diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/README.md b/README.md new file mode 100644 index 00000000..3533a212 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ + + + + +### GitHub Pages Cache + +Nothing to see here. The contents of this branch are essentially a cache that's not intended to be viewed on github.com. + + +If you're looking to update our documentation, check [the HylleraasMD documentation](https://cascella-group-uio.github.io/HyMD/index.html). + +For more information on how this documentation is built using Sphinx, Read the Docs, and GitHub Actions/Pages, see: + + * https://tech.michaelaltfield.net/2020/07/18/sphinx-rtd-github-pages-1 diff --git a/index.html b/index.html new file mode 100644 index 00000000..e2680780 --- /dev/null +++ b/index.html @@ -0,0 +1,9 @@ + + + + Redirecting to main branch + + + + + diff --git a/main/.buildinfo b/main/.buildinfo new file mode 100644 index 00000000..a812be1f --- /dev/null +++ b/main/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: d1c53ca0a458bab63f3363f597dbef0e +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/.doctrees/doc_pages/api.doctree b/main/.doctrees/doc_pages/api.doctree new file mode 100644 index 00000000..37b39d7c Binary files /dev/null and b/main/.doctrees/doc_pages/api.doctree differ diff --git a/main/.doctrees/doc_pages/benchmarks.doctree b/main/.doctrees/doc_pages/benchmarks.doctree new file mode 100644 index 00000000..353f1e1d Binary files /dev/null and b/main/.doctrees/doc_pages/benchmarks.doctree differ diff --git a/main/.doctrees/doc_pages/command_line.doctree b/main/.doctrees/doc_pages/command_line.doctree new file mode 100644 index 00000000..38e47c97 Binary files /dev/null and b/main/.doctrees/doc_pages/command_line.doctree differ diff --git a/main/.doctrees/doc_pages/config_file.doctree b/main/.doctrees/doc_pages/config_file.doctree new file mode 100644 index 00000000..c7d3ee41 Binary files /dev/null and b/main/.doctrees/doc_pages/config_file.doctree differ diff --git a/main/.doctrees/doc_pages/constants_and_units.doctree b/main/.doctrees/doc_pages/constants_and_units.doctree new file mode 100644 index 00000000..847d7905 Binary files /dev/null and b/main/.doctrees/doc_pages/constants_and_units.doctree differ diff --git a/main/.doctrees/doc_pages/electrostatics.doctree b/main/.doctrees/doc_pages/electrostatics.doctree new file mode 100644 index 00000000..50837500 Binary files /dev/null and b/main/.doctrees/doc_pages/electrostatics.doctree differ diff --git a/main/.doctrees/doc_pages/examples.doctree b/main/.doctrees/doc_pages/examples.doctree new file mode 100644 index 00000000..3689d68d Binary files /dev/null and b/main/.doctrees/doc_pages/examples.doctree differ diff --git a/main/.doctrees/doc_pages/filtering.doctree b/main/.doctrees/doc_pages/filtering.doctree new file mode 100644 index 00000000..5699f9fa Binary files /dev/null and b/main/.doctrees/doc_pages/filtering.doctree differ diff --git a/main/.doctrees/doc_pages/installation.doctree b/main/.doctrees/doc_pages/installation.doctree new file mode 100644 index 00000000..66188b0e Binary files /dev/null and b/main/.doctrees/doc_pages/installation.doctree differ diff --git a/main/.doctrees/doc_pages/interaction_energy_functionals.doctree b/main/.doctrees/doc_pages/interaction_energy_functionals.doctree new file mode 100644 index 00000000..51e0ed24 Binary files /dev/null and b/main/.doctrees/doc_pages/interaction_energy_functionals.doctree differ diff --git a/main/.doctrees/doc_pages/interfaces.doctree b/main/.doctrees/doc_pages/interfaces.doctree new file mode 100644 index 00000000..e47baf00 Binary files /dev/null and b/main/.doctrees/doc_pages/interfaces.doctree differ diff --git a/main/.doctrees/doc_pages/intramolecular_bonds.doctree b/main/.doctrees/doc_pages/intramolecular_bonds.doctree new file mode 100644 index 00000000..a5554eb8 Binary files /dev/null and b/main/.doctrees/doc_pages/intramolecular_bonds.doctree differ diff --git a/main/.doctrees/doc_pages/overview.doctree b/main/.doctrees/doc_pages/overview.doctree new file mode 100644 index 00000000..26a2f88f Binary files /dev/null and b/main/.doctrees/doc_pages/overview.doctree differ diff --git a/main/.doctrees/doc_pages/pressure.doctree b/main/.doctrees/doc_pages/pressure.doctree new file mode 100644 index 00000000..a372e241 Binary files /dev/null and b/main/.doctrees/doc_pages/pressure.doctree differ diff --git a/main/.doctrees/doc_pages/theory.doctree b/main/.doctrees/doc_pages/theory.doctree new file mode 100644 index 00000000..d3d61595 Binary files /dev/null and b/main/.doctrees/doc_pages/theory.doctree differ diff --git a/main/.doctrees/doc_pages/topology_input.doctree b/main/.doctrees/doc_pages/topology_input.doctree new file mode 100644 index 00000000..b44b4086 Binary files /dev/null and b/main/.doctrees/doc_pages/topology_input.doctree differ diff --git a/main/.doctrees/environment.pickle b/main/.doctrees/environment.pickle new file mode 100644 index 00000000..edb32f1a Binary files /dev/null and b/main/.doctrees/environment.pickle differ diff --git a/main/.doctrees/index.doctree b/main/.doctrees/index.doctree new file mode 100644 index 00000000..431014ba Binary files /dev/null and b/main/.doctrees/index.doctree differ diff --git a/main/_downloads/06277b09d9dbd669eb066a87bde69764/benchmarks-2.png b/main/_downloads/06277b09d9dbd669eb066a87bde69764/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/main/_downloads/06277b09d9dbd669eb066a87bde69764/benchmarks-2.png differ diff --git a/main/_downloads/65e54d27de07d1f3391023244e2c96b6/benchmarks-2.py b/main/_downloads/65e54d27de07d1f3391023244e2c96b6/benchmarks-2.py new file mode 100644 index 00000000..fd287cbc --- /dev/null +++ b/main/_downloads/65e54d27de07d1f3391023244e2c96b6/benchmarks-2.py @@ -0,0 +1,33 @@ +import numpy as np +import matplotlib.pyplot as plt + +mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] +mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + +mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + +mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + +mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] +mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + +mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + +mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + +plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") +plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") +plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") +plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") +plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") +plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") +plt.xlabel("CPUs", fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.ylabel("Time per step, s", fontsize=15) +plt.legend(loc="upper left", fontsize=15) +plt.show() \ No newline at end of file diff --git a/main/_downloads/682597475ba7aeb79c5d27601a114807/benchmarks-1.png b/main/_downloads/682597475ba7aeb79c5d27601a114807/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/main/_downloads/682597475ba7aeb79c5d27601a114807/benchmarks-1.png differ diff --git a/main/_downloads/9732f060c48ad320d8ef77b0255fa65c/benchmarks-2.hires.png b/main/_downloads/9732f060c48ad320d8ef77b0255fa65c/benchmarks-2.hires.png new file mode 100644 index 00000000..82806426 Binary files /dev/null and b/main/_downloads/9732f060c48ad320d8ef77b0255fa65c/benchmarks-2.hires.png differ diff --git a/main/_downloads/c2b4427af0abc490fea62e3654884461/benchmarks-1.py b/main/_downloads/c2b4427af0abc490fea62e3654884461/benchmarks-1.py new file mode 100644 index 00000000..deb4348f --- /dev/null +++ b/main/_downloads/c2b4427af0abc490fea62e3654884461/benchmarks-1.py @@ -0,0 +1,38 @@ +import numpy as np +import matplotlib.pyplot as plt +nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) +time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 +], dtype=np.float64) +nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 +], dtype=np.float64,) +time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, +], dtype=np.float64) +nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 +], dtype=np.float64) +time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, +], dtype=np.float64) +plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" +) +plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" +) +plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" +) +plt.xlabel("CPUs", fontsize=15) +plt.ylabel("Time per step, us", fontsize=15) +plt.legend(fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.show() \ No newline at end of file diff --git a/main/_downloads/d3fab0727cec9bfe48cd44e3926f8b8b/benchmarks-1.pdf b/main/_downloads/d3fab0727cec9bfe48cd44e3926f8b8b/benchmarks-1.pdf new file mode 100644 index 00000000..7e3c284f Binary files /dev/null and b/main/_downloads/d3fab0727cec9bfe48cd44e3926f8b8b/benchmarks-1.pdf differ diff --git a/main/_downloads/d80367d2b3a595c564d561412e710698/benchmarks-1.hires.png b/main/_downloads/d80367d2b3a595c564d561412e710698/benchmarks-1.hires.png new file mode 100644 index 00000000..173b39f3 Binary files /dev/null and b/main/_downloads/d80367d2b3a595c564d561412e710698/benchmarks-1.hires.png differ diff --git a/main/_downloads/f62fcc5108e569ea2fe61890ff1f4f10/benchmarks-2.pdf b/main/_downloads/f62fcc5108e569ea2fe61890ff1f4f10/benchmarks-2.pdf new file mode 100644 index 00000000..be18b504 Binary files /dev/null and b/main/_downloads/f62fcc5108e569ea2fe61890ff1f4f10/benchmarks-2.pdf differ diff --git a/main/_images/benchmarks-1.png b/main/_images/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/main/_images/benchmarks-1.png differ diff --git a/main/_images/benchmarks-2.png b/main/_images/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/main/_images/benchmarks-2.png differ diff --git a/main/_images/hylleraas_centre_logo_black.png b/main/_images/hylleraas_centre_logo_black.png new file mode 100644 index 00000000..40826396 Binary files /dev/null and b/main/_images/hylleraas_centre_logo_black.png differ diff --git a/main/_images/uio_full_logo_eng_pos.png b/main/_images/uio_full_logo_eng_pos.png new file mode 100644 index 00000000..6c603139 Binary files /dev/null and b/main/_images/uio_full_logo_eng_pos.png differ diff --git a/main/_modules/hymd/barostat.html b/main/_modules/hymd/barostat.html new file mode 100644 index 00000000..8fdfe103 --- /dev/null +++ b/main/_modules/hymd/barostat.html @@ -0,0 +1,604 @@ + + + + + + hymd.barostat — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.barostat

+"""Implements the Berendsen barostat.
+Scales the box and particle positions during simulation to
+simulate coupling to an external pressure bath set at a
+target pressure.
+
+It calculates the scaling factor according to:
+.. math::
+
+    \\alpha_{L,N} = 1 - \\frac{dt n_b}{\\tau_p}\\β(P_{L,N}^t - P_{L,N})
+
+where :math:`dt` is the outer rRESPA time-step, :math:`n_b` is the frequency
+of barostat calls, :math:`\\tau_p` is the pressure coupling time constant,
+:math:`\\beta` is the isothermal compressibility, :math:`P_{L,N}^t` and 
+:math:`P_{L,N}` is the target and instantaneous internal pressure in the 
+lateral (L) and normal (N) directions respectively. Convention: Cartesian
+z-direction is considered normal.
+
+The box and particle positions are scaled in the L and N directions according
+to the nature of the barostat (see functions `isotropic` and `semiisotropic`
+below by an amount :math:`\α^{\\frac{1}{3}}`.
+
+The updated system information is passed on to the pmesh objects.
+
+References
+----------
+H. J. C. Berendsen, J. P. M. Postma, W. F. van Gunsteren,
+A. DiNola, and J. R. Haak , "Molecular dynamics with coupling
+to an external bath", J. Chem. Phys. 81, 3684-3690 (1984)
+"""
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass
+from typing import Union
+from .pressure import comp_pressure
+from .field import initialize_pm
+
+
+@dataclass
+class Target_pressure:
+    P_L: Union[bool, float]
+    P_N: Union[bool, float]
+
+
+
[docs]def isotropic( + pmesh, + pm_stuff, + phi, + phi_q, + psi, + hamiltonian, + positions, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + bond_pr, + angle_pr, + step, + prng, + comm=MPI.COMM_WORLD, +): + """ + Implements an isotropic Berendsen barostat. + The box and particle positions are scaled uniformly + in the L and N directions. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of pmesh objects. + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fft : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds. + step : integer + MD step number + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of modified/unmodified pmesh objects. + change : Boolean + Indicates whether or not any pmesh objects were reinitialized. + """ + rank = comm.Get_rank() + beta = 4.6 * 10 ** (-5) # bar^(-1) #isothermal compressibility of water + change = False + + if np.mod(step, config.n_b) == 0: + change = True + # compute pressure + pressure = comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=comm, + ) + + # Total pressure across all ranks + P = np.average(pressure[-3:-1]) # kJ/(mol nm^3) + P = P * 16.61 # bar + + # scaling factor + alpha = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_L - P) + ) ** (1 / 3) + + # length scaling + config.box_size *= alpha + + # position coordinates scaling + positions *= alpha + + # pmesh re-initialize + pm_stuff = initialize_pm(pmesh, config, comm) + return (pm_stuff, change)
+ + +
[docs]def semiisotropic( + pmesh, + pm_stuff, + phi, + phi_q, + psi, + hamiltonian, + positions, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + bond_pr, + angle_pr, + step, + prng, + comm=MPI.COMM_WORLD, +): + """ + Implements a semiisotropic Berendsen barostat. + The box and particle positions are scaled by :math:`\\alpha_L^{\\frac{1}{3}}` + in the L direction and by :math:`\\alpha_N^{\\frac{1}{3}}` in the N direction. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of pmesh objects. + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fft : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds. + step : integer + MD step number + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of modified/unmodified pmesh objects. + change : Boolean + Indicates whether or not any pmesh objects were reinitialized. + """ + rank = comm.Get_rank() + beta = 4.6 * 10 ** (-5) # bar^(-1) #isothermal compressibility of water + change = False + if np.mod(step, config.n_b) == 0: + change = True + + # compute pressure + pressure = comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=comm, + ) + + # Total pressure across all ranks + # L: Lateral; N: Normal + [PL, PN] = [0, 0] + PL = (pressure[-3] + pressure[-2]) / 2 # kJ/(mol nm^3) + PN = pressure[-1] # kJ/(mol nm^3) + PL = PL * 16.61 # bar + PN = PN * 16.61 # bar + alphaL = 1.0 + alphaN = 1.0 + + if config.target_pressure.P_L: + # scaling factor + alphaL = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_L - PL) + ) ** (1 / 3) + # length scaling + config.box_size[0:2] *= alphaL + + positions[:][0:2] *= alphaL + + if config.target_pressure.P_N: + # scaling factor + alphaN = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_N - PN) + ) ** (1 / 3) + # length scaling + config.box_size[2] *= alphaN + + positions[:][2] *= alphaN + + # pmesh re-initialize + pm_stuff = initialize_pm(pmesh, config, comm) + return (pm_stuff, change)
+
+ +
+
+ +
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/_modules/hymd/field.html b/main/_modules/hymd/field.html new file mode 100644 index 00000000..09006f23 --- /dev/null +++ b/main/_modules/hymd/field.html @@ -0,0 +1,1473 @@ + + + + + + hymd.field — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.field

+"""Forces and energies from the discretized particle-field grid interactions
+"""
+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import warnings
+
+
+
[docs]def initialize_pm(pmesh, config, comm=MPI.COMM_WORLD): + """ + Creates the necessary pmesh objects for pfft operations. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + config : Config + Configuration dataclass containing simulation metadata and parameters. + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm : object 'pmesh.pm.ParticleMesh' + field_list : list[pmesh.pm.RealField], (multiple) + Essential list of pmesh objects required for MD + list_coulomb : list[pmesh.pm.RealField], (multiple) + Additional list of pmesh objects required for electrostatics. + """ + + if config.dtype == np.float64: + pmeshtype = "f8" + else: + pmeshtype = "f4" + # Ignore numpy numpy.VisibleDeprecationWarning: Creating an ndarray from + # ragged nested sequences until it is fixed in pmesh + with warnings.catch_warnings(): + warnings.filterwarnings( + action="ignore", + category=np.VisibleDeprecationWarning, + message=r"Creating an ndarray from ragged nested sequences", + ) + # The first argument of ParticleMesh has to be a tuple + pm = pmesh.ParticleMesh( + config.mesh_size, BoxSize=config.box_size, dtype=pmeshtype, comm=comm + ) + phi = [pm.create("real", value=0.0) for _ in range(config.n_types)] + phi_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] # noqa: E501 + force_on_grid = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + v_ext_fourier = [pm.create("complex", value=0.0) for _ in range(4)] + v_ext = [pm.create("real", value=0.0) for _ in range(config.n_types)] + + phi_transfer = [pm.create("complex", value=0.0) for _ in range(3)] + + phi_laplacian = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + + # Initialize charge density fields + coulomb_list = [] + elec_common_list = [None, None, None, None] + _SPACE_DIM = config.box_size.size + + if config.coulombtype == "PIC_Spectral_GPE" or config.coulombtype == "PIC_Spectral": + phi_q = pm.create("real", value=0.0) + phi_q_fourier = pm.create("complex", value=0.0) + psi = pm.create("real", value=0.0) + elec_field = [pm.create("real", value=0.0) for _ in range(_SPACE_DIM)] + + elec_common_list = [phi_q, phi_q_fourier, psi, elec_field] + + if config.coulombtype == "PIC_Spectral": + elec_field_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] # for force calculation + psi_fourier = pm.create("complex", value=0.0) + + coulomb_list = [ + elec_field_fourier, + psi_fourier, + ] + + if ( + config.coulombtype == "PIC_Spectral_GPE" + ): ## initializing the density mesh #dielectric_flag + phi_eps = pm.create( + "real", value=0.0 + ) ## real contrib of the epsilon dielectric painted to grid + phi_eps_fourier = pm.create("complex", value=0.0) # complex contrib of phi eps + phi_eta = [ + pm.create("real", value=0.0) for _ in range(_SPACE_DIM) + ] ## real contrib of factor in polarization charge density + phi_eta_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] ## fourier of factor in polarization charge density + phi_pol = pm.create( + "real", value=0.0 + ) ## real contrib of the polarization charge + phi_pol_prev = pm.create("real", value=0.0) + elec_dot = pm.create("real", value=0.0) + elec_field_contrib = pm.create( + "real", value=0.0 + ) # needed for pol energies later + + # External potential and force meshes + Vbar_elec = [pm.create("real", value=0.0) for _ in range(config.n_types)] + Vbar_elec_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] + force_mesh_elec = [ + [pm.create("real", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + force_mesh_elec_fourier = [ + [pm.create("complex", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + + coulomb_list = [ + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol, + phi_pol_prev, + elec_dot, + elec_field_contrib, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + ] + + field_list = [ + phi, + phi_fourier, + force_on_grid, + v_ext_fourier, + v_ext, + phi_transfer, + phi_laplacian, + ] + + return (pm, field_list, elec_common_list, coulomb_list)
+ + +
[docs]def compute_field_force(layouts, r, force_mesh, force, types, n_types): + """Interpolate particle-field forces from the grid onto particle positions + + Backmaps the forces calculated on the grid to particle positions using the + window function :math:`P` (by default cloud-in-cell [CIC]). In the + following, let :math:`\\mathbf{F}_j` denote the force acting on the + particle with index :math:`j` and position :math:`\\mathbf{r}_j`. The + interpolated force is + + .. math:: + + \\mathbf{F}_j = -\\sum_k\\nabla V_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`V_{j_k}` is the discretized external potential at grid vertex + :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid vertex + with index :math:`j_k`, and :math:`h^3` is the volume of each grid voxel. + The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + r : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + force : (N,D) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. Local + for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + n_types : int + Number of different unique types present in the simulation system. + :code:`n_types` is global, i.e. the same for all MPI ranks even if some + ranks contain zero particles of certain types. + """ + for t in range(n_types): + ind = types == t + for d in range(3): + force[ind, d] = force_mesh[t][d].readout(r[ind], layout=layouts[t])
+ + +
[docs]def compute_self_energy_q(config, charges, comm=MPI.COMM_WORLD): + """Compute the self energy for the interaction due to the Ewald scheme + used to compute the electrostatics. The energy is stored in :code:`config`. + + The self interaction energy is given by: + + .. math:: + + U_{self} = \\sqrt{\\frac{1}{2\\pi\\sigma^2}} \\sum_{i=1}^{N} q_i^2 + + where :math:`q_i` are the charges and :math:`\\sigma` is the half-width + of the Gaussian filter. + + Parameters + ---------- + config : Config + Configuration object. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + comm : mpi4py.Comm + MPI communicator to use for rank communication. + + Returns + ------- + field_q_self_energy : float + Electrostatic self energy. + """ + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + prefac = elec_conversion_factor * np.sqrt( + 1.0 / (2.0 * np.pi * config.sigma * config.sigma) + ) + _squared_charges = charges * charges + squared_charges_sum = comm.allreduce(np.sum(_squared_charges)) + return prefac * squared_charges_sum
+ + +
[docs]def update_field_force_q( + charges, + phi_q, + phi_q_fourier, + psi, + psi_fourier, + elec_field_fourier, + elec_field, + elec_forces, + layout_q, + hamiltonian, + pm, + positions, + config, +): + """Calculate the electrostatic particle-field forces on the grid + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential is computed in reciprocal space as + + .. math:: + + \\Phi = \\mathrm{FFT}^{-1}\\left[ + \\frac{4\\pi k_e}{\\varepsilon \\vert\\mathbf{k}\\vert^2} + \\mathrm{FFT}(\\rho)\\mathrm{FFT}(H) + \\right], + + with the electric field + + .. math:: + + \\mathbf{E} = \\mathrm{FFT}^{-1}\\left[ + -i\\mathbf{k}\\,\\mathrm{FFT}(\\Psi) + \\right]. + + In the following, let :math:`\\mathbf{F}_j` denote the electrostatic force + acting on the particle with index :math:`j` and position + :math:`\\mathbf{r}_j`. The interpolated electrostatic force is + + .. math:: + + \\mathbf{F}_j = \\sum_k q_j\\mathbf{E}_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`\\mathbf{E}_{j_k}` is the discretized electric field at grid + vertex :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid + vertex with index :math:`j_k`, and :math:`h^3` is the volume of each grid + voxel. The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty; any values in this field + are discarded. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + elec_field_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + electric field values in reciprocal space on the computational grid. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + n_dimensions = config.box_size.size + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + # charges to grid + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) + phi_q /= volume_per_cell + # print("phi_q", np.sum(phi_q)) + phi_q.r2c(out=phi_q_fourier) + + # smear charges with filter + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + + # solve Poisson equation in Fourier space to get electrostatic potential + def poisson_transfer_function(k, v): + return 4.0 * np.pi * elec_conversion_factor * v / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(poisson_transfer_function, out=psi_fourier) + # print("psi_fourier", np.sum(psi_fourier)) + psi_fourier.c2r(out=psi) + # print("phi_q * psi update_field", np.sum(phi_q * psi)) + + # exit() + + # compute electric field directly from smeared charged densities in Fourier + for _d in np.arange(n_dimensions): + + def poisson_transfer_function(k, v, d=_d): + return ( + -1j + * k[d] + * 4.0 + * np.pi + * elec_conversion_factor + * v + / k.normp(p=2, zeromode=1) + ) + + phi_q_fourier.apply(poisson_transfer_function, out=elec_field_fourier[_d]) + elec_field_fourier[_d].c2r(out=elec_field[_d]) + + # get electrostatic force from electric field + for _d in np.arange(n_dimensions): + elec_forces[:, _d] = charges * ( + elec_field[_d].readout(positions, layout=layout_q) + )
+ + +def comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, +): + for t in range(config.n_types): + np.copyto(phi_transfer[0].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[1].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[2].value, phi_fourier[t].value, casting="no", where=True) + + # Evaluate laplacian of phi in fourier space + for d in range(3): + + def laplacian_transfer(k, v, d=d): + return -k[d] ** 2 * v + + phi_transfer[d].apply(laplacian_transfer, out=Ellipsis) + phi_transfer[d].c2r(out=phi_laplacian[t][d]) + + +
[docs]def update_field( + phi, + phi_laplacian, + phi_transfer, + layouts, + force_mesh, + hamiltonian, + pm, + positions, + types, + config, + v_ext, + phi_fourier, + v_ext_fourier, + m, + compute_potential=False, +): + """Calculate the particle-field potential and force density + + If :code:`compute_potential` is :code:`True`, the energy may subsequently + be computed by calling :code:`compute_field_and_kinetic_energy`. + + Computes the particle-field external potential :math:`V_\\text{ext}` from + particle number densities through the smoothed density field, + :math:`\\phi(\\mathbf{r})`. With :math:`P` being the cloud-in-cell (CIC) + window function, the density and filtered densities are computed as + + .. math:: + + \\phi(\\mathbf{r}) = \\sum_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\phi(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\phi(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + external potential is computed in reciprocal space as + + .. math:: + + V_\\text{ext} = \\mathrm{FFT}^{-1}\\left[ + \\mathrm{FFT} + \\left( + \\frac{\\partial w}{\\partial \\tilde\\phi} + \\right) + \\mathrm{FFT}(H) + \\right], + + where :math:`w` is the interaction energy functional. Differentiating + :math:`V_\\text{ext}` is done by simply applying :math:`i\\mathbf{k}` in + Fourier space, and the resulting forces are back-transformed to direct + space and interpolated to particle positions by + + .. math:: + + \\mathbf{F}_j = -\\sum_{j_k} \\nabla V_{j_k} + P(\\mathbf{r}_{j_k} - \\mathbf{r}_j)h^3, + + where :math:`j_k` are the neighbouring vertices of particle :math:`j` at + position :math:`\\mathbf{r}_j`, and :math:`h^3` is the volume of each grid + voxel. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Pre-allocated, but empty; any values + in this field are discarded. Changed in-place. Local for each MPI + rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + config : Config + Configuration object. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Pre-allocated, but empty; any values in this field are + discarded Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + phi_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computational grid is represented by the collective fields of all + MPI ranks. + v_ext_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplesField` objects containing discretized + particle-field external potential values in reciprocal space on the + computational grid; :code:`D+1` fields in D dimensions for each + particle type. :code:`D` copies are made after calculation for later + use in force calculation, because the `force transfer function` + application differentiates the field in-place, ruining the contents + for differentiation in the remaining :code:`D-1` spatial directions. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + m: list[float], (M,) + pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. + Defaults to 1.0 for all particle types. + compute_potential : bool, optional + If :code:`True`, a :code:`D+1`-th copy of the Fourier transformed + external potential field is made to be used later in particle-field + energy calculation. If :code:`False`, only :code:`D` copies are made. + + See also + -------- + compute_field_and_kinetic_energy : + Compute the particle-field energy after the external potential is + calculated. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + for t in range(config.n_types): + pm.paint(positions[types == t], mass=m[t], layout=layouts[t], out=phi[t]) + phi[t] /= volume_per_cell + phi[t].r2c(out=phi_fourier[t]) + phi_fourier[t].apply(hamiltonian.H, out=Ellipsis) + phi_fourier[t].c2r(out=phi[t]) + + # External potential + for t in range(config.n_types): + v = hamiltonian.v_ext[t](phi) + + v.r2c(out=v_ext_fourier[0]) + v_ext_fourier[0].apply(hamiltonian.H, out=Ellipsis) + np.copyto( + v_ext_fourier[1].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + np.copyto( + v_ext_fourier[2].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + if compute_potential: + np.copyto( + v_ext_fourier[3].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + + # Differentiate the external potential in fourier space + for d in range(3): + + def force_transfer_function(k, v, d=d): + return -k[d] * 1j * v + + v_ext_fourier[d].apply(force_transfer_function, out=Ellipsis) + v_ext_fourier[d].c2r(out=force_mesh[t][d]) + + if compute_potential: + v_ext_fourier[3].c2r(out=v_ext[t])
+ + +
[docs]def compute_field_and_kinetic_energy( + phi, + phi_q, + psi, + velocity, + hamiltonian, + positions, + types, + v_ext, + config, + layouts, + comm=MPI.COMM_WORLD, +): + """Compute the particle-field and kinetic energy contributions + + Calculates the kinetic energy through + + .. math:: + + E_k = \\sum_j \\frac{1}{2}m_j\\mathbf{v}_j\\cdot\\mathbf{v}_j, + + and the particle-field energy by + + .. math:: + + E_\\text{field} = \\int\\mathrm{d}\\mathbf{r}\\, + w[\\tilde\\phi], + + where :math:`w` is the interaction energy functional `density`. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + velocity : (N,D) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Local for each MPI rank--the full computational grid is + represented by the collective fields of all MPI ranks. + config : Config + Configuration object. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field : + Computes the up-to-date external potential for use in calculating the + particle-field energy. + """ + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + field_energy = w_0.csum() # w to W + + kinetic_energy = comm.allreduce(0.5 * config.mass * np.sum(velocity**2)) + + if config.coulombtype == "PIC_Spectral": + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + field_q_energy = w_elec.csum() + else: + field_q_energy = 0.0 + + return field_energy, kinetic_energy, field_q_energy
+ + +
[docs]def compute_field_energy_q_GPE( + config, + phi_eps, + field_q_energy, + dot_elec, + comm=MPI.COMM_WORLD, +): + """ + Compute the electrostatic energy after electrosatic forces is + calculated. + + From the definition of the elecrostatic potential :math:`\\Psi`, the energy + is + + W = \\frac{1}{2}\\int\\mathrm{d}\\mathbf{r}\\, + \\epsilon(\\mathbf{r})} \\left(\\mathbf{E}\\cdot \\mathbf{E}\\right), + + where :math:`\\epsilon(\\mathbf{r})}` is the anisotropic, spatially dependent, + relative dielectric of the simulation medium. + + Parameters + ---------- + config : hymd.input_parser.Config + Configuration object. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + field_q_energy : float + Total elecrostatic energy. + dot_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing :math:`|\\mathbf{E(r)}|^{2}` + on the computational grid. Local for each MPI rank -- the full computational + grid is represented by the collective fields of all MPI ranks. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field_force_q_GPE: + Compute the electrosatic force from an anisotropic dielectric general + Poisson equation. + """ + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + # ^ due to integration on local cell before allreduce + + eps_0 = 1.0 / (config.coulomb_constant * 4 * np.pi) + field_q_energy = ( + volume_per_cell * (0.5 * eps_0) * comm.allreduce(np.sum(phi_eps * dot_elec)) + ) + + return field_q_energy
+ + +
[docs]def update_field_force_q_GPE( + conv_fun, + phi, + types, + charges, + phi_q, + phi_q_fourier, + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol_prev, + phi_pol, + elec_field, + elec_forces, + elec_field_contrib, + psi, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + hamiltonian, + layout_q, + layouts, + pm, + positions, + config, + comm=MPI.COMM_WORLD, +): + """ + Calculate the electrostatic particle-field forces on the grid, arising from + a general Poisson equation, i.e. anisotropic permittivity/dielectric. + The function is called when tomli input config.coulombtype = "PIC_Spectral_GPE." + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential for a variable dielectric does not have an + analytical expression, and is computed in reciprocal through an iterative + method. + + The GPE states that + + .. math:: + + \\nabla \\cdot \\left(\\epsilon(\\mathbf{r}) + \\nabla{\\mathbf{\\psi(r)}}\\right) = -\\rho({\\mathbf{r}}). + + where :math:`\\epsilon(\\mathbf{r})` is the relative dielectric function. + + Parameters + ---------- + conv_fun : Convergence function. + Returns a scalar. Depends on MPI allreduce for similar convergence + across MPI ranks. + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_eta : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + gradients of the relative dielectric values on the computational grid. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank--the + full computational grid is represented by the collective fields of all MPI ranks. + phi_eta_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated discretized + Fourier transformed gradient relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol_prev : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charge values on the computational grid. Parameter in + the iterative method.Pre-allocated,but empty. Changedin-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charges on the computational grid. Parameter in the iterative + method, updating the next quess in solving for the electrostatic potential. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all + MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + elec_field_contrib : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing + :math:`|\\mathbf{E(r)}|^2/\\phi_{0}` on the computational grid. + Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + psi : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic potential + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + Vbar_elec : mesh.pm.RealField + Pmesh :code:`RealField` object for storing functional derivatives of + :math:`\\|w(\\{ \\phi \\})_{elec}`on the computational grid. + Pre-allocated, but empty. Changed in-place. Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + Vbar_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated functional + derivatives of :math:`\\|w(\\{ \\phi \\})_{elec}` in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + force_mesh_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic force values + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + force_mesh_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated electrostatic + force values in reciprocal space on the computational grid. Local for + each MPI rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + layouts: list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + comm: mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + compute_field_energy_q_GPE: + Compute the electrostatic energy after electrosatic force is + calculated for a variable (anisotropic) dielectric general Poisson equation. + """ + + ## basic setup + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + ## old protocol in gen_qe_hpf_use_self + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) ## + ## scale and fft + ## old protocol in gen_qe_hpf_use_self + phi_q /= volume_per_cell + phi_q.r2c(out=phi_q_fourier) + + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + ## ^------ use the same gaussian as the \kai interaciton + phi_q_fourier.c2r(out=phi_q) ## this phi_q is after applying the smearing function + + denom_phi_tot = pm.create("real", value=0.0) + num_types = pm.create("real", value=0.0) + ### ^ ----- Calculate the relative dielectric (permittivity) to field + ### ------- from a mean contribution of particle number densities + + for t_ in range(config.n_types): + num_types = num_types + (config.dielectric_type[t_]) * phi[t_] + denom_phi_tot = denom_phi_tot + phi[t_] + + np.divide(num_types, denom_phi_tot, where=np.abs(denom_phi_tot > 1e-6), out=phi_eps) + + phi_eps.r2c(out=phi_eps_fourier) # FFT dielectric + + # phi_q_eps = (phi_q/phi_eps) + np.divide(phi_q, phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_q) + + _SPACE_DIM = 3 + ##^--------- constants needed throughout the calculations + + ### method for finding the gradient (fourier space), using the spatial dimension of k + for _d in np.arange(_SPACE_DIM): + + def gradient_transfer_function(k, x, d=_d): + return 1j * k[d] * x + + phi_eps_fourier.apply(gradient_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=phi_eta[_d]) + np.divide(phi_eta[_d], phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_eta[_d]) + + ### iterative GPE solver ### + ### ---------------------------------------------- + max_iter = 100 + i = 0 + delta = 1.0 + # phi_pol_prev = pm.create("real", value = 0.0) + ### ^------ set to zero before each iterative procedure or soft start + conv_criteria = config.conv_crit # conv. criteria (default 1e-6) + w = config.pol_mixing # polarization mixing param (default 0.6) + while i < max_iter and delta > conv_criteria: + (phi_q + phi_pol_prev).r2c(out=phi_q_fourier) + for _d in np.arange(_SPACE_DIM): + + def iterate_apply_k_vec(k, additive_terms, d=_d): + return additive_terms * (-1j * k[d]) / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(iterate_apply_k_vec, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + + phi_pol = -( + phi_eta[0] * elec_field[0] + + phi_eta[1] * elec_field[1] + + phi_eta[2] * elec_field[2] + ) + ### ^-- Following a negative sign convention (-ik) of the FT, a neg sign is + ### --- mathematically correct by the definition of the GPE (double - -> +) + phi_pol = w * phi_pol + (1.0 - w) * phi_pol_prev + diff = np.abs(phi_pol - phi_pol_prev) + delta = conv_fun(comm, diff) # decided from toml input + phi_pol_prev = phi_pol.copy() + i = i + 1 + # print("Stopping after iteration {:d} with stop crit {:.2e}, delta {:.2e}".format(i,conv_criteria,delta)) + + # compute_potential = True + def k_norm_divide(k, potential): + return potential / k.normp(p=2, zeromode=1) + + ## > Electrostatic potential + eps0_inv = config.coulomb_constant * 4 * np.pi + ## ^ the 1/(4pi eps0)*4*pi = 1/eps0 + ((eps0_inv) * (phi_q + phi_pol)).r2c(out=phi_q_fourier) + phi_q_fourier.apply(k_norm_divide, out=phi_q_fourier) + phi_q_fourier.c2r(out=psi) + ### ^ electrostatic potential for the GPE + + for _d in np.arange(_SPACE_DIM): + + def field_transfer_function(k, x, d=_d): + return ( + -1j * k[d] * x + ) ## negative sign relation, due to E = - nabla psi relation + + phi_q_fourier.apply(field_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + ## ^-------- Method: Obtaining the electric field from electrostatic potential + ## Assuming the electric field is conserved. + ## Assumption holds if no magnetic flux (magnetic induced fields) + + ############## Obtain forces ############## + elec_dot = ( + elec_field[0] * elec_field[0] + + elec_field[1] * elec_field[1] + + elec_field[2] * elec_field[2] + ) + # needed for energy calculations + + np.divide( + elec_dot, + denom_phi_tot, + where=np.abs(denom_phi_tot > 1e-6), + out=elec_field_contrib, + ) + + eps0_inv = config.coulomb_constant * 4 * np.pi + + for t_ in range(config.n_types): + Vbar_elec[t_] = ( + config.type_charges[t_] * psi + - (0.5 / eps0_inv) + * (config.dielectric_type[t_] - phi_eps) + * elec_field_contrib + ) + + # Obtain Vext,k + for t_ in range(config.n_types): + Vbar_elec[t_].r2c(out=Vbar_elec_fourier[t_]) + Vbar_elec_fourier[t_].apply(hamiltonian.H, out=Vbar_elec_fourier[t_]) + + # force terms + # F = - grad Vext + for t_ in range(config.n_types): + for _d in np.arange(_SPACE_DIM): + + def force_transfer_function(k, x, d=_d): + return -1j * k[_d] * x ## negative gradient + + Vbar_elec_fourier[t_].apply( + force_transfer_function, out=force_mesh_elec_fourier[t_][_d] + ) + force_mesh_elec_fourier[t_][_d].c2r(out=force_mesh_elec[t_][_d]) + elec_forces[types == t_, _d] = force_mesh_elec[t_][_d].readout( + positions[types == t_], layout=layouts[t_] + ) + + return Vbar_elec, phi_eps, elec_dot
+ + +
[docs]def domain_decomposition( + positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=MPI.COMM_WORLD +): + """Performs domain decomposition + + Rearranges the MPI rank memory layout into one that better mimics the PFFT + pencil grid 2D decomposition. As molecules are always required to be fully + contained on a single MPI rank, a perfect decomposition is not always + possible. The best decomposition which leaves the center of mass of all + molecules in their respective correct domains is used, with possible + overlap into neighbouring domains if the spatial extent of any molecule + crosses domain boundaries. + + Parameters + ---------- + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + *args + Variable length argument list containing arrays to include in the + domain decomposition. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + bonds : (N,M) numpy.ndarray, optional + Array of :code:`M` bonds originating from each of :code:`N` particles. + verbose : int, optional + Specify the logging event verbosity of this function. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + Domain decomposed :code:`positions` and any array specified in + :code:`*args`, in addition to :code:`bonds` and :code:`molecules` if these + arrays were provided as input. + """ + if molecules is not None: + if not topol: + assert bonds is not None, "bonds must be provided with molecules" + unique_molecules = np.sort(np.unique(molecules)) + molecules_com = np.empty_like(positions) + for m in unique_molecules: + ind = molecules == m + r = positions[ind, :][0, :] + molecules_com[ind, :] = r + layout = pm.decompose(molecules_com, smoothing=0) + if not topol: + args = (*args, bonds, molecules) + else: + args = (*args, molecules) + else: + layout = pm.decompose(positions, smoothing=0) + if verbose > 1: + Logger.rank0.log( + logging.INFO, + "DOMAIN_DECOMP: Total number of particles to be exchanged = %d", + np.sum(layout.get_exchange_cost()), + ) + return layout.exchange(positions, *args)
+
+ +
+
+ +
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/_modules/hymd/file_io.html b/main/_modules/hymd/file_io.html new file mode 100644 index 00000000..bcb4d770 --- /dev/null +++ b/main/_modules/hymd/file_io.html @@ -0,0 +1,1169 @@ + + + + + + hymd.file_io — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.file_io

+"""Handle file input/output in parllel HDF5 fashion
+"""
+import numpy as np
+import h5py
+import os
+import logging
+import getpass
+from mpi4py import MPI
+from .logger import Logger, get_version
+
+
+
[docs]class OutDataset: + """HDF5 dataset handler for file output""" + + def __init__( + self, + dest_directory, + config, + double_out=False, + disable_mpio=False, + comm=MPI.COMM_WORLD, + ): + """Constructor + + Parameters + ---------- + dest_directory : str + Ouput directory for saving data. + config : Config + Configuration object. + double_out : bool, optional + If :code:`True`, the output HDF5 objects are written in eight byte + floating point representation. Otherwise, four byte single + precision is used. + disable_mpio : bool, optional + If :code:`True`, disables parallel MPI-enabled HDF5 file output. + This is a compatibility option used if HDF5 is not compiled with + MPI support. This makes everything much harder by splitting all + output in one file per MPI rank, and having an MPI-enabled HDF5 + library is **highly recommended**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + """ + self.disable_mpio = disable_mpio + self.config = config + if double_out: + self.float_dtype = "float64" + else: + self.float_dtype = "float32" + + if disable_mpio: + self.file = h5py.File( + os.path.join( + dest_directory, f"sim.hdf5-{comm.rank:6d}-of-{comm.size:6d}" + ), + "w", + ) + else: + self.file = h5py.File( + os.path.join(dest_directory, "sim.H5"), "w", driver="mpio", comm=comm + ) + +
[docs] def is_open(self, comm=MPI.COMM_WORLD): + """Check if HDF5 output file is open + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + return self.file.__bool__()
+ +
[docs] def close_file(self, comm=MPI.COMM_WORLD): + """Closes the HDF5 output file + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + self.file.close()
+ +
[docs] def flush(self): + """Flushes output buffers, forcing file writes""" + self.file.flush()
+ + +
[docs]def setup_time_dependent_element( + name, parent_group, n_frames, shape, dtype, units=None +): + """Helper function for setting up time-dependent HDF5 group datasets + + All output groups must adhere to the H5MD standard, meaning a structure of + + + | ┗━ **group** particle group (e.g. :code:`all`) or :code:`observables` group + | ┗━ **group** time-dependent data + | ┣━ **dataset** :code:`step` :code:`shape=(n_frames,)` + | ┣━ **dataset** :code:`time` :code:`shape=(n_frames,)` + | ┗━ **dataset** :code:`value` :code:`shape=(n_frames, *)` + + is necessary. + + References + ---------- + H5MD specification : + https://www.nongnu.org/h5md/h5md.html + """ # noqa: E501 + group = parent_group.create_group(name) + step = group.create_dataset("step", (n_frames,), "int32") + time = group.create_dataset("time", (n_frames,), "float32") + value = group.create_dataset("value", (n_frames, *shape), dtype) + + if units is not None: + value.attrs["unit"] = units + time.attrs["unit"] = "ps" + return group, step, time, value
+ + +
[docs]def store_static( + h5md, + rank_range, + names, + types, + indices, + config, + bonds_2_atom1, + bonds_2_atom2, + molecules=None, + velocity_out=False, + force_out=False, + charges=False, + dielectrics=False, + plumed_out=False, + comm=MPI.COMM_WORLD, +): + """Outputs all static time-independent quantities to the HDF5 output file + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + rank_range : list[int] + Start and end indices for global arrays for each MPI rank. + names : (N,) numpy.ndarray + Array of names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of type indices for :code:`N` particles. + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + config : Config + Configuration object. + bonds_2_atom1 : (B,) numpy.ndarray + Array of indices of the first particle for :code:`B` total + two-particle bonds. + bonds_2_atom2 : (B,) numpy.ndarray + Array of indices of the second particle for :code:`B` total + two-particle bonds. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. + dielectrics : (N,) numpy.ndarray + Array of particle relative dielectric values for :code:`N` particles. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to output HDF5 file. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + prepare_bonds : + Constructs two-, three-, and four-particle bonds from toplogy input + file and bond configuration information. + distribute_input : + Distributes input arrays onto MPI ranks, attempting load balancing. + """ + dtype = h5md.float_dtype + + h5md_group = h5md.file.create_group("/h5md") + h5md.h5md_group = h5md_group + h5md.observables = h5md.file.create_group("/observables") + h5md.connectivity = h5md.file.create_group("/connectivity") + h5md.parameters = h5md.file.create_group("/parameters") + + h5md_group.attrs["version"] = np.array([1, 1], dtype=int) + author_group = h5md_group.create_group("author") + author_group.attrs["name"] = np.string_(getpass.getuser()) + creator_group = h5md_group.create_group("creator") + creator_group.attrs["name"] = np.string_("Hylleraas MD") + + # Get HyMD version + creator_group.attrs["version"] = np.string_(get_version()) + + h5md.particles_group = h5md.file.create_group("/particles") + h5md.all_particles = h5md.particles_group.create_group("all") + mass = h5md.all_particles.create_dataset("mass", (config.n_particles,), dtype) + mass[...] = config.mass + + if charges is not False: + charge = h5md.all_particles.create_dataset( + "charge", (config.n_particles,), dtype="float32" + ) + charge[indices] = charges + if dielectrics is not False: + dielectric = h5md.all_particles.create_dataset( + "dielectric", (config.n_particles,), dtype="float32" + ) + dielectric[indices] = dielectrics + + box = h5md.all_particles.create_group("box") + box.attrs["dimension"] = 3 + box.attrs["boundary"] = np.array( + [np.string_(s) for s in 3 * ["periodic"]], dtype="S8" + ) + + n_frames = config.n_steps // config.n_print + if np.mod(config.n_steps - 1, config.n_print) != 0: + n_frames += 1 + if np.mod(config.n_steps, config.n_print) == 1: + n_frames += 1 + if n_frames == config.n_steps: + n_frames += 1 + + species = h5md.all_particles.create_dataset( + "species", + (config.n_particles,), + dtype="i", + ) + + ( + _, + h5md.positions_step, + h5md.positions_time, + h5md.positions, + ) = setup_time_dependent_element( + "position", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm", + ) + if velocity_out: + ( + _, + h5md.velocities_step, + h5md.velocities_time, + h5md.velocities, + ) = setup_time_dependent_element( + "velocity", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm ps-1", + ) + if force_out: + ( + _, + h5md.forces_step, + h5md.forces_time, + h5md.forces, + ) = setup_time_dependent_element( + "force", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="kJ mol-1 nm-1", + ) + ( + _, + h5md.total_energy_step, + h5md.total_energy_time, + h5md.total_energy, + ) = setup_time_dependent_element( + "total_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.kinetc_energy_step, + h5md.kinetc_energy_time, + h5md.kinetc_energy, + ) = setup_time_dependent_element( + "kinetic_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.potential_energy_step, + h5md.potential_energy_time, + h5md.potential_energy, + ) = setup_time_dependent_element( + "potential_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.bond_energy_step, + h5md.bond_energy_time, + h5md.bond_energy, + ) = setup_time_dependent_element( + "bond_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.angle_energy_step, + h5md.angle_energy_time, + h5md.angle_energy, + ) = setup_time_dependent_element( + "angle_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.dihedral_energy_step, + h5md.dihedral_energy_time, + h5md.dihedral_energy, + ) = setup_time_dependent_element( + "dihedral_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.field_energy_step, + h5md.field_energy_time, + h5md.field_energy, + ) = setup_time_dependent_element( + "field_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + if charges is not False: + ( + _, + h5md.field_q_energy_step, + h5md.field_q_energy_time, + h5md.field_q_energy, + ) = setup_time_dependent_element( + "field_q_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) # <-------- xinmeng + if plumed_out is not False: + ( + _, + h5md.plumed_bias_step, + h5md.plumed_bias_time, + h5md.plumed_bias, + ) = setup_time_dependent_element( + "plumed_bias", h5md.observables, n_frames, (1,), dtype, units="kJ mol-1" # noqa: E501 + ) + ( + _, + h5md.total_momentum_step, + h5md.total_momentum_time, + h5md.total_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "total_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm g ps-1 mol-1", + ) + ( + _, + h5md.angular_momentum_step, + h5md.angular_momentum_time, + h5md.angular_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "angular_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm+2 g ps-1 mol-1", + ) + ( + _, + h5md.torque_step, + h5md.torque_time, + h5md.torque, + ) = setup_time_dependent_element( # noqa: E501 + "torque", + h5md.observables, + n_frames, + (3,), + dtype, + units="kJ nm+2 mol-1", + ) + ( + _, + h5md.temperature_step, + h5md.temperature_time, + h5md.temperature, + ) = setup_time_dependent_element( + "temperature", h5md.observables, n_frames, (3,), dtype, units="K" + ) + ( + _, + h5md.thermostat_work_step, + h5md.thermostat_work_time, + h5md.thermostat_work, + ) = setup_time_dependent_element( + "thermostat_work", + h5md.observables, + n_frames, + (1,), + "float32", + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.pressure_step, + h5md.pressure_time, + h5md.pressure, + ) = setup_time_dependent_element( + "pressure", h5md.observables, n_frames, (18,), "float32", units="Bar" + ) + (_, h5md.box_step, h5md.box_time, h5md.box_value,) = setup_time_dependent_element( + "edges", box, n_frames, (3, 3), "float32", units="nm" + ) + + ind_sort = np.argsort(indices) + for i in ind_sort: + species[indices[i]] = config.name_to_type_map[names[i].decode("utf-8")] + + h5md.parameters.attrs["config.toml"] = np.string_(str(config)) + vmd_group = h5md.parameters.create_group("vmd_structure") + index_of_species = vmd_group.create_dataset( + "indexOfSpecies", (config.n_types,), "i" + ) + index_of_species[:] = np.array(list(range(config.n_types))) + + # VMD-h5mdplugin maximum name/type name length is 16 characters (for + # whatever reason [VMD internals?]). + name_dataset = vmd_group.create_dataset("name", (config.n_types,), "S16") + type_dataset = vmd_group.create_dataset("type", (config.n_types,), "S16") + if molecules is not None: + resid_dataset = vmd_group.create_dataset( + "resid", + (config.n_particles,), + "i", + ) + + # Change this + for i, n in config.type_to_name_map.items(): + name_dataset[i] = np.string_(n[:16]) + if n == "W": + type_dataset[i] = np.string_("solvent") + else: + type_dataset[i] = np.string_("membrane") + + total_bonds = comm.allreduce(len(bonds_2_atom1), MPI.SUM) + n_bonds_local = len(bonds_2_atom1) + + receive_buffer = comm.gather(n_bonds_local, root=0) + n_bonds_global = None + if comm.Get_rank() == 0: + n_bonds_global = receive_buffer + n_bonds_global = np.array(comm.bcast(n_bonds_global, root=0)) + rank_bond_start = np.sum(n_bonds_global[: comm.Get_rank()]) + + bonds_from = vmd_group.create_dataset("bond_from", (total_bonds,), "i") + bonds_to = vmd_group.create_dataset("bond_to", (total_bonds,), "i") + for i in range(n_bonds_local): + a = bonds_2_atom1[i] + b = bonds_2_atom2[i] + bonds_from[rank_bond_start + i] = indices[a] + 1 + bonds_to[rank_bond_start + i] = indices[b] + 1 + + if molecules is not None: + resid_dataset[indices[ind_sort]] = molecules
+ + +# store data old vs +""" +h5md, step, frame, indices, positions, velocities, forces, box_size, +temperature, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, +field_energy, field_q_energy, time_step, config, velocity_out=False, +force_out=False, charge_out=False, dump_per_particle=False, +""" + + +
[docs]def store_data( + h5md, + step, + frame, + indices, + positions, + velocities, + forces, + box_size, + temperature, + pressure, + kinetic_energy, + bond2_energy, + bond3_energy, + bond4_energy, + field_energy, + field_q_energy, + plumed_bias, + time_step, + config, + velocity_out=False, + force_out=False, + charge_out=False, + plumed_out=False, + dump_per_particle=False, + comm=MPI.COMM_WORLD, +): + """Writes time-step data to HDF5 output file + + Handles all quantities which change during simulation, as opposed to + static quanitities (see :code:`store_static`). + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + step : int + Step number. + frame : int + Output frame number (:code:`step // n_print`). + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + positions : (N,) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + velocities : (N,) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + forces : (N,) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. + box_size : (D,) numpy.ndarray + Array containing the simulation box size. + temperature : float + Calculated instantaneous temperature. + kinetic_energy : float + Calculated instantaneous kinetic energy. + bond2_energy : float + Calculated instantaneous harmonic two-particle bond energy. + bond3_energy : float + Calculated instantaneous harmonic angular three-particle bond energy. + bond4_energy : float + Calculated instantaneous dihedral four-particle torsion energy. + field_energy : float + Calculated instantaneous particle-field energy. + field_q_energy : float + Calculated instantaneous electrostatic energy. + plumed_bias : float + PLUMED instantaneous bias energy. + time_step : float + Value of the time step. + config : Config + Configuration object. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charge_out : bool, optional + If :code:`True`, electrostatic energies are written to the output + HDF5 file. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to the output HDF5 file. + dump_per_particle : bool, optional + If :code:`True`, all quantities are written **per particle**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + store_static : + Outputs all static time-independent quantities to the HDF5 output file + """ + for dset in ( + h5md.positions_step, + h5md.total_energy_step, + h5md.potential_energy_step, + h5md.kinetc_energy_step, + h5md.bond_energy_step, + h5md.angle_energy_step, + h5md.dihedral_energy_step, + h5md.field_energy_step, + h5md.total_momentum_step, + h5md.angular_momentum_step, + h5md.torque_step, + h5md.temperature_step, + h5md.pressure_step, + h5md.box_step, + h5md.thermostat_work_step, + ): + dset[frame] = step + + for dset in ( + h5md.positions_time, + h5md.total_energy_time, + h5md.potential_energy_time, + h5md.kinetc_energy_time, + h5md.bond_energy_time, + h5md.angle_energy_time, + h5md.dihedral_energy_time, + h5md.field_energy_time, + h5md.total_momentum_time, + h5md.angular_momentum_time, + h5md.torque_time, + h5md.temperature_time, + h5md.pressure_time, + h5md.box_time, + h5md.thermostat_work_time, + ): + dset[frame] = step * time_step + + if velocity_out: + h5md.velocities_step[frame] = step + h5md.velocities_time[frame] = step * time_step + if force_out: + h5md.forces_step[frame] = step + h5md.forces_time[frame] = step * time_step + if charge_out: + h5md.field_q_energy_step[frame] = step + h5md.field_q_energy_time[frame] = step * time_step + if plumed_out: + h5md.plumed_bias_step[frame] = step + h5md.plumed_bias_time[frame] = step * time_step + + ind_sort = np.argsort(indices) + h5md.positions[frame, indices[ind_sort]] = positions[ind_sort] + + if velocity_out: + h5md.velocities[frame, indices[ind_sort]] = velocities[ind_sort] + if force_out: + h5md.forces[frame, indices[ind_sort]] = forces[ind_sort] + if charge_out: + h5md.field_q_energy[frame] = field_q_energy + if plumed_out: + h5md.plumed_bias[frame] = plumed_bias + + potential_energy = ( + bond2_energy + bond3_energy + bond4_energy + field_energy + field_q_energy + ) + + total_momentum = config.mass * comm.allreduce(np.sum(velocities, axis=0), MPI.SUM) + angular_momentum = config.mass * comm.allreduce( + np.sum(np.cross(positions, velocities), axis=0), MPI.SUM + ) + torque = config.mass * comm.allreduce( + np.sum(np.cross(positions, forces), axis=0), MPI.SUM + ) + h5md.total_energy[frame] = kinetic_energy + potential_energy + h5md.potential_energy[frame] = potential_energy + h5md.kinetc_energy[frame] = kinetic_energy + h5md.bond_energy[frame] = bond2_energy + h5md.angle_energy[frame] = bond3_energy + h5md.dihedral_energy[frame] = bond4_energy + h5md.field_energy[frame] = field_energy + h5md.total_momentum[frame, :] = total_momentum + h5md.angular_momentum[frame, :] = angular_momentum + h5md.torque[frame, :] = torque + h5md.temperature[frame] = temperature + h5md.pressure[frame] = pressure + for d in range(3): + h5md.box_value[frame, d, d] = box_size[d] + h5md.thermostat_work[frame] = config.thermostat_work + + fmt_ = [ + "step", + "time", + "temp", + "tot E", + "kin E", + "pot E", + "field E", + "elec E", + "bond E", + "ang E", + "dih E", + "bias E", + "Px", + "Py", + "Pz", + "ΔH" if config.target_temperature else "ΔE", + ] + fmt_ = np.array(fmt_) + + # create mask to show only energies != 0 + en_array = np.array([ + field_energy, + field_q_energy, + bond2_energy, + bond3_energy, + bond4_energy, + plumed_bias, + ]) + mask = np.full_like(fmt_, True, dtype=bool) + mask[range(6,12)] = en_array != 0. + + header_ = fmt_[mask].shape[0] * "{:>13}" + if config.initial_energy is None: + fmt_[-1] = "" + + divide_by = 1.0 + if dump_per_particle: + for i in range(3, 9): + fmt_[i] = fmt_[i][:-2] + "E/N" + fmt_[-1] += "/N" + divide_by = config.n_particles + total_energy = kinetic_energy + potential_energy + if config.initial_energy is not None: + if config.target_temperature: + H_tilde = total_energy - config.initial_energy - config.thermostat_work + else: + H_tilde = total_energy - config.initial_energy + else: + H_tilde = 0.0 + + header = header_.format(*fmt_[mask]) + data_fmt = f'{"{:13}"}{(fmt_[mask].shape[0]-1) * "{:13.5g}" }' + all_data = [ + step, + time_step * step, + temperature, + total_energy / divide_by, + kinetic_energy / divide_by, + potential_energy / divide_by, + field_energy / divide_by, + field_q_energy / divide_by, + bond2_energy / divide_by, + bond3_energy / divide_by, + bond4_energy / divide_by, + plumed_bias / divide_by, + total_momentum[0] / divide_by, + total_momentum[1] / divide_by, + total_momentum[2] / divide_by, + H_tilde / divide_by, + ] + data = data_fmt.format(*[val for i, val in enumerate(all_data) if mask[i]]) + Logger.rank0.log(logging.INFO, ("\n" + header + "\n" + data))
+ + +
[docs]def distribute_input( + in_file, rank, size, n_particles, max_molecule_size=201, comm=MPI.COMM_WORLD +): + """Assign global arrays onto MPI ranks, attempting load balancing + + Distributes approximately equal numbers of particles (workload) onto each + independent MPI rank, while respecting the requirement that any molecule + must be fully contained on a single MPI rank only (no splitting molecules + across multiple CPUs). + + Parameters + ---------- + in_file : h5py.File + HDF5 input file object. + rank : int + Local rank number for this MPI rank. + size : int + Global size of the MPI communicator (number of total CPUs). + n_particles : int + Total number of particles. + max_molecule_size : int, optional + Maximum size of any molecule present in the system. Used to initially + guess where the MPI rank boundaries (start/end indices) in the global + arrays should be placed. If molecules of size + :code:`>max_molecule_size` exist in the simulation system, HyMD + **might** work as expected. Or it might fail spectacularly. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + rank_range : + Starting and ending indices in the global arrays for each MPI rank. + """ + if n_particles is None: + n_particles = len(in_file["indices"]) + np_per_MPI = n_particles // size + + molecules_flag = False + if "molecules" in in_file: + molecules_flag = True + + if not molecules_flag: + if rank == size - 1: + np_cum_mpi = [rank * np_per_MPI, n_particles] + else: + np_cum_mpi = [rank * np_per_MPI, (rank + 1) * np_per_MPI] + p_mpi_range = list(range(np_cum_mpi[0], np_cum_mpi[1])) + return p_mpi_range, molecules_flag + + # To avoid splitting molecules across multiple different ranks, we need + # to read in some extra indices before/after the expected break points + # and iterate until we find a molecule break. + # + # Implicitly assuming no molecule is bigger than + # min(max_molecule_size, n_particles // n_MPI_ranks) atoms. + max_molecule_size += 2 + grab_extra = max_molecule_size if np_per_MPI > max_molecule_size else np_per_MPI + if rank == 0: + mpi_range_start = 0 + if size == 1: + mpi_range_end = n_particles + else: + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + elif rank == size - 1: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = n_particles + else: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + + molecules = in_file["molecules"][mpi_range_start:mpi_range_end] + indices = in_file["indices"][mpi_range_start:mpi_range_end] + molecule_end_indices = np.nonzero(np.diff(molecules))[0] + + p_mpi_range = [None, None] + if rank == 0: + p_mpi_range[0] = 0 + if size == 1: + p_mpi_range[1] = n_particles + else: + p_mpi_range[1] = indices[ + molecule_end_indices[molecule_end_indices >= np_per_MPI][0] + 1 + ] + elif rank == size - 1: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = n_particles + else: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = ( + indices[molecule_end_indices[molecule_end_indices > np_per_MPI][0]] + + 1 # noqa: E501 + ) + return list(range(p_mpi_range[0], p_mpi_range[1])), molecules_flag
+
+ +
+
+ +
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/_modules/hymd/force.html b/main/_modules/hymd/force.html new file mode 100644 index 00000000..0a7a8bda --- /dev/null +++ b/main/_modules/hymd/force.html @@ -0,0 +1,1172 @@ + + + + + + hymd.force — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.force

+"""Calculates intramolecular forces between bonded particles in molecules
+"""
+import numpy as np
+import networkx as nx
+from dataclasses import dataclass
+
+# Imported here so we can call from force import compute_bond_forces__fortran
+from force_kernels import cbf as compute_bond_forces__fortran  # noqa: F401
+from force_kernels import (  # noqa: F401
+    caf as compute_angle_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cdf as compute_dihedral_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cbf_d as compute_bond_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    caf_d as compute_angle_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    cdf_d as compute_dihedral_forces__fortran__double,
+)
+
+
+
[docs]@dataclass # might not be needed +class Dielectric_type: + atom_1: str + dielectric_value: float
+ + +
[docs]@dataclass +class Bond: + """Dataclass representing a single two-particle bond type + + A `bond type` is a bond strength and equilibrium distance associated with + any bond between particles of specific types :code:`A` and :code:`B` + (where :code:`A` and :code:`B` may be the same or different). Harmonic + two-particle bonds in HyMD take the form + + .. math:: + + V_2(\\mathbf{r}_1, \\mathbf{r}_2) = + \\frac{1}{2}k + \\left( + \\vert \\mathbf{r}_1 - \\mathbf{r}_2 \\vert - r_0 + \\right)^2, + + where :math:`k` is the bond strength (spring constant) and :math:`r_0` is + the equilibrium bond length (at which the energy is zero). + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + equilibrium : float + Equilibrium distance at which the energy associated with the bond + vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient (spring constant). + """ + + atom_1: str + atom_2: str + equilibrium: float + strength: float
+ + +
[docs]@dataclass +class Angle(Bond): + """Dataclass representing a single three-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any three-particle bond between particles of specific types :code:`A`, + :code:`B`, and :code:`C` (where :code:`A`, :code:`B`, and :code:`C` may be + different or the same). Harmonic angular three-particle bonds in HyMD take + the form + + .. math:: + + V_3(\\mathbf{r}_1, \\mathbf{r}_2, \\mathbf{r}_3) = + \\frac{1}{2}k + \\left( + \\cos^{-1} + \\left[ + \\frac{ + (\\mathbf{r}_1-\\mathbf{r}_2) + \\cdot + (\\mathbf{r}_3-\\mathbf{r}_2) + } + { + \\vert\\mathbf{r}_1-\\mathbf{r}_2\\vert + \\vert\\mathbf{r}_3-\\mathbf{r}_2\\vert + } + \\right] - \\theta_0 + \\right)^2 + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + equilibrium : float + Equilibrium angle at which the energy associated with the + three-particle angular bond vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient. + + See also + -------- + Bond : + Two-particle bond type dataclass + """ + + atom_3: str
+ + +
[docs]@dataclass +class Dihedral: + """Dataclass representing a single four-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any four-particle torsional bond between particles of specific types + :code:`A`, :code:`B`, :code:`C`, and :code:`D` (where :code:`A`, :code:`B`, + :code:`C`, and :code:`D` may be different or the same). Dihedral + four-particle bonds in HyMD take different forms depending on the + :code:`dih_type` parameter. + + In the following, let :math:`\\phi` denote the angle between the planes + spanned by the relative positions of atoms :code:`A`-:code:`B`-:code:`C` + and :code:`B`-:code:`C`-:code:`D`. If :code:`dih_type = 0`, then + + .. math:: + + V_4(\\phi) = \\sum_n c_n + \\left( + 1 + \\cos\\left[ + n\\phi - d_n + \\right] + \\right), + + where :math:`c_n` are energy coefficients and :math:`d_n` are propensity + phases. By default, the cosine sum is truncated at five terms. If + :code:`coeffs` provides only a single float, this is used as the coiling + propensity parameter :math:`\\lambda`. In this case, :math:`c_n` and + :math:`d_n` are automatically set to values which promote alpha helical + (:math:`\\lambda=-1`), beta sheet (:math:`\\lambda=1`), or a mixed + (:math:`1>\\lambda>-1`) structure (using values provided by Bore et al. + (2018)). In this case, the full potential takes the form + + .. math:: + + V_4(\\phi;\\lambda) = + \\frac{1}{2}(1-\\lambda) V_{\\text{prop},\\alpha}(\\phi) + + + \\frac{1}{2}(1+\\lambda) V_{\\text{prop},\\beta}(\\phi) + + + (1-\\vert\\lambda\\vert) V_{\\text{prop}, \\text{coil}}(\\phi), + + with each of the :math:`V_{\\mathrm{prop}, X}` being fixed cosine series + potentials with pre-set :math:`c_n` -s and :math:`d_n` -s. + + If :code:`dih_type = 1`, then a combined bending torsional (CBT) potential + is employed, + + .. math:: + + V_4(\\phi,\\gamma;\\lambda) = + V_4(\\phi;\\lambda) + + + \\frac{1}{2}K(\\phi)(\\gamma - \\gamma_0)^2, + + where :math:`V_4(\\phi;\\lambda)` specifies the potential as given by the + coiling propensity parameter above, :math:`K(\\phi)` is a separate cosine + series potential acting as the angular three-particle bond strength, and + :math:`\\gamma_0` is the three-particle bond equilibrium angle. In this + case, the :code:`coeffs` parameter must specify *both* a :math:`\\lambda` + value, in additon to the energy and phases dictating the :math:`K(\\phi)` + potential. + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + atom_4 : str + Type name of particle 4. + coeffs : list[list[float]] or list[float] or numpy.ndarray + Dihedral coefficients defining the series expansion of the dihedral + energy. + dih_type : int + Specifies the type of dihedral used; If :code:`0`, then :code:`coeffs` + must contain **either** two lists of five energy coefficients + :math:`c_n` and five propensity phases :math:`d_n` **or** a single + floating point number defining the :math:`\\lambda` coiling propensity + parameter. If :code:`1`, the combined bending-torsional potential is + used, and :code:`coeffs` must specify :math:`\\lambda` *and* two lists + containing energy coefficients and propensity phases for the + :math:`V_\\text{prop}` propensity potential, defined in terms of cosine + series. + + References + ---------- + Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018. + """ + + atom_1: str + atom_2: str + atom_3: str + atom_4: str + coeffs: np.ndarray + dih_type: int
+ + +
[docs]@dataclass +class Chi: + """Dataclass representing a single :math:`\\chi` mixing interaction type + + An `interaction mixing energy type` is a mixing energy associated with + density overlap between species of types :code:`A` and :code:`B` + (specified as inputs :code:`atom_1` and :code:`atom_2`). A positive mixing + energy promotes phase separation, a negative mixing energy promotes mixing. + The interaction energy density (provided the :code:`DefaultWithChi` + Hamiltonian is used) takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} + \\sum_{k,l}\\chi_{k,l} \\tilde\\phi_k\\tilde\\phi_l, + + where :math:`\\chi_{k,l}` denotes the mixing energy between species + :math:`k` and :math:`l`, with :math:`\\kappa` being the incompressibility. + The value of the interaction mixing energy parameter may be extracted from + `Flory-Huggins theory`_. + + .. _`Flory-Huggins theory`: + https://en.wikipedia.org/wiki/Flory%E2%80%93Huggins_solution_theory + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + interaction_energy : float + Interaction mixing energy. + + See also + -------- + hymd.hamiltonian.DefaultWithChi : + Interaction energy functional using :math:`\\chi`-interactions. + """ + + atom_1: str + atom_2: str + interaction_energy: float
+ + +
[docs]def find_all_paths(G, u, n): + """Helper function that recursively finds all paths of given lenght 'n + 1' inside a network 'G'. + Adapted from https://stackoverflow.com/a/28103735.""" + if n == 0: + return [[u]] + paths = [] + for neighbor in G.neighbors(u): + for path in find_all_paths(G, neighbor, n - 1): + if u not in path: + paths.append([u] + path) + return paths
+ + +
[docs]def propensity_potential_coeffs(x: float): + alpha_coeffs = np.array( + [ + [7.406, -5.298, -2.570, 1.336, 0.739], + [-0.28632126, 1.2099146, 1.18122138, 0.49075168, 0.98495911], + ] + ) + beta_coeffs = np.array( + [ + [3.770, 5.929, -4.151, -0.846, 0.190], + [-0.2300693, -0.0583289, 0.99342396, 1.03237971, 2.90160988], + ] + ) + coil_coeffs = np.array( + [ + [1.416, -0.739, 0.990, -0.397, 0.136], + [1.3495933, 0.45649087, 2.30441057, -0.12274901, -0.26179939], + ] + ) + + zero_add = np.zeros((2, 5)) + if np.isclose(x, -1): + return np.concatenate((alpha_coeffs, zero_add)) + elif np.isclose(x, 0): + return np.concatenate((coil_coeffs, zero_add)) + elif np.isclose(x, 1): + return np.concatenate((beta_coeffs, zero_add)) + + abs_x = np.abs(x) + if abs_x > 1: + err_str = ( + f"The provided value of lambda = {x} is out of lambda definition range, " + f"[-1.0, 1.0]." + ) + Logger.rank0.log(logging.ERROR, err_str) + else: + coil_coeffs[0] *= 1 - abs_x + if x < 0: + alpha_coeffs[0] *= 0.5 * (abs_x - x) + return np.concatenate((alpha_coeffs, coil_coeffs)) + else: + beta_coeffs[0] *= 0.5 * (abs_x + x) + return np.concatenate((beta_coeffs, coil_coeffs))
+ + +
[docs]def prepare_bonds_old(molecules, names, bonds, indices, config): + """Find bonded interactions from connectivity and bond types information + + .. deprecated:: 1.0.0 + :code:`prepare_bonds_old` was replaced by :code:`prepare_bonds` for + use with compiled Fortran kernels prior to 1.0.0 release. + + Prepares the necessary equilibrium and bond strength information needed by + the intramolecular interaction functions. This is performed locally on each + MPI rank, as the domain decomposition ensures that for all molecules *all* + consituent particles are always contained on *the same* MPI rankself. + + This function traverses the bond connectivity information provided in the + structure/topology input file and indentifies any two-, three-, or + four-particle potential bonds. For each connected chain of two, three, or + four particles, a matching to bond types is attempted. If the corresponding + names match, a bond object is initialized. + + In order to investigate the connectivity, a graph is created using + networkx functionality. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2 : list + List of lists containing *local* particle indices, equilibrium + distance, and bond strength coefficient for each reconstructed + two-particle bond. + bonds_3 : + List of lists containing *local* particle indices, equilibrium angle, + and bond strength coefficient for each reconstructed three-particle + bond. + bonds_4 : + List of lists containing *local* particle indices, dihedral type index, + and dihedral coefficients for each reconstructed four-particle + torsional bond. + bb_index : list + List indicating the dihedral type of each four-particle bond in + :code:`bonds_4`. + + See also + -------- + Bond : + Two-particle bond type dataclass. + Angle : + Three-particle angular bond type dataclass. + Dihedral : + Four-particle torsional bond type dataclass. + hymd.input_parser.Config + Configuration dataclass handler. + """ + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + bb_index = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + bb_dihedral = 0 + bond_graph = nx.Graph() + + for local_index, global_index in enumerate(indices): + if molecules[local_index] != mol: + continue + + bond_graph.add_node( + global_index, + name=names[local_index].decode("UTF-8"), + local_index=local_index, + ) + for bond in [b for b in bonds[local_index] if b != -1]: + bond_graph.add_edge(global_index, bond) + + connectivity = nx.all_pairs_shortest_path(bond_graph) + for c in connectivity: + i = c[0] + connected = c[1] + for j, path in connected.items(): + if len(path) == 2 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for b in config.bonds: + match_forward = name_i == b.atom_1 and name_j == b.atom_2 + match_backward = name_i == b.atom_2 and name_j == b.atom_1 + if match_forward or match_backward: + bonds_2.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[j]["local_index"], + b.equilibrium, + b.strength, + ] + ) + + if len(path) == 3 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_mid = bond_graph.nodes()[path[1]]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for a in config.angle_bonds: + match_forward = ( + name_i == a.atom_1 + and name_mid == a.atom_2 + and name_j == a.atom_3 + ) + match_backward = ( + name_i == a.atom_3 + and name_mid == a.atom_2 + and name_j == a.atom_1 + ) + if match_forward or match_backward: + bonds_3.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[path[1]]["local_index"], + bond_graph.nodes()[j]["local_index"], + np.radians(a.equilibrium), + a.strength, + ] + ) + + all_paths_len_four = find_all_paths(bond_graph, i, 3) + for p in all_paths_len_four: + name_i = bond_graph.nodes()[i]["name"] + name_mid_1 = bond_graph.nodes()[p[1]]["name"] + name_mid_2 = bond_graph.nodes()[p[2]]["name"] + name_j = bond_graph.nodes()[p[3]]["name"] + + for a in config.dihedrals: + match_forward = ( + name_i == a.atom_1 + and name_mid_1 == a.atom_2 + and name_mid_2 == a.atom_3 + and name_j == a.atom_4 + ) + if ( + match_forward + and [ + bond_graph.nodes()[p[3]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[i]["local_index"], + a.coeffs, + a.dih_type, + ] + not in bonds_4 + ): + bonds_4.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[3]]["local_index"], + a.coeffs, + a.dih_type, + ] + ) + if a.dih_type == 1: + bb_dihedral = len(bonds_4) + + if bb_dihedral: + bb_index.append(bb_dihedral - 1) + + return bonds_2, bonds_3, bonds_4, bb_index
+ + +
[docs]def prepare_index_based_bonds(molecules, topol): + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + resid = mol + 1 + top_summary = topol["system"]["molecules"] + resname = None + test_mol_number = 0 + for molname in top_summary: + test_mol_number += molname[1] + if resid <= test_mol_number: + resname = molname[0] + break + + if resname is None: + break + + if "bonds" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for bond in topol[resname]["bonds"]: + index_i = bond[0] - 1 + first_id + index_j = bond[1] - 1 + first_id + # bond[2] is the bond type, inherited by the itp format. Not used + equilibrium = bond[3] + strength = bond[4] + bonds_2.append([index_i, index_j, equilibrium, strength]) + + if "angles" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["angles"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + # angle[3] is the angle type, inherited by the itp format. Not used + equilibrium = np.radians(angle[4]) + strength = angle[5] + bonds_3.append([index_i, index_j, index_k, equilibrium, strength]) + + if "dihedrals" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["dihedrals"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + index_l = angle[3] - 1 + first_id + dih_type = angle[4] + coeff = angle[5] + if dih_type == 0 and isinstance(coeff[0], (float, int)): + coeff = propensity_potential_coeffs(coeff[0]) + elif dih_type == 1 and len(coeff) == 3: + coeff = np.array( + propensity_potential_coeffs(coeff[0][0]).tolist() + + coeff[1:] + ) + elif dih_type == 2: + coeff = np.array(coeff) + else: + coeff = np.insert(np.array(coeff), 2, np.zeros((2, 5)), axis=0) + bonds_4.append([index_i, index_j, index_k, index_l, coeff, dih_type, 0]) + return bonds_2, bonds_3, bonds_4
+ + +
[docs]def prepare_bonds(molecules, names, bonds, indices, config, topol=None): + """Rearrange the bond information for usage in compiled Fortran kernels + + Restructures the lists resulting from the execution of + :code:`prepare_bonds_old` into numpy arrays suitable for calls to optimized + Fortran code calculating bonded forces and energiesself. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2_atom_1 : (B,) numpy.ndarray + Local index of particle 1 for each of :code:`B` constructed + two-particle bonds. + bonds_2_atom_2 : (B,) numpy.ndarray + Local index of particle 2 for each of :code:`B` constructed + two-particle bonds. + bonds_2_equilibrium : (B,) numpy.ndarray + Equilibrium distance for each of :code:`B` constructed two-particle + bonds. + bonds_2_strength : (B,) numpy.ndarray + Bond strength for each of :code:`B` constructed two-particle + bonds. + bonds_3_atom_1 : (A,) numpy.ndarray + Local index of particle 1 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_2 : (A,) numpy.ndarray + Local index of particle 2 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_3 : (A,) numpy.ndarray + Local index of particle 3 for each of :code:`A` constructed + three-particle bonds. + bonds_3_equilibrium : (A,) numpy.ndarray + Equilibrium angle for each of :code:`A` constructed three-particle + bonds. + bonds_3_strength : (A,) numpy.ndarray + Bond strength for each of :code:`A` constructed three-particle + bonds. + bonds_4_atom_1 : (D,) numpy.ndarray + Local index of particle 1 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_2 : (D,) numpy.ndarray + Local index of particle 2 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_3 : (D,) numpy.ndarray + Local index of particle 3 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_4 : (D,) numpy.ndarray + Local index of particle 4 for each of :code:`D` constructed + four-particle bonds. + bonds_4_coeff : (D,) numpy.ndarray + Cosine series coefficients for each of :code:`D` constructed + four-particle bonds. + bonds_4_type : (D,) numpy.ndarray + Dihedral type for each of :code:`D` constructed four-particle + bonds. + bonds_4_last : (D,) numpy.ndarray + Flags indicating if :code:`dih_type` is :code:`1` for each of :code:`D` + constructed four-particle bonds. + + See also + -------- + prepare_bonds_old : + Used internally to reconstruct the bonded interactions types from the + connectivity information in the structure/topology input file and the + bonded types specified in the configuration file. + """ + if topol is not None: + bonds_2, bonds_3, bonds_4 = prepare_index_based_bonds( + molecules, topol + ) + else: + bonds_2, bonds_3, bonds_4, bb_index = prepare_bonds_old( + molecules, names, bonds, indices, config + ) + + # Bonds + bonds_2_atom1 = np.empty(len(bonds_2), dtype=int) + bonds_2_atom2 = np.empty(len(bonds_2), dtype=int) + bonds_2_equilibrium = np.empty(len(bonds_2), dtype=np.float64) + bonds_2_strength = np.empty(len(bonds_2), dtype=np.float64) + for i, b in enumerate(bonds_2): + bonds_2_atom1[i] = b[0] + bonds_2_atom2[i] = b[1] + bonds_2_equilibrium[i] = b[2] + bonds_2_strength[i] = b[3] + + # Angles + bonds_3_atom1 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom2 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom3 = np.empty(len(bonds_3), dtype=int) + bonds_3_equilibrium = np.empty(len(bonds_3), dtype=np.float64) + bonds_3_strength = np.empty(len(bonds_3), dtype=np.float64) + for i, b in enumerate(bonds_3): + bonds_3_atom1[i] = b[0] + bonds_3_atom2[i] = b[1] + bonds_3_atom3[i] = b[2] + bonds_3_equilibrium[i] = b[3] + bonds_3_strength[i] = b[4] + # Dihedrals + bonds_4_atom1 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom2 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom3 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom4 = np.empty(len(bonds_4), dtype=int) + number_of_coeff = 6 + len_of_coeff = 5 + bonds_4_coeff = np.empty( + (len(bonds_4), number_of_coeff, len_of_coeff), dtype=np.float64 + ) + bonds_4_type = np.empty(len(bonds_4), dtype=int) + bonds_4_last = np.zeros(len(bonds_4), dtype=int) + for i, b in enumerate(bonds_4): + bonds_4_atom1[i] = b[0] + bonds_4_atom2[i] = b[1] + bonds_4_atom3[i] = b[2] + bonds_4_atom4[i] = b[3] + bonds_4_coeff[i] = np.resize(b[4], (number_of_coeff, len_of_coeff)) + bonds_4_type[i] = b[5] + if topol is not None: + bonds_4_last[i] = b[6] + if topol is None: + bonds_4_last[bb_index] = 1 + + return ( + bonds_2_atom1, + bonds_2_atom2, + bonds_2_equilibrium, + bonds_2_strength, + bonds_3_atom1, + bonds_3_atom2, + bonds_3_atom3, + bonds_3_equilibrium, + bonds_3_strength, # noqa: E501 + bonds_4_atom1, + bonds_4_atom2, + bonds_4_atom3, + bonds_4_atom4, + bonds_4_coeff, + bonds_4_type, + bonds_4_last, # noqa: E501 + )
+ + +
[docs]def compute_bond_forces__plain(f_bonds, r, bonds_2, box_size): + """Computes forces resulting from bonded interactions + + .. deprecated:: 1.0.0 + :code:`compute_bond_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_bonds.fill(0.0) + energy = 0.0 + + for i, j, r0, k in bonds_2: + ri = r[i, :] + rj = r[j, :] + rij = rj - ri + + # Apply periodic boundary conditions to the distance rij + for dim in range(len(rij)): + rij[dim] -= box_size[dim] * np.around(rij[dim] / box_size[dim]) + dr = np.linalg.norm(rij) + df = -k * (dr - r0) + f_bond_vector = df * rij / dr + f_bonds[i, :] -= f_bond_vector + f_bonds[j, :] += f_bond_vector + + energy += 0.5 * k * (dr - r0) ** 2 + return energy
+ + +
[docs]def compute_angle_forces__plain(f_angles, r, bonds_3, box_size): + """Computes forces resulting from angular interactions + + .. deprecated:: 1.0.0 + :code:`compute_angle_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_angles.fill(0.0) + energy = 0.0 + + for a, b, c, theta0, k in bonds_3: + ra = r[a, :] - r[b, :] + rc = r[c, :] - r[b, :] + + for dim in range(len(ra)): + ra[dim] -= box_size[dim] * np.around(ra[dim] / box_size[dim]) + rc[dim] -= box_size[dim] * np.around(rc[dim] / box_size[dim]) + + xra = 1.0 / np.sqrt(np.dot(ra, ra)) + xrc = 1.0 / np.sqrt(np.dot(rc, rc)) + ea = ra * xra + ec = rc * xrc + + cosphi = np.dot(ea, ec) + theta = np.arccos(cosphi) + xsinph = 1.0 / np.sqrt(1.0 - cosphi**2) + + d = theta - theta0 + f = -k * d + + xrasin = xra * xsinph * f + xrcsin = xrc * xsinph * f + + fa = (ea * cosphi - ec) * xrasin + fc = (ec * cosphi - ea) * xrcsin + + f_angles[a, :] += fa + f_angles[c, :] += fc + f_angles[b, :] -= fa + fc + # f_angles[b, :] += -(fa + fc) + + energy -= 0.5 * f * d + + return energy
+ + +
[docs]def compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size): + """Computes forces resulting from dihedral interactions + + .. deprecated:: 1.0.0 + :code:`compute_dihedral_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_dihedrals.fill(0.0) + energy = 0.0 + + for a, b, c, d, coeffs, phase in bonds_4: + f = r[a, :] - r[b, :] + g = r[b, :] - r[c, :] + h = r[d, :] - r[c, :] + + for dim in range(3): + f -= box_size[dim] * np.around(f[dim] / box_size[dim]) + g -= box_size[dim] * np.around(g[dim] / box_size[dim]) + h -= box_size[dim] * np.around(h[dim] / box_size[dim]) + + v = np.cross(f, g) + w = np.cross(h, g) + vv = np.dot(v, v) + ww = np.dot(w, w) + gn = np.linalg.norm(g) + + cosphi = np.dot(v, w) + sinphi = np.dot(np.cross(v, w), g) / gn + phi = np.arctan2(sinphi, cosphi) + + fg = np.dot(f, g) + hg = np.dot(h, g) + sc = v * fg / (vv * gn) - w * hg / (ww * gn) + + df = 0 + + for m in range(len(coeffs[0])): + energy += coeffs[0][m] * (1 + np.cos(m * phi - coeffs[1][m])) + df += m * coeffs[0][m] * np.sin(m * phi - coeffs[1][m]) + + force_on_a = df * gn * v / vv + force_on_d = df * gn * w / ww + + f_dihedrals[a, :] -= force_on_a + f_dihedrals[b, :] += df * sc + force_on_a + f_dihedrals[c, :] -= df * sc + force_on_d + f_dihedrals[d, :] += force_on_d + return energy
+ + +
[docs]def dipole_forces_redistribution( + f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb +): + """Redistribute electrostatic forces calculated from topologically + reconstructed ghost dipole point charges to the backcone atoms of the protein. + """ + f_on_bead.fill(0.0) + for i, j, k, l, fd, matrix, dih_type, is_last in zip( + a, b, c, d, f_dipoles, trans_matrices, type_array, last_bb + ): + if dih_type == 1: + sum_force = fd[0] + fd[1] + diff_force = fd[0] - fd[1] + f_on_bead[i] += matrix[0] @ diff_force # Atom A + f_on_bead[j] += matrix[1] @ diff_force + 0.5 * sum_force # Atom B + f_on_bead[k] += matrix[2] @ diff_force + 0.5 * sum_force # Atom C + + if is_last == 1: + sum_force = fd[2] + fd[3] + diff_force = fd[2] - fd[3] + f_on_bead[j] += matrix[3] @ diff_force + f_on_bead[k] += matrix[4] @ diff_force + 0.5 * sum_force + f_on_bead[l] += matrix[5] @ diff_force + 0.5 * sum_force
+
+ +
+
+ +
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/_modules/hymd/hamiltonian.html b/main/_modules/hymd/hamiltonian.html new file mode 100644 index 00000000..9d332e37 --- /dev/null +++ b/main/_modules/hymd/hamiltonian.html @@ -0,0 +1,807 @@ + + + + + + hymd.hamiltonian — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.hamiltonian

+"""Interaction energy functionals.
+
+Implements field--particle interaction energy functionals depending on the
+field configuration. Extending HyMD with a new Hamiltonian is done by
+subclassing the :code:`Hamiltonian` superclass with logic intialized in the
+constructor.
+
+The grid-independent filtering function is defined in the :code:`Hamiltonian`
+superclass constructor. Hijack :code:`self.H` in a subclass to change the
+filter.
+"""
+import numpy as np
+import sympy
+
+
+
[docs]class Hamiltonian: + """Interaction energy functional superclass""" + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + self.config = config + self._setup()
+ +
[docs] def _setup(self): + """Superclass setup + + Sets up the grid-independent filtering function :code:`H`, and the + SymPy logic for symbolically differentiating interaction energy + functionals in Hamiltonian subclasses. + """ + if not hasattr(self.config, "simulation_volume"): + self.config.simulation_volume = np.prod(np.asarray(self.config.box_size)) + if not self.config.barostat: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.config.a = self.config.rho0 + if not self.config.rho0: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.phi = sympy.var("phi:%d" % (self.config.n_types)) + k = sympy.var("k:%d" % (3)) + + # electrostatics variables + self.psi = sympy.var("psi") + self.phi_q = sympy.var("phi_q") + if not self.config.self_energy: + self.config.self_energy = 0.0 + + def fourier_space_window_function(k): + return sympy.functions.elementary.exponential.exp( + -0.5 + * self.config.sigma**2 + * (k0**2 + k1**2 + k2**2) # noqa: F821, E501 + ) + + self.window_function_lambda = sympy.lambdify( + [k], fourier_space_window_function(k) + ) + + def H(k, v): + return v * self.window_function_lambda(k) + + self.H = H
+ + +
[docs]class SquaredPhi(Hamiltonian): + """Simple squared density interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + \\sum_k \\tilde\\phi_k + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`rho_0` is the + average density of the fully homogenous system. Expressing the species + densities in terms of fluctuations from the average, + + .. math:: + + \\mathrm{d}\\tilde\\phi_k = \\rho_0 - \\tilde\\phi_k, + + it is evident that this interaction energy functional is a slight change of + the :code:`DefaultNoChi` Hamiltonian, as the expanded interaction energy + density becomes + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + 6\\rho_0\\left[ + \\sum_k \\mathrm{d}\\tilde\\phi_k + \\right] + + + 9\\rho_0^2 + + + \\sum_k \\mathrm{d}\\tilde\\phi_k^2 + + + \\prod_{k\\not=l} + \\mathrm{d}\\tilde\\phi_k \\mathrm{d}\\tilde\\phi_l + \\right), + + identical to :code:`DefaultNoChi` apart from a constant energy shift + :math:`9\\rho_0^2`(which does not impact dynamics) and the + :math:`\\rho_0`--:math:`\\mathrm{d}\\tilde\\phi_k` cross-terms. These + cross-terms constitute contributions to the energy linear in + :math:`\\mathrm{d}\\tilde\\phi_k` absent in :code:`DefaultNoChi`, which has + only quadratic terms present. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(SquaredPhi, self).__init__(config) + super(SquaredPhi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0): + return 0.5 / (kappa * rho0) * (sum(phi)) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + ): + V_incompressibility = 1 / (kappa * rho0) * sum(phi) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultNoChi(Hamiltonian): + """Incompressibility-only interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. The :code:`SquaredPhi` Hamiltonian implements a similar + functional with an additional linear term component depending on + + .. math:: + + \\mathmr{d}\\tilde\\phi_k = \\tilde\\phi_k - \\rho_0 + + and not :math:`\\mathrm{d}\\tilde\\phi_k^2`. No explicit inter-species + interaction is present apart from the indirect interaction through the + incompressibility. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + hymd.input_parser.Config : + Configuration dataclass handler. + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultNoChi, self).__init__(config) + super(DefaultNoChi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0, a=self.config.a): + return 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultWithChi(Hamiltonian): + """Incompressibility and :math:`\\chi`-interactions energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = + \\frac{1}{2\\rho_0} + \\sum_{k,l}\\chi_{kl} \\tilde\\phi_k \\tilde\\phi_l + + + \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. :math:`\\chi_{ij}` is the Flory-Huggins-like + inter-species mixing energy. + """ + +
[docs] def __init__(self, config, unique_names, type_to_name_map): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultWithChi, self).__init__(config) + super(DefaultWithChi, self)._setup() + self.setup(unique_names, type_to_name_map)
+ +
[docs] def setup(self, unique_names, type_to_name_map): + """Setup the interaction energy potential and the external potential + + Parameters + ---------- + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + """ + self.type_to_name_map = type_to_name_map + self.chi_type_dictionary = { + tuple(sorted([c.atom_1, c.atom_2])): c.interaction_energy + for c in self.config.chi + } + self.phi_laplacian = [ + sympy.var("phi_laplacian%d(0:%d)" % (t, 3)) + for t in range(self.config.n_types) + ] + + def w( + phi, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + interaction = 0.0 + for i in range(self.config.n_types): + for j in range(i + 1, self.config.n_types): + ni = type_to_name_map[i] + nj = type_to_name_map[j] + names = sorted([ni, nj]) + c = chi_type_dictionary[tuple(names)] + + interaction += c * phi[i] * phi[j] / rho0 + incompressibility = 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + return incompressibility + interaction + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + t, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + + V_interaction = 0.0 + nk = type_to_name_map[t] + for i in range(self.config.n_types): + ni = type_to_name_map[i] + names = sorted([nk, ni]) + if ni != nk: + c = chi_type_dictionary[tuple(names)] + else: + c = 0.0 + # uncomment to count diagonal chi terms: + # c = chi_type_dictionary[tuple(names)] + V_interaction += c * phi[i] / rho0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[t])) + for t in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +def get_hamiltonian(config): + """Return appropriate Hamiltonian object based on the + config.hamiltonian string. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ---------- + hamiltonian : Hamiltonian + Hamiltonian object. + """ + if config.hamiltonian.lower() == "defaultnochi": + hamiltonian = DefaultNoChi(config) + elif config.hamiltonian.lower() == "defaultwithchi": + hamiltonian = DefaultWithChi( + config, config.unique_names, config.type_to_name_map + ) + elif config.hamiltonian.lower() == "squaredphi": + hamiltonian = SquaredPhi(config) + + return hamiltonian +
+ +
+
+ +
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/_modules/hymd/input_parser.html b/main/_modules/hymd/input_parser.html new file mode 100644 index 00000000..20967bd4 --- /dev/null +++ b/main/_modules/hymd/input_parser.html @@ -0,0 +1,1645 @@ + + + + + + hymd.input_parser — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.input_parser

+"""Parses and handles the configuration information provided for the simulation
+"""
+import copy
+import tomli
+import datetime
+import logging
+import warnings
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass, field
+from typing import List, Union, ClassVar
+from .force import Bond, Angle, Dihedral, Chi, Dielectric_type, propensity_potential_coeffs
+from .barostat import Target_pressure
+from .logger import Logger
+
+
+
[docs]@dataclass +class Config: + """Configuration object + + Handles and verifies the simulation configuration specified in the + configuration file. + + Attributes + ---------- + gas_constant : float + Constant value of the gas constant, R (equivalently the Boltzmann + constant) in the units used internally in HyMD. + coulomb_constant : float + Constant value of the Coulomb constant which converts electric field + values to forces and electric potential values to energies in the units + used internally in HyMD. + n_steps: int + Number of time steps in the simulation. + time_step: float + *Outer* time step used in the simulation. If the rRESPA intergrator is + used, the *inner* time step (the time step used in the integration of + intramolecular bending, stretching, and torsional forces) is + :code:`time_step / respa_inner`. + box_size : list[float] or (D,) numpy.ndarray + Simulation box size of simulation in :code:`D` dimensions in units of + nanometers. + mesh_size : list[int] or int or numpy.ndarray + Number of grid points used for the discrete density grid. + sigma : float + Filter width representing the effective coarse-graining level of the + particles in the simulation. + kappa : float + Compressibility parameter used in the relaxed incompressibility term in + the interaction energy functional. + n_print : int, optional + Frequency of trajectory/energy output to the H5MD trajectory/energy + output file (in units of number of time steps). + tau : float, optional + The time scale of the CSVR thermostat coupling. + start_temperature : float, optional + Generate starting temperature by assigning all particle velocities + randomly according to the Maxwell-Boltzmann distribution at + :code:`start_temperature` Kelvin prior to starting the simulation. + target_temperature : float, optional + Couple the system to a heat bath at :code:`target_temperature` Kelvin. + mass : float, optional + Mass of the particles in the simulation. + hamiltonian : str, optional + Specifies the interaction energy functional :math:`W[\\tilde\\phi]` + for use with the particle-field interactions. Options: + :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`. + domain_decomposition : int, optional + Specifies the interval (in time steps) of domain decomposition + exchange, involving all MPI ranks sending and receiving particles + according to the particles’ positions in the integration box and the + MPI ranks’ assigned domain. + integrator : str, optional + Specifies the time integrator used in the simulation. Options: + :code:`velocity-verlet` or :code:`respa`. + respa_inner : int, optional + The number of inner time steps in the rRESPA integrator. This denotes + the number of intramolecular force calculations (stretching, bending, + torsional) are performed between each impulse applied from the field + forces. + file_name : str, optional + File path of the parsed configuration file. + name : str, optional + Name for the simulation. + tags : list[str], optional + Tags for the simulation. + bonds : list[Bond], optional + Specifies harmonic stretching potentials between particles in the + same molecule. + angle_bonds : list[Angle], optional + Specifies harmonic angular bending potentials between particles in the + same molecule. + dihedrals : list[Dihedral], optional + Specifies four-particle torsional potentials by cosine series. + chi : list[Chi], optional + Specifies :math:`\\chi`-interaction parameters between particle + species. + n_particles : int, optional + Specifies the total number of particles in the input. Optional keyword + for validation, ensuring the input HDF5 topology has the correct number + of particles and molecules. + max_molecule_size : int, optional + Maximum size of any single molecule in the system. Used to speed up + distribution of particles onto MPI ranks in a parallel fashion. + n_flush : int, optional + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be + written to disk (in units of number of :code:`n_print`). + thermostat_work : float + Work performed by the thermostat on the system. + thermostat_coupling_groups : list[str], optional + Specifies individual groups coupling independently to the CSVR + thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and + :code:`"C"` type particles, + :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would + thermalise types :code:`"A"` and :code:`"B"` together and couple + :code:`"C"` type particles to a different thermostat (all individual + thermostats are at the same temperature, i.e. target_temperature + Kelvin). + initial_energy : float + Value of the total energy prior to the start of the simulation. + cancel_com_momentum : int, optional + If :code:`True`, the total linear momentum of the center of mass is + removed before starting the simulation. If an integer is specifed, the + total linear momentum of the center of mass is removed every + :code:`remove_com_momentum` time steps. If :code:`False`, the linear + momentum is never removed. + coulombtype : str, optional + Specifies the type of electrostatic Coulomb interactions in the system. + The strength of the electrostatic forces is modulated by the relative + dielectric constant of the simulation medium, specified with the + :code:`dielectric_const` keyword. Charges for individual particles are + specified in the structure/topology HDF5 input file, not in the + configuration file. If no charges (or peptide backbone dipoles) are + present, the electrostatic forces will not be calculated even if this + keyword is set to :code:`"PIC_Spectral"`. + dielectric_const : float, optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. When + using helical propensity dihedrals, this keyword must be specified—even + if electrostatics are not included with the :code:`coulombtype` + keyword. + dielectric_type: list[float], optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. The list assigns + relative dielectric values to each bead type, and an anisotropic + dielectric function is obtained from a weighted average. + + + See also + -------- + hymd.input_parser.Bond : + Two-particle bond type dataclass. + hymd.input_parser.Angle : + Three-particle bond type dataclass. + hymd.input_parser.Dihedral : + Four-particle bond type dataclass. + """ + + gas_constant: ClassVar[float] = 0.0083144621 # kJ mol-1 K-1 + coulomb_constant: ClassVar[float] = 138.935458 # kJ nm mol-1 e-2 + + n_steps: int + time_step: float + mesh_size: Union[Union[List[int], np.ndarray], int] + sigma: float + kappa: float + + dtype: np.dtype = None + box_size: Union[List[float], np.ndarray] = None + n_print: int = None + tau: float = None + start_temperature: Union[float, bool] = None + target_temperature: Union[float, bool] = None + mass: float = None + hamiltonian: str = None + domain_decomposition: Union[int, bool] = None + integrator: str = None + respa_inner: int = 1 + file_name: str = "<config file path unknown>" + name: str = None + tags: List[str] = field(default_factory=list) + bonds: List[Bond] = field(default_factory=list) + angle_bonds: List[Angle] = field(default_factory=list) + dihedrals: List[Dihedral] = field(default_factory=list) + chi: List[Chi] = field(default_factory=list) + n_particles: int = None + max_molecule_size: int = None + n_flush: int = None + thermostat_work: float = 0.0 + thermostat_coupling_groups: List[List[str]] = field(default_factory=list) + initial_energy: float = None + cancel_com_momentum: Union[int, bool] = False + coulombtype: str = None + convergence_type: str = None + pol_mixing: float = None + dielectric_const: float = None + conv_crit: float = None + dielectric_type: List[Dielectric_type] = field(default_factory=list) + self_energy: float = None + type_charges: Union[List[float], np.ndarray] = None + + # For NPT runs + rho0: float = None + a: float = None + pressure: bool = False + barostat: str = None + barostat_type: str = None + tau_p: float = None + target_pressure: List[Target_pressure] = field(default_factory=list) + n_b: int = None + m: List[float] = field(default_factory=list) + + def __str__(self): + target_pressure_str = "\ttarget_pressure:\n" + "".join( + "\t\tP_L: " + + f"{self.target_pressure.P_L}\n" + + "\t\tP_N: " + + f"{self.target_pressure.P_N}\n" + ) + bonds_str = "\tbonds:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " f"{k.equilibrium}, {k.strength}\n") + for k in self.bonds + ] + ) + angle_str = "\tangle_bonds:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3}: " + + f"{k.equilibrium}, {k.strength}\n" + ) + for k in self.angle_bonds + ] + ) + dihedrals_str = "\tdihedrals:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: " + # This might need to be fixed/made prettier, probably + # there's an easier way + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ).join( + map( + str, + [ + [round(num, 3) for num in c_in] + if isinstance(c_in, list) + else c_in + for c_in in k.coeffs + ], + ) + ) + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ) + + f"dih_type = {k.dih_type}\n" + ) + for k in self.dihedrals + ] + ) + chi_str = "\tchi:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " + f"{k.interaction_energy}\n") + for k in self.chi + ] + ) + + """ If dielectric wanted as dictionary + dielectric_type_str = "\tdielectric_type:\n" + "".join( + [ + (f"\t\t{k.atom_1}: " + f"{k.dielectric_value}\n") + for k in self.dielectric_type + ] + ) + + """ + + thermostat_coupling_groups_str = "" + if any(self.thermostat_coupling_groups): + thermostat_coupling_groups_str = ( + "\tthermostat_coupling_groups:\n" + + "".join( + [ + "\t\t" + ", ".join([f"{n}" for n in ng]) + "\n" + for ng in self.thermostat_coupling_groups + ] + ) + ) + + ret_str = f'\n\n\tConfig: {self.file_name}\n\t{50 * "-"}\n' + for k, v in self.__dict__.items(): + if k not in ( + "target_pressure", + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "thermostat_coupling_groups", + ): + ret_str += f"\t{k}: {v}\n" + ret_str += ( + target_pressure_str + + bonds_str + + angle_str + + dihedrals_str + + chi_str + + thermostat_coupling_groups_str + ) + return ret_str
+ + +
[docs]def read_config_toml(file_path): + with open(file_path, "r") as in_file: + file_content = in_file.read() + return file_content
+ +
[docs]def parse_config_toml(toml_content, file_path=None, comm=MPI.COMM_WORLD): + config_dict = {} + + # read toml to a dictionary + toml_content = tomli.loads(toml_content) + + # Defaults = None + for n in ( + "box_size", + "n_print", + "tau", + "start_temperature", + "target_temperature", + "mass", + "hamiltonian", + "domain_decomposition", + "integrator", + "name", + "n_particles", + "max_molecule_size", + "coulombtype", + "convergence_type", + "dielectric_const", + "pol_mixing", + "conv_crit", + "dielectric_type", + "n_b", + "box_size", + "n_flush", + "self_energy", + "dtype", + ): + config_dict[n] = None + + # Defaults = [] + + for n in ( + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "tags", + "m", + "dielectric_type", + "target_pressure", + "type_charges", + ): + config_dict[n] = [] + + # Defaults: bool + config_dict["pressure"] = False + + # Flatten the .toml dictionary, ignoring the top level [tag] directives (if + # any). + for k, v in toml_content.items(): + if isinstance(v, dict): + if k == "nn": # Don't parse diff-hymd optimization options + continue + for nested_k, nested_v in v.items(): + config_dict[nested_k] = nested_v + else: + config_dict[k] = v + for k, v in config_dict.items(): + if k == "bonds": + config_dict["bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["bonds"][i] = Bond( + atom_1=b[0], + atom_2=b[1], + equilibrium=b[2], + strength=b[3], + ) + if k == "angle_bonds": + config_dict["angle_bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["angle_bonds"][i] = Angle( + atom_1=b[0], + atom_2=b[1], + atom_3=b[2], + equilibrium=b[3], + strength=b[4], + ) + if k == "dihedrals": + config_dict["dihedrals"] = [None] * len(v) + for i, b in enumerate(v): + try: + dih_type = int(b[2][0]) + except IndexError: + Logger.rank0.log( + logging.WARNING, "Dihedral type not provided, defaulting to 0." + ) + dih_type = 0 + + # Probably it's better to move this in check_dihedrals? + wrong_len = len(b[1]) not in (1, 2) + wrong_type_1 = len(b[1]) == 1 and not isinstance(b[1][0], float) + wrong_type_2 = len(b[1]) == 2 and not isinstance(b[1][0], list) + if wrong_len or wrong_type_1 or wrong_type_2: + err_str = ( + "The coefficients specified for the dihedral type " + "(0) do not match the correct structure. Either " + "use [lambda] or [[cn_prop], [dn_prop]], or select" + " the correct dihedral type." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise RuntimeError(err_str) + + # FIXME: this is messy af, I don't like it + if dih_type == 0 and isinstance(b[1][0], (float, int)): + coeff = propensity_potential_coeffs(b[1][0]) + elif dih_type == 1 and len(b[1]) == 3: + coeff = np.array( + propensity_potential_coeffs(b[1][0][0]).tolist() + + b[1][1:] + ) + elif dih_type == 2: + coeff = np.array(b[1]) + else: + coeff = np.insert(np.array(b[1]), 2, np.zeros((2, 5)), axis=0) + + config_dict["dihedrals"][i] = Dihedral( + atom_1=b[0][0], + atom_2=b[0][1], + atom_3=b[0][2], + atom_4=b[0][3], + coeffs=coeff, + dih_type=dih_type, + ) + if k == "chi": + config_dict["chi"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0], c[1]]) + config_dict["chi"][i] = Chi( + atom_1=c_[0], atom_2=c_[1], interaction_energy=c[2] + ) + + """ + if k == "dielectric_type": + config_dict["dielectric_type"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0][0]]) + config_dict["dielectric_type"][i] = Dielectric_type( + atom_1=c_[0], dielectric_value=c[1][0] + ) + """ + if k == "target_pressure": + if len(v) == 2: + config_dict["target_pressure"] = Target_pressure( + P_L=v[0], + P_N=v[1], # check condition # V array (still read as array?) + ) + elif len(v) == 1: + config_dict["target_pressure"] = Target_pressure(P_L=v[0], P_N=None) + else: + config_dict["target_pressure"] = Target_pressure(P_L=None, P_N=None) + + if file_path is not None: + config_dict["file_name"] = file_path + + for n in ( + "n_steps", "time_step", "mesh_size", "sigma", "kappa" + ): + if n not in config_dict: + err_str = ( + f"No {n} specified in config file {file_path}. Unable to start" + f" simulation." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return Config(**config_dict)
+ + +
[docs]def check_n_particles(config, indices, comm=MPI.COMM_WORLD): + n_particles = comm.allreduce(len(indices), MPI.SUM) + if config.n_particles is None: + config = copy.deepcopy(config) + config.n_particles = n_particles + info_str = ( + f"No n_particles found in toml file {config.file_name}, defaulting" + f" to indices.shape ({n_particles})" + ) + Logger.rank0.log(logging.INFO, info_str) + return config + + if n_particles != config.n_particles: + warn_str = ( + f"n_particles in {config.file_name} ({config.n_particles}) does " + "not match the shape of the indices array in the .HDF5 file " + f"({n_particles}). Defaulting to using indices.shape " + f"({n_particles})" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.n_particles = n_particles + return config
+ + +
[docs]def check_max_molecule_size(config, comm=MPI.COMM_WORLD): + if config.max_molecule_size is None: + info_str = ( + f"No max_molecule_size found in toml file {config.file_name}, " + f"defaulting to 201" + ) + Logger.rank0.log(logging.INFO, info_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + + if config.max_molecule_size < 1: + warn_str = ( + f"max_molecule_size in {config.file_name} must be a positive " + f"integer, not {config.max_molecule_size}, defaulting to 201" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + return config
+ + +def _find_unique_names(config, names, comm=MPI.COMM_WORLD): + unique_names = np.unique(names) + receive_buffer = comm.gather(unique_names, root=0) + + gathered_unique_names = None + if comm.Get_rank() == 0: + gathered_unique_names = np.unique(np.concatenate(receive_buffer)) + unique_names = comm.bcast(gathered_unique_names, root=0) + unique_names = sorted([n.decode("UTF-8") for n in unique_names]) + config.unique_names = unique_names + config.n_types = len(unique_names) + return config + + +def _setup_type_to_name_map(config, names, types, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + name_to_type_ = {} + for n, t in zip(names, types): + n = n.decode("utf-8") + if n not in name_to_type_: + name_to_type_[n] = t + receive_buffer = comm.gather(name_to_type_, root=0) + gathered_dict = None + if comm.Get_rank() == 0: + gathered_dict = {} + for d in receive_buffer: + for k, v in d.items(): + if k not in gathered_dict: + gathered_dict[k] = v + else: + assert v == gathered_dict[k] + name_to_type_map = comm.bcast(gathered_dict, root=0) + config.name_to_type_map = name_to_type_map + config.type_to_name_map = {v: k for k, v in name_to_type_map.items()} + return config + + +
[docs]def check_bonds(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for b in config.bonds: + if b.atom_1 not in unique_names or b.atom_2 not in unique_names: + missing_str = "" + if b.atom_1 not in unique_names: + if b.atom_2 not in unique_names: + if b.atom_1 == b.atom_2: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"neither {b.atom_1}, {b.atom_2} atoms" + else: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"no {b.atom_2} atoms" + + warn_str = ( + f"Bond type {b.atom_1}--{b.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_angles(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for a in config.angle_bonds: + if ( + a.atom_1 not in unique_names + or a.atom_2 not in unique_names + or a.atom_3 not in unique_names + ): + missing = [ + a.atom_1 not in unique_names, + a.atom_2 not in unique_names, + a.atom_3 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([a.atom_1, a.atom_2, a.atom_3]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Angle bond type {a.atom_1}--{a.atom_2}--{a.atom_3} " + f"specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_dihedrals(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for d in config.dihedrals: + if ( + d.atom_1 not in unique_names + or d.atom_2 not in unique_names + or d.atom_3 not in unique_names + or d.atom_4 not in unique_names + ): + missing = [ + d.atom_1 not in unique_names, + d.atom_2 not in unique_names, + d.atom_3 not in unique_names, + d.atom_4 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([d.atom_1, d.atom_2, d.atom_3, d.atom_4]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Dihedral type {d.atom_1}--{d.atom_2}--{d.atom_3}--{d.atom_4}" + f" specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_chi(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for c in config.chi: + if c.atom_1 not in unique_names or c.atom_2 not in unique_names: + missing_str = "" + if c.atom_1 not in unique_names: + if c.atom_2 not in unique_names: + if c.atom_1 == c.atom_2: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"neither {c.atom_1}, {c.atom_2} atoms" + else: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"no {c.atom_2} atoms" + + warn_str = ( + f"Chi interaction {c.atom_1}--{c.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + for i, n in enumerate(unique_names): + for m in unique_names[i + 1 :]: + found = False + for c in config.chi: + if (c.atom_1 == n and c.atom_2 == m) or ( + c.atom_1 == m and c.atom_2 == n + ): + found = True + if not found: + config.chi.append(Chi(atom_1=n, atom_2=m, interaction_energy=0.0)) + warn_str = ( + f"Atom types {n} and {m} found in the " + f"system, but no chi interaction {n}--{m} " + f"specified in {config.file_name}. Defaulting to " + f"chi[{n}, {m}] = 0" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_box_size(config, input_box, comm=MPI.COMM_WORLD): + if config.box_size is not None: + config.box_size = np.array(config.box_size, dtype=np.float32) + if input_box.all() and not np.allclose(config.box_size, input_box, atol=0.009): + err_str = ( + f"Box size specified in {config.file_name}: " + f"{config.box_size} does not match input box:" + f"{input_box}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + else: + if input_box.all(): + config.box_size = input_box + else: + err_str = f"No box information found" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + for b in config.box_size: + if b <= 0.0: + err_str = ( + f"Invalid box size specified in {config.file_name}: " + f"{config.box_size}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return config
+ + +
[docs]def check_integrator(config, comm=MPI.COMM_WORLD): + if config.integrator.lower() not in ("velocity-verlet", "respa"): + err_str = ( + f"Invalid integrator specified in {config.file_name}: " + f'{config.integrator}. Available options "velocity-verlet" or ' + f'"respa".' + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + if config.integrator.lower() == "respa": + if isinstance(config.respa_inner, float): + warn_str = ( + f"Number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner} specified " + f"as float, using {int(config.respa_inner)}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = int(config.respa_inner) + elif not isinstance(config.respa_inner, int): + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + + if config.respa_inner <= 0: + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + if config.integrator.lower() == "velocity-verlet" and config.respa_inner != 1: + warn_str = ( + f"Integrator type Velocity-Verlet specified in {config.file_name} " + f"and inner rRESPA time steps set to {config.respa_inner}. " + f"Using respa_inner = 1" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = 1 + + return config
+ + +
[docs]def check_hamiltonian(config, comm=MPI.COMM_WORLD): + valid_hamiltonians = ["defaultnochi", "defaultwithchi", "squaredphi"] + + if config.hamiltonian is None: + if len(config.chi) == 0: + warn_str = ( + f"No hamiltonian form and no chi interactions specified in " + f"{config.file_name}, defaulting to DefaultNoChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultNoChi" + else: + warn_str = ( + f"No hamiltonian form specified in {config.file_name}, but " + f"chi interactions are specified, defaulting to " + f"DefaultWithChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultWithChi" + elif config.hamiltonian.lower() not in valid_hamiltonians: + err_str = ( + f"The specified Hamiltonian {config.hamiltonian} was not " + f"recognized as a valid Hamiltonian." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise NotImplementedError(err_str) + + return config
+ + +
[docs]def check_n_flush(config, comm=MPI.COMM_WORLD): + if config.n_print: + if config.n_flush is None: + config.n_flush = 10000 // config.n_print + return config
+ + +
[docs]def check_n_print(config, comm=MPI.COMM_WORLD): + if ( + not isinstance(config.n_print, int) + and not isinstance(config.n_print, float) + and config.n_print is not None + ): + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if config.n_print is None or config.n_print <= 0: + config.n_print = False + elif not isinstance(config.n_print, int): + if isinstance(config.n_print, float): + warn_str = ( + f"n_print is a float ({config.n_print}), not int, using " + f"{int(round(config.n_print))}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + config.n_print = int(round(config.n_print)) + else: + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + return config
+ + +
[docs]def check_tau(config, comm=MPI.COMM_WORLD): + if config.tau is None and config.target_temperature is not None: + warn_str = "target temp specified but no tau, defaulting 0.7" + config.tau = 0.7 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_start_and_target_temperature(config, comm=MPI.COMM_WORLD): + """Validate provided starting and target thermostat temperatures + + Assesses the provided temperature target and ensures it is a non-negative + floating point number or :code:`False`. Ensures the starting temperature is + a non-negative floating point number or :code:`False`. + + If the value for either is :code:`None`, the returned configuration object + has the values defaulted to :code:`False` in each case. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ------- + validated_config : Config + Configuration object with validated :code:`target_temperature` and + :code:`start_temperature`. + """ + for t in ("start_temperature", "target_temperature"): + if getattr(config, t) is not None: + try: + if getattr(config, t) < 0: + warn_str = ( + f"{t} set to negative value ({getattr(config, t)}), " + f"defaulting to False" + ) + setattr(config, t, False) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + except TypeError as e: + err_str = ( + f"Could not interpret {t} = {repr(getattr(config, t))} as " + f"a number." + ) + raise TypeError(err_str) from e + + if config.start_temperature is None: + config.start_temperature = False + if config.target_temperature is None: + config.target_temperature = False + return config
+ + +
[docs]def check_mass(config, comm=MPI.COMM_WORLD): + if config.mass is None: + info_str = "no mass specified, defaulting to 72.0" + config.mass = 72.0 + Logger.rank0.log(logging.INFO, info_str) + elif not isinstance(config.mass, int) and not isinstance(config.mass, float): + err_str = ( + f"specified mass is invalid type {config.mass}, " f"({type(config.mass)})" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + elif config.mass < 0: + err_str = f"invalid mass specified, {config.mass}" + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + else: + config.mass = float(config.mass) + + return config
+ + +
[docs]def check_domain_decomposition(config, comm=MPI.COMM_WORLD): + dd = config.domain_decomposition + if dd is None or dd is False: + config.domain_decomposition = False + return config + + if isinstance(dd, int): + if dd < 0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + elif isinstance(dd, float): + if dd < 0.0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + else: + warn_str = ( + f"domain_decomposition ({config.domain_decomposition}) is not " + f"an integer, using {int(round(dd))}" + ) + config.domain_decomposition = int(round(dd)) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + else: + err_str = ( + f"invalid value for domain_decomposition " + f"({config.domain_decomposition}) use an integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + return config
+ + +
[docs]def check_name(config, comm=MPI.COMM_WORLD): + if config.name is None: + root_current_time = "" + if comm.Get_rank() == 0: + root_current_time = datetime.datetime.now().strftime("%m/%d/%Y, %H:%M:%S") + current_time = comm.bcast(root_current_time, root=0) + + if config.name is None: + config.name = "sim" + current_time + else: + config.name = str(config.name) + return config
+ + +
[docs]def check_NPT_conditions(config, comm=MPI.COMM_WORLD): + """ + Check validity of barostat_type, barostat, + a, rho0, target_pressure, tau_p + """ + if config.barostat is None: + if ( + config.tau_p is not None + or (config.target_pressure.P_L and config.target_pressure.P_N) is not None + ): + err_str = ( + "barostat not specified but config.tau_p " + "or config.target_pressure specified, cannot start simulation {config.barostat}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.a: + warn_str = "a specified but no barostat," "setting a to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.rho0: + warn_str = ( + "rho0 specified but no barostat," "setting rho0 to average density" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + if config.barostat is not None: + if not config.barostat_type: + config.barostat_type = "berendsen" + warn_str = "barostat_type not specified," "setting to berendsen" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.barostat != "isotropic" and config.barostat != "semiisotropic": + err_str = "barostat option not recognised. Valid options: isotropic, semiisotropic" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.target_pressure.P_L is None: + config.target_pressure.P_L = 1.0 # bar + config.target_pressure.P_N = None + if config.barostat == "semiisotropic": + config.target_pressure.P_N = 1.0 # bar + warn_str = ( + "barostat specified but no target_pressure, defaulting to 1.0 bar" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.tau_p is None: + if config.tau <= 0.1: + config.tau_p = config.tau * 10.0 + else: + config.tau_p = 1.0 + warn_str = "barostat specified but no tau_p, defaulting to " + str( + config.tau_p + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if not config.a: + err_str = "a not specified; cannot start simulation {config.a}" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if not config.rho0: + warn_str = "rho0 not specified;" "setting rho0 to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + return config
+ + +
[docs]def check_thermostat_coupling_groups(config, comm=MPI.COMM_WORLD): + if any(config.thermostat_coupling_groups): + found = [0 for _ in config.unique_names] + unique_names = [n for n in config.unique_names] + for i, group in enumerate(config.thermostat_coupling_groups): + for species in group: + try: + ind = unique_names.index(species) + found[ind] += 1 + except ValueError as e: + err_str = ( + f"Particle species {species} specified in thermostat " + f"coupling group {i}, but no {species} particles were " + "found in the system." + ) + raise ValueError(err_str) from e + if any([True if f > 1 else False for f in found]): + for i, f in enumerate(found): + if f > 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} specified in multiple " + "thermostat coupling groups; " + f"{config.thermostat_coupling_groups}." + ) + raise ValueError(err_str) + if not all([True if f == 1 else False for f in found]): + for i, f in enumerate(found): + if f != 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} not specified in any " + f"thermostat coupling group, but {species} particles " + "were found in the system" + ) + raise ValueError(err_str) + return config
+ + +
[docs]def check_m(config, comm=MPI.COMM_WORLD): + if config.m == []: + config.m = [1.0 for t in range(config.n_types)] + return config
+ + +
[docs]def check_n_b(config, comm=MPI.COMM_WORLD): + if config.n_b is None: + warn_str = f"config.n_b not specified." "Defaulting to 1" + config.n_b = 1 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_cancel_com_momentum(config, comm=MPI.COMM_WORLD): + if isinstance(config.cancel_com_momentum, int): + if config.cancel_com_momentum == 0 or config.cancel_com_momentum < 0: + config.cancel_com_momentum = False + elif not isinstance(config.cancel_com_momentum, bool): + err_str = ( + f"Could not interpret {config.cancel_com_momentum} as an integer " + f"or boolean." + ) + raise ValueError(err_str) + return config
+ + +
[docs]def sort_dielectric_by_type_id(config, charges, types): + """ + Creates a list of length N CG-particles, sorted after the charges from + the input HDF5 file. Used in file_io.py + """ + dielectric_val = np.zeros(config.n_types) + for j in range(config.n_types): + name = config.dielectric_type[j][0][0] + type_id = config.name_to_type_map[name] + dielectric_val[type_id] = config.dielectric_type[j][1][0] + config.dielectric_type = dielectric_val.copy() + + N = len(charges) + len_list = np.zeros(config.n_types) + dielectric_by_types = np.zeros(N) + for i in range(N): + dielectric_by_types[i] = dielectric_val[types[i]] + # print("types ", types) + # print("diel val", dielectric_by_types) + # print("charges", charges) + # print(config.name_to_type_map) + return dielectric_by_types # by types with each particle id
+ + +
[docs]def check_charges_types_list(config, types, charges, comm=MPI.COMM_WORLD): + """ + Creates a list of charge values of length types. + Charges are sorted according to type ID. Used in field.py. + # TODO: this is messy, we should fix it + """ + if charges is None: + config.type_charges = [0.0] * config.n_types + return config + + check_val = -100.0 # some random value that will never be encountered + charges_list = np.full(config.n_types, check_val) # gatherv cant handle None + rank = comm.Get_rank() + # print(charges_list) + for t_ in range(config.n_types): + if t_ in types: + charges_list[t_] = charges[types == t_][0] + + nprocs = int(comm.Get_size()) + recv_charges = None + if rank == 0: + recv_charges = np.full( + config.n_types * nprocs, check_val + ) # gatherv cant handle None + comm.Gather(charges_list, recv_charges, root=0) + + ## make a charges list + if rank == 0: + config_charges = np.zeros(config.n_types) + test_config = np.full(config.n_types, check_val) + for j in range(nprocs): + for i in range(config.n_types): + if recv_charges[i + j * config.n_types] != check_val: + config_charges[i] = recv_charges[i + j * config.n_types] + if np.any([test_config, config_charges]): + continue + else: + break + + # print(config_charges) + # print(config.name_to_type_map) + # print(charges[types == 0][0],charges[types == 1][0],charges[types == 2][0],charges[types == 3][0], + # charges[types == 4][0]) + else: + config_charges = np.zeros(config.n_types) + + comm.Bcast(config_charges, root=0) + # print("config_charges", config_charges , "rank", rank) + # print(recv_charges) + # rank = comm.Get_rank() + # print(all_charges) + config.type_charges = config_charges + return config
+ + +
[docs]def check_dielectric(config, comm=MPI.COMM_WORLD): + """ + Error handling for electrostatics. + Unit testing of toml/tomli input. + """ + err_str_const = "Dielectric constant not given." + if config.coulombtype == "PIC_Spectral": + assert config.dielectric_const != None, err_str_const + + err_str = "Dielectric list is empty." + if config.coulombtype == "PIC_Spectral_GPE": + assert len(config.dielectric_type) != 0, err_str + # default values + if config.pol_mixing is None: + config.pol_mixing = 0.6 + if config.conv_crit is None: + config.conv_crit = 1e-6 + return config
+ + +
[docs]def check_charges(config, charges, comm=MPI.COMM_WORLD): + """Check if charges across ranks sum to zero. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of floats with charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + """ + total_charge = comm.allreduce(np.sum(charges), MPI.SUM) + + if not np.isclose(total_charge, 0.0): + warn_str = ( + f"Charges in the input file do not sum to zero. " + f"Total charge is {total_charge}." + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + # if charges are ok, compute self energy + if config.coulombtype == "PIC_Spectral": + from .field import compute_self_energy_q + + config.self_energy = compute_self_energy_q(config, charges, comm=comm) + + return config
+ + +
[docs]def check_config( + config, indices, names, types, charges, input_box, comm=MPI.COMM_WORLD +): + """Performs various checks on the specfied config to ensure consistency + + Parameters + ---------- + config : Config + Configuration object. + indices : (N,) numpy.ndarray + Array of integer indices for :code:`N` particles. + names : (N,) numpy.ndarray + Array of string names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of integer type indices for :code:`N` particles. + charges : (N,) numpy.ndarray + Array of floats charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + + Returns + ------- + config : Config + Validated configuration object. + """ + config = _find_unique_names(config, names, comm=comm) + if types is not None: + config = _setup_type_to_name_map(config, names, types, comm=comm) + config = check_box_size(config, input_box, comm=comm) + config = check_integrator(config, comm=comm) + config = check_max_molecule_size(config, comm=comm) + config = check_tau(config, comm=comm) + config = check_start_and_target_temperature(config, comm=comm) + config = check_mass(config, comm=comm) + config = check_domain_decomposition(config, comm=comm) + config = check_name(config, comm=comm) + config = check_n_particles(config, indices, comm=comm) + config = check_chi(config, names, comm=comm) + config = check_bonds(config, names, comm=comm) + config = check_angles(config, names, comm=comm) + config = check_dihedrals(config, names, comm=comm) + config = check_hamiltonian(config, comm=comm) + config = check_NPT_conditions(config, comm=comm) + config = check_n_b(config, comm=comm) + config = check_m(config, comm=comm) + config = check_thermostat_coupling_groups(config, comm=comm) + config = check_cancel_com_momentum(config, comm=comm) + config = check_dielectric(config, comm=comm) + config = check_n_print(config, comm=comm) + config = check_n_flush(config, comm=comm) + config = check_charges_types_list(config, types, charges, comm=comm) + if charges is not None: + config = check_charges(config, charges, comm=comm) + + return config
+
+ +
+
+ +
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/_modules/hymd/integrator.html b/main/_modules/hymd/integrator.html new file mode 100644 index 00000000..0f81004a --- /dev/null +++ b/main/_modules/hymd/integrator.html @@ -0,0 +1,368 @@ + + + + + + hymd.integrator — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.integrator

+"""Integrates equations of motion.
+
+Implements the Velocity Verlet integrator. The *reversible reference system
+propagator algorithm* (rRESPA) integrator uses the Velocity Verlet functions
+inside the MD loop in the main module.
+"""
+
+
+
[docs]def integrate_velocity(velocities, accelerations, time_step): + """Velocity update step of the Velocity Verlet integration algorithm. + + Computes the velocity update step of the Velocity Verlet algorithm. The + :code:`velocities` argument is **not** changed in place. + + Parameters + ---------- + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + accelerations : (N, D) numpy.ndarray + Array of accelerations of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step + + .. math:: \\mathbf{v}_{\\text{new}} = \\mathbf{v} + \\frac{\\Delta t}{2m} + \\mathbf{f} + + before the positions are moved a full step using the updated half-step + velocities. + + See Also + -------- + integrate_position : The position update step of the Velocity Verlet + algorithm. + """ + return velocities + 0.5 * time_step * accelerations
+ + +
[docs]def integrate_position(positions, velocities, time_step): + """Position update step of the Velocity Verlet integration algorithm. + + Computes the position update step of the Velocity Verlet algorithm. The + :code:`positions` argument is **not** changed in place. + + Parameters + ---------- + positions : (N, D) numpy.ndarray + Array of positions of :code:`N` particles in :code:`D` dimensions. + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step, then the positions are updated a full step using the updated + velocities + + .. math:: \\mathbf{x}_{\\text{new}} = \\mathbf{x} + \\Delta t \\mathbf{v} + + See Also + -------- + integrate_velocity : The velocity update step of the Velocity Verlet + algorithm. + """ + return positions + time_step * velocities
+
+ +
+
+ +
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/_modules/hymd/logger.html b/main/_modules/hymd/logger.html new file mode 100644 index 00000000..3091a7c6 --- /dev/null +++ b/main/_modules/hymd/logger.html @@ -0,0 +1,557 @@ + + + + + + hymd.logger — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.logger

+"""Handles event logging for simulation information, warnings, and errors.
+"""
+import sys
+import os
+import logging
+from mpi4py import MPI
+from .version import __version__
+
+
+
[docs]class MPIFilterRoot(logging.Filter): + """Log output Filter wrapper class for the root MPI rank log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + if self.comm.Get_rank() == 0: + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True + else: + return False
+ + +
[docs]class MPIFilterAll(logging.Filter): + """Log output Filter wrapper class for the all-MPI-ranks log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True
+ + +class MPIFilterStdout(logging.Filter): + """Log output Filter wrapper class for filtering STDOUT log""" + + def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.funcName = "replica 0 " + record.funcName + if MPI.COMM_WORLD.Get_rank() == 0: + record.rank = MPI.COMM_WORLD.Get_rank() + record.size = MPI.COMM_WORLD.Get_size() + return True + else: + return False + + +
[docs]class Logger: + """Log output handler class + + Notes + ----- + This wraps the default python library :code:`logging`, see + `docs.python.org/3/library/logging.html`_. + + .. _`docs.python.org/3/library/logging.html`: + https://docs.python.org/3/library/logging.html + + Attributes + ---------- + level : int + Determines the verbosity level of the log, corresponding to + logging.level. Numerical values :code:`50` (:code:`logging.CRITICAL`), + :code:`40` (:code:`logging.ERROR`), :code:`30` + (:code:`logging.WARNING`), :code:`20` (:code:`logging.INFO`), + :code:`10` (:code:`logging.DEBUG`), and :code:`0` + (:code:`logging.UNSET`) are supported values. Any log event message + less severe than the specified level is ignored. All other event + messages are emitted. + log_file : str + Path to output log file. + format : str + Prepended dump string for each log event. Specifies the log event + level, the module emitting the event, the code line, the enclosing + function name, and the MPI rank writing the message. + date_format : str + Prepends the date before all log event messages. + formatter : logging.Formatter + Formatter handling the prepending of the information in `format` and + `date_format` to each log event message. Used by default for all + loggers. + rank0 : logging.Logger + Default logger object for the root MPI rank. + all_ranks : logging.Logger + Default logger object for messages being emitted from all MPI ranks + simultaneously. + """ + + level = None + log_file = None + format = " %(levelname)-8s [%(filename)s:%(lineno)d] <%(funcName)s> {rank %(rank)d/%(size)d} %(message)s" # noqa: E501 + date_format = "%(asctime)s" + formatter = logging.Formatter(fmt=date_format + format) + rank0 = logging.getLogger("HyMD.rank_0") + all_ranks = logging.getLogger("HyMD.all_ranks") + +
[docs] @classmethod + def setup(cls, default_level=logging.INFO, log_file=None, verbose=False, comm=MPI.COMM_WORLD): + """Sets up the logger object. + + If a :code:`log_file` path is provided, log event messages are output + to it. Otherwise, the logging messages are emitted to stdout. + + Parameters + ---------- + default_level : int, optional + Default verbosity level of the logger. Unless specified, it is + :code:`10` (:code:`logging.INFO`). + log_file : str, optional + Path to output log file. If `None` or not priovided, no log file is + used and all logging is done to stdout. + verbose : bool, optional + Increases the logging level to :code:`30` (:code:`logging.WARNING`) + if True, otherwise leaves the logging level unchanged. + """ + cls.level = default_level + cls.log_file = log_file + + log_to_stdout = False + if verbose: + log_to_stdout = True + + level = default_level + if not verbose: + level = logging.WARNING + cls.rank0.setLevel(level) + cls.all_ranks.setLevel(level) + + root_filter = MPIFilterRoot(comm) + all_filter = MPIFilterAll(comm) + cls.rank0.addFilter(root_filter) + cls.all_ranks.addFilter(all_filter) + + if (not log_file) and (not log_to_stdout): + return + if log_file: + cls.log_file_handler = logging.FileHandler(log_file) + cls.log_file_handler.setLevel(level) + cls.log_file_handler.setFormatter(cls.formatter) + + cls.rank0.addHandler(cls.log_file_handler) + cls.all_ranks.addHandler(cls.log_file_handler) + if log_to_stdout: + cls.log_to_stdout = True + cls.stdout_handler = logging.StreamHandler() + cls.stdout_handler.setLevel(level) + cls.stdout_handler.setStream(sys.stdout) + cls.stdout_handler.setFormatter(cls.formatter) + cls.stdout_handler.addFilter(MPIFilterStdout()) + + cls.rank0.addHandler(cls.stdout_handler) + cls.all_ranks.addHandler(cls.stdout_handler)
+ + +def format_timedelta(timedelta): + days = timedelta.days + hours, rem = divmod(timedelta.seconds, 3600) + minutes, seconds = divmod(rem, 60) + microseconds = timedelta.microseconds + ret_str = "" + if days != 0: + ret_str += f"{days} days " + ret_str += f"{hours:02d}:{minutes:02d}:{seconds:02d}.{microseconds:06d}" + return ret_str + + +def get_version(): + # Check if we are in a git repo and grab the commit hash and the branch if + # we are, append it to the version number in the output specification. + try: + import git + + try: + repo_dir = os.path.abspath( + os.path.join(os.path.dirname(__file__), os.pardir) + ) + repo = git.Repo(repo_dir) + commit = str(repo.head.commit)[:7] + branch = repo.active_branch + version = f"{__version__} [{branch} branch commit {commit}]" + except git.exc.InvalidGitRepositoryError: + version = f"{__version__}" + except ModuleNotFoundError: + version = f"{__version__}" + + return version + + +def print_header(): + banner = r""" + __ __ ____ __ _______ + / / / /_ __/ / /__ _________ _____ ______ / |/ / __ \ + / /_/ / / / / / / _ \/ ___/ __ `/ __ `/ ___/ / /|_/ / / / / + / __ / /_/ / / / __/ / / /_/ / /_/ (__ ) / / / / /_/ / + /_/ /_/\__, /_/_/\___/_/ \__,_/\__,_/____/ /_/ /_/_____/ + /____/ + """ + + refs_set = """ + + [1] Ledum, M.; Sen, S.; Li, X.; Carrer, M.; Feng Y.; Cascella, M.; Bore, S. L. + HylleraasMD: A Domain Decomposition-Based Hybrid Particle-Field Software for Multi-Scale Simulations of Soft Matter. + J. Chem. Theory Comput. 2023. + + [2] Ledum, M.; Carrer, M.; Sen, S.; Li, X.; Cascella, M.; Bore, S. L. + HyMD: Massively parallel hybrid particle-field molecular dynamics in Python. + J. Open Source Softw. 8(84), 4149, 2023. + + [3] Sen, S.; Ledum, M.; Bore, S. L.; Cascella, M. + Soft Matter under Pressure: Pushing Particle–Field Molecular Dynamics to the Isobaric Ensemble. + J Chem Inf Model 2023, 63(7), 1549-9596. + + [4] Bore, S. L.; Cascella, M. + Hamiltonian and alias-free hybrid particle–field molecular dynamics. + J. Chem. Phys. 2020, 153, 094106. + + [5] Pippig, M. PFFT: An extension of FFTW to massively parallel architectures. + SIAM J. Sci. Comput. 2013, 35, C213–C236. + +""" + + version = f"Version {get_version()}" + header = banner + header += version.center(56) + "\n\n" + #header += " Please read and cite the references below:" + header += " PLEASE READ AND CITE THE REFERENCES BELOW:" + header += refs_set + + return header +
+ +
+
+ +
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/_modules/hymd/plumed.html b/main/_modules/hymd/plumed.html new file mode 100644 index 00000000..2be09fc4 --- /dev/null +++ b/main/_modules/hymd/plumed.html @@ -0,0 +1,530 @@ + + + + + + hymd.plumed — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.plumed

+"""Class to wrap PLUMED for use within HyMD.
+"""
+
+import numpy as np
+import logging
+import os
+from mpi4py import MPI
+from .logger import Logger
+
+
+
[docs]class PlumedBias: + """PLUMED handler class + + Notes + ----- + This wraps the :code:`Plumed()` class, see + `https://github.com/plumed/plumed2/tree/master/python`. + + The :code:`PlumedBias()` object is created with the arguments from + :code:`__init__` and at everystep the methods :code:`prepare()` and + :code:`calc()` should be called. + + Attributes + ---------- + plumed_obj : plumed.Plumed + Plumed object used to pass and request information from PLUMED. + plumed_forces : (N, D) numpy.ndarray + Array of forces of :code:`N` particles in :code:`D` dimensions. + After :code:`calc()`, this array contains only the forces due + to the PLUMED bias. + positions : (N, D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + Needed because we need C-contiguous array for passing to PLUMED. + plumed_bias : (1,) numpy.ndarray + Used as a pointer to an :code:`double` to store the bias energy. + plumed_version : (1,) numpy.ndarray + Used as a pointer to an :code:`int` to store PLUMED API version. + intracomm : mpi4py.Comm + MPI communicator to use for rank communication within a replica. + intercomm : mpi4py.Comm + MPI communicator to use for rank communication between replicas. + ready : bool + Stores wether the :code:`calc()` method can be called or not. + """ + + plumed_obj = None + plumed_forces = None + positions = None + charges = None + plumed_bias = np.zeros(1, np.double) + plumed_version = np.zeros(1, dtype=np.intc) + intracomm = None + intercomm = None + ready = False + verbose = None + + def __init__(self, config, plumeddat, logfile, intracomm=MPI.COMM_WORLD, intercomm=None, verbose=1): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + plumeddat : str + Path file containing PLUMED input. + logfile : str + Path to PLUMED's output file + intracomm : mpi4py.Comm, optional + MPI communicator to use for rank communication within a replica. + intercomm : mpi4py.Comm, optional + MPI communicator to use for rank communication between replicas. + verbose : int, optional + Specify the logging event verbosity of this object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + try: + import plumed + except ImportError: + err_str = ( + "You are trying to use PLUMED but HyMD could not import py-plumed." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ImportError(err_str) + + self.intracomm = intracomm + self.intercomm = intercomm + self.verbose = verbose + + try: + kernel_str = "Using PLUMED_KERNEL={}".format(os.environ["PLUMED_KERNEL"]) + except: + kernel_str = "The PLUMED_KERNEL environment variable is not set." + + Logger.rank0.log(logging.INFO, kernel_str) + + try: + self.plumed_obj = plumed.Plumed() + except: + err_str = ( + "HyMD was not able to create a PLUMED object. " + "Maybe there is a problem with your PLUMED_KERNEL?" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + self.plumed_obj.cmd("getApiVersion", self.plumed_version) + if self.plumed_version[0] <= 3: + err_str = "HyMD requires a PLUMED API > 3. Use a newer PLUMED kernel." + Logger.rank0.log(logging.ERROR, err_str) + raise AssertionError(err_str) + + self.plumed_obj.cmd("setMDEngine", "HyMD") + + if intercomm is not None: + if intracomm.Get_rank() == 0: + self.plumed_obj.cmd("GREX setMPIIntercomm", intercomm) + self.plumed_obj.cmd("GREX setMPIIntracomm", intracomm) + self.plumed_obj.cmd("GREX init") + + self.plumed_obj.cmd("setMPIComm", intracomm) + + Logger.rank0.log( + logging.INFO, f"Attempting to read PLUMED input from {plumeddat}" + ) + + self.plumed_obj.cmd("setPlumedDat", plumeddat) + self.plumed_obj.cmd("setLogFile", logfile) + self.plumed_obj.cmd("setTimestep", config.respa_inner * config.time_step) + self.plumed_obj.cmd("setNatoms", config.n_particles) + self.plumed_obj.cmd("setKbT", config.gas_constant * config.target_temperature) + self.plumed_obj.cmd("setNoVirial") + self.plumed_obj.cmd("init") + + Logger.rank0.log( + logging.INFO, + f"Successfully read PLUMED input. PLUMED output file is {logfile}", + ) + +
[docs] def finalize(self): + """Finalize object""" + self.plumed_obj.finalize()
+ + def __enter__(self): + """Allow usage in 'with' context""" + return self + + def __exit__(self, exc_type, exc_value, traceback): + """Finalize on exit of context""" + self.plumed_obj.__exit__(exc_type, exc_value, traceback) + + @property + def api_version(self): + """Returns the API version got from the PLUMED kernel.""" + return self.plumed_version[0] + +
[docs] def prepare(self, step, forces, positions, indices, config, charges): + """Set the pointers to positions and forces, and returns + wether the potential energy is being requested by PLUMED or not. + """ + if self.verbose > 1: + Logger.rank0.log(logging.INFO, f"Setting PLUMED pointers for step {step}") + self.plumed_forces = forces.ravel(order="C").astype(np.double) + self.charges = charges.astype(np.double) + self.positions = positions.ravel(order="C").astype( + np.double + ) # get C-contiguous array + + needs_energy = np.zeros(1, np.intc) + # plumed_virial = np.zeros((3,3), dtype=np.double) + masses = np.full_like(indices, config.mass, dtype=np.double) + box = np.diag(config.box_size).astype(np.double) + + self.plumed_obj.cmd("setAtomsNlocal", indices.shape[0]) + self.plumed_obj.cmd("setAtomsGatindex", indices) + self.plumed_obj.cmd("setStep", step) + self.plumed_obj.cmd("setForces", self.plumed_forces) + self.plumed_obj.cmd("setPositions", self.positions) + self.plumed_obj.cmd("setCharges", self.charges) + self.plumed_obj.cmd("setMasses", masses) + self.plumed_obj.cmd("setBox", box) + # self.plumed_obj.cmd("setVirial", plumed_virial) + + # check if PLUMED needs energy and returns + self.plumed_obj.cmd("prepareCalc") + self.plumed_obj.cmd("isEnergyNeeded", needs_energy) + + self.ready = True + return True if needs_energy[0] != 0 else False
+ +
[docs] def calc(self, forces, poteng): + """Passes the energy (which can be set to any value in case + :code:`prepare()` returns PLUMED doesn't need it) to get + the forces and energy from the bias. + """ + if not self.ready: + err_str = ( + "Trying to calculate PLUMED biased forces " + "without first calling prepare method." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if self.verbose > 1: + Logger.rank0.log(logging.INFO, "Calculating PLUMED forces") + + # set the energy and calc + self.plumed_obj.cmd("setEnergy", poteng) + self.plumed_obj.cmd("performCalc") + self.plumed_obj.cmd("getBias", self.plumed_bias) + + # check if the returned forces are valid + if np.isnan(self.plumed_forces).any(): + err_str = ( + "Forces returned by PLUMED are not valid. " + "It means there's a NaN in the computed forces, " + "and your input should be checked. " + ) + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + # subtract forces to get only the bias' extra force + self.plumed_forces -= forces.ravel(order="C") + + if self.verbose > 1: + Logger.rank0.log(logging.INFO, "Done calculating PLUMED forces") + + self.ready = False + return ( + np.asfortranarray(np.reshape(self.plumed_forces, forces.shape, order="C")), + self.plumed_bias[0], + )
+
+ +
+
+ +
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/_modules/hymd/pressure.html b/main/_modules/hymd/pressure.html new file mode 100644 index 00000000..06d03385 --- /dev/null +++ b/main/_modules/hymd/pressure.html @@ -0,0 +1,474 @@ + + + + + + hymd.pressure — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.pressure

+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import sympy
+from .field import comp_laplacian
+
+
+
[docs]def comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fourier, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=MPI.COMM_WORLD, +): + """ + Computes total internal pressure of the system. + Kinetic pressure is trivially calculated from the kinetic energy. + Already computed bond and angle pressure terms are inserted into the + total internal pressure. + The field pressure equation is implemented. + + Parameters + ---------- + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fourier : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pressure : (18,) numpy.ndarray + Pressure contributions from various energy terms. + 0: due to kinetic energy + 1-5: due to field energy + 6-8: due to two-particle bonded terms + 9-11: due to three-particle bonded terms (called angle terms) + 12-14: due to four-particle bonded terms (called dihedral terms) + (defaults to 0 currently. Yet to be implemented) + 15-17: total pressure in x,y,z directions. + """ + rank = comm.Get_rank() + size = comm.Get_size() + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + w_elec = 0.0 + if (config.coulombtype == "PIC_Spectral_GPE") or ( + config.coulombtype == "PIC_Spectral" + ): + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + w = w_0 + w_elec + + # Kinetic term + kinetic_energy = 0.5 * config.mass * np.sum(velocities**2) + p_kin = 2 / (3 * V) * kinetic_energy + + # Term 1 + p0 = -1 / V * np.sum(w) + + # Term 2 + if psi is not None: # if using electrostatics + V_bar = np.array([hamiltonian.V_bar[k]([phi, psi]) for k in range(config.n_types)]) + else: + V_bar = np.array([hamiltonian.V_bar_0[k](phi) for k in range(config.n_types)]) + + p1 = np.sum((volume_per_cell / V) * V_bar * phi) + + # Term 3 + comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, + ) + + p2 = np.sum( + volume_per_cell + / V + * config.sigma**2 + * np.repeat(V_bar[:, np.newaxis, :, :, :], 3, axis=1) + * phi_laplacian, + axis=(0, 2, 3, 4), + ) + + # Bonded force term: linking 2 particles + p_bond = bond_pr / V + + # Angle force term: linking 3 particles + p_angle = angle_pr / V + + # TODO: Dihedral angle force term: linking 4 atoms + p_dihedral = np.zeros(3) + + # Add formal parameter dihedral_forces as: comp_pressure(..., dihedral_forces) + # Define dictionary: + # forces = { + # 'x': dihedral_forces[:,0], + # 'y': dihedral_forces[:,1], + # 'z': dihedral_forces[:,2] + # } + # Compute the pressure due to dihedrals as: + # p_dihedral = { + # 'x': np.sum( np.multiply(forces['x'],positions[:,0]) )*(1/V), + # 'y': np.sum( np.multiply(forces['y'],positions[:,1]) )*(1/V), + # 'z': np.sum( np.multiply(forces['z'],positions[:,2]) )*(1/V) + # } + + # Total pressure in x, y, z + p_tot = p_kin + p0 + p1 + p2 + p_bond + p_angle + p_dihedral + + return_value = np.array( + [ + p_kin, + p0, + p1, + p2[0], + p2[1], + p2[2], + p_bond[0], + p_bond[1], + p_bond[2], + p_angle[0], + p_angle[1], + p_angle[2], + p_dihedral[0], + p_dihedral[1], + p_dihedral[2], + p_tot[0], + p_tot[1], + p_tot[2], + ] + ) + return_value = comm.allreduce(return_value, MPI.SUM) + + return return_value
+
+ +
+
+ +
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/_modules/hymd/thermostat.html b/main/_modules/hymd/thermostat.html new file mode 100644 index 00000000..ac130f6b --- /dev/null +++ b/main/_modules/hymd/thermostat.html @@ -0,0 +1,514 @@ + + + + + + hymd.thermostat — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.thermostat

+"""Scales or otherwise modifies the particle velocities during simulation to
+simulate coupling to an external heat bath with temperature T₀.
+"""
+import numpy as np
+import logging
+from mpi4py import MPI
+from typing import Callable
+from .logger import Logger
+from .input_parser import Config
+
+
+def cancel_com_momentum(velocities, config, comm=MPI.COMM_WORLD):
+    com_velocity = comm.allreduce(np.sum(velocities[...], axis=0), MPI.SUM)
+    velocities[...] = velocities[...] - com_velocity / config.n_particles
+    return velocities
+
+
+def generate_initial_velocities(velocities, config, prng, comm=MPI.COMM_WORLD):
+    kT_start = config.gas_constant * config.start_temperature
+    n_particles_ = velocities.shape[0]
+    velocities[...] = prng.normal(
+        loc=0, scale=kT_start / config.mass, size=(n_particles_, 3)
+    )
+    velocities = cancel_com_momentum(velocities, config, comm=comm)
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    start_kinetic_energy_target = (
+        1.5 * config.gas_constant * config.n_particles * config.start_temperature
+    )
+    factor = np.sqrt(1.5 * config.n_particles * kT_start / kinetic_energy)
+    velocities[...] = velocities[...] * factor
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    Logger.rank0.log(
+        logging.INFO,
+        (
+            f"Initialized {config.n_particles} velocities, target kinetic "
+            f"energy: {start_kinetic_energy_target}, actual kinetic energy "
+            f"generated: {kinetic_energy}"
+        ),
+    )
+    return velocities
+
+
+
[docs]def _random_gaussian(prng: np.random.Generator) -> float: + """Draw a single random number from the standard normal distribution + Generate a number from the Gaussian distribution centered at zero with unit + standard deviation, :math:`N(0, 1)`. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + + Returns + ------- + float + A random number drawn from :math:`N(0, 1)`. + """ + return prng.normal()
+ + +
[docs]def _random_chi_squared(prng: np.random.Generator, M: int) -> float: + """Draw the sum of :code:`M` squared normally distributed values + + The value is generated by the Gamma distribution, in lieu of generating + :code:`M` Gaussian distributed numbers and summing their squares. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + M : int + Number of standard normally distributed numbers in the sum. + + Returns + ------- + float + The sum of :code:`M` squared normally distributed values centered at + zero with unit standard deviation. + + Notes + ----- + The sum of the squares of k independent standard normal random variables is + distributed according to a :math:`\\chi^2` distribution. + + .. math:: + + \\chi^2_1 + \\chi_2^2 + \\chi_3^2 + \\dots + \\chi_M^2 + \\sim + \\sigma^2\\chi^2(k) + + This is a special case of the :math:`\\Gamma` distribution, + :math:`\\Gamma(k/2, 2)`, and may be generated by + + .. math:: + + \\chi^2(k) \\sim 2 \\Gamma(k/2, 2) + + References + ---------- + Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of + Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. + J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246. + """ + return prng.chisquare(M)
+ + +
[docs]def csvr_thermostat( + velocity: np.ndarray, + names: np.ndarray, + config: Config, + prng: np.random.Generator, + comm: MPI.Intracomm = MPI.COMM_WORLD, + random_gaussian: Callable[[np.random.Generator], float] = _random_gaussian, + random_chi_squared: Callable[ + [np.random.Generator, int, float], float + ] = _random_chi_squared, + remove_center_of_mass_momentum: bool = True, +) -> np.ndarray: + """Canonical sampling through velocity rescaling thermostat + + Implements the CSVR thermostat. Rescales the system kinetic energy by a + stochastically chosen factor to keep the temperature constant. Requires + communcation of the kinetic energies calculated locally for each MPI rank. + The random numbers sampled through :code:`random_gaussian` and + :code:`random_chi_squared` are broadcast from the root rank to the other + ranks to ensure the scaling is performed with the same stochasticity for + all particles in the full system. + + The velocities are cleaned of center of mass momentum before the thermostat + is applied, and the center of mass momentum is subsequently reapplied. This + is performed for each thermostat coupling group, i.e. the center of mass + momenta of each *group* is separately removed and reapplied after + thermostatting. + + The implementation here is based on the derivation presented in the 2008 + Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper. + + Parameters + ---------- + velocity : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + names : (N,) numpy.ndarray + Array of particle names. + config : Config + Configuration dataclass containing simulation metadata and parameters. + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + random_gaussian : callable, optional + Function for generating standard normally distributed numbers. + random_chi_squared : callable, optional + Function for generating :math:`\\chi^2`-distributed numbers + remove_center_of_mass_momentum : bool, optional + If True, the center of mass of each coupling group is removed before + the thermostat is applied. The center of mass momenta are added back + after the kinetic energy rescaling is complete. + + See Also + -------- + _random_gaussian : + Used to sample Gaussian-distributed numbers. + _random_chi_squared : + Used to sample :math:`\\chi^2`-distributed numbers. + hymd.input_parser.Config : + Configuration dataclass handler. + + References + ---------- + G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). + G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008). + """ + if not any(config.thermostat_coupling_groups): + config.thermostat_coupling_groups = [config.unique_names.copy()] + for i, group in enumerate(config.thermostat_coupling_groups): + ind = np.where( + np.logical_or.reduce(list(names == np.string_(t) for t in group)) + ) + group_n_particles = comm.allreduce(len(ind[0]), MPI.SUM) + + # Clean velocities of center of mass momentum + if remove_center_of_mass_momentum and group_n_particles > 1: + com_velocity = comm.allreduce(np.sum(velocity[ind], axis=0)) + velocity_clean = velocity[ind] - com_velocity / group_n_particles + K = comm.allreduce(0.5 * config.mass * np.sum(velocity_clean[...] ** 2)) + else: + K = comm.allreduce(0.5 * config.mass * np.sum(velocity[...] ** 2)) + K_target = ( + 1.5 * config.gas_constant * group_n_particles * config.target_temperature + ) + N_f = 3 * group_n_particles + c = np.exp(-(config.time_step * config.respa_inner) / config.tau) + + # Random numbers are identical across ranks because all ranks have + # the same prng after the initialization of the velocities + R = random_gaussian(prng) + SNf = random_chi_squared(prng, N_f - 1) + + alpha2 = ( + c + + (1 - c) * (SNf + R**2) * K_target / (N_f * K) + + 2 * R * np.sqrt(c * (1 - c) * K_target / (N_f * K)) + ) + dK = K * (alpha2 - 1) + alpha = np.sqrt(alpha2) + + if remove_center_of_mass_momentum and group_n_particles > 1: + # Assign velocities and reapply the previously removed center + # of mass momentum removed + velocity_clean *= alpha + velocity[ind] = velocity_clean + com_velocity / group_n_particles + else: + velocity *= alpha + config.thermostat_work += dK
+
+ +
+
+ +
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/_modules/index.html b/main/_modules/index.html new file mode 100644 index 00000000..26817ba6 --- /dev/null +++ b/main/_modules/index.html @@ -0,0 +1,305 @@ + + + + + + Overview: module code — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+ + +
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/main/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css new file mode 100644 index 00000000..1b057df2 --- /dev/null +++ b/main/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css @@ -0,0 +1 @@ +.badge{border-radius:.25rem;display:inline-block;font-size:75%;font-weight:700;line-height:1;padding:.25em .4em;text-align:center;vertical-align:baseline;white-space:nowrap}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{border-radius:10rem;padding-left:.6em;padding-right:.6em}.badge-primary{background-color:#007bff;color:#fff}.badge-primary[href]:focus,.badge-primary[href]:hover{background-color:#0062cc;color:#fff;text-decoration:none}.badge-secondary{background-color:#6c757d;color:#fff}.badge-secondary[href]:focus,.badge-secondary[href]:hover{background-color:#545b62;color:#fff;text-decoration:none}.badge-success{background-color:#28a745;color:#fff}.badge-success[href]:focus,.badge-success[href]:hover{background-color:#1e7e34;color:#fff;text-decoration:none}.badge-info{background-color:#17a2b8;color:#fff}.badge-info[href]:focus,.badge-info[href]:hover{background-color:#117a8b;color:#fff;text-decoration:none}.badge-warning{background-color:#ffc107;color:#212529}.badge-warning[href]:focus,.badge-warning[href]:hover{background-color:#d39e00;color:#212529;text-decoration:none}.badge-danger{background-color:#dc3545;color:#fff}.badge-danger[href]:focus,.badge-danger[href]:hover{background-color:#bd2130;color:#fff;text-decoration:none}.badge-light{background-color:#f8f9fa;color:#212529}.badge-light[href]:focus,.badge-light[href]:hover{background-color:#dae0e5;color:#212529;text-decoration:none}.badge-dark{background-color:#343a40;color:#fff}.badge-dark[href]:focus,.badge-dark[href]:hover{background-color:#1d2124;color:#fff;text-decoration:none}.border-0{border:0 !important}.border-top-0{border-top:0 !important}.border-right-0{border-right:0 !important}.border-bottom-0{border-bottom:0 !important}.border-left-0{border-left:0 !important}.p-0{padding:0 !important}.pt-0,.py-0{padding-top:0 !important}.pr-0,.px-0{padding-right:0 !important}.pb-0,.py-0{padding-bottom:0 !important}.pl-0,.px-0{padding-left:0 !important}.p-1{padding:.25rem !important}.pt-1,.py-1{padding-top:.25rem !important}.pr-1,.px-1{padding-right:.25rem !important}.pb-1,.py-1{padding-bottom:.25rem !important}.pl-1,.px-1{padding-left:.25rem !important}.p-2{padding:.5rem !important}.pt-2,.py-2{padding-top:.5rem !important}.pr-2,.px-2{padding-right:.5rem !important}.pb-2,.py-2{padding-bottom:.5rem !important}.pl-2,.px-2{padding-left:.5rem !important}.p-3{padding:1rem !important}.pt-3,.py-3{padding-top:1rem !important}.pr-3,.px-3{padding-right:1rem !important}.pb-3,.py-3{padding-bottom:1rem !important}.pl-3,.px-3{padding-left:1rem !important}.p-4{padding:1.5rem !important}.pt-4,.py-4{padding-top:1.5rem !important}.pr-4,.px-4{padding-right:1.5rem !important}.pb-4,.py-4{padding-bottom:1.5rem !important}.pl-4,.px-4{padding-left:1.5rem !important}.p-5{padding:3rem !important}.pt-5,.py-5{padding-top:3rem !important}.pr-5,.px-5{padding-right:3rem !important}.pb-5,.py-5{padding-bottom:3rem !important}.pl-5,.px-5{padding-left:3rem !important}.m-0{margin:0 !important}.mt-0,.my-0{margin-top:0 !important}.mr-0,.mx-0{margin-right:0 !important}.mb-0,.my-0{margin-bottom:0 !important}.ml-0,.mx-0{margin-left:0 !important}.m-1{margin:.25rem !important}.mt-1,.my-1{margin-top:.25rem !important}.mr-1,.mx-1{margin-right:.25rem !important}.mb-1,.my-1{margin-bottom:.25rem !important}.ml-1,.mx-1{margin-left:.25rem !important}.m-2{margin:.5rem !important}.mt-2,.my-2{margin-top:.5rem !important}.mr-2,.mx-2{margin-right:.5rem !important}.mb-2,.my-2{margin-bottom:.5rem !important}.ml-2,.mx-2{margin-left:.5rem !important}.m-3{margin:1rem !important}.mt-3,.my-3{margin-top:1rem !important}.mr-3,.mx-3{margin-right:1rem !important}.mb-3,.my-3{margin-bottom:1rem !important}.ml-3,.mx-3{margin-left:1rem !important}.m-4{margin:1.5rem !important}.mt-4,.my-4{margin-top:1.5rem !important}.mr-4,.mx-4{margin-right:1.5rem !important}.mb-4,.my-4{margin-bottom:1.5rem !important}.ml-4,.mx-4{margin-left:1.5rem !important}.m-5{margin:3rem !important}.mt-5,.my-5{margin-top:3rem !important}.mr-5,.mx-5{margin-right:3rem !important}.mb-5,.my-5{margin-bottom:3rem !important}.ml-5,.mx-5{margin-left:3rem !important}.btn{background-color:transparent;border:1px solid transparent;border-radius:.25rem;color:#212529;cursor:pointer;display:inline-block;font-size:1rem;font-weight:400;line-height:1.5;padding:.375rem .75rem;text-align:center;transition:color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none;vertical-align:middle}.btn:hover{color:#212529;text-decoration:none}.btn:visited{color:#212529}.btn.focus,.btn:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.25);outline:0}.btn.disabled,.btn:disabled{opacity:.65}@media (prefers-reduced-motion: reduce){.btn{transition:none}}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary:visited{color:#fff}.btn-primary:hover{background-color:#0069d9;border-color:#0062cc;color:#fff}.btn-primary.focus,.btn-primary:focus{background-color:#0069d9;border-color:#0062cc;box-shadow:0 0 0 .2rem rgba(0,123,255,0.5);color:#fff}.btn-primary.disabled,.btn-primary:disabled{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary.active:not(:disabled):not(.disabled),.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{background-color:#0062cc;border-color:#005cbf;color:#fff}.btn-primary.active:not(:disabled):not(.disabled):focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-secondary{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary:visited{color:#fff}.btn-secondary:hover{background-color:#5a6268;border-color:#545b62;color:#fff}.btn-secondary.focus,.btn-secondary:focus{background-color:#5a6268;border-color:#545b62;box-shadow:0 0 0 .2rem rgba(108,117,125,0.5);color:#fff}.btn-secondary.disabled,.btn-secondary:disabled{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled),.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{background-color:#545b62;border-color:#4e555b;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled):focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-success{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success:visited{color:#fff}.btn-success:hover{background-color:#218838;border-color:#1e7e34;color:#fff}.btn-success.focus,.btn-success:focus{background-color:#218838;border-color:#1e7e34;box-shadow:0 0 0 .2rem rgba(40,167,69,0.5);color:#fff}.btn-success.disabled,.btn-success:disabled{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success.active:not(:disabled):not(.disabled),.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{background-color:#1e7e34;border-color:#1c7430;color:#fff}.btn-success.active:not(:disabled):not(.disabled):focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-info{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info:visited{color:#fff}.btn-info:hover{background-color:#138496;border-color:#117a8b;color:#fff}.btn-info.focus,.btn-info:focus{background-color:#138496;border-color:#117a8b;box-shadow:0 0 0 .2rem rgba(23,162,184,0.5);color:#fff}.btn-info.disabled,.btn-info:disabled{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info.active:not(:disabled):not(.disabled),.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{background-color:#117a8b;border-color:#10707f;color:#fff}.btn-info.active:not(:disabled):not(.disabled):focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-warning{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning:visited{color:#212529}.btn-warning:hover{background-color:#e0a800;border-color:#d39e00;color:#212529}.btn-warning.focus,.btn-warning:focus{background-color:#e0a800;border-color:#d39e00;box-shadow:0 0 0 .2rem rgba(255,193,7,0.5);color:#212529}.btn-warning.disabled,.btn-warning:disabled{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning.active:not(:disabled):not(.disabled),.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{background-color:#d39e00;border-color:#c69500;color:#212529}.btn-warning.active:not(:disabled):not(.disabled):focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-danger{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger:visited{color:#fff}.btn-danger:hover{background-color:#c82333;border-color:#bd2130;color:#fff}.btn-danger.focus,.btn-danger:focus{background-color:#c82333;border-color:#bd2130;box-shadow:0 0 0 .2rem rgba(220,53,69,0.5);color:#fff}.btn-danger.disabled,.btn-danger:disabled{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger.active:not(:disabled):not(.disabled),.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{background-color:#bd2130;border-color:#b21f2d;color:#fff}.btn-danger.active:not(:disabled):not(.disabled):focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-light{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light:visited{color:#212529}.btn-light:hover{background-color:#e2e6ea;border-color:#dae0e5;color:#212529}.btn-light.focus,.btn-light:focus{background-color:#e2e6ea;border-color:#dae0e5;box-shadow:0 0 0 .2rem rgba(248,249,250,0.5);color:#212529}.btn-light.disabled,.btn-light:disabled{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light.active:not(:disabled):not(.disabled),.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{background-color:#dae0e5;border-color:#d3d9df;color:#212529}.btn-light.active:not(:disabled):not(.disabled):focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-dark{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark:visited{color:#fff}.btn-dark:hover{background-color:#23272b;border-color:#1d2124;color:#fff}.btn-dark.focus,.btn-dark:focus{background-color:#23272b;border-color:#1d2124;box-shadow:0 0 0 .2rem rgba(52,58,64,0.5);color:#fff}.btn-dark.disabled,.btn-dark:disabled{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark.active:not(:disabled):not(.disabled),.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{background-color:#1d2124;border-color:#171a1d;color:#fff}.btn-dark.active:not(:disabled):not(.disabled):focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-primary{border-color:#007bff;color:#007bff}.btn-outline-primary:visited{color:#007bff}.btn-outline-primary:hover{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{background-color:transparent;color:#007bff}.btn-outline-primary.active:not(:disabled):not(.disabled),.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.active:not(:disabled):not(.disabled):focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-secondary{border-color:#6c757d;color:#6c757d}.btn-outline-secondary:visited{color:#6c757d}.btn-outline-secondary:hover{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{background-color:transparent;color:#6c757d}.btn-outline-secondary.active:not(:disabled):not(.disabled),.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.active:not(:disabled):not(.disabled):focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-success{border-color:#28a745;color:#28a745}.btn-outline-success:visited{color:#28a745}.btn-outline-success:hover{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{background-color:transparent;color:#28a745}.btn-outline-success.active:not(:disabled):not(.disabled),.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.active:not(:disabled):not(.disabled):focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-info{border-color:#17a2b8;color:#17a2b8}.btn-outline-info:visited{color:#17a2b8}.btn-outline-info:hover{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{background-color:transparent;color:#17a2b8}.btn-outline-info.active:not(:disabled):not(.disabled),.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.active:not(:disabled):not(.disabled):focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-warning{border-color:#ffc107;color:#ffc107}.btn-outline-warning:visited{color:#ffc107}.btn-outline-warning:hover{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{background-color:transparent;color:#ffc107}.btn-outline-warning.active:not(:disabled):not(.disabled),.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.active:not(:disabled):not(.disabled):focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-danger{border-color:#dc3545;color:#dc3545}.btn-outline-danger:visited{color:#dc3545}.btn-outline-danger:hover{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{background-color:transparent;color:#dc3545}.btn-outline-danger.active:not(:disabled):not(.disabled),.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.active:not(:disabled):not(.disabled):focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-light{border-color:#f8f9fa;color:#f8f9fa}.btn-outline-light:visited{color:#f8f9fa}.btn-outline-light:hover{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{background-color:transparent;color:#f8f9fa}.btn-outline-light.active:not(:disabled):not(.disabled),.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.active:not(:disabled):not(.disabled):focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-dark{border-color:#343a40;color:#343a40}.btn-outline-dark:visited{color:#343a40}.btn-outline-dark:hover{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{background-color:transparent;color:#343a40}.btn-outline-dark.active:not(:disabled):not(.disabled),.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.active:not(:disabled):not(.disabled):focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-link{color:#007bff;font-weight:400;text-decoration:none}.btn-link:hover{color:#0056b3;text-decoration:underline}.btn-link.focus,.btn-link:focus{box-shadow:none;text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{border-radius:.3rem;font-size:1.25rem;line-height:1.5;padding:.5rem 1rem}.btn-group-sm>.btn,.btn-sm{border-radius:.2rem;font-size:.875rem;line-height:1.5;padding:.25rem .5rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input.btn-block[type=button],input.btn-block[type=reset],input.btn-block[type=submit]{width:100%}.stretched-link::after{background-color:rgba(0,0,0,0);bottom:0;content:'';left:0;pointer-events:auto;position:absolute;right:0;top:0;z-index:1}.text-wrap{white-space:normal !important}.card{background-clip:border-box;background-color:#fff;border:1px solid rgba(0,0,0,0.125);border-radius:.25rem;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;min-width:0;position:relative;word-wrap:break-word}.card>hr{margin-left:0;margin-right:0}.card>.list-group:first-child .list-group-item:first-child{border-top-left-radius:.25rem;border-top-right-radius:.25rem}.card>.list-group:last-child .list-group-item:last-child{border-bottom-left-radius:.25rem;border-bottom-right-radius:.25rem}.card-body{-ms-flex:1 1 auto;flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-bottom:0;margin-top:-.375rem}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{background-color:rgba(0,0,0,0.03);border-bottom:1px solid rgba(0,0,0,0.125);margin-bottom:0;padding:.75rem 1.25rem}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-header+.list-group .list-group-item:first-child{border-top:0}.card-footer{background-color:rgba(0,0,0,0.03);border-top:1px solid rgba(0,0,0,0.125);padding:.75rem 1.25rem}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{border-bottom:0;margin-bottom:-.75rem;margin-left:-.625rem;margin-right:-.625rem}.card-header-pills{margin-left:-.625rem;margin-right:-.625rem}.card-img-overlay{bottom:0;left:0;padding:1.25rem;position:absolute;right:0;top:0}.card-img,.card-img-bottom,.card-img-top{-ms-flex-negative:0;flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-left-radius:calc(.25rem - 1px);border-bottom-right-radius:calc(.25rem - 1px)}.w-100{width:100% !important}.shadow{box-shadow:0 0.5rem 1rem rgba(0,0,0,0.15) !important}.bg-primary{background-color:#007bff !important}button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc !important}a.bg-primary:focus,a.bg-primary:hover{background-color:#0062cc !important}a.text-primary:focus,a.text-primary:hover{color:#121416 !important}.bg-secondary{background-color:#6c757d !important}button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62 !important}a.bg-secondary:focus,a.bg-secondary:hover{background-color:#545b62 !important}a.text-secondary:focus,a.text-secondary:hover{color:#121416 !important}.bg-success{background-color:#28a745 !important}button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34 !important}a.bg-success:focus,a.bg-success:hover{background-color:#1e7e34 !important}a.text-success:focus,a.text-success:hover{color:#121416 !important}.bg-info{background-color:#17a2b8 !important}button.bg-info:focus,button.bg-info:hover{background-color:#117a8b !important}a.bg-info:focus,a.bg-info:hover{background-color:#117a8b !important}a.text-info:focus,a.text-info:hover{color:#121416 !important}.bg-warning{background-color:#ffc107 !important}button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00 !important}a.bg-warning:focus,a.bg-warning:hover{background-color:#d39e00 !important}a.text-warning:focus,a.text-warning:hover{color:#121416 !important}.bg-danger{background-color:#dc3545 !important}button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130 !important}a.bg-danger:focus,a.bg-danger:hover{background-color:#bd2130 !important}a.text-danger:focus,a.text-danger:hover{color:#121416 !important}.bg-light{background-color:#f8f9fa !important}button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5 !important}a.bg-light:focus,a.bg-light:hover{background-color:#dae0e5 !important}a.text-light:focus,a.text-light:hover{color:#121416 !important}.bg-dark{background-color:#343a40 !important}button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124 !important}a.bg-dark:focus,a.bg-dark:hover{background-color:#1d2124 !important}a.text-dark:focus,a.text-dark:hover{color:#121416 !important}.bg-white{background-color:#fff !important}button.bg-white:focus,button.bg-white:hover{background-color:#e6e6e6 !important}a.bg-white:focus,a.bg-white:hover{background-color:#e6e6e6 !important}a.text-white:focus,a.text-white:hover{color:#121416 !important}.text-primary{color:#007bff !important}.text-secondary{color:#6c757d !important}.text-success{color:#28a745 !important}.text-info{color:#17a2b8 !important}.text-warning{color:#ffc107 !important}.text-danger{color:#dc3545 !important}.text-light{color:#f8f9fa !important}.text-dark{color:#343a40 !important}.text-white{color:#fff !important}.text-body{color:#212529 !important}.text-muted{color:#6c757d !important}.text-black-50{color:rgba(0,0,0,0.5) !important}.text-white-50{color:rgba(255,255,255,0.5) !important}.bg-transparent{background-color:transparent !important}.text-justify{text-align:justify !important}.text-left{text-align:left !important}.text-right{text-align:right !important}.text-center{text-align:center !important}.font-weight-light{font-weight:300 !important}.font-weight-lighter{font-weight:lighter !important}.font-weight-normal{font-weight:400 !important}.font-weight-bold{font-weight:700 !important}.font-weight-bolder{font-weight:bolder !important}.font-italic{font-style:italic !important}.container{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container{max-width:540px}}@media (min-width: 768px){.container{max-width:720px}}@media (min-width: 992px){.container{max-width:960px}}@media (min-width: 1200px){.container{max-width:1140px}}.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container,.container-sm{max-width:540px}}@media (min-width: 768px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width: 992px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width: 1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1140px}}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;margin-right:-15px}.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{padding-left:15px;padding-right:15px;position:relative;width:100%}@media (min-width: 576px){.col-sm{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-sm-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-sm-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-sm-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-sm-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-sm-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 768px){.col-md{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-md-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-md-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-md-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-md-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-md-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 992px){.col-lg{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-lg-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-lg-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-lg-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-lg-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-lg-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 1200px){.col-xl{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-xl-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-xl-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-xl-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-xl-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-xl-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}.d-flex{display:-ms-flexbox !important;display:flex !important}.sphinx-bs,.sphinx-bs *{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sphinx-bs p{margin-top:0} diff --git a/main/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/main/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css new file mode 100644 index 00000000..fc14abc8 --- /dev/null +++ b/main/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css @@ -0,0 +1 @@ +details.dropdown .summary-title{padding-right:3em !important;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none}details.dropdown:hover{cursor:pointer}details.dropdown .summary-content{cursor:default}details.dropdown summary{list-style:none;padding:1em}details.dropdown summary .octicon.no-title{vertical-align:middle}details.dropdown[open] summary .octicon.no-title{visibility:hidden}details.dropdown summary::-webkit-details-marker{display:none}details.dropdown summary:focus{outline:none}details.dropdown summary:hover .summary-up svg,details.dropdown summary:hover .summary-down svg{opacity:1}details.dropdown .summary-up svg,details.dropdown .summary-down svg{display:block;opacity:.6}details.dropdown .summary-up,details.dropdown .summary-down{pointer-events:none;position:absolute;right:1em;top:.75em}details.dropdown[open] .summary-down{visibility:hidden}details.dropdown:not([open]) .summary-up{visibility:hidden}details.dropdown.fade-in[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out;animation:panels-fade-in .5s ease-in-out}details.dropdown.fade-in-slide-down[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out}@keyframes panels-fade-in{0%{opacity:0}100%{opacity:1}}@keyframes panels-slide-down{0%{transform:translate(0, -10px)}100%{transform:translate(0, 0)}}.octicon{display:inline-block;fill:currentColor;vertical-align:text-top}.tabbed-content{box-shadow:0 -.0625rem var(--tabs-color-overline),0 .0625rem var(--tabs-color-underline);display:none;order:99;padding-bottom:.75rem;padding-top:.75rem;width:100%}.tabbed-content>:first-child{margin-top:0 !important}.tabbed-content>:last-child{margin-bottom:0 !important}.tabbed-content>.tabbed-set{margin:0}.tabbed-set{border-radius:.125rem;display:flex;flex-wrap:wrap;margin:1em 0;position:relative}.tabbed-set>input{opacity:0;position:absolute}.tabbed-set>input:checked+label{border-color:var(--tabs-color-label-active);color:var(--tabs-color-label-active)}.tabbed-set>input:checked+label+.tabbed-content{display:block}.tabbed-set>input:focus+label{outline-style:auto}.tabbed-set>input:not(.focus-visible)+label{outline:none;-webkit-tap-highlight-color:transparent}.tabbed-set>label{border-bottom:.125rem solid transparent;color:var(--tabs-color-label-inactive);cursor:pointer;font-size:var(--tabs-size-label);font-weight:700;padding:1em 1.25em .5em;transition:color 250ms;width:auto;z-index:1}html .tabbed-set>label:hover{color:var(--tabs-color-label-active)} diff --git a/main/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css b/main/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css new file mode 100644 index 00000000..adc61662 --- /dev/null +++ b/main/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css @@ -0,0 +1,7 @@ +:root { +--tabs-color-label-active: hsla(231, 99%, 66%, 1); +--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); +--tabs-color-overline: rgb(207, 236, 238); +--tabs-color-underline: rgb(207, 236, 238); +--tabs-size-label: 1rem; +} \ No newline at end of file diff --git a/main/_sources/doc_pages/api.rst.txt b/main/_sources/doc_pages/api.rst.txt new file mode 100644 index 00000000..6761cfc0 --- /dev/null +++ b/main/_sources/doc_pages/api.rst.txt @@ -0,0 +1,122 @@ +.. _api-label: + + +API reference +============= + +Integrator +---------- + +.. automodule:: hymd.integrator + :members: + + +Thermostat +---------- + +.. automodule:: hymd.thermostat + :members: csvr_thermostat, _random_chi_squared, _random_gaussian + :undoc-members: + + +Barostat +-------- + +Berendsen Barostat +^^^^^^^^^^^^^^^^^^ + +.. automodule:: hymd.barostat + :members: isotropic, semiisotropic + :undoc-members: + +SCR Barostat +^^^^^^^^^^^^^^^^^^ + +.. automodule:: hymd.barostat_bussi + :members: isotropic, semiisotropic + :undoc-members: + + +Hamiltonian +----------- + +.. autoclass:: hymd.hamiltonian.Hamiltonian + :members: + + .. automethod:: __init__ + + .. automethod:: _setup + +.. autoclass:: hymd.hamiltonian.SquaredPhi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultNoChi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultWithChi + :members: + + .. automethod:: __init__ + + +Force +----- + +.. automodule:: hymd.force + :members: + :undoc-members: + + +Pressure +-------- + +.. automodule:: hymd.pressure + :members: comp_pressure + :undoc-members: + + +Logger +------ + +.. autoclass:: hymd.logger.Logger + :members: + +.. autoclass:: hymd.logger.MPIFilterRoot + :members: + +.. autoclass:: hymd.logger.MPIFilterAll + :members: + + +Input parser +------------ + +.. automodule:: hymd.input_parser + :members: + :undoc-members: propensity_potential_coeffs + + +Field +----- + +.. automodule:: hymd.field + :members: + + +File input/output +----------------- + +.. automodule:: hymd.file_io + :members: + +PLUMED +------ + +.. automodule:: hymd.plumed + :members: diff --git a/main/_sources/doc_pages/benchmarks.rst.txt b/main/_sources/doc_pages/benchmarks.rst.txt new file mode 100644 index 00000000..06377a85 --- /dev/null +++ b/main/_sources/doc_pages/benchmarks.rst.txt @@ -0,0 +1,93 @@ +.. _benchmarks-label: + +Benchmarks +########## +Homopolymer melt test systems of :math:`30^2`, :math:`40^2`, and :math:`50^2` +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively. + +Bonded forces +^^^^^^^^^^^^^ +Legend label denotes the number of particles in the system. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) + time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 + ], dtype=np.float64) + nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 + ], dtype=np.float64,) + time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, + ], dtype=np.float64) + nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 + ], dtype=np.float64) + time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, + ], dtype=np.float64) + plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" + ) + plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" + ) + plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" + ) + plt.xlabel("CPUs", fontsize=15) + plt.ylabel("Time per step, us", fontsize=15) + plt.legend(fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.show() + + +Particle--field forces +^^^^^^^^^^^^^^^^^^^^^^ +Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + + mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] + mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + + mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + + mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + + mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] + mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + + mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + + mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + + plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") + plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") + plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") + plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") + plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") + plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") + plt.xlabel("CPUs", fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.ylabel("Time per step, s", fontsize=15) + plt.legend(loc="upper left", fontsize=15) + plt.show() diff --git a/main/_sources/doc_pages/command_line.rst.txt b/main/_sources/doc_pages/command_line.rst.txt new file mode 100644 index 00000000..f0fb00bd --- /dev/null +++ b/main/_sources/doc_pages/command_line.rst.txt @@ -0,0 +1,130 @@ +.. _commandline-label: + +Command line arguments +###################### +Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle--field interactions. + + +Required arguments +================== +:configuration file: + :code:`type` positional + + Specifies the :code:`.toml` format configuration file containing simulation details. See :ref:`config-label` for details. + +:structure and topology file: + :code:`type` positional + + Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See :ref:`topology-label` for details. + +Optional arguments +================== +:code:`-v --verbose` + :code:`type` optional + + Number of following arguments: :code:`0` or :code:`1` + + Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying :code:`-v` or :code:`--verbose` with no additional specification. This increases verbosity level by :code:`1`. Alternatively, it maye be specified by :code:`--verbose V` with :code:`V` being :code:`0`, :code:`1`, or :code:`2`. + +:code:`--profile` + :code:`type` optional + + Number of following arguments: :code:`0` + + Enables code profiling using :code:`cProfile`. This will output one profiling file per MPI rank invoked in the simulation. + +:code:`--double-precision` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision internally in HyMD (including in the FFTs). + +:code:`--double-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision in the output trajectory from HyMD. + +:code:`--velocity-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that velocities should be output to the HyMD trajectory. + +:code:`--force-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that forces should be output to the HyMD trajectory. + +:code:`--disable-mpio` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult. + +:code:`--logfile` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the path of a plain text log file in which stdout is mirrored during simulation runs. + +:code:`--seed` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the random seed used in the :code:`numpy` random library to generate velocities, thermostatting, etc. + +:code:`--disable-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any two-particle bonds present in the system. + +:code:`--disable-angle-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any three-particle bonds present in the system. + +:code:`--disable-dihedrals` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any four-particle bonds present in the system. + +:code:`--disable-dipole` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any topological reconstruction of peptide backbone dipoles present in the system. + +:code:`--disable-field` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any particle--field interactions present in the system. + +:code:`--plumed` + :code:`type` optional + + Input file for PLUMED when using the PLUMED interface. See :ref:`interfaces-label` for details. + +:code:`--plumed-outfile + :code:`type` optional + + Name of PLUMED output file when running a simulation using PLUMED. diff --git a/main/_sources/doc_pages/config_file.rst.txt b/main/_sources/doc_pages/config_file.rst.txt new file mode 100644 index 00000000..2ee880b7 --- /dev/null +++ b/main/_sources/doc_pages/config_file.rst.txt @@ -0,0 +1,244 @@ +.. _config-label: + +Configuration file +################## +The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order. + +The configuration file is a `toml`_ format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs. + +.. _`toml`: + https://github.com/toml-lang/toml + +.. role:: required + +Configuration file keywords +--------------------------- + +The following constitutes every possible keyword specification in HyMD +configuration files: + +Metadata keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying metadata for the H5MD output trajectory. + +:name: + :code:`string` [**optional**, default: :code:`None`] + + Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file. + + +:tags: + :code:`array` [:code:`string`] [**optional**, default: :code:`None`] + + Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file. + + +Particle keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying properties of particles and molecules in the +system. + +:n_particles: + :code:`integer` [**optional**, default: :code:`None`] + + Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules. + +:mass: + :code:`float` [**optional**, default: :code:`72.0`] {units: :math:`\text{u}=\text{g}\,\text{mol}^{-1}`} + + Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal. + +:max_molecule_size: + :code:`integer` [**optional**, default: :code:`201`] + + Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code **will** crash if there are molecules larger than :code:`max_molecule_size` in the topology/structure input file. + + +Simulation keywords +^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying simulation parameters. + +:n_steps: + :code:`integer` [:required:`required`] + + Total number of integration steps to perform for this simulation. + +:n_print: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of *number of time steps*). + +:n_flush: + :code:`integer` [**optional**, default: :code:`None`] + + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of *number of* :code:`n_print`, i.e. :code:`n_print = 13`, :code:`n_flush = 3` would result in the trajectory/energy being written to disk every :code:`13 x 3 = 39` *simulation steps*) + +:time_step: + :code:`float` [:required:`required`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time step per integration step. If the rRESPA multiple time step integrator is used (:code:`integrator = "respa"`), this specifies the **inner** time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is :code:`respa_inner` times the :code:`time_step` , and the total simulation time is :code:`n_steps` times :code:`time_step` times :code:`respa_inner` . + +:box_size: + :code:`array` [:code:`float`] [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable. + +:integrator: + :code:`string` [:required:`required`] (options: :code:`velocity-verlet` or :code:`respa`) + + Specifies the time integrator used in the simulation. If :code:`respa`, the *reversible reference system propagator algorithm (rRESPA)* :cite:`tuckerman1992reversible` integrator is used, with :code:`respa_inner` number of inner (intramolecular force) time steps. If :code:`velocity-verlet`, a normal Velocity Verlet integrator is used. If :code:`respa` and :code:`respa_inner = 1`, the rRESPA integrator is equivalent to the Velocity Verlet. + +:respa_inner: + :code:`integer` [**optional**, default: :code:`1`] + + The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces. + +:domain_decomposition: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Specifies the interval (in time steps) of *domain decomposition exchange*, involving all MPI ranks sending and receiving particles according to the particles' positions in the integration box and the MPI ranks' assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If :code:`True`, the decomposition is performed once (before starting the simulation). If :code:`False`, no decomposition is performed. + +:cancel_com_momentum: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + If :code:`True`, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every :code:`remove_com_momentum` time steps. If :code:`False`, the linear momentum is never removed. + +:start_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at :code:`start_temperature` Kelvin prior to starting the simulation. If :code:`False`, the velocities are not changed before starting the simulation. + +:target_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Couple the system to a heat bath at :code:`target_temperature` Kelvin by applying a *Canonical sampling through velocity rescaling* :cite:`Bussi2007JCP` thermostat with coupling strength :code:`tau`. If :code:`False`, no temperature control is applied. + +:tau: + :code:`float` [**optional**, default: :code:`0.7`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the CSVR thermostat coupling. In the limit of :code:`tau → ∞`, the Hamiltonian dynamics are preserved and no temperature coupling takes place. + +:thermostat_coupling_groups: + :code:`array` [:code:`array` [:code:`string`]] [**optional**, default: :code:`[]`] + + Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and :code:`"C"` type particles, :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would thermalise types :code:`"A"` and :code:`"B"` together and couple :code:`"C"` type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. :code:`target_temperature` Kelvin). +:hamiltonian: + :code:`string` [**optional**, default: :code:`"DefaultNohChi"`] (options: :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`) + + Specifies the interaction energy functional :math:`W[\tilde\phi]` for use with the particle-field interactions. See :ref:`functionals-label` for details. + + +Field keywords +^^^^^^^^^^^^^^ +Configuration keywords specifying field parameters. + +:mesh_size: + :code:`array` [:code:`integer`] or :code:`integer` [:required:`required`] + + Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is :code:`box_size / mesh_size`. + +:kappa: + :code:`float` [:required:`required`] {units: :math:`\text{kJ}^{-1}\text{mol}`} + + Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional :math:`W[\tilde\phi]`. See :ref:`functionals-label` for more details. + +:sigma: + :code:`float` [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See :ref:`filtering-label` for more details. + +:chi: + :code:`array` [:code:`array` [:code:`string`, :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}`} + + Array of :math:`\tilde\chi_\text{AB}`-parameters indicating the strength of the repulsive or attractive interaction between particles of type :code:`"A"` and the number density due to particles of type :code:`"B"`, and vice versa. Example: :code:`chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ]` would specify a repulsive :code:`"A"`--:code:`"B"` type interaction, and a weakly attractive :code:`"C"`--:code:`"D"` interaction. Self-interaction :math:`\tilde\chi`-terms are always zero. See :ref:`functionals-label` for more details. + + +Bond keywords +^^^^^^^^^^^^^ +Configuration keywords specifying bonds and bonds parameters. + +:bonds: + :code:`array` [:code:`array` [2 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{nm}=10^{-9}~\text{m}` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: :code:`bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ]` indicates a :code:`"A"`--:code:`"A"` bond of equilibrium length :code:`0.47` :math:`\text{nm}` with a bond strength of :code:`980.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding bond between :code:`"A"` and :code:`"B"` type particles with equilibrium length :code:`0.31` :math:`\text{nm}` and a strength of :code:`1250.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify stretching bonds. + +:angle_bonds: + :code:`array` [:code:`array` [3 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`{}^\circ` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: :code:`bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ]` indicates a :code:`"A"`--:code:`"A"`--:code:`"A"` angular bond that tries to keep the bond linear at :code:`180` degrees with a bending strength of :code:`55.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding angle bond between :code:`"A"`--:code:`"B"`--:code:`"B"` prefering the angle at :code:`120` degrees and a strength of :code:`25.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify angular bonds. + +:dihedrals: + :code:`array` [:code:`array` [4 :code:`string`, :code:`integer`, :code:`COSINE SERIES` ]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`} + + Specifies four-particle torsional potentials by cosine series. See :ref:`bonds-label` for details about how to specify dihedrals. + + + +Electrostatic keywords +^^^^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying electrostatics and electrostatic parameters. + +:coulombtype: + :code:`string` [**optional**, default: :code:`None`] (options: :code:`PIC_Spectral`) + + Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the :code:`dielectric_const` keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, *not* in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to `PIC_Spectral`. + +:dielectric_const: + :code:`float` [**optional**, default: :code:`None`] + + Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified---even if electrostatics are not included with the :code:`coulombtype` keyword. + +Pressure keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying pressure and barostat parameters. + +Simulation keywords +========================================= + +:pressure: + :code:`boolean` [**optional**, default: :code:`False`] + + Specifies whether or not to calculate total internal pressure vector. + +:barostat: + :code:`string` [**optional**, default: :code:`None`](options: :code:`isotropic` or :code:`semiisotropic`) + + Specifies whether to apply pressure constraints equally in all 3 Cartesian directions (`isotropic`) or equally in xy and different in z (`semiisotropic`). + +:barostat_type: + :code:`string` [**optional**, default: :code:`berendsen`](options: :code:`berendsen` or :code:`scr`) + + Specifies the type of barostat to use. :code:`berendsen` is more suitable for equilibration and :code:`scr` for equilibrium data collection. + +:n_b: + :code:`integer` [**optional**, default: :code:`1`] + + Frequency of barostat call in number of outer rRESPA steps. + +:tau_p: + :code:`float` [**optional**, default: :code:`10 tau` if :code:`tau < 0.1` else :code:`1.0`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the barostat coupling. + +:target_pressure: + :code:`array` [:code:`float`] [**optional**, default: :code:1] {units: `bar`} + + Couples the system to an external pressure set to `target_pressure`. + +Field keywords +========================================= + +:rho0: + :code:`float` [**optional**, default: :code:average density] {units: :math:`\text{nm}^{-3}`} + + Intrinsic parameter corresponding to the specific volume of a coarse-grained particle. Typically: `8.66` + +:a: + :code:`float` [:required:`required`] {units: :math:`\text{nm}^{-3}`} + + Calibrated parameter to obtain the correct average density at the target temperature and pressure. Typically: `9.21` diff --git a/main/_sources/doc_pages/constants_and_units.rst.txt b/main/_sources/doc_pages/constants_and_units.rst.txt new file mode 100644 index 00000000..ee429829 --- /dev/null +++ b/main/_sources/doc_pages/constants_and_units.rst.txt @@ -0,0 +1,80 @@ +.. _units-label: + +Constants and Units +################### + +HyMD uses the following units and constants internally and in all input and +output: + +.. list-table:: **Units** + :widths: 30 10 75 + :header-rows: 1 + + * - Quantity + - Symbol + - Unit + * - length + - :math:`r` + - :math:`\text{nm}=10^{-9}~\text{m}` + * - time + - :math:`t` + - :math:`\text{ps}=10^{-12}~\text{s}` + * - charge + - :math:`q` + - :math:`e=1.602176634 \cdot 10^{-19}~\text{C}` + * - mass + - :math:`m` + - :math:`\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}` + * - temperature + - :math:`\text{T}` + - :math:`\text{K}` + * - energy + - :math:`E` + - :math:`\text{kJ}\,\text{mol}^{-1}` + * - velocity + - :math:`v` + - :math:`\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}` + * - momentum + - :math:`P` + - :math:`\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}` + * - force + - :math:`\mathbf{F}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}` + * - pressure + - :math:`p` + - :math:`\text{bar}=100~\text{kPa}` + * - electric potential + - :math:`\Psi` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}` + * - electric field + - :math:`\mathbf{E}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}` + * - compressibility + - :math:`\kappa` + - :math:`\text{mol}\,\text{kJ}^{-1}` + * - field-interaction + - :math:`\tilde\chi` + - :math:`\text{kJ}\,\text{mol}^{-1}` + +.. list-table:: **Constants** + :widths: 30 10 75 + :header-rows: 1 + + * - Constant + - Symbol + - Value + * - gas constant + - :math:`R` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Boltzmann’s constant + - :math:`k_\text{B}` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Avogadro's constant + - :math:`N_\text{A}` + - :math:`6.02214076 \cdot 10^23~\text{mol}^{-1}` + * - Vacuum permittivity + - :math:`\varepsilon_0` + - :math:`8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2` + * - Coulomb constant + - :math:`k_\text{e}` + - :math:`138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}` diff --git a/main/_sources/doc_pages/electrostatics.rst.txt b/main/_sources/doc_pages/electrostatics.rst.txt new file mode 100644 index 00000000..7e11c09d --- /dev/null +++ b/main/_sources/doc_pages/electrostatics.rst.txt @@ -0,0 +1,48 @@ +.. _electrostatics-label: + +Electrostatic interactions +########################## +In the filtered Hamiltonian hPF formalism :cite:`bore2020hamiltonian` the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle--mesh Ewald. + +The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered + +.. math:: + + \tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i), + +with :math:`q_i` being the charge of particle :math:`i` and :math:`H` is the +filtering function (see :ref:`filtering-label`). The value of the charge grid at +vertex :math:`(i,j,k)` is found by + +.. math:: + + \tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)] + +and the electrostatic potential :math:`\Psi_{ijk}` + +.. math:: + + \Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right], + +where :math:`k_\text{e}` is the Coulomb constant :math:`1/4\pi\varepsilon_0`. +The *electric field* is obtained by differentiation of the electrostatic +potential in Fourier space, + +.. math:: + + \mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)] + +from which the forces are interpolated back to the particle positions. + +Specifying electrostatics +^^^^^^^^^^^^^^^^^^^^^^^^^ +In HyMD, electrostatics are specified by the :code:`coulombtype` and +:code:`dielectric_const` keywords in the configuration file (see +:ref:`config-label`) and the :code:`/charge` dataset in the HDF5 format +structure/topology input file (see :ref:`topology-label`). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions. diff --git a/main/_sources/doc_pages/examples.rst.txt b/main/_sources/doc_pages/examples.rst.txt new file mode 100644 index 00000000..9f9c3655 --- /dev/null +++ b/main/_sources/doc_pages/examples.rst.txt @@ -0,0 +1,621 @@ +.. _examples-label: + +Examples +######## +The following examples are ordered in *more or less* order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the `HyMD-tutorial`_ github repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Ideal gas +========= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true + :align: right + :width: 200 + +The simplest possible system is one with no interactions at all---intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like: + + +.. code-block:: toml + :caption: **ideal_gas.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = false # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + +A simple input structure/topology file :code:`ideal_gas.HDF5` is available in +the `HyMD-tutorial/ideal_gas`_ github repository (along with the code to +generate it). Run the (very) short simulation by + +.. code:: bash + + python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field \ + --velocity-output \ + --force-output + +with the :code:`--disable-field` argument to completely turn off all +particle--field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook `ideal_gas.ipynb`_ for details. + + +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas +.. _ideal_gas.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.ipynb + + +Ideal chains +============ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true + :align: right + :width: 200 + +The simplest available interaction is the harmonic two-particle bond (see +:ref:`bonds-label`), + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2. + +Extending the configuration file from the ideal gas case, we need to add a +:code:`bonds` specification. Note that the :code:`[bonds]` meta specifier is not +necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **ideal_chain.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + +A simple input structure/topology file :code:`ideal_chain.HDF5` with a few +coiled up ideal chain polymers is available in the +`HyMD-tutorial/ideal_chain`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field + +we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +`ideal_chain.ipynb`_. + + +.. _HyMD-tutorial/ideal_chain: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_chain +.. _ideal_chain.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/ideal_chain.ipynb + + +Stiff rods +========== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true + :align: right + :width: 200 + +Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the :code:`i--j--k` angle :math:`\theta` (see +:ref:`bonds-label`), + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2. + +Extending the configuration file from the ideal chain case, we need to add a +:code:`angle_bonds` specification. Note that the :code:`[bonds]` meta specifier +is not necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **rods.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + + angle_bonds = [ + ["A", "A", "A", 180.0, 100.0], # (i, j, k, equilibrium angle, strength) + ] + + +A simple input structure/topology file :code:`rods.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook `rods.ipynb`_. + + +.. _HyMD-tutorial/rods: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/rods +.. _rods.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.ipynb + + + +Helixes +======= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true + :align: right + :width: 200 + +Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle :math:`\phi` between the +:code:`i--j--k` plane and the :code:`j--k--l` plane (see :ref:`bonds-label`), + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n). + +The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a :code:`dihedrals` keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the :code:`dielectric_const` +keyword even though we are not including electrostatic forces in the current +simulation. Note that the :code:`[bonds]` meta specifier is not necessary, but +may be used to help organise the input file. + +.. code-block:: toml + :caption: **helixes.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + dielectric_const = 15.0 + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.31, 10000.0], # (i name, j name, equilibrium length, strength) + ] + + dihedrals = [ + [ + ["A", "A", "A", "A"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0] + ], + ] + +A simple input structure/topology file :code:`helixes.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook `helixes.ipynb`_. + + +.. _HyMD-tutorial/helixes: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/helixes +.. _helixes.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.ipynb + + +Phase separation +================ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true + :align: right + :width: 200 + +The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types :code:`A` and :code:`B`. Using the Hamiltonian + +.. math:: + + \mathcal{H}=H_0+W + +with :math:`\tilde\chi`--dependent interactions defined by (specified in the +configuration file by :code:`hamiltonian = DefaultWithChi`): + +.. math:: + + W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2. + + +.. code-block:: toml + :caption: **phase_separation.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + + [field] + mesh_size = [20, 20, 20] # FFT grid size + sigma = 1.0 # filtering length scale in nm + kappa = 0.05 # compressibility in mol/kJ + chi = [ + ['A', 'B', 5.0], # (name i, name j, strength) + ] + +A simple input structure/topology file :code:`phase_separation.HDF5` containing +an equal number of :code:`A` type and :code:`B` type particles is available in +the `HyMD-tutorial/phase_separation`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd phase_separation.toml phase_separation.HDF5 + +we may examine the resulting trajectory. In the case of a low interaction +strength :math:`\tilde\chi` of :code:`5.0` (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to :code:`40.0` (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +`phase_separation.ipynb`_. + + +.. _HyMD-tutorial/phase_separation: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/phase_separation +.. _phase_separation.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/phase_separation.ipynb + + +Diblock copolymers +================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true + :align: right + :width: 200 + +Having introduced particle--field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive :math:`\tilde\chi`--interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the :code:`integrator = "respa"` keyword. Putting the pieces together, the +configuration file may look like the following: + +.. code-block:: toml + :caption: **copolymer.toml** + + [simulation] + integrator = "respa" + respa_inner = 15 + n_steps = 2000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [10.0, 10.0, 10.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [50, 50, 50] # FFT grid size + sigma = 0.5 # filtering length scale in nm + chi = [ + ["A", "B", 30.0], # (i, j, strength) + ] + + [bonds] + bonds = [ + ["A", "A", 0.25, 1500.0], # (i, j, equilibrium length, strength) + ["A", "B", 0.25, 1500.0], + ["B", "B", 0.25, 1500.0], + ] + angle_bonds = [ + ["A", "A", "A", 180.0, 25.0], # (i, j, k, equilibrium angle, strength) + ["B", "B", "B", 180.0, 25.0], + ] + +A simple input structure/topology file :code:`copolymer.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/copolymer`_ github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten :code:`A` followed by ten :code:`B` type particles. +Running the simulation with + +.. code:: bash + + python3 -m hymd copolymer.toml copolymer.HDF5 + +the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +`copolymer.ipynb`_. + + +.. _HyMD-tutorial/copolymer: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/copolymer +.. _copolymer.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer.ipynb + + +Lipid bilayer self-assembly +=========================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true + :align: right + :width: 300 + +Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field--particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the :code:`thermostat_coupling_groups` keyword. With parameters +optimised in :cite:`ledum2020automated`, the configuration file looks like: + + +.. code-block:: toml + :caption: **lipid_self_assembly.toml** + + [simulation] + integrator = "respa" + respa_inner = 25 + n_steps = 3000 + n_print = 200 + n_flush = 1 + time_step = 0.01 + box_size = [9.96924, 9.96924, 10.03970] + start_temperature = 323 + target_temperature = 323 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.05 + domain_decomposition = 10001 + cancel_com_momentum = true + max_molecule_size = 15 + thermostat_coupling_groups = [ + ["N", "P", "G", "C"], + ["W"], + ] + + [field] + mesh_size = [25, 25, 25] + sigma = 1.0 + chi = [ + ["C", "W", 42.24], + ["G", "C", 10.47], + ["N", "W", -3.77], + ["G", "W", 4.53], + ["N", "P", -9.34], + ["P", "G", 8.04], + ["N", "G", 1.97], + ["P", "C", 14.72], + ["P", "W", -1.51], + ["N", "C", 13.56], + ] + + [bonds] + bonds = [ + ["N", "P", 0.47, 1250.0], + ["P", "G", 0.47, 1250.0], + ["G", "G", 0.37, 1250.0], + ["G", "C", 0.47, 1250.0], + ["C", "C", 0.47, 1250.0], + ] + angle_bonds = [ + ["P", "G", "G", 120.0, 25.0], + ["P", "G", "C", 180.0, 25.0], + ["G", "C", "C", 180.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +A randomly mixed input structure/topology file +:code:`lipid_self_assembly.HDF5` with a few hundred lipids in a roughy +:code:`10 x 10 x 10nm` box is available in the +`HyMD-tutorial/lipid_self_assembly`_ github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation + +.. code:: bash + + python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5 + +we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook `lipid_self_assembly.ipynb`_. + + +.. _HyMD-tutorial/lipid_self_assembly: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/lipid_self_assembly +.. _lipid_self_assembly.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/lipid_self_assembly.ipynb + + +Peptide in lipid bilayer +======================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true + :align: right + :width: 300 + +Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer. + + +The `configuration file`_ is available in the `HyMD-tutorial/peptide`_ github +repository (omitted here for brevity). + +A pre-equilibrated input structure/topology file :code:`peptide.HDF5` with a +few hundred lipids in a roughy :code:`20 x 20 x 20nm` box is available in the +`HyMD-tutorial/peptide`_ github repository. Running the simulation + +.. code:: bash + + python3 -m hymd peptide.toml peptide.HDF5 + +we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook `peptide.ipynb`_. + + +.. _HyMD-tutorial/peptide: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/peptide +.. _configuration file: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.toml +.. _peptide.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.ipynb + + +SDS +=== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true + :align: right + :width: 300 + +The last part we introduce is explicit electrostatic interactions through +particle--mesh Ewald. Enabling the electrostatic calculations is done via the +:code:`coulombtype` keyword. :code:`"PIC_Spectral"` is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the :code:`dielectric_const` keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge. + + + +.. code-block:: toml + :caption: **sds.toml** + + [simulation] + integrator = "respa" + respa_inner = 10 + n_steps = 3000 + n_print = 1500 + n_flush = + time_step = 0.01 + box_size = [8.3, 8.3, 8.3] + start_temperature = 298 + target_temperature = 298 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.1 + domain_decomposition = 10000 + cancel_com_momentum = true + max_molecule_size = 5 + thermostat_coupling_groups = [ + ["S", "C"], + ["W", "Na"], + ] + dielectric_const = 45.0 # dielectric constant for the simulation medium + coulombtype = "PIC_Spectral" # particle in cloud, spectral method + + [field] + mesh_size = [64, 64, 64] + sigma = 0.5 + chi = [ + ["S", "C", 13.50], + ["S", "Na", 0.00], + ["S", "W", -3.60], + ["C", "Na", 13.50], + ["C", "W", 33.75], + ["W", "Na", 0.00], + ] + + [bonds] + bonds = [ + ["S", "C", 0.50, 1250.0], + ["C", "C", 0.50, 1250.0], + ] + angle_bonds = [ + ["S", "C", "C", 170.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +An input structure/topology file :code:`sds.HDF5` with a couple thousand +randomly dispersed SDS chains is available in the `HyMD-tutorial/sds`_ github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a :code:`/charge` dataset. +Running the simulation with + +.. code:: bash + + python3 -m hymd sds.toml sds.HDF5 + +we observe the aggregation of the SDS into micellular structures---first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook `sds.ipynb`_. + + +.. _HyMD-tutorial/sds: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/sds +.. _sds.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/sds.ipynb diff --git a/main/_sources/doc_pages/filtering.rst.txt b/main/_sources/doc_pages/filtering.rst.txt new file mode 100644 index 00000000..02af68c6 --- /dev/null +++ b/main/_sources/doc_pages/filtering.rst.txt @@ -0,0 +1,30 @@ +.. _filtering-label: + +Filtering +######### +The default grid-independent filter function used in HyMD is a Gaussian + +.. math:: + + H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] + +with reciprocal space representation + +.. math:: + + \hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +The coarse-graining parameter :math:`\sigma` determines a length scale of +particle extent and is given as configuration file input by + +.. code:: toml + + sigma = 0.75 + + +Implementing new filters +^^^^^^^^^^^^^^^^^^^^^^^^ +Implementing new filter functions is straightforward by hijacking +the :code:`setup` method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional. diff --git a/main/_sources/doc_pages/installation.rst.txt b/main/_sources/doc_pages/installation.rst.txt new file mode 100644 index 00000000..2f6e3659 --- /dev/null +++ b/main/_sources/doc_pages/installation.rst.txt @@ -0,0 +1,318 @@ +.. _installation-label: + +Installation +############ + +Dependencies +============ + +**Installing non-Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-openmpi-dev # Install MPI-enabled HDF5 + sudo apt-get install -y pkg-config # Install pkg-config, required for h5py install + sudo apt-get install -y curl wget + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + sudo dnf update -y + sudo dnf install -y python3.9 python3-devel # Install python3 and pip + sudo dnf install -y openmpi-devel # Install MPI development headers + sudo dnf install -y hdf5-openmpi-devel # Install MPI-enabled HDF5 + sudo dnf install -y curl wget + + + The automatic download and building of PFFT has some issues, so we + manually build FFTW and PFFT before calling :code:`pip3 install pfft-python`. + + .. code-block:: bash + + sudo dnf install -y git + sudo dnf install -y libtool + sudo dnf install -y fftw-openmpi-devel fftw-openmpi-libs + export PATH=$PATH:/usr/lib64/openmpi/bin/ # Ensure MPICC is in path + git clone https://github.com/mpip/pfft.git + cd pfft/ + ./bootstrap.sh + ./configure + make + make install + + + .. group-tab:: Mac OSX (brew) + + .. code-block:: bash + + brew update + brew install python # Install python3 and pip + brew install open-mpi # Install MPI development headers + brew install hdf5-mpi # Install MPI-enabled HDF5 + brew install pkg-config # Install pkg-config, required for h5py install + brew install curl wget + +.. warning:: + There might be memory leaks when using HyMD with OpenMPI 4.1.1. + Therefore, using a newer version of OpenMPI is recommended. + See `Issue #186 `_ for more details. + + +**Installing Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + python3 -m pip install --upgrade pip + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + python3 -m pip install "pmesh @ git+https://github.com/rainwoodman/pmesh" + + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + python3.9 -m ensurepip --upgrade + PATH=$PATH:/usr/lib64/openmpi/bin/:/usr/lib64/openmpi/lib/ + python3.9 -m pip install mpi4py numpy cython + export HDF5_DIR="/usr/lib64/openmpi/" + CC="mpicc" HDF5_MPI="ON" python3.9 -m pip install --no-binary=h5py h5py + python3.9 -m pip install "pmesh @ git+https://github.com/rainwoodman/pmesh" + + .. group-tab:: Mac OSX (brew) + + Find the location of the installed :code:`hdf5-mpi` package by + + .. code-block:: bash + + find /usr -iname "*hdf5.h" + + or + + .. code-block:: bash + + brew info hdf5-mpi + + and extract the path, which will look like for example + :code:`/usr/local/Cellar/hdf5-mpi/1.13.0/`. Export it as :code:`HDF5_DIR` + + .. code-block:: bash + + python3 -m ensurepip --upgrade + export HDF5_DIR="/usr/local/Cellar/hdf5-mpi/1.13.0/" + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + python3 -m pip install "pmesh @ git+https://github.com/rainwoodman/pmesh" + + +.. warning:: + + If MPI-enabled HDF5 and :code:`h5py` can not be installed, limited support + for serial HDF5 is available. Note that having MPI-enabled file IO is + **highly recommended**, and simulation performance under serial HDF5 will + potentially be very low. + + Example dependency install on Ubuntu (apt) using serial HDF5: + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-serial-dev # Install serial HDF5 + sudo apt-get install -y curl wget + + python3 -m pip install h5py mpi4py numpy cython + + Running parallel simulations without a + MPI-enabled HDF5 library available necessitates the use of the + :code:`--disable-mpio` argument to HyMD, see :ref:`commandline-label`. Note that + due to the way HyMD is built, a working MPI compiler is required even if all + intended simulations are serial. + + +Installing HyMD +=============== +HyMD may be installed using :code:`pip` by + +.. code-block:: bash + + python3 -m pip install hymd + + + +Install in docker +================= +A docker image with build essentials setup is available at `dockerhub`_ with tag +:code:`mortele/hymd`, + +.. code-block:: bash + + docker pull mortele/hymd:latest + docker run -it mortele/hymd + /app$ python3 -m pip install hymd + + # Grab example input files + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5 + + # Run simulation + /app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose + +.. _dockerhub: + https://hub.docker.com/repository/docker/mortele/hymd + + +Run interactively in Google Colaboratory +======================================== +A `Google Colaboratory`_ jupyter notebook is setup `here`_ with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Common issues +============= + +Numpy errors while importing the Fortran force kernels +------------------------------------------------------ + +.. code-block:: python + + RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd + + Traceback (most recent call last): + + (...) + + File "/..../HyMD/hymd/__init__.py", line 2, in + from .main import main # noqa: F401 + File "/..../HyMD/hymd/main.py", line 10, in + from .configure_runtime import configure_runtime + File "/..../hymd/configure_runtime.py", line 12, in + from .input_parser import read_config_toml, parse_config_toml + File "/..../HyMD/hymd/input_parser.py", line 12, in + from .force import Bond, Angle, Dihedral, Chi + File "/..../HyMD/hymd/force.py", line 8, in + from force_kernels import ( # noqa: F401 + ImportError: numpy.core.multiarray failed to import + +can normally be fixed by updating numpy versions, + +.. code-block:: bash + + python3 -m pip install -U numpy + + +Error building pfft-python due to missing curl/wget +--------------------------------------------------- + +.. code-block:: python + + Building wheel for pfft-python (setup.py) ... error + ERROR: Command errored out with exit status 1: + command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_ + cwd: /tmp/pip-install-fr6nt9m4/pfft-python/ + Complete output (56 lines): + running bdist_wheel + running build + running build_py + + (...) + + curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found + wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found + Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + Please check curl or wget + You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ + Traceback (most recent call last): + File "", line 1, in + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in + setup( + File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup + return distutils.core.setup(**attrs) + File "/usr/lib/python3.8/distutils/core.py", line 148, in setup + + (...) + + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions + build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:])) + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft + raise ValueError("could not build fftw; check MPICC?") + ValueError: could not build fftw; check MPICC? + ---------------------------------------- + ERROR: Failed building wheel for pfft-python + Running setup.py clean for pfft-python + Failed to build pfft-python + +can be fixed by installing either `curl`_ or `wget`_ + +.. code-block:: bash + + apt-get install -y curl wget + + +.. _`curl`: + https://curl.se/ + +.. _`wget`: + https://www.gnu.org/software/wget/ + + +Error running parallel HyMD without MPI-enabled h5py +---------------------------------------------------- + +.. code-block:: python + + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + main() + File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main + with h5py.File(args.input, "r", **_kwargs) as in_file: + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__ + with h5py.File(args.input, "r", **_kwargs) as in_file: + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + raise ValueError("h5py was built without MPI support, can't use mpio driver") + ValueError: h5py was built without MPI support, can't use mpio driver + +Can be fixed by installing a MPI-enabled :code:`h5py` through + +.. code-block:: bash + + python3 -m pip uninstall -y h5py + HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py diff --git a/main/_sources/doc_pages/interaction_energy_functionals.rst.txt b/main/_sources/doc_pages/interaction_energy_functionals.rst.txt new file mode 100644 index 00000000..f33c004e --- /dev/null +++ b/main/_sources/doc_pages/interaction_energy_functionals.rst.txt @@ -0,0 +1,98 @@ +.. _functionals-label: + +Interaction energy functionals +############################## +A few interaction energy functionals :math:`W` are defined in HyMD through +the :code:`Hamiltonian` class and associated subclasses. + +:math:`\chi`--interaction and :math:`\kappa`--incompressibility +=============================================================== +The most common hPF energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultWithChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where :math:`\tilde\chi_{\text{A}-\text{B}}` is the interaction energy between +overlapping densities of particle types :math:`\text{A}` and :math:`\text{B}`. +The incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\tilde\chi` +and :math:`\kappa` in the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + chi = [ + ["A", "B", 15.85], + ["B", "C", -5.70], + ... + ] + +Only :math:`\kappa`--incompressibility +====================================== +The only :math:`\kappa` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultNoChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where the incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Only :math:`\phi^2` +=================== +The :math:`\phi^2` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "SquaredPhi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2, + +where the :math:`\phi` squared term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Implementing new interaction energy forms +========================================= +Implementing new interaction energy functions is straightforward by subclassing +:code:`Hamiltonian` and applying :code:`sympy` differentiation to the symbolic +field objects. The :code:`sympy.lamdify` function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields. diff --git a/main/_sources/doc_pages/interfaces.rst.txt b/main/_sources/doc_pages/interfaces.rst.txt new file mode 100644 index 00000000..07cceece --- /dev/null +++ b/main/_sources/doc_pages/interfaces.rst.txt @@ -0,0 +1,23 @@ +.. _interfaces-label: + +PLUMED interface +################ + +HyMD is interfaced with `PLUMED ` for simulations using enhanced sampling or free-energy methods. +To use the interface, the Python package of PLUMED must be installed, and the user must provide a working :code:`PLUMED_KERNEL` by setting this environment variable to the kernel path. +In the current version, only simulations using a single replica are supported. + +.. warning:: + PLUMED versions prior to :code:`2.8.1` did not have a working Python interface with MPI. Therefore, you **must** use PLUMED :code:`2.8.1` or greater when installing the PLUMED library in Python. Older versions for the kernel are supported if the Python interface was correctly installed with version :code:`2.8.1`. + +Running simulations using PLUMED +================================ + +To run your simulations using PLUMED you must first set the environment variable :code:`PLUMED_KERNEL` and then call HyMD with the :code:`--plumed` option, passing the PLUMED input file to HyMD. +Optionally, you can also set the output file name with the :code:`--plumed-outfile` option (the default it :code:`plumed.out`). + +If your PLUMED input (see the `PLUMED manual <>` for details) is called, e.g., :code:`plumed_input.dat`, you can run a simulation using the PLUMED interface with: + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field --plumed plumed_input.dat diff --git a/main/_sources/doc_pages/intramolecular_bonds.rst.txt b/main/_sources/doc_pages/intramolecular_bonds.rst.txt new file mode 100644 index 00000000..820e81bc --- /dev/null +++ b/main/_sources/doc_pages/intramolecular_bonds.rst.txt @@ -0,0 +1,142 @@ +.. _bonds-label: + +Intramolecular bonds +#################### + +Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see :ref:`config-label`. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +:ref:`benchmarks-label`), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable. + +All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]). + + +Two-particle bonds +^^^^^^^^^^^^^^^^^^ +Stretching bonds in HyMD are implemented as harmonic spring potentials, + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2, + +where :math:`r=|\mathbf{r}|` is the inter-particle distance, :math:`k` is a +constant of dimension energy (units :math:`\text{kJ}\,\text{mol}^{-1}`), and +:math:`r_0` is the equilibrum length of the bond (units: :math:`\text{nm}`). The +force is calculated as + +.. math:: + + F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r}, + +where :math:`\mathbf{r}` is the vector pointing *from* :math:`i` *to* :math:`j`. + +In the configuration file, two-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_two_particle_example.toml + + [bonds] + bonds = [ + ["A", "A", 0.47, 1250.0], + ["A", "B", 0.37, 940.0], + ["B", "C", 0.50, 1010.0], + ["C", "A", 0.42, 550.0], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Three-particle bonds +^^^^^^^^^^^^^^^^^^^^ +Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle--particle--particle angle :math:`\theta`, + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2, + +where :math:`k` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}`), and :math:`\theta_0` is the equilibrum +angle of the bond (units: :math:`{}^\circ`). Defining the particles with labels +:math:`a`, :math:`b`, and :math:`c`, let :math:`\mathbf{r}_a` denote the vector +pointing from :math:`b` to :math:`a`, and correspondingly let +:math:`\mathbf{r}_c` point from :math:`b` to :math:`c`. The +:math:`a`--:math:`b`--:math:`c` may be computed through the law of Cosines, + +.. math:: + + \theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right] + +Then the force acting on :math:`a` and :math:`c` is + +.. math:: + + \mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a}, + + \mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c}, + +and + +.. math:: + + \mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c + +In the configuration file, three-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_three_particle_example.toml + + [bonds] + angle_bonds = [ + ["A", "A", "A", 180.0, 90.0], + ["A", "B", "A", 120.0, 55.0], + ["B", "C", "C", 30.0, 10.0], + ["C", "A", "B", 110.0, 25.5], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Four-particle bonds +^^^^^^^^^^^^^^^^^^^ +Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle :math:`\phi` between the +:math:`a`--:math:`b`--:math:`c` and :math:`b`--:math:`c`--:math:`d` planes, for +a dihedral bond quartet :math:`a`, :math:`b`, :math:`c`, and :math:`d`. The +potential takes the form + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n), + +where :math:`c_n` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`), and :math:`\phi_n` are +specified phase angles in the cosine series. + +In the configuration file, four-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_four_particle_example.toml + + [bonds] + dihedrals = [ + ["A", "B", "C", "D"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0], + ] diff --git a/main/_sources/doc_pages/overview.rst.txt b/main/_sources/doc_pages/overview.rst.txt new file mode 100644 index 00000000..0e4d6b65 --- /dev/null +++ b/main/_sources/doc_pages/overview.rst.txt @@ -0,0 +1,166 @@ +.. _overview-label: + +================================ + Usage overview for HylleraasMD +================================ + +HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a `toml`_ format configuration file, along with a topology and structure +file specifying the input system in HDF5 format. + +.. _`toml`: + https://github.com/toml-lang/toml + +**Configuration file** + +The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a :code:`[5, 5, 5]` nm simulation box at 300 K may look like +the following: + +.. code-block:: toml + :caption: **config_simple_1.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "SquaredPhi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [30, 30, 30] # FFT grid size + sigma = 0.5 # filtering length scale in nm + +Note that for the version 1.0 release of HyMD, the :code:`[particles]`, +:code:`[simulation]`, and :code:`[field]` groups are optional specifiers for +structuring the configuration file. + +For a full specification of every recognised configuration keyword in HyMD, +please refer to :ref:`config-label`. + +**Topology and structure file** + +The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +:code:`N` particles may look like the following: + +.. code-block:: bash + :caption: **example_structure.HDF5** + + group / + # root group + + dataset /coordinates + # float32, shape (T, N, D,) + # Time steps of N rows of D dimensional coordinate data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /velocities + # float32, shape (T, N, D,) OPTIONAL + # Time steps of N rows of D dimensional velocity data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /bonds + # int32, shape (N, B,) OPTIONAL + # Each row i contains indices of the particles bonds from/to i + # B denotes the maximum bonds per particle + + dataset /indices + # int32, shape (N,) + # Index of each particle, 0--(N-1) + + dataset /molecules + # int32, shape (N,) + # Index of molecule each particle belongs to + # Used to construct bond network locally on MPI ranks + + dataset /names + # str10, shape (N,) + # Fixed size string array containing particle type names + + dataset /types + # int32, shape (N,) OPTIONAL + # Mapping of particle names to type indices + + +For a full specification of the topology and structure input file, see +:ref:`topology-label`. + +**Command line arguments** + +A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the :code:`config_simple_1.toml` and :code:`example_structure.HDF5` +files may look like the following: + +.. code-block:: bash + + mpirun -n ${MPI_NUM_RANKS} python3 -m hymd \ # HyMD executable + config_simple_1.toml \ # configuration file + example_structure.HDF5 \ # structure file + --logfile=log_out.txt \ # set logfile path + --seed 123456 \ # set random seed + --verbose 2 \ # set logging verbosity + --velocity-output # enable velocity in trajectory output + +For a full specification of all command line arguments, see +:ref:`commandline-label`. + +**More examples** + +For more thorough rundown and concrete usage examples, see +:ref:`examples-label`. + +Running parallel simulations +============================ +Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the **only** difference being how the python3 interpreter is +invoked. Prepending :code:`mpirun -n ${NPROCS}` to the usual +:code:`python3 -m hymd` runs the simulation with :code:`${NPROCS}` MPI ranks. + +Inputting + +.. code:: bash + + mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field + +sets up an example simulation of the `HyMD-tutorial/ideal_gas`_ system. For +more details about this system in particular, or other example simulations, see +the `HyMD-tutorial`_ repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas + + +Running tests +============= +Run serial code tests by + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd + cd hymd/ + python3 -m pip install pytest pytest-mpi + python3 -m pytest + +There is a small convenience script in :code:`hymd/` for running the MPI-enabled +tests, + +.. code-block:: bash + + chmod +x pytest-mpi + ./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no diff --git a/main/_sources/doc_pages/pressure.rst.txt b/main/_sources/doc_pages/pressure.rst.txt new file mode 100644 index 00000000..be9c7cda --- /dev/null +++ b/main/_sources/doc_pages/pressure.rst.txt @@ -0,0 +1,37 @@ +.. _pressure-label: + +Pressure +######## +Internal pressure is calculated from internal energy according to + +.. math:: + + P_a = \frac{1}{\mathcal{V}} \left( 2T_a - \text{Vir}_a \right) \\ + \text{Vir}_a = L_a \frac{\partial \mathcal{U}}{\partial L_a} \\ + \mathcal{U} = \sum_{i=1}^M \mathcal{U}_0( \{ \mathbf{r}\}_i ) + W[\{ \tilde\phi \} ] + +where +:math:`\mathcal{V}` is the simulation volume, +:math:`{T_a}` is the kinetic energy +and :math:`L_a` the length of the box in the Cartesian direction :math:`a`, +Vir is the virial of the total interaction energy :math:`\mathcal{U}`. + +:math:`\mathcal{U}` comprises intramolecular bonded terms :math:`\mathcal{U}_0` (see :ref:`bonds-label` for details), +and field terms :math:`W[\{ \tilde\phi \} ]` (see :ref:`theory-label` for details). + +Using the above expressions, the following form for internal pressure is obtained: + +.. math:: + + P_a = \frac{2 T_a}{\mathcal{V}} -\frac{L_a}{\mathcal{V}} \sum_{i=1}^N \frac{\partial \mathcal{U}_{0i}}{\partial L_a} + P^{(3)}_a \\ + +.. P^{(3)}_a = - \frac{L_a}{\mathcal{V}} \frac{\partial W[\{ \tilde\phi \} ]}{\partial L_a} \\ + +.. math:: + + P^{(3)}_a = \frac{1}{\mathcal{V}}\left ( -W[\{ \tilde\phi(\mathbf{r}) \}] + \int \sum_t \bar{V}_t(\mathbf{r})\tilde\phi_t(\mathbf{r})d\mathbf{r} + + \int \sum_t \sigma^2\bar{V}_t(\mathbf{r})\nabla_a^2\tilde\phi_t(\mathbf{r}) d\mathbf{r} \right) + +where :math:`\bar{V}_t(\mathbf{r}) = \frac{\partial w(\{\tilde\phi\})}{\partial\tilde\phi_t}` +and :math:`σ` is a coarse-graining parameter (see :ref:`filtering-label` for details). +Note that the above expression is obtained for a Gaussian filter which is the most natural choice in HhPF theory. diff --git a/main/_sources/doc_pages/theory.rst.txt b/main/_sources/doc_pages/theory.rst.txt new file mode 100644 index 00000000..2429bc0d --- /dev/null +++ b/main/_sources/doc_pages/theory.rst.txt @@ -0,0 +1,122 @@ +.. _theory-label: + +Theory +###### +Hybrid particle--field simulations switch out the ordinary particle--particle +`Lennard-Jones`_ interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle--field densities are +defined as + +.. math:: + + \phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i), + +where :math:`\mathbf{r}` is a spatial coordinate, :math:`P` is a window function +used to distribute particle number densities onto a computational grid, and +:math:`\mathbf{r}_i` is the position of particle :math:`i` (of total :math:`N`). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of :math:`N` particles in :math:`M` molecules is + +.. math:: + + \mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})] + +with :math:`H_0` being a standard intramolecular Hamiltonian form (see +:ref:`bonds-label`) including kinetic terms, while :math:`W` is a density +dependent *interaction energy functional*. + +In the Hamiltonian hPF-MD formalism :cite:`bore2020hamiltonian`, the density +field is filtered using a grid-independent filtering function :math:`H`, + +.. math:: + + \tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}). + +The filter smooths the density, ensuring that :math:`\tilde\phi` and +:math:`W[\tilde\phi([\phi])]` both converge as the grid size is reduced. + +External potential +================== +The external potential acting on a particle is defined as the functional +derivative of :math:`W` with respect to :math:`\phi`. In the filtered formalism, +the potential takes the form + +.. math:: + + V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ + &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})}, + +under the assumption of a *local* form of the interaction energy functional, +:math:`W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]`. Note +that + +.. math:: + + \frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}). + +Force interpolation +=================== +The forces on particle :math:`i` are obtained by differentiation of the external +potential, + +.. math:: + + \mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i). + + +Reciprocal space calculations +============================= +The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density :math:`\phi_{ijk}` with CIC, we apply the filtering +and obtain the discrete version of the external potential by + +.. math:: + + \tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big] + +and + +.. math:: + + V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +The forces are obtained by differentiation of :math:`V` in Fourier space as + +.. math:: + + \nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +Filter +====== +By default, the filter used in HyMD is a simple Gaussian of the form + +.. math:: + + H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ + \hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +For more details about the filtering, see :ref:`filtering-label`. + +Hamiltonian form +================ +The default form of the interaction energy functional in HyMD is + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2. + +In the case of constant pressure simulations (NPT), the interaction energy functional becomes + +.. math:: + + W=\frac{1}{2\rho_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-a\right)^2. + +where, :math:`\rho_0= 1 / ν` is an intrinsic parameter corresponding to the specific volume :math:`(ν)` of a coarse-grained particle, +:math:`a` is a calibrated parameter to obtain the correct average density at the target temperature and pressure. +See :ref:`functionals-label` for details. + + +.. _`Lennard-Jones`: + https://en.wikipedia.org/wiki/Lennard-Jones_potential diff --git a/main/_sources/doc_pages/topology_input.rst.txt b/main/_sources/doc_pages/topology_input.rst.txt new file mode 100644 index 00000000..02faa501 --- /dev/null +++ b/main/_sources/doc_pages/topology_input.rst.txt @@ -0,0 +1,84 @@ +.. _topology-label: + +============================ +Topology and structure file +============================ +The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root :code:`/` group. + +The `HyMD-tutorial`_ has multiple examples of structure files for various levels +of complexity. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Required datasets +================= +:/coordinates: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/indices: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/names: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`string` (:code:`length` between :code:`1` and :code:`16`)] + + The shape represents one particle name per :code:`N` particles. The datatype may be a string of length :code:`=<16`. + + + +Optional datasets +================= +:/velocities: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/types: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle type index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/molecules: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one molecule index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/bonds: + :code:`array` shape [:code:`N`, :code:`B`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents :code:`B` bond specifications (indices of different particles) per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/charge: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents one particle charge per :code:`N` particles. The data type may be either four or eight byte reals. + +:/box: + :code:`array` shape [:code:`3`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents the initial box dimensions in Cartesian coordinates. diff --git a/main/_sources/index.rst.txt b/main/_sources/index.rst.txt new file mode 100644 index 00000000..6899ec42 --- /dev/null +++ b/main/_sources/index.rst.txt @@ -0,0 +1,164 @@ +.. hymd documentation master file, created by + sphinx-quickstart on Thu Dec 16 13:31:43 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +############################### +HylleraasMD documentation +############################### + +:Release: + |release| +:Date: + |today| + +**HylleraasMD** (HyMD) is a massively parallel Python package for Hamiltonian hybrid +particle-field molecular dynamics (HhPF-MD) simulations of coarse-grained bio- +and soft-matter systems. + +HyMD can run canonical hPF-MD simulations, or filtered density HhPF-MD simulations :cite:`hymd_domain2023,hymd_massive2023,hymd_pressure2023,hymd_alias2020` +with or without explicit PME electrostatic interactions. It includes all standard intramolecular interactions, +including stretching, bending, torsional, and combined bending-dihedral potentials. Additionally, topological reconstruction of permanent peptide chain backbone +dipoles is possible for accurate recreation of protein conformational dynamics. It can run simulations in constant energy (NVE), constant volume (NVT) :cite:`hymd_domain2023,hymd_massive2023` +or constant pressure (NPT) conditions :cite:`hymd_pressure2023`. +HyMD is also interfaced with :doc:`PLUMED ` and can perform simulations using enhanced sampling methods. + +HyMD uses the pmesh library for particle-mesh operations, with the PPFT :cite:`pippig2013` backend for FFTs through the pfft-python bindings. +File IO is done via HDF5 formats to allow MPI parallel reads. + +User Guide +========== +The HylleraasMD :doc:`User Guide ` provides comprehensive information on how to run +simulations. Selected :doc:`Examples ` are available to guide new users. + +.. _`github.com/rainwoodman/pmesh`: + https://github.com/rainwoodman/pmesh +.. _`github.com/rainwoodman/pfft-python`: + https://github.com/rainwoodman/pfft-python + +Installing HyMD +=============== +The easiest approach is to install using pip_: + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + +For more information and **required dependencies**, see +:ref:`installation-label`. + +.. _pip: + http://www.pip-installer.org/en/latest/index.html + + +Run in Google colab +------------------- +Run HyMD interactively in `Google Colaboratory`_ jupyter notebook `here`_. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Source Code +=========== +**Source code** is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the `GNU Lesser General Public +License v3.0`_. Obtain the source code with `git`_: + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git + +.. _GNU Lesser General Public License v3.0: + https://www.gnu.org/licenses/lgpl-3.0.html +.. _git: + https://git-scm.com/ + + +Development +=========== +HyMD is developed and maintained by researchers at the `Hylleraas Centre for +Quantum Molecular Sciences`_ at the `University of Oslo`_. + +|pic1| |pic2| + +.. _`Hylleraas Centre for Quantum Molecular Sciences`: + https://www.mn.uio.no/hylleraas/english/ +.. _`University of Oslo`: + https://www.uio.no/ + +.. |pic1| image:: img/hylleraas_centre_logo_black.png + :target: img/hylleraas_centre_logo_black.png + :width: 250 px + +.. |pic2| image:: img/uio_full_logo_eng_pos.png + :target: img/uio_full_logo_eng_pos.png + :width: 325 px + + + +References +========== +.. bibliography:: + :all: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. Contents +.. ======== + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Getting started + + ./doc_pages/installation + ./doc_pages/overview + ./doc_pages/config_file + ./doc_pages/topology_input + ./doc_pages/command_line + ./doc_pages/constants_and_units + + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Examples + + ./doc_pages/examples + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Theory + + ./doc_pages/theory + ./doc_pages/intramolecular_bonds + ./doc_pages/electrostatics + ./doc_pages/pressure + ./doc_pages/interfaces + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Developer documentation + + ./doc_pages/interaction_energy_functionals + ./doc_pages/filtering + ./doc_pages/benchmarks + ./doc_pages/api diff --git a/main/_static/basic.css b/main/_static/basic.css new file mode 100644 index 00000000..be19270e --- /dev/null +++ b/main/_static/basic.css @@ -0,0 +1,856 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/main/_static/css/badge_only.css b/main/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/main/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/main/_static/css/fonts/Roboto-Slab-Bold.woff b/main/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/main/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/main/_static/css/fonts/Roboto-Slab-Bold.woff2 b/main/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/main/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/main/_static/css/fonts/Roboto-Slab-Regular.woff b/main/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/main/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/main/_static/css/fonts/Roboto-Slab-Regular.woff2 b/main/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/main/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/main/_static/css/fonts/fontawesome-webfont.eot b/main/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/main/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/main/_static/css/fonts/fontawesome-webfont.svg b/main/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/main/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/main/_static/css/fonts/fontawesome-webfont.ttf b/main/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/main/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/main/_static/css/fonts/fontawesome-webfont.woff b/main/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/main/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/main/_static/css/fonts/fontawesome-webfont.woff2 b/main/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/main/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/main/_static/css/fonts/lato-bold-italic.woff b/main/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/main/_static/css/fonts/lato-bold-italic.woff differ diff --git a/main/_static/css/fonts/lato-bold-italic.woff2 b/main/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/main/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/main/_static/css/fonts/lato-bold.woff b/main/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/main/_static/css/fonts/lato-bold.woff differ diff --git a/main/_static/css/fonts/lato-bold.woff2 b/main/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/main/_static/css/fonts/lato-bold.woff2 differ diff --git a/main/_static/css/fonts/lato-normal-italic.woff b/main/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/main/_static/css/fonts/lato-normal-italic.woff differ diff --git a/main/_static/css/fonts/lato-normal-italic.woff2 b/main/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/main/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/main/_static/css/fonts/lato-normal.woff b/main/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/main/_static/css/fonts/lato-normal.woff differ diff --git a/main/_static/css/fonts/lato-normal.woff2 b/main/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/main/_static/css/fonts/lato-normal.woff2 differ diff --git a/main/_static/css/theme.css b/main/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/main/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/main/_static/custom.css b/main/_static/custom.css new file mode 100644 index 00000000..b20d6282 --- /dev/null +++ b/main/_static/custom.css @@ -0,0 +1,91 @@ + +body{ + background: #FFFFFF !important; +} + +.wy-menu-vertical header, .wy-menu-vertical p.caption{ + color: #4EA0AF!important; +} +.wy-menu-vertical li.current{ + background-color: #f4f4f4!important; +} +.wy-menu-vertical li.toctree-l2.current>a{ + background-color: #ebebeb!important; +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{ + background-color: #e3e3e3!important; +} + +.rst-content .sidebar{ + background-color: #fff!important; + border-radius: 6px; + -moz-border-radius: 6px; + -webkit-border-radius: 6px; +} + +h1 > a, h2 > a, h3 > a, h4 > a, h5 > a, h6 > a { + color: #17d9ff; +} + +h1, h2, h3, h4, h5, h6 { + color: black; + font-weight: normal; + padding: 0; +} + +h1, h2, h3 { + margin-top: 30px; + margin-bottom: 20px; +} + +h1 { + color: white; + padding: 20px 20px 20px 45px; + margin: 20px 0 35px -45px; + background: linear-gradient(to left, #fff, #2b38ff)!important; + + width: calc(100% + 90px); + border-bottom: 3px solid #000; +} + +h2 { + padding: .2em 0; + border-bottom: 1px solid #ddd; +} + +h3 { + margin-top: 35px; +} + +h4 { + margin-top: 30px; +} + +h5 { + margin-top: 25px; +} + +.wy-nav-content{ + max-width: none!important; +} + +.wy-side-nav-search{ + background: #2b38ff!important; +} + +.wy-side-nav-search input[type=text]{ + border-color:#4DA0B0!important; +} + +.wy-side-nav-search input[type=text]{ + border-radius: 4px!important; +} + +#caption-api { + background: red !important; +} + +#caption-text-api { + text-color: blue !important; +} diff --git a/main/_static/doctools.js b/main/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/main/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/main/_static/documentation_options.js b/main/_static/documentation_options.js new file mode 100644 index 00000000..f202afa0 --- /dev/null +++ b/main/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '2.2.0', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/main/_static/file.png b/main/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/main/_static/file.png differ diff --git a/main/_static/hymd_icon_white.png b/main/_static/hymd_icon_white.png new file mode 100644 index 00000000..d0396a17 Binary files /dev/null and b/main/_static/hymd_icon_white.png differ diff --git a/main/_static/hymd_logl_white_text_abbr.png b/main/_static/hymd_logl_white_text_abbr.png new file mode 100644 index 00000000..8c0e50c8 Binary files /dev/null and b/main/_static/hymd_logl_white_text_abbr.png differ diff --git a/main/_static/jquery-3.5.1.js b/main/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/main/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. API reference

+
+

4.1. Integrator

+

Integrates equations of motion.

+

Implements the Velocity Verlet integrator. The reversible reference system +propagator algorithm (rRESPA) integrator uses the Velocity Verlet functions +inside the MD loop in the main module.

+
+
+hymd.integrator.integrate_position(positions, velocities, time_step)[source]
+

Position update step of the Velocity Verlet integration algorithm.

+

Computes the position update step of the Velocity Verlet algorithm. The +positions argument is not changed in place.

+
+
Parameters:
+
+
positions(N, D) numpy.ndarray

Array of positions of N particles in D dimensions.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_velocity

The velocity update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step, then the positions are updated a full step using the updated +velocities

+
+\[\mathbf{x}_{\text{new}} = \mathbf{x} + \Delta t \mathbf{v}\]
+
+ +
+
+hymd.integrator.integrate_velocity(velocities, accelerations, time_step)[source]
+

Velocity update step of the Velocity Verlet integration algorithm.

+

Computes the velocity update step of the Velocity Verlet algorithm. The +velocities argument is not changed in place.

+
+
Parameters:
+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
accelerations(N, D) numpy.ndarray

Array of accelerations of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_position

The position update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step

+
+\[\mathbf{v}_{\text{new}} = \mathbf{v} + \frac{\Delta t}{2m} +\mathbf{f}\]
+

before the positions are moved a full step using the updated half-step +velocities.

+
+ +
+
+

4.2. Thermostat

+

Scales or otherwise modifies the particle velocities during simulation to +simulate coupling to an external heat bath with temperature T₀.

+
+
+hymd.thermostat._random_chi_squared(prng: numpy.random._generator.Generator, M: int)float[source]
+

Draw the sum of M squared normally distributed values

+

The value is generated by the Gamma distribution, in lieu of generating +M Gaussian distributed numbers and summing their squares.

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
Mint

Number of standard normally distributed numbers in the sum.

+
+
+
+
Returns:
+
+
float

The sum of M squared normally distributed values centered at +zero with unit standard deviation.

+
+
+
+
+

Notes

+

The sum of the squares of k independent standard normal random variables is +distributed according to a \(\chi^2\) distribution.

+
+\[\chi^2_1 + \chi_2^2 + \chi_3^2 + \dots + \chi_M^2 +\sim +\sigma^2\chi^2(k)\]
+

This is a special case of the \(\Gamma\) distribution, +\(\Gamma(k/2, 2)\), and may be generated by

+
+\[\chi^2(k) \sim 2 \Gamma(k/2, 2)\]
+

References

+

Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of +Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. +J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246.

+
+ +
+
+hymd.thermostat._random_gaussian(prng: numpy.random._generator.Generator)float[source]
+

Draw a single random number from the standard normal distribution +Generate a number from the Gaussian distribution centered at zero with unit +standard deviation, \(N(0, 1)\).

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
+
+
Returns:
+
+
float

A random number drawn from \(N(0, 1)\).

+
+
+
+
+
+ +
+
+hymd.thermostat.csvr_thermostat(velocity: numpy.ndarray, names: numpy.ndarray, config: hymd.input_parser.Config, prng: numpy.random._generator.Generator, comm: mpi4py.MPI.Intracomm = <mpi4py.MPI.Intracomm object>, random_gaussian: Callable[[numpy.random._generator.Generator], float] = <function _random_gaussian>, random_chi_squared: Callable[[numpy.random._generator.Generator, int, float], float] = <function _random_chi_squared>, remove_center_of_mass_momentum: bool = True)numpy.ndarray[source]
+

Canonical sampling through velocity rescaling thermostat

+

Implements the CSVR thermostat. Rescales the system kinetic energy by a +stochastically chosen factor to keep the temperature constant. Requires +communcation of the kinetic energies calculated locally for each MPI rank. +The random numbers sampled through random_gaussian and +random_chi_squared are broadcast from the root rank to the other +ranks to ensure the scaling is performed with the same stochasticity for +all particles in the full system.

+

The velocities are cleaned of center of mass momentum before the thermostat +is applied, and the center of mass momentum is subsequently reapplied. This +is performed for each thermostat coupling group, i.e. the center of mass +momenta of each group is separately removed and reapplied after +thermostatting.

+

The implementation here is based on the derivation presented in the 2008 +Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper.

+
+
Parameters:
+
+
velocity(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
names(N,) numpy.ndarray

Array of particle names.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
random_gaussiancallable, optional

Function for generating standard normally distributed numbers.

+
+
random_chi_squaredcallable, optional

Function for generating \(\chi^2\)-distributed numbers

+
+
remove_center_of_mass_momentumbool, optional

If True, the center of mass of each coupling group is removed before +the thermostat is applied. The center of mass momenta are added back +after the kinetic energy rescaling is complete.

+
+
+
+
+
+

See also

+
+
_random_gaussian

Used to sample Gaussian-distributed numbers.

+
+
_random_chi_squared

Used to sample \(\chi^2\)-distributed numbers.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +

References

+

G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). +G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008).

+
+ +
+
+

4.3. Barostat

+
+

4.3.1. Berendsen Barostat

+

Implements the Berendsen barostat. +Scales the box and particle positions during simulation to +simulate coupling to an external pressure bath set at a +target pressure.

+

It calculates the scaling factor according to: +.. math:

+
\alpha_{L,N} = 1 - \frac{dt n_b}{\tau_p}\β(P_{L,N}^t - P_{L,N})
+
+
+

where \(dt\) is the outer rRESPA time-step, \(n_b\) is the frequency +of barostat calls, \(\tau_p\) is the pressure coupling time constant, +\(\beta\) is the isothermal compressibility, \(P_{L,N}^t\) and +\(P_{L,N}\) is the target and instantaneous internal pressure in the +lateral (L) and normal (N) directions respectively. Convention: Cartesian +z-direction is considered normal.

+

The box and particle positions are scaled in the L and N directions according +to the nature of the barostat (see functions isotropic and semiisotropic +below by an amount \(\α^{\frac{1}{3}}\).

+

The updated system information is passed on to the pmesh objects.

+
+

4.3.1.1. References

+

H. J. C. Berendsen, J. P. M. Postma, W. F. van Gunsteren, +A. DiNola, and J. R. Haak , “Molecular dynamics with coupling +to an external bath”, J. Chem. Phys. 81, 3684-3690 (1984)

+
+
+hymd.barostat.isotropic(pmesh, pm_stuff, phi, phi_q, psi, hamiltonian, positions, velocities, config, phi_fft, phi_laplacian, phi_transfer, bond_pr, angle_pr, step, prng, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Implements an isotropic Berendsen barostat. +The box and particle positions are scaled uniformly +in the L and N directions.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of pmesh objects.

+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fftlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds.

+
+
stepinteger

MD step number

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of modified/unmodified pmesh objects.

+
+
changeBoolean

Indicates whether or not any pmesh objects were reinitialized.

+
+
+
+
+
+ +
+
+hymd.barostat.semiisotropic(pmesh, pm_stuff, phi, phi_q, psi, hamiltonian, positions, velocities, config, phi_fft, phi_laplacian, phi_transfer, bond_pr, angle_pr, step, prng, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Implements a semiisotropic Berendsen barostat. +The box and particle positions are scaled by \(\alpha_L^{\frac{1}{3}}\) +in the L direction and by \(\alpha_N^{\frac{1}{3}}\) in the N direction.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of pmesh objects.

+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fftlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds.

+
+
stepinteger

MD step number

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of modified/unmodified pmesh objects.

+
+
changeBoolean

Indicates whether or not any pmesh objects were reinitialized.

+
+
+
+
+
+ +
+
+
+

4.3.2. SCR Barostat

+
+
+
+

4.4. Hamiltonian

+
+
+class hymd.hamiltonian.Hamiltonian(config)[source]
+

Interaction energy functional superclass

+
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+_setup()[source]
+

Superclass setup

+

Sets up the grid-independent filtering function H, and the +SymPy logic for symbolically differentiating interaction energy +functionals in Hamiltonian subclasses.

+
+ +
+ +
+
+class hymd.hamiltonian.SquaredPhi(config)[source]
+

Simple squared density interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + \sum_k \tilde\phi_k + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(rho_0\) is the +average density of the fully homogenous system. Expressing the species +densities in terms of fluctuations from the average,

+
+\[\mathrm{d}\tilde\phi_k = \rho_0 - \tilde\phi_k,\]
+

it is evident that this interaction energy functional is a slight change of +the DefaultNoChi Hamiltonian, as the expanded interaction energy +density becomes

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + 6\rho_0\left[ + \sum_k \mathrm{d}\tilde\phi_k + \right] + + + 9\rho_0^2 + + + \sum_k \mathrm{d}\tilde\phi_k^2 + + + \prod_{k\not=l} + \mathrm{d}\tilde\phi_k \mathrm{d}\tilde\phi_l + \right),\]
+

identical to DefaultNoChi apart from a constant energy shift +\(9\rho_0^2`(which does not impact dynamics) and the +:math:\)rho_0`–\(\mathrm{d}\tilde\phi_k\) cross-terms. These +cross-terms constitute contributions to the energy linear in +\(\mathrm{d}\tilde\phi_k\) absent in DefaultNoChi, which has +only quadratic terms present.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultNoChi(config)[source]
+

Incompressibility-only interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a +\right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. The SquaredPhi Hamiltonian implements a similar +functional with an additional linear term component depending on

+
+\[\mathmr{d}\tilde\phi_k = \tilde\phi_k - \rho_0\]
+

and not \(\mathrm{d}\tilde\phi_k^2\). No explicit inter-species +interaction is present apart from the indirect interaction through the +incompressibility.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultWithChi(config, unique_names, type_to_name_map)[source]
+

Incompressibility and \(\chi\)-interactions energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = + \frac{1}{2\rho_0} + \sum_{k,l}\chi_{kl} \tilde\phi_k \tilde\phi_l + + + \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. \(\chi_{ij}\) is the Flory-Huggins-like +inter-species mixing energy.

+
+
+__init__(config, unique_names, type_to_name_map)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup(unique_names, type_to_name_map)[source]
+

Setup the interaction energy potential and the external potential

+
+
Parameters:
+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+ +
+ +
+
+

4.5. Force

+

Calculates intramolecular forces between bonded particles in molecules

+
+
+class hymd.force.Angle(atom_1: str, atom_2: str, equilibrium: float, strength: float, atom_3: str)[source]
+

Dataclass representing a single three-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any three-particle bond between particles of specific types A, +B, and C (where A, B, and C may be +different or the same). Harmonic angular three-particle bonds in HyMD take +the form

+
+\[V_3(\mathbf{r}_1, \mathbf{r}_2, \mathbf{r}_3) = + \frac{1}{2}k + \left( + \cos^{-1} + \left[ + \frac{ + (\mathbf{r}_1-\mathbf{r}_2) + \cdot + (\mathbf{r}_3-\mathbf{r}_2) + } + { + \vert\mathbf{r}_1-\mathbf{r}_2\vert + \vert\mathbf{r}_3-\mathbf{r}_2\vert + } + \right] - \theta_0 + \right)^2\]
+
+

See also

+
+
Bond

Two-particle bond type dataclass

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
equilibriumfloat

Equilibrium angle at which the energy associated with the +three-particle angular bond vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient.

+
+
+
+
+
+
+atom_3: str
+
+ +
+ +
+
+class hymd.force.Bond(atom_1: str, atom_2: str, equilibrium: float, strength: float)[source]
+

Dataclass representing a single two-particle bond type

+

A bond type is a bond strength and equilibrium distance associated with +any bond between particles of specific types A and B +(where A and B may be the same or different). Harmonic +two-particle bonds in HyMD take the form

+
+\[V_2(\mathbf{r}_1, \mathbf{r}_2) = + \frac{1}{2}k + \left( + \vert \mathbf{r}_1 - \mathbf{r}_2 \vert - r_0 + \right)^2,\]
+

where \(k\) is the bond strength (spring constant) and \(r_0\) is +the equilibrium bond length (at which the energy is zero).

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
equilibriumfloat

Equilibrium distance at which the energy associated with the bond +vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient (spring constant).

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+equilibrium: float
+
+ +
+
+strength: float
+
+ +
+ +
+
+class hymd.force.Chi(atom_1: str, atom_2: str, interaction_energy: float)[source]
+

Dataclass representing a single \(\chi\) mixing interaction type

+

An interaction mixing energy type is a mixing energy associated with +density overlap between species of types A and B +(specified as inputs atom_1 and atom_2). A positive mixing +energy promotes phase separation, a negative mixing energy promotes mixing. +The interaction energy density (provided the DefaultWithChi +Hamiltonian is used) takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} + \sum_{k,l}\chi_{k,l} \tilde\phi_k\tilde\phi_l,\]
+

where \(\chi_{k,l}\) denotes the mixing energy between species +\(k\) and \(l\), with \(\kappa\) being the incompressibility. +The value of the interaction mixing energy parameter may be extracted from +Flory-Huggins theory.

+
+

See also

+
+
hymd.hamiltonian.DefaultWithChi

Interaction energy functional using \(\chi\)-interactions.

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
interaction_energyfloat

Interaction mixing energy.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+interaction_energy: float
+
+ +
+ +
+
+class hymd.force.Dielectric_type(atom_1: str, dielectric_value: float)[source]
+
+
+atom_1: str
+
+ +
+
+dielectric_value: float
+
+ +
+ +
+
+class hymd.force.Dihedral(atom_1: str, atom_2: str, atom_3: str, atom_4: str, coeffs: numpy.ndarray, dih_type: int)[source]
+

Dataclass representing a single four-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any four-particle torsional bond between particles of specific types +A, B, C, and D (where A, B, +C, and D may be different or the same). Dihedral +four-particle bonds in HyMD take different forms depending on the +dih_type parameter.

+

In the following, let \(\phi\) denote the angle between the planes +spanned by the relative positions of atoms A-B-C +and B-C-D. If dih_type = 0, then

+
+\[V_4(\phi) = \sum_n c_n + \left( + 1 + \cos\left[ + n\phi - d_n + \right] + \right),\]
+

where \(c_n\) are energy coefficients and \(d_n\) are propensity +phases. By default, the cosine sum is truncated at five terms. If +coeffs provides only a single float, this is used as the coiling +propensity parameter \(\lambda\). In this case, \(c_n\) and +\(d_n\) are automatically set to values which promote alpha helical +(\(\lambda=-1\)), beta sheet (\(\lambda=1\)), or a mixed +(\(1>\lambda>-1\)) structure (using values provided by Bore et al. +(2018)). In this case, the full potential takes the form

+
+\[V_4(\phi;\lambda) = + \frac{1}{2}(1-\lambda) V_{\text{prop},\alpha}(\phi) + + + \frac{1}{2}(1+\lambda) V_{\text{prop},\beta}(\phi) + + + (1-\vert\lambda\vert) V_{\text{prop}, \text{coil}}(\phi),\]
+

with each of the \(V_{\mathrm{prop}, X}\) being fixed cosine series +potentials with pre-set \(c_n\) -s and \(d_n\) -s.

+

If dih_type = 1, then a combined bending torsional (CBT) potential +is employed,

+
+\[V_4(\phi,\gamma;\lambda) = + V_4(\phi;\lambda) + + + \frac{1}{2}K(\phi)(\gamma - \gamma_0)^2,\]
+

where \(V_4(\phi;\lambda)\) specifies the potential as given by the +coiling propensity parameter above, \(K(\phi)\) is a separate cosine +series potential acting as the angular three-particle bond strength, and +\(\gamma_0\) is the three-particle bond equilibrium angle. In this +case, the coeffs parameter must specify both a \(\lambda\) +value, in additon to the energy and phases dictating the \(K(\phi)\) +potential.

+

References

+

Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018.

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
atom_4str

Type name of particle 4.

+
+
coeffslist[list[float]] or list[float] or numpy.ndarray

Dihedral coefficients defining the series expansion of the dihedral +energy.

+
+
dih_typeint

Specifies the type of dihedral used; If 0, then coeffs +must contain either two lists of five energy coefficients +\(c_n\) and five propensity phases \(d_n\) or a single +floating point number defining the \(\lambda\) coiling propensity +parameter. If 1, the combined bending-torsional potential is +used, and coeffs must specify \(\lambda\) and two lists +containing energy coefficients and propensity phases for the +\(V_\text{prop}\) propensity potential, defined in terms of cosine +series.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+atom_3: str
+
+ +
+
+atom_4: str
+
+ +
+
+coeffs: numpy.ndarray
+
+ +
+
+dih_type: int
+
+ +
+ +
+
+hymd.force.compute_angle_forces__plain(f_angles, r, bonds_3, box_size)[source]
+

Computes forces resulting from angular interactions

+
+

Deprecated since version 1.0.0: compute_angle_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_bond_forces__plain(f_bonds, r, bonds_2, box_size)[source]
+

Computes forces resulting from bonded interactions

+
+

Deprecated since version 1.0.0: compute_bond_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size)[source]
+

Computes forces resulting from dihedral interactions

+
+

Deprecated since version 1.0.0: compute_dihedral_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.dipole_forces_redistribution(f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb)[source]
+

Redistribute electrostatic forces calculated from topologically +reconstructed ghost dipole point charges to the backcone atoms of the protein.

+
+ +
+
+hymd.force.find_all_paths(G, u, n)[source]
+

Helper function that recursively finds all paths of given lenght ‘n + 1’ inside a network ‘G’. +Adapted from https://stackoverflow.com/a/28103735.

+
+ +
+
+hymd.force.prepare_bonds(molecules, names, bonds, indices, config, topol=None)[source]
+

Rearrange the bond information for usage in compiled Fortran kernels

+

Restructures the lists resulting from the execution of +prepare_bonds_old into numpy arrays suitable for calls to optimized +Fortran code calculating bonded forces and energiesself.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2_atom_1(B,) numpy.ndarray

Local index of particle 1 for each of B constructed +two-particle bonds.

+
+
bonds_2_atom_2(B,) numpy.ndarray

Local index of particle 2 for each of B constructed +two-particle bonds.

+
+
bonds_2_equilibrium(B,) numpy.ndarray

Equilibrium distance for each of B constructed two-particle +bonds.

+
+
bonds_2_strength(B,) numpy.ndarray

Bond strength for each of B constructed two-particle +bonds.

+
+
bonds_3_atom_1(A,) numpy.ndarray

Local index of particle 1 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_2(A,) numpy.ndarray

Local index of particle 2 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_3(A,) numpy.ndarray

Local index of particle 3 for each of A constructed +three-particle bonds.

+
+
bonds_3_equilibrium(A,) numpy.ndarray

Equilibrium angle for each of A constructed three-particle +bonds.

+
+
bonds_3_strength(A,) numpy.ndarray

Bond strength for each of A constructed three-particle +bonds.

+
+
bonds_4_atom_1(D,) numpy.ndarray

Local index of particle 1 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_2(D,) numpy.ndarray

Local index of particle 2 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_3(D,) numpy.ndarray

Local index of particle 3 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_4(D,) numpy.ndarray

Local index of particle 4 for each of D constructed +four-particle bonds.

+
+
bonds_4_coeff(D,) numpy.ndarray

Cosine series coefficients for each of D constructed +four-particle bonds.

+
+
bonds_4_type(D,) numpy.ndarray

Dihedral type for each of D constructed four-particle +bonds.

+
+
bonds_4_last(D,) numpy.ndarray

Flags indicating if dih_type is 1 for each of D +constructed four-particle bonds.

+
+
+
+
+
+

See also

+
+
prepare_bonds_old

Used internally to reconstruct the bonded interactions types from the connectivity information in the structure/topology input file and the bonded types specified in the configuration file.

+
+
+ +
+ +
+
+hymd.force.prepare_bonds_old(molecules, names, bonds, indices, config)[source]
+

Find bonded interactions from connectivity and bond types information

+
+

Deprecated since version 1.0.0: prepare_bonds_old was replaced by prepare_bonds for +use with compiled Fortran kernels prior to 1.0.0 release.

+
+

Prepares the necessary equilibrium and bond strength information needed by +the intramolecular interaction functions. This is performed locally on each +MPI rank, as the domain decomposition ensures that for all molecules all +consituent particles are always contained on the same MPI rankself.

+

This function traverses the bond connectivity information provided in the +structure/topology input file and indentifies any two-, three-, or +four-particle potential bonds. For each connected chain of two, three, or +four particles, a matching to bond types is attempted. If the corresponding +names match, a bond object is initialized.

+

In order to investigate the connectivity, a graph is created using +networkx functionality.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2list

List of lists containing local particle indices, equilibrium +distance, and bond strength coefficient for each reconstructed +two-particle bond.

+
+
bonds_3

List of lists containing local particle indices, equilibrium angle, +and bond strength coefficient for each reconstructed three-particle +bond.

+
+
bonds_4

List of lists containing local particle indices, dihedral type index, +and dihedral coefficients for each reconstructed four-particle +torsional bond.

+
+
bb_indexlist

List indicating the dihedral type of each four-particle bond in +bonds_4.

+
+
+
+
+
+

See also

+
+
Bond

Two-particle bond type dataclass.

+
+
Angle

Three-particle angular bond type dataclass.

+
+
Dihedral

Four-particle torsional bond type dataclass.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+hymd.force.prepare_index_based_bonds(molecules, topol)[source]
+
+ +
+
+hymd.force.propensity_potential_coeffs(x: float)[source]
+
+ +
+
+

4.6. Pressure

+
+
+hymd.pressure.comp_pressure(phi, phi_q, psi, hamiltonian, velocities, config, phi_fourier, phi_laplacian, phi_transfer, positions, bond_pr, angle_pr, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Computes total internal pressure of the system. +Kinetic pressure is trivially calculated from the kinetic energy. +Already computed bond and angle pressure terms are inserted into the +total internal pressure. +The field pressure equation is implemented.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fourierlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pressure(18,) numpy.ndarray

Pressure contributions from various energy terms. +0: due to kinetic energy +1-5: due to field energy +6-8: due to two-particle bonded terms +9-11: due to three-particle bonded terms (called angle terms) +12-14: due to four-particle bonded terms (called dihedral terms) +(defaults to 0 currently. Yet to be implemented) +15-17: total pressure in x,y,z directions.

+
+
+
+
+
+ +
+
+

4.7. Logger

+
+
+class hymd.logger.Logger[source]
+

Log output handler class

+

Notes

+

This wraps the default python library logging, see +docs.python.org/3/library/logging.html.

+
+
Attributes:
+
+
levelint

Determines the verbosity level of the log, corresponding to +logging.level. Numerical values 50 (logging.CRITICAL), +40 (logging.ERROR), 30 +(logging.WARNING), 20 (logging.INFO), +10 (logging.DEBUG), and 0 +(logging.UNSET) are supported values. Any log event message +less severe than the specified level is ignored. All other event +messages are emitted.

+
+
log_filestr

Path to output log file.

+
+
formatstr

Prepended dump string for each log event. Specifies the log event +level, the module emitting the event, the code line, the enclosing +function name, and the MPI rank writing the message.

+
+
date_formatstr

Prepends the date before all log event messages.

+
+
formatterlogging.Formatter

Formatter handling the prepending of the information in format and +date_format to each log event message. Used by default for all +loggers.

+
+
rank0logging.Logger

Default logger object for the root MPI rank.

+
+
all_rankslogging.Logger

Default logger object for messages being emitted from all MPI ranks +simultaneously.

+
+
+
+
+
+
+classmethod setup(default_level=20, log_file=None, verbose=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Sets up the logger object.

+

If a log_file path is provided, log event messages are output +to it. Otherwise, the logging messages are emitted to stdout.

+
+
Parameters:
+
+
default_levelint, optional

Default verbosity level of the logger. Unless specified, it is +10 (logging.INFO).

+
+
log_filestr, optional

Path to output log file. If None or not priovided, no log file is +used and all logging is done to stdout.

+
+
verbosebool, optional

Increases the logging level to 30 (logging.WARNING) +if True, otherwise leaves the logging level unchanged.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterRoot(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the root MPI rank log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterAll(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the all-MPI-ranks log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+

4.8. Input parser

+

Parses and handles the configuration information provided for the simulation

+
+
+class hymd.input_parser.Config(n_steps: int, time_step: float, mesh_size: Union[List[int], numpy.ndarray, int], sigma: float, kappa: float, dtype: Optional[numpy.dtype] = None, box_size: Optional[Union[List[float], numpy.ndarray]] = None, n_print: Optional[int] = None, tau: Optional[float] = None, start_temperature: Optional[Union[float, bool]] = None, target_temperature: Optional[Union[float, bool]] = None, mass: Optional[float] = None, hamiltonian: Optional[str] = None, domain_decomposition: Optional[Union[int, bool]] = None, integrator: Optional[str] = None, respa_inner: int = 1, file_name: str = '<config file path unknown>', name: Optional[str] = None, tags: List[str] = <factory>, bonds: List[hymd.force.Bond] = <factory>, angle_bonds: List[hymd.force.Angle] = <factory>, dihedrals: List[hymd.force.Dihedral] = <factory>, chi: List[hymd.force.Chi] = <factory>, n_particles: Optional[int] = None, max_molecule_size: Optional[int] = None, n_flush: Optional[int] = None, thermostat_work: float = 0.0, thermostat_coupling_groups: List[List[str]] = <factory>, initial_energy: Optional[float] = None, cancel_com_momentum: Union[int, bool] = False, coulombtype: Optional[str] = None, convergence_type: Optional[str] = None, pol_mixing: Optional[float] = None, dielectric_const: Optional[float] = None, conv_crit: Optional[float] = None, dielectric_type: List[hymd.force.Dielectric_type] = <factory>, self_energy: Optional[float] = None, type_charges: Optional[Union[List[float], numpy.ndarray]] = None, rho0: Optional[float] = None, a: Optional[float] = None, pressure: bool = False, barostat: Optional[str] = None, barostat_type: Optional[str] = None, tau_p: Optional[float] = None, target_pressure: List[hymd.barostat.Target_pressure] = <factory>, n_b: Optional[int] = None, m: List[float] = <factory>)[source]
+

Configuration object

+

Handles and verifies the simulation configuration specified in the +configuration file.

+
+

See also

+
+
hymd.input_parser.Bond

Two-particle bond type dataclass.

+
+
hymd.input_parser.Angle

Three-particle bond type dataclass.

+
+
hymd.input_parser.Dihedral

Four-particle bond type dataclass.

+
+
+ +
+
Attributes:
+
+
gas_constantfloat

Constant value of the gas constant, R (equivalently the Boltzmann +constant) in the units used internally in HyMD.

+
+
coulomb_constantfloat

Constant value of the Coulomb constant which converts electric field +values to forces and electric potential values to energies in the units +used internally in HyMD.

+
+
n_steps: int

Number of time steps in the simulation.

+
+
time_step: float

Outer time step used in the simulation. If the rRESPA intergrator is +used, the inner time step (the time step used in the integration of +intramolecular bending, stretching, and torsional forces) is +time_step / respa_inner.

+
+
box_sizelist[float] or (D,) numpy.ndarray

Simulation box size of simulation in D dimensions in units of +nanometers.

+
+
mesh_sizelist[int] or int or numpy.ndarray

Number of grid points used for the discrete density grid.

+
+
sigmafloat

Filter width representing the effective coarse-graining level of the +particles in the simulation.

+
+
kappafloat

Compressibility parameter used in the relaxed incompressibility term in +the interaction energy functional.

+
+
n_printint, optional

Frequency of trajectory/energy output to the H5MD trajectory/energy +output file (in units of number of time steps).

+
+
taufloat, optional

The time scale of the CSVR thermostat coupling.

+
+
start_temperaturefloat, optional

Generate starting temperature by assigning all particle velocities +randomly according to the Maxwell-Boltzmann distribution at +start_temperature Kelvin prior to starting the simulation.

+
+
target_temperaturefloat, optional

Couple the system to a heat bath at target_temperature Kelvin.

+
+
massfloat, optional

Mass of the particles in the simulation.

+
+
hamiltonianstr, optional

Specifies the interaction energy functional \(W[\tilde\phi]\) +for use with the particle-field interactions. Options: +SquaredPhi, DefaultNohChi, or DefaultWithChi.

+
+
domain_decompositionint, optional

Specifies the interval (in time steps) of domain decomposition +exchange, involving all MPI ranks sending and receiving particles +according to the particles’ positions in the integration box and the +MPI ranks’ assigned domain.

+
+
integratorstr, optional

Specifies the time integrator used in the simulation. Options: +velocity-verlet or respa.

+
+
respa_innerint, optional

The number of inner time steps in the rRESPA integrator. This denotes +the number of intramolecular force calculations (stretching, bending, +torsional) are performed between each impulse applied from the field +forces.

+
+
file_namestr, optional

File path of the parsed configuration file.

+
+
namestr, optional

Name for the simulation.

+
+
tagslist[str], optional

Tags for the simulation.

+
+
bondslist[Bond], optional

Specifies harmonic stretching potentials between particles in the +same molecule.

+
+
angle_bondslist[Angle], optional

Specifies harmonic angular bending potentials between particles in the +same molecule.

+
+
dihedralslist[Dihedral], optional

Specifies four-particle torsional potentials by cosine series.

+
+
chilist[Chi], optional

Specifies \(\chi\)-interaction parameters between particle +species.

+
+
n_particlesint, optional

Specifies the total number of particles in the input. Optional keyword +for validation, ensuring the input HDF5 topology has the correct number +of particles and molecules.

+
+
max_molecule_sizeint, optional

Maximum size of any single molecule in the system. Used to speed up +distribution of particles onto MPI ranks in a parallel fashion.

+
+
n_flushint, optional

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be +written to disk (in units of number of n_print).

+
+
thermostat_workfloat

Work performed by the thermostat on the system.

+
+
thermostat_coupling_groupslist[str], optional

Specifies individual groups coupling independently to the CSVR +thermostat. E.g. in a system containing "A", "B", and +"C" type particles, +thermostat_coupling_groups = [["A", "B"], ["C"],] would +thermalise types "A" and "B" together and couple +"C" type particles to a different thermostat (all individual +thermostats are at the same temperature, i.e. target_temperature +Kelvin).

+
+
initial_energyfloat

Value of the total energy prior to the start of the simulation.

+
+
cancel_com_momentumint, optional

If True, the total linear momentum of the center of mass is +removed before starting the simulation. If an integer is specifed, the +total linear momentum of the center of mass is removed every +remove_com_momentum time steps. If False, the linear +momentum is never removed.

+
+
coulombtypestr, optional

Specifies the type of electrostatic Coulomb interactions in the system. +The strength of the electrostatic forces is modulated by the relative +dielectric constant of the simulation medium, specified with the +dielectric_const keyword. Charges for individual particles are +specified in the structure/topology HDF5 input file, not in the +configuration file. If no charges (or peptide backbone dipoles) are +present, the electrostatic forces will not be calculated even if this +keyword is set to "PIC_Spectral".

+
+
dielectric_constfloat, optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. When +using helical propensity dihedrals, this keyword must be specified—even +if electrostatics are not included with the coulombtype +keyword.

+
+
dielectric_type: list[float], optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. The list assigns +relative dielectric values to each bead type, and an anisotropic +dielectric function is obtained from a weighted average.

+
+
+
+
+
+
+a: float = None
+
+ +
+
+angle_bonds: List[hymd.force.Angle]
+
+ +
+
+barostat: str = None
+
+ +
+
+barostat_type: str = None
+
+ +
+
+bonds: List[hymd.force.Bond]
+
+ +
+
+box_size: Union[List[float], numpy.ndarray] = None
+
+ +
+
+cancel_com_momentum: Union[int, bool] = False
+
+ +
+
+chi: List[hymd.force.Chi]
+
+ +
+
+conv_crit: float = None
+
+ +
+
+convergence_type: str = None
+
+ +
+
+coulomb_constant: ClassVar[float] = 138.935458
+
+ +
+
+coulombtype: str = None
+
+ +
+
+dielectric_const: float = None
+
+ +
+
+dielectric_type: List[hymd.force.Dielectric_type]
+
+ +
+
+dihedrals: List[hymd.force.Dihedral]
+
+ +
+
+domain_decomposition: Union[int, bool] = None
+
+ +
+
+dtype: numpy.dtype = None
+
+ +
+
+file_name: str = '<config file path unknown>'
+
+ +
+
+gas_constant: ClassVar[float] = 0.0083144621
+
+ +
+
+hamiltonian: str = None
+
+ +
+
+initial_energy: float = None
+
+ +
+
+integrator: str = None
+
+ +
+
+kappa: float
+
+ +
+
+m: List[float]
+
+ +
+
+mass: float = None
+
+ +
+
+max_molecule_size: int = None
+
+ +
+
+mesh_size: Union[List[int], numpy.ndarray, int]
+
+ +
+
+n_b: int = None
+
+ +
+
+n_flush: int = None
+
+ +
+
+n_particles: int = None
+
+ +
+
+n_print: int = None
+
+ +
+
+n_steps: int
+
+ +
+
+name: str = None
+
+ +
+
+pol_mixing: float = None
+
+ +
+
+pressure: bool = False
+
+ +
+
+respa_inner: int = 1
+
+ +
+
+rho0: float = None
+
+ +
+
+self_energy: float = None
+
+ +
+
+sigma: float
+
+ +
+
+start_temperature: Union[float, bool] = None
+
+ +
+
+tags: List[str]
+
+ +
+
+target_pressure: List[hymd.barostat.Target_pressure]
+
+ +
+
+target_temperature: Union[float, bool] = None
+
+ +
+
+tau: float = None
+
+ +
+
+tau_p: float = None
+
+ +
+
+thermostat_coupling_groups: List[List[str]]
+
+ +
+
+thermostat_work: float = 0.0
+
+ +
+
+time_step: float
+
+ +
+
+type_charges: Union[List[float], numpy.ndarray] = None
+
+ +
+ +
+
+hymd.input_parser.check_NPT_conditions(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check validity of barostat_type, barostat, +a, rho0, target_pressure, tau_p

+
+ +
+
+hymd.input_parser.check_angles(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_bonds(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_box_size(config, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_cancel_com_momentum(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_charges(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if charges across ranks sum to zero.

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of floats with charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_charges_types_list(config, types, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates a list of charge values of length types. +Charges are sorted according to type ID. Used in field.py. +# TODO: this is messy, we should fix it

+
+ +
+
+hymd.input_parser.check_chi(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_config(config, indices, names, types, charges, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs various checks on the specfied config to ensure consistency

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
indices(N,) numpy.ndarray

Array of integer indices for N particles.

+
+
names(N,) numpy.ndarray

Array of string names for N particles.

+
+
types(N,) numpy.ndarray

Array of integer type indices for N particles.

+
+
charges(N,) numpy.ndarray

Array of floats charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
Returns:
+
+
configConfig

Validated configuration object.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_dielectric(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Error handling for electrostatics. +Unit testing of toml/tomli input.

+
+ +
+
+hymd.input_parser.check_dihedrals(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_domain_decomposition(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_hamiltonian(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_integrator(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_m(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_mass(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_max_molecule_size(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_b(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_flush(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_particles(config, indices, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_print(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_name(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_start_and_target_temperature(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Validate provided starting and target thermostat temperatures

+

Assesses the provided temperature target and ensures it is a non-negative +floating point number or False. Ensures the starting temperature is +a non-negative floating point number or False.

+

If the value for either is None, the returned configuration object +has the values defaulted to False in each case.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
validated_configConfig

Configuration object with validated target_temperature and +start_temperature.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_tau(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_thermostat_coupling_groups(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.parse_config_toml(toml_content, file_path=None, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.read_config_toml(file_path)[source]
+
+ +
+
+hymd.input_parser.sort_dielectric_by_type_id(config, charges, types)[source]
+

Creates a list of length N CG-particles, sorted after the charges from +the input HDF5 file. Used in file_io.py

+
+ +
+
+

4.9. Field

+

Forces and energies from the discretized particle-field grid interactions

+
+
+hymd.field.compute_field_and_kinetic_energy(phi, phi_q, psi, velocity, hamiltonian, positions, types, v_ext, config, layouts, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the particle-field and kinetic energy contributions

+

Calculates the kinetic energy through

+
+\[E_k = \sum_j \frac{1}{2}m_j\mathbf{v}_j\cdot\mathbf{v}_j,\]
+

and the particle-field energy by

+
+\[E_\text{field} = \int\mathrm{d}\mathbf{r}\, + w[\tilde\phi],\]
+

where \(w\) is the interaction energy functional density.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
velocity(N,D) numpy.ndarray

Array of velocities for N particles in D dimensions. +Local for each MPI rank.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Local for each MPI rank–the full computational grid is +represented by the collective fields of all MPI ranks.

+
+
configConfig

Configuration object.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field

Computes the up-to-date external potential for use in calculating the particle-field energy.

+
+
+ +
+ +
+
+hymd.field.compute_field_energy_q_GPE(config, phi_eps, field_q_energy, dot_elec, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the electrostatic energy after electrosatic forces is +calculated.

+

From the definition of the elecrostatic potential \(\Psi\), the energy +is

+
+
+
W = frac{1}{2}intmathrm{d}mathbf{r},

epsilon(mathbf{r})} left(mathbf{E}cdot mathbf{E}right),

+
+
+
+

where \(\epsilon(\mathbf{r})}\) is the anisotropic, spatially dependent, +relative dielectric of the simulation medium.

+
+
Parameters:
+
+
confighymd.input_parser.Config

Configuration object.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
field_q_energyfloat

Total elecrostatic energy.

+
+
dot_elecpmesh.pm.RealField

Pmesh RealField object for storing \(|\mathbf{E(r)}|^{2}\) +on the computational grid. Local for each MPI rank – the full computational +grid is represented by the collective fields of all MPI ranks.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field_force_q_GPE

Compute the electrosatic force from an anisotropic dielectric general Poisson equation.

+
+
+ +
+ +
+
+hymd.field.compute_field_force(layouts, r, force_mesh, force, types, n_types)[source]
+

Interpolate particle-field forces from the grid onto particle positions

+

Backmaps the forces calculated on the grid to particle positions using the +window function \(P\) (by default cloud-in-cell [CIC]). In the +following, let \(\mathbf{F}_j\) denote the force acting on the +particle with index \(j\) and position \(\mathbf{r}_j\). The +interpolated force is

+
+\[\mathbf{F}_j = -\sum_k\nabla V_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(V_{j_k}\) is the discretized external potential at grid vertex +\(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid vertex +with index \(j_k\), and \(h^3\) is the volume of each grid voxel. +The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
r(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
force(N,D) numpy.ndarray

Array of forces for N particles in D dimensions. Local +for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
n_typesint

Number of different unique types present in the simulation system. +n_types is global, i.e. the same for all MPI ranks even if some +ranks contain zero particles of certain types.

+
+
+
+
+
+ +
+
+hymd.field.compute_self_energy_q(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the self energy for the interaction due to the Ewald scheme +used to compute the electrostatics. The energy is stored in config.

+

The self interaction energy is given by:

+
+\[U_{self} = \sqrt{\frac{1}{2\pi\sigma^2}} \sum_{i=1}^{N} q_i^2\]
+

where \(q_i\) are the charges and \(\sigma\) is the half-width +of the Gaussian filter.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
Returns:
+
+
field_q_self_energyfloat

Electrostatic self energy.

+
+
+
+
+
+ +
+
+hymd.field.domain_decomposition(positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs domain decomposition

+

Rearranges the MPI rank memory layout into one that better mimics the PFFT +pencil grid 2D decomposition. As molecules are always required to be fully +contained on a single MPI rank, a perfect decomposition is not always +possible. The best decomposition which leaves the center of mass of all +molecules in their respective correct domains is used, with possible +overlap into neighbouring domains if the spatial extent of any molecule +crosses domain boundaries.

+
+
Parameters:
+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
*args

Variable length argument list containing arrays to include in the +domain decomposition.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
bonds(N,M) numpy.ndarray, optional

Array of M bonds originating from each of N particles.

+
+
verboseint, optional

Specify the logging event verbosity of this function.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
Domain decomposedcode:positions and any array specified in
+
:code:`*args`, in addition tocode:bonds and molecules if these
+
arrays were provided as input.
+
+
+
+
+ +
+
+hymd.field.initialize_pm(pmesh, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates the necessary pmesh objects for pfft operations.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pmobject ‘pmesh.pm.ParticleMesh’
+
field_listlist[pmesh.pm.RealField], (multiple)

Essential list of pmesh objects required for MD

+
+
list_coulomblist[pmesh.pm.RealField], (multiple)

Additional list of pmesh objects required for electrostatics.

+
+
+
+
+
+ +
+
+hymd.field.update_field(phi, phi_laplacian, phi_transfer, layouts, force_mesh, hamiltonian, pm, positions, types, config, v_ext, phi_fourier, v_ext_fourier, m, compute_potential=False)[source]
+

Calculate the particle-field potential and force density

+

If compute_potential is True, the energy may subsequently +be computed by calling compute_field_and_kinetic_energy.

+

Computes the particle-field external potential \(V_\text{ext}\) from +particle number densities through the smoothed density field, +\(\phi(\mathbf{r})\). With \(P\) being the cloud-in-cell (CIC) +window function, the density and filtered densities are computed as

+
+\[\phi(\mathbf{r}) = \sum_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\phi(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +external potential is computed in reciprocal space as

+
+\[V_\text{ext} = \mathrm{FFT}^{-1}\left[ + \mathrm{FFT} + \left( + \frac{\partial w}{\partial \tilde\phi} + \right) + \mathrm{FFT}(H) +\right],\]
+

where \(w\) is the interaction energy functional. Differentiating +\(V_\text{ext}\) is done by simply applying \(i\mathbf{k}\) in +Fourier space, and the resulting forces are back-transformed to direct +space and interpolated to particle positions by

+
+\[\mathbf{F}_j = -\sum_{j_k} \nabla V_{j_k} + P(\mathbf{r}_{j_k} - \mathbf{r}_j)h^3,\]
+

where \(j_k\) are the neighbouring vertices of particle \(j\) at +position \(\mathbf{r}_j\), and \(h^3\) is the volume of each grid +voxel.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Pre-allocated, but empty; any values +in this field are discarded. Changed in-place. Local for each MPI +rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
configConfig

Configuration object.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Pre-allocated, but empty; any values in this field are +discarded Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
phi_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computational grid is represented by the collective fields of all +MPI ranks.

+
+
v_ext_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplesField objects containing discretized +particle-field external potential values in reciprocal space on the +computational grid; D+1 fields in D dimensions for each +particle type. D copies are made after calculation for later +use in force calculation, because the force transfer function +application differentiates the field in-place, ruining the contents +for differentiation in the remaining D-1 spatial directions. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
m: list[float], (M,)

pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. +Defaults to 1.0 for all particle types.

+
+
compute_potentialbool, optional

If True, a D+1-th copy of the Fourier transformed +external potential field is made to be used later in particle-field +energy calculation. If False, only D copies are made.

+
+
+
+
+
+

See also

+
+
compute_field_and_kinetic_energy

Compute the particle-field energy after the external potential is calculated.

+
+
+ +
+ +
+
+hymd.field.update_field_force_q(charges, phi_q, phi_q_fourier, psi, psi_fourier, elec_field_fourier, elec_field, elec_forces, layout_q, hamiltonian, pm, positions, config)[source]
+

Calculate the electrostatic particle-field forces on the grid

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential is computed in reciprocal space as

+
+\[\Phi = \mathrm{FFT}^{-1}\left[ + \frac{4\pi k_e}{\varepsilon \vert\mathbf{k}\vert^2} + \mathrm{FFT}(\rho)\mathrm{FFT}(H) +\right],\]
+

with the electric field

+
+\[\mathbf{E} = \mathrm{FFT}^{-1}\left[ + -i\mathbf{k}\,\mathrm{FFT}(\Psi) +\right].\]
+

In the following, let \(\mathbf{F}_j\) denote the electrostatic force +acting on the particle with index \(j\) and position +\(\mathbf{r}_j\). The interpolated electrostatic force is

+
+\[\mathbf{F}_j = \sum_k q_j\mathbf{E}_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(\mathbf{E}_{j_k}\) is the discretized electric field at grid +vertex \(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid +vertex with index \(j_k\), and \(h^3\) is the volume of each grid +voxel. The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty; any values in this field +are discarded. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
elec_field_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +electric field values in reciprocal space on the computational grid. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
+
+
+
+ +
+
+hymd.field.update_field_force_q_GPE(conv_fun, phi, types, charges, phi_q, phi_q_fourier, phi_eps, phi_eps_fourier, phi_eta, phi_eta_fourier, phi_pol_prev, phi_pol, elec_field, elec_forces, elec_field_contrib, psi, Vbar_elec, Vbar_elec_fourier, force_mesh_elec, force_mesh_elec_fourier, hamiltonian, layout_q, layouts, pm, positions, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Calculate the electrostatic particle-field forces on the grid, arising from +a general Poisson equation, i.e. anisotropic permittivity/dielectric. +The function is called when tomli input config.coulombtype = “PIC_Spectral_GPE.”

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential for a variable dielectric does not have an +analytical expression, and is computed in reciprocal through an iterative +method.

+

The GPE states that

+
+\[\nabla \cdot \left(\epsilon(\mathbf{r}) +\nabla{\mathbf{\psi(r)}}\right) = -\rho({\mathbf{r}}).\]
+

where \(\epsilon(\mathbf{r})\) is the relative dielectric function.

+
+
Parameters:
+
+
conv_funConvergence function.

Returns a scalar. Depends on MPI allreduce for similar convergence +across MPI ranks.

+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_eps_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_etapmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +gradients of the relative dielectric values on the computational grid. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank–the +full computational grid is represented by the collective fields of all MPI ranks.

+
+
phi_eta_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated discretized +Fourier transformed gradient relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_pol_prevpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charge values on the computational grid. Parameter in +the iterative method.Pre-allocated,but empty. Changedin-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_polpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charges on the computational grid. Parameter in the iterative +method, updating the next quess in solving for the electrostatic potential. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank– +the full computational grid is represented by the collective fields of +all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all +MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
elec_field_contribpmesh.pm.RealField

Pmesh RealField object for storing +\(|\mathbf{E(r)}|^2/\phi_{0}\) on the computational grid. +Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
psipmesh.pm.RealField

Pmesh RealField object for storing electrostatic potential +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
Vbar_elecmesh.pm.RealField

Pmesh RealField object for storing functional derivatives of +:math:`|w({ phi })_{elec}`on the computational grid. +Pre-allocated, but empty. Changed in-place. Local for each MPI rank– +the full computational grid is represented by the collective fields of

+
+

all MPI ranks.

+
+
+
Vbar_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated functional +derivatives of \(\|w(\{ \phi \})_{elec}\) in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
force_mesh_elecpmesh.pm.RealField

Pmesh RealField object for storing electrostatic force values +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
force_mesh_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated electrostatic +force values in reciprocal space on the computational grid. Local for +each MPI rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
layouts: list[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
comm: mpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
compute_field_energy_q_GPE

Compute the electrostatic energy after electrosatic force is calculated for a variable (anisotropic) dielectric general Poisson equation.

+
+
+ +
+ +
+
+

4.10. File input/output

+

Handle file input/output in parllel HDF5 fashion

+
+
+class hymd.file_io.OutDataset(dest_directory, config, double_out=False, disable_mpio=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

HDF5 dataset handler for file output

+
+
+close_file(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Closes the HDF5 output file

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+
+flush()[source]
+

Flushes output buffers, forcing file writes

+
+ +
+
+is_open(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if HDF5 output file is open

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+ +
+
+hymd.file_io.distribute_input(in_file, rank, size, n_particles, max_molecule_size=201, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Assign global arrays onto MPI ranks, attempting load balancing

+

Distributes approximately equal numbers of particles (workload) onto each +independent MPI rank, while respecting the requirement that any molecule +must be fully contained on a single MPI rank only (no splitting molecules +across multiple CPUs).

+
+
Parameters:
+
+
in_fileh5py.File

HDF5 input file object.

+
+
rankint

Local rank number for this MPI rank.

+
+
sizeint

Global size of the MPI communicator (number of total CPUs).

+
+
n_particlesint

Total number of particles.

+
+
max_molecule_sizeint, optional

Maximum size of any molecule present in the system. Used to initially +guess where the MPI rank boundaries (start/end indices) in the global +arrays should be placed. If molecules of size +>max_molecule_size exist in the simulation system, HyMD +might work as expected. Or it might fail spectacularly.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
rank_range

Starting and ending indices in the global arrays for each MPI rank.

+
+
+
+
+
+ +
+
+hymd.file_io.setup_time_dependent_element(name, parent_group, n_frames, shape, dtype, units=None)[source]
+

Helper function for setting up time-dependent HDF5 group datasets

+

All output groups must adhere to the H5MD standard, meaning a structure of

+
+
┗━ group particle group (e.g. all) or observables group
+
+
┗━ group time-dependent data
+
+
┣━ dataset step shape=(n_frames,)
+
┣━ dataset time shape=(n_frames,)
+
┗━ dataset value shape=(n_frames, *)
+
+
+
+

is necessary.

+

References

+
+
H5MD specification :

https://www.nongnu.org/h5md/h5md.html

+
+
+
+ +
+
+hymd.file_io.store_data(h5md, step, frame, indices, positions, velocities, forces, box_size, temperature, pressure, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, field_energy, field_q_energy, plumed_bias, time_step, config, velocity_out=False, force_out=False, charge_out=False, plumed_out=False, dump_per_particle=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Writes time-step data to HDF5 output file

+

Handles all quantities which change during simulation, as opposed to +static quanitities (see store_static).

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
stepint

Step number.

+
+
frameint

Output frame number (step // n_print).

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
positions(N,) numpy.ndarray

Array of positions for N particles in D dimensions.

+
+
velocities(N,) numpy.ndarray

Array of velocities for N particles in D dimensions.

+
+
forces(N,) numpy.ndarray

Array of forces for N particles in D dimensions.

+
+
box_size(D,) numpy.ndarray

Array containing the simulation box size.

+
+
temperaturefloat

Calculated instantaneous temperature.

+
+
kinetic_energyfloat

Calculated instantaneous kinetic energy.

+
+
bond2_energyfloat

Calculated instantaneous harmonic two-particle bond energy.

+
+
bond3_energyfloat

Calculated instantaneous harmonic angular three-particle bond energy.

+
+
bond4_energyfloat

Calculated instantaneous dihedral four-particle torsion energy.

+
+
field_energyfloat

Calculated instantaneous particle-field energy.

+
+
field_q_energyfloat

Calculated instantaneous electrostatic energy.

+
+
plumed_biasfloat

PLUMED instantaneous bias energy.

+
+
time_stepfloat

Value of the time step.

+
+
configConfig

Configuration object.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charge_outbool, optional

If True, electrostatic energies are written to the output +HDF5 file.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to the output HDF5 file.

+
+
dump_per_particlebool, optional

If True, all quantities are written per particle.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
store_static

Outputs all static time-independent quantities to the HDF5 output file

+
+
+ +
+ +
+
+hymd.file_io.store_static(h5md, rank_range, names, types, indices, config, bonds_2_atom1, bonds_2_atom2, molecules=None, velocity_out=False, force_out=False, charges=False, dielectrics=False, plumed_out=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Outputs all static time-independent quantities to the HDF5 output file

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
rank_rangelist[int]

Start and end indices for global arrays for each MPI rank.

+
+
names(N,) numpy.ndarray

Array of names for N particles.

+
+
types(N,) numpy.ndarray

Array of type indices for N particles.

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
configConfig

Configuration object.

+
+
bonds_2_atom1(B,) numpy.ndarray

Array of indices of the first particle for B total +two-particle bonds.

+
+
bonds_2_atom2(B,) numpy.ndarray

Array of indices of the second particle for B total +two-particle bonds.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles.

+
+
dielectrics(N,) numpy.ndarray

Array of particle relative dielectric values for N particles.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to output HDF5 file.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
prepare_bonds

Constructs two-, three-, and four-particle bonds from toplogy input file and bond configuration information.

+
+
distribute_input

Distributes input arrays onto MPI ranks, attempting load balancing.

+
+
+ +
+ +
+
+

4.11. PLUMED

+

Class to wrap PLUMED for use within HyMD.

+
+
+class hymd.plumed.PlumedBias(config, plumeddat, logfile, intracomm=<mpi4py.MPI.Intracomm object>, intercomm=None, verbose=1)[source]
+

PLUMED handler class

+

Notes

+

This wraps the Plumed() class, see +https://github.com/plumed/plumed2/tree/master/python.

+

The PlumedBias() object is created with the arguments from +__init__ and at everystep the methods prepare() and +calc() should be called.

+
+
Attributes:
+
+
plumed_objplumed.Plumed

Plumed object used to pass and request information from PLUMED.

+
+
plumed_forces(N, D) numpy.ndarray

Array of forces of N particles in D dimensions. +After calc(), this array contains only the forces due +to the PLUMED bias.

+
+
positions(N, D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank. +Needed because we need C-contiguous array for passing to PLUMED.

+
+
plumed_bias(1,) numpy.ndarray

Used as a pointer to an double to store the bias energy.

+
+
plumed_version(1,) numpy.ndarray

Used as a pointer to an int to store PLUMED API version.

+
+
intracommmpi4py.Comm

MPI communicator to use for rank communication within a replica.

+
+
intercommmpi4py.Comm

MPI communicator to use for rank communication between replicas.

+
+
readybool

Stores wether the calc() method can be called or not.

+
+
+
+
+
+
+property api_version
+

Returns the API version got from the PLUMED kernel.

+
+ +
+
+calc(forces, poteng)[source]
+

Passes the energy (which can be set to any value in case +prepare() returns PLUMED doesn’t need it) to get +the forces and energy from the bias.

+
+ +
+
+finalize()[source]
+

Finalize object

+
+ +
+
+prepare(step, forces, positions, indices, config, charges)[source]
+

Set the pointers to positions and forces, and returns +wether the potential energy is being requested by PLUMED or not.

+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/doc_pages/benchmarks.html b/main/doc_pages/benchmarks.html new file mode 100644 index 00000000..b94b05fb --- /dev/null +++ b/main/doc_pages/benchmarks.html @@ -0,0 +1,322 @@ + + + + + + + 3. Benchmarks — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Benchmarks

+

Homopolymer melt test systems of \(30^2\), \(40^2\), and \(50^2\) +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively.

+
+

3.1. Bonded forces

+

Legend label denotes the number of particles in the system.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-1.png +
+
+
+

3.2. Particle–field forces

+

Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-2.png +
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/doc_pages/command_line.html b/main/doc_pages/command_line.html new file mode 100644 index 00000000..a4454568 --- /dev/null +++ b/main/doc_pages/command_line.html @@ -0,0 +1,385 @@ + + + + + + + 5. Command line arguments — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. Command line arguments

+

Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle–field interactions.

+
+

5.1. Required arguments

+
+
configuration file:
+

type positional

+

Specifies the .toml format configuration file containing simulation details. See Configuration file for details.

+
+
structure and topology file:
+

type positional

+

Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See Topology and structure file for details.

+
+
+
+
+

5.2. Optional arguments

+
+
-v  --verbose

type optional

+

Number of following arguments: 0 or 1

+

Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying -v or --verbose with no additional specification. This increases verbosity level by 1. Alternatively, it maye be specified by --verbose V with V being 0, 1, or 2.

+
+
--profile

type optional

+

Number of following arguments: 0

+

Enables code profiling using cProfile. This will output one profiling file per MPI rank invoked in the simulation.

+
+
--double-precision

type optional

+

Number of following arguments: 0

+

Specify usage of double precision internally in HyMD (including in the FFTs).

+
+
--double-output

type optional

+

Number of following arguments: 0

+

Specify usage of double precision in the output trajectory from HyMD.

+
+
--velocity-output

type optional

+

Number of following arguments: 0

+

Specify that velocities should be output to the HyMD trajectory.

+
+
--force-output

type optional

+

Number of following arguments: 0

+

Specify that forces should be output to the HyMD trajectory.

+
+
--disable-mpio

type optional

+

Number of following arguments: 0

+

Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult.

+
+
--logfile

type optional

+

Number of following arguments: 1

+

Specifies the path of a plain text log file in which stdout is mirrored during simulation runs.

+
+
--seed

type optional

+

Number of following arguments: 1

+

Specifies the random seed used in the numpy random library to generate velocities, thermostatting, etc.

+
+
--disable-bonds

type optional

+

Number of following arguments: 0

+

Disable any two-particle bonds present in the system.

+
+
--disable-angle-bonds

type optional

+

Number of following arguments: 0

+

Disable any three-particle bonds present in the system.

+
+
--disable-dihedrals

type optional

+

Number of following arguments: 0

+

Disable any four-particle bonds present in the system.

+
+
--disable-dipole

type optional

+

Number of following arguments: 0

+

Disable any topological reconstruction of peptide backbone dipoles present in the system.

+
+
--disable-field

type optional

+

Number of following arguments: 0

+

Disable any particle–field interactions present in the system.

+
+
--plumed

type optional

+

Input file for PLUMED when using the PLUMED interface. See PLUMED interface for details.

+
+
:code:`–plumed-outfile

type optional

+

Name of PLUMED output file when running a simulation using PLUMED.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/doc_pages/config_file.html b/main/doc_pages/config_file.html new file mode 100644 index 00000000..cd5750a8 --- /dev/null +++ b/main/doc_pages/config_file.html @@ -0,0 +1,512 @@ + + + + + + + 3. Configuration file — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Configuration file

+

The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order.

+

The configuration file is a toml format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs.

+
+

3.1. Configuration file keywords

+

The following constitutes every possible keyword specification in HyMD +configuration files:

+
+

3.1.1. Metadata keywords

+

Configuration keywords specifying metadata for the H5MD output trajectory.

+
+
name:
+

string [optional, default: None]

+

Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file.

+
+
tags:
+

array [string] [optional, default: None]

+

Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file.

+
+
+
+
+

3.1.2. Particle keywords

+

Configuration keywords specifying properties of particles and molecules in the +system.

+
+
n_particles:
+

integer [optional, default: None]

+

Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules.

+
+
mass:
+

float [optional, default: 72.0] {units: \(\text{u}=\text{g}\,\text{mol}^{-1}\)}

+

Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal.

+
+
max_molecule_size:
+

integer [optional, default: 201]

+

Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code will crash if there are molecules larger than max_molecule_size in the topology/structure input file.

+
+
+
+
+

3.1.3. Simulation keywords

+

Configuration keywords specifying simulation parameters.

+
+
n_steps:
+

integer [required]

+

Total number of integration steps to perform for this simulation.

+
+
n_print:
+

integer or boolean [optional, default: False]

+

Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of number of time steps).

+
+
n_flush:
+

integer [optional, default: None]

+

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of number of n_print, i.e. n_print = 13, n_flush = 3 would result in the trajectory/energy being written to disk every 13 x 3 = 39 simulation steps)

+
+
time_step:
+

float [required] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time step per integration step. If the rRESPA multiple time step integrator is used (integrator = "respa"), this specifies the inner time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is respa_inner times the time_step , and the total simulation time is n_steps times time_step times respa_inner .

+
+
box_size:
+

array [float] [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable.

+
+
integrator:
+

string [required] (options: velocity-verlet or respa)

+

Specifies the time integrator used in the simulation. If respa, the reversible reference system propagator algorithm (rRESPA) [Tuckerman et al., 1992] integrator is used, with respa_inner number of inner (intramolecular force) time steps. If velocity-verlet, a normal Velocity Verlet integrator is used. If respa and respa_inner = 1, the rRESPA integrator is equivalent to the Velocity Verlet.

+
+
respa_inner:
+

integer [optional, default: 1]

+

The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces.

+
+
domain_decomposition:
+

integer or boolean [optional, default: False]

+

Specifies the interval (in time steps) of domain decomposition exchange, involving all MPI ranks sending and receiving particles according to the particles’ positions in the integration box and the MPI ranks’ assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If True, the decomposition is performed once (before starting the simulation). If False, no decomposition is performed.

+
+
cancel_com_momentum:
+

integer or boolean [optional, default: False]

+

If True, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every remove_com_momentum time steps. If False, the linear momentum is never removed.

+
+
start_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at start_temperature Kelvin prior to starting the simulation. If False, the velocities are not changed before starting the simulation.

+
+
target_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Couple the system to a heat bath at target_temperature Kelvin by applying a Canonical sampling through velocity rescaling [Bussi et al., 2007] thermostat with coupling strength tau. If False, no temperature control is applied.

+
+
tau:
+

float [optional, default: 0.7] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the CSVR thermostat coupling. In the limit of tau , the Hamiltonian dynamics are preserved and no temperature coupling takes place.

+
+
thermostat_coupling_groups:
+

array [array [string]] [optional, default: []]

+

Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing "A", "B", and "C" type particles, thermostat_coupling_groups = [["A", "B"], ["C"],] would thermalise types "A" and "B" together and couple "C" type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. target_temperature Kelvin).

+
+
hamiltonian:
+

string [optional, default: "DefaultNohChi"] (options: SquaredPhi, DefaultNohChi, or DefaultWithChi)

+

Specifies the interaction energy functional \(W[\tilde\phi]\) for use with the particle-field interactions. See Interaction energy functionals for details.

+
+
+
+
+

3.1.4. Field keywords

+

Configuration keywords specifying field parameters.

+
+
mesh_size:
+

array [integer] or integer [required]

+

Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is box_size / mesh_size.

+
+
kappa:
+

float [required] {units: \(\text{kJ}^{-1}\text{mol}\)}

+

Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional \(W[\tilde\phi]\). See Interaction energy functionals for more details.

+
+
sigma:
+

float [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See Filtering for more details.

+
+
chi:
+

array [array [string, float]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\)}

+

Array of \(\tilde\chi_\text{AB}\)-parameters indicating the strength of the repulsive or attractive interaction between particles of type "A" and the number density due to particles of type "B", and vice versa. Example: chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ] would specify a repulsive "A""B" type interaction, and a weakly attractive "C""D" interaction. Self-interaction \(\tilde\chi\)-terms are always zero. See Interaction energy functionals for more details.

+
+
+
+
+

3.1.5. Bond keywords

+

Configuration keywords specifying bonds and bonds parameters.

+
+
bonds:
+

array [array [2 string, 2 float]] [optional, default: []] {units: \(\text{nm}=10^{-9}~\text{m}\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+

Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ] indicates a "A""A" bond of equilibrium length 0.47 \(\text{nm}\) with a bond strength of 980.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding bond between "A" and "B" type particles with equilibrium length 0.31 \(\text{nm}\) and a strength of 1250.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify stretching bonds.

+
+
angle_bonds:
+

array [array [3 string, 2 float]] [optional, default: []] {units: \({}^\circ\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+
+

Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ] indicates a "A""A""A" angular bond that tries to keep the bond linear at 180 degrees with a bending strength of 55.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding angle bond between "A""B""B" prefering the angle at 120 degrees and a strength of 25.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify angular bonds.

+
+
+
dihedrals:
+

array [array [4 string, integer, COSINE SERIES ]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)}

+

Specifies four-particle torsional potentials by cosine series. See Intramolecular bonds for details about how to specify dihedrals.

+
+
+
+
+

3.1.6. Electrostatic keywords

+

Configuration keywords specifying electrostatics and electrostatic parameters.

+
+
coulombtype:
+

string [optional, default: None] (options: PIC_Spectral)

+

Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the dielectric_const keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, not in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to PIC_Spectral.

+
+
dielectric_const:
+

float [optional, default: None]

+

Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified—even if electrostatics are not included with the coulombtype keyword.

+
+
+
+
+

3.1.7. Pressure keywords

+

Configuration keywords specifying pressure and barostat parameters.

+
+

3.1.7.1. Simulation keywords

+
+
pressure:
+

boolean [optional, default: False]

+

Specifies whether or not to calculate total internal pressure vector.

+
+
barostat:
+

string [optional, default: None](options: isotropic or semiisotropic)

+

Specifies whether to apply pressure constraints equally in all 3 Cartesian directions (isotropic) or equally in xy and different in z (semiisotropic).

+
+
barostat_type:
+

string [optional, default: berendsen](options: berendsen or scr)

+

Specifies the type of barostat to use. berendsen is more suitable for equilibration and scr for equilibrium data collection.

+
+
n_b:
+

integer [optional, default: 1]

+

Frequency of barostat call in number of outer rRESPA steps.

+
+
tau_p:
+

float [optional, default: 10 tau if tau < 0.1 else 1.0] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the barostat coupling.

+
+
target_pressure:
+

array [float] [optional, default: :code:1] {units: bar}

+

Couples the system to an external pressure set to target_pressure.

+
+
+
+
+

3.1.7.2. Field keywords

+
+
rho0:
+

float [optional, default: :code:average density] {units: \(\text{nm}^{-3}\)}

+

Intrinsic parameter corresponding to the specific volume of a coarse-grained particle. Typically: 8.66

+
+
a:
+

float [required] {units: \(\text{nm}^{-3}\)}

+

Calibrated parameter to obtain the correct average density at the target temperature and pressure. Typically: 9.21

+
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/doc_pages/constants_and_units.html b/main/doc_pages/constants_and_units.html new file mode 100644 index 00000000..122146b5 --- /dev/null +++ b/main/doc_pages/constants_and_units.html @@ -0,0 +1,413 @@ + + + + + + + 6. Constants and Units — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

6. Constants and Units

+

HyMD uses the following units and constants internally and in all input and +output:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Units

Quantity

Symbol

Unit

length

\(r\)

\(\text{nm}=10^{-9}~\text{m}\)

time

\(t\)

\(\text{ps}=10^{-12}~\text{s}\)

charge

\(q\)

\(e=1.602176634 \cdot 10^{-19}~\text{C}\)

mass

\(m\)

\(\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}\)

temperature

\(\text{T}\)

\(\text{K}\)

energy

\(E\)

\(\text{kJ}\,\text{mol}^{-1}\)

velocity

\(v\)

\(\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}\)

momentum

\(P\)

\(\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}\)

force

\(\mathbf{F}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}\)

pressure

\(p\)

\(\text{bar}=100~\text{kPa}\)

electric potential

\(\Psi\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}\)

electric field

\(\mathbf{E}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}\)

compressibility

\(\kappa\)

\(\text{mol}\,\text{kJ}^{-1}\)

field-interaction

\(\tilde\chi\)

\(\text{kJ}\,\text{mol}^{-1}\)

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants

Constant

Symbol

Value

gas constant

\(R\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Boltzmann’s constant

\(k_\text{B}\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Avogadro’s constant

\(N_\text{A}\)

\(6.02214076 \cdot 10^23~\text{mol}^{-1}\)

Vacuum permittivity

\(\varepsilon_0\)

\(8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2\)

Coulomb constant

\(k_\text{e}\)

\(138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}\)

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/doc_pages/electrostatics.html b/main/doc_pages/electrostatics.html new file mode 100644 index 00000000..367b91ca --- /dev/null +++ b/main/doc_pages/electrostatics.html @@ -0,0 +1,334 @@ + + + + + + + 3. Electrostatic interactions — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Electrostatic interactions

+

In the filtered Hamiltonian hPF formalism [] the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle–mesh Ewald.

+

The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered

+
+\[\tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i),\]
+

with \(q_i\) being the charge of particle \(i\) and \(H\) is the +filtering function (see Filtering). The value of the charge grid at +vertex \((i,j,k)\) is found by

+
+\[\tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)]\]
+

and the electrostatic potential \(\Psi_{ijk}\)

+
+\[\Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right],\]
+

where \(k_\text{e}\) is the Coulomb constant \(1/4\pi\varepsilon_0\). +The electric field is obtained by differentiation of the electrostatic +potential in Fourier space,

+
+\[\mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)]\]
+

from which the forces are interpolated back to the particle positions.

+
+

3.1. Specifying electrostatics

+

In HyMD, electrostatics are specified by the coulombtype and +dielectric_const keywords in the configuration file (see +Configuration file) and the /charge dataset in the HDF5 format +structure/topology input file (see Topology and structure file). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/doc_pages/examples.html b/main/doc_pages/examples.html new file mode 100644 index 00000000..2cb85d60 --- /dev/null +++ b/main/doc_pages/examples.html @@ -0,0 +1,782 @@ + + + + + + + 1. Examples — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Examples

+

The following examples are ordered in more or less order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the HyMD-tutorial github repository.

+
+

1.1. Ideal gas

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true +

The simplest possible system is one with no interactions at all—intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like:

+
+
ideal_gas.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = false         # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+
+
+

A simple input structure/topology file ideal_gas.HDF5 is available in +the HyMD-tutorial/ideal_gas github repository (along with the code to +generate it). Run the (very) short simulation by

+
python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field   \
+                                              --velocity-output \
+                                              --force-output
+
+
+

with the --disable-field argument to completely turn off all +particle–field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook ideal_gas.ipynb for details.

+
+
+

1.2. Ideal chains

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true +

The simplest available interaction is the harmonic two-particle bond (see +Intramolecular bonds),

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2.\]
+

Extending the configuration file from the ideal gas case, we need to add a +bonds specification. Note that the [bonds] meta specifier is not +necessary, but may be used to help organise the input file.

+
+
ideal_chain.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+
+
+

A simple input structure/topology file ideal_chain.HDF5 with a few +coiled up ideal chain polymers is available in the +HyMD-tutorial/ideal_chain github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field
+
+
+

we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +ideal_chain.ipynb.

+
+
+

1.3. Stiff rods

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true +

Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the i--j--k angle \(\theta\) (see +Intramolecular bonds),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2.\]
+

Extending the configuration file from the ideal chain case, we need to add a +angle_bonds specification. Note that the [bonds] meta specifier +is not necessary, but may be used to help organise the input file.

+
+
rods.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+angle_bonds = [
+  ["A", "A", "A", 180.0, 100.0],   # (i, j, k, equilibrium angle, strength)
+]
+
+
+
+

A simple input structure/topology file rods.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook rods.ipynb.

+
+
+

1.4. Helixes

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true +

Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle \(\phi\) between the +i--j--k plane and the j--k--l plane (see Intramolecular bonds),

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n).\]
+

The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a dihedrals keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the dielectric_const +keyword even though we are not including electrostatic forces in the current +simulation. Note that the [bonds] meta specifier is not necessary, but +may be used to help organise the input file.

+
+
helixes.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+dielectric_const = 15.0
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.31, 10000.0],       # (i name, j name, equilibrium length, strength)
+]
+
+dihedrals = [
+  [
+    ["A", "A", "A", "A"],
+    [
+      [-1],
+      [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+      [0.08, 0.46, 1.65, -0.96, 0.38],
+    ],
+    [1.0]
+  ],
+]
+
+
+
+

A simple input structure/topology file helixes.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook helixes.ipynb.

+
+
+

1.5. Phase separation

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true +

The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types A and B. Using the Hamiltonian

+
+\[\mathcal{H}=H_0+W\]
+

with \(\tilde\chi\)–dependent interactions defined by (specified in the +configuration file by hamiltonian = DefaultWithChi):

+
+\[W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2.\]
+
+
phase_separation.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+
+[field]
+mesh_size = [20, 20, 20]           # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+kappa = 0.05                       # compressibility in mol/kJ
+chi = [
+  ['A', 'B', 5.0],                 # (name i, name j, strength)
+]
+
+
+
+

A simple input structure/topology file phase_separation.HDF5 containing +an equal number of A type and B type particles is available in +the HyMD-tutorial/phase_separation github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd phase_separation.toml phase_separation.HDF5
+
+
+

we may examine the resulting trajectory. In the case of a low interaction +strength \(\tilde\chi\) of 5.0 (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to 40.0 (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +phase_separation.ipynb.

+
+
+

1.6. Diblock copolymers

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true +

Having introduced particle–field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive \(\tilde\chi\)–interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the integrator = "respa" keyword. Putting the pieces together, the +configuration file may look like the following:

+
+
copolymer.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 15
+n_steps = 2000                     # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [10.0, 10.0, 10.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [50, 50, 50]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+chi = [
+  ["A", "B", 30.0],                # (i, j, strength)
+]
+
+[bonds]
+bonds = [
+  ["A", "A", 0.25, 1500.0],        # (i, j, equilibrium length, strength)
+  ["A", "B", 0.25, 1500.0],
+  ["B", "B", 0.25, 1500.0],
+]
+angle_bonds = [
+  ["A", "A", "A", 180.0, 25.0],    # (i, j, k, equilibrium angle, strength)
+  ["B", "B", "B", 180.0, 25.0],
+]
+
+
+
+

A simple input structure/topology file copolymer.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/copolymer github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten A followed by ten B type particles. +Running the simulation with

+
python3 -m hymd copolymer.toml copolymer.HDF5
+
+
+

the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +copolymer.ipynb.

+
+
+

1.7. Lipid bilayer self-assembly

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true +

Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field–particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the thermostat_coupling_groups keyword. With parameters +optimised in [Ledum et al., 2020], the configuration file looks like:

+
+
lipid_self_assembly.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 25
+n_steps = 3000
+n_print = 200
+n_flush = 1
+time_step = 0.01
+box_size = [9.96924, 9.96924, 10.03970]
+start_temperature = 323
+target_temperature = 323
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.05
+domain_decomposition = 10001
+cancel_com_momentum = true
+max_molecule_size = 15
+thermostat_coupling_groups = [
+  ["N", "P", "G", "C"],
+  ["W"],
+]
+
+[field]
+mesh_size = [25, 25, 25]
+sigma = 1.0
+chi = [
+  ["C", "W", 42.24],
+  ["G", "C", 10.47],
+  ["N", "W", -3.77],
+  ["G", "W", 4.53],
+  ["N", "P", -9.34],
+  ["P", "G", 8.04],
+  ["N", "G", 1.97],
+  ["P", "C", 14.72],
+  ["P", "W", -1.51],
+  ["N", "C", 13.56],
+]
+
+[bonds]
+bonds = [
+  ["N", "P", 0.47, 1250.0],
+  ["P", "G", 0.47, 1250.0],
+  ["G", "G", 0.37, 1250.0],
+  ["G", "C", 0.47, 1250.0],
+  ["C", "C", 0.47, 1250.0],
+]
+angle_bonds = [
+  ["P", "G", "G", 120.0, 25.0],
+  ["P", "G", "C", 180.0, 25.0],
+  ["G", "C", "C", 180.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

A randomly mixed input structure/topology file +lipid_self_assembly.HDF5 with a few hundred lipids in a roughy +10 x 10 x 10nm box is available in the +HyMD-tutorial/lipid_self_assembly github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation

+
python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5
+
+
+

we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook lipid_self_assembly.ipynb.

+
+
+

1.8. Peptide in lipid bilayer

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true +

Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer.

+

The configuration file is available in the HyMD-tutorial/peptide github +repository (omitted here for brevity).

+

A pre-equilibrated input structure/topology file peptide.HDF5 with a +few hundred lipids in a roughy 20 x 20 x 20nm box is available in the +HyMD-tutorial/peptide github repository. Running the simulation

+
python3 -m hymd peptide.toml peptide.HDF5
+
+
+

we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook peptide.ipynb.

+
+
+

1.9. SDS

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true +

The last part we introduce is explicit electrostatic interactions through +particle–mesh Ewald. Enabling the electrostatic calculations is done via the +coulombtype keyword. "PIC_Spectral" is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the dielectric_const keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge.

+
+
sds.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 10
+n_steps = 3000
+n_print = 1500
+n_flush =
+time_step = 0.01
+box_size = [8.3, 8.3, 8.3]
+start_temperature = 298
+target_temperature = 298
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.1
+domain_decomposition = 10000
+cancel_com_momentum = true
+max_molecule_size = 5
+thermostat_coupling_groups = [
+  ["S", "C"],
+  ["W", "Na"],
+]
+dielectric_const = 45.0              # dielectric constant for the simulation medium
+coulombtype = "PIC_Spectral"         # particle in cloud, spectral method
+
+[field]
+mesh_size = [64, 64, 64]
+sigma = 0.5
+chi = [
+  ["S", "C",  13.50],
+  ["S", "Na",  0.00],
+  ["S", "W",  -3.60],
+  ["C", "Na", 13.50],
+  ["C", "W",  33.75],
+  ["W", "Na",  0.00],
+]
+
+[bonds]
+bonds = [
+  ["S",   "C",   0.50, 1250.0],
+  ["C",   "C",   0.50, 1250.0],
+]
+angle_bonds = [
+  ["S", "C", "C", 170.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

An input structure/topology file sds.HDF5 with a couple thousand +randomly dispersed SDS chains is available in the HyMD-tutorial/sds github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a /charge dataset. +Running the simulation with

+
python3 -m hymd sds.toml sds.HDF5
+
+
+

we observe the aggregation of the SDS into micellular structures—first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook sds.ipynb.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/doc_pages/filtering.html b/main/doc_pages/filtering.html new file mode 100644 index 00000000..3600e171 --- /dev/null +++ b/main/doc_pages/filtering.html @@ -0,0 +1,321 @@ + + + + + + + 2. Filtering — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Filtering

+

The default grid-independent filter function used in HyMD is a Gaussian

+
+\[H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right]\]
+

with reciprocal space representation

+
+\[\hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right].\]
+

The coarse-graining parameter \(\sigma\) determines a length scale of +particle extent and is given as configuration file input by

+
sigma = 0.75
+
+
+
+

2.1. Implementing new filters

+

Implementing new filter functions is straightforward by hijacking +the setup method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/doc_pages/installation.html b/main/doc_pages/installation.html new file mode 100644 index 00000000..a7d85b9b --- /dev/null +++ b/main/doc_pages/installation.html @@ -0,0 +1,556 @@ + + + + + + + 1. Installation — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Installation

+
+

1.1. Dependencies

+

Installing non-Python dependencies may be done by

+
+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-openmpi-dev  # Install MPI-enabled HDF5
+sudo apt-get install -y pkg-config           # Install pkg-config, required for h5py install
+sudo apt-get install -y curl wget
+
+
+
+
+

Warning

+

There might be memory leaks when using HyMD with OpenMPI 4.1.1. +Therefore, using a newer version of OpenMPI is recommended. +See Issue #186 for more details.

+ +

Installing Python dependencies may be done by

+
+
python3 -m pip install --upgrade pip
+CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+python3 -m pip install mpi4py numpy cython
+python3 -m pip install "pmesh @ git+https://github.com/rainwoodman/pmesh"
+
+
+
+
+

Warning

+

If MPI-enabled HDF5 and h5py can not be installed, limited support +for serial HDF5 is available. Note that having MPI-enabled file IO is +highly recommended, and simulation performance under serial HDF5 will +potentially be very low.

+

Example dependency install on Ubuntu (apt) using serial HDF5:

+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-serial-dev   # Install serial HDF5
+sudo apt-get install -y curl wget
+
+python3 -m pip install h5py mpi4py numpy cython
+
+
+

Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +--disable-mpio argument to HyMD, see Command line arguments. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial.

+ +
+
+

1.2. Installing HyMD

+

HyMD may be installed using pip by

+
python3 -m pip install hymd
+
+
+
+
+

1.3. Install in docker

+

A docker image with build essentials setup is available at dockerhub with tag +mortele/hymd,

+
docker pull mortele/hymd:latest
+docker run -it mortele/hymd
+/app$ python3 -m pip install hymd
+
+# Grab example input files
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5
+
+# Run simulation
+/app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose
+
+
+
+
+

1.4. Run interactively in Google Colaboratory

+

A Google Colaboratory jupyter notebook is setup here with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons.

+
+
+

1.5. Common issues

+
+

1.5.1. Numpy errors while importing the Fortran force kernels

+
RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd
+
+Traceback (most recent call last):
+
+  (...)
+
+File "/..../HyMD/hymd/__init__.py", line 2, in <module>
+  from .main import main  # noqa: F401
+File "/..../HyMD/hymd/main.py", line 10, in <module>
+  from .configure_runtime import configure_runtime
+File "/..../hymd/configure_runtime.py", line 12, in <module>
+  from .input_parser import read_config_toml, parse_config_toml
+File "/..../HyMD/hymd/input_parser.py", line 12, in <module>
+  from .force import Bond, Angle, Dihedral, Chi
+File "/..../HyMD/hymd/force.py", line 8, in <module>
+  from force_kernels import (  # noqa: F401
+ImportError: numpy.core.multiarray failed to import
+
+
+

can normally be fixed by updating numpy versions,

+
python3 -m pip install -U numpy
+
+
+
+
+

1.5.2. Error building pfft-python due to missing curl/wget

+
Building wheel for pfft-python (setup.py) ... error
+ERROR: Command errored out with exit status 1:
+command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_
+cwd: /tmp/pip-install-fr6nt9m4/pfft-python/
+Complete output (56 lines):
+running bdist_wheel
+running build
+running build_py
+
+  (...)
+
+curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found
+wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found
+Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+Please check curl or wget
+You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/
+Traceback (most recent call last):
+  File "<string>", line 1, in <module>
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in <module>
+    setup(
+  File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup
+    return distutils.core.setup(**attrs)
+  File "/usr/lib/python3.8/distutils/core.py", line 148, in setup
+
+  (...)
+
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions
+    build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:]))
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft
+    raise ValueError("could not build fftw; check MPICC?")
+ValueError: could not build fftw; check MPICC?
+----------------------------------------
+ERROR: Failed building wheel for pfft-python
+Running setup.py clean for pfft-python
+Failed to build pfft-python
+
+
+

can be fixed by installing either curl or wget

+
apt-get install -y curl wget
+
+
+
+
+

1.5.3. Error running parallel HyMD without MPI-enabled h5py

+
Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    main()
+  File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    raise ValueError("h5py was built without MPI support, can't use mpio driver")
+ValueError: h5py was built without MPI support, can't use mpio driver
+
+
+

Can be fixed by installing a MPI-enabled h5py through

+
python3 -m pip uninstall -y h5py
+HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/doc_pages/interaction_energy_functionals.html b/main/doc_pages/interaction_energy_functionals.html new file mode 100644 index 00000000..3e979100 --- /dev/null +++ b/main/doc_pages/interaction_energy_functionals.html @@ -0,0 +1,374 @@ + + + + + + + 1. Interaction energy functionals — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Interaction energy functionals

+

A few interaction energy functionals \(W\) are defined in HyMD through +the Hamiltonian class and associated subclasses.

+
+

1.1. \(\chi\)–interaction and \(\kappa\)–incompressibility

+

The most common hPF energy functional is specified by

+
hamiltonian = "DefaultWithChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where \(\tilde\chi_{\text{A}-\text{B}}\) is the interaction energy between +overlapping densities of particle types \(\text{A}\) and \(\text{B}\). +The incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\tilde\chi\) +and \(\kappa\) in the configuration file (see Configuration file)

+
kappa = 0.05
+chi = [
+   ["A", "B", 15.85],
+   ["B", "C", -5.70],
+   ...
+]
+
+
+
+
+

1.2. Only \(\kappa\)–incompressibility

+

The only \(\kappa\) interactions energy functional is specified by

+
hamiltonian = "DefaultNoChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where the incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.3. Only \(\phi^2\)

+

The \(\phi^2\) interactions energy functional is specified by

+
hamiltonian = "SquaredPhi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2,\]
+

where the \(\phi\) squared term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.4. Implementing new interaction energy forms

+

Implementing new interaction energy functions is straightforward by subclassing +Hamiltonian and applying sympy differentiation to the symbolic +field objects. The sympy.lamdify function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/doc_pages/interfaces.html b/main/doc_pages/interfaces.html new file mode 100644 index 00000000..6623ee70 --- /dev/null +++ b/main/doc_pages/interfaces.html @@ -0,0 +1,318 @@ + + + + + + + 5. PLUMED interface — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. PLUMED interface

+

HyMD is interfaced with PLUMED <https://www.plumed.org/> for simulations using enhanced sampling or free-energy methods. +To use the interface, the Python package of PLUMED must be installed, and the user must provide a working PLUMED_KERNEL by setting this environment variable to the kernel path. +In the current version, only simulations using a single replica are supported.

+
+

Warning

+

PLUMED versions prior to 2.8.1 did not have a working Python interface with MPI. Therefore, you must use PLUMED 2.8.1 or greater when installing the PLUMED library in Python. Older versions for the kernel are supported if the Python interface was correctly installed with version 2.8.1.

+ +
+

5.1. Running simulations using PLUMED

+

To run your simulations using PLUMED you must first set the environment variable PLUMED_KERNEL and then call HyMD with the --plumed option, passing the PLUMED input file to HyMD. +Optionally, you can also set the output file name with the --plumed-outfile option (the default it plumed.out).

+

If your PLUMED input (see the PLUMED manual <> for details) is called, e.g., plumed_input.dat, you can run a simulation using the PLUMED interface with:

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field --plumed plumed_input.dat
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/doc_pages/intramolecular_bonds.html b/main/doc_pages/intramolecular_bonds.html new file mode 100644 index 00000000..55713aa2 --- /dev/null +++ b/main/doc_pages/intramolecular_bonds.html @@ -0,0 +1,414 @@ + + + + + + + 2. Intramolecular bonds — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Intramolecular bonds

+

Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see Configuration file. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +Benchmarks), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable.

+

All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]).

+
+

2.1. Two-particle bonds

+

Stretching bonds in HyMD are implemented as harmonic spring potentials,

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2,\]
+

where \(r=|\mathbf{r}|\) is the inter-particle distance, \(k\) is a +constant of dimension energy (units \(\text{kJ}\,\text{mol}^{-1}\)), and +\(r_0\) is the equilibrum length of the bond (units: \(\text{nm}\)). The +force is calculated as

+
+\[F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r},\]
+

where \(\mathbf{r}\) is the vector pointing from \(i\) to \(j\).

+

In the configuration file, two-particle bonds are specified per particle type:

+
+
configuration_two_particle_example.toml
+
[bonds]
+bonds = [
+   ["A", "A", 0.47, 1250.0],
+   ["A", "B", 0.37,  940.0],
+   ["B", "C", 0.50, 1010.0],
+   ["C", "A", 0.42,  550.0],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.2. Three-particle bonds

+

Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle–particle–particle angle \(\theta\),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2,\]
+

where \(k\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\)), and \(\theta_0\) is the equilibrum +angle of the bond (units: \({}^\circ\)). Defining the particles with labels +\(a\), \(b\), and \(c\), let \(\mathbf{r}_a\) denote the vector +pointing from \(b\) to \(a\), and correspondingly let +\(\mathbf{r}_c\) point from \(b\) to \(c\). The +\(a\)\(b\)\(c\) may be computed through the law of Cosines,

+
+\[\theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right]\]
+

Then the force acting on \(a\) and \(c\) is

+
+\[ \begin{align}\begin{aligned}\mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a},\\\mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c},\end{aligned}\end{align} \]
+

and

+
+\[\mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c\]
+

In the configuration file, three-particle bonds are specified per particle type:

+
+
configuration_three_particle_example.toml
+
[bonds]
+angle_bonds = [
+   ["A", "A", "A", 180.0, 90.0],
+   ["A", "B", "A", 120.0, 55.0],
+   ["B", "C", "C",  30.0, 10.0],
+   ["C", "A", "B", 110.0, 25.5],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.3. Four-particle bonds

+

Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle \(\phi\) between the +\(a\)\(b\)\(c\) and \(b\)\(c\)\(d\) planes, for +a dihedral bond quartet \(a\), \(b\), \(c\), and \(d\). The +potential takes the form

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n),\]
+

where \(c_n\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)), and \(\phi_n\) are +specified phase angles in the cosine series.

+

In the configuration file, four-particle bonds are specified per particle type:

+
+
configuration_four_particle_example.toml
+
[bonds]
+dihedrals = [
+   ["A", "B", "C", "D"],
+   [
+     [-1],
+     [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+     [0.08, 0.46, 1.65, -0.96, 0.38],
+   ],
+   [1.0],
+]
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/doc_pages/overview.html b/main/doc_pages/overview.html new file mode 100644 index 00000000..e291894b --- /dev/null +++ b/main/doc_pages/overview.html @@ -0,0 +1,435 @@ + + + + + + + 2. Usage overview for HylleraasMD — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Usage overview for HylleraasMD

+

HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a toml format configuration file, along with a topology and structure +file specifying the input system in HDF5 format.

+

Configuration file

+

The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a [5, 5, 5] nm simulation box at 300 K may look like +the following:

+
+
config_simple_1.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "SquaredPhi"         # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [30, 30, 30]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+
+
+
+

Note that for the version 1.0 release of HyMD, the [particles], +[simulation], and [field] groups are optional specifiers for +structuring the configuration file.

+

For a full specification of every recognised configuration keyword in HyMD, +please refer to Configuration file.

+

Topology and structure file

+

The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +N particles may look like the following:

+
+
example_structure.HDF5
+
group   /
+   # root group
+
+dataset /coordinates
+   # float32, shape (T, N, D,)
+   # Time steps of N rows of D dimensional coordinate data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /velocities
+   # float32, shape (T, N, D,) OPTIONAL
+   # Time steps of N rows of D dimensional velocity data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /bonds
+   # int32,   shape (N, B,)    OPTIONAL
+   # Each row i contains indices of the particles bonds from/to i
+   # B denotes the maximum bonds per particle
+
+dataset /indices
+   # int32,   shape (N,)
+   # Index of each particle, 0--(N-1)
+
+dataset /molecules
+   # int32,   shape (N,)
+   # Index of molecule each particle belongs to
+   # Used to construct bond network locally on MPI ranks
+
+dataset /names
+   # str10,   shape (N,)
+   # Fixed size string array containing particle type names
+
+dataset /types
+   # int32,   shape (N,)       OPTIONAL
+   # Mapping of particle names to type indices
+
+
+
+

For a full specification of the topology and structure input file, see +Topology and structure file.

+

Command line arguments

+

A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the config_simple_1.toml and example_structure.HDF5 +files may look like the following:

+
mpirun -n ${MPI_NUM_RANKS} python3 -m hymd         \  # HyMD executable
+                           config_simple_1.toml    \  # configuration file
+                           example_structure.HDF5  \  # structure file
+                           --logfile=log_out.txt   \  # set logfile path
+                           --seed 123456           \  # set random seed
+                           --verbose 2             \  # set logging verbosity
+                           --velocity-output          # enable velocity in trajectory output
+
+
+

For a full specification of all command line arguments, see +Command line arguments.

+

More examples

+

For more thorough rundown and concrete usage examples, see +Examples.

+
+

2.1. Running parallel simulations

+

Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the only difference being how the python3 interpreter is +invoked. Prepending mpirun -n ${NPROCS} to the usual +python3 -m hymd runs the simulation with ${NPROCS} MPI ranks.

+

Inputting

+
mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field
+
+
+

sets up an example simulation of the HyMD-tutorial/ideal_gas system. For +more details about this system in particular, or other example simulations, see +the HyMD-tutorial repository.

+
+
+

2.2. Running tests

+

Run serial code tests by

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd
+cd hymd/
+python3 -m pip install pytest pytest-mpi
+python3 -m pytest
+
+
+

There is a small convenience script in hymd/ for running the MPI-enabled +tests,

+
chmod +x pytest-mpi
+./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/doc_pages/pressure.html b/main/doc_pages/pressure.html new file mode 100644 index 00000000..697b6acd --- /dev/null +++ b/main/doc_pages/pressure.html @@ -0,0 +1,324 @@ + + + + + + + 4. Pressure — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Pressure

+

Internal pressure is calculated from internal energy according to

+
+\[\begin{split}P_a = \frac{1}{\mathcal{V}} \left( 2T_a - \text{Vir}_a \right) \\ +\text{Vir}_a = L_a \frac{\partial \mathcal{U}}{\partial L_a} \\ +\mathcal{U} = \sum_{i=1}^M \mathcal{U}_0( \{ \mathbf{r}\}_i ) + W[\{ \tilde\phi \} ]\end{split}\]
+

where +\(\mathcal{V}\) is the simulation volume, +\({T_a}\) is the kinetic energy +and \(L_a\) the length of the box in the Cartesian direction \(a\), +Vir is the virial of the total interaction energy \(\mathcal{U}\).

+

\(\mathcal{U}\) comprises intramolecular bonded terms \(\mathcal{U}_0\) (see Intramolecular bonds for details), +and field terms \(W[\{ \tilde\phi \} ]\) (see Theory for details).

+

Using the above expressions, the following form for internal pressure is obtained:

+
+\[\begin{split}P_a = \frac{2 T_a}{\mathcal{V}} -\frac{L_a}{\mathcal{V}} \sum_{i=1}^N \frac{\partial \mathcal{U}_{0i}}{\partial L_a} + P^{(3)}_a \\\end{split}\]
+
+\[P^{(3)}_a = \frac{1}{\mathcal{V}}\left ( -W[\{ \tilde\phi(\mathbf{r}) \}] + \int \sum_t \bar{V}_t(\mathbf{r})\tilde\phi_t(\mathbf{r})d\mathbf{r} + + \int \sum_t \sigma^2\bar{V}_t(\mathbf{r})\nabla_a^2\tilde\phi_t(\mathbf{r}) d\mathbf{r} \right)\]
+

where \(\bar{V}_t(\mathbf{r}) = \frac{\partial w(\{\tilde\phi\})}{\partial\tilde\phi_t}\) +and \(σ\) is a coarse-graining parameter (see Filtering for details). +Note that the above expression is obtained for a Gaussian filter which is the most natural choice in HhPF theory.

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/doc_pages/theory.html b/main/doc_pages/theory.html new file mode 100644 index 00000000..4193676a --- /dev/null +++ b/main/doc_pages/theory.html @@ -0,0 +1,382 @@ + + + + + + + 1. Theory — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Theory

+

Hybrid particle–field simulations switch out the ordinary particle–particle +Lennard-Jones interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle–field densities are +defined as

+
+\[\phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i),\]
+

where \(\mathbf{r}\) is a spatial coordinate, \(P\) is a window function +used to distribute particle number densities onto a computational grid, and +\(\mathbf{r}_i\) is the position of particle \(i\) (of total \(N\)). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of \(N\) particles in \(M\) molecules is

+
+\[\mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})]\]
+

with \(H_0\) being a standard intramolecular Hamiltonian form (see +Intramolecular bonds) including kinetic terms, while \(W\) is a density +dependent interaction energy functional.

+

In the Hamiltonian hPF-MD formalism [], the density +field is filtered using a grid-independent filtering function \(H\),

+
+\[\tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}).\]
+

The filter smooths the density, ensuring that \(\tilde\phi\) and +\(W[\tilde\phi([\phi])]\) both converge as the grid size is reduced.

+
+

1.1. External potential

+

The external potential acting on a particle is defined as the functional +derivative of \(W\) with respect to \(\phi\). In the filtered formalism, +the potential takes the form

+
+\[\begin{split}V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ +&= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})},\end{split}\]
+

under the assumption of a local form of the interaction energy functional, +\(W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]\). Note +that

+
+\[\frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}).\]
+
+
+

1.2. Force interpolation

+

The forces on particle \(i\) are obtained by differentiation of the external +potential,

+
+\[\mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i).\]
+
+
+

1.3. Reciprocal space calculations

+

The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density \(\phi_{ijk}\) with CIC, we apply the filtering +and obtain the discrete version of the external potential by

+
+\[\tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big]\]
+

and

+
+\[V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+

The forces are obtained by differentiation of \(V\) in Fourier space as

+
+\[\nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+
+
+

1.4. Filter

+

By default, the filter used in HyMD is a simple Gaussian of the form

+
+\[\begin{split}H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ +\hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right].\end{split}\]
+

For more details about the filtering, see Filtering.

+
+
+

1.5. Hamiltonian form

+

The default form of the interaction energy functional in HyMD is

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2.\]
+

In the case of constant pressure simulations (NPT), the interaction energy functional becomes

+
+\[W=\frac{1}{2\rho_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-a\right)^2.\]
+

where, \(\rho_0= 1 / ν\) is an intrinsic parameter corresponding to the specific volume \((ν)\) of a coarse-grained particle, +\(a\) is a calibrated parameter to obtain the correct average density at the target temperature and pressure. +See Interaction energy functionals for details.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/doc_pages/topology_input.html b/main/doc_pages/topology_input.html new file mode 100644 index 00000000..d2825ac1 --- /dev/null +++ b/main/doc_pages/topology_input.html @@ -0,0 +1,363 @@ + + + + + + + 4. Topology and structure file — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Topology and structure file

+

The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root / group.

+

The HyMD-tutorial has multiple examples of structure files for various levels +of complexity.

+
+

4.1. Required datasets

+
+
/coordinates:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/indices:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/names:
+

array shape [N,]

+

datatype [string (length between 1 and 16)]

+

The shape represents one particle name per N particles. The datatype may be a string of length =<16.

+
+
+
+
+

4.2. Optional datasets

+
+
/velocities:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/types:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle type index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/molecules:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one molecule index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/bonds:
+

array shape [N, B,]

+

datatype [int32 or int64]

+

The shape represents B bond specifications (indices of different particles) per N particles. The data type may be either 32 or 64 bit integers.

+
+
/charge:
+

array shape [N,]

+

datatype [float32 or float64]

+

The shape represents one particle charge per N particles. The data type may be either four or eight byte reals.

+
+
/box:
+

array shape [3,]

+

datatype [float32 or float64]

+

The shape represents the initial box dimensions in Cartesian coordinates.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/genindex.html b/main/genindex.html new file mode 100644 index 00000000..d5743aed --- /dev/null +++ b/main/genindex.html @@ -0,0 +1,879 @@ + + + + + + Index — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + +
+ +

F

+ + + +
+ +

G

+ + +
+ +

H

+ + + +
    +
  • + hymd.input_parser + +
  • +
  • + hymd.integrator + +
  • +
  • + hymd.plumed + +
  • +
  • + hymd.pressure + +
  • +
  • + hymd.thermostat + +
  • +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/index.html b/main/index.html new file mode 100644 index 00000000..29f64262 --- /dev/null +++ b/main/index.html @@ -0,0 +1,408 @@ + + + + + + + HylleraasMD documentation — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

HylleraasMD documentation

+
+
Release:
+

2.2.0

+
+
Date:
+

Oct 06, 2023

+
+
+

HylleraasMD (HyMD) is a massively parallel Python package for Hamiltonian hybrid +particle-field molecular dynamics (HhPF-MD) simulations of coarse-grained bio- +and soft-matter systems.

+

HyMD can run canonical hPF-MD simulations, or filtered density HhPF-MD simulations [Bore and Cascella, 2020, Ledum et al., 2023, Ledum et al., 2023, Sen et al., 2023] +with or without explicit PME electrostatic interactions. It includes all standard intramolecular interactions, +including stretching, bending, torsional, and combined bending-dihedral potentials. Additionally, topological reconstruction of permanent peptide chain backbone +dipoles is possible for accurate recreation of protein conformational dynamics. It can run simulations in constant energy (NVE), constant volume (NVT) [Ledum et al., 2023, Ledum et al., 2023] +or constant pressure (NPT) conditions [Sen et al., 2023]. +HyMD is also interfaced with PLUMED and can perform simulations using enhanced sampling methods.

+

HyMD uses the pmesh library for particle-mesh operations, with the PPFT [Pippig, 2013] backend for FFTs through the pfft-python bindings. +File IO is done via HDF5 formats to allow MPI parallel reads.

+
+

User Guide

+

The HylleraasMD User Guide provides comprehensive information on how to run +simulations. Selected Examples are available to guide new users.

+
+
+

Installing HyMD

+

The easiest approach is to install using pip:

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+

For more information and required dependencies, see +Installation.

+
+

Run in Google colab

+

Run HyMD interactively in Google Colaboratory jupyter notebook here.

+
+
+
+

Source Code

+

Source code is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the GNU Lesser General Public +License v3.0. Obtain the source code with git:

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git
+
+
+
+
+

Development

+

HyMD is developed and maintained by researchers at the Hylleraas Centre for +Quantum Molecular Sciences at the University of Oslo.

+

pic1 pic2

+
+
+

References

+
+
+[BC20] +

Sigbjørn Løland Bore and Michele Cascella. Hamiltonian and alias-free hybrid particle–field molecular dynamics. J. Chem. Phys., 153(9):094106, 2020. doi:10.1063/5.0020733.

+
+
+[BDP07] +

Giovanni Bussi, Davide Donadio, and Michele Parrinello. Canonical sampling through velocity rescaling. J. Chem. Phys., 126(1):014101, 2007. doi:10.1063/1.2408420.

+
+
+[LBC20] +

Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Automated determination of hybrid particle-field parameters by machine learning. Mol. Phys., 118(19-20):e1785571, 2020. doi:10.1080/00268976.2020.1785571.

+
+
+[LCS+23] +

Morten Ledum, Manuel Carrer, Samiran Sen, Xinmeng Li, Michele Cascella, and Sigbjørn Løland Bore. HylleraasMD: Massively parallel hybrid particle-field molecular dynamics in Python. Journal of Open Source Software, 8(84):4149, apr 2023. URL: https://joss.theoj.org/papers/10.21105/joss.04149, doi:10.21105/joss.04149.

+
+
+[LSL+23] +

missing journal in hymd_domain2023

+
+
+[Pip13] +

Michael Pippig. Pfft: an extension of fftw to massively parallel architectures. SIAM J. Sci. Comput., 35(3):C213–C236, 2013. doi:10.1137/120885887.

+
+
+[SLBC23] +

Samiran Sen, Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Soft matter under pressure: pushing particle–field molecular dynamics to the isobaric ensemble. J Chem Inf Model, 63(7):2207–2217, March 2023. URL: https://doi.org/10.1021/acs.jcim.3c00186, doi:10.1021/acs.jcim.3c00186.

+
+
+[TBM92] +

MBBJM Tuckerman, Bruce J Berne, and Glenn J Martyna. Reversible multiple time scale molecular dynamics. J. Chem. Phys., 97(3):1990–2001, 1992. doi:10.1063/1.463137.

+
+
+
+
+
+

Indices and tables

+ +
+
+
+
+
+
+
+
+
+ + + +
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+ + + + + +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/objects.inv b/main/objects.inv new file mode 100644 index 00000000..f0c7150d Binary files /dev/null and b/main/objects.inv differ diff --git a/main/py-modindex.html b/main/py-modindex.html new file mode 100644 index 00000000..8907f7f7 --- /dev/null +++ b/main/py-modindex.html @@ -0,0 +1,359 @@ + + + + + + Python Module Index — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ h +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ h
+ hymd +
    + hymd.barostat +
    + hymd.field +
    + hymd.file_io +
    + hymd.force +
    + hymd.input_parser +
    + hymd.integrator +
    + hymd.plumed +
    + hymd.pressure +
    + hymd.thermostat +
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/main/search.html b/main/search.html new file mode 100644 index 00000000..778e1eeb --- /dev/null +++ b/main/search.html @@ -0,0 +1,314 @@ + + + + + + Search — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: main + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/main/searchindex.js b/main/searchindex.js new file mode 100644 index 00000000..48ec1e3a --- /dev/null +++ b/main/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["doc_pages/api","doc_pages/benchmarks","doc_pages/command_line","doc_pages/config_file","doc_pages/constants_and_units","doc_pages/electrostatics","doc_pages/examples","doc_pages/filtering","doc_pages/installation","doc_pages/interaction_energy_functionals","doc_pages/interfaces","doc_pages/intramolecular_bonds","doc_pages/overview","doc_pages/pressure","doc_pages/theory","doc_pages/topology_input","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,"sphinxcontrib.bibtex":9,sphinx:56},filenames:["doc_pages/api.rst","doc_pages/benchmarks.rst","doc_pages/command_line.rst","doc_pages/config_file.rst","doc_pages/constants_and_units.rst","doc_pages/electrostatics.rst","doc_pages/examples.rst","doc_pages/filtering.rst","doc_pages/installation.rst","doc_pages/interaction_energy_functionals.rst","doc_pages/interfaces.rst","doc_pages/intramolecular_bonds.rst","doc_pages/overview.rst","doc_pages/pressure.rst","doc_pages/theory.rst","doc_pages/topology_input.rst","index.rst"],objects:{"hymd.barostat":{isotropic:[0,1,1,""],semiisotropic:[0,1,1,""]},"hymd.field":{compute_field_and_kinetic_energy:[0,1,1,""],compute_field_energy_q_GPE:[0,1,1,""],compute_field_force:[0,1,1,""],compute_self_energy_q:[0,1,1,""],domain_decomposition:[0,1,1,""],initialize_pm:[0,1,1,""],update_field:[0,1,1,""],update_field_force_q:[0,1,1,""],update_field_force_q_GPE:[0,1,1,""]},"hymd.file_io":{OutDataset:[0,2,1,""],distribute_input:[0,1,1,""],setup_time_dependent_element:[0,1,1,""],store_data:[0,1,1,""],store_static:[0,1,1,""]},"hymd.file_io.OutDataset":{close_file:[0,3,1,""],flush:[0,3,1,""],is_open:[0,3,1,""]},"hymd.force":{Angle:[0,2,1,""],Bond:[0,2,1,""],Chi:[0,2,1,""],Dielectric_type:[0,2,1,""],Dihedral:[0,2,1,""],compute_angle_forces__plain:[0,1,1,""],compute_bond_forces__plain:[0,1,1,""],compute_dihedral_forces__plain:[0,1,1,""],dipole_forces_redistribution:[0,1,1,""],find_all_paths:[0,1,1,""],prepare_bonds:[0,1,1,""],prepare_bonds_old:[0,1,1,""],prepare_index_based_bonds:[0,1,1,""],propensity_potential_coeffs:[0,1,1,""]},"hymd.force.Angle":{atom_3:[0,4,1,""]},"hymd.force.Bond":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],equilibrium:[0,4,1,""],strength:[0,4,1,""]},"hymd.force.Chi":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],interaction_energy:[0,4,1,""]},"hymd.force.Dielectric_type":{atom_1:[0,4,1,""],dielectric_value:[0,4,1,""]},"hymd.force.Dihedral":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],atom_3:[0,4,1,""],atom_4:[0,4,1,""],coeffs:[0,4,1,""],dih_type:[0,4,1,""]},"hymd.hamiltonian":{DefaultNoChi:[0,2,1,""],DefaultWithChi:[0,2,1,""],Hamiltonian:[0,2,1,""],SquaredPhi:[0,2,1,""]},"hymd.hamiltonian.DefaultNoChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.DefaultWithChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.Hamiltonian":{__init__:[0,3,1,""],_setup:[0,3,1,""]},"hymd.hamiltonian.SquaredPhi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.input_parser":{Config:[0,2,1,""],check_NPT_conditions:[0,1,1,""],check_angles:[0,1,1,""],check_bonds:[0,1,1,""],check_box_size:[0,1,1,""],check_cancel_com_momentum:[0,1,1,""],check_charges:[0,1,1,""],check_charges_types_list:[0,1,1,""],check_chi:[0,1,1,""],check_config:[0,1,1,""],check_dielectric:[0,1,1,""],check_dihedrals:[0,1,1,""],check_domain_decomposition:[0,1,1,""],check_hamiltonian:[0,1,1,""],check_integrator:[0,1,1,""],check_m:[0,1,1,""],check_mass:[0,1,1,""],check_max_molecule_size:[0,1,1,""],check_n_b:[0,1,1,""],check_n_flush:[0,1,1,""],check_n_particles:[0,1,1,""],check_n_print:[0,1,1,""],check_name:[0,1,1,""],check_start_and_target_temperature:[0,1,1,""],check_tau:[0,1,1,""],check_thermostat_coupling_groups:[0,1,1,""],parse_config_toml:[0,1,1,""],read_config_toml:[0,1,1,""],sort_dielectric_by_type_id:[0,1,1,""]},"hymd.input_parser.Config":{a:[0,4,1,""],angle_bonds:[0,4,1,""],barostat:[0,4,1,""],barostat_type:[0,4,1,""],bonds:[0,4,1,""],box_size:[0,4,1,""],cancel_com_momentum:[0,4,1,""],chi:[0,4,1,""],conv_crit:[0,4,1,""],convergence_type:[0,4,1,""],coulomb_constant:[0,4,1,""],coulombtype:[0,4,1,""],dielectric_const:[0,4,1,""],dielectric_type:[0,4,1,""],dihedrals:[0,4,1,""],domain_decomposition:[0,4,1,""],dtype:[0,4,1,""],file_name:[0,4,1,""],gas_constant:[0,4,1,""],hamiltonian:[0,4,1,""],initial_energy:[0,4,1,""],integrator:[0,4,1,""],kappa:[0,4,1,""],m:[0,4,1,""],mass:[0,4,1,""],max_molecule_size:[0,4,1,""],mesh_size:[0,4,1,""],n_b:[0,4,1,""],n_flush:[0,4,1,""],n_particles:[0,4,1,""],n_print:[0,4,1,""],n_steps:[0,4,1,""],name:[0,4,1,""],pol_mixing:[0,4,1,""],pressure:[0,4,1,""],respa_inner:[0,4,1,""],rho0:[0,4,1,""],self_energy:[0,4,1,""],sigma:[0,4,1,""],start_temperature:[0,4,1,""],tags:[0,4,1,""],target_pressure:[0,4,1,""],target_temperature:[0,4,1,""],tau:[0,4,1,""],tau_p:[0,4,1,""],thermostat_coupling_groups:[0,4,1,""],thermostat_work:[0,4,1,""],time_step:[0,4,1,""],type_charges:[0,4,1,""]},"hymd.integrator":{integrate_position:[0,1,1,""],integrate_velocity:[0,1,1,""]},"hymd.logger":{Logger:[0,2,1,""],MPIFilterAll:[0,2,1,""],MPIFilterRoot:[0,2,1,""]},"hymd.logger.Logger":{setup:[0,3,1,""]},"hymd.logger.MPIFilterAll":{filter:[0,3,1,""]},"hymd.logger.MPIFilterRoot":{filter:[0,3,1,""]},"hymd.plumed":{PlumedBias:[0,2,1,""]},"hymd.plumed.PlumedBias":{api_version:[0,3,1,""],calc:[0,3,1,""],finalize:[0,3,1,""],prepare:[0,3,1,""]},"hymd.pressure":{comp_pressure:[0,1,1,""]},"hymd.thermostat":{_random_chi_squared:[0,1,1,""],_random_gaussian:[0,1,1,""],csvr_thermostat:[0,1,1,""]},hymd:{barostat:[0,0,0,"-"],field:[0,0,0,"-"],file_io:[0,0,0,"-"],force:[0,0,0,"-"],input_parser:[0,0,0,"-"],integrator:[0,0,0,"-"],plumed:[0,0,0,"-"],pressure:[0,0,0,"-"],thermostat:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0020733":16,"00268976":16,"0083144621":0,"01036426965":4,"014101":[0,16],"02214076":4,"03642696562":4,"03970":6,"04149":16,"08790868":[6,11],"094106":16,"0xd":8,"0xe":8,"100":[4,6,12],"1000":6,"10000":6,"10001":6,"1010":11,"1021":16,"1063":16,"1080":16,"10nm":6,"110":11,"1120":0,"1130":0,"1137":16,"118":16,"120":[3,6,11],"120885887":16,"120ff":0,"123456":12,"1250":[3,6,11],"126":[0,16],"138":[0,4],"144":8,"148":8,"1500":6,"153":16,"166":8,"170":6,"1785571":16,"179":0,"180":[3,6,11],"186":8,"197":8,"1974":0,"1981":0,"1984":0,"1990":16,"1992":[3,16],"200":[6,11],"2000":6,"2001":16,"2007":[0,3,16],"2008":0,"201":[0,3],"2013":16,"2018":0,"2020":[6,16],"2023":16,"20nm":6,"21105":16,"2207":16,"2217":16,"223":0,"224":1,"2408420":16,"2408724":[6,11],"246":0,"251":[6,11],"28103735":0,"298":6,"2_1":0,"2don2d":8,"2nd":0,"2t_a":13,"300":[6,12],"3000":6,"3144621":4,"323":6,"3684":0,"3690":0,"3c00186":16,"4149":16,"449":[6,11],"463137":16,"48626121":[6,11],"502":8,"533":1,"544":[6,11],"550":11,"59427866":[6,11],"602176634":4,"610":[6,11],"66053906660":4,"85418781281":4,"935458":[0,4],"940":11,"96924":6,"980":3,"9918564":[6,11],"\u03b1":0,"\u03b2":0,"\u03bd":14,"\u03c3":13,"boolean":[0,3],"byte":15,"case":[0,3,6,11,14],"class":[0,9],"default":[0,3,7,10,12,14,15],"export":8,"final":0,"float":[0,3],"function":[0,3,5,6,7,12,14],"int":[0,5,6,9,13,14],"long":[5,6],"new":[0,11,15,16],"particle\u00e2":16,"public":16,"return":[0,8],"short":[6,12],"static":0,"switch":14,"true":[0,3,6],"while":[0,14],Adding:6,For:[0,12,14,16],LCS:16,The:[0,3,5,6,7,8,9,11,12,14,15,16],Then:11,There:[8,12],These:0,Used:[0,3,12],Using:[6,9,13],With:[0,6],__file__:8,__init__:[0,8],__main__:8,_gener:0,_hl:8,_kwarg:8,_random_chi_squar:0,_random_gaussian:0,_run_cod:8,_run_module_as_main:8,_set_fapl_mpio:8,_setup:0,about:[3,12,14],abov:[0,6,13],absent:0,acceler:0,accompani:6,accord:[0,3,13],accur:16,acid:6,across:[0,3],acs:16,act:[0,11,14],adapt:0,add:[5,6],added:0,adding:6,addison:0,addit:[0,2,5,12],addition:16,additon:0,adher:0,affect:0,affili:[0,2],after:[0,11,14],against:8,aggreg:6,ahren:0,alanin:6,algorithm:[0,3,14],alia:16,all:[0,2,3,4,6,8,11,12,16],all_nam:0,all_rank:0,alloc:0,allow:[12,16],allreduc:0,along:[6,12],alpha3:8,alpha:0,alpha_:0,alpha_l:0,alpha_n:0,alreadi:0,also:[6,8,10,16],altern:2,alwai:[0,3],amino:6,amount:0,analyt:0,angl:[0,2,3,6,8,11],angle_bond:[0,3,6,11],angle_pr:0,angular:[0,3,6,11],ani:[0,2,3],anisotrop:0,apart:0,api:8,api_vers:0,app:8,appli:[0,3,7,9,14],applic:0,approach:16,approxim:0,apr:16,apt:8,architectur:16,arg:[0,8],argument:[0,6,8,12],argv:8,aris:0,around:11,arrai:[0,3,12,15],arriv:6,art:0,aspect:3,assess:0,assign:[0,3,11],associ:[0,9],assum:3,assumpt:14,atom:0,atom_1:0,atom_2:0,atom_3:0,atom_4:0,attach:15,attempt:0,attr:8,attract:3,attribut:0,autom:16,automat:[0,7,8,9],avail:[6,8,16],averag:[0,3,9,14],avogadro:4,back:[0,5],backbon:[0,2,3,16],backcon:0,backend:16,backmap:0,balanc:0,ballist:6,bar:[3,4,13],barostat:3,barostat_typ:[0,3],base:0,bath:[0,3],bb_index:0,bc20:16,bdist_wheel:8,bdp07:16,bead:0,becaus:0,becom:[0,14],befor:[0,3,6,8],being:[0,2,3,5,11,12,14],belong:12,below:[0,6],benchmark:11,bend:[0,3,11,16],berendsen:3,bern:16,besid:2,best:0,beta:0,better:0,between:[0,3,5,6,9,11,14,15],bia:0,big:14,bin:8,binari:8,bind:16,bio:16,bit:[0,15],blueprint:0,boltzmann:[0,3,4],bond2_energi:0,bond3_energi:0,bond4_energi:0,bond:[0,2,6,8,12,13,14,15],bond_pr:0,bonds_2:0,bonds_2_atom1:0,bonds_2_atom2:0,bonds_2_atom_1:0,bonds_2_atom_2:0,bonds_2_equilibrium:0,bonds_2_strength:0,bonds_3:0,bonds_3_atom_1:0,bonds_3_atom_2:0,bonds_3_atom_3:0,bonds_3_equilibrium:0,bonds_3_strength:0,bonds_4:0,bonds_4_atom_1:0,bonds_4_atom_2:0,bonds_4_atom_3:0,bonds_4_atom_4:0,bonds_4_coeff:0,bonds_4_last:0,bonds_4_typ:0,bool:0,bootstrap:8,bore:[0,16],both:[0,14],boundari:[0,3],box:[0,3,6,12,13,15],box_siz:[0,3,6,12],breviti:6,brew:8,broadcast:0,browser:8,bruce:16,buffer:[0,3],build_extens:8,build_pfft:8,build_pi:8,built:8,bussi:[0,3,16],c213:16,c236:16,c_n:[0,6,11],calc:0,calcul:[0,3,6,11,13],calibr:[0,3,14],call:[0,3,8,10],callabl:0,can:[0,6,8,10,16],cancel_com_momentum:[0,3,6],canon:[0,3,16],capabl:2,captur:12,carrer:16,carri:6,cartesian:[0,3,13,15],cascella:[8,12,16],cbt:0,cdot10:4,cdot:[0,4,11],cell:[0,14],cellar:8,center:[0,3],centr:16,certain:[0,2],chain:[0,16],chang:[0,3],changedin:0,charg:[0,3,4,5,6,15],charge_out:0,check:[0,8],check_angl:0,check_bond:0,check_box_s:0,check_cancel_com_momentum:0,check_charg:0,check_charges_types_list:0,check_chi:0,check_config:0,check_dielectr:0,check_dihedr:0,check_domain_decomposit:0,check_hamiltonian:0,check_integr:0,check_m:0,check_mass:0,check_max_molecule_s:0,check_n_b:0,check_n_flush:0,check_n_particl:0,check_n_print:0,check_nam:0,check_npt_condit:0,check_start_and_target_temperatur:0,check_tau:0,check_thermostat_coupling_group:0,chem:[0,16],chi:[0,3,4,6,8],chi_2:0,chi_3:0,chi_:[0,3,6,9,14],chi_m:0,chmod:12,choic:13,chosen:0,cic:[0,5,14],circ:[3,11],circumv:14,classmethod:0,classvar:0,clean:[0,8],clone:[8,12,16],close:[0,8],close_fil:0,closest:0,cloud:[0,6,14],coars:[0,3,7,13,14,16],code:[0,1,2,3,6,8,12],coeff:0,coeffici:0,coil:[0,6],colab:8,colaboratori:16,collect:[0,3,15],com:[0,8,12,16],combin:[0,6,16],comm:0,comm_world:0,command:[8,12],common:9,commuic:0,commun:[0,3,11],communc:0,comp_pressur:0,compar:6,compat:2,compil:[0,8],compiler_so:8,complesfield:0,complet:[0,6,8],complex:[6,15],complexfield:0,compon:0,comprehens:16,compress:[0,3,4,6,9,12],compris:13,comput:[0,5,11,14,16],computaion:0,compute_angle_forces__plain:0,compute_bond_forces__plain:0,compute_dihedral_forces__plain:0,compute_field_and_kinetic_energi:0,compute_field_energy_q_gp:0,compute_field_forc:0,compute_potenti:0,compute_self_energy_q:0,concret:12,condit:[6,16],config:[0,8],config_simple_1:12,configur:[0,2,5,6,7,8,9,11,12],configuration_four_particle_exampl:11,configuration_three_particle_exampl:11,configuration_two_particle_exampl:11,configure_runtim:8,conform:[6,15,16],connect:0,conserv:1,consid:[0,6],consist:[0,6],consit:6,consitu:0,constant:[0,3,5,6,11,14,16],constitut:[0,2,3],constraint:3,construct:[0,11,12],constructor:0,contain:[0,1,2,3,6,12],content:[0,6],contigu:0,contribut:0,control:3,conv_crit:0,conv_fun:0,conveni:12,convent:0,converg:[0,14],convergence_typ:0,convert:0,coordin:[12,14,15],copi:0,core:8,correct:[0,3,14],correctli:10,correspond:[0,3,14],correspondingli:11,cos:[0,6,11],cosin:[0,3,6,11],cost:[3,11],could:8,coulomb:[0,3,4,5],coulomb_const:0,coulombtyp:[0,3,5,6],counter:6,coupl:[0,3,6,12],cprofil:2,cpu:[0,11],crash:3,creat:[0,9],critic:[0,6],cross:0,csvr:[0,3],csvr_thermostat:0,current:[0,6,10],cwd:8,cython:[8,16],d_n:0,dat:10,data:[0,3,6,12,15],dataclass:0,dataset:[0,5,6,12],datatyp:15,date:[0,16],date_format:0,david:16,debug:[0,2],decompos:0,decomposit:[0,3,11],default_level:0,defaultnochi:[0,6,9],defaultnohchi:[0,3],defaultwithchi:[0,3,6,9],defin:[0,6,9,11,14],definit:0,degre:3,delta:[0,14],denot:[0,1,3,9,11,12],densiti:[0,3,5,9,14,16],depend:[0,6,11,14,16],deprec:0,deriv:[0,14],design:6,dest_directori:0,detail:[2,3,6,8,10,12,13,14],determin:[0,2,7,16],dev:8,devel:8,develop:[6,8],deviat:[0,3],dict:0,dictat:0,dictionari:0,did:10,dielectr:[0,3,6],dielectric_const:[0,3,5,6],dielectric_typ:0,dielectric_valu:0,dieter:0,differ:[0,3,6,12,15],differenti:[0,5,7,9,14],difficult:2,dih_typ:0,dihedr:[0,2,3,5,6,8,11,16],dimens:[0,11,12,15],dimension:12,dinola:0,dipol:[0,2,3,5,6,16],dipole_forces_redistribut:0,direct:[0,3,13],directori:12,disabl:[2,6,8,10,12],disable_mpio:0,discard:0,discret:[0,14],discretis:14,disk:[0,3],dispers:6,dist:8,distanc:[0,3,11],distinct:0,distribut:[0,3,5,6,14],distribute_input:0,distutil:8,dnf:8,doc:0,dockerhub:8,dodecyl:6,doe:[0,11],doesn:0,doi:16,domain:[0,3,11],domain_decomposit:[0,3,6],donadio:[0,16],done:[0,6,8,16],dopc:6,dot:0,dot_elec:0,doubl:[0,2],double_out:0,download:8,dppc:6,draw:0,drawn:0,driver:[8,12],dtype:0,due:[0,3],dump:0,dump_per_particl:0,dure:[0,2,3,11,12],dynam:[0,3,12,14,16],e1785571:16,e_k:0,each:[0,3,6,11,12],easiest:16,effect:[0,3],effici:11,eight:15,either:[0,3,8,15],elec:0,elec_field:0,elec_field_contrib:0,elec_field_fouri:0,elec_forc:0,elecrostat:0,electr:[0,4,5],electrosat:0,electrostat:[0,6,16],els:3,elucid:6,embed:6,emit:0,emploi:0,empti:0,enabl:[2,6,12],enclos:0,end:0,energi:[0,1,3,4,6,7,10,11,12,13,14,16],energiesself:0,enhanc:[10,16],ensembl:16,ensur:[0,3,6,8,14],ensurepip:8,entri:3,environ:10,epsilon:0,equal:[0,3,6],equat:0,equilibr:[3,6],equilibrium:[0,3,6],equilibrum:11,equival:[0,3],error:0,essenti:[0,1,8],etc:[2,3],even:[0,3,6,8],event:0,everi:[0,3,6,11,12],everystep:0,evid:0,ewald:[0,5,6],examin:6,exampl:[3,8,12,15,16],example_structur:12,except:11,exchang:[0,3],exec:8,execut:[0,8,12],exist:0,exit:8,exp:[7,14],expand:0,expans:0,expect:0,expens:[3,14],explicit:[0,6,11,16],express:[0,13],ext:0,extend:6,extens:16,extent:[0,7],extern:[0,3],extract:[0,8],f401:8,f_angl:0,f_bond:0,f_dihedr:0,f_dipol:0,f_on_bead:0,factor:0,factori:0,fail:[0,8],fals:[0,3,6],fapl:8,fashion:[0,3],fast:14,fedora:8,few:[6,9,11,12],fft:[0,1,2,3,5,6,12,14,16],fftw3:8,fftw:[8,16],field:[2,4,5,6,9,10,12,13,14,16],field_energi:0,field_list:0,field_q_energi:0,field_q_self_energi:0,file:[2,5,6,7,8,9,10,11,12,16],file_io:0,file_nam:0,file_path:0,filter:[0,3,5,6,12,13,16],find:[0,8],find_all_path:0,first:[0,3,6,10,12],five:0,fix:[0,8,12],flag:[0,15],flat:12,float32:[12,15],float64:15,flori:0,fluctuat:0,flush:[0,3],follow:[0,2,3,4,6,12,13],forc:[2,3,4,5,6,11],force_kernel:8,force_mesh:0,force_mesh_elec:0,force_mesh_elec_fouri:0,force_out:0,forego:2,form:[0,5,11,13],formal:[5,14],format:[0,2,3,5,12,15,16],formatt:0,fortran:[0,11],forward:0,found:[5,8],four:[0,2,3,6,15],fourier:[0,5,14],fr6nt9m4:8,frac:[0,5,6,7,9,11,13,14],frame:[0,12,15],framework:8,free:[10,16],frequenc:[0,3],from:[0,2,3,5,6,8,9,11,12,13,16],full:[0,9,12],fulli:[0,6,8],fundament:12,gamma:0,gamma_0:0,gas:[0,4],gas_const:0,gather:0,gaussian:[0,3,7,13,14],gener:[0,2,3,6,16],get:[0,8],getattr:8,ghost:0,giovanni:16,git:[8,12,16],github:[0,6,8,12,16],githubusercont:8,given:[0,3,6,7],glenn:16,global:0,gnu:16,got:0,govern:9,gpe:0,grab:8,gradient:0,grain:[0,3,7,13,14,16],graph:0,greater:10,grid:[0,1,3,5,6,7,12,14],group:[0,3,6,8,12,15,16],guess:0,gunsteren:0,gyrat:6,h5md:[0,3],h5py:[0,2],h_0:[6,14],haak:0,half:0,hamiltonian:[3,5,6,7,9,12,16],handl:0,handler:0,happen:11,harmon:[0,3,6,11],has:[0,3,8,15],hat:[7,14],have:[0,6,8,10],hdf5:[0,2,3,5,6,8,10,12,15,16],hdf5_dir:8,hdf5_mpi:8,head:6,header:8,heat:[0,3],helic:[0,3,5,6],help:6,helper:0,here:[0,6,8,16],hhpf:[13,16],highli:[8,11,12],hijack:7,hire:1,homogen:0,homopolym:1,homopolypeptid:6,how:[3,12,16],howev:6,hpf:[3,5,9,12,14,16],html:0,http:[0,8,10,12,16],huggin:0,hundr:[6,11],hybrid:[12,14,16],hylleraa:16,hymd:[0,2,3,4,5,6,7,9,10,11,12,14,15],hymd_domain2023:16,ideal:11,ideal_chain:[6,8,10],ideal_ga:[6,12],ident:0,ignor:0,ijk:[5,14],imag:8,impact:0,implement:[0,11],importerror:8,impuls:[0,3],in_fil:[0,8],inam:8,includ:[0,2,3,6,14,16],incompress:[0,3],increas:[0,2,6],indentifi:0,independ:[0,3,7,14],index:[0,12,15,16],indic:[0,2,3,11,12,15],indirect:0,individu:[0,3,6],induc:5,inf:16,infer:11,info:[0,8],inform:[0,11,16],ingredi:6,initi:[0,15],initial_energi:0,initialis:12,initialize_pm:0,inner:[0,3],input:[2,3,4,5,6,7,8,10,12,15],input_box:0,input_pars:[0,8],insert:0,insid:[0,3,6],instal:[2,10,12],install_pfft:8,instantan:0,int32:[12,15],int64:15,integ:[0,3,6,15],integr:[3,6,12],integrate_posit:0,integrate_veloc:0,intend:8,inter:[0,11],interact:[0,2,3,4,6,7,12,13,14,16],interaction_energi:0,intercomm:0,interfac:[0,2,16],intergr:0,intermediari:0,intermolecular:6,intern:[0,2,3,4,11,13],interpol:[0,5],interpret:12,interv:[0,3],intmathrm:0,intracomm:0,intramolecular:[0,3,6,13,14,16],intrins:[3,5,14],introduc:6,investig:0,invok:[2,12],involv:[0,3,11],ion:6,ipynb:6,is_open:0,isobar:16,isotherm:0,isotrop:[0,3],iter:0,j_k:0,jcim:16,join:8,jone:14,joss:16,journal:16,jupyt:[6,8,16],k_e:0,kappa:[0,3,4,6,12,14],keep:[0,3],kelvin:[0,3,6,12],kernel:[0,10,11],keyword:[0,5,6,12],kinet:[0,13,14],kinetic_energi:0,knuth:0,kpa:4,kwd:8,l_a:13,label:[1,11],lambda:0,lamdifi:9,land:16,laplacian:0,larg:[8,12],larger:3,last:[6,8,12,15],last_bb:0,later:[0,6],latest:8,law:11,layout:0,layout_q:0,lbc20:16,leak:8,learn:16,leav:0,ledum:[6,16],left:[0,5,6,7,9,11,13,14],legend:1,lenght:0,length:[0,3,4,6,7,11,12,13,15],lennard:14,less:[0,6],lesser:16,let:[0,11],level:[0,2,3,15],lib64:8,lib:8,libhdf5:8,libopenmpi:8,librari:[0,2,8,10,16],libtool:8,libver:8,licens:16,lieu:0,like:[0,6,8,12],limit:[3,8],line:[0,8,12],linear:[0,3],lipid_self_assembl:6,list:0,list_coulomb:0,load:0,local:[0,8,11,12,14],locat:8,log:[0,2,12],log_fil:0,log_out:12,logfil:[0,2,12],logger:2,logic:0,logrecord:0,look:[6,8,12],loop:0,lost:3,low:[6,8],lsl:16,m_j:0,mac:8,machin:[2,16],made:0,mai:[0,2,3,6,8,11,12,15],main:[0,8,12],main_glob:8,maintain:16,make:[6,8],make_fapl:8,manner:6,manual:[8,10],manuel:16,map:[0,12],march:16,martini:6,martyna:16,mass:[0,3,4,15],massiv:16,master:0,match:0,math:0,mathbf:[0,4,5,6,9,11,13,14],mathcal:[6,13,14],mathmr:0,mathrm:[0,5,6,9,11,14],matter:[6,11,16],max_molecule_s:[0,3,6],maximum:[0,3,11,12],maxwel:[0,3],may:2,mbbjm:16,mean:[0,2,3],measur:11,medium:[0,3,6],melt:1,membran:6,memori:[0,8],mesh:[0,1,3,5,6,16],mesh_siz:[0,3,6,12],messag:0,messi:0,meta:6,metadata:0,method:[0,1,6,7,10,16],mh_0:14,micellular:6,michael:16,michel:16,might:[0,8],mimic:0,minim:6,minuscul:11,mirror:2,miss:16,mix:[0,6],model:[6,16],modifi:0,modul:[0,3,8,16],mol:[3,4,6,11,12,16],molecul:[0,3,12,14,15],molecular:[0,2,12,14,16],momenta:[0,12],momentum:[0,3,4],monoatom:6,more:[2,3,6,8,12,14,16],mortel:8,morten:16,most:[8,9,12,13,14],mostli:2,motion:[0,6],move:0,mpi4pi:[0,8,16],mpi:[0,2,3,10,11,12,16],mpi_num_rank:12,mpicc:8,mpifilteral:0,mpifilterroot:0,mpio:[2,8],mpip:8,mpirun:12,multiarrai:8,multipl:[0,3,6,12,15,16],must:[0,3,10],n_b:[0,3],n_flush:[0,3,6],n_frame:0,n_particl:[0,3],n_print:[0,3,6,12],n_step:[0,3,6,12],n_type:0,nabla:[0,14],nabla_a:13,name:[0,2,3,6,10,11,12,15],nanomet:[0,1],nanosecond:6,natur:[0,13],ndarrai:0,ne5et1y_:8,necessari:[0,6],necessit:[8,9],need:[0,6],neg:[0,6],neighbour:0,network:[0,11,12,15],networkx:0,neutralis:6,never:[0,3],nevertheless:3,newer:8,next:[0,6],non:[0,2,6,8],none:[0,3,8],nongnu:0,noqa:8,normal:[0,2,3,8,14],notabl:12,note:[0,6,8,12,13,14],notebook:[6,8,16],now:6,nproc:12,npt:[0,14,16],nq_i:5,number:[0,1,2,3,6,12,14,15],numer:0,numpi:[0,2,9,16],nve:16,nvt:[0,16],object:[0,9],oblat:6,observ:[0,6],obtain:[0,3,5,13,14,16],obviou:8,oct:16,off:6,older:10,omit:6,onc:[3,11],one:[0,2,3,6,15],onli:[0,6,10,11,12],onto:[0,3,5,14],open:[0,8,16],openmpi:8,oper:[0,3,14,16],oppos:0,optim:[0,11],optimis:[6,11],option:[0,3,6,10,12],order:[0,3,6,11,12],ordinari:[5,14],org:[0,10,16],organis:6,origin:0,oslo:16,osx:8,other:[0,12],otherwis:0,out:[8,10,14],outdataset:0,outer:[0,3],outfil:[2,10],output:[2,3,4,6,8,10,12],outsid:3,over:0,overlap:[0,9],p_a:13,packag:[8,10,12,16],page:16,paint:0,paper:[0,16],parallel:[0,2,3,16],paramet:[0,3,6,7,9,13,14,16],parent_group:0,parllel:0,parrinello:[0,16],pars:[0,3],parse_config_toml:[0,8],part:[5,6,14],partial:[0,13],particl:[0,2,5,6,7,9,12,14,15,16],particlemesh:0,particular:12,pass:[0,10],path:[0,2,8,10,12],pdf:1,pencil:0,peptid:[0,2,3,5,16],per:[0,2,3,11,12,15],perfect:0,perform:[0,3,8,11,12,14,16],perman:[11,16],permitt:[0,4],pfft:[0,16],pfft_build_dir:8,phase:[0,11],phase_separ:6,phi:[0,3,6,11,13,14],phi_0:[6,9,14],phi_:[0,6,9,14],phi_ep:0,phi_eps_fouri:0,phi_eta:0,phi_eta_fouri:0,phi_fft:0,phi_fouri:0,phi_k:0,phi_l:0,phi_laplacian:0,phi_n:[6,11],phi_pol:0,phi_pol_prev:0,phi_q:0,phi_q_fouri:0,phi_t:13,phi_transf:0,phospholipid:6,phy:[0,16],pic_spectr:[0,3,6],pic_spectral_gp:0,piec:6,pip13:16,pip3:8,pip:[8,12,16],pippig:16,pkg:8,place:[0,3],plain:2,plane:[0,6,11],pleas:[8,12],plist:8,plume:[2,16],plumed2:0,plumed_bia:0,plumed_forc:0,plumed_input:10,plumed_kernel:10,plumed_obj:0,plumed_out:0,plumed_vers:0,plumedbia:0,plumeddat:0,pm_stuff:0,pme:16,pmesh:[0,8,16],png:1,point:[0,1,11,15],pointer:0,poisson:0,pol_mix:0,polar:0,polym:6,posit:[0,2,3,5,6,12,14],possibl:[0,3,6,16],postma:0,poteng:0,potenti:[0,3,4,5,7,8,11,16],ppft:16,practic:11,pre:[0,6],precis:[1,2],prefer:3,prepar:0,prepare_bond:0,prepare_bonds_old:0,prepare_index_based_bond:0,prepend:[0,12],present:[0,2,3,6],preserv:3,pressur:[4,14,16],pretti:8,previou:0,previous:6,prior:[0,3,10],priovid:0,prng:0,prod_:0,profil:2,program:[0,12],project:5,promot:0,prop:0,propag:[0,3],propens:[0,3,5,6],propensity_potential_coeff:0,properti:[0,3],protein:[0,16],provid:[0,2,3,10,12,15,16],psi:[0,4,5],psi_:5,psi_fouri:0,pull:8,push:16,put:6,pytest:12,python3:[6,8,10,12,16],python:[0,10,12,16],q_i:[0,5],q_j:0,quadrat:0,quanit:0,quantiti:[0,4],quantum:16,quartet:11,quess:0,r_0:[0,6,11],r_a:11,r_c:11,rad:[3,11],radial:6,radii:6,radiu:6,rainwoodman:8,rais:[6,8],random:[0,2,12],random_chi_squar:0,random_gaussian:0,randomli:[0,3,6],rang:5,rank0:0,rank:[0,2,3,11,12],rank_rang:0,rankself:0,rare:11,raw:8,rdcc_nbyte:8,rdcc_nslot:8,rdcc_w0:8,read:[0,8,12,16],read_config_toml:[0,8],readi:0,readout:0,real:15,realfield:0,realist:6,reappli:0,rearrang:0,reason:8,receiv:[0,3],recent:8,reciproc:[0,7],recognis:12,recommend:8,reconstruct:[0,2,5,6,11,16],record:0,recreat:16,recurs:0,redistribut:0,reduc:[3,14],refer:[3,12],regim:6,regul:[0,3],reiniti:0,rel:[0,3,6,11],relax:[0,3],releas:[0,6,8,12,16],remain:[0,6],remov:[0,3],remove_center_of_mass_momentum:0,remove_com_momentum:[0,3],replac:[0,8],replica:[0,10],repositori:[6,12],repres:[0,3,15],represent:7,repuls:3,request:0,requir:[0,3,8,11,12,16],rescal:[0,3,16],research:16,respa:[0,3,6],respa_inn:[0,3,6],respect:[0,1,14],restructur:0,result:[0,3,6,9],revers:[0,3,16],rho0:[0,3],rho:[0,5],rho_0:[0,14],rho_:5,right:[0,5,6,7,9,11,13,14],rightarrow:11,root:[0,12,15],roughi:6,row:12,rrespa:[0,3,6],ruin:0,run:[0,2,3,6,11],run_glob:8,rundown:12,runpi:8,runtimeerror:8,same:[0,3,6],samiran:16,sampl:[0,3,10,16],scalar:0,scale:[0,3,6,7,8,11,12,16],scheme:[0,6],sci:16,scienc:16,scr:3,script:12,sds:6,search:16,second:[0,12],see:[0,2,3,5,6,8,9,10,11,12,13,14,16],seed:[2,12],select:[12,16],self:[0,3,8],self_energi:0,semiisotrop:[0,3],seminumer:0,sen:16,send:[0,3],separ:0,seri:[0,3,6,11],serial:[8,12],serialis:3,set:[0,3,10,12],set_fapl:8,setup:[0,6,7,8,15],setup_time_dependent_el:0,setuptool:8,sever:0,shape:[0,6,12,15],sheet:0,shift:0,should:[0,2,11],shown:6,siam:16,sigbj:16,sigma:[0,3,6,7,12,13,14],sim:0,similar:0,simpl:[0,6,12,14],simplest:6,simpli:0,simul:[0,2,6,8,11,13,14,15,16],simultan:0,sinc:0,singl:[0,3,6,10],site:8,size:[0,3,6,12,14],slbc23:16,slight:0,slowli:14,small:[3,12],smear:5,smooth:[0,14],sodium:6,soft:[6,16],softwar:16,solv:0,solvent:6,some:[0,3,8],sort:0,sort_dielectric_by_type_id:0,sourc:[0,1],space:[0,3,5,7],span:0,spatial:[0,3,12,14],specfi:0,speci:0,special:0,specif:[0,2,3,6,9,11,12,14,15],specifi:[0,2,3,6,9,11,12,15],spectacularli:0,spectral:6,speed:[0,3],spheric:6,spheroid:6,split:0,spontan:6,spring:[0,11],sqrt:[0,7,14],squar:[0,9],squaredphi:[0,3,9,12],stabil:6,stabl:6,stackoverflow:0,standard:[0,3,14,16],start:[0,3,6,11,15],start_temperatur:[0,3,6],state:0,statu:8,stdout:[0,2],step:[0,3,6,11,12],stiff:3,stochast:0,store:0,store_data:0,store_stat:0,str10:12,str:0,straightforward:[7,9],stream:0,strength:[0,3,6,12],stretch:[0,3,11,16],string:[0,3,8,12,15],structur:[0,2,3,5,6,12],sub:6,subclass:[0,9],subsequ:[0,5,6,11],sudo:8,suitabl:[0,3],sulfat:6,sum:0,sum_:[0,5,9,13,14],sum_i:0,sum_j:0,sum_k:0,sum_n:[0,6,11],sum_t:13,summari:12,superclass:[0,7],support:[0,6,8,10],swap:11,symbol:[0,4,9],sympi:[0,9],sys:8,system:[0,1,2,3,6,9,12,14,16],t_a:13,tag:[0,3,8],take:[0,3,5,9,11,12,14],taken:0,tar:8,target:[0,3,14],target_pressur:[0,3],target_temperatur:[0,3,6,12],tau:[0,3,6,12],tau_p:[0,3],tbm92:16,temperatur:[0,3,4,6,12,14],ten:6,term:[0,3,6,9,13,14],test:[0,1],text:[0,2,3,4,5,6,9,11,13,14],than:[0,3],theoj:16,theori:[0,13],therefor:[8,10],thermalis:[0,3],thermostat:[2,3,6,12],thermostat_coupling_group:[0,3,6],thermostat_work:0,theta:[6,11],theta_0:[0,6,11],thi:[0,2,3,6,8,9,10,11,12,14],thorough:12,though:6,thousand:[6,11],three:[0,2,3,6],through:[0,3,6,7,8,9,11,16],tild:[0,3,4,5,6,9,13,14],time:[0,3,4,6,11,12,16],time_step:[0,3,6,12],tmp:8,todo:0,togeth:[0,3,6],token:8,toml:[0,2,3,6,8,10,11,12],toml_cont:0,tomli:0,too:3,toplog:0,topol:0,topolog:[0,2,3,5,6,12,16],torsion:[0,3,11,16],total:[0,3,6,12,13,14],traceback:8,trajectori:[0,2,3,6,12],trans_matric:0,transfer:[0,11],transform:[0,9,14],travers:0,tree:0,tri:3,trivial:0,truncat:0,tuckerman:[3,16],turn:6,tutori:[6,8,12,15],two:[0,2,3,6],txt:12,type:[0,2,3,5,6,9,11,12,15],type_arrai:0,type_charg:0,type_to_name_map:0,typic:3,ubuntu:8,uio:[8,12,16],unchang:0,under:[6,8,14,16],uniformli:0,uninstal:8,union:0,uniqu:0,unique_nam:0,unit:[0,3,11],univers:16,unknown:0,unless:[0,3],unmodifi:0,unset:0,unstabl:3,until:6,updat:[0,8],update_field:0,update_field_force_q:0,update_field_force_q_gp:0,upgrad:[8,16],url:16,usag:[0,2],use:[0,3,5,6,8,10],used:[0,1,2,3,6,7,9,12,14,15],user:10,uses:[0,4,14,16],using:[0,2,3,8,14,16],usr:8,usual:12,v_2:[0,6,11],v_3:[0,6,11],v_4:[0,6,11],v_ext:0,v_ext_fouri:0,vacuum:4,valid:[0,3],validated_config:0,valu:[0,3,4,5,6,11],valueerror:8,van:0,vanish:0,varepsilon:0,varepsilon_0:[4,5],vari:14,variabl:[0,10],variant:6,variou:[0,15],vbar_elec:0,vbar_elec_fouri:0,vector:[3,11],vectoris:9,veloc:[0,2,3,4,6,12,15,16],velocity_out:0,velocti:0,verbos:[0,2,8,12],veri:[6,8,11],verifi:0,verlet:[0,3,6,12],versa:3,version:[0,6,8,10,12,14],vert:0,vertex:[0,5],vertic:0,via:[6,16],vice:3,vir:13,virial:13,vol:0,volum:[0,3,13,14,16],voxel:0,wai:[8,14],warn:0,weakli:3,weight:0,well:6,were:0,weslei:0,wether:0,wheel:8,when:[0,2,3,8,10,11],where:[0,5,9,11,13,14],whether:[0,3],which:[0,2,3,5,6,8,9,11,12,13],width:[0,3],window:[0,5,14],within:0,without:[0,16],work:[0,8,10],workload:0,would:[0,3],wrap:0,wrapper:0,write:[0,3],written:[0,3],www:[0,10],xinmeng:16,yet:0,yield:6,you:[8,10,11],your:10,zero:[0,3]},titles:["4. API reference","3. Benchmarks","5. Command line arguments","3. Configuration file","6. Constants and Units","3. Electrostatic interactions","1. Examples","2. Filtering","1. Installation","1. Interaction energy functionals","5. PLUMED interface","2. Intramolecular bonds","2. Usage overview for HylleraasMD","4. Pressure","1. Theory","4. Topology and structure file","HylleraasMD documentation"],titleterms:{"function":9,"import":8,"new":[7,9],"while":8,SDS:6,api:0,argument:2,assembl:6,barostat:0,benchmark:1,berendsen:0,bilay:6,bond:[1,3,11],build:8,calcul:14,chain:6,chi:9,code:16,colab:16,colaboratori:8,command:2,common:8,configur:3,constant:4,copolym:6,curl:8,dataset:15,depend:8,develop:16,diblock:6,docker:8,document:16,due:8,electrostat:[3,5],enabl:8,energi:9,error:8,exampl:6,extern:14,field:[0,1,3],file:[0,3,15],filter:[7,14],forc:[0,1,8,14],form:[9,14],fortran:8,four:11,gas:6,googl:[8,16],guid:16,h5py:8,hamiltonian:[0,14],helix:6,hylleraasmd:[12,16],hymd:[8,16],ideal:6,implement:[7,9],incompress:9,indic:16,input:0,instal:[8,16],integr:0,interact:[5,8,9],interfac:10,interpol:14,intramolecular:11,issu:8,kappa:9,kernel:8,keyword:3,line:2,lipid:6,logger:0,metadata:3,miss:8,mpi:8,numpi:8,onli:9,option:[2,15],output:0,overview:12,parallel:[8,12],parser:0,particl:[1,3,11],peptid:6,pfft:8,phase:6,phi:9,plume:[0,10],potenti:14,pressur:[0,3,13],python:8,reciproc:14,refer:[0,16],requir:[2,15],rod:6,run:[8,10,12,16],scr:0,self:6,separ:6,simul:[3,10,12],sourc:16,space:14,specifi:5,stiff:6,structur:15,tabl:16,test:12,theori:14,thermostat:0,three:11,topolog:15,two:11,unit:4,usag:12,user:16,using:10,wget:8,without:8}}) \ No newline at end of file diff --git a/v1.0.1/.buildinfo b/v1.0.1/.buildinfo new file mode 100644 index 00000000..e55e7180 --- /dev/null +++ b/v1.0.1/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: da221445b6f9d62ecc1485821fe921d8 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v1.0.1/.doctrees/doc_pages/api.doctree b/v1.0.1/.doctrees/doc_pages/api.doctree new file mode 100644 index 00000000..a7174190 Binary files /dev/null and b/v1.0.1/.doctrees/doc_pages/api.doctree differ diff --git a/v1.0.1/.doctrees/doc_pages/benchmarks.doctree b/v1.0.1/.doctrees/doc_pages/benchmarks.doctree new file mode 100644 index 00000000..25708cf0 Binary files /dev/null and b/v1.0.1/.doctrees/doc_pages/benchmarks.doctree differ diff --git a/v1.0.1/.doctrees/doc_pages/command_line.doctree b/v1.0.1/.doctrees/doc_pages/command_line.doctree new file mode 100644 index 00000000..0435fbe9 Binary files /dev/null and b/v1.0.1/.doctrees/doc_pages/command_line.doctree differ diff --git a/v1.0.1/.doctrees/doc_pages/config_file.doctree b/v1.0.1/.doctrees/doc_pages/config_file.doctree new file mode 100644 index 00000000..12c7eff8 Binary files /dev/null and b/v1.0.1/.doctrees/doc_pages/config_file.doctree differ diff --git a/v1.0.1/.doctrees/doc_pages/constants_and_units.doctree b/v1.0.1/.doctrees/doc_pages/constants_and_units.doctree new file mode 100644 index 00000000..b85c6981 Binary files /dev/null and b/v1.0.1/.doctrees/doc_pages/constants_and_units.doctree differ diff --git a/v1.0.1/.doctrees/doc_pages/electrostatics.doctree b/v1.0.1/.doctrees/doc_pages/electrostatics.doctree new file mode 100644 index 00000000..0ce8e728 Binary files /dev/null and b/v1.0.1/.doctrees/doc_pages/electrostatics.doctree differ diff --git a/v1.0.1/.doctrees/doc_pages/examples.doctree b/v1.0.1/.doctrees/doc_pages/examples.doctree new file mode 100644 index 00000000..e722b0a6 Binary files /dev/null and b/v1.0.1/.doctrees/doc_pages/examples.doctree differ diff --git a/v1.0.1/.doctrees/doc_pages/filtering.doctree b/v1.0.1/.doctrees/doc_pages/filtering.doctree new file mode 100644 index 00000000..c5610a0e Binary files /dev/null and b/v1.0.1/.doctrees/doc_pages/filtering.doctree differ diff --git a/v1.0.1/.doctrees/doc_pages/installation.doctree b/v1.0.1/.doctrees/doc_pages/installation.doctree new file mode 100644 index 00000000..1c1ff94f Binary files /dev/null and b/v1.0.1/.doctrees/doc_pages/installation.doctree differ diff --git a/v1.0.1/.doctrees/doc_pages/interaction_energy_functionals.doctree b/v1.0.1/.doctrees/doc_pages/interaction_energy_functionals.doctree new file mode 100644 index 00000000..bb7fb48c Binary files /dev/null and b/v1.0.1/.doctrees/doc_pages/interaction_energy_functionals.doctree differ diff --git a/v1.0.1/.doctrees/doc_pages/intramolecular_bonds.doctree b/v1.0.1/.doctrees/doc_pages/intramolecular_bonds.doctree new file mode 100644 index 00000000..0f70c805 Binary files /dev/null and b/v1.0.1/.doctrees/doc_pages/intramolecular_bonds.doctree differ diff --git a/v1.0.1/.doctrees/doc_pages/overview.doctree b/v1.0.1/.doctrees/doc_pages/overview.doctree new file mode 100644 index 00000000..dab0c4df Binary files /dev/null and b/v1.0.1/.doctrees/doc_pages/overview.doctree differ diff --git a/v1.0.1/.doctrees/doc_pages/theory.doctree b/v1.0.1/.doctrees/doc_pages/theory.doctree new file mode 100644 index 00000000..d80ee166 Binary files /dev/null and b/v1.0.1/.doctrees/doc_pages/theory.doctree differ diff --git a/v1.0.1/.doctrees/doc_pages/topology_input.doctree b/v1.0.1/.doctrees/doc_pages/topology_input.doctree new file mode 100644 index 00000000..2c3c75dd Binary files /dev/null and b/v1.0.1/.doctrees/doc_pages/topology_input.doctree differ diff --git a/v1.0.1/.doctrees/environment.pickle b/v1.0.1/.doctrees/environment.pickle new file mode 100644 index 00000000..3bb54c4c Binary files /dev/null and b/v1.0.1/.doctrees/environment.pickle differ diff --git a/v1.0.1/.doctrees/index.doctree b/v1.0.1/.doctrees/index.doctree new file mode 100644 index 00000000..71d5034f Binary files /dev/null and b/v1.0.1/.doctrees/index.doctree differ diff --git a/v1.0.1/_downloads/05e020d3665b48a52ef1f1737dbefad6/benchmarks-1.png b/v1.0.1/_downloads/05e020d3665b48a52ef1f1737dbefad6/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.1/_downloads/05e020d3665b48a52ef1f1737dbefad6/benchmarks-1.png differ diff --git a/v1.0.1/_downloads/39fb6882b2fb79b690730abc32e6ba81/benchmarks-2.hires.png b/v1.0.1/_downloads/39fb6882b2fb79b690730abc32e6ba81/benchmarks-2.hires.png new file mode 100644 index 00000000..d8487c6d Binary files /dev/null and b/v1.0.1/_downloads/39fb6882b2fb79b690730abc32e6ba81/benchmarks-2.hires.png differ diff --git a/v1.0.1/_downloads/59e0c180b0e61e7945b9fb3eb4595fca/benchmarks-1.pdf b/v1.0.1/_downloads/59e0c180b0e61e7945b9fb3eb4595fca/benchmarks-1.pdf new file mode 100644 index 00000000..7a4e9bee Binary files /dev/null and b/v1.0.1/_downloads/59e0c180b0e61e7945b9fb3eb4595fca/benchmarks-1.pdf differ diff --git a/v1.0.1/_downloads/9c4399c0e4a420b984d31a0c6d2a3d18/benchmarks-2.pdf b/v1.0.1/_downloads/9c4399c0e4a420b984d31a0c6d2a3d18/benchmarks-2.pdf new file mode 100644 index 00000000..d029aee9 Binary files /dev/null and b/v1.0.1/_downloads/9c4399c0e4a420b984d31a0c6d2a3d18/benchmarks-2.pdf differ diff --git a/v1.0.1/_downloads/b11d2238d2d1c44d110e59c683970d70/benchmarks-2.png b/v1.0.1/_downloads/b11d2238d2d1c44d110e59c683970d70/benchmarks-2.png new file mode 100644 index 00000000..d3c84f99 Binary files /dev/null and b/v1.0.1/_downloads/b11d2238d2d1c44d110e59c683970d70/benchmarks-2.png differ diff --git a/v1.0.1/_downloads/b8a92a1a0f898ca7805f0adcf18bb222/benchmarks-1.hires.png b/v1.0.1/_downloads/b8a92a1a0f898ca7805f0adcf18bb222/benchmarks-1.hires.png new file mode 100644 index 00000000..173b39f3 Binary files /dev/null and b/v1.0.1/_downloads/b8a92a1a0f898ca7805f0adcf18bb222/benchmarks-1.hires.png differ diff --git a/v1.0.1/_downloads/e3e4a2b9b7e70f7fd74978fade84b7b8/benchmarks-1.py b/v1.0.1/_downloads/e3e4a2b9b7e70f7fd74978fade84b7b8/benchmarks-1.py new file mode 100644 index 00000000..deb4348f --- /dev/null +++ b/v1.0.1/_downloads/e3e4a2b9b7e70f7fd74978fade84b7b8/benchmarks-1.py @@ -0,0 +1,38 @@ +import numpy as np +import matplotlib.pyplot as plt +nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) +time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 +], dtype=np.float64) +nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 +], dtype=np.float64,) +time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, +], dtype=np.float64) +nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 +], dtype=np.float64) +time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, +], dtype=np.float64) +plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" +) +plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" +) +plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" +) +plt.xlabel("CPUs", fontsize=15) +plt.ylabel("Time per step, us", fontsize=15) +plt.legend(fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.show() \ No newline at end of file diff --git a/v1.0.1/_downloads/ecb3234ae9a71531d61c83c8ce4c0476/benchmarks-2.py b/v1.0.1/_downloads/ecb3234ae9a71531d61c83c8ce4c0476/benchmarks-2.py new file mode 100644 index 00000000..60b3af65 --- /dev/null +++ b/v1.0.1/_downloads/ecb3234ae9a71531d61c83c8ce4c0476/benchmarks-2.py @@ -0,0 +1,33 @@ +import numpy as np +import matplotlib.pyplot as plt + +mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] +mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + +mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + +mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + +mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] +mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + +mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + +mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + +plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048²") +plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024²") +plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512²") +plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256²") +plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128²") +plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64²") +plt.xlabel("CPUs", fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.ylabel("Time per step, s", fontsize=15) +plt.legend(loc="upper left", fontsize=15) +plt.show() \ No newline at end of file diff --git a/v1.0.1/_images/benchmarks-1.png b/v1.0.1/_images/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.1/_images/benchmarks-1.png differ diff --git a/v1.0.1/_images/benchmarks-2.png b/v1.0.1/_images/benchmarks-2.png new file mode 100644 index 00000000..d3c84f99 Binary files /dev/null and b/v1.0.1/_images/benchmarks-2.png differ diff --git a/v1.0.1/_images/hylleraas_centre_logo_black.png b/v1.0.1/_images/hylleraas_centre_logo_black.png new file mode 100644 index 00000000..40826396 Binary files /dev/null and b/v1.0.1/_images/hylleraas_centre_logo_black.png differ diff --git a/v1.0.1/_images/uio_full_logo_eng_pos.png b/v1.0.1/_images/uio_full_logo_eng_pos.png new file mode 100644 index 00000000..6c603139 Binary files /dev/null and b/v1.0.1/_images/uio_full_logo_eng_pos.png differ diff --git a/v1.0.1/_modules/hymd/field.html b/v1.0.1/_modules/hymd/field.html new file mode 100644 index 00000000..92861da9 --- /dev/null +++ b/v1.0.1/_modules/hymd/field.html @@ -0,0 +1,1450 @@ + + + + + + hymd.field — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.field

+"""Forces and energies from the discretized particle-field grid interactions
+"""
+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import warnings
+
+
+
[docs]def initialize_pm(pmesh, config, comm=MPI.COMM_WORLD): + """ + Creates the necessary pmesh objects for pfft operations. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + config : Config + Configuration dataclass containing simulation metadata and parameters. + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm : object 'pmesh.pm.ParticleMesh' + field_list : list[pmesh.pm.RealField], (multiple) + Essential list of pmesh objects required for MD + list_coulomb : list[pmesh.pm.RealField], (multiple) + Additional list of pmesh objects required for electrostatics. + """ + + if config.dtype == np.float64: + pmeshtype = "f8" + else: + pmeshtype = "f4" + # Ignore numpy numpy.VisibleDeprecationWarning: Creating an ndarray from + # ragged nested sequences until it is fixed in pmesh + with warnings.catch_warnings(): + warnings.filterwarnings( + action="ignore", + category=np.VisibleDeprecationWarning, + message=r"Creating an ndarray from ragged nested sequences", + ) + # The first argument of ParticleMesh has to be a tuple + pm = pmesh.ParticleMesh( + config.mesh_size, BoxSize=config.box_size, dtype=pmeshtype, comm=comm + ) + phi = [pm.create("real", value=0.0) for _ in range(config.n_types)] + phi_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] # noqa: E501 + force_on_grid = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + v_ext_fourier = [pm.create("complex", value=0.0) for _ in range(4)] + v_ext = [pm.create("real", value=0.0) for _ in range(config.n_types)] + + phi_transfer = [pm.create("complex", value=0.0) for _ in range(3)] + + phi_laplacian = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + + # Initialize charge density fields + coulomb_list = [] + elec_common_list = [None, None, None, None] + _SPACE_DIM = config.box_size.size + + if config.coulombtype == "PIC_Spectral_GPE" or config.coulombtype == "PIC_Spectral": + phi_q = pm.create("real", value=0.0) + phi_q_fourier = pm.create("complex", value=0.0) + psi = pm.create("real", value=0.0) + elec_field = [pm.create("real", value=0.0) for _ in range(_SPACE_DIM)] + + elec_common_list = [phi_q, phi_q_fourier, psi, elec_field] + + if config.coulombtype == "PIC_Spectral": + elec_field_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] # for force calculation + psi_fourier = pm.create("complex", value=0.0) + + coulomb_list = [ + elec_field_fourier, + psi_fourier, + ] + + if ( + config.coulombtype == "PIC_Spectral_GPE" + ): ## initializing the density mesh #dielectric_flag + phi_eps = pm.create( + "real", value=0.0 + ) ## real contrib of the epsilon dielectric painted to grid + phi_eps_fourier = pm.create("complex", value=0.0) # complex contrib of phi eps + phi_eta = [ + pm.create("real", value=0.0) for _ in range(_SPACE_DIM) + ] ## real contrib of factor in polarization charge density + phi_eta_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] ## fourier of factor in polarization charge density + phi_pol = pm.create( + "real", value=0.0 + ) ## real contrib of the polarization charge + phi_pol_prev = pm.create("real", value=0.0) + elec_dot = pm.create("real", value=0.0) + elec_field_contrib = pm.create( + "real", value=0.0 + ) # needed for pol energies later + + # External potential and force meshes + Vbar_elec = [pm.create("real", value=0.0) for _ in range(config.n_types)] + Vbar_elec_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] + force_mesh_elec = [ + [pm.create("real", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + force_mesh_elec_fourier = [ + [pm.create("complex", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + + coulomb_list = [ + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol, + phi_pol_prev, + elec_dot, + elec_field_contrib, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + ] + + field_list = [ + phi, + phi_fourier, + force_on_grid, + v_ext_fourier, + v_ext, + phi_transfer, + phi_laplacian, + ] + + return (pm, field_list, elec_common_list, coulomb_list)
+ + +
[docs]def compute_field_force(layouts, r, force_mesh, force, types, n_types): + """Interpolate particle-field forces from the grid onto particle positions + + Backmaps the forces calculated on the grid to particle positions using the + window function :math:`P` (by default cloud-in-cell [CIC]). In the + following, let :math:`\\mathbf{F}_j` denote the force acting on the + particle with index :math:`j` and position :math:`\\mathbf{r}_j`. The + interpolated force is + + .. math:: + + \\mathbf{F}_j = -\\sum_k\\nabla V_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`V_{j_k}` is the discretized external potential at grid vertex + :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid vertex + with index :math:`j_k`, and :math:`h^3` is the volume of each grid voxel. + The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + r : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + force : (N,D) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. Local + for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + n_types : int + Number of different unique types present in the simulation system. + :code:`n_types` is global, i.e. the same for all MPI ranks even if some + ranks contain zero particles of certain types. + """ + for t in range(n_types): + ind = types == t + for d in range(3): + force[ind, d] = force_mesh[t][d].readout(r[ind], layout=layouts[t])
+ + +
[docs]def compute_self_energy_q(config, charges, comm=MPI.COMM_WORLD): + """Compute the self energy for the interaction due to the Ewald scheme + used to compute the electrostatics. The energy is stored in :code:`config`. + + The self interaction energy is given by: + + .. math:: + + U_{self} = \\sqrt{\\frac{1}{2\\pi\\sigma^2}} \\sum_{i=1}^{N} q_i^2 + + where :math:`q_i` are the charges and :math:`\\sigma` is the half-width + of the Gaussian filter. + + Parameters + ---------- + config : Config + Configuration object. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + comm : mpi4py.Comm + MPI communicator to use for rank communication. + + Returns + ------- + field_q_self_energy : float + Electrostatic self energy. + """ + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + prefac = elec_conversion_factor * np.sqrt( + 1.0 / (2.0 * np.pi * config.sigma * config.sigma) + ) + _squared_charges = charges * charges + squared_charges_sum = comm.allreduce(np.sum(_squared_charges)) + return prefac * squared_charges_sum
+ + +
[docs]def update_field_force_q( + charges, + phi_q, + phi_q_fourier, + psi, + psi_fourier, + elec_field_fourier, + elec_field, + elec_forces, + layout_q, + hamiltonian, + pm, + positions, + config, +): + """Calculate the electrostatic particle-field forces on the grid + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential is computed in reciprocal space as + + .. math:: + + \\Phi = \\mathrm{FFT}^{-1}\\left[ + \\frac{4\\pi k_e}{\\varepsilon \\vert\\mathbf{k}\\vert^2} + \\mathrm{FFT}(\\rho)\\mathrm{FFT}(H) + \\right], + + with the electric field + + .. math:: + + \\mathbf{E} = \\mathrm{FFT}^{-1}\\left[ + -i\\mathbf{k}\\,\\mathrm{FFT}(\\Psi) + \\right]. + + In the following, let :math:`\\mathbf{F}_j` denote the electrostatic force + acting on the particle with index :math:`j` and position + :math:`\\mathbf{r}_j`. The interpolated electrostatic force is + + .. math:: + + \\mathbf{F}_j = \\sum_k q_j\\mathbf{E}_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`\\mathbf{E}_{j_k}` is the discretized electric field at grid + vertex :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid + vertex with index :math:`j_k`, and :math:`h^3` is the volume of each grid + voxel. The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty; any values in this field + are discarded. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + elec_field_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + electric field values in reciprocal space on the computational grid. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + n_dimensions = config.box_size.size + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + # charges to grid + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) + phi_q /= volume_per_cell + # print("phi_q", np.sum(phi_q)) + phi_q.r2c(out=phi_q_fourier) + + # smear charges with filter + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + + # solve Poisson equation in Fourier space to get electrostatic potential + def poisson_transfer_function(k, v): + return 4.0 * np.pi * elec_conversion_factor * v / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(poisson_transfer_function, out=psi_fourier) + # print("psi_fourier", np.sum(psi_fourier)) + psi_fourier.c2r(out=psi) + # print("phi_q * psi update_field", np.sum(phi_q * psi)) + + # exit() + + # compute electric field directly from smeared charged densities in Fourier + for _d in np.arange(n_dimensions): + + def poisson_transfer_function(k, v, d=_d): + return ( + -1j + * k[d] + * 4.0 + * np.pi + * elec_conversion_factor + * v + / k.normp(p=2, zeromode=1) + ) + + phi_q_fourier.apply(poisson_transfer_function, out=elec_field_fourier[_d]) + elec_field_fourier[_d].c2r(out=elec_field[_d]) + + # get electrostatic force from electric field + for _d in np.arange(n_dimensions): + elec_forces[:, _d] = charges * ( + elec_field[_d].readout(positions, layout=layout_q) + )
+ + +def comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, +): + for t in range(config.n_types): + np.copyto(phi_transfer[0].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[1].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[2].value, phi_fourier[t].value, casting="no", where=True) + + # Evaluate laplacian of phi in fourier space + for d in range(3): + + def laplacian_transfer(k, v, d=d): + return -k[d] ** 2 * v + + phi_transfer[d].apply(laplacian_transfer, out=Ellipsis) + phi_transfer[d].c2r(out=phi_laplacian[t][d]) + + +
[docs]def update_field( + phi, + phi_laplacian, + phi_transfer, + layouts, + force_mesh, + hamiltonian, + pm, + positions, + types, + config, + v_ext, + phi_fourier, + v_ext_fourier, + m, + compute_potential=False, +): + """Calculate the particle-field potential and force density + + If :code:`compute_potential` is :code:`True`, the energy may subsequently + be computed by calling :code:`compute_field_and_kinetic_energy`. + + Computes the particle-field external potential :math:`V_\\text{ext}` from + particle number densities through the smoothed density field, + :math:`\\phi(\\mathbf{r})`. With :math:`P` being the cloud-in-cell (CIC) + window function, the density and filtered densities are computed as + + .. math:: + + \\phi(\\mathbf{r}) = \\sum_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\phi(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\phi(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + external potential is computed in reciprocal space as + + .. math:: + + V_\\text{ext} = \\mathrm{FFT}^{-1}\\left[ + \\mathrm{FFT} + \\left( + \\frac{\\partial w}{\\partial \\tilde\\phi} + \\right) + \\mathrm{FFT}(H) + \\right], + + where :math:`w` is the interaction energy functional. Differentiating + :math:`V_\\text{ext}` is done by simply applying :math:`i\\mathbf{k}` in + Fourier space, and the resulting forces are back-transformed to direct + space and interpolated to particle positions by + + .. math:: + + \\mathbf{F}_j = -\\sum_{j_k} \\nabla V_{j_k} + P(\\mathbf{r}_{j_k} - \\mathbf{r}_j)h^3, + + where :math:`j_k` are the neighbouring vertices of particle :math:`j` at + position :math:`\\mathbf{r}_j`, and :math:`h^3` is the volume of each grid + voxel. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Pre-allocated, but empty; any values + in this field are discarded. Changed in-place. Local for each MPI + rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + config : Config + Configuration object. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Pre-allocated, but empty; any values in this field are + discarded Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + phi_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computational grid is represented by the collective fields of all + MPI ranks. + v_ext_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplesField` objects containing discretized + particle-field external potential values in reciprocal space on the + computational grid; :code:`D+1` fields in D dimensions for each + particle type. :code:`D` copies are made after calculation for later + use in force calculation, because the `force transfer function` + application differentiates the field in-place, ruining the contents + for differentiation in the remaining :code:`D-1` spatial directions. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + m: list[float], (M,) + pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. + Defaults to 1.0 for all particle types. + compute_potential : bool, optional + If :code:`True`, a :code:`D+1`-th copy of the Fourier transformed + external potential field is made to be used later in particle-field + energy calculation. If :code:`False`, only :code:`D` copies are made. + + See also + -------- + compute_field_and_kinetic_energy : + Compute the particle-field energy after the external potential is + calculated. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + for t in range(config.n_types): + pm.paint(positions[types == t], mass=m[t], layout=layouts[t], out=phi[t]) + phi[t] /= volume_per_cell + phi[t].r2c(out=phi_fourier[t]) + phi_fourier[t].apply(hamiltonian.H, out=Ellipsis) + phi_fourier[t].c2r(out=phi[t]) + + # External potential + for t in range(config.n_types): + v = hamiltonian.v_ext[t](phi) + + v.r2c(out=v_ext_fourier[0]) + v_ext_fourier[0].apply(hamiltonian.H, out=Ellipsis) + np.copyto( + v_ext_fourier[1].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + np.copyto( + v_ext_fourier[2].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + if compute_potential: + np.copyto( + v_ext_fourier[3].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + + # Differentiate the external potential in fourier space + for d in range(3): + + def force_transfer_function(k, v, d=d): + return -k[d] * 1j * v + + v_ext_fourier[d].apply(force_transfer_function, out=Ellipsis) + v_ext_fourier[d].c2r(out=force_mesh[t][d]) + + if compute_potential: + v_ext_fourier[3].c2r(out=v_ext[t])
+ + +
[docs]def compute_field_and_kinetic_energy( + phi, + phi_q, + psi, + velocity, + hamiltonian, + positions, + types, + v_ext, + config, + layouts, + comm=MPI.COMM_WORLD, +): + """Compute the particle-field and kinetic energy contributions + + Calculates the kinetic energy through + + .. math:: + + E_k = \\sum_j \\frac{1}{2}m_j\\mathbf{v}_j\\cdot\\mathbf{v}_j, + + and the particle-field energy by + + .. math:: + + E_\\text{field} = \\int\\mathrm{d}\\mathbf{r}\\, + w[\\tilde\\phi], + + where :math:`w` is the interaction energy functional `density`. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + velocity : (N,D) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Local for each MPI rank--the full computational grid is + represented by the collective fields of all MPI ranks. + config : Config + Configuration object. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field : + Computes the up-to-date external potential for use in calculating the + particle-field energy. + """ + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + field_energy = w_0.csum() # w to W + + kinetic_energy = comm.allreduce(0.5 * config.mass * np.sum(velocity**2)) + + if config.coulombtype == "PIC_Spectral": + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + field_q_energy = w_elec.csum() + else: + field_q_energy = 0.0 + + return field_energy, kinetic_energy, field_q_energy
+ + +
[docs]def compute_field_energy_q_GPE( + config, + phi_eps, + field_q_energy, + dot_elec, + comm=MPI.COMM_WORLD, +): + """ + Compute the electrostatic energy after electrosatic forces is + calculated. + + From the definition of the elecrostatic potential :math:`\\Psi`, the energy + is + + W = \\frac{1}{2}\\int\\mathrm{d}\\mathbf{r}\\, + \\epsilon(\\mathbf{r})} \\left(\\mathbf{E}\\cdot \\mathbf{E}\\right), + + where :math:`\\epsilon(\\mathbf{r})}` is the anisotropic, spatially dependent, + relative dielectric of the simulation medium. + + Parameters + ---------- + config : hymd.input_parser.Config + Configuration object. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + field_q_energy : float + Total elecrostatic energy. + dot_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing :math:`|\\mathbf{E(r)}|^{2}` + on the computational grid. Local for each MPI rank -- the full computational + grid is represented by the collective fields of all MPI ranks. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field_force_q_GPE: + Compute the electrosatic force from an anisotropic dielectric general + Poisson equation. + """ + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + # ^ due to integration on local cell before allreduce + + eps_0 = 1.0 / (config.coulomb_constant * 4 * np.pi) + field_q_energy = ( + volume_per_cell * (0.5 * eps_0) * comm.allreduce(np.sum(phi_eps * dot_elec)) + ) + + return field_q_energy
+ + +
[docs]def update_field_force_q_GPE( + conv_fun, + phi, + types, + charges, + phi_q, + phi_q_fourier, + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol_prev, + phi_pol, + elec_field, + elec_forces, + elec_field_contrib, + psi, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + hamiltonian, + layout_q, + layouts, + pm, + positions, + config, + comm=MPI.COMM_WORLD, +): + """ + Calculate the electrostatic particle-field forces on the grid, arising from + a general Poisson equation, i.e. anisotropic permittivity/dielectric. + The function is called when tomli input config.coulombtype = "PIC_Spectral_GPE." + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential for a variable dielectric does not have an + analytical expression, and is computed in reciprocal through an iterative + method. + + The GPE states that + + .. math:: + + \\nabla \\cdot \\left(\\epsilon(\\mathbf{r}) + \\nabla{\\mathbf{\\psi(r)}}\\right) = -\\rho({\\mathbf{r}}). + + where :math:`\\epsilon(\\mathbf{r})` is the relative dielectric function. + + Parameters + ---------- + conv_fun : Convergence function. + Returns a scalar. Depends on MPI allreduce for similar convergence + across MPI ranks. + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_eta : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + gradients of the relative dielectric values on the computational grid. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank--the + full computational grid is represented by the collective fields of all MPI ranks. + phi_eta_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated discretized + Fourier transformed gradient relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol_prev : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charge values on the computational grid. Parameter in + the iterative method.Pre-allocated,but empty. Changedin-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charges on the computational grid. Parameter in the iterative + method, updating the next quess in solving for the electrostatic potential. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all + MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + elec_field_contrib : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing + :math:`|\\mathbf{E(r)}|^2/\\phi_{0}` on the computational grid. + Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + psi : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic potential + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + Vbar_elec : mesh.pm.RealField + Pmesh :code:`RealField` object for storing functional derivatives of + :math:`\\|w(\\{ \\phi \\})_{elec}`on the computational grid. + Pre-allocated, but empty. Changed in-place. Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + Vbar_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated functional + derivatives of :math:`\\|w(\\{ \\phi \\})_{elec}` in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + force_mesh_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic force values + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + force_mesh_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated electrostatic + force values in reciprocal space on the computational grid. Local for + each MPI rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + layouts: list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + comm: mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + compute_field_energy_q_GPE: + Compute the electrostatic energy after electrosatic force is + calculated for a variable (anisotropic) dielectric general Poisson equation. + """ + + ## basic setup + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + ## old protocol in gen_qe_hpf_use_self + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) ## + ## scale and fft + ## old protocol in gen_qe_hpf_use_self + phi_q /= volume_per_cell + phi_q.r2c(out=phi_q_fourier) + + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + ## ^------ use the same gaussian as the \kai interaciton + phi_q_fourier.c2r(out=phi_q) ## this phi_q is after applying the smearing function + + denom_phi_tot = pm.create("real", value=0.0) + num_types = pm.create("real", value=0.0) + ### ^ ----- Calculate the relative dielectric (permittivity) to field + ### ------- from a mean contribution of particle number densities + + for t_ in range(config.n_types): + num_types = num_types + (config.dielectric_type[t_]) * phi[t_] + denom_phi_tot = denom_phi_tot + phi[t_] + + np.divide(num_types, denom_phi_tot, where=np.abs(denom_phi_tot > 1e-6), out=phi_eps) + + phi_eps.r2c(out=phi_eps_fourier) # FFT dielectric + + # phi_q_eps = (phi_q/phi_eps) + np.divide(phi_q, phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_q) + + _SPACE_DIM = 3 + ##^--------- constants needed throughout the calculations + + ### method for finding the gradient (fourier space), using the spatial dimension of k + for _d in np.arange(_SPACE_DIM): + + def gradient_transfer_function(k, x, d=_d): + return 1j * k[d] * x + + phi_eps_fourier.apply(gradient_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=phi_eta[_d]) + np.divide(phi_eta[_d], phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_eta[_d]) + + ### iterative GPE solver ### + ### ---------------------------------------------- + max_iter = 100 + i = 0 + delta = 1.0 + # phi_pol_prev = pm.create("real", value = 0.0) + ### ^------ set to zero before each iterative procedure or soft start + conv_criteria = config.conv_crit # conv. criteria (default 1e-6) + w = config.pol_mixing # polarization mixing param (default 0.6) + while i < max_iter and delta > conv_criteria: + (phi_q + phi_pol_prev).r2c(out=phi_q_fourier) + for _d in np.arange(_SPACE_DIM): + + def iterate_apply_k_vec(k, additive_terms, d=_d): + return additive_terms * (-1j * k[d]) / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(iterate_apply_k_vec, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + + phi_pol = -( + phi_eta[0] * elec_field[0] + + phi_eta[1] * elec_field[1] + + phi_eta[2] * elec_field[2] + ) + ### ^-- Following a negative sign convention (-ik) of the FT, a neg sign is + ### --- mathematically correct by the definition of the GPE (double - -> +) + phi_pol = w * phi_pol + (1.0 - w) * phi_pol_prev + diff = np.abs(phi_pol - phi_pol_prev) + delta = conv_fun(comm, diff) # decided from toml input + phi_pol_prev = phi_pol.copy() + i = i + 1 + # print("Stopping after iteration {:d} with stop crit {:.2e}, delta {:.2e}".format(i,conv_criteria,delta)) + + # compute_potential = True + def k_norm_divide(k, potential): + return potential / k.normp(p=2, zeromode=1) + + ## > Electrostatic potential + eps0_inv = config.coulomb_constant * 4 * np.pi + ## ^ the 1/(4pi eps0)*4*pi = 1/eps0 + ((eps0_inv) * (phi_q + phi_pol)).r2c(out=phi_q_fourier) + phi_q_fourier.apply(k_norm_divide, out=phi_q_fourier) + phi_q_fourier.c2r(out=psi) + ### ^ electrostatic potential for the GPE + + for _d in np.arange(_SPACE_DIM): + + def field_transfer_function(k, x, d=_d): + return ( + -1j * k[d] * x + ) ## negative sign relation, due to E = - nabla psi relation + + phi_q_fourier.apply(field_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + ## ^-------- Method: Obtaining the electric field from electrostatic potential + ## Assuming the electric field is conserved. + ## Assumption holds if no magnetic flux (magnetic induced fields) + + ############## Obtain forces ############## + elec_dot = ( + elec_field[0] * elec_field[0] + + elec_field[1] * elec_field[1] + + elec_field[2] * elec_field[2] + ) + # needed for energy calculations + + np.divide( + elec_dot, + denom_phi_tot, + where=np.abs(denom_phi_tot > 1e-6), + out=elec_field_contrib, + ) + + eps0_inv = config.coulomb_constant * 4 * np.pi + + for t_ in range(config.n_types): + Vbar_elec[t_] = ( + config.type_charges[t_] * psi + - (0.5 / eps0_inv) + * (config.dielectric_type[t_] - phi_eps) + * elec_field_contrib + ) + + # Obtain Vext,k + for t_ in range(config.n_types): + Vbar_elec[t_].r2c(out=Vbar_elec_fourier[t_]) + Vbar_elec_fourier[t_].apply(hamiltonian.H, out=Vbar_elec_fourier[t_]) + + # force terms + # F = - grad Vext + for t_ in range(config.n_types): + for _d in np.arange(_SPACE_DIM): + + def force_transfer_function(k, x, d=_d): + return -1j * k[_d] * x ## negative gradient + + Vbar_elec_fourier[t_].apply( + force_transfer_function, out=force_mesh_elec_fourier[t_][_d] + ) + force_mesh_elec_fourier[t_][_d].c2r(out=force_mesh_elec[t_][_d]) + elec_forces[types == t_, _d] = force_mesh_elec[t_][_d].readout( + positions[types == t_], layout=layouts[t_] + ) + + return Vbar_elec, phi_eps, elec_dot
+ + +
[docs]def domain_decomposition( + positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=MPI.COMM_WORLD +): + """Performs domain decomposition + + Rearranges the MPI rank memory layout into one that better mimics the PFFT + pencil grid 2D decomposition. As molecules are always required to be fully + contained on a single MPI rank, a perfect decomposition is not always + possible. The best decomposition which leaves the center of mass of all + molecules in their respective correct domains is used, with possible + overlap into neighbouring domains if the spatial extent of any molecule + crosses domain boundaries. + + Parameters + ---------- + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + *args + Variable length argument list containing arrays to include in the + domain decomposition. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + bonds : (N,M) numpy.ndarray, optional + Array of :code:`M` bonds originating from each of :code:`N` particles. + verbose : int, optional + Specify the logging event verbosity of this function. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + Domain decomposed :code:`positions` and any array specified in + :code:`*args`, in addition to :code:`bonds` and :code:`molecules` if these + arrays were provided as input. + """ + if molecules is not None: + if not topol: + assert bonds is not None, "bonds must be provided with molecules" + unique_molecules = np.sort(np.unique(molecules)) + molecules_com = np.empty_like(positions) + for m in unique_molecules: + ind = molecules == m + r = positions[ind, :][0, :] + molecules_com[ind, :] = r + layout = pm.decompose(molecules_com, smoothing=0) + if not topol: + args = (*args, bonds, molecules) + else: + args = (*args, molecules) + else: + layout = pm.decompose(positions, smoothing=0) + if verbose > 1: + Logger.rank0.log( + logging.INFO, + "DOMAIN_DECOMP: Total number of particles to be exchanged = %d", + np.sum(layout.get_exchange_cost()), + ) + return layout.exchange(positions, *args)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/_modules/hymd/file_io.html b/v1.0.1/_modules/hymd/file_io.html new file mode 100644 index 00000000..a150037c --- /dev/null +++ b/v1.0.1/_modules/hymd/file_io.html @@ -0,0 +1,1146 @@ + + + + + + hymd.file_io — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.file_io

+"""Handle file input/output in parllel HDF5 fashion
+"""
+import numpy as np
+import h5py
+import os
+import logging
+import getpass
+from mpi4py import MPI
+from .logger import Logger, get_version
+
+
+
[docs]class OutDataset: + """HDF5 dataset handler for file output""" + + def __init__( + self, + dest_directory, + config, + double_out=False, + disable_mpio=False, + comm=MPI.COMM_WORLD, + ): + """Constructor + + Parameters + ---------- + dest_directory : str + Ouput directory for saving data. + config : Config + Configuration object. + double_out : bool, optional + If :code:`True`, the output HDF5 objects are written in eight byte + floating point representation. Otherwise, four byte single + precision is used. + disable_mpio : bool, optional + If :code:`True`, disables parallel MPI-enabled HDF5 file output. + This is a compatibility option used if HDF5 is not compiled with + MPI support. This makes everything much harder by splitting all + output in one file per MPI rank, and having an MPI-enabled HDF5 + library is **highly recommended**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + """ + self.disable_mpio = disable_mpio + self.config = config + if double_out: + self.float_dtype = "float64" + else: + self.float_dtype = "float32" + + if disable_mpio: + self.file = h5py.File( + os.path.join( + dest_directory, f"sim.hdf5-{comm.rank:6d}-of-{comm.size:6d}" + ), + "w", + ) + else: + self.file = h5py.File( + os.path.join(dest_directory, "sim.H5"), "w", driver="mpio", comm=comm + ) + +
[docs] def is_open(self, comm=MPI.COMM_WORLD): + """Check if HDF5 output file is open + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + return self.file.__bool__()
+ +
[docs] def close_file(self, comm=MPI.COMM_WORLD): + """Closes the HDF5 output file + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + self.file.close()
+ +
[docs] def flush(self): + """Flushes output buffers, forcing file writes""" + self.file.flush()
+ + +
[docs]def setup_time_dependent_element( + name, parent_group, n_frames, shape, dtype, units=None +): + """Helper function for setting up time-dependent HDF5 group datasets + + All output groups must adhere to the H5MD standard, meaning a structure of + + + | ┗━ **group** particle group (e.g. :code:`all`) or :code:`observables` group + | ┗━ **group** time-dependent data + | ┣━ **dataset** :code:`step` :code:`shape=(n_frames,)` + | ┣━ **dataset** :code:`time` :code:`shape=(n_frames,)` + | ┗━ **dataset** :code:`value` :code:`shape=(n_frames, *)` + + is necessary. + + References + ---------- + H5MD specification : + https://www.nongnu.org/h5md/h5md.html + """ # noqa: E501 + group = parent_group.create_group(name) + step = group.create_dataset("step", (n_frames,), "int32") + time = group.create_dataset("time", (n_frames,), "float32") + value = group.create_dataset("value", (n_frames, *shape), dtype) + + if units is not None: + value.attrs["unit"] = units + time.attrs["unit"] = "ps" + return group, step, time, value
+ + +
[docs]def store_static( + h5md, + rank_range, + names, + types, + indices, + config, + bonds_2_atom1, + bonds_2_atom2, + molecules=None, + velocity_out=False, + force_out=False, + charges=False, + dielectrics=False, + plumed_out=False, + comm=MPI.COMM_WORLD, +): + """Outputs all static time-independent quantities to the HDF5 output file + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + rank_range : list[int] + Start and end indices for global arrays for each MPI rank. + names : (N,) numpy.ndarray + Array of names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of type indices for :code:`N` particles. + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + config : Config + Configuration object. + bonds_2_atom1 : (B,) numpy.ndarray + Array of indices of the first particle for :code:`B` total + two-particle bonds. + bonds_2_atom2 : (B,) numpy.ndarray + Array of indices of the second particle for :code:`B` total + two-particle bonds. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. + dielectrics : (N,) numpy.ndarray + Array of particle relative dielectric values for :code:`N` particles. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to output HDF5 file. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + prepare_bonds : + Constructs two-, three-, and four-particle bonds from toplogy input + file and bond configuration information. + distribute_input : + Distributes input arrays onto MPI ranks, attempting load balancing. + """ + dtype = h5md.float_dtype + + h5md_group = h5md.file.create_group("/h5md") + h5md.h5md_group = h5md_group + h5md.observables = h5md.file.create_group("/observables") + h5md.connectivity = h5md.file.create_group("/connectivity") + h5md.parameters = h5md.file.create_group("/parameters") + + h5md_group.attrs["version"] = np.array([1, 1], dtype=int) + author_group = h5md_group.create_group("author") + author_group.attrs["name"] = np.string_(getpass.getuser()) + creator_group = h5md_group.create_group("creator") + creator_group.attrs["name"] = np.string_("Hylleraas MD") + + # Get HyMD version + creator_group.attrs["version"] = np.string_(get_version()) + + h5md.particles_group = h5md.file.create_group("/particles") + h5md.all_particles = h5md.particles_group.create_group("all") + mass = h5md.all_particles.create_dataset("mass", (config.n_particles,), dtype) + mass[...] = config.mass + + if charges is not False: + charge = h5md.all_particles.create_dataset( + "charge", (config.n_particles,), dtype="float32" + ) + charge[indices] = charges + if dielectrics is not False: + dielectric = h5md.all_particles.create_dataset( + "dielectric", (config.n_particles,), dtype="float32" + ) + dielectric[indices] = dielectrics + + box = h5md.all_particles.create_group("box") + box.attrs["dimension"] = 3 + box.attrs["boundary"] = np.array( + [np.string_(s) for s in 3 * ["periodic"]], dtype="S8" + ) + + n_frames = config.n_steps // config.n_print + if np.mod(config.n_steps - 1, config.n_print) != 0: + n_frames += 1 + if np.mod(config.n_steps, config.n_print) == 1: + n_frames += 1 + if n_frames == config.n_steps: + n_frames += 1 + + species = h5md.all_particles.create_dataset( + "species", + (config.n_particles,), + dtype="i", + ) + + ( + _, + h5md.positions_step, + h5md.positions_time, + h5md.positions, + ) = setup_time_dependent_element( + "position", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm", + ) + if velocity_out: + ( + _, + h5md.velocities_step, + h5md.velocities_time, + h5md.velocities, + ) = setup_time_dependent_element( + "velocity", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm ps-1", + ) + if force_out: + ( + _, + h5md.forces_step, + h5md.forces_time, + h5md.forces, + ) = setup_time_dependent_element( + "force", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="kJ mol-1 nm-1", + ) + ( + _, + h5md.total_energy_step, + h5md.total_energy_time, + h5md.total_energy, + ) = setup_time_dependent_element( + "total_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.kinetc_energy_step, + h5md.kinetc_energy_time, + h5md.kinetc_energy, + ) = setup_time_dependent_element( + "kinetic_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.potential_energy_step, + h5md.potential_energy_time, + h5md.potential_energy, + ) = setup_time_dependent_element( + "potential_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.bond_energy_step, + h5md.bond_energy_time, + h5md.bond_energy, + ) = setup_time_dependent_element( + "bond_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.angle_energy_step, + h5md.angle_energy_time, + h5md.angle_energy, + ) = setup_time_dependent_element( + "angle_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.dihedral_energy_step, + h5md.dihedral_energy_time, + h5md.dihedral_energy, + ) = setup_time_dependent_element( + "dihedral_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.field_energy_step, + h5md.field_energy_time, + h5md.field_energy, + ) = setup_time_dependent_element( + "field_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + if charges is not False: + ( + _, + h5md.field_q_energy_step, + h5md.field_q_energy_time, + h5md.field_q_energy, + ) = setup_time_dependent_element( + "field_q_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) # <-------- xinmeng + if plumed_out is not False: + ( + _, + h5md.plumed_bias_step, + h5md.plumed_bias_time, + h5md.plumed_bias, + ) = setup_time_dependent_element( + "plumed_bias", h5md.observables, n_frames, (1,), dtype, units="kJ mol-1" # noqa: E501 + ) + ( + _, + h5md.total_momentum_step, + h5md.total_momentum_time, + h5md.total_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "total_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm g ps-1 mol-1", + ) + ( + _, + h5md.angular_momentum_step, + h5md.angular_momentum_time, + h5md.angular_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "angular_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm+2 g ps-1 mol-1", + ) + ( + _, + h5md.torque_step, + h5md.torque_time, + h5md.torque, + ) = setup_time_dependent_element( # noqa: E501 + "torque", + h5md.observables, + n_frames, + (3,), + dtype, + units="kJ nm+2 mol-1", + ) + ( + _, + h5md.temperature_step, + h5md.temperature_time, + h5md.temperature, + ) = setup_time_dependent_element( + "temperature", h5md.observables, n_frames, (3,), dtype, units="K" + ) + ( + _, + h5md.thermostat_work_step, + h5md.thermostat_work_time, + h5md.thermostat_work, + ) = setup_time_dependent_element( + "thermostat_work", + h5md.observables, + n_frames, + (1,), + "float32", + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.pressure_step, + h5md.pressure_time, + h5md.pressure, + ) = setup_time_dependent_element( + "pressure", h5md.observables, n_frames, (18,), "float32", units="Bar" + ) + (_, h5md.box_step, h5md.box_time, h5md.box_value,) = setup_time_dependent_element( + "edges", box, n_frames, (3, 3), "float32", units="nm" + ) + + ind_sort = np.argsort(indices) + for i in ind_sort: + species[indices[i]] = config.name_to_type_map[names[i].decode("utf-8")] + + h5md.parameters.attrs["config.toml"] = np.string_(str(config)) + vmd_group = h5md.parameters.create_group("vmd_structure") + index_of_species = vmd_group.create_dataset( + "indexOfSpecies", (config.n_types,), "i" + ) + index_of_species[:] = np.array(list(range(config.n_types))) + + # VMD-h5mdplugin maximum name/type name length is 16 characters (for + # whatever reason [VMD internals?]). + name_dataset = vmd_group.create_dataset("name", (config.n_types,), "S16") + type_dataset = vmd_group.create_dataset("type", (config.n_types,), "S16") + if molecules is not None: + resid_dataset = vmd_group.create_dataset( + "resid", + (config.n_particles,), + "i", + ) + + # Change this + for i, n in config.type_to_name_map.items(): + name_dataset[i] = np.string_(n[:16]) + if n == "W": + type_dataset[i] = np.string_("solvent") + else: + type_dataset[i] = np.string_("membrane") + + total_bonds = comm.allreduce(len(bonds_2_atom1), MPI.SUM) + n_bonds_local = len(bonds_2_atom1) + + receive_buffer = comm.gather(n_bonds_local, root=0) + n_bonds_global = None + if comm.Get_rank() == 0: + n_bonds_global = receive_buffer + n_bonds_global = np.array(comm.bcast(n_bonds_global, root=0)) + rank_bond_start = np.sum(n_bonds_global[: comm.Get_rank()]) + + bonds_from = vmd_group.create_dataset("bond_from", (total_bonds,), "i") + bonds_to = vmd_group.create_dataset("bond_to", (total_bonds,), "i") + for i in range(n_bonds_local): + a = bonds_2_atom1[i] + b = bonds_2_atom2[i] + bonds_from[rank_bond_start + i] = indices[a] + 1 + bonds_to[rank_bond_start + i] = indices[b] + 1 + + if molecules is not None: + resid_dataset[indices[ind_sort]] = molecules
+ + +# store data old vs +""" +h5md, step, frame, indices, positions, velocities, forces, box_size, +temperature, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, +field_energy, field_q_energy, time_step, config, velocity_out=False, +force_out=False, charge_out=False, dump_per_particle=False, +""" + + +
[docs]def store_data( + h5md, + step, + frame, + indices, + positions, + velocities, + forces, + box_size, + temperature, + pressure, + kinetic_energy, + bond2_energy, + bond3_energy, + bond4_energy, + field_energy, + field_q_energy, + plumed_bias, + time_step, + config, + velocity_out=False, + force_out=False, + charge_out=False, + plumed_out=False, + dump_per_particle=False, + comm=MPI.COMM_WORLD, +): + """Writes time-step data to HDF5 output file + + Handles all quantities which change during simulation, as opposed to + static quanitities (see :code:`store_static`). + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + step : int + Step number. + frame : int + Output frame number (:code:`step // n_print`). + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + positions : (N,) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + velocities : (N,) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + forces : (N,) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. + box_size : (D,) numpy.ndarray + Array containing the simulation box size. + temperature : float + Calculated instantaneous temperature. + kinetic_energy : float + Calculated instantaneous kinetic energy. + bond2_energy : float + Calculated instantaneous harmonic two-particle bond energy. + bond3_energy : float + Calculated instantaneous harmonic angular three-particle bond energy. + bond4_energy : float + Calculated instantaneous dihedral four-particle torsion energy. + field_energy : float + Calculated instantaneous particle-field energy. + field_q_energy : float + Calculated instantaneous electrostatic energy. + plumed_bias : float + PLUMED instantaneous bias energy. + time_step : float + Value of the time step. + config : Config + Configuration object. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charge_out : bool, optional + If :code:`True`, electrostatic energies are written to the output + HDF5 file. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to the output HDF5 file. + dump_per_particle : bool, optional + If :code:`True`, all quantities are written **per particle**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + store_static : + Outputs all static time-independent quantities to the HDF5 output file + """ + for dset in ( + h5md.positions_step, + h5md.total_energy_step, + h5md.potential_energy_step, + h5md.kinetc_energy_step, + h5md.bond_energy_step, + h5md.angle_energy_step, + h5md.dihedral_energy_step, + h5md.field_energy_step, + h5md.total_momentum_step, + h5md.angular_momentum_step, + h5md.torque_step, + h5md.temperature_step, + h5md.pressure_step, + h5md.box_step, + h5md.thermostat_work_step, + ): + dset[frame] = step + + for dset in ( + h5md.positions_time, + h5md.total_energy_time, + h5md.potential_energy_time, + h5md.kinetc_energy_time, + h5md.bond_energy_time, + h5md.angle_energy_time, + h5md.dihedral_energy_time, + h5md.field_energy_time, + h5md.total_momentum_time, + h5md.angular_momentum_time, + h5md.torque_time, + h5md.temperature_time, + h5md.pressure_time, + h5md.box_time, + h5md.thermostat_work_time, + ): + dset[frame] = step * time_step + + if velocity_out: + h5md.velocities_step[frame] = step + h5md.velocities_time[frame] = step * time_step + if force_out: + h5md.forces_step[frame] = step + h5md.forces_time[frame] = step * time_step + if charge_out: + h5md.field_q_energy_step[frame] = step + h5md.field_q_energy_time[frame] = step * time_step + if plumed_out: + h5md.plumed_bias_step[frame] = step + h5md.plumed_bias_time[frame] = step * time_step + + ind_sort = np.argsort(indices) + h5md.positions[frame, indices[ind_sort]] = positions[ind_sort] + + if velocity_out: + h5md.velocities[frame, indices[ind_sort]] = velocities[ind_sort] + if force_out: + h5md.forces[frame, indices[ind_sort]] = forces[ind_sort] + if charge_out: + h5md.field_q_energy[frame] = field_q_energy + if plumed_out: + h5md.plumed_bias[frame] = plumed_bias + + potential_energy = ( + bond2_energy + bond3_energy + bond4_energy + field_energy + field_q_energy + ) + + total_momentum = config.mass * comm.allreduce(np.sum(velocities, axis=0), MPI.SUM) + angular_momentum = config.mass * comm.allreduce( + np.sum(np.cross(positions, velocities), axis=0), MPI.SUM + ) + torque = config.mass * comm.allreduce( + np.sum(np.cross(positions, forces), axis=0), MPI.SUM + ) + h5md.total_energy[frame] = kinetic_energy + potential_energy + h5md.potential_energy[frame] = potential_energy + h5md.kinetc_energy[frame] = kinetic_energy + h5md.bond_energy[frame] = bond2_energy + h5md.angle_energy[frame] = bond3_energy + h5md.dihedral_energy[frame] = bond4_energy + h5md.field_energy[frame] = field_energy + h5md.total_momentum[frame, :] = total_momentum + h5md.angular_momentum[frame, :] = angular_momentum + h5md.torque[frame, :] = torque + h5md.temperature[frame] = temperature + h5md.pressure[frame] = pressure + for d in range(3): + h5md.box_value[frame, d, d] = box_size[d] + h5md.thermostat_work[frame] = config.thermostat_work + + fmt_ = [ + "step", + "time", + "temp", + "tot E", + "kin E", + "pot E", + "field E", + "elec E", + "bond E", + "ang E", + "dih E", + "bias E", + "Px", + "Py", + "Pz", + "ΔH" if config.target_temperature else "ΔE", + ] + fmt_ = np.array(fmt_) + + # create mask to show only energies != 0 + en_array = np.array([ + field_energy, + field_q_energy, + bond2_energy, + bond3_energy, + bond4_energy, + plumed_bias, + ]) + mask = np.full_like(fmt_, True, dtype=bool) + mask[range(6,12)] = en_array != 0. + + header_ = fmt_[mask].shape[0] * "{:>13}" + if config.initial_energy is None: + fmt_[-1] = "" + + divide_by = 1.0 + if dump_per_particle: + for i in range(3, 9): + fmt_[i] = fmt_[i][:-2] + "E/N" + fmt_[-1] += "/N" + divide_by = config.n_particles + total_energy = kinetic_energy + potential_energy + if config.initial_energy is not None: + if config.target_temperature: + H_tilde = total_energy - config.initial_energy - config.thermostat_work + else: + H_tilde = total_energy - config.initial_energy + else: + H_tilde = 0.0 + + header = header_.format(*fmt_[mask]) + data_fmt = f'{"{:13}"}{(fmt_[mask].shape[0]-1) * "{:13.5g}" }' + all_data = [ + step, + time_step * step, + temperature, + total_energy / divide_by, + kinetic_energy / divide_by, + potential_energy / divide_by, + field_energy / divide_by, + field_q_energy / divide_by, + bond2_energy / divide_by, + bond3_energy / divide_by, + bond4_energy / divide_by, + plumed_bias / divide_by, + total_momentum[0] / divide_by, + total_momentum[1] / divide_by, + total_momentum[2] / divide_by, + H_tilde / divide_by, + ] + data = data_fmt.format(*[val for i, val in enumerate(all_data) if mask[i]]) + Logger.rank0.log(logging.INFO, ("\n" + header + "\n" + data))
+ + +
[docs]def distribute_input( + in_file, rank, size, n_particles, max_molecule_size=201, comm=MPI.COMM_WORLD +): + """Assign global arrays onto MPI ranks, attempting load balancing + + Distributes approximately equal numbers of particles (workload) onto each + independent MPI rank, while respecting the requirement that any molecule + must be fully contained on a single MPI rank only (no splitting molecules + across multiple CPUs). + + Parameters + ---------- + in_file : h5py.File + HDF5 input file object. + rank : int + Local rank number for this MPI rank. + size : int + Global size of the MPI communicator (number of total CPUs). + n_particles : int + Total number of particles. + max_molecule_size : int, optional + Maximum size of any molecule present in the system. Used to initially + guess where the MPI rank boundaries (start/end indices) in the global + arrays should be placed. If molecules of size + :code:`>max_molecule_size` exist in the simulation system, HyMD + **might** work as expected. Or it might fail spectacularly. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + rank_range : + Starting and ending indices in the global arrays for each MPI rank. + """ + if n_particles is None: + n_particles = len(in_file["indices"]) + np_per_MPI = n_particles // size + + molecules_flag = False + if "molecules" in in_file: + molecules_flag = True + + if not molecules_flag: + if rank == size - 1: + np_cum_mpi = [rank * np_per_MPI, n_particles] + else: + np_cum_mpi = [rank * np_per_MPI, (rank + 1) * np_per_MPI] + p_mpi_range = list(range(np_cum_mpi[0], np_cum_mpi[1])) + return p_mpi_range, molecules_flag + + # To avoid splitting molecules across multiple different ranks, we need + # to read in some extra indices before/after the expected break points + # and iterate until we find a molecule break. + # + # Implicitly assuming no molecule is bigger than + # min(max_molecule_size, n_particles // n_MPI_ranks) atoms. + max_molecule_size += 2 + grab_extra = max_molecule_size if np_per_MPI > max_molecule_size else np_per_MPI + if rank == 0: + mpi_range_start = 0 + if size == 1: + mpi_range_end = n_particles + else: + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + elif rank == size - 1: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = n_particles + else: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + + molecules = in_file["molecules"][mpi_range_start:mpi_range_end] + indices = in_file["indices"][mpi_range_start:mpi_range_end] + molecule_end_indices = np.nonzero(np.diff(molecules))[0] + + p_mpi_range = [None, None] + if rank == 0: + p_mpi_range[0] = 0 + if size == 1: + p_mpi_range[1] = n_particles + else: + p_mpi_range[1] = indices[ + molecule_end_indices[molecule_end_indices >= np_per_MPI][0] + 1 + ] + elif rank == size - 1: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = n_particles + else: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = ( + indices[molecule_end_indices[molecule_end_indices > np_per_MPI][0]] + + 1 # noqa: E501 + ) + return list(range(p_mpi_range[0], p_mpi_range[1])), molecules_flag
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/_modules/hymd/force.html b/v1.0.1/_modules/hymd/force.html new file mode 100644 index 00000000..d81404d5 --- /dev/null +++ b/v1.0.1/_modules/hymd/force.html @@ -0,0 +1,1149 @@ + + + + + + hymd.force — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.force

+"""Calculates intramolecular forces between bonded particles in molecules
+"""
+import numpy as np
+import networkx as nx
+from dataclasses import dataclass
+
+# Imported here so we can call from force import compute_bond_forces__fortran
+from force_kernels import cbf as compute_bond_forces__fortran  # noqa: F401
+from force_kernels import (  # noqa: F401
+    caf as compute_angle_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cdf as compute_dihedral_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cbf_d as compute_bond_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    caf_d as compute_angle_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    cdf_d as compute_dihedral_forces__fortran__double,
+)
+
+
+
[docs]@dataclass # might not be needed +class Dielectric_type: + atom_1: str + dielectric_value: float
+ + +
[docs]@dataclass +class Bond: + """Dataclass representing a single two-particle bond type + + A `bond type` is a bond strength and equilibrium distance associated with + any bond between particles of specific types :code:`A` and :code:`B` + (where :code:`A` and :code:`B` may be the same or different). Harmonic + two-particle bonds in HyMD take the form + + .. math:: + + V_2(\\mathbf{r}_1, \\mathbf{r}_2) = + \\frac{1}{2}k + \\left( + \\vert \\mathbf{r}_1 - \\mathbf{r}_2 \\vert - r_0 + \\right)^2, + + where :math:`k` is the bond strength (spring constant) and :math:`r_0` is + the equilibrium bond length (at which the energy is zero). + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + equilibrium : float + Equilibrium distance at which the energy associated with the bond + vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient (spring constant). + """ + + atom_1: str + atom_2: str + equilibrium: float + strength: float
+ + +
[docs]@dataclass +class Angle(Bond): + """Dataclass representing a single three-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any three-particle bond between particles of specific types :code:`A`, + :code:`B`, and :code:`C` (where :code:`A`, :code:`B`, and :code:`C` may be + different or the same). Harmonic angular three-particle bonds in HyMD take + the form + + .. math:: + + V_3(\\mathbf{r}_1, \\mathbf{r}_2, \\mathbf{r}_3) = + \\frac{1}{2}k + \\left( + \\cos^{-1} + \\left[ + \\frac{ + (\\mathbf{r}_1-\\mathbf{r}_2) + \\cdot + (\\mathbf{r}_3-\\mathbf{r}_2) + } + { + \\vert\\mathbf{r}_1-\\mathbf{r}_2\\vert + \\vert\\mathbf{r}_3-\\mathbf{r}_2\\vert + } + \\right] - \\theta_0 + \\right)^2 + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + equilibrium : float + Equilibrium angle at which the energy associated with the + three-particle angular bond vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient. + + See also + -------- + Bond : + Two-particle bond type dataclass + """ + + atom_3: str
+ + +
[docs]@dataclass +class Dihedral: + """Dataclass representing a single four-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any four-particle torsional bond between particles of specific types + :code:`A`, :code:`B`, :code:`C`, and :code:`D` (where :code:`A`, :code:`B`, + :code:`C`, and :code:`D` may be different or the same). Dihedral + four-particle bonds in HyMD take different forms depending on the + :code:`dih_type` parameter. + + In the following, let :math:`\\phi` denote the angle between the planes + spanned by the relative positions of atoms :code:`A`-:code:`B`-:code:`C` + and :code:`B`-:code:`C`-:code:`D`. If :code:`dih_type = 0`, then + + .. math:: + + V_4(\\phi) = \\sum_n c_n + \\left( + 1 + \\cos\\left[ + n\\phi - d_n + \\right] + \\right), + + where :math:`c_n` are energy coefficients and :math:`d_n` are propensity + phases. By default, the cosine sum is truncated at five terms. If + :code:`coeffs` provides only a single float, this is used as the coiling + propensity parameter :math:`\\lambda`. In this case, :math:`c_n` and + :math:`d_n` are automatically set to values which promote alpha helical + (:math:`\\lambda=-1`), beta sheet (:math:`\\lambda=1`), or a mixed + (:math:`1>\\lambda>-1`) structure (using values provided by Bore et al. + (2018)). In this case, the full potential takes the form + + .. math:: + + V_4(\\phi;\\lambda) = + \\frac{1}{2}(1-\\lambda) V_{\\text{prop},\\alpha}(\\phi) + + + \\frac{1}{2}(1+\\lambda) V_{\\text{prop},\\beta}(\\phi) + + + (1-\\vert\\lambda\\vert) V_{\\text{prop}, \\text{coil}}(\\phi), + + with each of the :math:`V_{\\mathrm{prop}, X}` being fixed cosine series + potentials with pre-set :math:`c_n` -s and :math:`d_n` -s. + + If :code:`dih_type = 1`, then a combined bending torsional (CBT) potential + is employed, + + .. math:: + + V_4(\\phi,\\gamma;\\lambda) = + V_4(\\phi;\\lambda) + + + \\frac{1}{2}K(\\phi)(\\gamma - \\gamma_0)^2, + + where :math:`V_4(\\phi;\\lambda)` specifies the potential as given by the + coiling propensity parameter above, :math:`K(\\phi)` is a separate cosine + series potential acting as the angular three-particle bond strength, and + :math:`\\gamma_0` is the three-particle bond equilibrium angle. In this + case, the :code:`coeffs` parameter must specify *both* a :math:`\\lambda` + value, in additon to the energy and phases dictating the :math:`K(\\phi)` + potential. + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + atom_4 : str + Type name of particle 4. + coeffs : list[list[float]] or list[float] or numpy.ndarray + Dihedral coefficients defining the series expansion of the dihedral + energy. + dih_type : int + Specifies the type of dihedral used; If :code:`0`, then :code:`coeffs` + must contain **either** two lists of five energy coefficients + :math:`c_n` and five propensity phases :math:`d_n` **or** a single + floating point number defining the :math:`\\lambda` coiling propensity + parameter. If :code:`1`, the combined bending-torsional potential is + used, and :code:`coeffs` must specify :math:`\\lambda` *and* two lists + containing energy coefficients and propensity phases for the + :math:`V_\\text{prop}` propensity potential, defined in terms of cosine + series. + + References + ---------- + Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018. + """ + + atom_1: str + atom_2: str + atom_3: str + atom_4: str + coeffs: np.ndarray + dih_type: int
+ + +
[docs]@dataclass +class Chi: + """Dataclass representing a single :math:`\\chi` mixing interaction type + + An `interaction mixing energy type` is a mixing energy associated with + density overlap between species of types :code:`A` and :code:`B` + (specified as inputs :code:`atom_1` and :code:`atom_2`). A positive mixing + energy promotes phase separation, a negative mixing energy promotes mixing. + The interaction energy density (provided the :code:`DefaultWithChi` + Hamiltonian is used) takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} + \\sum_{k,l}\\chi_{k,l} \\tilde\\phi_k\\tilde\\phi_l, + + where :math:`\\chi_{k,l}` denotes the mixing energy between species + :math:`k` and :math:`l`, with :math:`\\kappa` being the incompressibility. + The value of the interaction mixing energy parameter may be extracted from + `Flory-Huggins theory`_. + + .. _`Flory-Huggins theory`: + https://en.wikipedia.org/wiki/Flory%E2%80%93Huggins_solution_theory + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + interaction_energy : float + Interaction mixing energy. + + See also + -------- + hymd.hamiltonian.DefaultWithChi : + Interaction energy functional using :math:`\\chi`-interactions. + """ + + atom_1: str + atom_2: str + interaction_energy: float
+ + +
[docs]def find_all_paths(G, u, n): + """Helper function that recursively finds all paths of given lenght 'n + 1' inside a network 'G'. + Adapted from https://stackoverflow.com/a/28103735.""" + if n == 0: + return [[u]] + paths = [] + for neighbor in G.neighbors(u): + for path in find_all_paths(G, neighbor, n - 1): + if u not in path: + paths.append([u] + path) + return paths
+ + +
[docs]def propensity_potential_coeffs(x: float): + alpha_coeffs = np.array( + [ + [7.406, -5.298, -2.570, 1.336, 0.739], + [-0.28632126, 1.2099146, 1.18122138, 0.49075168, 0.98495911], + ] + ) + beta_coeffs = np.array( + [ + [3.770, 5.929, -4.151, -0.846, 0.190], + [-0.2300693, -0.0583289, 0.99342396, 1.03237971, 2.90160988], + ] + ) + coil_coeffs = np.array( + [ + [1.416, -0.739, 0.990, -0.397, 0.136], + [1.3495933, 0.45649087, 2.30441057, -0.12274901, -0.26179939], + ] + ) + + zero_add = np.zeros((2, 5)) + if np.isclose(x, -1): + return np.concatenate((alpha_coeffs, zero_add)) + elif np.isclose(x, 0): + return np.concatenate((coil_coeffs, zero_add)) + elif np.isclose(x, 1): + return np.concatenate((beta_coeffs, zero_add)) + + abs_x = np.abs(x) + if abs_x > 1: + err_str = ( + f"The provided value of lambda = {x} is out of lambda definition range, " + f"[-1.0, 1.0]." + ) + Logger.rank0.log(logging.ERROR, err_str) + else: + coil_coeffs[0] *= 1 - abs_x + if x < 0: + alpha_coeffs[0] *= 0.5 * (abs_x - x) + return np.concatenate((alpha_coeffs, coil_coeffs)) + else: + beta_coeffs[0] *= 0.5 * (abs_x + x) + return np.concatenate((beta_coeffs, coil_coeffs))
+ + +
[docs]def prepare_bonds_old(molecules, names, bonds, indices, config): + """Find bonded interactions from connectivity and bond types information + + .. deprecated:: 1.0.0 + :code:`prepare_bonds_old` was replaced by :code:`prepare_bonds` for + use with compiled Fortran kernels prior to 1.0.0 release. + + Prepares the necessary equilibrium and bond strength information needed by + the intramolecular interaction functions. This is performed locally on each + MPI rank, as the domain decomposition ensures that for all molecules *all* + consituent particles are always contained on *the same* MPI rankself. + + This function traverses the bond connectivity information provided in the + structure/topology input file and indentifies any two-, three-, or + four-particle potential bonds. For each connected chain of two, three, or + four particles, a matching to bond types is attempted. If the corresponding + names match, a bond object is initialized. + + In order to investigate the connectivity, a graph is created using + networkx functionality. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2 : list + List of lists containing *local* particle indices, equilibrium + distance, and bond strength coefficient for each reconstructed + two-particle bond. + bonds_3 : + List of lists containing *local* particle indices, equilibrium angle, + and bond strength coefficient for each reconstructed three-particle + bond. + bonds_4 : + List of lists containing *local* particle indices, dihedral type index, + and dihedral coefficients for each reconstructed four-particle + torsional bond. + bb_index : list + List indicating the dihedral type of each four-particle bond in + :code:`bonds_4`. + + See also + -------- + Bond : + Two-particle bond type dataclass. + Angle : + Three-particle angular bond type dataclass. + Dihedral : + Four-particle torsional bond type dataclass. + hymd.input_parser.Config + Configuration dataclass handler. + """ + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + bb_index = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + bb_dihedral = 0 + bond_graph = nx.Graph() + + for local_index, global_index in enumerate(indices): + if molecules[local_index] != mol: + continue + + bond_graph.add_node( + global_index, + name=names[local_index].decode("UTF-8"), + local_index=local_index, + ) + for bond in [b for b in bonds[local_index] if b != -1]: + bond_graph.add_edge(global_index, bond) + + connectivity = nx.all_pairs_shortest_path(bond_graph) + for c in connectivity: + i = c[0] + connected = c[1] + for j, path in connected.items(): + if len(path) == 2 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for b in config.bonds: + match_forward = name_i == b.atom_1 and name_j == b.atom_2 + match_backward = name_i == b.atom_2 and name_j == b.atom_1 + if match_forward or match_backward: + bonds_2.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[j]["local_index"], + b.equilibrium, + b.strength, + ] + ) + + if len(path) == 3 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_mid = bond_graph.nodes()[path[1]]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for a in config.angle_bonds: + match_forward = ( + name_i == a.atom_1 + and name_mid == a.atom_2 + and name_j == a.atom_3 + ) + match_backward = ( + name_i == a.atom_3 + and name_mid == a.atom_2 + and name_j == a.atom_1 + ) + if match_forward or match_backward: + bonds_3.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[path[1]]["local_index"], + bond_graph.nodes()[j]["local_index"], + np.radians(a.equilibrium), + a.strength, + ] + ) + + all_paths_len_four = find_all_paths(bond_graph, i, 3) + for p in all_paths_len_four: + name_i = bond_graph.nodes()[i]["name"] + name_mid_1 = bond_graph.nodes()[p[1]]["name"] + name_mid_2 = bond_graph.nodes()[p[2]]["name"] + name_j = bond_graph.nodes()[p[3]]["name"] + + for a in config.dihedrals: + match_forward = ( + name_i == a.atom_1 + and name_mid_1 == a.atom_2 + and name_mid_2 == a.atom_3 + and name_j == a.atom_4 + ) + if ( + match_forward + and [ + bond_graph.nodes()[p[3]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[i]["local_index"], + a.coeffs, + a.dih_type, + ] + not in bonds_4 + ): + bonds_4.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[3]]["local_index"], + a.coeffs, + a.dih_type, + ] + ) + if a.dih_type == 1: + bb_dihedral = len(bonds_4) + + if bb_dihedral: + bb_index.append(bb_dihedral - 1) + + return bonds_2, bonds_3, bonds_4, bb_index
+ + +
[docs]def prepare_index_based_bonds(molecules, topol): + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + resid = mol + 1 + top_summary = topol["system"]["molecules"] + resname = None + test_mol_number = 0 + for molname in top_summary: + test_mol_number += molname[1] + if resid <= test_mol_number: + resname = molname[0] + break + + if resname is None: + break + + if "bonds" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for bond in topol[resname]["bonds"]: + index_i = bond[0] - 1 + first_id + index_j = bond[1] - 1 + first_id + # bond[2] is the bond type, inherited by the itp format. Not used + equilibrium = bond[3] + strength = bond[4] + bonds_2.append([index_i, index_j, equilibrium, strength]) + + if "angles" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["angles"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + # angle[3] is the angle type, inherited by the itp format. Not used + equilibrium = np.radians(angle[4]) + strength = angle[5] + bonds_3.append([index_i, index_j, index_k, equilibrium, strength]) + + if "dihedrals" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["dihedrals"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + index_l = angle[3] - 1 + first_id + dih_type = angle[4] + coeff = angle[5] + if dih_type == 0 and isinstance(coeff[0], (float, int)): + coeff = propensity_potential_coeffs(coeff[0]) + elif dih_type == 1 and len(coeff) == 3: + coeff = np.array( + propensity_potential_coeffs(coeff[0][0]).tolist() + + coeff[1:] + ) + elif dih_type == 2: + coeff = np.array(coeff) + else: + coeff = np.insert(np.array(coeff), 2, np.zeros((2, 5)), axis=0) + bonds_4.append([index_i, index_j, index_k, index_l, coeff, dih_type, 0]) + return bonds_2, bonds_3, bonds_4
+ + +
[docs]def prepare_bonds(molecules, names, bonds, indices, config, topol=None): + """Rearrange the bond information for usage in compiled Fortran kernels + + Restructures the lists resulting from the execution of + :code:`prepare_bonds_old` into numpy arrays suitable for calls to optimized + Fortran code calculating bonded forces and energiesself. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2_atom_1 : (B,) numpy.ndarray + Local index of particle 1 for each of :code:`B` constructed + two-particle bonds. + bonds_2_atom_2 : (B,) numpy.ndarray + Local index of particle 2 for each of :code:`B` constructed + two-particle bonds. + bonds_2_equilibrium : (B,) numpy.ndarray + Equilibrium distance for each of :code:`B` constructed two-particle + bonds. + bonds_2_strength : (B,) numpy.ndarray + Bond strength for each of :code:`B` constructed two-particle + bonds. + bonds_3_atom_1 : (A,) numpy.ndarray + Local index of particle 1 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_2 : (A,) numpy.ndarray + Local index of particle 2 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_3 : (A,) numpy.ndarray + Local index of particle 3 for each of :code:`A` constructed + three-particle bonds. + bonds_3_equilibrium : (A,) numpy.ndarray + Equilibrium angle for each of :code:`A` constructed three-particle + bonds. + bonds_3_strength : (A,) numpy.ndarray + Bond strength for each of :code:`A` constructed three-particle + bonds. + bonds_4_atom_1 : (D,) numpy.ndarray + Local index of particle 1 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_2 : (D,) numpy.ndarray + Local index of particle 2 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_3 : (D,) numpy.ndarray + Local index of particle 3 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_4 : (D,) numpy.ndarray + Local index of particle 4 for each of :code:`D` constructed + four-particle bonds. + bonds_4_coeff : (D,) numpy.ndarray + Cosine series coefficients for each of :code:`D` constructed + four-particle bonds. + bonds_4_type : (D,) numpy.ndarray + Dihedral type for each of :code:`D` constructed four-particle + bonds. + bonds_4_last : (D,) numpy.ndarray + Flags indicating if :code:`dih_type` is :code:`1` for each of :code:`D` + constructed four-particle bonds. + + See also + -------- + prepare_bonds_old : + Used internally to reconstruct the bonded interactions types from the + connectivity information in the structure/topology input file and the + bonded types specified in the configuration file. + """ + if topol is not None: + bonds_2, bonds_3, bonds_4 = prepare_index_based_bonds( + molecules, topol + ) + else: + bonds_2, bonds_3, bonds_4, bb_index = prepare_bonds_old( + molecules, names, bonds, indices, config + ) + + # Bonds + bonds_2_atom1 = np.empty(len(bonds_2), dtype=int) + bonds_2_atom2 = np.empty(len(bonds_2), dtype=int) + bonds_2_equilibrium = np.empty(len(bonds_2), dtype=np.float64) + bonds_2_strength = np.empty(len(bonds_2), dtype=np.float64) + for i, b in enumerate(bonds_2): + bonds_2_atom1[i] = b[0] + bonds_2_atom2[i] = b[1] + bonds_2_equilibrium[i] = b[2] + bonds_2_strength[i] = b[3] + + # Angles + bonds_3_atom1 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom2 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom3 = np.empty(len(bonds_3), dtype=int) + bonds_3_equilibrium = np.empty(len(bonds_3), dtype=np.float64) + bonds_3_strength = np.empty(len(bonds_3), dtype=np.float64) + for i, b in enumerate(bonds_3): + bonds_3_atom1[i] = b[0] + bonds_3_atom2[i] = b[1] + bonds_3_atom3[i] = b[2] + bonds_3_equilibrium[i] = b[3] + bonds_3_strength[i] = b[4] + # Dihedrals + bonds_4_atom1 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom2 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom3 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom4 = np.empty(len(bonds_4), dtype=int) + number_of_coeff = 6 + len_of_coeff = 5 + bonds_4_coeff = np.empty( + (len(bonds_4), number_of_coeff, len_of_coeff), dtype=np.float64 + ) + bonds_4_type = np.empty(len(bonds_4), dtype=int) + bonds_4_last = np.zeros(len(bonds_4), dtype=int) + for i, b in enumerate(bonds_4): + bonds_4_atom1[i] = b[0] + bonds_4_atom2[i] = b[1] + bonds_4_atom3[i] = b[2] + bonds_4_atom4[i] = b[3] + bonds_4_coeff[i] = np.resize(b[4], (number_of_coeff, len_of_coeff)) + bonds_4_type[i] = b[5] + if topol is not None: + bonds_4_last[i] = b[6] + if topol is None: + bonds_4_last[bb_index] = 1 + + return ( + bonds_2_atom1, + bonds_2_atom2, + bonds_2_equilibrium, + bonds_2_strength, + bonds_3_atom1, + bonds_3_atom2, + bonds_3_atom3, + bonds_3_equilibrium, + bonds_3_strength, # noqa: E501 + bonds_4_atom1, + bonds_4_atom2, + bonds_4_atom3, + bonds_4_atom4, + bonds_4_coeff, + bonds_4_type, + bonds_4_last, # noqa: E501 + )
+ + +
[docs]def compute_bond_forces__plain(f_bonds, r, bonds_2, box_size): + """Computes forces resulting from bonded interactions + + .. deprecated:: 1.0.0 + :code:`compute_bond_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_bonds.fill(0.0) + energy = 0.0 + + for i, j, r0, k in bonds_2: + ri = r[i, :] + rj = r[j, :] + rij = rj - ri + + # Apply periodic boundary conditions to the distance rij + for dim in range(len(rij)): + rij[dim] -= box_size[dim] * np.around(rij[dim] / box_size[dim]) + dr = np.linalg.norm(rij) + df = -k * (dr - r0) + f_bond_vector = df * rij / dr + f_bonds[i, :] -= f_bond_vector + f_bonds[j, :] += f_bond_vector + + energy += 0.5 * k * (dr - r0) ** 2 + return energy
+ + +
[docs]def compute_angle_forces__plain(f_angles, r, bonds_3, box_size): + """Computes forces resulting from angular interactions + + .. deprecated:: 1.0.0 + :code:`compute_angle_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_angles.fill(0.0) + energy = 0.0 + + for a, b, c, theta0, k in bonds_3: + ra = r[a, :] - r[b, :] + rc = r[c, :] - r[b, :] + + for dim in range(len(ra)): + ra[dim] -= box_size[dim] * np.around(ra[dim] / box_size[dim]) + rc[dim] -= box_size[dim] * np.around(rc[dim] / box_size[dim]) + + xra = 1.0 / np.sqrt(np.dot(ra, ra)) + xrc = 1.0 / np.sqrt(np.dot(rc, rc)) + ea = ra * xra + ec = rc * xrc + + cosphi = np.dot(ea, ec) + theta = np.arccos(cosphi) + xsinph = 1.0 / np.sqrt(1.0 - cosphi**2) + + d = theta - theta0 + f = -k * d + + xrasin = xra * xsinph * f + xrcsin = xrc * xsinph * f + + fa = (ea * cosphi - ec) * xrasin + fc = (ec * cosphi - ea) * xrcsin + + f_angles[a, :] += fa + f_angles[c, :] += fc + f_angles[b, :] -= fa + fc + # f_angles[b, :] += -(fa + fc) + + energy -= 0.5 * f * d + + return energy
+ + +
[docs]def compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size): + """Computes forces resulting from dihedral interactions + + .. deprecated:: 1.0.0 + :code:`compute_dihedral_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_dihedrals.fill(0.0) + energy = 0.0 + + for a, b, c, d, coeffs, phase in bonds_4: + f = r[a, :] - r[b, :] + g = r[b, :] - r[c, :] + h = r[d, :] - r[c, :] + + for dim in range(3): + f -= box_size[dim] * np.around(f[dim] / box_size[dim]) + g -= box_size[dim] * np.around(g[dim] / box_size[dim]) + h -= box_size[dim] * np.around(h[dim] / box_size[dim]) + + v = np.cross(f, g) + w = np.cross(h, g) + vv = np.dot(v, v) + ww = np.dot(w, w) + gn = np.linalg.norm(g) + + cosphi = np.dot(v, w) + sinphi = np.dot(np.cross(v, w), g) / gn + phi = np.arctan2(sinphi, cosphi) + + fg = np.dot(f, g) + hg = np.dot(h, g) + sc = v * fg / (vv * gn) - w * hg / (ww * gn) + + df = 0 + + for m in range(len(coeffs[0])): + energy += coeffs[0][m] * (1 + np.cos(m * phi - coeffs[1][m])) + df += m * coeffs[0][m] * np.sin(m * phi - coeffs[1][m]) + + force_on_a = df * gn * v / vv + force_on_d = df * gn * w / ww + + f_dihedrals[a, :] -= force_on_a + f_dihedrals[b, :] += df * sc + force_on_a + f_dihedrals[c, :] -= df * sc + force_on_d + f_dihedrals[d, :] += force_on_d + return energy
+ + +
[docs]def dipole_forces_redistribution( + f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb +): + """Redistribute electrostatic forces calculated from topologically + reconstructed ghost dipole point charges to the backcone atoms of the protein. + """ + f_on_bead.fill(0.0) + for i, j, k, l, fd, matrix, dih_type, is_last in zip( + a, b, c, d, f_dipoles, trans_matrices, type_array, last_bb + ): + if dih_type == 1: + sum_force = fd[0] + fd[1] + diff_force = fd[0] - fd[1] + f_on_bead[i] += matrix[0] @ diff_force # Atom A + f_on_bead[j] += matrix[1] @ diff_force + 0.5 * sum_force # Atom B + f_on_bead[k] += matrix[2] @ diff_force + 0.5 * sum_force # Atom C + + if is_last == 1: + sum_force = fd[2] + fd[3] + diff_force = fd[2] - fd[3] + f_on_bead[j] += matrix[3] @ diff_force + f_on_bead[k] += matrix[4] @ diff_force + 0.5 * sum_force + f_on_bead[l] += matrix[5] @ diff_force + 0.5 * sum_force
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/_modules/hymd/hamiltonian.html b/v1.0.1/_modules/hymd/hamiltonian.html new file mode 100644 index 00000000..299f1c23 --- /dev/null +++ b/v1.0.1/_modules/hymd/hamiltonian.html @@ -0,0 +1,784 @@ + + + + + + hymd.hamiltonian — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.hamiltonian

+"""Interaction energy functionals.
+
+Implements field--particle interaction energy functionals depending on the
+field configuration. Extending HyMD with a new Hamiltonian is done by
+subclassing the :code:`Hamiltonian` superclass with logic intialized in the
+constructor.
+
+The grid-independent filtering function is defined in the :code:`Hamiltonian`
+superclass constructor. Hijack :code:`self.H` in a subclass to change the
+filter.
+"""
+import numpy as np
+import sympy
+
+
+
[docs]class Hamiltonian: + """Interaction energy functional superclass""" + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + self.config = config + self._setup()
+ +
[docs] def _setup(self): + """Superclass setup + + Sets up the grid-independent filtering function :code:`H`, and the + SymPy logic for symbolically differentiating interaction energy + functionals in Hamiltonian subclasses. + """ + if not hasattr(self.config, "simulation_volume"): + self.config.simulation_volume = np.prod(np.asarray(self.config.box_size)) + if not self.config.barostat: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.config.a = self.config.rho0 + if not self.config.rho0: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.phi = sympy.var("phi:%d" % (self.config.n_types)) + k = sympy.var("k:%d" % (3)) + + # electrostatics variables + self.psi = sympy.var("psi") + self.phi_q = sympy.var("phi_q") + if not self.config.self_energy: + self.config.self_energy = 0.0 + + def fourier_space_window_function(k): + return sympy.functions.elementary.exponential.exp( + -0.5 + * self.config.sigma**2 + * (k0**2 + k1**2 + k2**2) # noqa: F821, E501 + ) + + self.window_function_lambda = sympy.lambdify( + [k], fourier_space_window_function(k) + ) + + def H(k, v): + return v * self.window_function_lambda(k) + + self.H = H
+ + +
[docs]class SquaredPhi(Hamiltonian): + """Simple squared density interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + \\sum_k \\tilde\\phi_k + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`rho_0` is the + average density of the fully homogenous system. Expressing the species + densities in terms of fluctuations from the average, + + .. math:: + + \\mathrm{d}\\tilde\\phi_k = \\rho_0 - \\tilde\\phi_k, + + it is evident that this interaction energy functional is a slight change of + the :code:`DefaultNoChi` Hamiltonian, as the expanded interaction energy + density becomes + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + 6\\rho_0\\left[ + \\sum_k \\mathrm{d}\\tilde\\phi_k + \\right] + + + 9\\rho_0^2 + + + \\sum_k \\mathrm{d}\\tilde\\phi_k^2 + + + \\prod_{k\\not=l} + \\mathrm{d}\\tilde\\phi_k \\mathrm{d}\\tilde\\phi_l + \\right), + + identical to :code:`DefaultNoChi` apart from a constant energy shift + :math:`9\\rho_0^2`(which does not impact dynamics) and the + :math:`\\rho_0`--:math:`\\mathrm{d}\\tilde\\phi_k` cross-terms. These + cross-terms constitute contributions to the energy linear in + :math:`\\mathrm{d}\\tilde\\phi_k` absent in :code:`DefaultNoChi`, which has + only quadratic terms present. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(SquaredPhi, self).__init__(config) + super(SquaredPhi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0): + return 0.5 / (kappa * rho0) * (sum(phi)) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + ): + V_incompressibility = 1 / (kappa * rho0) * sum(phi) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultNoChi(Hamiltonian): + """Incompressibility-only interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. The :code:`SquaredPhi` Hamiltonian implements a similar + functional with an additional linear term component depending on + + .. math:: + + \\mathmr{d}\\tilde\\phi_k = \\tilde\\phi_k - \\rho_0 + + and not :math:`\\mathrm{d}\\tilde\\phi_k^2`. No explicit inter-species + interaction is present apart from the indirect interaction through the + incompressibility. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + hymd.input_parser.Config : + Configuration dataclass handler. + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultNoChi, self).__init__(config) + super(DefaultNoChi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0, a=self.config.a): + return 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultWithChi(Hamiltonian): + """Incompressibility and :math:`\\chi`-interactions energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = + \\frac{1}{2\\rho_0} + \\sum_{k,l}\\chi_{kl} \\tilde\\phi_k \\tilde\\phi_l + + + \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. :math:`\\chi_{ij}` is the Flory-Huggins-like + inter-species mixing energy. + """ + +
[docs] def __init__(self, config, unique_names, type_to_name_map): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultWithChi, self).__init__(config) + super(DefaultWithChi, self)._setup() + self.setup(unique_names, type_to_name_map)
+ +
[docs] def setup(self, unique_names, type_to_name_map): + """Setup the interaction energy potential and the external potential + + Parameters + ---------- + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + """ + self.type_to_name_map = type_to_name_map + self.chi_type_dictionary = { + tuple(sorted([c.atom_1, c.atom_2])): c.interaction_energy + for c in self.config.chi + } + self.phi_laplacian = [ + sympy.var("phi_laplacian%d(0:%d)" % (t, 3)) + for t in range(self.config.n_types) + ] + + def w( + phi, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + interaction = 0.0 + for i in range(self.config.n_types): + for j in range(i + 1, self.config.n_types): + ni = type_to_name_map[i] + nj = type_to_name_map[j] + names = sorted([ni, nj]) + c = chi_type_dictionary[tuple(names)] + + interaction += c * phi[i] * phi[j] / rho0 + incompressibility = 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + return incompressibility + interaction + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + t, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + + V_interaction = 0.0 + nk = type_to_name_map[t] + for i in range(self.config.n_types): + ni = type_to_name_map[i] + names = sorted([nk, ni]) + if ni != nk: + c = chi_type_dictionary[tuple(names)] + else: + c = 0.0 + # uncomment to count diagonal chi terms: + # c = chi_type_dictionary[tuple(names)] + V_interaction += c * phi[i] / rho0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[t])) + for t in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +def get_hamiltonian(config): + """Return appropriate Hamiltonian object based on the + config.hamiltonian string. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ---------- + hamiltonian : Hamiltonian + Hamiltonian object. + """ + if config.hamiltonian.lower() == "defaultnochi": + hamiltonian = DefaultNoChi(config) + elif config.hamiltonian.lower() == "defaultwithchi": + hamiltonian = DefaultWithChi( + config, config.unique_names, config.type_to_name_map + ) + elif config.hamiltonian.lower() == "squaredphi": + hamiltonian = SquaredPhi(config) + + return hamiltonian +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/_modules/hymd/input_parser.html b/v1.0.1/_modules/hymd/input_parser.html new file mode 100644 index 00000000..c17c331a --- /dev/null +++ b/v1.0.1/_modules/hymd/input_parser.html @@ -0,0 +1,1622 @@ + + + + + + hymd.input_parser — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.input_parser

+"""Parses and handles the configuration information provided for the simulation
+"""
+import copy
+import tomli
+import datetime
+import logging
+import warnings
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass, field
+from typing import List, Union, ClassVar
+from .force import Bond, Angle, Dihedral, Chi, Dielectric_type, propensity_potential_coeffs
+from .barostat import Target_pressure
+from .logger import Logger
+
+
+
[docs]@dataclass +class Config: + """Configuration object + + Handles and verifies the simulation configuration specified in the + configuration file. + + Attributes + ---------- + gas_constant : float + Constant value of the gas constant, R (equivalently the Boltzmann + constant) in the units used internally in HyMD. + coulomb_constant : float + Constant value of the Coulomb constant which converts electric field + values to forces and electric potential values to energies in the units + used internally in HyMD. + n_steps: int + Number of time steps in the simulation. + time_step: float + *Outer* time step used in the simulation. If the rRESPA intergrator is + used, the *inner* time step (the time step used in the integration of + intramolecular bending, stretching, and torsional forces) is + :code:`time_step / respa_inner`. + box_size : list[float] or (D,) numpy.ndarray + Simulation box size of simulation in :code:`D` dimensions in units of + nanometers. + mesh_size : list[int] or int or numpy.ndarray + Number of grid points used for the discrete density grid. + sigma : float + Filter width representing the effective coarse-graining level of the + particles in the simulation. + kappa : float + Compressibility parameter used in the relaxed incompressibility term in + the interaction energy functional. + n_print : int, optional + Frequency of trajectory/energy output to the H5MD trajectory/energy + output file (in units of number of time steps). + tau : float, optional + The time scale of the CSVR thermostat coupling. + start_temperature : float, optional + Generate starting temperature by assigning all particle velocities + randomly according to the Maxwell-Boltzmann distribution at + :code:`start_temperature` Kelvin prior to starting the simulation. + target_temperature : float, optional + Couple the system to a heat bath at :code:`target_temperature` Kelvin. + mass : float, optional + Mass of the particles in the simulation. + hamiltonian : str, optional + Specifies the interaction energy functional :math:`W[\\tilde\\phi]` + for use with the particle-field interactions. Options: + :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`. + domain_decomposition : int, optional + Specifies the interval (in time steps) of domain decomposition + exchange, involving all MPI ranks sending and receiving particles + according to the particles’ positions in the integration box and the + MPI ranks’ assigned domain. + integrator : str, optional + Specifies the time integrator used in the simulation. Options: + :code:`velocity-verlet` or :code:`respa`. + respa_inner : int, optional + The number of inner time steps in the rRESPA integrator. This denotes + the number of intramolecular force calculations (stretching, bending, + torsional) are performed between each impulse applied from the field + forces. + file_name : str, optional + File path of the parsed configuration file. + name : str, optional + Name for the simulation. + tags : list[str], optional + Tags for the simulation. + bonds : list[Bond], optional + Specifies harmonic stretching potentials between particles in the + same molecule. + angle_bonds : list[Angle], optional + Specifies harmonic angular bending potentials between particles in the + same molecule. + dihedrals : list[Dihedral], optional + Specifies four-particle torsional potentials by cosine series. + chi : list[Chi], optional + Specifies :math:`\\chi`-interaction parameters between particle + species. + n_particles : int, optional + Specifies the total number of particles in the input. Optional keyword + for validation, ensuring the input HDF5 topology has the correct number + of particles and molecules. + max_molecule_size : int, optional + Maximum size of any single molecule in the system. Used to speed up + distribution of particles onto MPI ranks in a parallel fashion. + n_flush : int, optional + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be + written to disk (in units of number of :code:`n_print`). + thermostat_work : float + Work performed by the thermostat on the system. + thermostat_coupling_groups : list[str], optional + Specifies individual groups coupling independently to the CSVR + thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and + :code:`"C"` type particles, + :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would + thermalise types :code:`"A"` and :code:`"B"` together and couple + :code:`"C"` type particles to a different thermostat (all individual + thermostats are at the same temperature, i.e. target_temperature + Kelvin). + initial_energy : float + Value of the total energy prior to the start of the simulation. + cancel_com_momentum : int, optional + If :code:`True`, the total linear momentum of the center of mass is + removed before starting the simulation. If an integer is specifed, the + total linear momentum of the center of mass is removed every + :code:`remove_com_momentum` time steps. If :code:`False`, the linear + momentum is never removed. + coulombtype : str, optional + Specifies the type of electrostatic Coulomb interactions in the system. + The strength of the electrostatic forces is modulated by the relative + dielectric constant of the simulation medium, specified with the + :code:`dielectric_const` keyword. Charges for individual particles are + specified in the structure/topology HDF5 input file, not in the + configuration file. If no charges (or peptide backbone dipoles) are + present, the electrostatic forces will not be calculated even if this + keyword is set to :code:`"PIC_Spectral"`. + dielectric_const : float, optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. When + using helical propensity dihedrals, this keyword must be specified—even + if electrostatics are not included with the :code:`coulombtype` + keyword. + dielectric_type: list[float], optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. The list assigns + relative dielectric values to each bead type, and an anisotropic + dielectric function is obtained from a weighted average. + + + See also + -------- + hymd.input_parser.Bond : + Two-particle bond type dataclass. + hymd.input_parser.Angle : + Three-particle bond type dataclass. + hymd.input_parser.Dihedral : + Four-particle bond type dataclass. + """ + + gas_constant: ClassVar[float] = 0.0083144621 # kJ mol-1 K-1 + coulomb_constant: ClassVar[float] = 138.935458 # kJ nm mol-1 e-2 + + n_steps: int + time_step: float + mesh_size: Union[Union[List[int], np.ndarray], int] + sigma: float + kappa: float + + dtype: np.dtype = None + box_size: Union[List[float], np.ndarray] = None + n_print: int = None + tau: float = None + start_temperature: Union[float, bool] = None + target_temperature: Union[float, bool] = None + mass: float = None + hamiltonian: str = None + domain_decomposition: Union[int, bool] = None + integrator: str = None + respa_inner: int = 1 + file_name: str = "<config file path unknown>" + name: str = None + tags: List[str] = field(default_factory=list) + bonds: List[Bond] = field(default_factory=list) + angle_bonds: List[Angle] = field(default_factory=list) + dihedrals: List[Dihedral] = field(default_factory=list) + chi: List[Chi] = field(default_factory=list) + n_particles: int = None + max_molecule_size: int = None + n_flush: int = None + thermostat_work: float = 0.0 + thermostat_coupling_groups: List[List[str]] = field(default_factory=list) + initial_energy: float = None + cancel_com_momentum: Union[int, bool] = False + coulombtype: str = None + convergence_type: str = None + pol_mixing: float = None + dielectric_const: float = None + conv_crit: float = None + dielectric_type: List[Dielectric_type] = field(default_factory=list) + self_energy: float = None + type_charges: Union[List[float], np.ndarray] = None + + # For NPT runs + rho0: float = None + a: float = None + pressure: bool = False + barostat: str = None + barostat_type: str = None + tau_p: float = None + target_pressure: List[Target_pressure] = field(default_factory=list) + n_b: int = None + m: List[float] = field(default_factory=list) + + def __str__(self): + target_pressure_str = "\ttarget_pressure:\n" + "".join( + "\t\tP_L: " + + f"{self.target_pressure.P_L}\n" + + "\t\tP_N: " + + f"{self.target_pressure.P_N}\n" + ) + bonds_str = "\tbonds:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " f"{k.equilibrium}, {k.strength}\n") + for k in self.bonds + ] + ) + angle_str = "\tangle_bonds:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3}: " + + f"{k.equilibrium}, {k.strength}\n" + ) + for k in self.angle_bonds + ] + ) + dihedrals_str = "\tdihedrals:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: " + # This might need to be fixed/made prettier, probably + # there's an easier way + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ).join( + map( + str, + [ + [round(num, 3) for num in c_in] + if isinstance(c_in, list) + else c_in + for c_in in k.coeffs + ], + ) + ) + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ) + + f"dih_type = {k.dih_type}\n" + ) + for k in self.dihedrals + ] + ) + chi_str = "\tchi:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " + f"{k.interaction_energy}\n") + for k in self.chi + ] + ) + + """ If dielectric wanted as dictionary + dielectric_type_str = "\tdielectric_type:\n" + "".join( + [ + (f"\t\t{k.atom_1}: " + f"{k.dielectric_value}\n") + for k in self.dielectric_type + ] + ) + + """ + + thermostat_coupling_groups_str = "" + if any(self.thermostat_coupling_groups): + thermostat_coupling_groups_str = ( + "\tthermostat_coupling_groups:\n" + + "".join( + [ + "\t\t" + ", ".join([f"{n}" for n in ng]) + "\n" + for ng in self.thermostat_coupling_groups + ] + ) + ) + + ret_str = f'\n\n\tConfig: {self.file_name}\n\t{50 * "-"}\n' + for k, v in self.__dict__.items(): + if k not in ( + "target_pressure", + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "thermostat_coupling_groups", + ): + ret_str += f"\t{k}: {v}\n" + ret_str += ( + target_pressure_str + + bonds_str + + angle_str + + dihedrals_str + + chi_str + + thermostat_coupling_groups_str + ) + return ret_str
+ + +
[docs]def read_config_toml(file_path): + with open(file_path, "r") as in_file: + file_content = in_file.read() + return file_content
+ +
[docs]def parse_config_toml(toml_content, file_path=None, comm=MPI.COMM_WORLD): + config_dict = {} + + # read toml to a dictionary + toml_content = tomli.loads(toml_content) + + # Defaults = None + for n in ( + "box_size", + "n_print", + "tau", + "start_temperature", + "target_temperature", + "mass", + "hamiltonian", + "domain_decomposition", + "integrator", + "name", + "n_particles", + "max_molecule_size", + "coulombtype", + "convergence_type", + "dielectric_const", + "pol_mixing", + "conv_crit", + "dielectric_type", + "n_b", + "box_size", + "n_flush", + "self_energy", + "dtype", + ): + config_dict[n] = None + + # Defaults = [] + + for n in ( + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "tags", + "m", + "dielectric_type", + "target_pressure", + "type_charges", + ): + config_dict[n] = [] + + # Defaults: bool + config_dict["pressure"] = False + + # Flatten the .toml dictionary, ignoring the top level [tag] directives (if + # any). + for k, v in toml_content.items(): + if isinstance(v, dict): + if k == "nn": # Don't parse diff-hymd optimization options + continue + for nested_k, nested_v in v.items(): + config_dict[nested_k] = nested_v + else: + config_dict[k] = v + for k, v in config_dict.items(): + if k == "bonds": + config_dict["bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["bonds"][i] = Bond( + atom_1=b[0], + atom_2=b[1], + equilibrium=b[2], + strength=b[3], + ) + if k == "angle_bonds": + config_dict["angle_bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["angle_bonds"][i] = Angle( + atom_1=b[0], + atom_2=b[1], + atom_3=b[2], + equilibrium=b[3], + strength=b[4], + ) + if k == "dihedrals": + config_dict["dihedrals"] = [None] * len(v) + for i, b in enumerate(v): + try: + dih_type = int(b[2][0]) + except IndexError: + Logger.rank0.log( + logging.WARNING, "Dihedral type not provided, defaulting to 0." + ) + dih_type = 0 + + # Probably it's better to move this in check_dihedrals? + wrong_len = len(b[1]) not in (1, 2) + wrong_type_1 = len(b[1]) == 1 and not isinstance(b[1][0], float) + wrong_type_2 = len(b[1]) == 2 and not isinstance(b[1][0], list) + if wrong_len or wrong_type_1 or wrong_type_2: + err_str = ( + "The coefficients specified for the dihedral type " + "(0) do not match the correct structure. Either " + "use [lambda] or [[cn_prop], [dn_prop]], or select" + " the correct dihedral type." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise RuntimeError(err_str) + + # FIXME: this is messy af, I don't like it + if dih_type == 0 and isinstance(b[1][0], (float, int)): + coeff = propensity_potential_coeffs(b[1][0]) + elif dih_type == 1 and len(b[1]) == 3: + coeff = np.array( + propensity_potential_coeffs(b[1][0][0]).tolist() + + b[1][1:] + ) + elif dih_type == 2: + coeff = np.array(b[1]) + else: + coeff = np.insert(np.array(b[1]), 2, np.zeros((2, 5)), axis=0) + + config_dict["dihedrals"][i] = Dihedral( + atom_1=b[0][0], + atom_2=b[0][1], + atom_3=b[0][2], + atom_4=b[0][3], + coeffs=coeff, + dih_type=dih_type, + ) + if k == "chi": + config_dict["chi"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0], c[1]]) + config_dict["chi"][i] = Chi( + atom_1=c_[0], atom_2=c_[1], interaction_energy=c[2] + ) + + """ + if k == "dielectric_type": + config_dict["dielectric_type"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0][0]]) + config_dict["dielectric_type"][i] = Dielectric_type( + atom_1=c_[0], dielectric_value=c[1][0] + ) + """ + if k == "target_pressure": + if len(v) == 2: + config_dict["target_pressure"] = Target_pressure( + P_L=v[0], + P_N=v[1], # check condition # V array (still read as array?) + ) + elif len(v) == 1: + config_dict["target_pressure"] = Target_pressure(P_L=v[0], P_N=None) + else: + config_dict["target_pressure"] = Target_pressure(P_L=None, P_N=None) + + if file_path is not None: + config_dict["file_name"] = file_path + + for n in ( + "n_steps", "time_step", "mesh_size", "sigma", "kappa" + ): + if n not in config_dict: + err_str = ( + f"No {n} specified in config file {file_path}. Unable to start" + f" simulation." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return Config(**config_dict)
+ + +
[docs]def check_n_particles(config, indices, comm=MPI.COMM_WORLD): + n_particles = comm.allreduce(len(indices), MPI.SUM) + if config.n_particles is None: + config = copy.deepcopy(config) + config.n_particles = n_particles + info_str = ( + f"No n_particles found in toml file {config.file_name}, defaulting" + f" to indices.shape ({n_particles})" + ) + Logger.rank0.log(logging.INFO, info_str) + return config + + if n_particles != config.n_particles: + warn_str = ( + f"n_particles in {config.file_name} ({config.n_particles}) does " + "not match the shape of the indices array in the .HDF5 file " + f"({n_particles}). Defaulting to using indices.shape " + f"({n_particles})" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.n_particles = n_particles + return config
+ + +
[docs]def check_max_molecule_size(config, comm=MPI.COMM_WORLD): + if config.max_molecule_size is None: + info_str = ( + f"No max_molecule_size found in toml file {config.file_name}, " + f"defaulting to 201" + ) + Logger.rank0.log(logging.INFO, info_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + + if config.max_molecule_size < 1: + warn_str = ( + f"max_molecule_size in {config.file_name} must be a positive " + f"integer, not {config.max_molecule_size}, defaulting to 201" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + return config
+ + +def _find_unique_names(config, names, comm=MPI.COMM_WORLD): + unique_names = np.unique(names) + receive_buffer = comm.gather(unique_names, root=0) + + gathered_unique_names = None + if comm.Get_rank() == 0: + gathered_unique_names = np.unique(np.concatenate(receive_buffer)) + unique_names = comm.bcast(gathered_unique_names, root=0) + unique_names = sorted([n.decode("UTF-8") for n in unique_names]) + config.unique_names = unique_names + config.n_types = len(unique_names) + return config + + +def _setup_type_to_name_map(config, names, types, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + name_to_type_ = {} + for n, t in zip(names, types): + n = n.decode("utf-8") + if n not in name_to_type_: + name_to_type_[n] = t + receive_buffer = comm.gather(name_to_type_, root=0) + gathered_dict = None + if comm.Get_rank() == 0: + gathered_dict = {} + for d in receive_buffer: + for k, v in d.items(): + if k not in gathered_dict: + gathered_dict[k] = v + else: + assert v == gathered_dict[k] + name_to_type_map = comm.bcast(gathered_dict, root=0) + config.name_to_type_map = name_to_type_map + config.type_to_name_map = {v: k for k, v in name_to_type_map.items()} + return config + + +
[docs]def check_bonds(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for b in config.bonds: + if b.atom_1 not in unique_names or b.atom_2 not in unique_names: + missing_str = "" + if b.atom_1 not in unique_names: + if b.atom_2 not in unique_names: + if b.atom_1 == b.atom_2: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"neither {b.atom_1}, {b.atom_2} atoms" + else: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"no {b.atom_2} atoms" + + warn_str = ( + f"Bond type {b.atom_1}--{b.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_angles(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for a in config.angle_bonds: + if ( + a.atom_1 not in unique_names + or a.atom_2 not in unique_names + or a.atom_3 not in unique_names + ): + missing = [ + a.atom_1 not in unique_names, + a.atom_2 not in unique_names, + a.atom_3 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([a.atom_1, a.atom_2, a.atom_3]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Angle bond type {a.atom_1}--{a.atom_2}--{a.atom_3} " + f"specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_dihedrals(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for d in config.dihedrals: + if ( + d.atom_1 not in unique_names + or d.atom_2 not in unique_names + or d.atom_3 not in unique_names + or d.atom_4 not in unique_names + ): + missing = [ + d.atom_1 not in unique_names, + d.atom_2 not in unique_names, + d.atom_3 not in unique_names, + d.atom_4 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([d.atom_1, d.atom_2, d.atom_3, d.atom_4]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Dihedral type {d.atom_1}--{d.atom_2}--{d.atom_3}--{d.atom_4}" + f" specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_chi(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for c in config.chi: + if c.atom_1 not in unique_names or c.atom_2 not in unique_names: + missing_str = "" + if c.atom_1 not in unique_names: + if c.atom_2 not in unique_names: + if c.atom_1 == c.atom_2: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"neither {c.atom_1}, {c.atom_2} atoms" + else: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"no {c.atom_2} atoms" + + warn_str = ( + f"Chi interaction {c.atom_1}--{c.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + for i, n in enumerate(unique_names): + for m in unique_names[i + 1 :]: + found = False + for c in config.chi: + if (c.atom_1 == n and c.atom_2 == m) or ( + c.atom_1 == m and c.atom_2 == n + ): + found = True + if not found: + config.chi.append(Chi(atom_1=n, atom_2=m, interaction_energy=0.0)) + warn_str = ( + f"Atom types {n} and {m} found in the " + f"system, but no chi interaction {n}--{m} " + f"specified in {config.file_name}. Defaulting to " + f"chi[{n}, {m}] = 0" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_box_size(config, input_box, comm=MPI.COMM_WORLD): + if config.box_size is not None: + config.box_size = np.array(config.box_size, dtype=np.float32) + if input_box.all() and not np.allclose(config.box_size, input_box, atol=0.009): + err_str = ( + f"Box size specified in {config.file_name}: " + f"{config.box_size} does not match input box:" + f"{input_box}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + else: + if input_box.all(): + config.box_size = input_box + else: + err_str = f"No box information found" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + for b in config.box_size: + if b <= 0.0: + err_str = ( + f"Invalid box size specified in {config.file_name}: " + f"{config.box_size}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return config
+ + +
[docs]def check_integrator(config, comm=MPI.COMM_WORLD): + if config.integrator.lower() not in ("velocity-verlet", "respa"): + err_str = ( + f"Invalid integrator specified in {config.file_name}: " + f'{config.integrator}. Available options "velocity-verlet" or ' + f'"respa".' + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + if config.integrator.lower() == "respa": + if isinstance(config.respa_inner, float): + warn_str = ( + f"Number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner} specified " + f"as float, using {int(config.respa_inner)}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = int(config.respa_inner) + elif not isinstance(config.respa_inner, int): + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + + if config.respa_inner <= 0: + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + if config.integrator.lower() == "velocity-verlet" and config.respa_inner != 1: + warn_str = ( + f"Integrator type Velocity-Verlet specified in {config.file_name} " + f"and inner rRESPA time steps set to {config.respa_inner}. " + f"Using respa_inner = 1" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = 1 + + return config
+ + +
[docs]def check_hamiltonian(config, comm=MPI.COMM_WORLD): + valid_hamiltonians = ["defaultnochi", "defaultwithchi", "squaredphi"] + + if config.hamiltonian is None: + if len(config.chi) == 0: + warn_str = ( + f"No hamiltonian form and no chi interactions specified in " + f"{config.file_name}, defaulting to DefaultNoChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultNoChi" + else: + warn_str = ( + f"No hamiltonian form specified in {config.file_name}, but " + f"chi interactions are specified, defaulting to " + f"DefaultWithChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultWithChi" + elif config.hamiltonian.lower() not in valid_hamiltonians: + err_str = ( + f"The specified Hamiltonian {config.hamiltonian} was not " + f"recognized as a valid Hamiltonian." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise NotImplementedError(err_str) + + return config
+ + +
[docs]def check_n_flush(config, comm=MPI.COMM_WORLD): + if config.n_print: + if config.n_flush is None: + config.n_flush = 10000 // config.n_print + return config
+ + +
[docs]def check_n_print(config, comm=MPI.COMM_WORLD): + if ( + not isinstance(config.n_print, int) + and not isinstance(config.n_print, float) + and config.n_print is not None + ): + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if config.n_print is None or config.n_print <= 0: + config.n_print = False + elif not isinstance(config.n_print, int): + if isinstance(config.n_print, float): + warn_str = ( + f"n_print is a float ({config.n_print}), not int, using " + f"{int(round(config.n_print))}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + config.n_print = int(round(config.n_print)) + else: + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + return config
+ + +
[docs]def check_tau(config, comm=MPI.COMM_WORLD): + if config.tau is None and config.target_temperature is not None: + warn_str = "target temp specified but no tau, defaulting 0.7" + config.tau = 0.7 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_start_and_target_temperature(config, comm=MPI.COMM_WORLD): + """Validate provided starting and target thermostat temperatures + + Assesses the provided temperature target and ensures it is a non-negative + floating point number or :code:`False`. Ensures the starting temperature is + a non-negative floating point number or :code:`False`. + + If the value for either is :code:`None`, the returned configuration object + has the values defaulted to :code:`False` in each case. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ------- + validated_config : Config + Configuration object with validated :code:`target_temperature` and + :code:`start_temperature`. + """ + for t in ("start_temperature", "target_temperature"): + if getattr(config, t) is not None: + try: + if getattr(config, t) < 0: + warn_str = ( + f"{t} set to negative value ({getattr(config, t)}), " + f"defaulting to False" + ) + setattr(config, t, False) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + except TypeError as e: + err_str = ( + f"Could not interpret {t} = {repr(getattr(config, t))} as " + f"a number." + ) + raise TypeError(err_str) from e + + if config.start_temperature is None: + config.start_temperature = False + if config.target_temperature is None: + config.target_temperature = False + return config
+ + +
[docs]def check_mass(config, comm=MPI.COMM_WORLD): + if config.mass is None: + info_str = "no mass specified, defaulting to 72.0" + config.mass = 72.0 + Logger.rank0.log(logging.INFO, info_str) + elif not isinstance(config.mass, int) and not isinstance(config.mass, float): + err_str = ( + f"specified mass is invalid type {config.mass}, " f"({type(config.mass)})" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + elif config.mass < 0: + err_str = f"invalid mass specified, {config.mass}" + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + else: + config.mass = float(config.mass) + + return config
+ + +
[docs]def check_domain_decomposition(config, comm=MPI.COMM_WORLD): + dd = config.domain_decomposition + if dd is None or dd is False: + config.domain_decomposition = False + return config + + if isinstance(dd, int): + if dd < 0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + elif isinstance(dd, float): + if dd < 0.0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + else: + warn_str = ( + f"domain_decomposition ({config.domain_decomposition}) is not " + f"an integer, using {int(round(dd))}" + ) + config.domain_decomposition = int(round(dd)) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + else: + err_str = ( + f"invalid value for domain_decomposition " + f"({config.domain_decomposition}) use an integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + return config
+ + +
[docs]def check_name(config, comm=MPI.COMM_WORLD): + if config.name is None: + root_current_time = "" + if comm.Get_rank() == 0: + root_current_time = datetime.datetime.now().strftime("%m/%d/%Y, %H:%M:%S") + current_time = comm.bcast(root_current_time, root=0) + + if config.name is None: + config.name = "sim" + current_time + else: + config.name = str(config.name) + return config
+ + +
[docs]def check_NPT_conditions(config, comm=MPI.COMM_WORLD): + """ + Check validity of barostat_type, barostat, + a, rho0, target_pressure, tau_p + """ + if config.barostat is None: + if ( + config.tau_p is not None + or (config.target_pressure.P_L and config.target_pressure.P_N) is not None + ): + err_str = ( + "barostat not specified but config.tau_p " + "or config.target_pressure specified, cannot start simulation {config.barostat}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.a: + warn_str = "a specified but no barostat," "setting a to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.rho0: + warn_str = ( + "rho0 specified but no barostat," "setting rho0 to average density" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + if config.barostat is not None: + if not config.barostat_type: + config.barostat_type = "berendsen" + warn_str = "barostat_type not specified," "setting to berendsen" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.barostat != "isotropic" and config.barostat != "semiisotropic": + err_str = "barostat option not recognised. Valid options: isotropic, semiisotropic" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.target_pressure.P_L is None: + config.target_pressure.P_L = 1.0 # bar + config.target_pressure.P_N = None + if config.barostat == "semiisotropic": + config.target_pressure.P_N = 1.0 # bar + warn_str = ( + "barostat specified but no target_pressure, defaulting to 1.0 bar" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.tau_p is None: + if config.tau <= 0.1: + config.tau_p = config.tau * 10.0 + else: + config.tau_p = 1.0 + warn_str = "barostat specified but no tau_p, defaulting to " + str( + config.tau_p + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if not config.a: + err_str = "a not specified; cannot start simulation {config.a}" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if not config.rho0: + warn_str = "rho0 not specified;" "setting rho0 to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + return config
+ + +
[docs]def check_thermostat_coupling_groups(config, comm=MPI.COMM_WORLD): + if any(config.thermostat_coupling_groups): + found = [0 for _ in config.unique_names] + unique_names = [n for n in config.unique_names] + for i, group in enumerate(config.thermostat_coupling_groups): + for species in group: + try: + ind = unique_names.index(species) + found[ind] += 1 + except ValueError as e: + err_str = ( + f"Particle species {species} specified in thermostat " + f"coupling group {i}, but no {species} particles were " + "found in the system." + ) + raise ValueError(err_str) from e + if any([True if f > 1 else False for f in found]): + for i, f in enumerate(found): + if f > 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} specified in multiple " + "thermostat coupling groups; " + f"{config.thermostat_coupling_groups}." + ) + raise ValueError(err_str) + if not all([True if f == 1 else False for f in found]): + for i, f in enumerate(found): + if f != 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} not specified in any " + f"thermostat coupling group, but {species} particles " + "were found in the system" + ) + raise ValueError(err_str) + return config
+ + +
[docs]def check_m(config, comm=MPI.COMM_WORLD): + if config.m == []: + config.m = [1.0 for t in range(config.n_types)] + return config
+ + +
[docs]def check_n_b(config, comm=MPI.COMM_WORLD): + if config.n_b is None: + warn_str = f"config.n_b not specified." "Defaulting to 1" + config.n_b = 1 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_cancel_com_momentum(config, comm=MPI.COMM_WORLD): + if isinstance(config.cancel_com_momentum, int): + if config.cancel_com_momentum == 0 or config.cancel_com_momentum < 0: + config.cancel_com_momentum = False + elif not isinstance(config.cancel_com_momentum, bool): + err_str = ( + f"Could not interpret {config.cancel_com_momentum} as an integer " + f"or boolean." + ) + raise ValueError(err_str) + return config
+ + +
[docs]def sort_dielectric_by_type_id(config, charges, types): + """ + Creates a list of length N CG-particles, sorted after the charges from + the input HDF5 file. Used in file_io.py + """ + dielectric_val = np.zeros(config.n_types) + for j in range(config.n_types): + name = config.dielectric_type[j][0][0] + type_id = config.name_to_type_map[name] + dielectric_val[type_id] = config.dielectric_type[j][1][0] + config.dielectric_type = dielectric_val.copy() + + N = len(charges) + len_list = np.zeros(config.n_types) + dielectric_by_types = np.zeros(N) + for i in range(N): + dielectric_by_types[i] = dielectric_val[types[i]] + # print("types ", types) + # print("diel val", dielectric_by_types) + # print("charges", charges) + # print(config.name_to_type_map) + return dielectric_by_types # by types with each particle id
+ + +
[docs]def check_charges_types_list(config, types, charges, comm=MPI.COMM_WORLD): + """ + Creates a list of charge values of length types. + Charges are sorted according to type ID. Used in field.py. + # TODO: this is messy, we should fix it + """ + if charges is None: + config.type_charges = [0.0] * config.n_types + return config + + check_val = -100.0 # some random value that will never be encountered + charges_list = np.full(config.n_types, check_val) # gatherv cant handle None + rank = comm.Get_rank() + # print(charges_list) + for t_ in range(config.n_types): + if t_ in types: + charges_list[t_] = charges[types == t_][0] + + nprocs = int(comm.Get_size()) + recv_charges = None + if rank == 0: + recv_charges = np.full( + config.n_types * nprocs, check_val + ) # gatherv cant handle None + comm.Gather(charges_list, recv_charges, root=0) + + ## make a charges list + if rank == 0: + config_charges = np.zeros(config.n_types) + test_config = np.full(config.n_types, check_val) + for j in range(nprocs): + for i in range(config.n_types): + if recv_charges[i + j * config.n_types] != check_val: + config_charges[i] = recv_charges[i + j * config.n_types] + if np.any([test_config, config_charges]): + continue + else: + break + + # print(config_charges) + # print(config.name_to_type_map) + # print(charges[types == 0][0],charges[types == 1][0],charges[types == 2][0],charges[types == 3][0], + # charges[types == 4][0]) + else: + config_charges = np.zeros(config.n_types) + + comm.Bcast(config_charges, root=0) + # print("config_charges", config_charges , "rank", rank) + # print(recv_charges) + # rank = comm.Get_rank() + # print(all_charges) + config.type_charges = config_charges + return config
+ + +
[docs]def check_dielectric(config, comm=MPI.COMM_WORLD): + """ + Error handling for electrostatics. + Unit testing of toml/tomli input. + """ + err_str_const = "Dielectric constant not given." + if config.coulombtype == "PIC_Spectral": + assert config.dielectric_const != None, err_str_const + + err_str = "Dielectric list is empty." + if config.coulombtype == "PIC_Spectral_GPE": + assert len(config.dielectric_type) != 0, err_str + # default values + if config.pol_mixing is None: + config.pol_mixing = 0.6 + if config.conv_crit is None: + config.conv_crit = 1e-6 + return config
+ + +
[docs]def check_charges(config, charges, comm=MPI.COMM_WORLD): + """Check if charges across ranks sum to zero. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of floats with charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + """ + total_charge = comm.allreduce(np.sum(charges), MPI.SUM) + + if not np.isclose(total_charge, 0.0): + warn_str = ( + f"Charges in the input file do not sum to zero. " + f"Total charge is {total_charge}." + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + # if charges are ok, compute self energy + if config.coulombtype == "PIC_Spectral": + from .field import compute_self_energy_q + + config.self_energy = compute_self_energy_q(config, charges, comm=comm) + + return config
+ + +
[docs]def check_config( + config, indices, names, types, charges, input_box, comm=MPI.COMM_WORLD +): + """Performs various checks on the specfied config to ensure consistency + + Parameters + ---------- + config : Config + Configuration object. + indices : (N,) numpy.ndarray + Array of integer indices for :code:`N` particles. + names : (N,) numpy.ndarray + Array of string names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of integer type indices for :code:`N` particles. + charges : (N,) numpy.ndarray + Array of floats charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + + Returns + ------- + config : Config + Validated configuration object. + """ + config = _find_unique_names(config, names, comm=comm) + if types is not None: + config = _setup_type_to_name_map(config, names, types, comm=comm) + config = check_box_size(config, input_box, comm=comm) + config = check_integrator(config, comm=comm) + config = check_max_molecule_size(config, comm=comm) + config = check_tau(config, comm=comm) + config = check_start_and_target_temperature(config, comm=comm) + config = check_mass(config, comm=comm) + config = check_domain_decomposition(config, comm=comm) + config = check_name(config, comm=comm) + config = check_n_particles(config, indices, comm=comm) + config = check_chi(config, names, comm=comm) + config = check_bonds(config, names, comm=comm) + config = check_angles(config, names, comm=comm) + config = check_dihedrals(config, names, comm=comm) + config = check_hamiltonian(config, comm=comm) + config = check_NPT_conditions(config, comm=comm) + config = check_n_b(config, comm=comm) + config = check_m(config, comm=comm) + config = check_thermostat_coupling_groups(config, comm=comm) + config = check_cancel_com_momentum(config, comm=comm) + config = check_dielectric(config, comm=comm) + config = check_n_print(config, comm=comm) + config = check_n_flush(config, comm=comm) + config = check_charges_types_list(config, types, charges, comm=comm) + if charges is not None: + config = check_charges(config, charges, comm=comm) + + return config
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/_modules/hymd/integrator.html b/v1.0.1/_modules/hymd/integrator.html new file mode 100644 index 00000000..e5e37ebd --- /dev/null +++ b/v1.0.1/_modules/hymd/integrator.html @@ -0,0 +1,345 @@ + + + + + + hymd.integrator — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.integrator

+"""Integrates equations of motion.
+
+Implements the Velocity Verlet integrator. The *reversible reference system
+propagator algorithm* (rRESPA) integrator uses the Velocity Verlet functions
+inside the MD loop in the main module.
+"""
+
+
+
[docs]def integrate_velocity(velocities, accelerations, time_step): + """Velocity update step of the Velocity Verlet integration algorithm. + + Computes the velocity update step of the Velocity Verlet algorithm. The + :code:`velocities` argument is **not** changed in place. + + Parameters + ---------- + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + accelerations : (N, D) numpy.ndarray + Array of accelerations of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step + + .. math:: \\mathbf{v}_{\\text{new}} = \\mathbf{v} + \\frac{\\Delta t}{2m} + \\mathbf{f} + + before the positions are moved a full step using the updated half-step + velocities. + + See Also + -------- + integrate_position : The position update step of the Velocity Verlet + algorithm. + """ + return velocities + 0.5 * time_step * accelerations
+ + +
[docs]def integrate_position(positions, velocities, time_step): + """Position update step of the Velocity Verlet integration algorithm. + + Computes the position update step of the Velocity Verlet algorithm. The + :code:`positions` argument is **not** changed in place. + + Parameters + ---------- + positions : (N, D) numpy.ndarray + Array of positions of :code:`N` particles in :code:`D` dimensions. + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step, then the positions are updated a full step using the updated + velocities + + .. math:: \\mathbf{x}_{\\text{new}} = \\mathbf{x} + \\Delta t \\mathbf{v} + + See Also + -------- + integrate_velocity : The velocity update step of the Velocity Verlet + algorithm. + """ + return positions + time_step * velocities
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/_modules/hymd/logger.html b/v1.0.1/_modules/hymd/logger.html new file mode 100644 index 00000000..89fab6b2 --- /dev/null +++ b/v1.0.1/_modules/hymd/logger.html @@ -0,0 +1,534 @@ + + + + + + hymd.logger — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.logger

+"""Handles event logging for simulation information, warnings, and errors.
+"""
+import sys
+import os
+import logging
+from mpi4py import MPI
+from .version import __version__
+
+
+
[docs]class MPIFilterRoot(logging.Filter): + """Log output Filter wrapper class for the root MPI rank log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + if self.comm.Get_rank() == 0: + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True + else: + return False
+ + +
[docs]class MPIFilterAll(logging.Filter): + """Log output Filter wrapper class for the all-MPI-ranks log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True
+ + +class MPIFilterStdout(logging.Filter): + """Log output Filter wrapper class for filtering STDOUT log""" + + def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.funcName = "replica 0 " + record.funcName + if MPI.COMM_WORLD.Get_rank() == 0: + record.rank = MPI.COMM_WORLD.Get_rank() + record.size = MPI.COMM_WORLD.Get_size() + return True + else: + return False + + +
[docs]class Logger: + """Log output handler class + + Notes + ----- + This wraps the default python library :code:`logging`, see + `docs.python.org/3/library/logging.html`_. + + .. _`docs.python.org/3/library/logging.html`: + https://docs.python.org/3/library/logging.html + + Attributes + ---------- + level : int + Determines the verbosity level of the log, corresponding to + logging.level. Numerical values :code:`50` (:code:`logging.CRITICAL`), + :code:`40` (:code:`logging.ERROR`), :code:`30` + (:code:`logging.WARNING`), :code:`20` (:code:`logging.INFO`), + :code:`10` (:code:`logging.DEBUG`), and :code:`0` + (:code:`logging.UNSET`) are supported values. Any log event message + less severe than the specified level is ignored. All other event + messages are emitted. + log_file : str + Path to output log file. + format : str + Prepended dump string for each log event. Specifies the log event + level, the module emitting the event, the code line, the enclosing + function name, and the MPI rank writing the message. + date_format : str + Prepends the date before all log event messages. + formatter : logging.Formatter + Formatter handling the prepending of the information in `format` and + `date_format` to each log event message. Used by default for all + loggers. + rank0 : logging.Logger + Default logger object for the root MPI rank. + all_ranks : logging.Logger + Default logger object for messages being emitted from all MPI ranks + simultaneously. + """ + + level = None + log_file = None + format = " %(levelname)-8s [%(filename)s:%(lineno)d] <%(funcName)s> {rank %(rank)d/%(size)d} %(message)s" # noqa: E501 + date_format = "%(asctime)s" + formatter = logging.Formatter(fmt=date_format + format) + rank0 = logging.getLogger("HyMD.rank_0") + all_ranks = logging.getLogger("HyMD.all_ranks") + +
[docs] @classmethod + def setup(cls, default_level=logging.INFO, log_file=None, verbose=False, comm=MPI.COMM_WORLD): + """Sets up the logger object. + + If a :code:`log_file` path is provided, log event messages are output + to it. Otherwise, the logging messages are emitted to stdout. + + Parameters + ---------- + default_level : int, optional + Default verbosity level of the logger. Unless specified, it is + :code:`10` (:code:`logging.INFO`). + log_file : str, optional + Path to output log file. If `None` or not priovided, no log file is + used and all logging is done to stdout. + verbose : bool, optional + Increases the logging level to :code:`30` (:code:`logging.WARNING`) + if True, otherwise leaves the logging level unchanged. + """ + cls.level = default_level + cls.log_file = log_file + + log_to_stdout = False + if verbose: + log_to_stdout = True + + level = default_level + if not verbose: + level = logging.WARNING + cls.rank0.setLevel(level) + cls.all_ranks.setLevel(level) + + root_filter = MPIFilterRoot(comm) + all_filter = MPIFilterAll(comm) + cls.rank0.addFilter(root_filter) + cls.all_ranks.addFilter(all_filter) + + if (not log_file) and (not log_to_stdout): + return + if log_file: + cls.log_file_handler = logging.FileHandler(log_file) + cls.log_file_handler.setLevel(level) + cls.log_file_handler.setFormatter(cls.formatter) + + cls.rank0.addHandler(cls.log_file_handler) + cls.all_ranks.addHandler(cls.log_file_handler) + if log_to_stdout: + cls.log_to_stdout = True + cls.stdout_handler = logging.StreamHandler() + cls.stdout_handler.setLevel(level) + cls.stdout_handler.setStream(sys.stdout) + cls.stdout_handler.setFormatter(cls.formatter) + cls.stdout_handler.addFilter(MPIFilterStdout()) + + cls.rank0.addHandler(cls.stdout_handler) + cls.all_ranks.addHandler(cls.stdout_handler)
+ + +def format_timedelta(timedelta): + days = timedelta.days + hours, rem = divmod(timedelta.seconds, 3600) + minutes, seconds = divmod(rem, 60) + microseconds = timedelta.microseconds + ret_str = "" + if days != 0: + ret_str += f"{days} days " + ret_str += f"{hours:02d}:{minutes:02d}:{seconds:02d}.{microseconds:06d}" + return ret_str + + +def get_version(): + # Check if we are in a git repo and grab the commit hash and the branch if + # we are, append it to the version number in the output specification. + try: + import git + + try: + repo_dir = os.path.abspath( + os.path.join(os.path.dirname(__file__), os.pardir) + ) + repo = git.Repo(repo_dir) + commit = str(repo.head.commit)[:7] + branch = repo.active_branch + version = f"{__version__} [{branch} branch commit {commit}]" + except git.exc.InvalidGitRepositoryError: + version = f"{__version__}" + except ModuleNotFoundError: + version = f"{__version__}" + + return version + + +def print_header(): + banner = r""" + __ __ ____ __ _______ + / / / /_ __/ / /__ _________ _____ ______ / |/ / __ \ + / /_/ / / / / / / _ \/ ___/ __ `/ __ `/ ___/ / /|_/ / / / / + / __ / /_/ / / / __/ / / /_/ / /_/ (__ ) / / / / /_/ / + /_/ /_/\__, /_/_/\___/_/ \__,_/\__,_/____/ /_/ /_/_____/ + /____/ + """ + + refs_set = """ + + [1] Ledum, M.; Sen, S.; Li, X.; Carrer, M.; Feng Y.; Cascella, M.; Bore, S. L. + HylleraasMD: A Domain Decomposition-Based Hybrid Particle-Field Software for Multi-Scale Simulations of Soft Matter. + J. Chem. Theory Comput. 2023. + + [2] Ledum, M.; Carrer, M.; Sen, S.; Li, X.; Cascella, M.; Bore, S. L. + HyMD: Massively parallel hybrid particle-field molecular dynamics in Python. + J. Open Source Softw. 8(84), 4149, 2023. + + [3] Sen, S.; Ledum, M.; Bore, S. L.; Cascella, M. + Soft Matter under Pressure: Pushing Particle–Field Molecular Dynamics to the Isobaric Ensemble. + J Chem Inf Model 2023, 63(7), 1549-9596. + + [4] Bore, S. L.; Cascella, M. + Hamiltonian and alias-free hybrid particle–field molecular dynamics. + J. Chem. Phys. 2020, 153, 094106. + + [5] Pippig, M. PFFT: An extension of FFTW to massively parallel architectures. + SIAM J. Sci. Comput. 2013, 35, C213–C236. + +""" + + version = f"Version {get_version()}" + header = banner + header += version.center(56) + "\n\n" + #header += " Please read and cite the references below:" + header += " PLEASE READ AND CITE THE REFERENCES BELOW:" + header += refs_set + + return header +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/_modules/hymd/thermostat.html b/v1.0.1/_modules/hymd/thermostat.html new file mode 100644 index 00000000..59050ee0 --- /dev/null +++ b/v1.0.1/_modules/hymd/thermostat.html @@ -0,0 +1,491 @@ + + + + + + hymd.thermostat — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.thermostat

+"""Scales or otherwise modifies the particle velocities during simulation to
+simulate coupling to an external heat bath with temperature T₀.
+"""
+import numpy as np
+import logging
+from mpi4py import MPI
+from typing import Callable
+from .logger import Logger
+from .input_parser import Config
+
+
+def cancel_com_momentum(velocities, config, comm=MPI.COMM_WORLD):
+    com_velocity = comm.allreduce(np.sum(velocities[...], axis=0), MPI.SUM)
+    velocities[...] = velocities[...] - com_velocity / config.n_particles
+    return velocities
+
+
+def generate_initial_velocities(velocities, config, prng, comm=MPI.COMM_WORLD):
+    kT_start = config.gas_constant * config.start_temperature
+    n_particles_ = velocities.shape[0]
+    velocities[...] = prng.normal(
+        loc=0, scale=kT_start / config.mass, size=(n_particles_, 3)
+    )
+    velocities = cancel_com_momentum(velocities, config, comm=comm)
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    start_kinetic_energy_target = (
+        1.5 * config.gas_constant * config.n_particles * config.start_temperature
+    )
+    factor = np.sqrt(1.5 * config.n_particles * kT_start / kinetic_energy)
+    velocities[...] = velocities[...] * factor
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    Logger.rank0.log(
+        logging.INFO,
+        (
+            f"Initialized {config.n_particles} velocities, target kinetic "
+            f"energy: {start_kinetic_energy_target}, actual kinetic energy "
+            f"generated: {kinetic_energy}"
+        ),
+    )
+    return velocities
+
+
+
[docs]def _random_gaussian(prng: np.random.Generator) -> float: + """Draw a single random number from the standard normal distribution + Generate a number from the Gaussian distribution centered at zero with unit + standard deviation, :math:`N(0, 1)`. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + + Returns + ------- + float + A random number drawn from :math:`N(0, 1)`. + """ + return prng.normal()
+ + +
[docs]def _random_chi_squared(prng: np.random.Generator, M: int) -> float: + """Draw the sum of :code:`M` squared normally distributed values + + The value is generated by the Gamma distribution, in lieu of generating + :code:`M` Gaussian distributed numbers and summing their squares. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + M : int + Number of standard normally distributed numbers in the sum. + + Returns + ------- + float + The sum of :code:`M` squared normally distributed values centered at + zero with unit standard deviation. + + Notes + ----- + The sum of the squares of k independent standard normal random variables is + distributed according to a :math:`\\chi^2` distribution. + + .. math:: + + \\chi^2_1 + \\chi_2^2 + \\chi_3^2 + \\dots + \\chi_M^2 + \\sim + \\sigma^2\\chi^2(k) + + This is a special case of the :math:`\\Gamma` distribution, + :math:`\\Gamma(k/2, 2)`, and may be generated by + + .. math:: + + \\chi^2(k) \\sim 2 \\Gamma(k/2, 2) + + References + ---------- + Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of + Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. + J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246. + """ + return prng.chisquare(M)
+ + +
[docs]def csvr_thermostat( + velocity: np.ndarray, + names: np.ndarray, + config: Config, + prng: np.random.Generator, + comm: MPI.Intracomm = MPI.COMM_WORLD, + random_gaussian: Callable[[np.random.Generator], float] = _random_gaussian, + random_chi_squared: Callable[ + [np.random.Generator, int, float], float + ] = _random_chi_squared, + remove_center_of_mass_momentum: bool = True, +) -> np.ndarray: + """Canonical sampling through velocity rescaling thermostat + + Implements the CSVR thermostat. Rescales the system kinetic energy by a + stochastically chosen factor to keep the temperature constant. Requires + communcation of the kinetic energies calculated locally for each MPI rank. + The random numbers sampled through :code:`random_gaussian` and + :code:`random_chi_squared` are broadcast from the root rank to the other + ranks to ensure the scaling is performed with the same stochasticity for + all particles in the full system. + + The velocities are cleaned of center of mass momentum before the thermostat + is applied, and the center of mass momentum is subsequently reapplied. This + is performed for each thermostat coupling group, i.e. the center of mass + momenta of each *group* is separately removed and reapplied after + thermostatting. + + The implementation here is based on the derivation presented in the 2008 + Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper. + + Parameters + ---------- + velocity : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + names : (N,) numpy.ndarray + Array of particle names. + config : Config + Configuration dataclass containing simulation metadata and parameters. + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + random_gaussian : callable, optional + Function for generating standard normally distributed numbers. + random_chi_squared : callable, optional + Function for generating :math:`\\chi^2`-distributed numbers + remove_center_of_mass_momentum : bool, optional + If True, the center of mass of each coupling group is removed before + the thermostat is applied. The center of mass momenta are added back + after the kinetic energy rescaling is complete. + + See Also + -------- + _random_gaussian : + Used to sample Gaussian-distributed numbers. + _random_chi_squared : + Used to sample :math:`\\chi^2`-distributed numbers. + hymd.input_parser.Config : + Configuration dataclass handler. + + References + ---------- + G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). + G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008). + """ + if not any(config.thermostat_coupling_groups): + config.thermostat_coupling_groups = [config.unique_names.copy()] + for i, group in enumerate(config.thermostat_coupling_groups): + ind = np.where( + np.logical_or.reduce(list(names == np.string_(t) for t in group)) + ) + group_n_particles = comm.allreduce(len(ind[0]), MPI.SUM) + + # Clean velocities of center of mass momentum + if remove_center_of_mass_momentum and group_n_particles > 1: + com_velocity = comm.allreduce(np.sum(velocity[ind], axis=0)) + velocity_clean = velocity[ind] - com_velocity / group_n_particles + K = comm.allreduce(0.5 * config.mass * np.sum(velocity_clean[...] ** 2)) + else: + K = comm.allreduce(0.5 * config.mass * np.sum(velocity[...] ** 2)) + K_target = ( + 1.5 * config.gas_constant * group_n_particles * config.target_temperature + ) + N_f = 3 * group_n_particles + c = np.exp(-(config.time_step * config.respa_inner) / config.tau) + + # Random numbers are identical across ranks because all ranks have + # the same prng after the initialization of the velocities + R = random_gaussian(prng) + SNf = random_chi_squared(prng, N_f - 1) + + alpha2 = ( + c + + (1 - c) * (SNf + R**2) * K_target / (N_f * K) + + 2 * R * np.sqrt(c * (1 - c) * K_target / (N_f * K)) + ) + dK = K * (alpha2 - 1) + alpha = np.sqrt(alpha2) + + if remove_center_of_mass_momentum and group_n_particles > 1: + # Assign velocities and reapply the previously removed center + # of mass momentum removed + velocity_clean *= alpha + velocity[ind] = velocity_clean + com_velocity / group_n_particles + else: + velocity *= alpha + config.thermostat_work += dK
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/_modules/index.html b/v1.0.1/_modules/index.html new file mode 100644 index 00000000..3ce8dd43 --- /dev/null +++ b/v1.0.1/_modules/index.html @@ -0,0 +1,279 @@ + + + + + + Overview: module code — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+ +
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/v1.0.1/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css new file mode 100644 index 00000000..1b057df2 --- /dev/null +++ b/v1.0.1/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css @@ -0,0 +1 @@ +.badge{border-radius:.25rem;display:inline-block;font-size:75%;font-weight:700;line-height:1;padding:.25em .4em;text-align:center;vertical-align:baseline;white-space:nowrap}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{border-radius:10rem;padding-left:.6em;padding-right:.6em}.badge-primary{background-color:#007bff;color:#fff}.badge-primary[href]:focus,.badge-primary[href]:hover{background-color:#0062cc;color:#fff;text-decoration:none}.badge-secondary{background-color:#6c757d;color:#fff}.badge-secondary[href]:focus,.badge-secondary[href]:hover{background-color:#545b62;color:#fff;text-decoration:none}.badge-success{background-color:#28a745;color:#fff}.badge-success[href]:focus,.badge-success[href]:hover{background-color:#1e7e34;color:#fff;text-decoration:none}.badge-info{background-color:#17a2b8;color:#fff}.badge-info[href]:focus,.badge-info[href]:hover{background-color:#117a8b;color:#fff;text-decoration:none}.badge-warning{background-color:#ffc107;color:#212529}.badge-warning[href]:focus,.badge-warning[href]:hover{background-color:#d39e00;color:#212529;text-decoration:none}.badge-danger{background-color:#dc3545;color:#fff}.badge-danger[href]:focus,.badge-danger[href]:hover{background-color:#bd2130;color:#fff;text-decoration:none}.badge-light{background-color:#f8f9fa;color:#212529}.badge-light[href]:focus,.badge-light[href]:hover{background-color:#dae0e5;color:#212529;text-decoration:none}.badge-dark{background-color:#343a40;color:#fff}.badge-dark[href]:focus,.badge-dark[href]:hover{background-color:#1d2124;color:#fff;text-decoration:none}.border-0{border:0 !important}.border-top-0{border-top:0 !important}.border-right-0{border-right:0 !important}.border-bottom-0{border-bottom:0 !important}.border-left-0{border-left:0 !important}.p-0{padding:0 !important}.pt-0,.py-0{padding-top:0 !important}.pr-0,.px-0{padding-right:0 !important}.pb-0,.py-0{padding-bottom:0 !important}.pl-0,.px-0{padding-left:0 !important}.p-1{padding:.25rem !important}.pt-1,.py-1{padding-top:.25rem !important}.pr-1,.px-1{padding-right:.25rem !important}.pb-1,.py-1{padding-bottom:.25rem !important}.pl-1,.px-1{padding-left:.25rem !important}.p-2{padding:.5rem !important}.pt-2,.py-2{padding-top:.5rem !important}.pr-2,.px-2{padding-right:.5rem !important}.pb-2,.py-2{padding-bottom:.5rem !important}.pl-2,.px-2{padding-left:.5rem !important}.p-3{padding:1rem !important}.pt-3,.py-3{padding-top:1rem !important}.pr-3,.px-3{padding-right:1rem !important}.pb-3,.py-3{padding-bottom:1rem !important}.pl-3,.px-3{padding-left:1rem !important}.p-4{padding:1.5rem !important}.pt-4,.py-4{padding-top:1.5rem !important}.pr-4,.px-4{padding-right:1.5rem !important}.pb-4,.py-4{padding-bottom:1.5rem !important}.pl-4,.px-4{padding-left:1.5rem !important}.p-5{padding:3rem !important}.pt-5,.py-5{padding-top:3rem !important}.pr-5,.px-5{padding-right:3rem !important}.pb-5,.py-5{padding-bottom:3rem !important}.pl-5,.px-5{padding-left:3rem !important}.m-0{margin:0 !important}.mt-0,.my-0{margin-top:0 !important}.mr-0,.mx-0{margin-right:0 !important}.mb-0,.my-0{margin-bottom:0 !important}.ml-0,.mx-0{margin-left:0 !important}.m-1{margin:.25rem !important}.mt-1,.my-1{margin-top:.25rem !important}.mr-1,.mx-1{margin-right:.25rem !important}.mb-1,.my-1{margin-bottom:.25rem !important}.ml-1,.mx-1{margin-left:.25rem !important}.m-2{margin:.5rem !important}.mt-2,.my-2{margin-top:.5rem !important}.mr-2,.mx-2{margin-right:.5rem !important}.mb-2,.my-2{margin-bottom:.5rem !important}.ml-2,.mx-2{margin-left:.5rem !important}.m-3{margin:1rem !important}.mt-3,.my-3{margin-top:1rem !important}.mr-3,.mx-3{margin-right:1rem !important}.mb-3,.my-3{margin-bottom:1rem !important}.ml-3,.mx-3{margin-left:1rem !important}.m-4{margin:1.5rem !important}.mt-4,.my-4{margin-top:1.5rem !important}.mr-4,.mx-4{margin-right:1.5rem !important}.mb-4,.my-4{margin-bottom:1.5rem !important}.ml-4,.mx-4{margin-left:1.5rem !important}.m-5{margin:3rem !important}.mt-5,.my-5{margin-top:3rem !important}.mr-5,.mx-5{margin-right:3rem !important}.mb-5,.my-5{margin-bottom:3rem !important}.ml-5,.mx-5{margin-left:3rem !important}.btn{background-color:transparent;border:1px solid transparent;border-radius:.25rem;color:#212529;cursor:pointer;display:inline-block;font-size:1rem;font-weight:400;line-height:1.5;padding:.375rem .75rem;text-align:center;transition:color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none;vertical-align:middle}.btn:hover{color:#212529;text-decoration:none}.btn:visited{color:#212529}.btn.focus,.btn:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.25);outline:0}.btn.disabled,.btn:disabled{opacity:.65}@media (prefers-reduced-motion: reduce){.btn{transition:none}}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary:visited{color:#fff}.btn-primary:hover{background-color:#0069d9;border-color:#0062cc;color:#fff}.btn-primary.focus,.btn-primary:focus{background-color:#0069d9;border-color:#0062cc;box-shadow:0 0 0 .2rem rgba(0,123,255,0.5);color:#fff}.btn-primary.disabled,.btn-primary:disabled{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary.active:not(:disabled):not(.disabled),.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{background-color:#0062cc;border-color:#005cbf;color:#fff}.btn-primary.active:not(:disabled):not(.disabled):focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-secondary{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary:visited{color:#fff}.btn-secondary:hover{background-color:#5a6268;border-color:#545b62;color:#fff}.btn-secondary.focus,.btn-secondary:focus{background-color:#5a6268;border-color:#545b62;box-shadow:0 0 0 .2rem rgba(108,117,125,0.5);color:#fff}.btn-secondary.disabled,.btn-secondary:disabled{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled),.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{background-color:#545b62;border-color:#4e555b;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled):focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-success{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success:visited{color:#fff}.btn-success:hover{background-color:#218838;border-color:#1e7e34;color:#fff}.btn-success.focus,.btn-success:focus{background-color:#218838;border-color:#1e7e34;box-shadow:0 0 0 .2rem rgba(40,167,69,0.5);color:#fff}.btn-success.disabled,.btn-success:disabled{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success.active:not(:disabled):not(.disabled),.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{background-color:#1e7e34;border-color:#1c7430;color:#fff}.btn-success.active:not(:disabled):not(.disabled):focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-info{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info:visited{color:#fff}.btn-info:hover{background-color:#138496;border-color:#117a8b;color:#fff}.btn-info.focus,.btn-info:focus{background-color:#138496;border-color:#117a8b;box-shadow:0 0 0 .2rem rgba(23,162,184,0.5);color:#fff}.btn-info.disabled,.btn-info:disabled{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info.active:not(:disabled):not(.disabled),.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{background-color:#117a8b;border-color:#10707f;color:#fff}.btn-info.active:not(:disabled):not(.disabled):focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-warning{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning:visited{color:#212529}.btn-warning:hover{background-color:#e0a800;border-color:#d39e00;color:#212529}.btn-warning.focus,.btn-warning:focus{background-color:#e0a800;border-color:#d39e00;box-shadow:0 0 0 .2rem rgba(255,193,7,0.5);color:#212529}.btn-warning.disabled,.btn-warning:disabled{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning.active:not(:disabled):not(.disabled),.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{background-color:#d39e00;border-color:#c69500;color:#212529}.btn-warning.active:not(:disabled):not(.disabled):focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-danger{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger:visited{color:#fff}.btn-danger:hover{background-color:#c82333;border-color:#bd2130;color:#fff}.btn-danger.focus,.btn-danger:focus{background-color:#c82333;border-color:#bd2130;box-shadow:0 0 0 .2rem rgba(220,53,69,0.5);color:#fff}.btn-danger.disabled,.btn-danger:disabled{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger.active:not(:disabled):not(.disabled),.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{background-color:#bd2130;border-color:#b21f2d;color:#fff}.btn-danger.active:not(:disabled):not(.disabled):focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-light{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light:visited{color:#212529}.btn-light:hover{background-color:#e2e6ea;border-color:#dae0e5;color:#212529}.btn-light.focus,.btn-light:focus{background-color:#e2e6ea;border-color:#dae0e5;box-shadow:0 0 0 .2rem rgba(248,249,250,0.5);color:#212529}.btn-light.disabled,.btn-light:disabled{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light.active:not(:disabled):not(.disabled),.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{background-color:#dae0e5;border-color:#d3d9df;color:#212529}.btn-light.active:not(:disabled):not(.disabled):focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-dark{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark:visited{color:#fff}.btn-dark:hover{background-color:#23272b;border-color:#1d2124;color:#fff}.btn-dark.focus,.btn-dark:focus{background-color:#23272b;border-color:#1d2124;box-shadow:0 0 0 .2rem rgba(52,58,64,0.5);color:#fff}.btn-dark.disabled,.btn-dark:disabled{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark.active:not(:disabled):not(.disabled),.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{background-color:#1d2124;border-color:#171a1d;color:#fff}.btn-dark.active:not(:disabled):not(.disabled):focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-primary{border-color:#007bff;color:#007bff}.btn-outline-primary:visited{color:#007bff}.btn-outline-primary:hover{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{background-color:transparent;color:#007bff}.btn-outline-primary.active:not(:disabled):not(.disabled),.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.active:not(:disabled):not(.disabled):focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-secondary{border-color:#6c757d;color:#6c757d}.btn-outline-secondary:visited{color:#6c757d}.btn-outline-secondary:hover{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{background-color:transparent;color:#6c757d}.btn-outline-secondary.active:not(:disabled):not(.disabled),.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.active:not(:disabled):not(.disabled):focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-success{border-color:#28a745;color:#28a745}.btn-outline-success:visited{color:#28a745}.btn-outline-success:hover{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{background-color:transparent;color:#28a745}.btn-outline-success.active:not(:disabled):not(.disabled),.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.active:not(:disabled):not(.disabled):focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-info{border-color:#17a2b8;color:#17a2b8}.btn-outline-info:visited{color:#17a2b8}.btn-outline-info:hover{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{background-color:transparent;color:#17a2b8}.btn-outline-info.active:not(:disabled):not(.disabled),.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.active:not(:disabled):not(.disabled):focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-warning{border-color:#ffc107;color:#ffc107}.btn-outline-warning:visited{color:#ffc107}.btn-outline-warning:hover{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{background-color:transparent;color:#ffc107}.btn-outline-warning.active:not(:disabled):not(.disabled),.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.active:not(:disabled):not(.disabled):focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-danger{border-color:#dc3545;color:#dc3545}.btn-outline-danger:visited{color:#dc3545}.btn-outline-danger:hover{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{background-color:transparent;color:#dc3545}.btn-outline-danger.active:not(:disabled):not(.disabled),.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.active:not(:disabled):not(.disabled):focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-light{border-color:#f8f9fa;color:#f8f9fa}.btn-outline-light:visited{color:#f8f9fa}.btn-outline-light:hover{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{background-color:transparent;color:#f8f9fa}.btn-outline-light.active:not(:disabled):not(.disabled),.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.active:not(:disabled):not(.disabled):focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-dark{border-color:#343a40;color:#343a40}.btn-outline-dark:visited{color:#343a40}.btn-outline-dark:hover{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{background-color:transparent;color:#343a40}.btn-outline-dark.active:not(:disabled):not(.disabled),.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.active:not(:disabled):not(.disabled):focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-link{color:#007bff;font-weight:400;text-decoration:none}.btn-link:hover{color:#0056b3;text-decoration:underline}.btn-link.focus,.btn-link:focus{box-shadow:none;text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{border-radius:.3rem;font-size:1.25rem;line-height:1.5;padding:.5rem 1rem}.btn-group-sm>.btn,.btn-sm{border-radius:.2rem;font-size:.875rem;line-height:1.5;padding:.25rem .5rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input.btn-block[type=button],input.btn-block[type=reset],input.btn-block[type=submit]{width:100%}.stretched-link::after{background-color:rgba(0,0,0,0);bottom:0;content:'';left:0;pointer-events:auto;position:absolute;right:0;top:0;z-index:1}.text-wrap{white-space:normal !important}.card{background-clip:border-box;background-color:#fff;border:1px solid rgba(0,0,0,0.125);border-radius:.25rem;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;min-width:0;position:relative;word-wrap:break-word}.card>hr{margin-left:0;margin-right:0}.card>.list-group:first-child .list-group-item:first-child{border-top-left-radius:.25rem;border-top-right-radius:.25rem}.card>.list-group:last-child .list-group-item:last-child{border-bottom-left-radius:.25rem;border-bottom-right-radius:.25rem}.card-body{-ms-flex:1 1 auto;flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-bottom:0;margin-top:-.375rem}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{background-color:rgba(0,0,0,0.03);border-bottom:1px solid rgba(0,0,0,0.125);margin-bottom:0;padding:.75rem 1.25rem}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-header+.list-group .list-group-item:first-child{border-top:0}.card-footer{background-color:rgba(0,0,0,0.03);border-top:1px solid rgba(0,0,0,0.125);padding:.75rem 1.25rem}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{border-bottom:0;margin-bottom:-.75rem;margin-left:-.625rem;margin-right:-.625rem}.card-header-pills{margin-left:-.625rem;margin-right:-.625rem}.card-img-overlay{bottom:0;left:0;padding:1.25rem;position:absolute;right:0;top:0}.card-img,.card-img-bottom,.card-img-top{-ms-flex-negative:0;flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-left-radius:calc(.25rem - 1px);border-bottom-right-radius:calc(.25rem - 1px)}.w-100{width:100% !important}.shadow{box-shadow:0 0.5rem 1rem rgba(0,0,0,0.15) !important}.bg-primary{background-color:#007bff !important}button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc !important}a.bg-primary:focus,a.bg-primary:hover{background-color:#0062cc !important}a.text-primary:focus,a.text-primary:hover{color:#121416 !important}.bg-secondary{background-color:#6c757d !important}button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62 !important}a.bg-secondary:focus,a.bg-secondary:hover{background-color:#545b62 !important}a.text-secondary:focus,a.text-secondary:hover{color:#121416 !important}.bg-success{background-color:#28a745 !important}button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34 !important}a.bg-success:focus,a.bg-success:hover{background-color:#1e7e34 !important}a.text-success:focus,a.text-success:hover{color:#121416 !important}.bg-info{background-color:#17a2b8 !important}button.bg-info:focus,button.bg-info:hover{background-color:#117a8b !important}a.bg-info:focus,a.bg-info:hover{background-color:#117a8b !important}a.text-info:focus,a.text-info:hover{color:#121416 !important}.bg-warning{background-color:#ffc107 !important}button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00 !important}a.bg-warning:focus,a.bg-warning:hover{background-color:#d39e00 !important}a.text-warning:focus,a.text-warning:hover{color:#121416 !important}.bg-danger{background-color:#dc3545 !important}button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130 !important}a.bg-danger:focus,a.bg-danger:hover{background-color:#bd2130 !important}a.text-danger:focus,a.text-danger:hover{color:#121416 !important}.bg-light{background-color:#f8f9fa !important}button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5 !important}a.bg-light:focus,a.bg-light:hover{background-color:#dae0e5 !important}a.text-light:focus,a.text-light:hover{color:#121416 !important}.bg-dark{background-color:#343a40 !important}button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124 !important}a.bg-dark:focus,a.bg-dark:hover{background-color:#1d2124 !important}a.text-dark:focus,a.text-dark:hover{color:#121416 !important}.bg-white{background-color:#fff !important}button.bg-white:focus,button.bg-white:hover{background-color:#e6e6e6 !important}a.bg-white:focus,a.bg-white:hover{background-color:#e6e6e6 !important}a.text-white:focus,a.text-white:hover{color:#121416 !important}.text-primary{color:#007bff !important}.text-secondary{color:#6c757d !important}.text-success{color:#28a745 !important}.text-info{color:#17a2b8 !important}.text-warning{color:#ffc107 !important}.text-danger{color:#dc3545 !important}.text-light{color:#f8f9fa !important}.text-dark{color:#343a40 !important}.text-white{color:#fff !important}.text-body{color:#212529 !important}.text-muted{color:#6c757d !important}.text-black-50{color:rgba(0,0,0,0.5) !important}.text-white-50{color:rgba(255,255,255,0.5) !important}.bg-transparent{background-color:transparent !important}.text-justify{text-align:justify !important}.text-left{text-align:left !important}.text-right{text-align:right !important}.text-center{text-align:center !important}.font-weight-light{font-weight:300 !important}.font-weight-lighter{font-weight:lighter !important}.font-weight-normal{font-weight:400 !important}.font-weight-bold{font-weight:700 !important}.font-weight-bolder{font-weight:bolder !important}.font-italic{font-style:italic !important}.container{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container{max-width:540px}}@media (min-width: 768px){.container{max-width:720px}}@media (min-width: 992px){.container{max-width:960px}}@media (min-width: 1200px){.container{max-width:1140px}}.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container,.container-sm{max-width:540px}}@media (min-width: 768px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width: 992px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width: 1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1140px}}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;margin-right:-15px}.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{padding-left:15px;padding-right:15px;position:relative;width:100%}@media (min-width: 576px){.col-sm{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-sm-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-sm-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-sm-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-sm-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-sm-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 768px){.col-md{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-md-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-md-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-md-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-md-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-md-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 992px){.col-lg{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-lg-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-lg-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-lg-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-lg-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-lg-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 1200px){.col-xl{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-xl-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-xl-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-xl-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-xl-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-xl-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}.d-flex{display:-ms-flexbox !important;display:flex !important}.sphinx-bs,.sphinx-bs *{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sphinx-bs p{margin-top:0} diff --git a/v1.0.1/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/v1.0.1/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css new file mode 100644 index 00000000..fc14abc8 --- /dev/null +++ b/v1.0.1/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css @@ -0,0 +1 @@ +details.dropdown .summary-title{padding-right:3em !important;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none}details.dropdown:hover{cursor:pointer}details.dropdown .summary-content{cursor:default}details.dropdown summary{list-style:none;padding:1em}details.dropdown summary .octicon.no-title{vertical-align:middle}details.dropdown[open] summary .octicon.no-title{visibility:hidden}details.dropdown summary::-webkit-details-marker{display:none}details.dropdown summary:focus{outline:none}details.dropdown summary:hover .summary-up svg,details.dropdown summary:hover .summary-down svg{opacity:1}details.dropdown .summary-up svg,details.dropdown .summary-down svg{display:block;opacity:.6}details.dropdown .summary-up,details.dropdown .summary-down{pointer-events:none;position:absolute;right:1em;top:.75em}details.dropdown[open] .summary-down{visibility:hidden}details.dropdown:not([open]) .summary-up{visibility:hidden}details.dropdown.fade-in[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out;animation:panels-fade-in .5s ease-in-out}details.dropdown.fade-in-slide-down[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out}@keyframes panels-fade-in{0%{opacity:0}100%{opacity:1}}@keyframes panels-slide-down{0%{transform:translate(0, -10px)}100%{transform:translate(0, 0)}}.octicon{display:inline-block;fill:currentColor;vertical-align:text-top}.tabbed-content{box-shadow:0 -.0625rem var(--tabs-color-overline),0 .0625rem var(--tabs-color-underline);display:none;order:99;padding-bottom:.75rem;padding-top:.75rem;width:100%}.tabbed-content>:first-child{margin-top:0 !important}.tabbed-content>:last-child{margin-bottom:0 !important}.tabbed-content>.tabbed-set{margin:0}.tabbed-set{border-radius:.125rem;display:flex;flex-wrap:wrap;margin:1em 0;position:relative}.tabbed-set>input{opacity:0;position:absolute}.tabbed-set>input:checked+label{border-color:var(--tabs-color-label-active);color:var(--tabs-color-label-active)}.tabbed-set>input:checked+label+.tabbed-content{display:block}.tabbed-set>input:focus+label{outline-style:auto}.tabbed-set>input:not(.focus-visible)+label{outline:none;-webkit-tap-highlight-color:transparent}.tabbed-set>label{border-bottom:.125rem solid transparent;color:var(--tabs-color-label-inactive);cursor:pointer;font-size:var(--tabs-size-label);font-weight:700;padding:1em 1.25em .5em;transition:color 250ms;width:auto;z-index:1}html .tabbed-set>label:hover{color:var(--tabs-color-label-active)} diff --git a/v1.0.1/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css b/v1.0.1/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css new file mode 100644 index 00000000..adc61662 --- /dev/null +++ b/v1.0.1/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css @@ -0,0 +1,7 @@ +:root { +--tabs-color-label-active: hsla(231, 99%, 66%, 1); +--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); +--tabs-color-overline: rgb(207, 236, 238); +--tabs-color-underline: rgb(207, 236, 238); +--tabs-size-label: 1rem; +} \ No newline at end of file diff --git a/v1.0.1/_sources/doc_pages/api.rst.txt b/v1.0.1/_sources/doc_pages/api.rst.txt new file mode 100644 index 00000000..c9f8837b --- /dev/null +++ b/v1.0.1/_sources/doc_pages/api.rst.txt @@ -0,0 +1,90 @@ +.. _api-label: + + +API reference +============= + +Integrator +---------- + +.. automodule:: hymd.integrator + :members: + + +Thermostat +---------- + +.. automodule:: hymd.thermostat + :members: csvr_thermostat, _random_chi_squared, _random_gaussian + :undoc-members: + + +Hamiltonian +----------- + +.. autoclass:: hymd.hamiltonian.Hamiltonian + :members: + + .. automethod:: __init__ + + .. automethod:: _setup + +.. autoclass:: hymd.hamiltonian.SquaredPhi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultNoChi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultWithChi + :members: + + .. automethod:: __init__ + + +Force +----- + +.. automodule:: hymd.force + :members: + :undoc-members: + + +Logger +------ + +.. autoclass:: hymd.logger.Logger + :members: + +.. autoclass:: hymd.logger.MPIFilterRoot + :members: + +.. autoclass:: hymd.logger.MPIFilterAll + :members: + + +Input parser +------------ + +.. automodule:: hymd.input_parser + :members: + :undoc-members: propensity_potential_coeffs + + +Field +----- + +.. automodule:: hymd.field + :members: + + +File input/output +----------------- + +.. automodule:: hymd.file_io + :members: diff --git a/v1.0.1/_sources/doc_pages/benchmarks.rst.txt b/v1.0.1/_sources/doc_pages/benchmarks.rst.txt new file mode 100644 index 00000000..edc8a863 --- /dev/null +++ b/v1.0.1/_sources/doc_pages/benchmarks.rst.txt @@ -0,0 +1,93 @@ +.. _benchmarks-label: + +Benchmarks +########## +Homopolymer melt test systems of :math:`30^2`, :math:`40^2`, and :math:`50^2` +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively. + +Bonded forces +^^^^^^^^^^^^^ +Legend label denotes the number of particles in the system. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) + time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 + ], dtype=np.float64) + nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 + ], dtype=np.float64,) + time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, + ], dtype=np.float64) + nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 + ], dtype=np.float64) + time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, + ], dtype=np.float64) + plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" + ) + plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" + ) + plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" + ) + plt.xlabel("CPUs", fontsize=15) + plt.ylabel("Time per step, us", fontsize=15) + plt.legend(fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.show() + + +Particle--field forces +^^^^^^^^^^^^^^^^^^^^^^ +Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + + mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] + mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + + mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + + mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + + mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] + mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + + mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + + mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + + plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048²") + plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024²") + plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512²") + plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256²") + plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128²") + plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64²") + plt.xlabel("CPUs", fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.ylabel("Time per step, s", fontsize=15) + plt.legend(loc="upper left", fontsize=15) + plt.show() diff --git a/v1.0.1/_sources/doc_pages/command_line.rst.txt b/v1.0.1/_sources/doc_pages/command_line.rst.txt new file mode 100644 index 00000000..5233710f --- /dev/null +++ b/v1.0.1/_sources/doc_pages/command_line.rst.txt @@ -0,0 +1,120 @@ +.. _commandline-label: + +Command line arguments +###################### +Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle--field interactions. + + +Required arguments +================== +:configuration file: + :code:`type` positional + + Specifies the :code:`.toml` format configuration file containing simulation details. See :ref:`config-label` for details. + +:structure and topology file: + :code:`type` positional + + Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See :ref:`topology-label` for details. + +Optional arguments +================== +:code:`-v --verbose` + :code:`type` optional + + Number of following arguments: :code:`0` or :code:`1` + + Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying :code:`-v` or :code:`--verbose` with no additional specification. This increases verbosity level by :code:`1`. Alternatively, it maye be specified by :code:`--verbose V` with :code:`V` being :code:`0`, :code:`1`, or :code:`2`. + +:code:`--profile` + :code:`type` optional + + Number of following arguments: :code:`0` + + Enables code profiling using :code:`cProfile`. This will output one profiling file per MPI rank invoked in the simulation. + +:code:`--double-precision` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision internally in HyMD (including in the FFTs). + +:code:`--double-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision in the output trajectory from HyMD. + +:code:`--velocity-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that velocities should be output to the HyMD trajectory. + +:code:`--force-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that forces should be output to the HyMD trajectory. + +:code:`--disable-mpio` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult. + +:code:`--logfile` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the path of a plain text log file in which stdout is mirrored during simulation runs. + +:code:`--seed` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the random seed used in the :code:`numpy` random library to generate velocities, thermostatting, etc. + +:code:`--disable-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any two-particle bonds present in the system. + +:code:`--disable-angle-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any three-particle bonds present in the system. + +:code:`--disable-dihedrals` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any four-particle bonds present in the system. + +:code:`--disable-dipole` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any topological reconstruction of peptide backbone dipoles present in the system. + +:code:`--disable-field` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any particle--field interactions present in the system. diff --git a/v1.0.1/_sources/doc_pages/config_file.rst.txt b/v1.0.1/_sources/doc_pages/config_file.rst.txt new file mode 100644 index 00000000..40ee0479 --- /dev/null +++ b/v1.0.1/_sources/doc_pages/config_file.rst.txt @@ -0,0 +1,194 @@ +.. _config-label: + +Configuration file +################## +The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order. + +The configuration file is a `toml`_ format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs. + +.. _`toml`: + https://github.com/toml-lang/toml + +.. role:: required + +Configuration file keywords +--------------------------- + +The following constitutes every possible keyword specification in HyMD +configuration files: + +Metadata keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying metadata for the H5MD output trajectory. + +:name: + :code:`string` [**optional**, default: :code:`None`] + + Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file. + + +:tags: + :code:`array` [:code:`string`] [**optional**, default: :code:`None`] + + Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file. + + +Particle keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying properties of particles and molecules in the +system. + +:n_particles: + :code:`integer` [**optional**, default: :code:`None`] + + Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules. + +:mass: + :code:`float` [**optional**, default: :code:`72.0`] {units: :math:`\text{u}=\text{g}\,\text{mol}^{-1}`} + + Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal. + +:max_molecule_size: + :code:`integer` [**optional**, default: :code:`201`] + + Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code **will** crash if there are molecules larger than :code:`max_molecule_size` in the topology/structure input file. + + +Simulation keywords +^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying simulation parameters. + +:n_steps: + :code:`integer` [:required:`required`] + + Total number of integration steps to perform for this simulation. + +:n_print: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of *number of time steps*). + +:n_flush: + :code:`integer` [**optional**, default: :code:`None`] + + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of *number of* :code:`n_print`, i.e. :code:`n_print = 13`, :code:`n_flush = 3` would result in the trajectory/energy being written to disk every :code:`13 x 3 = 39` *simulation steps*) + +:time_step: + :code:`float` [:required:`required`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time step per integration step. If the rRESPA multiple time step integrator is used (:code:`integrator = "respa"`), this specifies the **inner** time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is :code:`respa_inner` times the :code:`time_step` , and the total simulation time is :code:`n_steps` times :code:`time_step` times :code:`respa_inner` . + +:box_size: + :code:`array` [:code:`float`] [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable. + +:integrator: + :code:`string` [:required:`required`] (options: :code:`velocity-verlet` or :code:`respa`) + + Specifies the time integrator used in the simulation. If :code:`respa`, the *reversible reference system propagator algorithm (rRESPA)* :cite:`tuckerman1992reversible` integrator is used, with :code:`respa_inner` number of inner (intramolecular force) time steps. If :code:`velocity-verlet`, a normal Velocity Verlet integrator is used. If :code:`respa` and :code:`respa_inner = 1`, the rRESPA integrator is equivalent to the Velocity Verlet. + +:respa_inner: + :code:`integer` [**optional**, default: :code:`1`] + + The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces. + +:domain_decomposition: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Specifies the interval (in time steps) of *domain decomposition exchange*, involving all MPI ranks sending and receiving particles according to the particles' positions in the integration box and the MPI ranks' assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If :code:`True`, the decomposition is performed once (before starting the simulation). If :code:`False`, no decomposition is performed. + +:cancel_com_momentum: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + If :code:`True`, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every :code:`remove_com_momentum` time steps. If :code:`False`, the linear momentum is never removed. + +:start_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at :code:`start_temperature` Kelvin prior to starting the simulation. If :code:`False`, the velocities are not changed before starting the simulation. + +:target_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Couple the system to a heat bath at :code:`target_temperature` Kelvin by applying a *Canonical sampling through velocity rescaling* :cite:`Bussi2007JCP` thermostat with coupling strength :code:`tau`. If :code:`False`, no temperature control is applied. + +:tau: + :code:`float` [**optional**, default: :code:`0.7`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the CSVR thermostat coupling. In the limit of :code:`tau → ∞`, the Hamiltonian dynamics are preserved and no temperature coupling takes place. + +:thermostat_coupling_groups: + :code:`array` [:code:`array` [:code:`string`]] [**optional**, default: :code:`[]`] + + Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and :code:`"C"` type particles, :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would thermalise types :code:`"A"` and :code:`"B"` together and couple :code:`"C"` type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. :code:`target_temperature` Kelvin). +:hamiltonian: + :code:`string` [**optional**, default: :code:`"DefaultNohChi"`] (options: :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`) + + Specifies the interaction energy functional :math:`W[\tilde\phi]` for use with the particle-field interactions. See :ref:`functionals-label` for details. + + +Field keywords +^^^^^^^^^^^^^^ +Configuration keywords specifying field parameters. + +:mesh_size: + :code:`array` [:code:`integer`] or :code:`integer` [:required:`required`] + + Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is :code:`box_size / mesh_size`. + +:kappa: + :code:`float` [:required:`required`] {units: :math:`\text{kJ}^{-1}\text{mol}`} + + Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional :math:`W[\tilde\phi]`. See :ref:`functionals-label` for more details. + +:sigma: + :code:`float` [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See :ref:`filtering-label` for more details. + +:chi: + :code:`array` [:code:`array` [:code:`string`, :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}`} + + Array of :math:`\tilde\chi_\text{AB}`-parameters indicating the strength of the repulsive or attractive interaction between particles of type :code:`"A"` and the number density due to particles of type :code:`"B"`, and vice versa. Example: :code:`chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ]` would specify a repulsive :code:`"A"`--:code:`"B"` type interaction, and a weakly attractive :code:`"C"`--:code:`"D"` interaction. Self-interaction :math:`\tilde\chi`-terms are always zero. See :ref:`functionals-label` for more details. + + +Bond keywords +^^^^^^^^^^^^^ +Configuration keywords specifying bonds and bonds parameters. + +:bonds: + :code:`array` [:code:`array` [2 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{nm}=10^{-9}~\text{m}` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: :code:`bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ]` indicates a :code:`"A"`--:code:`"A"` bond of equilibrium length :code:`0.47` :math:`\text{nm}` with a bond strength of :code:`980.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding bond between :code:`"A"` and :code:`"B"` type particles with equilibrium length :code:`0.31` :math:`\text{nm}` and a strength of :code:`1250.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify stretching bonds. + +:angle_bonds: + :code:`array` [:code:`array` [3 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`{}^\circ` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: :code:`bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ]` indicates a :code:`"A"`--:code:`"A"`--:code:`"A"` angular bond that tries to keep the bond linear at :code:`180` degrees with a bending strength of :code:`55.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding angle bond between :code:`"A"`--:code:`"B"`--:code:`"B"` prefering the angle at :code:`120` degrees and a strength of :code:`25.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify angular bonds. + +:dihedrals: + :code:`array` [:code:`array` [4 :code:`string`, :code:`integer`, :code:`COSINE SERIES` ]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`} + + Specifies four-particle torsional potentials by cosine series. See :ref:`bonds-label` for details about how to specify dihedrals. + + + +Electrostatic keywords +^^^^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying electrostatics and electrostatic parameters. + +:coulombtype: + :code:`string` [**optional**, default: :code:`None`] (options: :code:`PIC_Spectral`) + + Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the :code:`dielectric_const` keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, *not* in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to `PIC_Spectral`. + +:dielectric_const: + :code:`float` [**optional**, default: :code:`None`] + + Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified---even if electrostatics are not included with the :code:`coulombtype` keyword. diff --git a/v1.0.1/_sources/doc_pages/constants_and_units.rst.txt b/v1.0.1/_sources/doc_pages/constants_and_units.rst.txt new file mode 100644 index 00000000..ee429829 --- /dev/null +++ b/v1.0.1/_sources/doc_pages/constants_and_units.rst.txt @@ -0,0 +1,80 @@ +.. _units-label: + +Constants and Units +################### + +HyMD uses the following units and constants internally and in all input and +output: + +.. list-table:: **Units** + :widths: 30 10 75 + :header-rows: 1 + + * - Quantity + - Symbol + - Unit + * - length + - :math:`r` + - :math:`\text{nm}=10^{-9}~\text{m}` + * - time + - :math:`t` + - :math:`\text{ps}=10^{-12}~\text{s}` + * - charge + - :math:`q` + - :math:`e=1.602176634 \cdot 10^{-19}~\text{C}` + * - mass + - :math:`m` + - :math:`\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}` + * - temperature + - :math:`\text{T}` + - :math:`\text{K}` + * - energy + - :math:`E` + - :math:`\text{kJ}\,\text{mol}^{-1}` + * - velocity + - :math:`v` + - :math:`\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}` + * - momentum + - :math:`P` + - :math:`\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}` + * - force + - :math:`\mathbf{F}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}` + * - pressure + - :math:`p` + - :math:`\text{bar}=100~\text{kPa}` + * - electric potential + - :math:`\Psi` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}` + * - electric field + - :math:`\mathbf{E}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}` + * - compressibility + - :math:`\kappa` + - :math:`\text{mol}\,\text{kJ}^{-1}` + * - field-interaction + - :math:`\tilde\chi` + - :math:`\text{kJ}\,\text{mol}^{-1}` + +.. list-table:: **Constants** + :widths: 30 10 75 + :header-rows: 1 + + * - Constant + - Symbol + - Value + * - gas constant + - :math:`R` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Boltzmann’s constant + - :math:`k_\text{B}` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Avogadro's constant + - :math:`N_\text{A}` + - :math:`6.02214076 \cdot 10^23~\text{mol}^{-1}` + * - Vacuum permittivity + - :math:`\varepsilon_0` + - :math:`8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2` + * - Coulomb constant + - :math:`k_\text{e}` + - :math:`138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}` diff --git a/v1.0.1/_sources/doc_pages/electrostatics.rst.txt b/v1.0.1/_sources/doc_pages/electrostatics.rst.txt new file mode 100644 index 00000000..7e11c09d --- /dev/null +++ b/v1.0.1/_sources/doc_pages/electrostatics.rst.txt @@ -0,0 +1,48 @@ +.. _electrostatics-label: + +Electrostatic interactions +########################## +In the filtered Hamiltonian hPF formalism :cite:`bore2020hamiltonian` the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle--mesh Ewald. + +The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered + +.. math:: + + \tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i), + +with :math:`q_i` being the charge of particle :math:`i` and :math:`H` is the +filtering function (see :ref:`filtering-label`). The value of the charge grid at +vertex :math:`(i,j,k)` is found by + +.. math:: + + \tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)] + +and the electrostatic potential :math:`\Psi_{ijk}` + +.. math:: + + \Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right], + +where :math:`k_\text{e}` is the Coulomb constant :math:`1/4\pi\varepsilon_0`. +The *electric field* is obtained by differentiation of the electrostatic +potential in Fourier space, + +.. math:: + + \mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)] + +from which the forces are interpolated back to the particle positions. + +Specifying electrostatics +^^^^^^^^^^^^^^^^^^^^^^^^^ +In HyMD, electrostatics are specified by the :code:`coulombtype` and +:code:`dielectric_const` keywords in the configuration file (see +:ref:`config-label`) and the :code:`/charge` dataset in the HDF5 format +structure/topology input file (see :ref:`topology-label`). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions. diff --git a/v1.0.1/_sources/doc_pages/examples.rst.txt b/v1.0.1/_sources/doc_pages/examples.rst.txt new file mode 100644 index 00000000..9f9c3655 --- /dev/null +++ b/v1.0.1/_sources/doc_pages/examples.rst.txt @@ -0,0 +1,621 @@ +.. _examples-label: + +Examples +######## +The following examples are ordered in *more or less* order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the `HyMD-tutorial`_ github repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Ideal gas +========= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true + :align: right + :width: 200 + +The simplest possible system is one with no interactions at all---intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like: + + +.. code-block:: toml + :caption: **ideal_gas.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = false # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + +A simple input structure/topology file :code:`ideal_gas.HDF5` is available in +the `HyMD-tutorial/ideal_gas`_ github repository (along with the code to +generate it). Run the (very) short simulation by + +.. code:: bash + + python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field \ + --velocity-output \ + --force-output + +with the :code:`--disable-field` argument to completely turn off all +particle--field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook `ideal_gas.ipynb`_ for details. + + +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas +.. _ideal_gas.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.ipynb + + +Ideal chains +============ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true + :align: right + :width: 200 + +The simplest available interaction is the harmonic two-particle bond (see +:ref:`bonds-label`), + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2. + +Extending the configuration file from the ideal gas case, we need to add a +:code:`bonds` specification. Note that the :code:`[bonds]` meta specifier is not +necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **ideal_chain.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + +A simple input structure/topology file :code:`ideal_chain.HDF5` with a few +coiled up ideal chain polymers is available in the +`HyMD-tutorial/ideal_chain`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field + +we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +`ideal_chain.ipynb`_. + + +.. _HyMD-tutorial/ideal_chain: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_chain +.. _ideal_chain.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/ideal_chain.ipynb + + +Stiff rods +========== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true + :align: right + :width: 200 + +Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the :code:`i--j--k` angle :math:`\theta` (see +:ref:`bonds-label`), + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2. + +Extending the configuration file from the ideal chain case, we need to add a +:code:`angle_bonds` specification. Note that the :code:`[bonds]` meta specifier +is not necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **rods.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + + angle_bonds = [ + ["A", "A", "A", 180.0, 100.0], # (i, j, k, equilibrium angle, strength) + ] + + +A simple input structure/topology file :code:`rods.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook `rods.ipynb`_. + + +.. _HyMD-tutorial/rods: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/rods +.. _rods.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.ipynb + + + +Helixes +======= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true + :align: right + :width: 200 + +Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle :math:`\phi` between the +:code:`i--j--k` plane and the :code:`j--k--l` plane (see :ref:`bonds-label`), + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n). + +The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a :code:`dihedrals` keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the :code:`dielectric_const` +keyword even though we are not including electrostatic forces in the current +simulation. Note that the :code:`[bonds]` meta specifier is not necessary, but +may be used to help organise the input file. + +.. code-block:: toml + :caption: **helixes.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + dielectric_const = 15.0 + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.31, 10000.0], # (i name, j name, equilibrium length, strength) + ] + + dihedrals = [ + [ + ["A", "A", "A", "A"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0] + ], + ] + +A simple input structure/topology file :code:`helixes.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook `helixes.ipynb`_. + + +.. _HyMD-tutorial/helixes: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/helixes +.. _helixes.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.ipynb + + +Phase separation +================ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true + :align: right + :width: 200 + +The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types :code:`A` and :code:`B`. Using the Hamiltonian + +.. math:: + + \mathcal{H}=H_0+W + +with :math:`\tilde\chi`--dependent interactions defined by (specified in the +configuration file by :code:`hamiltonian = DefaultWithChi`): + +.. math:: + + W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2. + + +.. code-block:: toml + :caption: **phase_separation.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + + [field] + mesh_size = [20, 20, 20] # FFT grid size + sigma = 1.0 # filtering length scale in nm + kappa = 0.05 # compressibility in mol/kJ + chi = [ + ['A', 'B', 5.0], # (name i, name j, strength) + ] + +A simple input structure/topology file :code:`phase_separation.HDF5` containing +an equal number of :code:`A` type and :code:`B` type particles is available in +the `HyMD-tutorial/phase_separation`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd phase_separation.toml phase_separation.HDF5 + +we may examine the resulting trajectory. In the case of a low interaction +strength :math:`\tilde\chi` of :code:`5.0` (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to :code:`40.0` (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +`phase_separation.ipynb`_. + + +.. _HyMD-tutorial/phase_separation: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/phase_separation +.. _phase_separation.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/phase_separation.ipynb + + +Diblock copolymers +================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true + :align: right + :width: 200 + +Having introduced particle--field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive :math:`\tilde\chi`--interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the :code:`integrator = "respa"` keyword. Putting the pieces together, the +configuration file may look like the following: + +.. code-block:: toml + :caption: **copolymer.toml** + + [simulation] + integrator = "respa" + respa_inner = 15 + n_steps = 2000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [10.0, 10.0, 10.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [50, 50, 50] # FFT grid size + sigma = 0.5 # filtering length scale in nm + chi = [ + ["A", "B", 30.0], # (i, j, strength) + ] + + [bonds] + bonds = [ + ["A", "A", 0.25, 1500.0], # (i, j, equilibrium length, strength) + ["A", "B", 0.25, 1500.0], + ["B", "B", 0.25, 1500.0], + ] + angle_bonds = [ + ["A", "A", "A", 180.0, 25.0], # (i, j, k, equilibrium angle, strength) + ["B", "B", "B", 180.0, 25.0], + ] + +A simple input structure/topology file :code:`copolymer.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/copolymer`_ github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten :code:`A` followed by ten :code:`B` type particles. +Running the simulation with + +.. code:: bash + + python3 -m hymd copolymer.toml copolymer.HDF5 + +the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +`copolymer.ipynb`_. + + +.. _HyMD-tutorial/copolymer: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/copolymer +.. _copolymer.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer.ipynb + + +Lipid bilayer self-assembly +=========================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true + :align: right + :width: 300 + +Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field--particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the :code:`thermostat_coupling_groups` keyword. With parameters +optimised in :cite:`ledum2020automated`, the configuration file looks like: + + +.. code-block:: toml + :caption: **lipid_self_assembly.toml** + + [simulation] + integrator = "respa" + respa_inner = 25 + n_steps = 3000 + n_print = 200 + n_flush = 1 + time_step = 0.01 + box_size = [9.96924, 9.96924, 10.03970] + start_temperature = 323 + target_temperature = 323 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.05 + domain_decomposition = 10001 + cancel_com_momentum = true + max_molecule_size = 15 + thermostat_coupling_groups = [ + ["N", "P", "G", "C"], + ["W"], + ] + + [field] + mesh_size = [25, 25, 25] + sigma = 1.0 + chi = [ + ["C", "W", 42.24], + ["G", "C", 10.47], + ["N", "W", -3.77], + ["G", "W", 4.53], + ["N", "P", -9.34], + ["P", "G", 8.04], + ["N", "G", 1.97], + ["P", "C", 14.72], + ["P", "W", -1.51], + ["N", "C", 13.56], + ] + + [bonds] + bonds = [ + ["N", "P", 0.47, 1250.0], + ["P", "G", 0.47, 1250.0], + ["G", "G", 0.37, 1250.0], + ["G", "C", 0.47, 1250.0], + ["C", "C", 0.47, 1250.0], + ] + angle_bonds = [ + ["P", "G", "G", 120.0, 25.0], + ["P", "G", "C", 180.0, 25.0], + ["G", "C", "C", 180.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +A randomly mixed input structure/topology file +:code:`lipid_self_assembly.HDF5` with a few hundred lipids in a roughy +:code:`10 x 10 x 10nm` box is available in the +`HyMD-tutorial/lipid_self_assembly`_ github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation + +.. code:: bash + + python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5 + +we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook `lipid_self_assembly.ipynb`_. + + +.. _HyMD-tutorial/lipid_self_assembly: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/lipid_self_assembly +.. _lipid_self_assembly.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/lipid_self_assembly.ipynb + + +Peptide in lipid bilayer +======================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true + :align: right + :width: 300 + +Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer. + + +The `configuration file`_ is available in the `HyMD-tutorial/peptide`_ github +repository (omitted here for brevity). + +A pre-equilibrated input structure/topology file :code:`peptide.HDF5` with a +few hundred lipids in a roughy :code:`20 x 20 x 20nm` box is available in the +`HyMD-tutorial/peptide`_ github repository. Running the simulation + +.. code:: bash + + python3 -m hymd peptide.toml peptide.HDF5 + +we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook `peptide.ipynb`_. + + +.. _HyMD-tutorial/peptide: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/peptide +.. _configuration file: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.toml +.. _peptide.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.ipynb + + +SDS +=== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true + :align: right + :width: 300 + +The last part we introduce is explicit electrostatic interactions through +particle--mesh Ewald. Enabling the electrostatic calculations is done via the +:code:`coulombtype` keyword. :code:`"PIC_Spectral"` is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the :code:`dielectric_const` keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge. + + + +.. code-block:: toml + :caption: **sds.toml** + + [simulation] + integrator = "respa" + respa_inner = 10 + n_steps = 3000 + n_print = 1500 + n_flush = + time_step = 0.01 + box_size = [8.3, 8.3, 8.3] + start_temperature = 298 + target_temperature = 298 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.1 + domain_decomposition = 10000 + cancel_com_momentum = true + max_molecule_size = 5 + thermostat_coupling_groups = [ + ["S", "C"], + ["W", "Na"], + ] + dielectric_const = 45.0 # dielectric constant for the simulation medium + coulombtype = "PIC_Spectral" # particle in cloud, spectral method + + [field] + mesh_size = [64, 64, 64] + sigma = 0.5 + chi = [ + ["S", "C", 13.50], + ["S", "Na", 0.00], + ["S", "W", -3.60], + ["C", "Na", 13.50], + ["C", "W", 33.75], + ["W", "Na", 0.00], + ] + + [bonds] + bonds = [ + ["S", "C", 0.50, 1250.0], + ["C", "C", 0.50, 1250.0], + ] + angle_bonds = [ + ["S", "C", "C", 170.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +An input structure/topology file :code:`sds.HDF5` with a couple thousand +randomly dispersed SDS chains is available in the `HyMD-tutorial/sds`_ github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a :code:`/charge` dataset. +Running the simulation with + +.. code:: bash + + python3 -m hymd sds.toml sds.HDF5 + +we observe the aggregation of the SDS into micellular structures---first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook `sds.ipynb`_. + + +.. _HyMD-tutorial/sds: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/sds +.. _sds.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/sds.ipynb diff --git a/v1.0.1/_sources/doc_pages/filtering.rst.txt b/v1.0.1/_sources/doc_pages/filtering.rst.txt new file mode 100644 index 00000000..02af68c6 --- /dev/null +++ b/v1.0.1/_sources/doc_pages/filtering.rst.txt @@ -0,0 +1,30 @@ +.. _filtering-label: + +Filtering +######### +The default grid-independent filter function used in HyMD is a Gaussian + +.. math:: + + H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] + +with reciprocal space representation + +.. math:: + + \hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +The coarse-graining parameter :math:`\sigma` determines a length scale of +particle extent and is given as configuration file input by + +.. code:: toml + + sigma = 0.75 + + +Implementing new filters +^^^^^^^^^^^^^^^^^^^^^^^^ +Implementing new filter functions is straightforward by hijacking +the :code:`setup` method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional. diff --git a/v1.0.1/_sources/doc_pages/installation.rst.txt b/v1.0.1/_sources/doc_pages/installation.rst.txt new file mode 100644 index 00000000..7cdc0d68 --- /dev/null +++ b/v1.0.1/_sources/doc_pages/installation.rst.txt @@ -0,0 +1,144 @@ +.. _installation-label: + +Installation +############ +HyMD may be installed using :code:`pip` by + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + + +Dependencies +============ +HyMD **requires** a working MPI compiler and HDF5. On an Ubuntu system, this +may be installed via + +.. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y libhdf5-openmpi-dev python3-mpi4py + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-cache-dir --no-binary=h5py h5py + +It is **highly recommended** to have MPI-enabled HDF5 and h5py. A +non-MPI-enabled h5py may be installed by simply + +.. code-block:: bash + + sudo apt-get update -y + sudo apt-get install libhdf5-serial-dev + python3 -m pip --upgrade install h5py + +A non-MPI-enabled HDF5 library with corresponding :code:`h5py` will work +(mostly), but is inconvenient and slow. Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +:code:`--disable-mpio` argument to HyMD, see :ref:`commandline-label`. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial. + +Install in docker +================= +A docker image with build essentials setup is available at `dockerhub`_ with tag +:code:`mortele/hymd`, + +.. code-block:: bash + + docker pull mortele/hymd:1.0 + docker run -it mortele/hynd:1.0 + /app# python3 -m pip install hymd + /app# python3 -m hymd [CONFIGURATION_FILE] [TOPOLOGY_FILE] + +.. _dockerhub: + https://hub.docker.com/repository/docker/mortele/hymd + + +Common issues +============= + +Numpy errors while importing the Fortran force kernels +------------------------------------------------------ + +.. code-block:: python3 + + RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd + + Traceback (most recent call last): + + (...) + + File "/..../HyMD/hymd/__init__.py", line 2, in + from .main import main # noqa: F401 + File "/..../HyMD/hymd/main.py", line 10, in + from .configure_runtime import configure_runtime + File "/..../hymd/configure_runtime.py", line 12, in + from .input_parser import read_config_toml, parse_config_toml + File "/..../HyMD/hymd/input_parser.py", line 12, in + from .force import Bond, Angle, Dihedral, Chi + File "/..../HyMD/hymd/force.py", line 8, in + from force_kernels import ( # noqa: F401 + ImportError: numpy.core.multiarray failed to import + +can normally be fixed by updating numpy versions, + +.. code-block:: bash + + python3 -m pip install -U numpy + + +Error building pfft-python due to missing curl/wget +--------------------------------------------------- + +.. code-block:: python3 + + Building wheel for pfft-python (setup.py) ... error + ERROR: Command errored out with exit status 1: + command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_ + cwd: /tmp/pip-install-fr6nt9m4/pfft-python/ + Complete output (56 lines): + running bdist_wheel + running build + running build_py + + (...) + + curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found + wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found + Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + Please check curl or wget + You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ + Traceback (most recent call last): + File "", line 1, in + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in + setup( + File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup + return distutils.core.setup(**attrs) + File "/usr/lib/python3.8/distutils/core.py", line 148, in setup + + (...) + + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions + build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:])) + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft + raise ValueError("could not build fftw; check MPICC?") + ValueError: could not build fftw; check MPICC? + ---------------------------------------- + ERROR: Failed building wheel for pfft-python + Running setup.py clean for pfft-python + Failed to build pfft-python + +can be fixed by installing either `curl`_ or `wget`_ + +.. code-block:: bash + + apt-get install -y curl wget + + +.. _`curl`: + https://curl.se/ + +.. _`wget`: + https://www.gnu.org/software/wget/ diff --git a/v1.0.1/_sources/doc_pages/interaction_energy_functionals.rst.txt b/v1.0.1/_sources/doc_pages/interaction_energy_functionals.rst.txt new file mode 100644 index 00000000..f33c004e --- /dev/null +++ b/v1.0.1/_sources/doc_pages/interaction_energy_functionals.rst.txt @@ -0,0 +1,98 @@ +.. _functionals-label: + +Interaction energy functionals +############################## +A few interaction energy functionals :math:`W` are defined in HyMD through +the :code:`Hamiltonian` class and associated subclasses. + +:math:`\chi`--interaction and :math:`\kappa`--incompressibility +=============================================================== +The most common hPF energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultWithChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where :math:`\tilde\chi_{\text{A}-\text{B}}` is the interaction energy between +overlapping densities of particle types :math:`\text{A}` and :math:`\text{B}`. +The incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\tilde\chi` +and :math:`\kappa` in the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + chi = [ + ["A", "B", 15.85], + ["B", "C", -5.70], + ... + ] + +Only :math:`\kappa`--incompressibility +====================================== +The only :math:`\kappa` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultNoChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where the incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Only :math:`\phi^2` +=================== +The :math:`\phi^2` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "SquaredPhi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2, + +where the :math:`\phi` squared term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Implementing new interaction energy forms +========================================= +Implementing new interaction energy functions is straightforward by subclassing +:code:`Hamiltonian` and applying :code:`sympy` differentiation to the symbolic +field objects. The :code:`sympy.lamdify` function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields. diff --git a/v1.0.1/_sources/doc_pages/intramolecular_bonds.rst.txt b/v1.0.1/_sources/doc_pages/intramolecular_bonds.rst.txt new file mode 100644 index 00000000..820e81bc --- /dev/null +++ b/v1.0.1/_sources/doc_pages/intramolecular_bonds.rst.txt @@ -0,0 +1,142 @@ +.. _bonds-label: + +Intramolecular bonds +#################### + +Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see :ref:`config-label`. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +:ref:`benchmarks-label`), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable. + +All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]). + + +Two-particle bonds +^^^^^^^^^^^^^^^^^^ +Stretching bonds in HyMD are implemented as harmonic spring potentials, + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2, + +where :math:`r=|\mathbf{r}|` is the inter-particle distance, :math:`k` is a +constant of dimension energy (units :math:`\text{kJ}\,\text{mol}^{-1}`), and +:math:`r_0` is the equilibrum length of the bond (units: :math:`\text{nm}`). The +force is calculated as + +.. math:: + + F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r}, + +where :math:`\mathbf{r}` is the vector pointing *from* :math:`i` *to* :math:`j`. + +In the configuration file, two-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_two_particle_example.toml + + [bonds] + bonds = [ + ["A", "A", 0.47, 1250.0], + ["A", "B", 0.37, 940.0], + ["B", "C", 0.50, 1010.0], + ["C", "A", 0.42, 550.0], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Three-particle bonds +^^^^^^^^^^^^^^^^^^^^ +Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle--particle--particle angle :math:`\theta`, + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2, + +where :math:`k` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}`), and :math:`\theta_0` is the equilibrum +angle of the bond (units: :math:`{}^\circ`). Defining the particles with labels +:math:`a`, :math:`b`, and :math:`c`, let :math:`\mathbf{r}_a` denote the vector +pointing from :math:`b` to :math:`a`, and correspondingly let +:math:`\mathbf{r}_c` point from :math:`b` to :math:`c`. The +:math:`a`--:math:`b`--:math:`c` may be computed through the law of Cosines, + +.. math:: + + \theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right] + +Then the force acting on :math:`a` and :math:`c` is + +.. math:: + + \mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a}, + + \mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c}, + +and + +.. math:: + + \mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c + +In the configuration file, three-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_three_particle_example.toml + + [bonds] + angle_bonds = [ + ["A", "A", "A", 180.0, 90.0], + ["A", "B", "A", 120.0, 55.0], + ["B", "C", "C", 30.0, 10.0], + ["C", "A", "B", 110.0, 25.5], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Four-particle bonds +^^^^^^^^^^^^^^^^^^^ +Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle :math:`\phi` between the +:math:`a`--:math:`b`--:math:`c` and :math:`b`--:math:`c`--:math:`d` planes, for +a dihedral bond quartet :math:`a`, :math:`b`, :math:`c`, and :math:`d`. The +potential takes the form + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n), + +where :math:`c_n` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`), and :math:`\phi_n` are +specified phase angles in the cosine series. + +In the configuration file, four-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_four_particle_example.toml + + [bonds] + dihedrals = [ + ["A", "B", "C", "D"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0], + ] diff --git a/v1.0.1/_sources/doc_pages/overview.rst.txt b/v1.0.1/_sources/doc_pages/overview.rst.txt new file mode 100644 index 00000000..0e4d6b65 --- /dev/null +++ b/v1.0.1/_sources/doc_pages/overview.rst.txt @@ -0,0 +1,166 @@ +.. _overview-label: + +================================ + Usage overview for HylleraasMD +================================ + +HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a `toml`_ format configuration file, along with a topology and structure +file specifying the input system in HDF5 format. + +.. _`toml`: + https://github.com/toml-lang/toml + +**Configuration file** + +The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a :code:`[5, 5, 5]` nm simulation box at 300 K may look like +the following: + +.. code-block:: toml + :caption: **config_simple_1.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "SquaredPhi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [30, 30, 30] # FFT grid size + sigma = 0.5 # filtering length scale in nm + +Note that for the version 1.0 release of HyMD, the :code:`[particles]`, +:code:`[simulation]`, and :code:`[field]` groups are optional specifiers for +structuring the configuration file. + +For a full specification of every recognised configuration keyword in HyMD, +please refer to :ref:`config-label`. + +**Topology and structure file** + +The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +:code:`N` particles may look like the following: + +.. code-block:: bash + :caption: **example_structure.HDF5** + + group / + # root group + + dataset /coordinates + # float32, shape (T, N, D,) + # Time steps of N rows of D dimensional coordinate data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /velocities + # float32, shape (T, N, D,) OPTIONAL + # Time steps of N rows of D dimensional velocity data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /bonds + # int32, shape (N, B,) OPTIONAL + # Each row i contains indices of the particles bonds from/to i + # B denotes the maximum bonds per particle + + dataset /indices + # int32, shape (N,) + # Index of each particle, 0--(N-1) + + dataset /molecules + # int32, shape (N,) + # Index of molecule each particle belongs to + # Used to construct bond network locally on MPI ranks + + dataset /names + # str10, shape (N,) + # Fixed size string array containing particle type names + + dataset /types + # int32, shape (N,) OPTIONAL + # Mapping of particle names to type indices + + +For a full specification of the topology and structure input file, see +:ref:`topology-label`. + +**Command line arguments** + +A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the :code:`config_simple_1.toml` and :code:`example_structure.HDF5` +files may look like the following: + +.. code-block:: bash + + mpirun -n ${MPI_NUM_RANKS} python3 -m hymd \ # HyMD executable + config_simple_1.toml \ # configuration file + example_structure.HDF5 \ # structure file + --logfile=log_out.txt \ # set logfile path + --seed 123456 \ # set random seed + --verbose 2 \ # set logging verbosity + --velocity-output # enable velocity in trajectory output + +For a full specification of all command line arguments, see +:ref:`commandline-label`. + +**More examples** + +For more thorough rundown and concrete usage examples, see +:ref:`examples-label`. + +Running parallel simulations +============================ +Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the **only** difference being how the python3 interpreter is +invoked. Prepending :code:`mpirun -n ${NPROCS}` to the usual +:code:`python3 -m hymd` runs the simulation with :code:`${NPROCS}` MPI ranks. + +Inputting + +.. code:: bash + + mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field + +sets up an example simulation of the `HyMD-tutorial/ideal_gas`_ system. For +more details about this system in particular, or other example simulations, see +the `HyMD-tutorial`_ repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas + + +Running tests +============= +Run serial code tests by + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd + cd hymd/ + python3 -m pip install pytest pytest-mpi + python3 -m pytest + +There is a small convenience script in :code:`hymd/` for running the MPI-enabled +tests, + +.. code-block:: bash + + chmod +x pytest-mpi + ./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no diff --git a/v1.0.1/_sources/doc_pages/theory.rst.txt b/v1.0.1/_sources/doc_pages/theory.rst.txt new file mode 100644 index 00000000..95d7842c --- /dev/null +++ b/v1.0.1/_sources/doc_pages/theory.rst.txt @@ -0,0 +1,114 @@ +.. _theory-label: + +Theory +###### +Hybrid particle--field simulations switch out the ordinary particle--particle +`Lennard-Jones`_ interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle--field densities are +defined as + +.. math:: + + \phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i), + +where :math:`\mathbf{r}` is a spatial coordinate, :math:`P` is a window function +used to distribute particle number densities onto a computational grid, and +:math:`\mathbf{r}_i` is the position of particle :math:`i` (of total :math:`N`). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of :math:`N` particles in :math:`M` molecules is + +.. math:: + + \mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})] + +with :math:`H_0` being a standard intramolecular Hamiltonian form (see +:ref:`bonds-label`) including kinetic terms, while :math:`W` is a density +dependent *interaction energy functional*. + +In the Hamiltonian hPF-MD formalism :cite:`bore2020hamiltonian`, the density +field is filtered using a grid-independent filtering function :math:`H`, + +.. math:: + + \tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}). + +The filter smooths the density, ensuring that :math:`\tilde\phi` and +:math:`W[\tilde\phi([\phi])]` both converge as the grid size is reduced. + +External potential +================== +The external potential acting on a particle is defined as the functional +derivative of :math:`W` with respect to :math:`\phi`. In the filtered formalism, +the potential takes the form + +.. math:: + + V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ + &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})}, + +under the assumption of a *local* form of the interaction energy functional, +:math:`W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]`. Note +that + +.. math:: + + \frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}). + +Force interpolation +=================== +The forces on particle :math:`i` are obtained by differentiation of the external +potential, + +.. math:: + + \mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i). + + +Reciprocal space calculations +============================= +The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density :math:`\phi_{ijk}` with CIC, we apply the filtering +and obtain the discrete version of the external potential by + +.. math:: + + \tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big] + +and + +.. math:: + + V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +The forces are obtained by differentiation of :math:`V` in Fourier space as + +.. math:: + + \nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +Filter +====== +By default, the filter used in HyMD is a simple Gaussian of the form + +.. math:: + + H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ + \hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +For more details about the filtering, see :ref:`filtering-label`. + +Hamiltonian form +================ +The default form of the interaction energy functional in HyMD is + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2. + +See :ref:`functionals-label` for details. + + +.. _`Lennard-Jones`: + https://en.wikipedia.org/wiki/Lennard-Jones_potential diff --git a/v1.0.1/_sources/doc_pages/topology_input.rst.txt b/v1.0.1/_sources/doc_pages/topology_input.rst.txt new file mode 100644 index 00000000..adabe129 --- /dev/null +++ b/v1.0.1/_sources/doc_pages/topology_input.rst.txt @@ -0,0 +1,77 @@ +.. _topology-label: + +============================ +Topology and structure file +============================ +The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root :code:`/` group. + +The `HyMD-tutorial`_ has multiple examples of structure files for various levels +of complexity. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Required datasets +================= +:/coordinates: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/indices: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/names: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`string` (:code:`length` between :code:`1` and :code:`16`)] + + The shape represents one particle name per :code:`N` particles. The datatype may be a string of length :code:`=<16`. + + + +Optional datasets +================= +:/velocities: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/types: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle type index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/molecules: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one molecule index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/bonds: + :code:`array` shape [:code:`N`, :code:`B`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents :code:`B` bond specifications (indices of different particles) per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/charge: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents one particle charge per :code:`N` particles. The data type may be either four or eight byte reals. diff --git a/v1.0.1/_sources/index.rst.txt b/v1.0.1/_sources/index.rst.txt new file mode 100644 index 00000000..435d79f3 --- /dev/null +++ b/v1.0.1/_sources/index.rst.txt @@ -0,0 +1,157 @@ +.. hymd documentation master file, created by + sphinx-quickstart on Thu Dec 16 13:31:43 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +############################### +HylleraasMD documentation +############################### + +:Release: + |release| +:Date: + |today| + +**HylleraasMD** (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems. + +HyMD can run canonical hPF-MD simulations :cite:`Milano2009JCP`, or filtered +density Hamiltonian hPF (HhPF-MD) simulations :cite:`bore2020hamiltonian`, with +or without explicit PME electrostatic interactions :cite:`kolli2018JCTC`. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +:cite:`Cascella2008,bore2018hybrid`. Martini +style elastic networks (ElNeDyn) :cite:`periole2009combining` are also +supported. + +HyMD uses the pmesh (`github.com/rainwoodman/pmesh`_) library for particle-mesh +operations, with the PPFT :cite:`pippig2013pfft` backend for FFTs through the +pfft-python bindings (`github.com/rainwoodman/pfft-python`_). File IO is done +via HDF5 formats to allow MPI parallel reads. + +User Guide +========== +The HylleraasMD :doc:`User Guide ` provides comprehensive information on how to run +simulations. Selected :doc:`Examples ` are available to guide new users. + +.. _`github.com/rainwoodman/pmesh`: + https://github.com/rainwoodman/pmesh +.. _`github.com/rainwoodman/pfft-python`: + https://github.com/rainwoodman/pfft-python + +Installing HyMD +=============== +The easiest approach is to install using pip_: + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + +For more information and **required dependencies**, see +:ref:`installation-label`. + +.. _pip: + http://www.pip-installer.org/en/latest/index.html + +Source Code +=========== +**Source code** is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the `GNU Lesser General Public +License v3.0`_. Obtain the source code with `git`_: + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git + +.. _GNU Lesser General Public License v3.0: + https://www.gnu.org/licenses/lgpl-3.0.html +.. _git: + https://git-scm.com/ + + +Development +=========== +HyMD is developed and maintained by researchers at the `Hylleraas Centre for +Quantum Molecular Sciences`_ at the `University of Oslo`_. + +|pic1| |pic2| + +.. _`Hylleraas Centre for Quantum Molecular Sciences`: + https://www.mn.uio.no/hylleraas/english/ +.. _`University of Oslo`: + https://www.uio.no/ + +.. |pic1| image:: img/hylleraas_centre_logo_black.png + :target: img/hylleraas_centre_logo_black.png + :width: 250 px + +.. |pic2| image:: img/uio_full_logo_eng_pos.png + :target: img/uio_full_logo_eng_pos.png + :width: 325 px + + + +References +========== +.. bibliography:: + :all: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. Contents +.. ======== + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Getting started + + ./doc_pages/installation + ./doc_pages/overview + ./doc_pages/config_file + ./doc_pages/topology_input + ./doc_pages/command_line + ./doc_pages/constants_and_units + + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Examples + + ./doc_pages/examples + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Theory + + ./doc_pages/theory + ./doc_pages/intramolecular_bonds + ./doc_pages/electrostatics + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Developer documentation + + ./doc_pages/interaction_energy_functionals + ./doc_pages/filtering + ./doc_pages/benchmarks + ./doc_pages/api diff --git a/v1.0.1/_static/basic.css b/v1.0.1/_static/basic.css new file mode 100644 index 00000000..be19270e --- /dev/null +++ b/v1.0.1/_static/basic.css @@ -0,0 +1,856 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/v1.0.1/_static/css/badge_only.css b/v1.0.1/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/v1.0.1/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/v1.0.1/_static/css/fonts/Roboto-Slab-Bold.woff b/v1.0.1/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/v1.0.1/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/v1.0.1/_static/css/fonts/Roboto-Slab-Bold.woff2 b/v1.0.1/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/v1.0.1/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/v1.0.1/_static/css/fonts/Roboto-Slab-Regular.woff b/v1.0.1/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/v1.0.1/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/v1.0.1/_static/css/fonts/Roboto-Slab-Regular.woff2 b/v1.0.1/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/v1.0.1/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/v1.0.1/_static/css/fonts/fontawesome-webfont.eot b/v1.0.1/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/v1.0.1/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/v1.0.1/_static/css/fonts/fontawesome-webfont.svg b/v1.0.1/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/v1.0.1/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v1.0.1/_static/css/fonts/fontawesome-webfont.ttf b/v1.0.1/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/v1.0.1/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/v1.0.1/_static/css/fonts/fontawesome-webfont.woff b/v1.0.1/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/v1.0.1/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/v1.0.1/_static/css/fonts/fontawesome-webfont.woff2 b/v1.0.1/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/v1.0.1/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/v1.0.1/_static/css/fonts/lato-bold-italic.woff b/v1.0.1/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/v1.0.1/_static/css/fonts/lato-bold-italic.woff differ diff --git a/v1.0.1/_static/css/fonts/lato-bold-italic.woff2 b/v1.0.1/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/v1.0.1/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/v1.0.1/_static/css/fonts/lato-bold.woff b/v1.0.1/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/v1.0.1/_static/css/fonts/lato-bold.woff differ diff --git a/v1.0.1/_static/css/fonts/lato-bold.woff2 b/v1.0.1/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/v1.0.1/_static/css/fonts/lato-bold.woff2 differ diff --git a/v1.0.1/_static/css/fonts/lato-normal-italic.woff b/v1.0.1/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/v1.0.1/_static/css/fonts/lato-normal-italic.woff differ diff --git a/v1.0.1/_static/css/fonts/lato-normal-italic.woff2 b/v1.0.1/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/v1.0.1/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/v1.0.1/_static/css/fonts/lato-normal.woff b/v1.0.1/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/v1.0.1/_static/css/fonts/lato-normal.woff differ diff --git a/v1.0.1/_static/css/fonts/lato-normal.woff2 b/v1.0.1/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/v1.0.1/_static/css/fonts/lato-normal.woff2 differ diff --git a/v1.0.1/_static/css/theme.css b/v1.0.1/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/v1.0.1/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/v1.0.1/_static/custom.css b/v1.0.1/_static/custom.css new file mode 100644 index 00000000..b20d6282 --- /dev/null +++ b/v1.0.1/_static/custom.css @@ -0,0 +1,91 @@ + +body{ + background: #FFFFFF !important; +} + +.wy-menu-vertical header, .wy-menu-vertical p.caption{ + color: #4EA0AF!important; +} +.wy-menu-vertical li.current{ + background-color: #f4f4f4!important; +} +.wy-menu-vertical li.toctree-l2.current>a{ + background-color: #ebebeb!important; +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{ + background-color: #e3e3e3!important; +} + +.rst-content .sidebar{ + background-color: #fff!important; + border-radius: 6px; + -moz-border-radius: 6px; + -webkit-border-radius: 6px; +} + +h1 > a, h2 > a, h3 > a, h4 > a, h5 > a, h6 > a { + color: #17d9ff; +} + +h1, h2, h3, h4, h5, h6 { + color: black; + font-weight: normal; + padding: 0; +} + +h1, h2, h3 { + margin-top: 30px; + margin-bottom: 20px; +} + +h1 { + color: white; + padding: 20px 20px 20px 45px; + margin: 20px 0 35px -45px; + background: linear-gradient(to left, #fff, #2b38ff)!important; + + width: calc(100% + 90px); + border-bottom: 3px solid #000; +} + +h2 { + padding: .2em 0; + border-bottom: 1px solid #ddd; +} + +h3 { + margin-top: 35px; +} + +h4 { + margin-top: 30px; +} + +h5 { + margin-top: 25px; +} + +.wy-nav-content{ + max-width: none!important; +} + +.wy-side-nav-search{ + background: #2b38ff!important; +} + +.wy-side-nav-search input[type=text]{ + border-color:#4DA0B0!important; +} + +.wy-side-nav-search input[type=text]{ + border-radius: 4px!important; +} + +#caption-api { + background: red !important; +} + +#caption-text-api { + text-color: blue !important; +} diff --git a/v1.0.1/_static/doctools.js b/v1.0.1/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/v1.0.1/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/v1.0.1/_static/documentation_options.js b/v1.0.1/_static/documentation_options.js new file mode 100644 index 00000000..9fd31e43 --- /dev/null +++ b/v1.0.1/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '1.0.1', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/v1.0.1/_static/file.png b/v1.0.1/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/v1.0.1/_static/file.png differ diff --git a/v1.0.1/_static/hymd_icon_white.png b/v1.0.1/_static/hymd_icon_white.png new file mode 100644 index 00000000..d0396a17 Binary files /dev/null and b/v1.0.1/_static/hymd_icon_white.png differ diff --git a/v1.0.1/_static/hymd_logl_white_text_abbr.png b/v1.0.1/_static/hymd_logl_white_text_abbr.png new file mode 100644 index 00000000..8c0e50c8 Binary files /dev/null and b/v1.0.1/_static/hymd_logl_white_text_abbr.png differ diff --git a/v1.0.1/_static/jquery-3.5.1.js b/v1.0.1/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/v1.0.1/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. API reference

+
+

4.1. Integrator

+

Integrates equations of motion.

+

Implements the Velocity Verlet integrator. The reversible reference system +propagator algorithm (rRESPA) integrator uses the Velocity Verlet functions +inside the MD loop in the main module.

+
+
+hymd.integrator.integrate_position(positions, velocities, time_step)[source]
+

Position update step of the Velocity Verlet integration algorithm.

+

Computes the position update step of the Velocity Verlet algorithm. The +positions argument is not changed in place.

+
+
Parameters:
+
+
positions(N, D) numpy.ndarray

Array of positions of N particles in D dimensions.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_velocity

The velocity update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step, then the positions are updated a full step using the updated +velocities

+
+\[\mathbf{x}_{\text{new}} = \mathbf{x} + \Delta t \mathbf{v}\]
+
+ +
+
+hymd.integrator.integrate_velocity(velocities, accelerations, time_step)[source]
+

Velocity update step of the Velocity Verlet integration algorithm.

+

Computes the velocity update step of the Velocity Verlet algorithm. The +velocities argument is not changed in place.

+
+
Parameters:
+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
accelerations(N, D) numpy.ndarray

Array of accelerations of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_position

The position update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step

+
+\[\mathbf{v}_{\text{new}} = \mathbf{v} + \frac{\Delta t}{2m} +\mathbf{f}\]
+

before the positions are moved a full step using the updated half-step +velocities.

+
+ +
+
+

4.2. Thermostat

+

Scales or otherwise modifies the particle velocities during simulation to +simulate coupling to an external heat bath with temperature T₀.

+
+
+hymd.thermostat._random_chi_squared(prng: numpy.random._generator.Generator, M: int)float[source]
+

Draw the sum of M squared normally distributed values

+

The value is generated by the Gamma distribution, in lieu of generating +M Gaussian distributed numbers and summing their squares.

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
Mint

Number of standard normally distributed numbers in the sum.

+
+
+
+
Returns:
+
+
float

The sum of M squared normally distributed values centered at +zero with unit standard deviation.

+
+
+
+
+

Notes

+

The sum of the squares of k independent standard normal random variables is +distributed according to a \(\chi^2\) distribution.

+
+\[\chi^2_1 + \chi_2^2 + \chi_3^2 + \dots + \chi_M^2 +\sim +\sigma^2\chi^2(k)\]
+

This is a special case of the \(\Gamma\) distribution, +\(\Gamma(k/2, 2)\), and may be generated by

+
+\[\chi^2(k) \sim 2 \Gamma(k/2, 2)\]
+

References

+

Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of +Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. +J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246.

+
+ +
+
+hymd.thermostat._random_gaussian(prng: numpy.random._generator.Generator)float[source]
+

Draw a single random number from the standard normal distribution +Generate a number from the Gaussian distribution centered at zero with unit +standard deviation, \(N(0, 1)\).

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
+
+
Returns:
+
+
float

A random number drawn from \(N(0, 1)\).

+
+
+
+
+
+ +
+
+hymd.thermostat.csvr_thermostat(velocity: numpy.ndarray, names: numpy.ndarray, config: hymd.input_parser.Config, prng: numpy.random._generator.Generator, comm: mpi4py.MPI.Intracomm = <mpi4py.MPI.Intracomm object>, random_gaussian: Callable[[numpy.random._generator.Generator], float] = <function _random_gaussian>, random_chi_squared: Callable[[numpy.random._generator.Generator, int, float], float] = <function _random_chi_squared>, remove_center_of_mass_momentum: bool = True)numpy.ndarray[source]
+

Canonical sampling through velocity rescaling thermostat

+

Implements the CSVR thermostat. Rescales the system kinetic energy by a +stochastically chosen factor to keep the temperature constant. Requires +communcation of the kinetic energies calculated locally for each MPI rank. +The random numbers sampled through random_gaussian and +random_chi_squared are broadcast from the root rank to the other +ranks to ensure the scaling is performed with the same stochasticity for +all particles in the full system.

+

The velocities are cleaned of center of mass momentum before the thermostat +is applied, and the center of mass momentum is subsequently reapplied. This +is performed for each thermostat coupling group, i.e. the center of mass +momenta of each group is separately removed and reapplied after +thermostatting.

+

The implementation here is based on the derivation presented in the 2008 +Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper.

+
+
Parameters:
+
+
velocity(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
names(N,) numpy.ndarray

Array of particle names.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
random_gaussiancallable, optional

Function for generating standard normally distributed numbers.

+
+
random_chi_squaredcallable, optional

Function for generating \(\chi^2\)-distributed numbers

+
+
remove_center_of_mass_momentumbool, optional

If True, the center of mass of each coupling group is removed before +the thermostat is applied. The center of mass momenta are added back +after the kinetic energy rescaling is complete.

+
+
+
+
+
+

See also

+
+
_random_gaussian

Used to sample Gaussian-distributed numbers.

+
+
_random_chi_squared

Used to sample \(\chi^2\)-distributed numbers.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +

References

+

G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). +G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008).

+
+ +
+
+

4.3. Hamiltonian

+
+
+class hymd.hamiltonian.Hamiltonian(config)[source]
+

Interaction energy functional superclass

+
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+_setup()[source]
+

Superclass setup

+

Sets up the grid-independent filtering function H, and the +SymPy logic for symbolically differentiating interaction energy +functionals in Hamiltonian subclasses.

+
+ +
+ +
+
+class hymd.hamiltonian.SquaredPhi(config)[source]
+

Simple squared density interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + \sum_k \tilde\phi_k + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(rho_0\) is the +average density of the fully homogenous system. Expressing the species +densities in terms of fluctuations from the average,

+
+\[\mathrm{d}\tilde\phi_k = \rho_0 - \tilde\phi_k,\]
+

it is evident that this interaction energy functional is a slight change of +the DefaultNoChi Hamiltonian, as the expanded interaction energy +density becomes

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + 6\rho_0\left[ + \sum_k \mathrm{d}\tilde\phi_k + \right] + + + 9\rho_0^2 + + + \sum_k \mathrm{d}\tilde\phi_k^2 + + + \prod_{k\not=l} + \mathrm{d}\tilde\phi_k \mathrm{d}\tilde\phi_l + \right),\]
+

identical to DefaultNoChi apart from a constant energy shift +\(9\rho_0^2`(which does not impact dynamics) and the +:math:\)rho_0`–\(\mathrm{d}\tilde\phi_k\) cross-terms. These +cross-terms constitute contributions to the energy linear in +\(\mathrm{d}\tilde\phi_k\) absent in DefaultNoChi, which has +only quadratic terms present.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultNoChi(config)[source]
+

Incompressibility-only interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a +\right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. The SquaredPhi Hamiltonian implements a similar +functional with an additional linear term component depending on

+
+\[\mathmr{d}\tilde\phi_k = \tilde\phi_k - \rho_0\]
+

and not \(\mathrm{d}\tilde\phi_k^2\). No explicit inter-species +interaction is present apart from the indirect interaction through the +incompressibility.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultWithChi(config, unique_names, type_to_name_map)[source]
+

Incompressibility and \(\chi\)-interactions energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = + \frac{1}{2\rho_0} + \sum_{k,l}\chi_{kl} \tilde\phi_k \tilde\phi_l + + + \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. \(\chi_{ij}\) is the Flory-Huggins-like +inter-species mixing energy.

+
+
+__init__(config, unique_names, type_to_name_map)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup(unique_names, type_to_name_map)[source]
+

Setup the interaction energy potential and the external potential

+
+
Parameters:
+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+ +
+ +
+
+

4.4. Force

+

Calculates intramolecular forces between bonded particles in molecules

+
+
+class hymd.force.Angle(atom_1: str, atom_2: str, equilibrium: float, strength: float, atom_3: str)[source]
+

Dataclass representing a single three-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any three-particle bond between particles of specific types A, +B, and C (where A, B, and C may be +different or the same). Harmonic angular three-particle bonds in HyMD take +the form

+
+\[V_3(\mathbf{r}_1, \mathbf{r}_2, \mathbf{r}_3) = + \frac{1}{2}k + \left( + \cos^{-1} + \left[ + \frac{ + (\mathbf{r}_1-\mathbf{r}_2) + \cdot + (\mathbf{r}_3-\mathbf{r}_2) + } + { + \vert\mathbf{r}_1-\mathbf{r}_2\vert + \vert\mathbf{r}_3-\mathbf{r}_2\vert + } + \right] - \theta_0 + \right)^2\]
+
+

See also

+
+
Bond

Two-particle bond type dataclass

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
equilibriumfloat

Equilibrium angle at which the energy associated with the +three-particle angular bond vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient.

+
+
+
+
+
+
+atom_3: str
+
+ +
+ +
+
+class hymd.force.Bond(atom_1: str, atom_2: str, equilibrium: float, strength: float)[source]
+

Dataclass representing a single two-particle bond type

+

A bond type is a bond strength and equilibrium distance associated with +any bond between particles of specific types A and B +(where A and B may be the same or different). Harmonic +two-particle bonds in HyMD take the form

+
+\[V_2(\mathbf{r}_1, \mathbf{r}_2) = + \frac{1}{2}k + \left( + \vert \mathbf{r}_1 - \mathbf{r}_2 \vert - r_0 + \right)^2,\]
+

where \(k\) is the bond strength (spring constant) and \(r_0\) is +the equilibrium bond length (at which the energy is zero).

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
equilibriumfloat

Equilibrium distance at which the energy associated with the bond +vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient (spring constant).

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+equilibrium: float
+
+ +
+
+strength: float
+
+ +
+ +
+
+class hymd.force.Chi(atom_1: str, atom_2: str, interaction_energy: float)[source]
+

Dataclass representing a single \(\chi\) mixing interaction type

+

An interaction mixing energy type is a mixing energy associated with +density overlap between species of types A and B +(specified as inputs atom_1 and atom_2). A positive mixing +energy promotes phase separation, a negative mixing energy promotes mixing. +The interaction energy density (provided the DefaultWithChi +Hamiltonian is used) takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} + \sum_{k,l}\chi_{k,l} \tilde\phi_k\tilde\phi_l,\]
+

where \(\chi_{k,l}\) denotes the mixing energy between species +\(k\) and \(l\), with \(\kappa\) being the incompressibility. +The value of the interaction mixing energy parameter may be extracted from +Flory-Huggins theory.

+
+

See also

+
+
hymd.hamiltonian.DefaultWithChi

Interaction energy functional using \(\chi\)-interactions.

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
interaction_energyfloat

Interaction mixing energy.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+interaction_energy: float
+
+ +
+ +
+
+class hymd.force.Dielectric_type(atom_1: str, dielectric_value: float)[source]
+
+
+atom_1: str
+
+ +
+
+dielectric_value: float
+
+ +
+ +
+
+class hymd.force.Dihedral(atom_1: str, atom_2: str, atom_3: str, atom_4: str, coeffs: numpy.ndarray, dih_type: int)[source]
+

Dataclass representing a single four-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any four-particle torsional bond between particles of specific types +A, B, C, and D (where A, B, +C, and D may be different or the same). Dihedral +four-particle bonds in HyMD take different forms depending on the +dih_type parameter.

+

In the following, let \(\phi\) denote the angle between the planes +spanned by the relative positions of atoms A-B-C +and B-C-D. If dih_type = 0, then

+
+\[V_4(\phi) = \sum_n c_n + \left( + 1 + \cos\left[ + n\phi - d_n + \right] + \right),\]
+

where \(c_n\) are energy coefficients and \(d_n\) are propensity +phases. By default, the cosine sum is truncated at five terms. If +coeffs provides only a single float, this is used as the coiling +propensity parameter \(\lambda\). In this case, \(c_n\) and +\(d_n\) are automatically set to values which promote alpha helical +(\(\lambda=-1\)), beta sheet (\(\lambda=1\)), or a mixed +(\(1>\lambda>-1\)) structure (using values provided by Bore et al. +(2018)). In this case, the full potential takes the form

+
+\[V_4(\phi;\lambda) = + \frac{1}{2}(1-\lambda) V_{\text{prop},\alpha}(\phi) + + + \frac{1}{2}(1+\lambda) V_{\text{prop},\beta}(\phi) + + + (1-\vert\lambda\vert) V_{\text{prop}, \text{coil}}(\phi),\]
+

with each of the \(V_{\mathrm{prop}, X}\) being fixed cosine series +potentials with pre-set \(c_n\) -s and \(d_n\) -s.

+

If dih_type = 1, then a combined bending torsional (CBT) potential +is employed,

+
+\[V_4(\phi,\gamma;\lambda) = + V_4(\phi;\lambda) + + + \frac{1}{2}K(\phi)(\gamma - \gamma_0)^2,\]
+

where \(V_4(\phi;\lambda)\) specifies the potential as given by the +coiling propensity parameter above, \(K(\phi)\) is a separate cosine +series potential acting as the angular three-particle bond strength, and +\(\gamma_0\) is the three-particle bond equilibrium angle. In this +case, the coeffs parameter must specify both a \(\lambda\) +value, in additon to the energy and phases dictating the \(K(\phi)\) +potential.

+

References

+

Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018.

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
atom_4str

Type name of particle 4.

+
+
coeffslist[list[float]] or list[float] or numpy.ndarray

Dihedral coefficients defining the series expansion of the dihedral +energy.

+
+
dih_typeint

Specifies the type of dihedral used; If 0, then coeffs +must contain either two lists of five energy coefficients +\(c_n\) and five propensity phases \(d_n\) or a single +floating point number defining the \(\lambda\) coiling propensity +parameter. If 1, the combined bending-torsional potential is +used, and coeffs must specify \(\lambda\) and two lists +containing energy coefficients and propensity phases for the +\(V_\text{prop}\) propensity potential, defined in terms of cosine +series.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+atom_3: str
+
+ +
+
+atom_4: str
+
+ +
+
+coeffs: numpy.ndarray
+
+ +
+
+dih_type: int
+
+ +
+ +
+
+hymd.force.compute_angle_forces__plain(f_angles, r, bonds_3, box_size)[source]
+

Computes forces resulting from angular interactions

+
+

Deprecated since version 1.0.0: compute_angle_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_bond_forces__plain(f_bonds, r, bonds_2, box_size)[source]
+

Computes forces resulting from bonded interactions

+
+

Deprecated since version 1.0.0: compute_bond_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size)[source]
+

Computes forces resulting from dihedral interactions

+
+

Deprecated since version 1.0.0: compute_dihedral_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.dipole_forces_redistribution(f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb)[source]
+

Redistribute electrostatic forces calculated from topologically +reconstructed ghost dipole point charges to the backcone atoms of the protein.

+
+ +
+
+hymd.force.find_all_paths(G, u, n)[source]
+

Helper function that recursively finds all paths of given lenght ‘n + 1’ inside a network ‘G’. +Adapted from https://stackoverflow.com/a/28103735.

+
+ +
+
+hymd.force.prepare_bonds(molecules, names, bonds, indices, config, topol=None)[source]
+

Rearrange the bond information for usage in compiled Fortran kernels

+

Restructures the lists resulting from the execution of +prepare_bonds_old into numpy arrays suitable for calls to optimized +Fortran code calculating bonded forces and energiesself.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2_atom_1(B,) numpy.ndarray

Local index of particle 1 for each of B constructed +two-particle bonds.

+
+
bonds_2_atom_2(B,) numpy.ndarray

Local index of particle 2 for each of B constructed +two-particle bonds.

+
+
bonds_2_equilibrium(B,) numpy.ndarray

Equilibrium distance for each of B constructed two-particle +bonds.

+
+
bonds_2_strength(B,) numpy.ndarray

Bond strength for each of B constructed two-particle +bonds.

+
+
bonds_3_atom_1(A,) numpy.ndarray

Local index of particle 1 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_2(A,) numpy.ndarray

Local index of particle 2 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_3(A,) numpy.ndarray

Local index of particle 3 for each of A constructed +three-particle bonds.

+
+
bonds_3_equilibrium(A,) numpy.ndarray

Equilibrium angle for each of A constructed three-particle +bonds.

+
+
bonds_3_strength(A,) numpy.ndarray

Bond strength for each of A constructed three-particle +bonds.

+
+
bonds_4_atom_1(D,) numpy.ndarray

Local index of particle 1 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_2(D,) numpy.ndarray

Local index of particle 2 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_3(D,) numpy.ndarray

Local index of particle 3 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_4(D,) numpy.ndarray

Local index of particle 4 for each of D constructed +four-particle bonds.

+
+
bonds_4_coeff(D,) numpy.ndarray

Cosine series coefficients for each of D constructed +four-particle bonds.

+
+
bonds_4_type(D,) numpy.ndarray

Dihedral type for each of D constructed four-particle +bonds.

+
+
bonds_4_last(D,) numpy.ndarray

Flags indicating if dih_type is 1 for each of D +constructed four-particle bonds.

+
+
+
+
+
+

See also

+
+
prepare_bonds_old

Used internally to reconstruct the bonded interactions types from the connectivity information in the structure/topology input file and the bonded types specified in the configuration file.

+
+
+ +
+ +
+
+hymd.force.prepare_bonds_old(molecules, names, bonds, indices, config)[source]
+

Find bonded interactions from connectivity and bond types information

+
+

Deprecated since version 1.0.0: prepare_bonds_old was replaced by prepare_bonds for +use with compiled Fortran kernels prior to 1.0.0 release.

+
+

Prepares the necessary equilibrium and bond strength information needed by +the intramolecular interaction functions. This is performed locally on each +MPI rank, as the domain decomposition ensures that for all molecules all +consituent particles are always contained on the same MPI rankself.

+

This function traverses the bond connectivity information provided in the +structure/topology input file and indentifies any two-, three-, or +four-particle potential bonds. For each connected chain of two, three, or +four particles, a matching to bond types is attempted. If the corresponding +names match, a bond object is initialized.

+

In order to investigate the connectivity, a graph is created using +networkx functionality.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2list

List of lists containing local particle indices, equilibrium +distance, and bond strength coefficient for each reconstructed +two-particle bond.

+
+
bonds_3

List of lists containing local particle indices, equilibrium angle, +and bond strength coefficient for each reconstructed three-particle +bond.

+
+
bonds_4

List of lists containing local particle indices, dihedral type index, +and dihedral coefficients for each reconstructed four-particle +torsional bond.

+
+
bb_indexlist

List indicating the dihedral type of each four-particle bond in +bonds_4.

+
+
+
+
+
+

See also

+
+
Bond

Two-particle bond type dataclass.

+
+
Angle

Three-particle angular bond type dataclass.

+
+
Dihedral

Four-particle torsional bond type dataclass.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+hymd.force.prepare_index_based_bonds(molecules, topol)[source]
+
+ +
+
+hymd.force.propensity_potential_coeffs(x: float)[source]
+
+ +
+
+

4.5. Logger

+
+
+class hymd.logger.Logger[source]
+

Log output handler class

+

Notes

+

This wraps the default python library logging, see +docs.python.org/3/library/logging.html.

+
+
Attributes:
+
+
levelint

Determines the verbosity level of the log, corresponding to +logging.level. Numerical values 50 (logging.CRITICAL), +40 (logging.ERROR), 30 +(logging.WARNING), 20 (logging.INFO), +10 (logging.DEBUG), and 0 +(logging.UNSET) are supported values. Any log event message +less severe than the specified level is ignored. All other event +messages are emitted.

+
+
log_filestr

Path to output log file.

+
+
formatstr

Prepended dump string for each log event. Specifies the log event +level, the module emitting the event, the code line, the enclosing +function name, and the MPI rank writing the message.

+
+
date_formatstr

Prepends the date before all log event messages.

+
+
formatterlogging.Formatter

Formatter handling the prepending of the information in format and +date_format to each log event message. Used by default for all +loggers.

+
+
rank0logging.Logger

Default logger object for the root MPI rank.

+
+
all_rankslogging.Logger

Default logger object for messages being emitted from all MPI ranks +simultaneously.

+
+
+
+
+
+
+classmethod setup(default_level=20, log_file=None, verbose=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Sets up the logger object.

+

If a log_file path is provided, log event messages are output +to it. Otherwise, the logging messages are emitted to stdout.

+
+
Parameters:
+
+
default_levelint, optional

Default verbosity level of the logger. Unless specified, it is +10 (logging.INFO).

+
+
log_filestr, optional

Path to output log file. If None or not priovided, no log file is +used and all logging is done to stdout.

+
+
verbosebool, optional

Increases the logging level to 30 (logging.WARNING) +if True, otherwise leaves the logging level unchanged.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterRoot(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the root MPI rank log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterAll(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the all-MPI-ranks log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+

4.6. Input parser

+

Parses and handles the configuration information provided for the simulation

+
+
+class hymd.input_parser.Config(n_steps: int, time_step: float, mesh_size: Union[List[int], numpy.ndarray, int], sigma: float, kappa: float, dtype: Optional[numpy.dtype] = None, box_size: Optional[Union[List[float], numpy.ndarray]] = None, n_print: Optional[int] = None, tau: Optional[float] = None, start_temperature: Optional[Union[float, bool]] = None, target_temperature: Optional[Union[float, bool]] = None, mass: Optional[float] = None, hamiltonian: Optional[str] = None, domain_decomposition: Optional[Union[int, bool]] = None, integrator: Optional[str] = None, respa_inner: int = 1, file_name: str = '<config file path unknown>', name: Optional[str] = None, tags: List[str] = <factory>, bonds: List[hymd.force.Bond] = <factory>, angle_bonds: List[hymd.force.Angle] = <factory>, dihedrals: List[hymd.force.Dihedral] = <factory>, chi: List[hymd.force.Chi] = <factory>, n_particles: Optional[int] = None, max_molecule_size: Optional[int] = None, n_flush: Optional[int] = None, thermostat_work: float = 0.0, thermostat_coupling_groups: List[List[str]] = <factory>, initial_energy: Optional[float] = None, cancel_com_momentum: Union[int, bool] = False, coulombtype: Optional[str] = None, convergence_type: Optional[str] = None, pol_mixing: Optional[float] = None, dielectric_const: Optional[float] = None, conv_crit: Optional[float] = None, dielectric_type: List[hymd.force.Dielectric_type] = <factory>, self_energy: Optional[float] = None, type_charges: Optional[Union[List[float], numpy.ndarray]] = None, rho0: Optional[float] = None, a: Optional[float] = None, pressure: bool = False, barostat: Optional[str] = None, barostat_type: Optional[str] = None, tau_p: Optional[float] = None, target_pressure: List[hymd.barostat.Target_pressure] = <factory>, n_b: Optional[int] = None, m: List[float] = <factory>)[source]
+

Configuration object

+

Handles and verifies the simulation configuration specified in the +configuration file.

+
+

See also

+
+
hymd.input_parser.Bond

Two-particle bond type dataclass.

+
+
hymd.input_parser.Angle

Three-particle bond type dataclass.

+
+
hymd.input_parser.Dihedral

Four-particle bond type dataclass.

+
+
+ +
+
Attributes:
+
+
gas_constantfloat

Constant value of the gas constant, R (equivalently the Boltzmann +constant) in the units used internally in HyMD.

+
+
coulomb_constantfloat

Constant value of the Coulomb constant which converts electric field +values to forces and electric potential values to energies in the units +used internally in HyMD.

+
+
n_steps: int

Number of time steps in the simulation.

+
+
time_step: float

Outer time step used in the simulation. If the rRESPA intergrator is +used, the inner time step (the time step used in the integration of +intramolecular bending, stretching, and torsional forces) is +time_step / respa_inner.

+
+
box_sizelist[float] or (D,) numpy.ndarray

Simulation box size of simulation in D dimensions in units of +nanometers.

+
+
mesh_sizelist[int] or int or numpy.ndarray

Number of grid points used for the discrete density grid.

+
+
sigmafloat

Filter width representing the effective coarse-graining level of the +particles in the simulation.

+
+
kappafloat

Compressibility parameter used in the relaxed incompressibility term in +the interaction energy functional.

+
+
n_printint, optional

Frequency of trajectory/energy output to the H5MD trajectory/energy +output file (in units of number of time steps).

+
+
taufloat, optional

The time scale of the CSVR thermostat coupling.

+
+
start_temperaturefloat, optional

Generate starting temperature by assigning all particle velocities +randomly according to the Maxwell-Boltzmann distribution at +start_temperature Kelvin prior to starting the simulation.

+
+
target_temperaturefloat, optional

Couple the system to a heat bath at target_temperature Kelvin.

+
+
massfloat, optional

Mass of the particles in the simulation.

+
+
hamiltonianstr, optional

Specifies the interaction energy functional \(W[\tilde\phi]\) +for use with the particle-field interactions. Options: +SquaredPhi, DefaultNohChi, or DefaultWithChi.

+
+
domain_decompositionint, optional

Specifies the interval (in time steps) of domain decomposition +exchange, involving all MPI ranks sending and receiving particles +according to the particles’ positions in the integration box and the +MPI ranks’ assigned domain.

+
+
integratorstr, optional

Specifies the time integrator used in the simulation. Options: +velocity-verlet or respa.

+
+
respa_innerint, optional

The number of inner time steps in the rRESPA integrator. This denotes +the number of intramolecular force calculations (stretching, bending, +torsional) are performed between each impulse applied from the field +forces.

+
+
file_namestr, optional

File path of the parsed configuration file.

+
+
namestr, optional

Name for the simulation.

+
+
tagslist[str], optional

Tags for the simulation.

+
+
bondslist[Bond], optional

Specifies harmonic stretching potentials between particles in the +same molecule.

+
+
angle_bondslist[Angle], optional

Specifies harmonic angular bending potentials between particles in the +same molecule.

+
+
dihedralslist[Dihedral], optional

Specifies four-particle torsional potentials by cosine series.

+
+
chilist[Chi], optional

Specifies \(\chi\)-interaction parameters between particle +species.

+
+
n_particlesint, optional

Specifies the total number of particles in the input. Optional keyword +for validation, ensuring the input HDF5 topology has the correct number +of particles and molecules.

+
+
max_molecule_sizeint, optional

Maximum size of any single molecule in the system. Used to speed up +distribution of particles onto MPI ranks in a parallel fashion.

+
+
n_flushint, optional

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be +written to disk (in units of number of n_print).

+
+
thermostat_workfloat

Work performed by the thermostat on the system.

+
+
thermostat_coupling_groupslist[str], optional

Specifies individual groups coupling independently to the CSVR +thermostat. E.g. in a system containing "A", "B", and +"C" type particles, +thermostat_coupling_groups = [["A", "B"], ["C"],] would +thermalise types "A" and "B" together and couple +"C" type particles to a different thermostat (all individual +thermostats are at the same temperature, i.e. target_temperature +Kelvin).

+
+
initial_energyfloat

Value of the total energy prior to the start of the simulation.

+
+
cancel_com_momentumint, optional

If True, the total linear momentum of the center of mass is +removed before starting the simulation. If an integer is specifed, the +total linear momentum of the center of mass is removed every +remove_com_momentum time steps. If False, the linear +momentum is never removed.

+
+
coulombtypestr, optional

Specifies the type of electrostatic Coulomb interactions in the system. +The strength of the electrostatic forces is modulated by the relative +dielectric constant of the simulation medium, specified with the +dielectric_const keyword. Charges for individual particles are +specified in the structure/topology HDF5 input file, not in the +configuration file. If no charges (or peptide backbone dipoles) are +present, the electrostatic forces will not be calculated even if this +keyword is set to "PIC_Spectral".

+
+
dielectric_constfloat, optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. When +using helical propensity dihedrals, this keyword must be specified—even +if electrostatics are not included with the coulombtype +keyword.

+
+
dielectric_type: list[float], optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. The list assigns +relative dielectric values to each bead type, and an anisotropic +dielectric function is obtained from a weighted average.

+
+
+
+
+
+
+a: float = None
+
+ +
+
+angle_bonds: List[hymd.force.Angle]
+
+ +
+
+barostat: str = None
+
+ +
+
+barostat_type: str = None
+
+ +
+
+bonds: List[hymd.force.Bond]
+
+ +
+
+box_size: Union[List[float], numpy.ndarray] = None
+
+ +
+
+cancel_com_momentum: Union[int, bool] = False
+
+ +
+
+chi: List[hymd.force.Chi]
+
+ +
+
+conv_crit: float = None
+
+ +
+
+convergence_type: str = None
+
+ +
+
+coulomb_constant: ClassVar[float] = 138.935458
+
+ +
+
+coulombtype: str = None
+
+ +
+
+dielectric_const: float = None
+
+ +
+
+dielectric_type: List[hymd.force.Dielectric_type]
+
+ +
+
+dihedrals: List[hymd.force.Dihedral]
+
+ +
+
+domain_decomposition: Union[int, bool] = None
+
+ +
+
+dtype: numpy.dtype = None
+
+ +
+
+file_name: str = '<config file path unknown>'
+
+ +
+
+gas_constant: ClassVar[float] = 0.0083144621
+
+ +
+
+hamiltonian: str = None
+
+ +
+
+initial_energy: float = None
+
+ +
+
+integrator: str = None
+
+ +
+
+kappa: float
+
+ +
+
+m: List[float]
+
+ +
+
+mass: float = None
+
+ +
+
+max_molecule_size: int = None
+
+ +
+
+mesh_size: Union[List[int], numpy.ndarray, int]
+
+ +
+
+n_b: int = None
+
+ +
+
+n_flush: int = None
+
+ +
+
+n_particles: int = None
+
+ +
+
+n_print: int = None
+
+ +
+
+n_steps: int
+
+ +
+
+name: str = None
+
+ +
+
+pol_mixing: float = None
+
+ +
+
+pressure: bool = False
+
+ +
+
+respa_inner: int = 1
+
+ +
+
+rho0: float = None
+
+ +
+
+self_energy: float = None
+
+ +
+
+sigma: float
+
+ +
+
+start_temperature: Union[float, bool] = None
+
+ +
+
+tags: List[str]
+
+ +
+
+target_pressure: List[hymd.barostat.Target_pressure]
+
+ +
+
+target_temperature: Union[float, bool] = None
+
+ +
+
+tau: float = None
+
+ +
+
+tau_p: float = None
+
+ +
+
+thermostat_coupling_groups: List[List[str]]
+
+ +
+
+thermostat_work: float = 0.0
+
+ +
+
+time_step: float
+
+ +
+
+type_charges: Union[List[float], numpy.ndarray] = None
+
+ +
+ +
+
+hymd.input_parser.check_NPT_conditions(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check validity of barostat_type, barostat, +a, rho0, target_pressure, tau_p

+
+ +
+
+hymd.input_parser.check_angles(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_bonds(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_box_size(config, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_cancel_com_momentum(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_charges(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if charges across ranks sum to zero.

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of floats with charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_charges_types_list(config, types, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates a list of charge values of length types. +Charges are sorted according to type ID. Used in field.py. +# TODO: this is messy, we should fix it

+
+ +
+
+hymd.input_parser.check_chi(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_config(config, indices, names, types, charges, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs various checks on the specfied config to ensure consistency

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
indices(N,) numpy.ndarray

Array of integer indices for N particles.

+
+
names(N,) numpy.ndarray

Array of string names for N particles.

+
+
types(N,) numpy.ndarray

Array of integer type indices for N particles.

+
+
charges(N,) numpy.ndarray

Array of floats charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
Returns:
+
+
configConfig

Validated configuration object.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_dielectric(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Error handling for electrostatics. +Unit testing of toml/tomli input.

+
+ +
+
+hymd.input_parser.check_dihedrals(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_domain_decomposition(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_hamiltonian(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_integrator(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_m(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_mass(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_max_molecule_size(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_b(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_flush(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_particles(config, indices, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_print(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_name(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_start_and_target_temperature(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Validate provided starting and target thermostat temperatures

+

Assesses the provided temperature target and ensures it is a non-negative +floating point number or False. Ensures the starting temperature is +a non-negative floating point number or False.

+

If the value for either is None, the returned configuration object +has the values defaulted to False in each case.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
validated_configConfig

Configuration object with validated target_temperature and +start_temperature.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_tau(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_thermostat_coupling_groups(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.parse_config_toml(toml_content, file_path=None, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.read_config_toml(file_path)[source]
+
+ +
+
+hymd.input_parser.sort_dielectric_by_type_id(config, charges, types)[source]
+

Creates a list of length N CG-particles, sorted after the charges from +the input HDF5 file. Used in file_io.py

+
+ +
+
+

4.7. Field

+

Forces and energies from the discretized particle-field grid interactions

+
+
+hymd.field.compute_field_and_kinetic_energy(phi, phi_q, psi, velocity, hamiltonian, positions, types, v_ext, config, layouts, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the particle-field and kinetic energy contributions

+

Calculates the kinetic energy through

+
+\[E_k = \sum_j \frac{1}{2}m_j\mathbf{v}_j\cdot\mathbf{v}_j,\]
+

and the particle-field energy by

+
+\[E_\text{field} = \int\mathrm{d}\mathbf{r}\, + w[\tilde\phi],\]
+

where \(w\) is the interaction energy functional density.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
velocity(N,D) numpy.ndarray

Array of velocities for N particles in D dimensions. +Local for each MPI rank.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Local for each MPI rank–the full computational grid is +represented by the collective fields of all MPI ranks.

+
+
configConfig

Configuration object.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field

Computes the up-to-date external potential for use in calculating the particle-field energy.

+
+
+ +
+ +
+
+hymd.field.compute_field_energy_q_GPE(config, phi_eps, field_q_energy, dot_elec, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the electrostatic energy after electrosatic forces is +calculated.

+

From the definition of the elecrostatic potential \(\Psi\), the energy +is

+
+
+
W = frac{1}{2}intmathrm{d}mathbf{r},

epsilon(mathbf{r})} left(mathbf{E}cdot mathbf{E}right),

+
+
+
+

where \(\epsilon(\mathbf{r})}\) is the anisotropic, spatially dependent, +relative dielectric of the simulation medium.

+
+
Parameters:
+
+
confighymd.input_parser.Config

Configuration object.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
field_q_energyfloat

Total elecrostatic energy.

+
+
dot_elecpmesh.pm.RealField

Pmesh RealField object for storing \(|\mathbf{E(r)}|^{2}\) +on the computational grid. Local for each MPI rank – the full computational +grid is represented by the collective fields of all MPI ranks.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field_force_q_GPE

Compute the electrosatic force from an anisotropic dielectric general Poisson equation.

+
+
+ +
+ +
+
+hymd.field.compute_field_force(layouts, r, force_mesh, force, types, n_types)[source]
+

Interpolate particle-field forces from the grid onto particle positions

+

Backmaps the forces calculated on the grid to particle positions using the +window function \(P\) (by default cloud-in-cell [CIC]). In the +following, let \(\mathbf{F}_j\) denote the force acting on the +particle with index \(j\) and position \(\mathbf{r}_j\). The +interpolated force is

+
+\[\mathbf{F}_j = -\sum_k\nabla V_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(V_{j_k}\) is the discretized external potential at grid vertex +\(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid vertex +with index \(j_k\), and \(h^3\) is the volume of each grid voxel. +The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
r(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
force(N,D) numpy.ndarray

Array of forces for N particles in D dimensions. Local +for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
n_typesint

Number of different unique types present in the simulation system. +n_types is global, i.e. the same for all MPI ranks even if some +ranks contain zero particles of certain types.

+
+
+
+
+
+ +
+
+hymd.field.compute_self_energy_q(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the self energy for the interaction due to the Ewald scheme +used to compute the electrostatics. The energy is stored in config.

+

The self interaction energy is given by:

+
+\[U_{self} = \sqrt{\frac{1}{2\pi\sigma^2}} \sum_{i=1}^{N} q_i^2\]
+

where \(q_i\) are the charges and \(\sigma\) is the half-width +of the Gaussian filter.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
Returns:
+
+
field_q_self_energyfloat

Electrostatic self energy.

+
+
+
+
+
+ +
+
+hymd.field.domain_decomposition(positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs domain decomposition

+

Rearranges the MPI rank memory layout into one that better mimics the PFFT +pencil grid 2D decomposition. As molecules are always required to be fully +contained on a single MPI rank, a perfect decomposition is not always +possible. The best decomposition which leaves the center of mass of all +molecules in their respective correct domains is used, with possible +overlap into neighbouring domains if the spatial extent of any molecule +crosses domain boundaries.

+
+
Parameters:
+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
*args

Variable length argument list containing arrays to include in the +domain decomposition.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
bonds(N,M) numpy.ndarray, optional

Array of M bonds originating from each of N particles.

+
+
verboseint, optional

Specify the logging event verbosity of this function.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
Domain decomposedcode:positions and any array specified in
+
:code:`*args`, in addition tocode:bonds and molecules if these
+
arrays were provided as input.
+
+
+
+
+ +
+
+hymd.field.initialize_pm(pmesh, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates the necessary pmesh objects for pfft operations.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pmobject ‘pmesh.pm.ParticleMesh’
+
field_listlist[pmesh.pm.RealField], (multiple)

Essential list of pmesh objects required for MD

+
+
list_coulomblist[pmesh.pm.RealField], (multiple)

Additional list of pmesh objects required for electrostatics.

+
+
+
+
+
+ +
+
+hymd.field.update_field(phi, phi_laplacian, phi_transfer, layouts, force_mesh, hamiltonian, pm, positions, types, config, v_ext, phi_fourier, v_ext_fourier, m, compute_potential=False)[source]
+

Calculate the particle-field potential and force density

+

If compute_potential is True, the energy may subsequently +be computed by calling compute_field_and_kinetic_energy.

+

Computes the particle-field external potential \(V_\text{ext}\) from +particle number densities through the smoothed density field, +\(\phi(\mathbf{r})\). With \(P\) being the cloud-in-cell (CIC) +window function, the density and filtered densities are computed as

+
+\[\phi(\mathbf{r}) = \sum_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\phi(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +external potential is computed in reciprocal space as

+
+\[V_\text{ext} = \mathrm{FFT}^{-1}\left[ + \mathrm{FFT} + \left( + \frac{\partial w}{\partial \tilde\phi} + \right) + \mathrm{FFT}(H) +\right],\]
+

where \(w\) is the interaction energy functional. Differentiating +\(V_\text{ext}\) is done by simply applying \(i\mathbf{k}\) in +Fourier space, and the resulting forces are back-transformed to direct +space and interpolated to particle positions by

+
+\[\mathbf{F}_j = -\sum_{j_k} \nabla V_{j_k} + P(\mathbf{r}_{j_k} - \mathbf{r}_j)h^3,\]
+

where \(j_k\) are the neighbouring vertices of particle \(j\) at +position \(\mathbf{r}_j\), and \(h^3\) is the volume of each grid +voxel.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Pre-allocated, but empty; any values +in this field are discarded. Changed in-place. Local for each MPI +rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
configConfig

Configuration object.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Pre-allocated, but empty; any values in this field are +discarded Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
phi_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computational grid is represented by the collective fields of all +MPI ranks.

+
+
v_ext_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplesField objects containing discretized +particle-field external potential values in reciprocal space on the +computational grid; D+1 fields in D dimensions for each +particle type. D copies are made after calculation for later +use in force calculation, because the force transfer function +application differentiates the field in-place, ruining the contents +for differentiation in the remaining D-1 spatial directions. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
m: list[float], (M,)

pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. +Defaults to 1.0 for all particle types.

+
+
compute_potentialbool, optional

If True, a D+1-th copy of the Fourier transformed +external potential field is made to be used later in particle-field +energy calculation. If False, only D copies are made.

+
+
+
+
+
+

See also

+
+
compute_field_and_kinetic_energy

Compute the particle-field energy after the external potential is calculated.

+
+
+ +
+ +
+
+hymd.field.update_field_force_q(charges, phi_q, phi_q_fourier, psi, psi_fourier, elec_field_fourier, elec_field, elec_forces, layout_q, hamiltonian, pm, positions, config)[source]
+

Calculate the electrostatic particle-field forces on the grid

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential is computed in reciprocal space as

+
+\[\Phi = \mathrm{FFT}^{-1}\left[ + \frac{4\pi k_e}{\varepsilon \vert\mathbf{k}\vert^2} + \mathrm{FFT}(\rho)\mathrm{FFT}(H) +\right],\]
+

with the electric field

+
+\[\mathbf{E} = \mathrm{FFT}^{-1}\left[ + -i\mathbf{k}\,\mathrm{FFT}(\Psi) +\right].\]
+

In the following, let \(\mathbf{F}_j\) denote the electrostatic force +acting on the particle with index \(j\) and position +\(\mathbf{r}_j\). The interpolated electrostatic force is

+
+\[\mathbf{F}_j = \sum_k q_j\mathbf{E}_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(\mathbf{E}_{j_k}\) is the discretized electric field at grid +vertex \(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid +vertex with index \(j_k\), and \(h^3\) is the volume of each grid +voxel. The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty; any values in this field +are discarded. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
elec_field_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +electric field values in reciprocal space on the computational grid. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
+
+
+
+ +
+
+hymd.field.update_field_force_q_GPE(conv_fun, phi, types, charges, phi_q, phi_q_fourier, phi_eps, phi_eps_fourier, phi_eta, phi_eta_fourier, phi_pol_prev, phi_pol, elec_field, elec_forces, elec_field_contrib, psi, Vbar_elec, Vbar_elec_fourier, force_mesh_elec, force_mesh_elec_fourier, hamiltonian, layout_q, layouts, pm, positions, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Calculate the electrostatic particle-field forces on the grid, arising from +a general Poisson equation, i.e. anisotropic permittivity/dielectric. +The function is called when tomli input config.coulombtype = “PIC_Spectral_GPE.”

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential for a variable dielectric does not have an +analytical expression, and is computed in reciprocal through an iterative +method.

+

The GPE states that

+
+\[\nabla \cdot \left(\epsilon(\mathbf{r}) +\nabla{\mathbf{\psi(r)}}\right) = -\rho({\mathbf{r}}).\]
+

where \(\epsilon(\mathbf{r})\) is the relative dielectric function.

+
+
Parameters:
+
+
conv_funConvergence function.

Returns a scalar. Depends on MPI allreduce for similar convergence +across MPI ranks.

+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_eps_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_etapmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +gradients of the relative dielectric values on the computational grid. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank–the +full computational grid is represented by the collective fields of all MPI ranks.

+
+
phi_eta_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated discretized +Fourier transformed gradient relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_pol_prevpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charge values on the computational grid. Parameter in +the iterative method.Pre-allocated,but empty. Changedin-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_polpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charges on the computational grid. Parameter in the iterative +method, updating the next quess in solving for the electrostatic potential. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank– +the full computational grid is represented by the collective fields of +all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all +MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
elec_field_contribpmesh.pm.RealField

Pmesh RealField object for storing +\(|\mathbf{E(r)}|^2/\phi_{0}\) on the computational grid. +Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
psipmesh.pm.RealField

Pmesh RealField object for storing electrostatic potential +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
Vbar_elecmesh.pm.RealField

Pmesh RealField object for storing functional derivatives of +:math:`|w({ phi })_{elec}`on the computational grid. +Pre-allocated, but empty. Changed in-place. Local for each MPI rank– +the full computational grid is represented by the collective fields of

+
+

all MPI ranks.

+
+
+
Vbar_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated functional +derivatives of \(\|w(\{ \phi \})_{elec}\) in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
force_mesh_elecpmesh.pm.RealField

Pmesh RealField object for storing electrostatic force values +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
force_mesh_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated electrostatic +force values in reciprocal space on the computational grid. Local for +each MPI rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
layouts: list[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
comm: mpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
compute_field_energy_q_GPE

Compute the electrostatic energy after electrosatic force is calculated for a variable (anisotropic) dielectric general Poisson equation.

+
+
+ +
+ +
+
+

4.8. File input/output

+

Handle file input/output in parllel HDF5 fashion

+
+
+class hymd.file_io.OutDataset(dest_directory, config, double_out=False, disable_mpio=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

HDF5 dataset handler for file output

+
+
+close_file(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Closes the HDF5 output file

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+
+flush()[source]
+

Flushes output buffers, forcing file writes

+
+ +
+
+is_open(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if HDF5 output file is open

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+ +
+
+hymd.file_io.distribute_input(in_file, rank, size, n_particles, max_molecule_size=201, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Assign global arrays onto MPI ranks, attempting load balancing

+

Distributes approximately equal numbers of particles (workload) onto each +independent MPI rank, while respecting the requirement that any molecule +must be fully contained on a single MPI rank only (no splitting molecules +across multiple CPUs).

+
+
Parameters:
+
+
in_fileh5py.File

HDF5 input file object.

+
+
rankint

Local rank number for this MPI rank.

+
+
sizeint

Global size of the MPI communicator (number of total CPUs).

+
+
n_particlesint

Total number of particles.

+
+
max_molecule_sizeint, optional

Maximum size of any molecule present in the system. Used to initially +guess where the MPI rank boundaries (start/end indices) in the global +arrays should be placed. If molecules of size +>max_molecule_size exist in the simulation system, HyMD +might work as expected. Or it might fail spectacularly.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
rank_range

Starting and ending indices in the global arrays for each MPI rank.

+
+
+
+
+
+ +
+
+hymd.file_io.setup_time_dependent_element(name, parent_group, n_frames, shape, dtype, units=None)[source]
+

Helper function for setting up time-dependent HDF5 group datasets

+

All output groups must adhere to the H5MD standard, meaning a structure of

+
+
┗━ group particle group (e.g. all) or observables group
+
+
┗━ group time-dependent data
+
+
┣━ dataset step shape=(n_frames,)
+
┣━ dataset time shape=(n_frames,)
+
┗━ dataset value shape=(n_frames, *)
+
+
+
+

is necessary.

+

References

+
+
H5MD specification :

https://www.nongnu.org/h5md/h5md.html

+
+
+
+ +
+
+hymd.file_io.store_data(h5md, step, frame, indices, positions, velocities, forces, box_size, temperature, pressure, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, field_energy, field_q_energy, plumed_bias, time_step, config, velocity_out=False, force_out=False, charge_out=False, plumed_out=False, dump_per_particle=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Writes time-step data to HDF5 output file

+

Handles all quantities which change during simulation, as opposed to +static quanitities (see store_static).

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
stepint

Step number.

+
+
frameint

Output frame number (step // n_print).

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
positions(N,) numpy.ndarray

Array of positions for N particles in D dimensions.

+
+
velocities(N,) numpy.ndarray

Array of velocities for N particles in D dimensions.

+
+
forces(N,) numpy.ndarray

Array of forces for N particles in D dimensions.

+
+
box_size(D,) numpy.ndarray

Array containing the simulation box size.

+
+
temperaturefloat

Calculated instantaneous temperature.

+
+
kinetic_energyfloat

Calculated instantaneous kinetic energy.

+
+
bond2_energyfloat

Calculated instantaneous harmonic two-particle bond energy.

+
+
bond3_energyfloat

Calculated instantaneous harmonic angular three-particle bond energy.

+
+
bond4_energyfloat

Calculated instantaneous dihedral four-particle torsion energy.

+
+
field_energyfloat

Calculated instantaneous particle-field energy.

+
+
field_q_energyfloat

Calculated instantaneous electrostatic energy.

+
+
plumed_biasfloat

PLUMED instantaneous bias energy.

+
+
time_stepfloat

Value of the time step.

+
+
configConfig

Configuration object.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charge_outbool, optional

If True, electrostatic energies are written to the output +HDF5 file.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to the output HDF5 file.

+
+
dump_per_particlebool, optional

If True, all quantities are written per particle.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
store_static

Outputs all static time-independent quantities to the HDF5 output file

+
+
+ +
+ +
+
+hymd.file_io.store_static(h5md, rank_range, names, types, indices, config, bonds_2_atom1, bonds_2_atom2, molecules=None, velocity_out=False, force_out=False, charges=False, dielectrics=False, plumed_out=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Outputs all static time-independent quantities to the HDF5 output file

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
rank_rangelist[int]

Start and end indices for global arrays for each MPI rank.

+
+
names(N,) numpy.ndarray

Array of names for N particles.

+
+
types(N,) numpy.ndarray

Array of type indices for N particles.

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
configConfig

Configuration object.

+
+
bonds_2_atom1(B,) numpy.ndarray

Array of indices of the first particle for B total +two-particle bonds.

+
+
bonds_2_atom2(B,) numpy.ndarray

Array of indices of the second particle for B total +two-particle bonds.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles.

+
+
dielectrics(N,) numpy.ndarray

Array of particle relative dielectric values for N particles.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to output HDF5 file.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
prepare_bonds

Constructs two-, three-, and four-particle bonds from toplogy input file and bond configuration information.

+
+
distribute_input

Distributes input arrays onto MPI ranks, attempting load balancing.

+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/doc_pages/benchmarks.html b/v1.0.1/doc_pages/benchmarks.html new file mode 100644 index 00000000..aeaa9638 --- /dev/null +++ b/v1.0.1/doc_pages/benchmarks.html @@ -0,0 +1,299 @@ + + + + + + + 3. Benchmarks — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Benchmarks

+

Homopolymer melt test systems of \(30^2\), \(40^2\), and \(50^2\) +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively.

+
+

3.1. Bonded forces

+

Legend label denotes the number of particles in the system.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-1.png +
+
+
+

3.2. Particle–field forces

+

Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-2.png +
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/doc_pages/command_line.html b/v1.0.1/doc_pages/command_line.html new file mode 100644 index 00000000..87ad18c0 --- /dev/null +++ b/v1.0.1/doc_pages/command_line.html @@ -0,0 +1,356 @@ + + + + + + + 5. Command line arguments — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. Command line arguments

+

Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle–field interactions.

+
+

5.1. Required arguments

+
+
configuration file:
+

type positional

+

Specifies the .toml format configuration file containing simulation details. See Configuration file for details.

+
+
structure and topology file:
+

type positional

+

Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See Topology and structure file for details.

+
+
+
+
+

5.2. Optional arguments

+
+
-v  --verbose

type optional

+

Number of following arguments: 0 or 1

+

Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying -v or --verbose with no additional specification. This increases verbosity level by 1. Alternatively, it maye be specified by --verbose V with V being 0, 1, or 2.

+
+
--profile

type optional

+

Number of following arguments: 0

+

Enables code profiling using cProfile. This will output one profiling file per MPI rank invoked in the simulation.

+
+
--double-precision

type optional

+

Number of following arguments: 0

+

Specify usage of double precision internally in HyMD (including in the FFTs).

+
+
--double-output

type optional

+

Number of following arguments: 0

+

Specify usage of double precision in the output trajectory from HyMD.

+
+
--velocity-output

type optional

+

Number of following arguments: 0

+

Specify that velocities should be output to the HyMD trajectory.

+
+
--force-output

type optional

+

Number of following arguments: 0

+

Specify that forces should be output to the HyMD trajectory.

+
+
--disable-mpio

type optional

+

Number of following arguments: 0

+

Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult.

+
+
--logfile

type optional

+

Number of following arguments: 1

+

Specifies the path of a plain text log file in which stdout is mirrored during simulation runs.

+
+
--seed

type optional

+

Number of following arguments: 1

+

Specifies the random seed used in the numpy random library to generate velocities, thermostatting, etc.

+
+
--disable-bonds

type optional

+

Number of following arguments: 0

+

Disable any two-particle bonds present in the system.

+
+
--disable-angle-bonds

type optional

+

Number of following arguments: 0

+

Disable any three-particle bonds present in the system.

+
+
--disable-dihedrals

type optional

+

Number of following arguments: 0

+

Disable any four-particle bonds present in the system.

+
+
--disable-dipole

type optional

+

Number of following arguments: 0

+

Disable any topological reconstruction of peptide backbone dipoles present in the system.

+
+
--disable-field

type optional

+

Number of following arguments: 0

+

Disable any particle–field interactions present in the system.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/doc_pages/config_file.html b/v1.0.1/doc_pages/config_file.html new file mode 100644 index 00000000..62362b42 --- /dev/null +++ b/v1.0.1/doc_pages/config_file.html @@ -0,0 +1,443 @@ + + + + + + + 3. Configuration file — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Configuration file

+

The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order.

+

The configuration file is a toml format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs.

+
+

3.1. Configuration file keywords

+

The following constitutes every possible keyword specification in HyMD +configuration files:

+
+

3.1.1. Metadata keywords

+

Configuration keywords specifying metadata for the H5MD output trajectory.

+
+
name:
+

string [optional, default: None]

+

Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file.

+
+
tags:
+

array [string] [optional, default: None]

+

Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file.

+
+
+
+
+

3.1.2. Particle keywords

+

Configuration keywords specifying properties of particles and molecules in the +system.

+
+
n_particles:
+

integer [optional, default: None]

+

Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules.

+
+
mass:
+

float [optional, default: 72.0] {units: \(\text{u}=\text{g}\,\text{mol}^{-1}\)}

+

Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal.

+
+
max_molecule_size:
+

integer [optional, default: 201]

+

Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code will crash if there are molecules larger than max_molecule_size in the topology/structure input file.

+
+
+
+
+

3.1.3. Simulation keywords

+

Configuration keywords specifying simulation parameters.

+
+
n_steps:
+

integer [required]

+

Total number of integration steps to perform for this simulation.

+
+
n_print:
+

integer or boolean [optional, default: False]

+

Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of number of time steps).

+
+
n_flush:
+

integer [optional, default: None]

+

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of number of n_print, i.e. n_print = 13, n_flush = 3 would result in the trajectory/energy being written to disk every 13 x 3 = 39 simulation steps)

+
+
time_step:
+

float [required] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time step per integration step. If the rRESPA multiple time step integrator is used (integrator = "respa"), this specifies the inner time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is respa_inner times the time_step , and the total simulation time is n_steps times time_step times respa_inner .

+
+
box_size:
+

array [float] [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable.

+
+
integrator:
+

string [required] (options: velocity-verlet or respa)

+

Specifies the time integrator used in the simulation. If respa, the reversible reference system propagator algorithm (rRESPA) [Tuckerman et al., 1992] integrator is used, with respa_inner number of inner (intramolecular force) time steps. If velocity-verlet, a normal Velocity Verlet integrator is used. If respa and respa_inner = 1, the rRESPA integrator is equivalent to the Velocity Verlet.

+
+
respa_inner:
+

integer [optional, default: 1]

+

The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces.

+
+
domain_decomposition:
+

integer or boolean [optional, default: False]

+

Specifies the interval (in time steps) of domain decomposition exchange, involving all MPI ranks sending and receiving particles according to the particles’ positions in the integration box and the MPI ranks’ assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If True, the decomposition is performed once (before starting the simulation). If False, no decomposition is performed.

+
+
cancel_com_momentum:
+

integer or boolean [optional, default: False]

+

If True, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every remove_com_momentum time steps. If False, the linear momentum is never removed.

+
+
start_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at start_temperature Kelvin prior to starting the simulation. If False, the velocities are not changed before starting the simulation.

+
+
target_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Couple the system to a heat bath at target_temperature Kelvin by applying a Canonical sampling through velocity rescaling [Bussi et al., 2007] thermostat with coupling strength tau. If False, no temperature control is applied.

+
+
tau:
+

float [optional, default: 0.7] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the CSVR thermostat coupling. In the limit of tau , the Hamiltonian dynamics are preserved and no temperature coupling takes place.

+
+
thermostat_coupling_groups:
+

array [array [string]] [optional, default: []]

+

Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing "A", "B", and "C" type particles, thermostat_coupling_groups = [["A", "B"], ["C"],] would thermalise types "A" and "B" together and couple "C" type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. target_temperature Kelvin).

+
+
hamiltonian:
+

string [optional, default: "DefaultNohChi"] (options: SquaredPhi, DefaultNohChi, or DefaultWithChi)

+

Specifies the interaction energy functional \(W[\tilde\phi]\) for use with the particle-field interactions. See Interaction energy functionals for details.

+
+
+
+
+

3.1.4. Field keywords

+

Configuration keywords specifying field parameters.

+
+
mesh_size:
+

array [integer] or integer [required]

+

Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is box_size / mesh_size.

+
+
kappa:
+

float [required] {units: \(\text{kJ}^{-1}\text{mol}\)}

+

Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional \(W[\tilde\phi]\). See Interaction energy functionals for more details.

+
+
sigma:
+

float [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See Filtering for more details.

+
+
chi:
+

array [array [string, float]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\)}

+

Array of \(\tilde\chi_\text{AB}\)-parameters indicating the strength of the repulsive or attractive interaction between particles of type "A" and the number density due to particles of type "B", and vice versa. Example: chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ] would specify a repulsive "A""B" type interaction, and a weakly attractive "C""D" interaction. Self-interaction \(\tilde\chi\)-terms are always zero. See Interaction energy functionals for more details.

+
+
+
+
+

3.1.5. Bond keywords

+

Configuration keywords specifying bonds and bonds parameters.

+
+
bonds:
+

array [array [2 string, 2 float]] [optional, default: []] {units: \(\text{nm}=10^{-9}~\text{m}\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+

Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ] indicates a "A""A" bond of equilibrium length 0.47 \(\text{nm}\) with a bond strength of 980.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding bond between "A" and "B" type particles with equilibrium length 0.31 \(\text{nm}\) and a strength of 1250.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify stretching bonds.

+
+
angle_bonds:
+

array [array [3 string, 2 float]] [optional, default: []] {units: \({}^\circ\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+
+

Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ] indicates a "A""A""A" angular bond that tries to keep the bond linear at 180 degrees with a bending strength of 55.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding angle bond between "A""B""B" prefering the angle at 120 degrees and a strength of 25.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify angular bonds.

+
+
+
dihedrals:
+

array [array [4 string, integer, COSINE SERIES ]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)}

+

Specifies four-particle torsional potentials by cosine series. See Intramolecular bonds for details about how to specify dihedrals.

+
+
+
+
+

3.1.6. Electrostatic keywords

+

Configuration keywords specifying electrostatics and electrostatic parameters.

+
+
coulombtype:
+

string [optional, default: None] (options: PIC_Spectral)

+

Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the dielectric_const keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, not in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to PIC_Spectral.

+
+
dielectric_const:
+

float [optional, default: None]

+

Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified—even if electrostatics are not included with the coulombtype keyword.

+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/doc_pages/constants_and_units.html b/v1.0.1/doc_pages/constants_and_units.html new file mode 100644 index 00000000..878e7ebf --- /dev/null +++ b/v1.0.1/doc_pages/constants_and_units.html @@ -0,0 +1,390 @@ + + + + + + + 6. Constants and Units — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

6. Constants and Units

+

HyMD uses the following units and constants internally and in all input and +output:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Units

Quantity

Symbol

Unit

length

\(r\)

\(\text{nm}=10^{-9}~\text{m}\)

time

\(t\)

\(\text{ps}=10^{-12}~\text{s}\)

charge

\(q\)

\(e=1.602176634 \cdot 10^{-19}~\text{C}\)

mass

\(m\)

\(\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}\)

temperature

\(\text{T}\)

\(\text{K}\)

energy

\(E\)

\(\text{kJ}\,\text{mol}^{-1}\)

velocity

\(v\)

\(\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}\)

momentum

\(P\)

\(\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}\)

force

\(\mathbf{F}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}\)

pressure

\(p\)

\(\text{bar}=100~\text{kPa}\)

electric potential

\(\Psi\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}\)

electric field

\(\mathbf{E}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}\)

compressibility

\(\kappa\)

\(\text{mol}\,\text{kJ}^{-1}\)

field-interaction

\(\tilde\chi\)

\(\text{kJ}\,\text{mol}^{-1}\)

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants

Constant

Symbol

Value

gas constant

\(R\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Boltzmann’s constant

\(k_\text{B}\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Avogadro’s constant

\(N_\text{A}\)

\(6.02214076 \cdot 10^23~\text{mol}^{-1}\)

Vacuum permittivity

\(\varepsilon_0\)

\(8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2\)

Coulomb constant

\(k_\text{e}\)

\(138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}\)

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/doc_pages/electrostatics.html b/v1.0.1/doc_pages/electrostatics.html new file mode 100644 index 00000000..ec70de33 --- /dev/null +++ b/v1.0.1/doc_pages/electrostatics.html @@ -0,0 +1,311 @@ + + + + + + + 3. Electrostatic interactions — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Electrostatic interactions

+

In the filtered Hamiltonian hPF formalism [Bore and Cascella, 2020] the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle–mesh Ewald.

+

The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered

+
+\[\tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i),\]
+

with \(q_i\) being the charge of particle \(i\) and \(H\) is the +filtering function (see Filtering). The value of the charge grid at +vertex \((i,j,k)\) is found by

+
+\[\tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)]\]
+

and the electrostatic potential \(\Psi_{ijk}\)

+
+\[\Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right],\]
+

where \(k_\text{e}\) is the Coulomb constant \(1/4\pi\varepsilon_0\). +The electric field is obtained by differentiation of the electrostatic +potential in Fourier space,

+
+\[\mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)]\]
+

from which the forces are interpolated back to the particle positions.

+
+

3.1. Specifying electrostatics

+

In HyMD, electrostatics are specified by the coulombtype and +dielectric_const keywords in the configuration file (see +Configuration file) and the /charge dataset in the HDF5 format +structure/topology input file (see Topology and structure file). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/doc_pages/examples.html b/v1.0.1/doc_pages/examples.html new file mode 100644 index 00000000..5e477f83 --- /dev/null +++ b/v1.0.1/doc_pages/examples.html @@ -0,0 +1,759 @@ + + + + + + + 1. Examples — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Examples

+

The following examples are ordered in more or less order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the HyMD-tutorial github repository.

+
+

1.1. Ideal gas

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true +

The simplest possible system is one with no interactions at all—intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like:

+
+
ideal_gas.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = false         # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+
+
+

A simple input structure/topology file ideal_gas.HDF5 is available in +the HyMD-tutorial/ideal_gas github repository (along with the code to +generate it). Run the (very) short simulation by

+
python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field   \
+                                              --velocity-output \
+                                              --force-output
+
+
+

with the --disable-field argument to completely turn off all +particle–field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook ideal_gas.ipynb for details.

+
+
+

1.2. Ideal chains

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true +

The simplest available interaction is the harmonic two-particle bond (see +Intramolecular bonds),

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2.\]
+

Extending the configuration file from the ideal gas case, we need to add a +bonds specification. Note that the [bonds] meta specifier is not +necessary, but may be used to help organise the input file.

+
+
ideal_chain.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+
+
+

A simple input structure/topology file ideal_chain.HDF5 with a few +coiled up ideal chain polymers is available in the +HyMD-tutorial/ideal_chain github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field
+
+
+

we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +ideal_chain.ipynb.

+
+
+

1.3. Stiff rods

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true +

Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the i--j--k angle \(\theta\) (see +Intramolecular bonds),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2.\]
+

Extending the configuration file from the ideal chain case, we need to add a +angle_bonds specification. Note that the [bonds] meta specifier +is not necessary, but may be used to help organise the input file.

+
+
rods.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+angle_bonds = [
+  ["A", "A", "A", 180.0, 100.0],   # (i, j, k, equilibrium angle, strength)
+]
+
+
+
+

A simple input structure/topology file rods.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook rods.ipynb.

+
+
+

1.4. Helixes

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true +

Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle \(\phi\) between the +i--j--k plane and the j--k--l plane (see Intramolecular bonds),

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n).\]
+

The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a dihedrals keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the dielectric_const +keyword even though we are not including electrostatic forces in the current +simulation. Note that the [bonds] meta specifier is not necessary, but +may be used to help organise the input file.

+
+
helixes.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+dielectric_const = 15.0
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.31, 10000.0],       # (i name, j name, equilibrium length, strength)
+]
+
+dihedrals = [
+  [
+    ["A", "A", "A", "A"],
+    [
+      [-1],
+      [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+      [0.08, 0.46, 1.65, -0.96, 0.38],
+    ],
+    [1.0]
+  ],
+]
+
+
+
+

A simple input structure/topology file helixes.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook helixes.ipynb.

+
+
+

1.5. Phase separation

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true +

The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types A and B. Using the Hamiltonian

+
+\[\mathcal{H}=H_0+W\]
+

with \(\tilde\chi\)–dependent interactions defined by (specified in the +configuration file by hamiltonian = DefaultWithChi):

+
+\[W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2.\]
+
+
phase_separation.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+
+[field]
+mesh_size = [20, 20, 20]           # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+kappa = 0.05                       # compressibility in mol/kJ
+chi = [
+  ['A', 'B', 5.0],                 # (name i, name j, strength)
+]
+
+
+
+

A simple input structure/topology file phase_separation.HDF5 containing +an equal number of A type and B type particles is available in +the HyMD-tutorial/phase_separation github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd phase_separation.toml phase_separation.HDF5
+
+
+

we may examine the resulting trajectory. In the case of a low interaction +strength \(\tilde\chi\) of 5.0 (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to 40.0 (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +phase_separation.ipynb.

+
+
+

1.6. Diblock copolymers

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true +

Having introduced particle–field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive \(\tilde\chi\)–interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the integrator = "respa" keyword. Putting the pieces together, the +configuration file may look like the following:

+
+
copolymer.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 15
+n_steps = 2000                     # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [10.0, 10.0, 10.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [50, 50, 50]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+chi = [
+  ["A", "B", 30.0],                # (i, j, strength)
+]
+
+[bonds]
+bonds = [
+  ["A", "A", 0.25, 1500.0],        # (i, j, equilibrium length, strength)
+  ["A", "B", 0.25, 1500.0],
+  ["B", "B", 0.25, 1500.0],
+]
+angle_bonds = [
+  ["A", "A", "A", 180.0, 25.0],    # (i, j, k, equilibrium angle, strength)
+  ["B", "B", "B", 180.0, 25.0],
+]
+
+
+
+

A simple input structure/topology file copolymer.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/copolymer github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten A followed by ten B type particles. +Running the simulation with

+
python3 -m hymd copolymer.toml copolymer.HDF5
+
+
+

the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +copolymer.ipynb.

+
+
+

1.7. Lipid bilayer self-assembly

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true +

Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field–particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the thermostat_coupling_groups keyword. With parameters +optimised in [Ledum et al., 2020], the configuration file looks like:

+
+
lipid_self_assembly.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 25
+n_steps = 3000
+n_print = 200
+n_flush = 1
+time_step = 0.01
+box_size = [9.96924, 9.96924, 10.03970]
+start_temperature = 323
+target_temperature = 323
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.05
+domain_decomposition = 10001
+cancel_com_momentum = true
+max_molecule_size = 15
+thermostat_coupling_groups = [
+  ["N", "P", "G", "C"],
+  ["W"],
+]
+
+[field]
+mesh_size = [25, 25, 25]
+sigma = 1.0
+chi = [
+  ["C", "W", 42.24],
+  ["G", "C", 10.47],
+  ["N", "W", -3.77],
+  ["G", "W", 4.53],
+  ["N", "P", -9.34],
+  ["P", "G", 8.04],
+  ["N", "G", 1.97],
+  ["P", "C", 14.72],
+  ["P", "W", -1.51],
+  ["N", "C", 13.56],
+]
+
+[bonds]
+bonds = [
+  ["N", "P", 0.47, 1250.0],
+  ["P", "G", 0.47, 1250.0],
+  ["G", "G", 0.37, 1250.0],
+  ["G", "C", 0.47, 1250.0],
+  ["C", "C", 0.47, 1250.0],
+]
+angle_bonds = [
+  ["P", "G", "G", 120.0, 25.0],
+  ["P", "G", "C", 180.0, 25.0],
+  ["G", "C", "C", 180.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

A randomly mixed input structure/topology file +lipid_self_assembly.HDF5 with a few hundred lipids in a roughy +10 x 10 x 10nm box is available in the +HyMD-tutorial/lipid_self_assembly github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation

+
python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5
+
+
+

we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook lipid_self_assembly.ipynb.

+
+
+

1.8. Peptide in lipid bilayer

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true +

Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer.

+

The configuration file is available in the HyMD-tutorial/peptide github +repository (omitted here for brevity).

+

A pre-equilibrated input structure/topology file peptide.HDF5 with a +few hundred lipids in a roughy 20 x 20 x 20nm box is available in the +HyMD-tutorial/peptide github repository. Running the simulation

+
python3 -m hymd peptide.toml peptide.HDF5
+
+
+

we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook peptide.ipynb.

+
+
+

1.9. SDS

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true +

The last part we introduce is explicit electrostatic interactions through +particle–mesh Ewald. Enabling the electrostatic calculations is done via the +coulombtype keyword. "PIC_Spectral" is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the dielectric_const keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge.

+
+
sds.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 10
+n_steps = 3000
+n_print = 1500
+n_flush =
+time_step = 0.01
+box_size = [8.3, 8.3, 8.3]
+start_temperature = 298
+target_temperature = 298
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.1
+domain_decomposition = 10000
+cancel_com_momentum = true
+max_molecule_size = 5
+thermostat_coupling_groups = [
+  ["S", "C"],
+  ["W", "Na"],
+]
+dielectric_const = 45.0              # dielectric constant for the simulation medium
+coulombtype = "PIC_Spectral"         # particle in cloud, spectral method
+
+[field]
+mesh_size = [64, 64, 64]
+sigma = 0.5
+chi = [
+  ["S", "C",  13.50],
+  ["S", "Na",  0.00],
+  ["S", "W",  -3.60],
+  ["C", "Na", 13.50],
+  ["C", "W",  33.75],
+  ["W", "Na",  0.00],
+]
+
+[bonds]
+bonds = [
+  ["S",   "C",   0.50, 1250.0],
+  ["C",   "C",   0.50, 1250.0],
+]
+angle_bonds = [
+  ["S", "C", "C", 170.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

An input structure/topology file sds.HDF5 with a couple thousand +randomly dispersed SDS chains is available in the HyMD-tutorial/sds github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a /charge dataset. +Running the simulation with

+
python3 -m hymd sds.toml sds.HDF5
+
+
+

we observe the aggregation of the SDS into micellular structures—first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook sds.ipynb.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/doc_pages/filtering.html b/v1.0.1/doc_pages/filtering.html new file mode 100644 index 00000000..78cb44dd --- /dev/null +++ b/v1.0.1/doc_pages/filtering.html @@ -0,0 +1,298 @@ + + + + + + + 2. Filtering — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Filtering

+

The default grid-independent filter function used in HyMD is a Gaussian

+
+\[H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right]\]
+

with reciprocal space representation

+
+\[\hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right].\]
+

The coarse-graining parameter \(\sigma\) determines a length scale of +particle extent and is given as configuration file input by

+
sigma = 0.75
+
+
+
+

2.1. Implementing new filters

+

Implementing new filter functions is straightforward by hijacking +the setup method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/doc_pages/installation.html b/v1.0.1/doc_pages/installation.html new file mode 100644 index 00000000..fa2a385d --- /dev/null +++ b/v1.0.1/doc_pages/installation.html @@ -0,0 +1,394 @@ + + + + + + + 1. Installation — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Installation

+

HyMD may be installed using pip by

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+
+

1.1. Dependencies

+

HyMD requires a working MPI compiler and HDF5. On an Ubuntu system, this +may be installed via

+
sudo apt-get update -y
+sudo apt-get install -y libhdf5-openmpi-dev python3-mpi4py
+CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-cache-dir --no-binary=h5py h5py
+
+
+

It is highly recommended to have MPI-enabled HDF5 and h5py. A +non-MPI-enabled h5py may be installed by simply

+
sudo apt-get update -y
+sudo apt-get install libhdf5-serial-dev
+python3 -m pip --upgrade install h5py
+
+
+

A non-MPI-enabled HDF5 library with corresponding h5py will work +(mostly), but is inconvenient and slow. Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +--disable-mpio argument to HyMD, see Command line arguments. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial.

+
+
+

1.2. Install in docker

+

A docker image with build essentials setup is available at dockerhub with tag +mortele/hymd,

+
docker pull mortele/hymd:1.0
+docker run -it mortele/hynd:1.0
+/app# python3 -m pip install hymd
+/app# python3 -m hymd [CONFIGURATION_FILE] [TOPOLOGY_FILE]
+
+
+
+
+

1.3. Common issues

+
+

1.3.1. Numpy errors while importing the Fortran force kernels

+
RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd
+
+Traceback (most recent call last):
+
+  (...)
+
+File "/..../HyMD/hymd/__init__.py", line 2, in <module>
+  from .main import main  # noqa: F401
+File "/..../HyMD/hymd/main.py", line 10, in <module>
+  from .configure_runtime import configure_runtime
+File "/..../hymd/configure_runtime.py", line 12, in <module>
+  from .input_parser import read_config_toml, parse_config_toml
+File "/..../HyMD/hymd/input_parser.py", line 12, in <module>
+  from .force import Bond, Angle, Dihedral, Chi
+File "/..../HyMD/hymd/force.py", line 8, in <module>
+  from force_kernels import (  # noqa: F401
+ImportError: numpy.core.multiarray failed to import
+
+
+

can normally be fixed by updating numpy versions,

+
python3 -m pip install -U numpy
+
+
+
+
+

1.3.2. Error building pfft-python due to missing curl/wget

+
Building wheel for pfft-python (setup.py) ... error
+ERROR: Command errored out with exit status 1:
+command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_
+cwd: /tmp/pip-install-fr6nt9m4/pfft-python/
+Complete output (56 lines):
+running bdist_wheel
+running build
+running build_py
+
+  (...)
+
+curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found
+wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found
+Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+Please check curl or wget
+You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/
+Traceback (most recent call last):
+  File "<string>", line 1, in <module>
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in <module>
+    setup(
+  File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup
+    return distutils.core.setup(**attrs)
+  File "/usr/lib/python3.8/distutils/core.py", line 148, in setup
+
+  (...)
+
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions
+    build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:]))
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft
+    raise ValueError("could not build fftw; check MPICC?")
+ValueError: could not build fftw; check MPICC?
+----------------------------------------
+ERROR: Failed building wheel for pfft-python
+Running setup.py clean for pfft-python
+Failed to build pfft-python
+
+
+

can be fixed by installing either curl or wget

+
apt-get install -y curl wget
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/doc_pages/interaction_energy_functionals.html b/v1.0.1/doc_pages/interaction_energy_functionals.html new file mode 100644 index 00000000..a53b491b --- /dev/null +++ b/v1.0.1/doc_pages/interaction_energy_functionals.html @@ -0,0 +1,351 @@ + + + + + + + 1. Interaction energy functionals — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Interaction energy functionals

+

A few interaction energy functionals \(W\) are defined in HyMD through +the Hamiltonian class and associated subclasses.

+
+

1.1. \(\chi\)–interaction and \(\kappa\)–incompressibility

+

The most common hPF energy functional is specified by

+
hamiltonian = "DefaultWithChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where \(\tilde\chi_{\text{A}-\text{B}}\) is the interaction energy between +overlapping densities of particle types \(\text{A}\) and \(\text{B}\). +The incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\tilde\chi\) +and \(\kappa\) in the configuration file (see Configuration file)

+
kappa = 0.05
+chi = [
+   ["A", "B", 15.85],
+   ["B", "C", -5.70],
+   ...
+]
+
+
+
+
+

1.2. Only \(\kappa\)–incompressibility

+

The only \(\kappa\) interactions energy functional is specified by

+
hamiltonian = "DefaultNoChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where the incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.3. Only \(\phi^2\)

+

The \(\phi^2\) interactions energy functional is specified by

+
hamiltonian = "SquaredPhi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2,\]
+

where the \(\phi\) squared term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.4. Implementing new interaction energy forms

+

Implementing new interaction energy functions is straightforward by subclassing +Hamiltonian and applying sympy differentiation to the symbolic +field objects. The sympy.lamdify function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/doc_pages/intramolecular_bonds.html b/v1.0.1/doc_pages/intramolecular_bonds.html new file mode 100644 index 00000000..367e242e --- /dev/null +++ b/v1.0.1/doc_pages/intramolecular_bonds.html @@ -0,0 +1,391 @@ + + + + + + + 2. Intramolecular bonds — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Intramolecular bonds

+

Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see Configuration file. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +Benchmarks), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable.

+

All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]).

+
+

2.1. Two-particle bonds

+

Stretching bonds in HyMD are implemented as harmonic spring potentials,

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2,\]
+

where \(r=|\mathbf{r}|\) is the inter-particle distance, \(k\) is a +constant of dimension energy (units \(\text{kJ}\,\text{mol}^{-1}\)), and +\(r_0\) is the equilibrum length of the bond (units: \(\text{nm}\)). The +force is calculated as

+
+\[F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r},\]
+

where \(\mathbf{r}\) is the vector pointing from \(i\) to \(j\).

+

In the configuration file, two-particle bonds are specified per particle type:

+
+
configuration_two_particle_example.toml
+
[bonds]
+bonds = [
+   ["A", "A", 0.47, 1250.0],
+   ["A", "B", 0.37,  940.0],
+   ["B", "C", 0.50, 1010.0],
+   ["C", "A", 0.42,  550.0],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.2. Three-particle bonds

+

Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle–particle–particle angle \(\theta\),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2,\]
+

where \(k\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\)), and \(\theta_0\) is the equilibrum +angle of the bond (units: \({}^\circ\)). Defining the particles with labels +\(a\), \(b\), and \(c\), let \(\mathbf{r}_a\) denote the vector +pointing from \(b\) to \(a\), and correspondingly let +\(\mathbf{r}_c\) point from \(b\) to \(c\). The +\(a\)\(b\)\(c\) may be computed through the law of Cosines,

+
+\[\theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right]\]
+

Then the force acting on \(a\) and \(c\) is

+
+\[ \begin{align}\begin{aligned}\mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a},\\\mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c},\end{aligned}\end{align} \]
+

and

+
+\[\mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c\]
+

In the configuration file, three-particle bonds are specified per particle type:

+
+
configuration_three_particle_example.toml
+
[bonds]
+angle_bonds = [
+   ["A", "A", "A", 180.0, 90.0],
+   ["A", "B", "A", 120.0, 55.0],
+   ["B", "C", "C",  30.0, 10.0],
+   ["C", "A", "B", 110.0, 25.5],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.3. Four-particle bonds

+

Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle \(\phi\) between the +\(a\)\(b\)\(c\) and \(b\)\(c\)\(d\) planes, for +a dihedral bond quartet \(a\), \(b\), \(c\), and \(d\). The +potential takes the form

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n),\]
+

where \(c_n\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)), and \(\phi_n\) are +specified phase angles in the cosine series.

+

In the configuration file, four-particle bonds are specified per particle type:

+
+
configuration_four_particle_example.toml
+
[bonds]
+dihedrals = [
+   ["A", "B", "C", "D"],
+   [
+     [-1],
+     [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+     [0.08, 0.46, 1.65, -0.96, 0.38],
+   ],
+   [1.0],
+]
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/doc_pages/overview.html b/v1.0.1/doc_pages/overview.html new file mode 100644 index 00000000..abe50598 --- /dev/null +++ b/v1.0.1/doc_pages/overview.html @@ -0,0 +1,412 @@ + + + + + + + 2. Usage overview for HylleraasMD — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Usage overview for HylleraasMD

+

HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a toml format configuration file, along with a topology and structure +file specifying the input system in HDF5 format.

+

Configuration file

+

The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a [5, 5, 5] nm simulation box at 300 K may look like +the following:

+
+
config_simple_1.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "SquaredPhi"         # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [30, 30, 30]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+
+
+
+

Note that for the version 1.0 release of HyMD, the [particles], +[simulation], and [field] groups are optional specifiers for +structuring the configuration file.

+

For a full specification of every recognised configuration keyword in HyMD, +please refer to Configuration file.

+

Topology and structure file

+

The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +N particles may look like the following:

+
+
example_structure.HDF5
+
group   /
+   # root group
+
+dataset /coordinates
+   # float32, shape (T, N, D,)
+   # Time steps of N rows of D dimensional coordinate data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /velocities
+   # float32, shape (T, N, D,) OPTIONAL
+   # Time steps of N rows of D dimensional velocity data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /bonds
+   # int32,   shape (N, B,)    OPTIONAL
+   # Each row i contains indices of the particles bonds from/to i
+   # B denotes the maximum bonds per particle
+
+dataset /indices
+   # int32,   shape (N,)
+   # Index of each particle, 0--(N-1)
+
+dataset /molecules
+   # int32,   shape (N,)
+   # Index of molecule each particle belongs to
+   # Used to construct bond network locally on MPI ranks
+
+dataset /names
+   # str10,   shape (N,)
+   # Fixed size string array containing particle type names
+
+dataset /types
+   # int32,   shape (N,)       OPTIONAL
+   # Mapping of particle names to type indices
+
+
+
+

For a full specification of the topology and structure input file, see +Topology and structure file.

+

Command line arguments

+

A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the config_simple_1.toml and example_structure.HDF5 +files may look like the following:

+
mpirun -n ${MPI_NUM_RANKS} python3 -m hymd         \  # HyMD executable
+                           config_simple_1.toml    \  # configuration file
+                           example_structure.HDF5  \  # structure file
+                           --logfile=log_out.txt   \  # set logfile path
+                           --seed 123456           \  # set random seed
+                           --verbose 2             \  # set logging verbosity
+                           --velocity-output          # enable velocity in trajectory output
+
+
+

For a full specification of all command line arguments, see +Command line arguments.

+

More examples

+

For more thorough rundown and concrete usage examples, see +Examples.

+
+

2.1. Running parallel simulations

+

Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the only difference being how the python3 interpreter is +invoked. Prepending mpirun -n ${NPROCS} to the usual +python3 -m hymd runs the simulation with ${NPROCS} MPI ranks.

+

Inputting

+
mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field
+
+
+

sets up an example simulation of the HyMD-tutorial/ideal_gas system. For +more details about this system in particular, or other example simulations, see +the HyMD-tutorial repository.

+
+
+

2.2. Running tests

+

Run serial code tests by

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd
+cd hymd/
+python3 -m pip install pytest pytest-mpi
+python3 -m pytest
+
+
+

There is a small convenience script in hymd/ for running the MPI-enabled +tests,

+
chmod +x pytest-mpi
+./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/doc_pages/theory.html b/v1.0.1/doc_pages/theory.html new file mode 100644 index 00000000..cbda9840 --- /dev/null +++ b/v1.0.1/doc_pages/theory.html @@ -0,0 +1,354 @@ + + + + + + + 1. Theory — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Theory

+

Hybrid particle–field simulations switch out the ordinary particle–particle +Lennard-Jones interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle–field densities are +defined as

+
+\[\phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i),\]
+

where \(\mathbf{r}\) is a spatial coordinate, \(P\) is a window function +used to distribute particle number densities onto a computational grid, and +\(\mathbf{r}_i\) is the position of particle \(i\) (of total \(N\)). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of \(N\) particles in \(M\) molecules is

+
+\[\mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})]\]
+

with \(H_0\) being a standard intramolecular Hamiltonian form (see +Intramolecular bonds) including kinetic terms, while \(W\) is a density +dependent interaction energy functional.

+

In the Hamiltonian hPF-MD formalism [Bore and Cascella, 2020], the density +field is filtered using a grid-independent filtering function \(H\),

+
+\[\tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}).\]
+

The filter smooths the density, ensuring that \(\tilde\phi\) and +\(W[\tilde\phi([\phi])]\) both converge as the grid size is reduced.

+
+

1.1. External potential

+

The external potential acting on a particle is defined as the functional +derivative of \(W\) with respect to \(\phi\). In the filtered formalism, +the potential takes the form

+
+\[\begin{split}V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ +&= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})},\end{split}\]
+

under the assumption of a local form of the interaction energy functional, +\(W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]\). Note +that

+
+\[\frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}).\]
+
+
+

1.2. Force interpolation

+

The forces on particle \(i\) are obtained by differentiation of the external +potential,

+
+\[\mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i).\]
+
+
+

1.3. Reciprocal space calculations

+

The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density \(\phi_{ijk}\) with CIC, we apply the filtering +and obtain the discrete version of the external potential by

+
+\[\tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big]\]
+

and

+
+\[V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+

The forces are obtained by differentiation of \(V\) in Fourier space as

+
+\[\nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+
+
+

1.4. Filter

+

By default, the filter used in HyMD is a simple Gaussian of the form

+
+\[\begin{split}H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ +\hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right].\end{split}\]
+

For more details about the filtering, see Filtering.

+
+
+

1.5. Hamiltonian form

+

The default form of the interaction energy functional in HyMD is

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2.\]
+

See Interaction energy functionals for details.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/doc_pages/topology_input.html b/v1.0.1/doc_pages/topology_input.html new file mode 100644 index 00000000..764ab637 --- /dev/null +++ b/v1.0.1/doc_pages/topology_input.html @@ -0,0 +1,335 @@ + + + + + + + 4. Topology and structure file — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Topology and structure file

+

The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root / group.

+

The HyMD-tutorial has multiple examples of structure files for various levels +of complexity.

+
+

4.1. Required datasets

+
+
/coordinates:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/indices:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/names:
+

array shape [N,]

+

datatype [string (length between 1 and 16)]

+

The shape represents one particle name per N particles. The datatype may be a string of length =<16.

+
+
+
+
+

4.2. Optional datasets

+
+
/velocities:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/types:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle type index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/molecules:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one molecule index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/bonds:
+

array shape [N, B,]

+

datatype [int32 or int64]

+

The shape represents B bond specifications (indices of different particles) per N particles. The data type may be either 32 or 64 bit integers.

+
+
/charge:
+

array shape [N,]

+

datatype [float32 or float64]

+

The shape represents one particle charge per N particles. The data type may be either four or eight byte reals.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/genindex.html b/v1.0.1/genindex.html new file mode 100644 index 00000000..30403373 --- /dev/null +++ b/v1.0.1/genindex.html @@ -0,0 +1,813 @@ + + + + + + Index — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + +
+ +

F

+ + + +
+ +

G

+ + +
+ +

H

+ + + +
    +
  • + hymd.input_parser + +
  • +
  • + hymd.integrator + +
  • +
  • + hymd.thermostat + +
  • +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/index.html b/v1.0.1/index.html new file mode 100644 index 00000000..a30813ce --- /dev/null +++ b/v1.0.1/index.html @@ -0,0 +1,395 @@ + + + + + + + HylleraasMD documentation — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

HylleraasMD documentation

+
+
Release:
+

1.0.1

+
+
Date:
+

Jan 06, 2022

+
+
+

HylleraasMD (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems.

+

HyMD can run canonical hPF-MD simulations [Milano and Kawakatsu, 2009], or filtered +density Hamiltonian hPF (HhPF-MD) simulations [Bore and Cascella, 2020], with +or without explicit PME electrostatic interactions [Kolli et al., 2018]. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +[Bore et al., 2018, Cascella et al., 2008]. Martini +style elastic networks (ElNeDyn) [Periole et al., 2009] are also +supported.

+

HyMD uses the pmesh (github.com/rainwoodman/pmesh) library for particle-mesh +operations, with the PPFT [Pippig, 2013] backend for FFTs through the +pfft-python bindings (github.com/rainwoodman/pfft-python). File IO is done +via HDF5 formats to allow MPI parallel reads.

+
+

User Guide

+

The HylleraasMD User Guide provides comprehensive information on how to run +simulations. Selected Examples are available to guide new users.

+
+
+

Installing HyMD

+

The easiest approach is to install using pip:

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+

For more information and required dependencies, see +Installation.

+
+
+

Source Code

+

Source code is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the GNU Lesser General Public +License v3.0. Obtain the source code with git:

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git
+
+
+
+
+

Development

+

HyMD is developed and maintained by researchers at the Hylleraas Centre for +Quantum Molecular Sciences at the University of Oslo.

+

pic1 pic2

+
+
+

References

+
+
+[BC20] +

Sigbjørn Løland Bore and Michele Cascella. Hamiltonian and alias-free hybrid particle–field molecular dynamics. J. Chem. Phys., 153(9):094106, 2020. doi:10.1063/5.0020733.

+
+
+[BMC18] +

Sigbjørn Løland Bore, Giuseppe Milano, and Michele Cascella. Hybrid particle-field model for conformational dynamics of peptide chains. J. Chem. Theory Comput., 14(2):1120–1130, 2018. doi:10.1021/acs.jctc.7b01160.

+
+
+[BDP07] +

Giovanni Bussi, Davide Donadio, and Michele Parrinello. Canonical sampling through velocity rescaling. J. Chem. Phys., 126(1):014101, 2007. doi:10.1063/1.2408420.

+
+
+[CNCDP08] +

Michele Cascella, Marilisa A. Neri, Paolo Carloni, and Matteo Dal Peraro. Topologically based multipolar reconstruction of electrostatic interactions in multiscale simulations of proteins. J. Chem. Theory Comput., 4(8):1378–1385, 2008. doi:10.1021/ct800122x.

+
+
+[KDNB+18] +

Hima Bindu Kolli, Antonio De Nicola, Sigbjørn Løland Bore, Ken Schäfer, Gregor Diezemann, Jürgen Gauss, Toshihiro Kawakatsu, Zhong-Yuan Lu, You-Liang Zhu, Giuseppe Milano, and Michele Cascella. Hybrid particle-field molecular dynamics simulations of charged amphiphiles in an aqueous environment. J. Chem. Theory Comput., 14(9):4928–4937, 2018. doi:10.26434/chemrxiv.6264644.v1.

+
+
+[LBC20] +

Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Automated determination of hybrid particle-field parameters by machine learning. Mol. Phys., 118(19-20):e1785571, 2020. doi:10.1080/00268976.2020.1785571.

+
+
+[MK09] +

Giuseppe Milano and Toshihiro Kawakatsu. Hybrid particle-field molecular dynamics simulations for dense polymer systems. J. Chem. Phys., 130(21):214106, 2009. doi:10.1063/1.3142103.

+
+
+[PCMC09] +

Xavier Periole, Marco Cavalli, Siewert-Jan Marrink, and Marco A Ceruso. Combining an elastic network with a coarse-grained molecular force field: structure, dynamics, and intermolecular recognition. Journal of chemical theory and computation, 5(9):2531–2543, 2009. doi:10.1021/ct9002114.

+
+
+[Pip13] +

Michael Pippig. Pfft: an extension of fftw to massively parallel architectures. SIAM J. Sci. Comput., 35(3):C213–C236, 2013. doi:10.1137/120885887.

+
+
+[TBM92] +

MBBJM Tuckerman, Bruce J Berne, and Glenn J Martyna. Reversible multiple time scale molecular dynamics. J. Chem. Phys., 97(3):1990–2001, 1992. doi:10.1063/1.463137.

+
+
+
+
+
+

Indices and tables

+ +
+
+
+
+
+
+
+
+
+ + + +
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+ + + + + +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/objects.inv b/v1.0.1/objects.inv new file mode 100644 index 00000000..245fa1b6 Binary files /dev/null and b/v1.0.1/objects.inv differ diff --git a/v1.0.1/py-modindex.html b/v1.0.1/py-modindex.html new file mode 100644 index 00000000..525d1676 --- /dev/null +++ b/v1.0.1/py-modindex.html @@ -0,0 +1,321 @@ + + + + + + Python Module Index — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ h +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ h
+ hymd +
    + hymd.field +
    + hymd.file_io +
    + hymd.force +
    + hymd.input_parser +
    + hymd.integrator +
    + hymd.thermostat +
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.1/search.html b/v1.0.1/search.html new file mode 100644 index 00000000..8eb97049 --- /dev/null +++ b/v1.0.1/search.html @@ -0,0 +1,291 @@ + + + + + + Search — hymd 1.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v1.0.1/searchindex.js b/v1.0.1/searchindex.js new file mode 100644 index 00000000..732d6d49 --- /dev/null +++ b/v1.0.1/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["doc_pages/api","doc_pages/benchmarks","doc_pages/command_line","doc_pages/config_file","doc_pages/constants_and_units","doc_pages/electrostatics","doc_pages/examples","doc_pages/filtering","doc_pages/installation","doc_pages/interaction_energy_functionals","doc_pages/intramolecular_bonds","doc_pages/overview","doc_pages/theory","doc_pages/topology_input","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,"sphinxcontrib.bibtex":9,sphinx:56},filenames:["doc_pages/api.rst","doc_pages/benchmarks.rst","doc_pages/command_line.rst","doc_pages/config_file.rst","doc_pages/constants_and_units.rst","doc_pages/electrostatics.rst","doc_pages/examples.rst","doc_pages/filtering.rst","doc_pages/installation.rst","doc_pages/interaction_energy_functionals.rst","doc_pages/intramolecular_bonds.rst","doc_pages/overview.rst","doc_pages/theory.rst","doc_pages/topology_input.rst","index.rst"],objects:{"hymd.field":{compute_field_and_kinetic_energy:[0,1,1,""],compute_field_energy_q_GPE:[0,1,1,""],compute_field_force:[0,1,1,""],compute_self_energy_q:[0,1,1,""],domain_decomposition:[0,1,1,""],initialize_pm:[0,1,1,""],update_field:[0,1,1,""],update_field_force_q:[0,1,1,""],update_field_force_q_GPE:[0,1,1,""]},"hymd.file_io":{OutDataset:[0,2,1,""],distribute_input:[0,1,1,""],setup_time_dependent_element:[0,1,1,""],store_data:[0,1,1,""],store_static:[0,1,1,""]},"hymd.file_io.OutDataset":{close_file:[0,3,1,""],flush:[0,3,1,""],is_open:[0,3,1,""]},"hymd.force":{Angle:[0,2,1,""],Bond:[0,2,1,""],Chi:[0,2,1,""],Dielectric_type:[0,2,1,""],Dihedral:[0,2,1,""],compute_angle_forces__plain:[0,1,1,""],compute_bond_forces__plain:[0,1,1,""],compute_dihedral_forces__plain:[0,1,1,""],dipole_forces_redistribution:[0,1,1,""],find_all_paths:[0,1,1,""],prepare_bonds:[0,1,1,""],prepare_bonds_old:[0,1,1,""],prepare_index_based_bonds:[0,1,1,""],propensity_potential_coeffs:[0,1,1,""]},"hymd.force.Angle":{atom_3:[0,4,1,""]},"hymd.force.Bond":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],equilibrium:[0,4,1,""],strength:[0,4,1,""]},"hymd.force.Chi":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],interaction_energy:[0,4,1,""]},"hymd.force.Dielectric_type":{atom_1:[0,4,1,""],dielectric_value:[0,4,1,""]},"hymd.force.Dihedral":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],atom_3:[0,4,1,""],atom_4:[0,4,1,""],coeffs:[0,4,1,""],dih_type:[0,4,1,""]},"hymd.hamiltonian":{DefaultNoChi:[0,2,1,""],DefaultWithChi:[0,2,1,""],Hamiltonian:[0,2,1,""],SquaredPhi:[0,2,1,""]},"hymd.hamiltonian.DefaultNoChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.DefaultWithChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.Hamiltonian":{__init__:[0,3,1,""],_setup:[0,3,1,""]},"hymd.hamiltonian.SquaredPhi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.input_parser":{Config:[0,2,1,""],check_NPT_conditions:[0,1,1,""],check_angles:[0,1,1,""],check_bonds:[0,1,1,""],check_box_size:[0,1,1,""],check_cancel_com_momentum:[0,1,1,""],check_charges:[0,1,1,""],check_charges_types_list:[0,1,1,""],check_chi:[0,1,1,""],check_config:[0,1,1,""],check_dielectric:[0,1,1,""],check_dihedrals:[0,1,1,""],check_domain_decomposition:[0,1,1,""],check_hamiltonian:[0,1,1,""],check_integrator:[0,1,1,""],check_m:[0,1,1,""],check_mass:[0,1,1,""],check_max_molecule_size:[0,1,1,""],check_n_b:[0,1,1,""],check_n_flush:[0,1,1,""],check_n_particles:[0,1,1,""],check_n_print:[0,1,1,""],check_name:[0,1,1,""],check_start_and_target_temperature:[0,1,1,""],check_tau:[0,1,1,""],check_thermostat_coupling_groups:[0,1,1,""],parse_config_toml:[0,1,1,""],read_config_toml:[0,1,1,""],sort_dielectric_by_type_id:[0,1,1,""]},"hymd.input_parser.Config":{a:[0,4,1,""],angle_bonds:[0,4,1,""],barostat:[0,4,1,""],barostat_type:[0,4,1,""],bonds:[0,4,1,""],box_size:[0,4,1,""],cancel_com_momentum:[0,4,1,""],chi:[0,4,1,""],conv_crit:[0,4,1,""],convergence_type:[0,4,1,""],coulomb_constant:[0,4,1,""],coulombtype:[0,4,1,""],dielectric_const:[0,4,1,""],dielectric_type:[0,4,1,""],dihedrals:[0,4,1,""],domain_decomposition:[0,4,1,""],dtype:[0,4,1,""],file_name:[0,4,1,""],gas_constant:[0,4,1,""],hamiltonian:[0,4,1,""],initial_energy:[0,4,1,""],integrator:[0,4,1,""],kappa:[0,4,1,""],m:[0,4,1,""],mass:[0,4,1,""],max_molecule_size:[0,4,1,""],mesh_size:[0,4,1,""],n_b:[0,4,1,""],n_flush:[0,4,1,""],n_particles:[0,4,1,""],n_print:[0,4,1,""],n_steps:[0,4,1,""],name:[0,4,1,""],pol_mixing:[0,4,1,""],pressure:[0,4,1,""],respa_inner:[0,4,1,""],rho0:[0,4,1,""],self_energy:[0,4,1,""],sigma:[0,4,1,""],start_temperature:[0,4,1,""],tags:[0,4,1,""],target_pressure:[0,4,1,""],target_temperature:[0,4,1,""],tau:[0,4,1,""],tau_p:[0,4,1,""],thermostat_coupling_groups:[0,4,1,""],thermostat_work:[0,4,1,""],time_step:[0,4,1,""],type_charges:[0,4,1,""]},"hymd.integrator":{integrate_position:[0,1,1,""],integrate_velocity:[0,1,1,""]},"hymd.logger":{Logger:[0,2,1,""],MPIFilterAll:[0,2,1,""],MPIFilterRoot:[0,2,1,""]},"hymd.logger.Logger":{setup:[0,3,1,""]},"hymd.logger.MPIFilterAll":{filter:[0,3,1,""]},"hymd.logger.MPIFilterRoot":{filter:[0,3,1,""]},"hymd.thermostat":{_random_chi_squared:[0,1,1,""],_random_gaussian:[0,1,1,""],csvr_thermostat:[0,1,1,""]},hymd:{field:[0,0,0,"-"],file_io:[0,0,0,"-"],force:[0,0,0,"-"],input_parser:[0,0,0,"-"],integrator:[0,0,0,"-"],thermostat:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0020733":14,"00268976":14,"0083144621":0,"01036426965":4,"014101":[0,14],"02214076":4,"03642696562":4,"03970":6,"08790868":[6,10],"094106":14,"0xd":8,"0xe":8,"100":[4,6,11],"1000":6,"10000":6,"10001":6,"1010":10,"1021":14,"1063":14,"1080":14,"10nm":6,"110":10,"1120":[0,14],"1130":[0,14],"1137":14,"118":14,"120":[3,6,10],"120885887":14,"120ff":0,"123456":11,"1250":[3,6,10],"126":[0,14],"130":14,"1378":14,"138":[0,4],"1385":14,"144":8,"148":8,"1500":6,"153":14,"170":6,"1785571":14,"179":0,"180":[3,6,10],"1974":0,"1981":0,"1990":14,"1992":[3,14],"200":[6,10],"2000":6,"2001":14,"2007":[0,3,14],"2008":[0,14],"2009":14,"201":[0,3],"2013":14,"2018":[0,14],"2020":[5,6,12,14],"2022":14,"20nm":6,"214106":14,"223":0,"224":1,"2408420":14,"2408724":[6,10],"246":0,"251":[6,10],"2531":14,"2543":14,"26434":14,"28103735":0,"298":6,"2_1":0,"2don2d":8,"2nd":0,"300":[6,11],"3000":6,"3142103":14,"3144621":4,"323":6,"449":[6,10],"463137":14,"48626121":[6,10],"4928":14,"4937":14,"533":1,"544":[6,10],"550":10,"59427866":[6,10],"602176634":4,"610":[6,10],"6264644":14,"66053906660":4,"7b01160":14,"85418781281":4,"935458":[0,4],"940":10,"96924":6,"980":3,"9918564":[6,10],"boolean":3,"byte":13,"case":[0,3,6,10],"class":[0,9],"default":[0,3,7,11,12,13],"float":[0,3],"function":[0,3,5,6,7,11,12],"int":[0,5,6,9,12],"long":[5,6],"new":[0,10,13,14],"public":14,"return":[0,8],"short":[6,11],"sigbj\u00e3":14,"static":0,"switch":12,"true":[0,3,6],"while":[0,12],Adding:6,For:[0,11,12,14],The:[0,3,5,6,7,9,10,11,12,13,14],Then:10,There:11,These:0,Used:[0,3,11],Using:[6,9],With:[0,6],__file__:8,__init__:[0,8],_gener:0,_random_chi_squar:0,_random_gaussian:0,_setup:0,about:[3,11,12],abov:[0,6],absent:0,acceler:0,accompani:6,accord:[0,3],accur:14,acid:6,across:[0,3],acs:14,act:[0,10,12],adapt:0,add:[5,6],added:0,adding:6,addison:0,addit:[0,2,5,11],addition:14,additon:0,adher:0,affect:0,affili:[0,2],after:[0,10,12],against:8,aggreg:6,ahren:0,alanin:6,algorithm:[0,3,12],alia:14,all:[0,2,3,4,6,8,10,11,14],all_nam:0,all_rank:0,alloc:0,allow:[11,14],allreduc:0,along:[6,11],alpha3:8,alpha:0,also:[6,8,14],altern:2,alwai:[0,3],amino:6,amphiphil:14,analyt:0,angl:[0,2,3,6,8,10],angle_bond:[0,3,6,10],angular:[0,3,6,10],ani:[0,2,3],anisotrop:0,antonio:14,apart:0,api:8,app:8,appli:[0,3,7,9,12],applic:0,approach:14,approxim:0,apt:8,aqueou:14,architectur:14,arg:0,argument:[0,6,8,11],argv:8,aris:0,around:10,arrai:[0,3,11,13],arriv:6,art:0,aspect:3,assess:0,assign:[0,3,10],associ:[0,9],assum:3,assumpt:12,atom:0,atom_1:0,atom_2:0,atom_3:0,atom_4:0,attach:13,attempt:0,attr:8,attract:3,attribut:0,autom:14,automat:[0,7,9],avail:[6,8,14],averag:[0,9],avogadro:4,back:[0,5],backbon:[0,2,3,14],backcon:0,backend:14,backmap:0,balanc:0,ballist:6,bar:4,barostat:0,barostat_typ:0,base:[0,14],bath:[0,3],bb_index:0,bc20:14,bdist_wheel:8,bdp07:14,bead:0,becaus:0,becom:0,befor:[0,3,6],being:[0,2,3,5,10,11,12],belong:11,below:6,benchmark:10,bend:[0,3,10,14],bern:14,besid:2,best:0,beta:0,better:0,between:[0,3,5,6,9,10,12,13],bia:0,big:12,bin:8,binari:8,bind:14,bindu:14,bio:14,bit:[0,13],blueprint:0,bmc18:14,boltzmann:[0,3,4],bond2_energi:0,bond3_energi:0,bond4_energi:0,bond:[0,2,6,8,11,12,13],bonds_2:0,bonds_2_atom1:0,bonds_2_atom2:0,bonds_2_atom_1:0,bonds_2_atom_2:0,bonds_2_equilibrium:0,bonds_2_strength:0,bonds_3:0,bonds_3_atom_1:0,bonds_3_atom_2:0,bonds_3_atom_3:0,bonds_3_equilibrium:0,bonds_3_strength:0,bonds_4:0,bonds_4_atom_1:0,bonds_4_atom_2:0,bonds_4_atom_3:0,bonds_4_atom_4:0,bonds_4_coeff:0,bonds_4_last:0,bonds_4_typ:0,bool:0,bore:[0,5,12,14],both:[0,12],boundari:[0,3],box:[0,3,6,11],box_siz:[0,3,6,11],breviti:6,broadcast:0,bruce:14,buffer:[0,3],build_extens:8,build_pfft:8,build_pi:8,built:8,bussi:[0,3,14],c213:14,c236:14,c_n:[0,6,10],cach:8,calcul:[0,3,6,10],calibr:0,call:[0,8],callabl:0,can:[6,8,14],cancel_com_momentum:[0,3,6],canon:[0,3,14],capabl:2,captur:11,carloni:14,carri:6,cascella:[5,11,12,14],caval:14,cbt:0,cdot10:4,cdot:[0,4,10],cell:[0,12],center:[0,3],centr:14,certain:[0,2],ceruso:14,chain:[0,14],chang:[0,3],changedin:0,charg:[0,3,4,5,6,13,14],charge_out:0,check:[0,8],check_angl:0,check_bond:0,check_box_s:0,check_cancel_com_momentum:0,check_charg:0,check_charges_types_list:0,check_chi:0,check_config:0,check_dielectr:0,check_dihedr:0,check_domain_decomposit:0,check_hamiltonian:0,check_integr:0,check_m:0,check_mass:0,check_max_molecule_s:0,check_n_b:0,check_n_flush:0,check_n_particl:0,check_n_print:0,check_nam:0,check_npt_condit:0,check_start_and_target_temperatur:0,check_tau:0,check_thermostat_coupling_group:0,chem:[0,14],chemic:14,chemrxiv:14,chi:[0,3,4,6,8],chi_2:0,chi_3:0,chi_:[0,3,6,9,12],chi_m:0,chmod:11,chosen:0,cic:[0,5,12],circ:[3,10],circumv:12,classmethod:0,classvar:0,clean:[0,8],clone:[11,14],close:[0,8],close_fil:0,closest:0,cloud:[0,6,12],cncdp08:14,coars:[0,3,7,14],code:[0,1,2,3,6,8,11],coeff:0,coeffici:0,coil:[0,6],collect:[0,13],com:[0,8,11,14],combin:[0,6,14],comm:0,comm_world:0,command:[8,11],common:9,commuic:0,commun:[0,3,10],communc:0,compar:6,compat:2,compil:[0,8],compiler_so:8,complesfield:0,complet:[0,6,8],complex:[6,13],complexfield:0,compon:0,comprehens:14,compress:[0,3,4,6,9,11],comput:[0,5,10,12,14],compute_angle_forces__plain:0,compute_bond_forces__plain:0,compute_dihedral_forces__plain:0,compute_field_and_kinetic_energi:0,compute_field_energy_q_gp:0,compute_field_forc:0,compute_potenti:0,compute_self_energy_q:0,concret:11,condit:6,config:0,config_simple_1:11,configur:[0,2,5,6,7,9,10,11],configuration_fil:8,configuration_four_particle_exampl:10,configuration_three_particle_exampl:10,configuration_two_particle_exampl:10,configure_runtim:8,conform:[6,13,14],connect:0,conserv:1,consid:6,consist:[0,6],consit:6,consitu:0,constant:[0,3,5,6,10],constitut:[0,2,3],construct:[0,10,11],constructor:0,contain:[0,1,2,3,6,11],content:[0,6],contribut:0,control:3,conv_crit:0,conv_fun:0,conveni:11,converg:[0,12],convergence_typ:0,convert:0,coordin:[11,12,13],copi:0,core:8,correct:[0,3],correspond:[0,3,8],correspondingli:10,cos:[0,6,10],cosin:[0,3,6,10],cost:[3,10],could:8,coulomb:[0,3,4,5],coulomb_const:0,coulombtyp:[0,3,5,6],counter:6,coupl:[0,3,6,11],cprofil:2,cpu:[0,10],crash:3,creat:[0,9],critic:[0,6],cross:0,csvr:[0,3],csvr_thermostat:0,ct800122x:14,ct9002114:14,current:6,cwd:8,cython:[8,14],d_n:0,dal:14,data:[0,6,11,13],dataclass:0,dataset:[0,5,6,11],datatyp:13,date:[0,14],date_format:0,david:14,debug:[0,2],decompos:0,decomposit:[0,3,10],default_level:0,defaultnochi:[0,6,9],defaultnohchi:[0,3],defaultwithchi:[0,3,6,9],defin:[0,6,9,10,12],definit:0,degre:3,delta:[0,12],denot:[0,1,3,9,10,11],dens:14,densiti:[0,3,5,9,12,14],depend:[0,6,10,12,14],deprec:0,deriv:[0,12],design:6,dest_directori:0,detail:[2,3,6,11,12],determin:[0,2,7,14],dev:8,develop:6,deviat:[0,3],dict:0,dictat:0,dictionari:0,dielectr:[0,3,6],dielectric_const:[0,3,5,6],dielectric_typ:0,dielectric_valu:0,dieter:0,diezemann:14,differ:[0,3,6,11,13],differenti:[0,5,7,9,12],difficult:2,dih_typ:0,dihedr:[0,2,3,5,6,8,10,14],dimens:[0,10,11,13],dimension:11,dipol:[0,2,3,5,6,14],dipole_forces_redistribut:0,dir:8,direct:[0,3],directori:11,disabl:[2,6,8,11],disable_mpio:0,discard:0,discret:[0,12],discretis:12,disk:[0,3],dispers:6,dist:8,distanc:[0,3,10],distinct:0,distribut:[0,3,5,6,12],distribute_input:0,distutil:8,doc:0,dockerhub:8,dodecyl:6,doe:[0,10],doi:14,domain:[0,3,10],domain_decomposit:[0,3,6],donadio:[0,14],done:[0,6,14],dopc:6,dot:0,dot_elec:0,doubl:2,double_out:0,download:8,dppc:6,draw:0,drawn:0,driver:11,dtype:0,due:[0,3],dump:0,dump_per_particl:0,dure:[0,2,3,10,11],dynam:[0,3,11,12,14],e1785571:14,e_k:0,each:[0,3,6,10,11],easiest:14,effect:[0,3],effici:10,eight:13,either:[0,3,8,13],elast:14,elec:0,elec_field:0,elec_field_contrib:0,elec_field_fouri:0,elec_forc:0,elecrostat:0,electr:[0,4,5],electrosat:0,electrostat:[0,6,14],elnedyn:14,elucid:6,embed:6,emit:0,emploi:0,empti:0,enabl:[2,6,8,11],enclos:0,end:0,energi:[0,1,3,4,6,7,10,11,12],energiesself:0,ensur:[0,3,6,12],entri:3,environ:14,epsilon:0,equal:[0,3,6],equat:0,equilibr:6,equilibrium:[0,3,6],equilibrum:10,equival:[0,3],error:0,essenti:[0,1,8],etc:[2,3],even:[0,3,6,8],event:0,everi:[0,3,6,10,11],evid:0,ewald:[0,5,6],examin:6,exampl:[3,11,13,14],example_structur:11,except:10,exchang:[0,3],exec:8,execut:[0,11],exist:0,exit:8,exp:[7,12],expand:0,expans:0,expect:0,expens:[3,12],explicit:[0,6,10,14],express:0,ext:0,extend:6,extens:14,extent:[0,7],extern:0,extract:0,f401:8,f_angl:0,f_bond:0,f_dihedr:0,f_dipol:0,f_on_bead:0,factor:0,factori:0,fail:[0,8],fals:[0,3,6],fashion:[0,3],fast:12,fer:14,few:[6,9,10,11],fft:[0,1,2,3,5,6,11,12,14],fftw3:8,fftw:[8,14],field:[2,4,5,6,9,11,12,14],field_energi:0,field_list:0,field_q_energi:0,field_q_self_energi:0,file:[2,5,6,7,8,9,10,11,14],file_io:0,file_nam:0,file_path:0,filter:[0,3,5,6,11,14],find:0,find_all_path:0,first:[0,3,6,11],five:0,fix:[0,8,11],flag:[0,13],flat:11,float32:[11,13],float64:13,flori:0,fluctuat:0,flush:[0,3],follow:[0,2,3,4,6,11],forc:[2,3,4,5,6,10,14],force_kernel:8,force_mesh:0,force_mesh_elec:0,force_mesh_elec_fouri:0,force_out:0,forego:2,form:[0,5,10],formal:[5,12],format:[0,2,3,5,11,13,14],formatt:0,fortran:[0,10],forward:0,found:[5,8],four:[0,2,3,6,13],fourier:[0,5,12],fr6nt9m4:8,frac:[0,5,6,7,9,10,12],frame:[0,11,13],free:14,frequenc:[0,3],from:[0,2,3,5,6,8,9,10,11,14],full:[0,9,11],fulli:[0,6],fundament:11,gamma:0,gamma_0:0,gas:[0,4],gas_const:0,gather:0,gauss:14,gaussian:[0,3,7,12],gener:[0,2,3,6,14],get:8,getattr:8,ghost:0,giovanni:14,git:[11,14],github:[6,8,11,14],giusepp:14,given:[0,3,6,7],glenn:14,global:0,gnu:14,govern:9,gpe:0,gradient:0,grain:[0,3,7,14],graph:0,gregor:14,grid:[0,1,3,5,6,7,11,12],group:[0,3,6,11,13,14],guess:0,gyrat:6,h5md:[0,3],h5py:[0,2,8],h_0:[6,12],half:0,hamiltonian:[3,5,6,7,9,11,14],handl:0,handler:0,happen:10,harmon:[0,3,6,10],has:[0,3,13],hat:[7,12],have:[0,6,8],hdf5:[0,2,3,5,6,8,11,13,14],hdf5_mpi:8,head:6,heat:[0,3],helic:[0,3,5,6],help:6,helper:0,here:[0,6],hhpf:14,highli:[8,10,11],hijack:7,hima:14,hire:1,homogen:0,homopolym:1,homopolypeptid:6,how:[3,11,14],howev:6,hpf:[3,5,9,11,12,14],html:0,http:[0,8,11,14],huggin:0,hundr:[6,10],hybrid:[11,12,14],hylleraa:14,hymd:[0,2,3,4,5,6,7,8,9,10,11,12,13],hynd:8,ideal:10,ideal_chain:6,ideal_ga:[6,11],ident:0,ignor:0,ijk:[5,12],imag:8,impact:0,implement:[0,10],importerror:8,impuls:[0,3],in_fil:0,includ:[0,2,3,6,12,14],incompress:[0,3],inconveni:8,increas:[0,2,6],indentifi:0,independ:[0,3,7,12],index:[0,11,13,14],indic:[0,2,3,10,11,13],indirect:0,individu:[0,3,6],induc:5,infer:10,info:0,inform:[0,10,14],ingredi:6,initi:0,initial_energi:0,initialis:11,initialize_pm:0,inner:[0,3],input:[2,3,4,5,6,7,11,13],input_box:0,input_pars:[0,8],insid:[0,3,6],instal:[2,11],install_pfft:8,instantan:0,int32:[11,13],int64:13,integ:[0,3,6,13],integr:[3,6,11],integrate_posit:0,integrate_veloc:0,intend:8,inter:[0,10],interact:[0,2,3,4,6,7,11,12,14],interaction_energi:0,interfac:0,intergr:0,intermediari:0,intermolecular:[6,14],intern:[0,2,4,10],interpol:[0,5],interpret:11,interv:[0,3],intmathrm:0,intracomm:0,intramolecular:[0,3,6,12,14],intrins:5,introduc:6,investig:0,invok:[2,11],involv:[0,3,10],ion:6,ipynb:6,is_open:0,iter:0,j_k:0,jan:14,jctc:14,join:8,jone:12,journal:14,jupyt:6,k_e:0,kappa:[0,3,4,6,11,12],kawakatsu:14,kdnb:14,keep:[0,3],kelvin:[0,3,6,11],ken:14,kernel:[0,10],keyword:[0,5,6,11],kinet:[0,12],kinetic_energi:0,knuth:0,kolli:14,kpa:4,label:[1,10],lambda:0,lamdifi:9,land:14,laplacian:0,larg:11,larger:3,last:[6,8,11,13],last_bb:0,later:[0,6],law:10,layout:0,layout_q:0,lbc20:14,learn:14,leav:0,ledum:[6,14],left:[0,5,6,7,9,10,12],legend:1,lenght:0,length:[0,3,4,6,7,10,11,13],lennard:12,less:[0,6],lesser:14,let:[0,10],level:[0,2,3,13],liang:14,lib:8,libhdf5:8,librari:[0,2,8,14],licens:14,lieu:0,like:[0,6,11],limit:3,line:[0,8,11],linear:[0,3],lipid_self_assembl:6,list:0,list_coulomb:0,load:0,local:[0,10,11,12],log:[0,2,11],log_fil:0,log_out:11,logfil:[2,11],logger:2,logic:0,logrecord:0,look:[6,11],loop:0,lost:3,low:6,m_j:0,machin:[2,14],made:0,mai:[0,2,3,6,8,10,11,13],main:[0,8,11],maintain:14,make:6,manner:6,manual:8,map:[0,11],marco:14,marilisa:14,marrink:14,martini:[6,14],martyna:14,mass:[0,3,4,13],massiv:14,match:0,math:0,mathbf:[0,4,5,6,9,10,12],mathcal:[6,12],mathmr:0,mathrm:[0,5,6,9,10,12],matteo:14,matter:[6,10,14],max_molecule_s:[0,3,6],maximum:[0,3,10,11],maxwel:[0,3],may:2,mbbjm:14,mean:[0,2,3],measur:10,medium:[0,3,6],melt:1,membran:6,memori:0,mesh:[0,1,3,5,6,14],mesh_siz:[0,3,6,11],messag:0,messi:0,meta:6,metadata:0,method:[0,1,6,7],mh_0:12,micellular:6,michael:14,michel:14,might:0,milano:14,mimic:0,minim:6,minuscul:10,mirror:2,mix:[0,6],mk09:14,model:[6,14],modifi:0,modul:[0,3,8,14],mol:[3,4,6,10,11,14],molecul:[0,3,11,12,13],molecular:[2,11,12,14],momenta:[0,11],momentum:[0,3,4],monoatom:6,more:[2,3,6,11,12,14],mortel:8,morten:14,most:[8,9,11,12],mostli:[2,8],motion:[0,6],move:0,mpi4pi:[0,8,14],mpi:[0,2,3,8,10,11,14],mpi_num_rank:11,mpicc:8,mpifilteral:0,mpifilterroot:0,mpio:[2,8],mpirun:11,multiarrai:8,multipl:[0,3,6,11,13,14],multipolar:14,multiscal:14,must:[0,3],n_b:0,n_flush:[0,3,6],n_frame:0,n_particl:[0,3],n_print:[0,3,6,11],n_step:[0,3,6,11],n_type:0,nabla:[0,12],name:[0,2,3,6,10,11,13],nanomet:[0,1],nanosecond:6,ndarrai:0,ne5et1y_:8,necessari:[0,6],necessit:[8,9],need:[0,6],neg:[0,6],neighbour:0,neri:14,network:[0,10,11,13,14],networkx:0,neutralis:6,never:[0,3],nevertheless:3,next:[0,6],nicola:14,non:[0,2,6,8],none:[0,3],nongnu:0,noqa:8,normal:[0,2,3,8,12],notabl:11,note:[0,6,8,11,12],notebook:6,now:6,nproc:11,npt:0,nq_i:5,number:[0,1,2,3,6,11,12,13],numer:0,numpi:[0,2,9,14],nvt:0,object:[0,9],oblat:6,observ:[0,6],obtain:[0,5,12,14],off:6,omit:6,onc:[3,10],one:[0,2,3,6,13],onli:[0,6,10,11],onto:[0,3,5,12],open:[0,8],openmpi:8,oper:[0,3,12,14],oppos:0,optim:[0,10],optimis:[6,10],option:[0,3,6,11],order:[0,3,6,10,11],ordinari:[5,12],org:0,organis:6,origin:0,oslo:14,other:[0,11],otherwis:0,out:[8,12],outdataset:0,outer:0,output:[2,3,4,6,8,11],outsid:3,over:0,overlap:[0,9],packag:[8,11,14],page:14,paint:0,paolo:14,paper:0,parallel:[0,2,3,8,14],paramet:[0,3,6,7,9,14],parent_group:0,parllel:0,parrinello:[0,14],pars:[0,3],parse_config_toml:[0,8],part:[5,6,12],partial:0,particl:[0,2,5,6,7,9,11,12,13,14],particlemesh:0,particular:11,path:[0,2,11],pcmc09:14,pdf:1,pencil:0,peptid:[0,2,3,5,14],per:[0,2,3,10,11,13],peraro:14,perfect:0,perform:[0,3,10,11,12],periol:14,perman:[10,14],permitt:[0,4],pfft:[0,14],pfft_build_dir:8,phase:[0,10],phase_separ:6,phi:[0,3,6,10,12],phi_0:[6,9,12],phi_:[0,6,9,12],phi_ep:0,phi_eps_fouri:0,phi_eta:0,phi_eta_fouri:0,phi_fouri:0,phi_k:0,phi_l:0,phi_laplacian:0,phi_n:[6,10],phi_pol:0,phi_pol_prev:0,phi_q:0,phi_q_fouri:0,phi_transf:0,phospholipid:6,phy:[0,14],pic_spectr:[0,3,6],pic_spectral_gp:0,piec:6,pip13:14,pip:[8,11,14],pippig:14,place:[0,3],plain:2,plane:[0,6,10],pleas:[8,11],plume:0,plumed_bia:0,plumed_out:0,pme:14,pmesh:[0,14],png:1,point:[0,1,10,13],poisson:0,pol_mix:0,polar:0,polym:[6,14],posit:[0,2,3,5,6,11,12],possibl:[0,3,6,14],potenti:[0,3,4,5,7,10,14],ppft:14,practic:10,pre:[0,6],precis:[1,2],prefer:3,prepar:0,prepare_bond:0,prepare_bonds_old:0,prepare_index_based_bond:0,prepend:[0,11],present:[0,2,3,6],preserv:3,pressur:[0,4],previou:0,previous:6,prior:[0,3],priovid:0,prng:0,prod_:0,profil:2,program:[0,11],project:5,promot:0,prop:0,propag:[0,3],propens:[0,3,5,6],propensity_potential_coeff:0,properti:3,protein:[0,14],provid:[0,2,3,11,13,14],psi:[0,4,5],psi_:5,psi_fouri:0,pull:8,put:6,pytest:11,python3:[6,8,11,14],python:[0,11,14],q_i:[0,5],q_j:0,quadrat:0,quanit:0,quantiti:[0,4],quantum:14,quartet:10,quess:0,r_0:[0,6,10],r_a:10,r_c:10,rad:[3,10],radial:6,radii:6,radiu:6,rainwoodman:[8,14],rais:[6,8],random:[0,2,11],random_chi_squar:0,random_gaussian:0,randomli:[0,3,6],rang:5,rank0:0,rank:[0,2,3,10,11],rank_rang:0,rankself:0,rare:10,read:[0,8,11,14],read_config_toml:[0,8],readout:0,real:13,realfield:0,realist:6,reappli:0,rearrang:0,receiv:[0,3],recent:8,reciproc:[0,7],recognis:11,recognit:14,recommend:8,reconstruct:[0,2,5,6,10,14],record:0,recreat:14,recurs:0,redistribut:0,reduc:[3,12],refer:[3,11],regim:6,regul:[0,3],rel:[0,3,6,10],relax:[0,3],releas:[0,6,8,11,14],remain:[0,6],remov:[0,3],remove_center_of_mass_momentum:0,remove_com_momentum:[0,3],replac:[0,8],repositori:[6,11],repres:[0,3,13],represent:7,repuls:3,requir:[0,3,8,10,11,14],rescal:[0,3,14],research:14,respa:[0,3,6],respa_inn:[0,3,6],respect:[0,1,12],restructur:0,result:[0,3,6,9],revers:[0,3,14],rgen:14,rho0:0,rho:[0,5],rho_0:0,rho_:5,right:[0,5,6,7,9,10,12],rightarrow:10,root:[0,11,13],roughi:6,row:11,rrespa:[0,3,6],ruin:0,run:[0,2,3,6,8,10,14],rundown:11,runtimeerror:8,same:[0,3,6],sampl:[0,3,14],scalar:0,scale:[0,3,6,7,10,11,14],sch:14,scheme:[0,6],sci:14,scienc:14,script:11,sds:6,search:14,second:[0,11],see:[0,2,3,5,6,8,9,10,11,12,14],seed:[2,11],select:[11,14],self:[0,3,8],self_energi:0,seminumer:0,send:[0,3],separ:0,seri:[0,3,6,10],serial:[8,11],serialis:3,set:[0,3,11],setup:[0,6,7,8,13],setup_time_dependent_el:0,setuptool:8,sever:0,shape:[0,6,11,13],sheet:0,shift:0,should:[0,2,10],shown:6,siam:14,siewert:14,sigbj:14,sigma:[0,3,6,7,11,12],sim:0,similar:0,simpl:[0,6,11,12],simplest:6,simpli:[0,8],simul:[0,2,6,8,10,12,13,14],simultan:0,sinc:0,singl:[0,3,6],size:[0,3,6,11,12],slight:0,slow:8,slowli:12,small:[3,11],smear:5,smooth:[0,12],sodium:6,soft:[6,14],solv:0,solvent:6,some:[0,3],sort:0,sort_dielectric_by_type_id:0,sourc:[0,1],space:[0,3,5,7],span:0,spatial:[0,3,11,12],specfi:0,speci:0,special:0,specif:[0,2,3,6,9,10,11,13],specifi:[0,2,3,6,9,10,11,13],spectacularli:0,spectral:6,speed:[0,3],spheric:6,spheroid:6,split:0,spontan:6,spring:[0,10],sqrt:[0,7,12],squar:[0,9],squaredphi:[0,3,9,11],stabil:6,stabl:6,stackoverflow:0,standard:[0,3,12,14],start:[0,3,6,10,13],start_temperatur:[0,3,6],state:0,statu:8,stdout:[0,2],step:[0,3,6,10,11],stiff:3,stochast:0,store:0,store_data:0,store_stat:0,str10:11,str:0,straightforward:[7,9],stream:0,strength:[0,3,6,11],stretch:[0,3,10,14],string:[0,3,8,11,13],structur:[0,2,3,5,6,11,14],style:14,sub:6,subclass:[0,9],subsequ:[0,5,6,10],sudo:8,suitabl:0,sulfat:6,sum:0,sum_:[0,5,9,12],sum_i:0,sum_j:0,sum_k:0,sum_n:[0,6,10],summari:11,superclass:[0,7],support:[0,6,14],swap:10,symbol:[0,4,9],sympi:[0,9],sys:8,system:[0,1,2,3,6,8,9,11,12,14],tag:[0,3,8],take:[0,3,5,9,10,11,12],taken:0,tar:8,target:0,target_pressur:0,target_temperatur:[0,3,6,11],tau:[0,3,6,11],tau_p:0,tbm92:14,temperatur:[0,3,4,6,11],ten:6,term:[0,3,6,9,12],test:[0,1],text:[0,2,3,4,5,6,9,10,12],than:[0,3],theori:[0,14],thermalis:[0,3],thermostat:[2,3,6,11],thermostat_coupling_group:[0,3,6],thermostat_work:0,theta:[6,10],theta_0:[0,6,10],thi:[0,2,3,6,8,9,10,11,12],thorough:11,though:6,thousand:[6,10],three:[0,2,3,6],through:[0,3,6,7,9,10,14],tild:[0,3,4,5,6,9,12],time:[0,3,4,6,10,11,14],time_step:[0,3,6,11],tmp:8,todo:0,togeth:[0,3,6],token:8,toml:[0,2,3,6,10,11],toml_cont:0,tomli:0,too:3,toplog:0,topol:0,topolog:[0,2,3,5,6,11,14],topology_fil:8,torsion:[0,3,10,14],toshihiro:14,total:[0,3,6,11,12],traceback:8,trajectori:[0,2,3,6,11],trans_matric:0,transfer:[0,10],transform:[0,9,12],travers:0,tri:3,truncat:0,tuckerman:[3,14],turn:6,tutori:[6,11,13],two:[0,2,3,6],txt:11,type:[0,2,3,5,6,9,10,11,13],type_arrai:0,type_charg:0,type_to_name_map:0,ubuntu:8,uio:[11,14],unchang:0,under:[6,12,14],union:0,uniqu:0,unique_nam:0,unit:[0,3,10],univers:14,unknown:0,unless:[0,3],unset:0,unstabl:3,until:6,updat:[0,8],update_field:0,update_field_force_q:0,update_field_force_q_gp:0,upgrad:[8,14],usag:[0,2],use:[0,3,5,6,8],used:[0,1,2,3,6,7,9,11,12,13],uses:[0,4,12,14],using:[0,2,3,8,12,14],usr:8,usual:11,v_2:[0,6,10],v_3:[0,6,10],v_4:[0,6,10],v_ext:0,v_ext_fouri:0,vacuum:4,valid:[0,3],validated_config:0,valu:[0,3,4,5,6,10],valueerror:8,vanish:0,varepsilon:0,varepsilon_0:[4,5],vari:12,variabl:0,variant:6,variou:[0,13],vbar_elec:0,vbar_elec_fouri:0,vector:10,vectoris:9,veloc:[0,2,3,4,6,11,13,14],velocity_out:0,velocti:0,verbos:[0,2,11],veri:[6,10],verifi:0,verlet:[0,3,6,11],versa:3,version:[0,6,8,11,12],vert:0,vertex:[0,5],vertic:0,via:[6,8,14],vice:3,vol:0,volum:0,voxel:0,wai:[8,12],warn:0,weakli:3,weight:0,well:6,were:0,weslei:0,wheel:8,when:[0,3,10],where:[0,5,9,10,12],which:[0,2,3,5,6,9,10,11],width:[0,3],window:[0,5,12],without:[0,8,14],work:[0,8],workload:0,would:[0,3],wrap:0,wrapper:0,write:[0,3],written:[0,3],www:0,xavier:14,yield:6,you:[8,10,14],yuan:14,zero:[0,3],zhong:14,zhu:14},titles:["4. API reference","3. Benchmarks","5. Command line arguments","3. Configuration file","6. Constants and Units","3. Electrostatic interactions","1. Examples","2. Filtering","1. Installation","1. Interaction energy functionals","2. Intramolecular bonds","2. Usage overview for HylleraasMD","1. Theory","4. Topology and structure file","HylleraasMD documentation"],titleterms:{"function":9,"import":8,"new":[7,9],"while":8,SDS:6,api:0,argument:2,assembl:6,benchmark:1,bilay:6,bond:[1,3,10],build:8,calcul:12,chain:6,chi:9,code:14,command:2,common:8,configur:3,constant:4,copolym:6,curl:8,dataset:13,depend:8,develop:14,diblock:6,docker:8,document:14,due:8,electrostat:[3,5],energi:9,error:8,exampl:6,extern:12,field:[0,1,3],file:[0,3,13],filter:[7,12],forc:[0,1,8,12],form:[9,12],fortran:8,four:10,gas:6,guid:14,hamiltonian:[0,12],helix:6,hylleraasmd:[11,14],hymd:14,ideal:6,implement:[7,9],incompress:9,indic:14,input:0,instal:[8,14],integr:0,interact:[5,9],interpol:12,intramolecular:10,issu:8,kappa:9,kernel:8,keyword:3,line:2,lipid:6,logger:0,metadata:3,miss:8,numpi:8,onli:9,option:[2,13],output:0,overview:11,parallel:11,parser:0,particl:[1,3,10],peptid:6,pfft:8,phase:6,phi:9,potenti:12,python:8,reciproc:12,refer:[0,14],requir:[2,13],rod:6,run:11,self:6,separ:6,simul:[3,11],sourc:14,space:12,specifi:5,stiff:6,structur:13,tabl:14,test:11,theori:12,thermostat:0,three:10,topolog:13,two:10,unit:4,usag:11,user:14,wget:8}}) \ No newline at end of file diff --git a/v1.0.2/.buildinfo b/v1.0.2/.buildinfo new file mode 100644 index 00000000..e48becbd --- /dev/null +++ b/v1.0.2/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: e15676827dd2d4150015cbfb76f645b6 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v1.0.2/.doctrees/doc_pages/api.doctree b/v1.0.2/.doctrees/doc_pages/api.doctree new file mode 100644 index 00000000..063bae06 Binary files /dev/null and b/v1.0.2/.doctrees/doc_pages/api.doctree differ diff --git a/v1.0.2/.doctrees/doc_pages/benchmarks.doctree b/v1.0.2/.doctrees/doc_pages/benchmarks.doctree new file mode 100644 index 00000000..ade49e80 Binary files /dev/null and b/v1.0.2/.doctrees/doc_pages/benchmarks.doctree differ diff --git a/v1.0.2/.doctrees/doc_pages/command_line.doctree b/v1.0.2/.doctrees/doc_pages/command_line.doctree new file mode 100644 index 00000000..bebb113b Binary files /dev/null and b/v1.0.2/.doctrees/doc_pages/command_line.doctree differ diff --git a/v1.0.2/.doctrees/doc_pages/config_file.doctree b/v1.0.2/.doctrees/doc_pages/config_file.doctree new file mode 100644 index 00000000..f2c2987d Binary files /dev/null and b/v1.0.2/.doctrees/doc_pages/config_file.doctree differ diff --git a/v1.0.2/.doctrees/doc_pages/constants_and_units.doctree b/v1.0.2/.doctrees/doc_pages/constants_and_units.doctree new file mode 100644 index 00000000..7d0504fb Binary files /dev/null and b/v1.0.2/.doctrees/doc_pages/constants_and_units.doctree differ diff --git a/v1.0.2/.doctrees/doc_pages/electrostatics.doctree b/v1.0.2/.doctrees/doc_pages/electrostatics.doctree new file mode 100644 index 00000000..d6c8887f Binary files /dev/null and b/v1.0.2/.doctrees/doc_pages/electrostatics.doctree differ diff --git a/v1.0.2/.doctrees/doc_pages/examples.doctree b/v1.0.2/.doctrees/doc_pages/examples.doctree new file mode 100644 index 00000000..78dc4ceb Binary files /dev/null and b/v1.0.2/.doctrees/doc_pages/examples.doctree differ diff --git a/v1.0.2/.doctrees/doc_pages/filtering.doctree b/v1.0.2/.doctrees/doc_pages/filtering.doctree new file mode 100644 index 00000000..86578108 Binary files /dev/null and b/v1.0.2/.doctrees/doc_pages/filtering.doctree differ diff --git a/v1.0.2/.doctrees/doc_pages/installation.doctree b/v1.0.2/.doctrees/doc_pages/installation.doctree new file mode 100644 index 00000000..c180b7db Binary files /dev/null and b/v1.0.2/.doctrees/doc_pages/installation.doctree differ diff --git a/v1.0.2/.doctrees/doc_pages/interaction_energy_functionals.doctree b/v1.0.2/.doctrees/doc_pages/interaction_energy_functionals.doctree new file mode 100644 index 00000000..c13aeba1 Binary files /dev/null and b/v1.0.2/.doctrees/doc_pages/interaction_energy_functionals.doctree differ diff --git a/v1.0.2/.doctrees/doc_pages/intramolecular_bonds.doctree b/v1.0.2/.doctrees/doc_pages/intramolecular_bonds.doctree new file mode 100644 index 00000000..6f40fccd Binary files /dev/null and b/v1.0.2/.doctrees/doc_pages/intramolecular_bonds.doctree differ diff --git a/v1.0.2/.doctrees/doc_pages/overview.doctree b/v1.0.2/.doctrees/doc_pages/overview.doctree new file mode 100644 index 00000000..98d4ae59 Binary files /dev/null and b/v1.0.2/.doctrees/doc_pages/overview.doctree differ diff --git a/v1.0.2/.doctrees/doc_pages/theory.doctree b/v1.0.2/.doctrees/doc_pages/theory.doctree new file mode 100644 index 00000000..38228eb3 Binary files /dev/null and b/v1.0.2/.doctrees/doc_pages/theory.doctree differ diff --git a/v1.0.2/.doctrees/doc_pages/topology_input.doctree b/v1.0.2/.doctrees/doc_pages/topology_input.doctree new file mode 100644 index 00000000..b36bd5bc Binary files /dev/null and b/v1.0.2/.doctrees/doc_pages/topology_input.doctree differ diff --git a/v1.0.2/.doctrees/environment.pickle b/v1.0.2/.doctrees/environment.pickle new file mode 100644 index 00000000..cf40c095 Binary files /dev/null and b/v1.0.2/.doctrees/environment.pickle differ diff --git a/v1.0.2/.doctrees/index.doctree b/v1.0.2/.doctrees/index.doctree new file mode 100644 index 00000000..409c7a60 Binary files /dev/null and b/v1.0.2/.doctrees/index.doctree differ diff --git a/v1.0.2/_downloads/1bddbe381d5c5eda06589d9bd69fa607/benchmarks-1.hires.png b/v1.0.2/_downloads/1bddbe381d5c5eda06589d9bd69fa607/benchmarks-1.hires.png new file mode 100644 index 00000000..173b39f3 Binary files /dev/null and b/v1.0.2/_downloads/1bddbe381d5c5eda06589d9bd69fa607/benchmarks-1.hires.png differ diff --git a/v1.0.2/_downloads/445ad85fd2d4ae93ce00f8584f733c1d/benchmarks-1.py b/v1.0.2/_downloads/445ad85fd2d4ae93ce00f8584f733c1d/benchmarks-1.py new file mode 100644 index 00000000..deb4348f --- /dev/null +++ b/v1.0.2/_downloads/445ad85fd2d4ae93ce00f8584f733c1d/benchmarks-1.py @@ -0,0 +1,38 @@ +import numpy as np +import matplotlib.pyplot as plt +nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) +time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 +], dtype=np.float64) +nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 +], dtype=np.float64,) +time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, +], dtype=np.float64) +nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 +], dtype=np.float64) +time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, +], dtype=np.float64) +plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" +) +plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" +) +plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" +) +plt.xlabel("CPUs", fontsize=15) +plt.ylabel("Time per step, us", fontsize=15) +plt.legend(fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.show() \ No newline at end of file diff --git a/v1.0.2/_downloads/62e8527b8fbdd3768789d5db2a2e7997/benchmarks-2.pdf b/v1.0.2/_downloads/62e8527b8fbdd3768789d5db2a2e7997/benchmarks-2.pdf new file mode 100644 index 00000000..19740b99 Binary files /dev/null and b/v1.0.2/_downloads/62e8527b8fbdd3768789d5db2a2e7997/benchmarks-2.pdf differ diff --git a/v1.0.2/_downloads/6505756b3b2ff9157caf64c34a7dce6a/benchmarks-2.py b/v1.0.2/_downloads/6505756b3b2ff9157caf64c34a7dce6a/benchmarks-2.py new file mode 100644 index 00000000..60b3af65 --- /dev/null +++ b/v1.0.2/_downloads/6505756b3b2ff9157caf64c34a7dce6a/benchmarks-2.py @@ -0,0 +1,33 @@ +import numpy as np +import matplotlib.pyplot as plt + +mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] +mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + +mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + +mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + +mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] +mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + +mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + +mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + +plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048²") +plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024²") +plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512²") +plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256²") +plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128²") +plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64²") +plt.xlabel("CPUs", fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.ylabel("Time per step, s", fontsize=15) +plt.legend(loc="upper left", fontsize=15) +plt.show() \ No newline at end of file diff --git a/v1.0.2/_downloads/687baa2953f4275a9a345a1591671e55/benchmarks-1.pdf b/v1.0.2/_downloads/687baa2953f4275a9a345a1591671e55/benchmarks-1.pdf new file mode 100644 index 00000000..ce69cffa Binary files /dev/null and b/v1.0.2/_downloads/687baa2953f4275a9a345a1591671e55/benchmarks-1.pdf differ diff --git a/v1.0.2/_downloads/7101371937888f0d89fd46071ebebcdc/benchmarks-2.hires.png b/v1.0.2/_downloads/7101371937888f0d89fd46071ebebcdc/benchmarks-2.hires.png new file mode 100644 index 00000000..d8487c6d Binary files /dev/null and b/v1.0.2/_downloads/7101371937888f0d89fd46071ebebcdc/benchmarks-2.hires.png differ diff --git a/v1.0.2/_downloads/b6919aa356df0cb66f43ba86d928e927/benchmarks-2.png b/v1.0.2/_downloads/b6919aa356df0cb66f43ba86d928e927/benchmarks-2.png new file mode 100644 index 00000000..d3c84f99 Binary files /dev/null and b/v1.0.2/_downloads/b6919aa356df0cb66f43ba86d928e927/benchmarks-2.png differ diff --git a/v1.0.2/_downloads/bfa4f72d1c148913a5da22fbc697d1f3/benchmarks-1.png b/v1.0.2/_downloads/bfa4f72d1c148913a5da22fbc697d1f3/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.2/_downloads/bfa4f72d1c148913a5da22fbc697d1f3/benchmarks-1.png differ diff --git a/v1.0.2/_images/benchmarks-1.png b/v1.0.2/_images/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.2/_images/benchmarks-1.png differ diff --git a/v1.0.2/_images/benchmarks-2.png b/v1.0.2/_images/benchmarks-2.png new file mode 100644 index 00000000..d3c84f99 Binary files /dev/null and b/v1.0.2/_images/benchmarks-2.png differ diff --git a/v1.0.2/_images/hylleraas_centre_logo_black.png b/v1.0.2/_images/hylleraas_centre_logo_black.png new file mode 100644 index 00000000..40826396 Binary files /dev/null and b/v1.0.2/_images/hylleraas_centre_logo_black.png differ diff --git a/v1.0.2/_images/uio_full_logo_eng_pos.png b/v1.0.2/_images/uio_full_logo_eng_pos.png new file mode 100644 index 00000000..6c603139 Binary files /dev/null and b/v1.0.2/_images/uio_full_logo_eng_pos.png differ diff --git a/v1.0.2/_modules/hymd/field.html b/v1.0.2/_modules/hymd/field.html new file mode 100644 index 00000000..f98cf960 --- /dev/null +++ b/v1.0.2/_modules/hymd/field.html @@ -0,0 +1,1450 @@ + + + + + + hymd.field — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.field

+"""Forces and energies from the discretized particle-field grid interactions
+"""
+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import warnings
+
+
+
[docs]def initialize_pm(pmesh, config, comm=MPI.COMM_WORLD): + """ + Creates the necessary pmesh objects for pfft operations. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + config : Config + Configuration dataclass containing simulation metadata and parameters. + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm : object 'pmesh.pm.ParticleMesh' + field_list : list[pmesh.pm.RealField], (multiple) + Essential list of pmesh objects required for MD + list_coulomb : list[pmesh.pm.RealField], (multiple) + Additional list of pmesh objects required for electrostatics. + """ + + if config.dtype == np.float64: + pmeshtype = "f8" + else: + pmeshtype = "f4" + # Ignore numpy numpy.VisibleDeprecationWarning: Creating an ndarray from + # ragged nested sequences until it is fixed in pmesh + with warnings.catch_warnings(): + warnings.filterwarnings( + action="ignore", + category=np.VisibleDeprecationWarning, + message=r"Creating an ndarray from ragged nested sequences", + ) + # The first argument of ParticleMesh has to be a tuple + pm = pmesh.ParticleMesh( + config.mesh_size, BoxSize=config.box_size, dtype=pmeshtype, comm=comm + ) + phi = [pm.create("real", value=0.0) for _ in range(config.n_types)] + phi_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] # noqa: E501 + force_on_grid = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + v_ext_fourier = [pm.create("complex", value=0.0) for _ in range(4)] + v_ext = [pm.create("real", value=0.0) for _ in range(config.n_types)] + + phi_transfer = [pm.create("complex", value=0.0) for _ in range(3)] + + phi_laplacian = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + + # Initialize charge density fields + coulomb_list = [] + elec_common_list = [None, None, None, None] + _SPACE_DIM = config.box_size.size + + if config.coulombtype == "PIC_Spectral_GPE" or config.coulombtype == "PIC_Spectral": + phi_q = pm.create("real", value=0.0) + phi_q_fourier = pm.create("complex", value=0.0) + psi = pm.create("real", value=0.0) + elec_field = [pm.create("real", value=0.0) for _ in range(_SPACE_DIM)] + + elec_common_list = [phi_q, phi_q_fourier, psi, elec_field] + + if config.coulombtype == "PIC_Spectral": + elec_field_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] # for force calculation + psi_fourier = pm.create("complex", value=0.0) + + coulomb_list = [ + elec_field_fourier, + psi_fourier, + ] + + if ( + config.coulombtype == "PIC_Spectral_GPE" + ): ## initializing the density mesh #dielectric_flag + phi_eps = pm.create( + "real", value=0.0 + ) ## real contrib of the epsilon dielectric painted to grid + phi_eps_fourier = pm.create("complex", value=0.0) # complex contrib of phi eps + phi_eta = [ + pm.create("real", value=0.0) for _ in range(_SPACE_DIM) + ] ## real contrib of factor in polarization charge density + phi_eta_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] ## fourier of factor in polarization charge density + phi_pol = pm.create( + "real", value=0.0 + ) ## real contrib of the polarization charge + phi_pol_prev = pm.create("real", value=0.0) + elec_dot = pm.create("real", value=0.0) + elec_field_contrib = pm.create( + "real", value=0.0 + ) # needed for pol energies later + + # External potential and force meshes + Vbar_elec = [pm.create("real", value=0.0) for _ in range(config.n_types)] + Vbar_elec_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] + force_mesh_elec = [ + [pm.create("real", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + force_mesh_elec_fourier = [ + [pm.create("complex", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + + coulomb_list = [ + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol, + phi_pol_prev, + elec_dot, + elec_field_contrib, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + ] + + field_list = [ + phi, + phi_fourier, + force_on_grid, + v_ext_fourier, + v_ext, + phi_transfer, + phi_laplacian, + ] + + return (pm, field_list, elec_common_list, coulomb_list)
+ + +
[docs]def compute_field_force(layouts, r, force_mesh, force, types, n_types): + """Interpolate particle-field forces from the grid onto particle positions + + Backmaps the forces calculated on the grid to particle positions using the + window function :math:`P` (by default cloud-in-cell [CIC]). In the + following, let :math:`\\mathbf{F}_j` denote the force acting on the + particle with index :math:`j` and position :math:`\\mathbf{r}_j`. The + interpolated force is + + .. math:: + + \\mathbf{F}_j = -\\sum_k\\nabla V_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`V_{j_k}` is the discretized external potential at grid vertex + :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid vertex + with index :math:`j_k`, and :math:`h^3` is the volume of each grid voxel. + The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + r : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + force : (N,D) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. Local + for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + n_types : int + Number of different unique types present in the simulation system. + :code:`n_types` is global, i.e. the same for all MPI ranks even if some + ranks contain zero particles of certain types. + """ + for t in range(n_types): + ind = types == t + for d in range(3): + force[ind, d] = force_mesh[t][d].readout(r[ind], layout=layouts[t])
+ + +
[docs]def compute_self_energy_q(config, charges, comm=MPI.COMM_WORLD): + """Compute the self energy for the interaction due to the Ewald scheme + used to compute the electrostatics. The energy is stored in :code:`config`. + + The self interaction energy is given by: + + .. math:: + + U_{self} = \\sqrt{\\frac{1}{2\\pi\\sigma^2}} \\sum_{i=1}^{N} q_i^2 + + where :math:`q_i` are the charges and :math:`\\sigma` is the half-width + of the Gaussian filter. + + Parameters + ---------- + config : Config + Configuration object. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + comm : mpi4py.Comm + MPI communicator to use for rank communication. + + Returns + ------- + field_q_self_energy : float + Electrostatic self energy. + """ + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + prefac = elec_conversion_factor * np.sqrt( + 1.0 / (2.0 * np.pi * config.sigma * config.sigma) + ) + _squared_charges = charges * charges + squared_charges_sum = comm.allreduce(np.sum(_squared_charges)) + return prefac * squared_charges_sum
+ + +
[docs]def update_field_force_q( + charges, + phi_q, + phi_q_fourier, + psi, + psi_fourier, + elec_field_fourier, + elec_field, + elec_forces, + layout_q, + hamiltonian, + pm, + positions, + config, +): + """Calculate the electrostatic particle-field forces on the grid + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential is computed in reciprocal space as + + .. math:: + + \\Phi = \\mathrm{FFT}^{-1}\\left[ + \\frac{4\\pi k_e}{\\varepsilon \\vert\\mathbf{k}\\vert^2} + \\mathrm{FFT}(\\rho)\\mathrm{FFT}(H) + \\right], + + with the electric field + + .. math:: + + \\mathbf{E} = \\mathrm{FFT}^{-1}\\left[ + -i\\mathbf{k}\\,\\mathrm{FFT}(\\Psi) + \\right]. + + In the following, let :math:`\\mathbf{F}_j` denote the electrostatic force + acting on the particle with index :math:`j` and position + :math:`\\mathbf{r}_j`. The interpolated electrostatic force is + + .. math:: + + \\mathbf{F}_j = \\sum_k q_j\\mathbf{E}_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`\\mathbf{E}_{j_k}` is the discretized electric field at grid + vertex :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid + vertex with index :math:`j_k`, and :math:`h^3` is the volume of each grid + voxel. The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty; any values in this field + are discarded. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + elec_field_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + electric field values in reciprocal space on the computational grid. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + n_dimensions = config.box_size.size + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + # charges to grid + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) + phi_q /= volume_per_cell + # print("phi_q", np.sum(phi_q)) + phi_q.r2c(out=phi_q_fourier) + + # smear charges with filter + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + + # solve Poisson equation in Fourier space to get electrostatic potential + def poisson_transfer_function(k, v): + return 4.0 * np.pi * elec_conversion_factor * v / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(poisson_transfer_function, out=psi_fourier) + # print("psi_fourier", np.sum(psi_fourier)) + psi_fourier.c2r(out=psi) + # print("phi_q * psi update_field", np.sum(phi_q * psi)) + + # exit() + + # compute electric field directly from smeared charged densities in Fourier + for _d in np.arange(n_dimensions): + + def poisson_transfer_function(k, v, d=_d): + return ( + -1j + * k[d] + * 4.0 + * np.pi + * elec_conversion_factor + * v + / k.normp(p=2, zeromode=1) + ) + + phi_q_fourier.apply(poisson_transfer_function, out=elec_field_fourier[_d]) + elec_field_fourier[_d].c2r(out=elec_field[_d]) + + # get electrostatic force from electric field + for _d in np.arange(n_dimensions): + elec_forces[:, _d] = charges * ( + elec_field[_d].readout(positions, layout=layout_q) + )
+ + +def comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, +): + for t in range(config.n_types): + np.copyto(phi_transfer[0].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[1].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[2].value, phi_fourier[t].value, casting="no", where=True) + + # Evaluate laplacian of phi in fourier space + for d in range(3): + + def laplacian_transfer(k, v, d=d): + return -k[d] ** 2 * v + + phi_transfer[d].apply(laplacian_transfer, out=Ellipsis) + phi_transfer[d].c2r(out=phi_laplacian[t][d]) + + +
[docs]def update_field( + phi, + phi_laplacian, + phi_transfer, + layouts, + force_mesh, + hamiltonian, + pm, + positions, + types, + config, + v_ext, + phi_fourier, + v_ext_fourier, + m, + compute_potential=False, +): + """Calculate the particle-field potential and force density + + If :code:`compute_potential` is :code:`True`, the energy may subsequently + be computed by calling :code:`compute_field_and_kinetic_energy`. + + Computes the particle-field external potential :math:`V_\\text{ext}` from + particle number densities through the smoothed density field, + :math:`\\phi(\\mathbf{r})`. With :math:`P` being the cloud-in-cell (CIC) + window function, the density and filtered densities are computed as + + .. math:: + + \\phi(\\mathbf{r}) = \\sum_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\phi(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\phi(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + external potential is computed in reciprocal space as + + .. math:: + + V_\\text{ext} = \\mathrm{FFT}^{-1}\\left[ + \\mathrm{FFT} + \\left( + \\frac{\\partial w}{\\partial \\tilde\\phi} + \\right) + \\mathrm{FFT}(H) + \\right], + + where :math:`w` is the interaction energy functional. Differentiating + :math:`V_\\text{ext}` is done by simply applying :math:`i\\mathbf{k}` in + Fourier space, and the resulting forces are back-transformed to direct + space and interpolated to particle positions by + + .. math:: + + \\mathbf{F}_j = -\\sum_{j_k} \\nabla V_{j_k} + P(\\mathbf{r}_{j_k} - \\mathbf{r}_j)h^3, + + where :math:`j_k` are the neighbouring vertices of particle :math:`j` at + position :math:`\\mathbf{r}_j`, and :math:`h^3` is the volume of each grid + voxel. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Pre-allocated, but empty; any values + in this field are discarded. Changed in-place. Local for each MPI + rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + config : Config + Configuration object. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Pre-allocated, but empty; any values in this field are + discarded Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + phi_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computational grid is represented by the collective fields of all + MPI ranks. + v_ext_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplesField` objects containing discretized + particle-field external potential values in reciprocal space on the + computational grid; :code:`D+1` fields in D dimensions for each + particle type. :code:`D` copies are made after calculation for later + use in force calculation, because the `force transfer function` + application differentiates the field in-place, ruining the contents + for differentiation in the remaining :code:`D-1` spatial directions. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + m: list[float], (M,) + pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. + Defaults to 1.0 for all particle types. + compute_potential : bool, optional + If :code:`True`, a :code:`D+1`-th copy of the Fourier transformed + external potential field is made to be used later in particle-field + energy calculation. If :code:`False`, only :code:`D` copies are made. + + See also + -------- + compute_field_and_kinetic_energy : + Compute the particle-field energy after the external potential is + calculated. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + for t in range(config.n_types): + pm.paint(positions[types == t], mass=m[t], layout=layouts[t], out=phi[t]) + phi[t] /= volume_per_cell + phi[t].r2c(out=phi_fourier[t]) + phi_fourier[t].apply(hamiltonian.H, out=Ellipsis) + phi_fourier[t].c2r(out=phi[t]) + + # External potential + for t in range(config.n_types): + v = hamiltonian.v_ext[t](phi) + + v.r2c(out=v_ext_fourier[0]) + v_ext_fourier[0].apply(hamiltonian.H, out=Ellipsis) + np.copyto( + v_ext_fourier[1].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + np.copyto( + v_ext_fourier[2].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + if compute_potential: + np.copyto( + v_ext_fourier[3].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + + # Differentiate the external potential in fourier space + for d in range(3): + + def force_transfer_function(k, v, d=d): + return -k[d] * 1j * v + + v_ext_fourier[d].apply(force_transfer_function, out=Ellipsis) + v_ext_fourier[d].c2r(out=force_mesh[t][d]) + + if compute_potential: + v_ext_fourier[3].c2r(out=v_ext[t])
+ + +
[docs]def compute_field_and_kinetic_energy( + phi, + phi_q, + psi, + velocity, + hamiltonian, + positions, + types, + v_ext, + config, + layouts, + comm=MPI.COMM_WORLD, +): + """Compute the particle-field and kinetic energy contributions + + Calculates the kinetic energy through + + .. math:: + + E_k = \\sum_j \\frac{1}{2}m_j\\mathbf{v}_j\\cdot\\mathbf{v}_j, + + and the particle-field energy by + + .. math:: + + E_\\text{field} = \\int\\mathrm{d}\\mathbf{r}\\, + w[\\tilde\\phi], + + where :math:`w` is the interaction energy functional `density`. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + velocity : (N,D) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Local for each MPI rank--the full computational grid is + represented by the collective fields of all MPI ranks. + config : Config + Configuration object. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field : + Computes the up-to-date external potential for use in calculating the + particle-field energy. + """ + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + field_energy = w_0.csum() # w to W + + kinetic_energy = comm.allreduce(0.5 * config.mass * np.sum(velocity**2)) + + if config.coulombtype == "PIC_Spectral": + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + field_q_energy = w_elec.csum() + else: + field_q_energy = 0.0 + + return field_energy, kinetic_energy, field_q_energy
+ + +
[docs]def compute_field_energy_q_GPE( + config, + phi_eps, + field_q_energy, + dot_elec, + comm=MPI.COMM_WORLD, +): + """ + Compute the electrostatic energy after electrosatic forces is + calculated. + + From the definition of the elecrostatic potential :math:`\\Psi`, the energy + is + + W = \\frac{1}{2}\\int\\mathrm{d}\\mathbf{r}\\, + \\epsilon(\\mathbf{r})} \\left(\\mathbf{E}\\cdot \\mathbf{E}\\right), + + where :math:`\\epsilon(\\mathbf{r})}` is the anisotropic, spatially dependent, + relative dielectric of the simulation medium. + + Parameters + ---------- + config : hymd.input_parser.Config + Configuration object. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + field_q_energy : float + Total elecrostatic energy. + dot_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing :math:`|\\mathbf{E(r)}|^{2}` + on the computational grid. Local for each MPI rank -- the full computational + grid is represented by the collective fields of all MPI ranks. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field_force_q_GPE: + Compute the electrosatic force from an anisotropic dielectric general + Poisson equation. + """ + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + # ^ due to integration on local cell before allreduce + + eps_0 = 1.0 / (config.coulomb_constant * 4 * np.pi) + field_q_energy = ( + volume_per_cell * (0.5 * eps_0) * comm.allreduce(np.sum(phi_eps * dot_elec)) + ) + + return field_q_energy
+ + +
[docs]def update_field_force_q_GPE( + conv_fun, + phi, + types, + charges, + phi_q, + phi_q_fourier, + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol_prev, + phi_pol, + elec_field, + elec_forces, + elec_field_contrib, + psi, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + hamiltonian, + layout_q, + layouts, + pm, + positions, + config, + comm=MPI.COMM_WORLD, +): + """ + Calculate the electrostatic particle-field forces on the grid, arising from + a general Poisson equation, i.e. anisotropic permittivity/dielectric. + The function is called when tomli input config.coulombtype = "PIC_Spectral_GPE." + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential for a variable dielectric does not have an + analytical expression, and is computed in reciprocal through an iterative + method. + + The GPE states that + + .. math:: + + \\nabla \\cdot \\left(\\epsilon(\\mathbf{r}) + \\nabla{\\mathbf{\\psi(r)}}\\right) = -\\rho({\\mathbf{r}}). + + where :math:`\\epsilon(\\mathbf{r})` is the relative dielectric function. + + Parameters + ---------- + conv_fun : Convergence function. + Returns a scalar. Depends on MPI allreduce for similar convergence + across MPI ranks. + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_eta : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + gradients of the relative dielectric values on the computational grid. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank--the + full computational grid is represented by the collective fields of all MPI ranks. + phi_eta_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated discretized + Fourier transformed gradient relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol_prev : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charge values on the computational grid. Parameter in + the iterative method.Pre-allocated,but empty. Changedin-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charges on the computational grid. Parameter in the iterative + method, updating the next quess in solving for the electrostatic potential. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all + MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + elec_field_contrib : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing + :math:`|\\mathbf{E(r)}|^2/\\phi_{0}` on the computational grid. + Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + psi : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic potential + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + Vbar_elec : mesh.pm.RealField + Pmesh :code:`RealField` object for storing functional derivatives of + :math:`\\|w(\\{ \\phi \\})_{elec}`on the computational grid. + Pre-allocated, but empty. Changed in-place. Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + Vbar_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated functional + derivatives of :math:`\\|w(\\{ \\phi \\})_{elec}` in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + force_mesh_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic force values + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + force_mesh_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated electrostatic + force values in reciprocal space on the computational grid. Local for + each MPI rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + layouts: list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + comm: mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + compute_field_energy_q_GPE: + Compute the electrostatic energy after electrosatic force is + calculated for a variable (anisotropic) dielectric general Poisson equation. + """ + + ## basic setup + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + ## old protocol in gen_qe_hpf_use_self + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) ## + ## scale and fft + ## old protocol in gen_qe_hpf_use_self + phi_q /= volume_per_cell + phi_q.r2c(out=phi_q_fourier) + + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + ## ^------ use the same gaussian as the \kai interaciton + phi_q_fourier.c2r(out=phi_q) ## this phi_q is after applying the smearing function + + denom_phi_tot = pm.create("real", value=0.0) + num_types = pm.create("real", value=0.0) + ### ^ ----- Calculate the relative dielectric (permittivity) to field + ### ------- from a mean contribution of particle number densities + + for t_ in range(config.n_types): + num_types = num_types + (config.dielectric_type[t_]) * phi[t_] + denom_phi_tot = denom_phi_tot + phi[t_] + + np.divide(num_types, denom_phi_tot, where=np.abs(denom_phi_tot > 1e-6), out=phi_eps) + + phi_eps.r2c(out=phi_eps_fourier) # FFT dielectric + + # phi_q_eps = (phi_q/phi_eps) + np.divide(phi_q, phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_q) + + _SPACE_DIM = 3 + ##^--------- constants needed throughout the calculations + + ### method for finding the gradient (fourier space), using the spatial dimension of k + for _d in np.arange(_SPACE_DIM): + + def gradient_transfer_function(k, x, d=_d): + return 1j * k[d] * x + + phi_eps_fourier.apply(gradient_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=phi_eta[_d]) + np.divide(phi_eta[_d], phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_eta[_d]) + + ### iterative GPE solver ### + ### ---------------------------------------------- + max_iter = 100 + i = 0 + delta = 1.0 + # phi_pol_prev = pm.create("real", value = 0.0) + ### ^------ set to zero before each iterative procedure or soft start + conv_criteria = config.conv_crit # conv. criteria (default 1e-6) + w = config.pol_mixing # polarization mixing param (default 0.6) + while i < max_iter and delta > conv_criteria: + (phi_q + phi_pol_prev).r2c(out=phi_q_fourier) + for _d in np.arange(_SPACE_DIM): + + def iterate_apply_k_vec(k, additive_terms, d=_d): + return additive_terms * (-1j * k[d]) / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(iterate_apply_k_vec, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + + phi_pol = -( + phi_eta[0] * elec_field[0] + + phi_eta[1] * elec_field[1] + + phi_eta[2] * elec_field[2] + ) + ### ^-- Following a negative sign convention (-ik) of the FT, a neg sign is + ### --- mathematically correct by the definition of the GPE (double - -> +) + phi_pol = w * phi_pol + (1.0 - w) * phi_pol_prev + diff = np.abs(phi_pol - phi_pol_prev) + delta = conv_fun(comm, diff) # decided from toml input + phi_pol_prev = phi_pol.copy() + i = i + 1 + # print("Stopping after iteration {:d} with stop crit {:.2e}, delta {:.2e}".format(i,conv_criteria,delta)) + + # compute_potential = True + def k_norm_divide(k, potential): + return potential / k.normp(p=2, zeromode=1) + + ## > Electrostatic potential + eps0_inv = config.coulomb_constant * 4 * np.pi + ## ^ the 1/(4pi eps0)*4*pi = 1/eps0 + ((eps0_inv) * (phi_q + phi_pol)).r2c(out=phi_q_fourier) + phi_q_fourier.apply(k_norm_divide, out=phi_q_fourier) + phi_q_fourier.c2r(out=psi) + ### ^ electrostatic potential for the GPE + + for _d in np.arange(_SPACE_DIM): + + def field_transfer_function(k, x, d=_d): + return ( + -1j * k[d] * x + ) ## negative sign relation, due to E = - nabla psi relation + + phi_q_fourier.apply(field_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + ## ^-------- Method: Obtaining the electric field from electrostatic potential + ## Assuming the electric field is conserved. + ## Assumption holds if no magnetic flux (magnetic induced fields) + + ############## Obtain forces ############## + elec_dot = ( + elec_field[0] * elec_field[0] + + elec_field[1] * elec_field[1] + + elec_field[2] * elec_field[2] + ) + # needed for energy calculations + + np.divide( + elec_dot, + denom_phi_tot, + where=np.abs(denom_phi_tot > 1e-6), + out=elec_field_contrib, + ) + + eps0_inv = config.coulomb_constant * 4 * np.pi + + for t_ in range(config.n_types): + Vbar_elec[t_] = ( + config.type_charges[t_] * psi + - (0.5 / eps0_inv) + * (config.dielectric_type[t_] - phi_eps) + * elec_field_contrib + ) + + # Obtain Vext,k + for t_ in range(config.n_types): + Vbar_elec[t_].r2c(out=Vbar_elec_fourier[t_]) + Vbar_elec_fourier[t_].apply(hamiltonian.H, out=Vbar_elec_fourier[t_]) + + # force terms + # F = - grad Vext + for t_ in range(config.n_types): + for _d in np.arange(_SPACE_DIM): + + def force_transfer_function(k, x, d=_d): + return -1j * k[_d] * x ## negative gradient + + Vbar_elec_fourier[t_].apply( + force_transfer_function, out=force_mesh_elec_fourier[t_][_d] + ) + force_mesh_elec_fourier[t_][_d].c2r(out=force_mesh_elec[t_][_d]) + elec_forces[types == t_, _d] = force_mesh_elec[t_][_d].readout( + positions[types == t_], layout=layouts[t_] + ) + + return Vbar_elec, phi_eps, elec_dot
+ + +
[docs]def domain_decomposition( + positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=MPI.COMM_WORLD +): + """Performs domain decomposition + + Rearranges the MPI rank memory layout into one that better mimics the PFFT + pencil grid 2D decomposition. As molecules are always required to be fully + contained on a single MPI rank, a perfect decomposition is not always + possible. The best decomposition which leaves the center of mass of all + molecules in their respective correct domains is used, with possible + overlap into neighbouring domains if the spatial extent of any molecule + crosses domain boundaries. + + Parameters + ---------- + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + *args + Variable length argument list containing arrays to include in the + domain decomposition. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + bonds : (N,M) numpy.ndarray, optional + Array of :code:`M` bonds originating from each of :code:`N` particles. + verbose : int, optional + Specify the logging event verbosity of this function. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + Domain decomposed :code:`positions` and any array specified in + :code:`*args`, in addition to :code:`bonds` and :code:`molecules` if these + arrays were provided as input. + """ + if molecules is not None: + if not topol: + assert bonds is not None, "bonds must be provided with molecules" + unique_molecules = np.sort(np.unique(molecules)) + molecules_com = np.empty_like(positions) + for m in unique_molecules: + ind = molecules == m + r = positions[ind, :][0, :] + molecules_com[ind, :] = r + layout = pm.decompose(molecules_com, smoothing=0) + if not topol: + args = (*args, bonds, molecules) + else: + args = (*args, molecules) + else: + layout = pm.decompose(positions, smoothing=0) + if verbose > 1: + Logger.rank0.log( + logging.INFO, + "DOMAIN_DECOMP: Total number of particles to be exchanged = %d", + np.sum(layout.get_exchange_cost()), + ) + return layout.exchange(positions, *args)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/_modules/hymd/file_io.html b/v1.0.2/_modules/hymd/file_io.html new file mode 100644 index 00000000..ae1ea384 --- /dev/null +++ b/v1.0.2/_modules/hymd/file_io.html @@ -0,0 +1,1146 @@ + + + + + + hymd.file_io — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.file_io

+"""Handle file input/output in parllel HDF5 fashion
+"""
+import numpy as np
+import h5py
+import os
+import logging
+import getpass
+from mpi4py import MPI
+from .logger import Logger, get_version
+
+
+
[docs]class OutDataset: + """HDF5 dataset handler for file output""" + + def __init__( + self, + dest_directory, + config, + double_out=False, + disable_mpio=False, + comm=MPI.COMM_WORLD, + ): + """Constructor + + Parameters + ---------- + dest_directory : str + Ouput directory for saving data. + config : Config + Configuration object. + double_out : bool, optional + If :code:`True`, the output HDF5 objects are written in eight byte + floating point representation. Otherwise, four byte single + precision is used. + disable_mpio : bool, optional + If :code:`True`, disables parallel MPI-enabled HDF5 file output. + This is a compatibility option used if HDF5 is not compiled with + MPI support. This makes everything much harder by splitting all + output in one file per MPI rank, and having an MPI-enabled HDF5 + library is **highly recommended**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + """ + self.disable_mpio = disable_mpio + self.config = config + if double_out: + self.float_dtype = "float64" + else: + self.float_dtype = "float32" + + if disable_mpio: + self.file = h5py.File( + os.path.join( + dest_directory, f"sim.hdf5-{comm.rank:6d}-of-{comm.size:6d}" + ), + "w", + ) + else: + self.file = h5py.File( + os.path.join(dest_directory, "sim.H5"), "w", driver="mpio", comm=comm + ) + +
[docs] def is_open(self, comm=MPI.COMM_WORLD): + """Check if HDF5 output file is open + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + return self.file.__bool__()
+ +
[docs] def close_file(self, comm=MPI.COMM_WORLD): + """Closes the HDF5 output file + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + self.file.close()
+ +
[docs] def flush(self): + """Flushes output buffers, forcing file writes""" + self.file.flush()
+ + +
[docs]def setup_time_dependent_element( + name, parent_group, n_frames, shape, dtype, units=None +): + """Helper function for setting up time-dependent HDF5 group datasets + + All output groups must adhere to the H5MD standard, meaning a structure of + + + | ┗━ **group** particle group (e.g. :code:`all`) or :code:`observables` group + | ┗━ **group** time-dependent data + | ┣━ **dataset** :code:`step` :code:`shape=(n_frames,)` + | ┣━ **dataset** :code:`time` :code:`shape=(n_frames,)` + | ┗━ **dataset** :code:`value` :code:`shape=(n_frames, *)` + + is necessary. + + References + ---------- + H5MD specification : + https://www.nongnu.org/h5md/h5md.html + """ # noqa: E501 + group = parent_group.create_group(name) + step = group.create_dataset("step", (n_frames,), "int32") + time = group.create_dataset("time", (n_frames,), "float32") + value = group.create_dataset("value", (n_frames, *shape), dtype) + + if units is not None: + value.attrs["unit"] = units + time.attrs["unit"] = "ps" + return group, step, time, value
+ + +
[docs]def store_static( + h5md, + rank_range, + names, + types, + indices, + config, + bonds_2_atom1, + bonds_2_atom2, + molecules=None, + velocity_out=False, + force_out=False, + charges=False, + dielectrics=False, + plumed_out=False, + comm=MPI.COMM_WORLD, +): + """Outputs all static time-independent quantities to the HDF5 output file + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + rank_range : list[int] + Start and end indices for global arrays for each MPI rank. + names : (N,) numpy.ndarray + Array of names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of type indices for :code:`N` particles. + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + config : Config + Configuration object. + bonds_2_atom1 : (B,) numpy.ndarray + Array of indices of the first particle for :code:`B` total + two-particle bonds. + bonds_2_atom2 : (B,) numpy.ndarray + Array of indices of the second particle for :code:`B` total + two-particle bonds. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. + dielectrics : (N,) numpy.ndarray + Array of particle relative dielectric values for :code:`N` particles. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to output HDF5 file. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + prepare_bonds : + Constructs two-, three-, and four-particle bonds from toplogy input + file and bond configuration information. + distribute_input : + Distributes input arrays onto MPI ranks, attempting load balancing. + """ + dtype = h5md.float_dtype + + h5md_group = h5md.file.create_group("/h5md") + h5md.h5md_group = h5md_group + h5md.observables = h5md.file.create_group("/observables") + h5md.connectivity = h5md.file.create_group("/connectivity") + h5md.parameters = h5md.file.create_group("/parameters") + + h5md_group.attrs["version"] = np.array([1, 1], dtype=int) + author_group = h5md_group.create_group("author") + author_group.attrs["name"] = np.string_(getpass.getuser()) + creator_group = h5md_group.create_group("creator") + creator_group.attrs["name"] = np.string_("Hylleraas MD") + + # Get HyMD version + creator_group.attrs["version"] = np.string_(get_version()) + + h5md.particles_group = h5md.file.create_group("/particles") + h5md.all_particles = h5md.particles_group.create_group("all") + mass = h5md.all_particles.create_dataset("mass", (config.n_particles,), dtype) + mass[...] = config.mass + + if charges is not False: + charge = h5md.all_particles.create_dataset( + "charge", (config.n_particles,), dtype="float32" + ) + charge[indices] = charges + if dielectrics is not False: + dielectric = h5md.all_particles.create_dataset( + "dielectric", (config.n_particles,), dtype="float32" + ) + dielectric[indices] = dielectrics + + box = h5md.all_particles.create_group("box") + box.attrs["dimension"] = 3 + box.attrs["boundary"] = np.array( + [np.string_(s) for s in 3 * ["periodic"]], dtype="S8" + ) + + n_frames = config.n_steps // config.n_print + if np.mod(config.n_steps - 1, config.n_print) != 0: + n_frames += 1 + if np.mod(config.n_steps, config.n_print) == 1: + n_frames += 1 + if n_frames == config.n_steps: + n_frames += 1 + + species = h5md.all_particles.create_dataset( + "species", + (config.n_particles,), + dtype="i", + ) + + ( + _, + h5md.positions_step, + h5md.positions_time, + h5md.positions, + ) = setup_time_dependent_element( + "position", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm", + ) + if velocity_out: + ( + _, + h5md.velocities_step, + h5md.velocities_time, + h5md.velocities, + ) = setup_time_dependent_element( + "velocity", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm ps-1", + ) + if force_out: + ( + _, + h5md.forces_step, + h5md.forces_time, + h5md.forces, + ) = setup_time_dependent_element( + "force", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="kJ mol-1 nm-1", + ) + ( + _, + h5md.total_energy_step, + h5md.total_energy_time, + h5md.total_energy, + ) = setup_time_dependent_element( + "total_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.kinetc_energy_step, + h5md.kinetc_energy_time, + h5md.kinetc_energy, + ) = setup_time_dependent_element( + "kinetic_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.potential_energy_step, + h5md.potential_energy_time, + h5md.potential_energy, + ) = setup_time_dependent_element( + "potential_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.bond_energy_step, + h5md.bond_energy_time, + h5md.bond_energy, + ) = setup_time_dependent_element( + "bond_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.angle_energy_step, + h5md.angle_energy_time, + h5md.angle_energy, + ) = setup_time_dependent_element( + "angle_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.dihedral_energy_step, + h5md.dihedral_energy_time, + h5md.dihedral_energy, + ) = setup_time_dependent_element( + "dihedral_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.field_energy_step, + h5md.field_energy_time, + h5md.field_energy, + ) = setup_time_dependent_element( + "field_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + if charges is not False: + ( + _, + h5md.field_q_energy_step, + h5md.field_q_energy_time, + h5md.field_q_energy, + ) = setup_time_dependent_element( + "field_q_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) # <-------- xinmeng + if plumed_out is not False: + ( + _, + h5md.plumed_bias_step, + h5md.plumed_bias_time, + h5md.plumed_bias, + ) = setup_time_dependent_element( + "plumed_bias", h5md.observables, n_frames, (1,), dtype, units="kJ mol-1" # noqa: E501 + ) + ( + _, + h5md.total_momentum_step, + h5md.total_momentum_time, + h5md.total_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "total_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm g ps-1 mol-1", + ) + ( + _, + h5md.angular_momentum_step, + h5md.angular_momentum_time, + h5md.angular_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "angular_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm+2 g ps-1 mol-1", + ) + ( + _, + h5md.torque_step, + h5md.torque_time, + h5md.torque, + ) = setup_time_dependent_element( # noqa: E501 + "torque", + h5md.observables, + n_frames, + (3,), + dtype, + units="kJ nm+2 mol-1", + ) + ( + _, + h5md.temperature_step, + h5md.temperature_time, + h5md.temperature, + ) = setup_time_dependent_element( + "temperature", h5md.observables, n_frames, (3,), dtype, units="K" + ) + ( + _, + h5md.thermostat_work_step, + h5md.thermostat_work_time, + h5md.thermostat_work, + ) = setup_time_dependent_element( + "thermostat_work", + h5md.observables, + n_frames, + (1,), + "float32", + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.pressure_step, + h5md.pressure_time, + h5md.pressure, + ) = setup_time_dependent_element( + "pressure", h5md.observables, n_frames, (18,), "float32", units="Bar" + ) + (_, h5md.box_step, h5md.box_time, h5md.box_value,) = setup_time_dependent_element( + "edges", box, n_frames, (3, 3), "float32", units="nm" + ) + + ind_sort = np.argsort(indices) + for i in ind_sort: + species[indices[i]] = config.name_to_type_map[names[i].decode("utf-8")] + + h5md.parameters.attrs["config.toml"] = np.string_(str(config)) + vmd_group = h5md.parameters.create_group("vmd_structure") + index_of_species = vmd_group.create_dataset( + "indexOfSpecies", (config.n_types,), "i" + ) + index_of_species[:] = np.array(list(range(config.n_types))) + + # VMD-h5mdplugin maximum name/type name length is 16 characters (for + # whatever reason [VMD internals?]). + name_dataset = vmd_group.create_dataset("name", (config.n_types,), "S16") + type_dataset = vmd_group.create_dataset("type", (config.n_types,), "S16") + if molecules is not None: + resid_dataset = vmd_group.create_dataset( + "resid", + (config.n_particles,), + "i", + ) + + # Change this + for i, n in config.type_to_name_map.items(): + name_dataset[i] = np.string_(n[:16]) + if n == "W": + type_dataset[i] = np.string_("solvent") + else: + type_dataset[i] = np.string_("membrane") + + total_bonds = comm.allreduce(len(bonds_2_atom1), MPI.SUM) + n_bonds_local = len(bonds_2_atom1) + + receive_buffer = comm.gather(n_bonds_local, root=0) + n_bonds_global = None + if comm.Get_rank() == 0: + n_bonds_global = receive_buffer + n_bonds_global = np.array(comm.bcast(n_bonds_global, root=0)) + rank_bond_start = np.sum(n_bonds_global[: comm.Get_rank()]) + + bonds_from = vmd_group.create_dataset("bond_from", (total_bonds,), "i") + bonds_to = vmd_group.create_dataset("bond_to", (total_bonds,), "i") + for i in range(n_bonds_local): + a = bonds_2_atom1[i] + b = bonds_2_atom2[i] + bonds_from[rank_bond_start + i] = indices[a] + 1 + bonds_to[rank_bond_start + i] = indices[b] + 1 + + if molecules is not None: + resid_dataset[indices[ind_sort]] = molecules
+ + +# store data old vs +""" +h5md, step, frame, indices, positions, velocities, forces, box_size, +temperature, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, +field_energy, field_q_energy, time_step, config, velocity_out=False, +force_out=False, charge_out=False, dump_per_particle=False, +""" + + +
[docs]def store_data( + h5md, + step, + frame, + indices, + positions, + velocities, + forces, + box_size, + temperature, + pressure, + kinetic_energy, + bond2_energy, + bond3_energy, + bond4_energy, + field_energy, + field_q_energy, + plumed_bias, + time_step, + config, + velocity_out=False, + force_out=False, + charge_out=False, + plumed_out=False, + dump_per_particle=False, + comm=MPI.COMM_WORLD, +): + """Writes time-step data to HDF5 output file + + Handles all quantities which change during simulation, as opposed to + static quanitities (see :code:`store_static`). + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + step : int + Step number. + frame : int + Output frame number (:code:`step // n_print`). + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + positions : (N,) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + velocities : (N,) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + forces : (N,) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. + box_size : (D,) numpy.ndarray + Array containing the simulation box size. + temperature : float + Calculated instantaneous temperature. + kinetic_energy : float + Calculated instantaneous kinetic energy. + bond2_energy : float + Calculated instantaneous harmonic two-particle bond energy. + bond3_energy : float + Calculated instantaneous harmonic angular three-particle bond energy. + bond4_energy : float + Calculated instantaneous dihedral four-particle torsion energy. + field_energy : float + Calculated instantaneous particle-field energy. + field_q_energy : float + Calculated instantaneous electrostatic energy. + plumed_bias : float + PLUMED instantaneous bias energy. + time_step : float + Value of the time step. + config : Config + Configuration object. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charge_out : bool, optional + If :code:`True`, electrostatic energies are written to the output + HDF5 file. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to the output HDF5 file. + dump_per_particle : bool, optional + If :code:`True`, all quantities are written **per particle**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + store_static : + Outputs all static time-independent quantities to the HDF5 output file + """ + for dset in ( + h5md.positions_step, + h5md.total_energy_step, + h5md.potential_energy_step, + h5md.kinetc_energy_step, + h5md.bond_energy_step, + h5md.angle_energy_step, + h5md.dihedral_energy_step, + h5md.field_energy_step, + h5md.total_momentum_step, + h5md.angular_momentum_step, + h5md.torque_step, + h5md.temperature_step, + h5md.pressure_step, + h5md.box_step, + h5md.thermostat_work_step, + ): + dset[frame] = step + + for dset in ( + h5md.positions_time, + h5md.total_energy_time, + h5md.potential_energy_time, + h5md.kinetc_energy_time, + h5md.bond_energy_time, + h5md.angle_energy_time, + h5md.dihedral_energy_time, + h5md.field_energy_time, + h5md.total_momentum_time, + h5md.angular_momentum_time, + h5md.torque_time, + h5md.temperature_time, + h5md.pressure_time, + h5md.box_time, + h5md.thermostat_work_time, + ): + dset[frame] = step * time_step + + if velocity_out: + h5md.velocities_step[frame] = step + h5md.velocities_time[frame] = step * time_step + if force_out: + h5md.forces_step[frame] = step + h5md.forces_time[frame] = step * time_step + if charge_out: + h5md.field_q_energy_step[frame] = step + h5md.field_q_energy_time[frame] = step * time_step + if plumed_out: + h5md.plumed_bias_step[frame] = step + h5md.plumed_bias_time[frame] = step * time_step + + ind_sort = np.argsort(indices) + h5md.positions[frame, indices[ind_sort]] = positions[ind_sort] + + if velocity_out: + h5md.velocities[frame, indices[ind_sort]] = velocities[ind_sort] + if force_out: + h5md.forces[frame, indices[ind_sort]] = forces[ind_sort] + if charge_out: + h5md.field_q_energy[frame] = field_q_energy + if plumed_out: + h5md.plumed_bias[frame] = plumed_bias + + potential_energy = ( + bond2_energy + bond3_energy + bond4_energy + field_energy + field_q_energy + ) + + total_momentum = config.mass * comm.allreduce(np.sum(velocities, axis=0), MPI.SUM) + angular_momentum = config.mass * comm.allreduce( + np.sum(np.cross(positions, velocities), axis=0), MPI.SUM + ) + torque = config.mass * comm.allreduce( + np.sum(np.cross(positions, forces), axis=0), MPI.SUM + ) + h5md.total_energy[frame] = kinetic_energy + potential_energy + h5md.potential_energy[frame] = potential_energy + h5md.kinetc_energy[frame] = kinetic_energy + h5md.bond_energy[frame] = bond2_energy + h5md.angle_energy[frame] = bond3_energy + h5md.dihedral_energy[frame] = bond4_energy + h5md.field_energy[frame] = field_energy + h5md.total_momentum[frame, :] = total_momentum + h5md.angular_momentum[frame, :] = angular_momentum + h5md.torque[frame, :] = torque + h5md.temperature[frame] = temperature + h5md.pressure[frame] = pressure + for d in range(3): + h5md.box_value[frame, d, d] = box_size[d] + h5md.thermostat_work[frame] = config.thermostat_work + + fmt_ = [ + "step", + "time", + "temp", + "tot E", + "kin E", + "pot E", + "field E", + "elec E", + "bond E", + "ang E", + "dih E", + "bias E", + "Px", + "Py", + "Pz", + "ΔH" if config.target_temperature else "ΔE", + ] + fmt_ = np.array(fmt_) + + # create mask to show only energies != 0 + en_array = np.array([ + field_energy, + field_q_energy, + bond2_energy, + bond3_energy, + bond4_energy, + plumed_bias, + ]) + mask = np.full_like(fmt_, True, dtype=bool) + mask[range(6,12)] = en_array != 0. + + header_ = fmt_[mask].shape[0] * "{:>13}" + if config.initial_energy is None: + fmt_[-1] = "" + + divide_by = 1.0 + if dump_per_particle: + for i in range(3, 9): + fmt_[i] = fmt_[i][:-2] + "E/N" + fmt_[-1] += "/N" + divide_by = config.n_particles + total_energy = kinetic_energy + potential_energy + if config.initial_energy is not None: + if config.target_temperature: + H_tilde = total_energy - config.initial_energy - config.thermostat_work + else: + H_tilde = total_energy - config.initial_energy + else: + H_tilde = 0.0 + + header = header_.format(*fmt_[mask]) + data_fmt = f'{"{:13}"}{(fmt_[mask].shape[0]-1) * "{:13.5g}" }' + all_data = [ + step, + time_step * step, + temperature, + total_energy / divide_by, + kinetic_energy / divide_by, + potential_energy / divide_by, + field_energy / divide_by, + field_q_energy / divide_by, + bond2_energy / divide_by, + bond3_energy / divide_by, + bond4_energy / divide_by, + plumed_bias / divide_by, + total_momentum[0] / divide_by, + total_momentum[1] / divide_by, + total_momentum[2] / divide_by, + H_tilde / divide_by, + ] + data = data_fmt.format(*[val for i, val in enumerate(all_data) if mask[i]]) + Logger.rank0.log(logging.INFO, ("\n" + header + "\n" + data))
+ + +
[docs]def distribute_input( + in_file, rank, size, n_particles, max_molecule_size=201, comm=MPI.COMM_WORLD +): + """Assign global arrays onto MPI ranks, attempting load balancing + + Distributes approximately equal numbers of particles (workload) onto each + independent MPI rank, while respecting the requirement that any molecule + must be fully contained on a single MPI rank only (no splitting molecules + across multiple CPUs). + + Parameters + ---------- + in_file : h5py.File + HDF5 input file object. + rank : int + Local rank number for this MPI rank. + size : int + Global size of the MPI communicator (number of total CPUs). + n_particles : int + Total number of particles. + max_molecule_size : int, optional + Maximum size of any molecule present in the system. Used to initially + guess where the MPI rank boundaries (start/end indices) in the global + arrays should be placed. If molecules of size + :code:`>max_molecule_size` exist in the simulation system, HyMD + **might** work as expected. Or it might fail spectacularly. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + rank_range : + Starting and ending indices in the global arrays for each MPI rank. + """ + if n_particles is None: + n_particles = len(in_file["indices"]) + np_per_MPI = n_particles // size + + molecules_flag = False + if "molecules" in in_file: + molecules_flag = True + + if not molecules_flag: + if rank == size - 1: + np_cum_mpi = [rank * np_per_MPI, n_particles] + else: + np_cum_mpi = [rank * np_per_MPI, (rank + 1) * np_per_MPI] + p_mpi_range = list(range(np_cum_mpi[0], np_cum_mpi[1])) + return p_mpi_range, molecules_flag + + # To avoid splitting molecules across multiple different ranks, we need + # to read in some extra indices before/after the expected break points + # and iterate until we find a molecule break. + # + # Implicitly assuming no molecule is bigger than + # min(max_molecule_size, n_particles // n_MPI_ranks) atoms. + max_molecule_size += 2 + grab_extra = max_molecule_size if np_per_MPI > max_molecule_size else np_per_MPI + if rank == 0: + mpi_range_start = 0 + if size == 1: + mpi_range_end = n_particles + else: + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + elif rank == size - 1: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = n_particles + else: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + + molecules = in_file["molecules"][mpi_range_start:mpi_range_end] + indices = in_file["indices"][mpi_range_start:mpi_range_end] + molecule_end_indices = np.nonzero(np.diff(molecules))[0] + + p_mpi_range = [None, None] + if rank == 0: + p_mpi_range[0] = 0 + if size == 1: + p_mpi_range[1] = n_particles + else: + p_mpi_range[1] = indices[ + molecule_end_indices[molecule_end_indices >= np_per_MPI][0] + 1 + ] + elif rank == size - 1: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = n_particles + else: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = ( + indices[molecule_end_indices[molecule_end_indices > np_per_MPI][0]] + + 1 # noqa: E501 + ) + return list(range(p_mpi_range[0], p_mpi_range[1])), molecules_flag
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/_modules/hymd/force.html b/v1.0.2/_modules/hymd/force.html new file mode 100644 index 00000000..d67e56bd --- /dev/null +++ b/v1.0.2/_modules/hymd/force.html @@ -0,0 +1,1149 @@ + + + + + + hymd.force — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.force

+"""Calculates intramolecular forces between bonded particles in molecules
+"""
+import numpy as np
+import networkx as nx
+from dataclasses import dataclass
+
+# Imported here so we can call from force import compute_bond_forces__fortran
+from force_kernels import cbf as compute_bond_forces__fortran  # noqa: F401
+from force_kernels import (  # noqa: F401
+    caf as compute_angle_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cdf as compute_dihedral_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cbf_d as compute_bond_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    caf_d as compute_angle_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    cdf_d as compute_dihedral_forces__fortran__double,
+)
+
+
+
[docs]@dataclass # might not be needed +class Dielectric_type: + atom_1: str + dielectric_value: float
+ + +
[docs]@dataclass +class Bond: + """Dataclass representing a single two-particle bond type + + A `bond type` is a bond strength and equilibrium distance associated with + any bond between particles of specific types :code:`A` and :code:`B` + (where :code:`A` and :code:`B` may be the same or different). Harmonic + two-particle bonds in HyMD take the form + + .. math:: + + V_2(\\mathbf{r}_1, \\mathbf{r}_2) = + \\frac{1}{2}k + \\left( + \\vert \\mathbf{r}_1 - \\mathbf{r}_2 \\vert - r_0 + \\right)^2, + + where :math:`k` is the bond strength (spring constant) and :math:`r_0` is + the equilibrium bond length (at which the energy is zero). + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + equilibrium : float + Equilibrium distance at which the energy associated with the bond + vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient (spring constant). + """ + + atom_1: str + atom_2: str + equilibrium: float + strength: float
+ + +
[docs]@dataclass +class Angle(Bond): + """Dataclass representing a single three-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any three-particle bond between particles of specific types :code:`A`, + :code:`B`, and :code:`C` (where :code:`A`, :code:`B`, and :code:`C` may be + different or the same). Harmonic angular three-particle bonds in HyMD take + the form + + .. math:: + + V_3(\\mathbf{r}_1, \\mathbf{r}_2, \\mathbf{r}_3) = + \\frac{1}{2}k + \\left( + \\cos^{-1} + \\left[ + \\frac{ + (\\mathbf{r}_1-\\mathbf{r}_2) + \\cdot + (\\mathbf{r}_3-\\mathbf{r}_2) + } + { + \\vert\\mathbf{r}_1-\\mathbf{r}_2\\vert + \\vert\\mathbf{r}_3-\\mathbf{r}_2\\vert + } + \\right] - \\theta_0 + \\right)^2 + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + equilibrium : float + Equilibrium angle at which the energy associated with the + three-particle angular bond vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient. + + See also + -------- + Bond : + Two-particle bond type dataclass + """ + + atom_3: str
+ + +
[docs]@dataclass +class Dihedral: + """Dataclass representing a single four-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any four-particle torsional bond between particles of specific types + :code:`A`, :code:`B`, :code:`C`, and :code:`D` (where :code:`A`, :code:`B`, + :code:`C`, and :code:`D` may be different or the same). Dihedral + four-particle bonds in HyMD take different forms depending on the + :code:`dih_type` parameter. + + In the following, let :math:`\\phi` denote the angle between the planes + spanned by the relative positions of atoms :code:`A`-:code:`B`-:code:`C` + and :code:`B`-:code:`C`-:code:`D`. If :code:`dih_type = 0`, then + + .. math:: + + V_4(\\phi) = \\sum_n c_n + \\left( + 1 + \\cos\\left[ + n\\phi - d_n + \\right] + \\right), + + where :math:`c_n` are energy coefficients and :math:`d_n` are propensity + phases. By default, the cosine sum is truncated at five terms. If + :code:`coeffs` provides only a single float, this is used as the coiling + propensity parameter :math:`\\lambda`. In this case, :math:`c_n` and + :math:`d_n` are automatically set to values which promote alpha helical + (:math:`\\lambda=-1`), beta sheet (:math:`\\lambda=1`), or a mixed + (:math:`1>\\lambda>-1`) structure (using values provided by Bore et al. + (2018)). In this case, the full potential takes the form + + .. math:: + + V_4(\\phi;\\lambda) = + \\frac{1}{2}(1-\\lambda) V_{\\text{prop},\\alpha}(\\phi) + + + \\frac{1}{2}(1+\\lambda) V_{\\text{prop},\\beta}(\\phi) + + + (1-\\vert\\lambda\\vert) V_{\\text{prop}, \\text{coil}}(\\phi), + + with each of the :math:`V_{\\mathrm{prop}, X}` being fixed cosine series + potentials with pre-set :math:`c_n` -s and :math:`d_n` -s. + + If :code:`dih_type = 1`, then a combined bending torsional (CBT) potential + is employed, + + .. math:: + + V_4(\\phi,\\gamma;\\lambda) = + V_4(\\phi;\\lambda) + + + \\frac{1}{2}K(\\phi)(\\gamma - \\gamma_0)^2, + + where :math:`V_4(\\phi;\\lambda)` specifies the potential as given by the + coiling propensity parameter above, :math:`K(\\phi)` is a separate cosine + series potential acting as the angular three-particle bond strength, and + :math:`\\gamma_0` is the three-particle bond equilibrium angle. In this + case, the :code:`coeffs` parameter must specify *both* a :math:`\\lambda` + value, in additon to the energy and phases dictating the :math:`K(\\phi)` + potential. + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + atom_4 : str + Type name of particle 4. + coeffs : list[list[float]] or list[float] or numpy.ndarray + Dihedral coefficients defining the series expansion of the dihedral + energy. + dih_type : int + Specifies the type of dihedral used; If :code:`0`, then :code:`coeffs` + must contain **either** two lists of five energy coefficients + :math:`c_n` and five propensity phases :math:`d_n` **or** a single + floating point number defining the :math:`\\lambda` coiling propensity + parameter. If :code:`1`, the combined bending-torsional potential is + used, and :code:`coeffs` must specify :math:`\\lambda` *and* two lists + containing energy coefficients and propensity phases for the + :math:`V_\\text{prop}` propensity potential, defined in terms of cosine + series. + + References + ---------- + Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018. + """ + + atom_1: str + atom_2: str + atom_3: str + atom_4: str + coeffs: np.ndarray + dih_type: int
+ + +
[docs]@dataclass +class Chi: + """Dataclass representing a single :math:`\\chi` mixing interaction type + + An `interaction mixing energy type` is a mixing energy associated with + density overlap between species of types :code:`A` and :code:`B` + (specified as inputs :code:`atom_1` and :code:`atom_2`). A positive mixing + energy promotes phase separation, a negative mixing energy promotes mixing. + The interaction energy density (provided the :code:`DefaultWithChi` + Hamiltonian is used) takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} + \\sum_{k,l}\\chi_{k,l} \\tilde\\phi_k\\tilde\\phi_l, + + where :math:`\\chi_{k,l}` denotes the mixing energy between species + :math:`k` and :math:`l`, with :math:`\\kappa` being the incompressibility. + The value of the interaction mixing energy parameter may be extracted from + `Flory-Huggins theory`_. + + .. _`Flory-Huggins theory`: + https://en.wikipedia.org/wiki/Flory%E2%80%93Huggins_solution_theory + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + interaction_energy : float + Interaction mixing energy. + + See also + -------- + hymd.hamiltonian.DefaultWithChi : + Interaction energy functional using :math:`\\chi`-interactions. + """ + + atom_1: str + atom_2: str + interaction_energy: float
+ + +
[docs]def find_all_paths(G, u, n): + """Helper function that recursively finds all paths of given lenght 'n + 1' inside a network 'G'. + Adapted from https://stackoverflow.com/a/28103735.""" + if n == 0: + return [[u]] + paths = [] + for neighbor in G.neighbors(u): + for path in find_all_paths(G, neighbor, n - 1): + if u not in path: + paths.append([u] + path) + return paths
+ + +
[docs]def propensity_potential_coeffs(x: float): + alpha_coeffs = np.array( + [ + [7.406, -5.298, -2.570, 1.336, 0.739], + [-0.28632126, 1.2099146, 1.18122138, 0.49075168, 0.98495911], + ] + ) + beta_coeffs = np.array( + [ + [3.770, 5.929, -4.151, -0.846, 0.190], + [-0.2300693, -0.0583289, 0.99342396, 1.03237971, 2.90160988], + ] + ) + coil_coeffs = np.array( + [ + [1.416, -0.739, 0.990, -0.397, 0.136], + [1.3495933, 0.45649087, 2.30441057, -0.12274901, -0.26179939], + ] + ) + + zero_add = np.zeros((2, 5)) + if np.isclose(x, -1): + return np.concatenate((alpha_coeffs, zero_add)) + elif np.isclose(x, 0): + return np.concatenate((coil_coeffs, zero_add)) + elif np.isclose(x, 1): + return np.concatenate((beta_coeffs, zero_add)) + + abs_x = np.abs(x) + if abs_x > 1: + err_str = ( + f"The provided value of lambda = {x} is out of lambda definition range, " + f"[-1.0, 1.0]." + ) + Logger.rank0.log(logging.ERROR, err_str) + else: + coil_coeffs[0] *= 1 - abs_x + if x < 0: + alpha_coeffs[0] *= 0.5 * (abs_x - x) + return np.concatenate((alpha_coeffs, coil_coeffs)) + else: + beta_coeffs[0] *= 0.5 * (abs_x + x) + return np.concatenate((beta_coeffs, coil_coeffs))
+ + +
[docs]def prepare_bonds_old(molecules, names, bonds, indices, config): + """Find bonded interactions from connectivity and bond types information + + .. deprecated:: 1.0.0 + :code:`prepare_bonds_old` was replaced by :code:`prepare_bonds` for + use with compiled Fortran kernels prior to 1.0.0 release. + + Prepares the necessary equilibrium and bond strength information needed by + the intramolecular interaction functions. This is performed locally on each + MPI rank, as the domain decomposition ensures that for all molecules *all* + consituent particles are always contained on *the same* MPI rankself. + + This function traverses the bond connectivity information provided in the + structure/topology input file and indentifies any two-, three-, or + four-particle potential bonds. For each connected chain of two, three, or + four particles, a matching to bond types is attempted. If the corresponding + names match, a bond object is initialized. + + In order to investigate the connectivity, a graph is created using + networkx functionality. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2 : list + List of lists containing *local* particle indices, equilibrium + distance, and bond strength coefficient for each reconstructed + two-particle bond. + bonds_3 : + List of lists containing *local* particle indices, equilibrium angle, + and bond strength coefficient for each reconstructed three-particle + bond. + bonds_4 : + List of lists containing *local* particle indices, dihedral type index, + and dihedral coefficients for each reconstructed four-particle + torsional bond. + bb_index : list + List indicating the dihedral type of each four-particle bond in + :code:`bonds_4`. + + See also + -------- + Bond : + Two-particle bond type dataclass. + Angle : + Three-particle angular bond type dataclass. + Dihedral : + Four-particle torsional bond type dataclass. + hymd.input_parser.Config + Configuration dataclass handler. + """ + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + bb_index = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + bb_dihedral = 0 + bond_graph = nx.Graph() + + for local_index, global_index in enumerate(indices): + if molecules[local_index] != mol: + continue + + bond_graph.add_node( + global_index, + name=names[local_index].decode("UTF-8"), + local_index=local_index, + ) + for bond in [b for b in bonds[local_index] if b != -1]: + bond_graph.add_edge(global_index, bond) + + connectivity = nx.all_pairs_shortest_path(bond_graph) + for c in connectivity: + i = c[0] + connected = c[1] + for j, path in connected.items(): + if len(path) == 2 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for b in config.bonds: + match_forward = name_i == b.atom_1 and name_j == b.atom_2 + match_backward = name_i == b.atom_2 and name_j == b.atom_1 + if match_forward or match_backward: + bonds_2.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[j]["local_index"], + b.equilibrium, + b.strength, + ] + ) + + if len(path) == 3 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_mid = bond_graph.nodes()[path[1]]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for a in config.angle_bonds: + match_forward = ( + name_i == a.atom_1 + and name_mid == a.atom_2 + and name_j == a.atom_3 + ) + match_backward = ( + name_i == a.atom_3 + and name_mid == a.atom_2 + and name_j == a.atom_1 + ) + if match_forward or match_backward: + bonds_3.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[path[1]]["local_index"], + bond_graph.nodes()[j]["local_index"], + np.radians(a.equilibrium), + a.strength, + ] + ) + + all_paths_len_four = find_all_paths(bond_graph, i, 3) + for p in all_paths_len_four: + name_i = bond_graph.nodes()[i]["name"] + name_mid_1 = bond_graph.nodes()[p[1]]["name"] + name_mid_2 = bond_graph.nodes()[p[2]]["name"] + name_j = bond_graph.nodes()[p[3]]["name"] + + for a in config.dihedrals: + match_forward = ( + name_i == a.atom_1 + and name_mid_1 == a.atom_2 + and name_mid_2 == a.atom_3 + and name_j == a.atom_4 + ) + if ( + match_forward + and [ + bond_graph.nodes()[p[3]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[i]["local_index"], + a.coeffs, + a.dih_type, + ] + not in bonds_4 + ): + bonds_4.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[3]]["local_index"], + a.coeffs, + a.dih_type, + ] + ) + if a.dih_type == 1: + bb_dihedral = len(bonds_4) + + if bb_dihedral: + bb_index.append(bb_dihedral - 1) + + return bonds_2, bonds_3, bonds_4, bb_index
+ + +
[docs]def prepare_index_based_bonds(molecules, topol): + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + resid = mol + 1 + top_summary = topol["system"]["molecules"] + resname = None + test_mol_number = 0 + for molname in top_summary: + test_mol_number += molname[1] + if resid <= test_mol_number: + resname = molname[0] + break + + if resname is None: + break + + if "bonds" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for bond in topol[resname]["bonds"]: + index_i = bond[0] - 1 + first_id + index_j = bond[1] - 1 + first_id + # bond[2] is the bond type, inherited by the itp format. Not used + equilibrium = bond[3] + strength = bond[4] + bonds_2.append([index_i, index_j, equilibrium, strength]) + + if "angles" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["angles"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + # angle[3] is the angle type, inherited by the itp format. Not used + equilibrium = np.radians(angle[4]) + strength = angle[5] + bonds_3.append([index_i, index_j, index_k, equilibrium, strength]) + + if "dihedrals" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["dihedrals"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + index_l = angle[3] - 1 + first_id + dih_type = angle[4] + coeff = angle[5] + if dih_type == 0 and isinstance(coeff[0], (float, int)): + coeff = propensity_potential_coeffs(coeff[0]) + elif dih_type == 1 and len(coeff) == 3: + coeff = np.array( + propensity_potential_coeffs(coeff[0][0]).tolist() + + coeff[1:] + ) + elif dih_type == 2: + coeff = np.array(coeff) + else: + coeff = np.insert(np.array(coeff), 2, np.zeros((2, 5)), axis=0) + bonds_4.append([index_i, index_j, index_k, index_l, coeff, dih_type, 0]) + return bonds_2, bonds_3, bonds_4
+ + +
[docs]def prepare_bonds(molecules, names, bonds, indices, config, topol=None): + """Rearrange the bond information for usage in compiled Fortran kernels + + Restructures the lists resulting from the execution of + :code:`prepare_bonds_old` into numpy arrays suitable for calls to optimized + Fortran code calculating bonded forces and energiesself. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2_atom_1 : (B,) numpy.ndarray + Local index of particle 1 for each of :code:`B` constructed + two-particle bonds. + bonds_2_atom_2 : (B,) numpy.ndarray + Local index of particle 2 for each of :code:`B` constructed + two-particle bonds. + bonds_2_equilibrium : (B,) numpy.ndarray + Equilibrium distance for each of :code:`B` constructed two-particle + bonds. + bonds_2_strength : (B,) numpy.ndarray + Bond strength for each of :code:`B` constructed two-particle + bonds. + bonds_3_atom_1 : (A,) numpy.ndarray + Local index of particle 1 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_2 : (A,) numpy.ndarray + Local index of particle 2 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_3 : (A,) numpy.ndarray + Local index of particle 3 for each of :code:`A` constructed + three-particle bonds. + bonds_3_equilibrium : (A,) numpy.ndarray + Equilibrium angle for each of :code:`A` constructed three-particle + bonds. + bonds_3_strength : (A,) numpy.ndarray + Bond strength for each of :code:`A` constructed three-particle + bonds. + bonds_4_atom_1 : (D,) numpy.ndarray + Local index of particle 1 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_2 : (D,) numpy.ndarray + Local index of particle 2 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_3 : (D,) numpy.ndarray + Local index of particle 3 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_4 : (D,) numpy.ndarray + Local index of particle 4 for each of :code:`D` constructed + four-particle bonds. + bonds_4_coeff : (D,) numpy.ndarray + Cosine series coefficients for each of :code:`D` constructed + four-particle bonds. + bonds_4_type : (D,) numpy.ndarray + Dihedral type for each of :code:`D` constructed four-particle + bonds. + bonds_4_last : (D,) numpy.ndarray + Flags indicating if :code:`dih_type` is :code:`1` for each of :code:`D` + constructed four-particle bonds. + + See also + -------- + prepare_bonds_old : + Used internally to reconstruct the bonded interactions types from the + connectivity information in the structure/topology input file and the + bonded types specified in the configuration file. + """ + if topol is not None: + bonds_2, bonds_3, bonds_4 = prepare_index_based_bonds( + molecules, topol + ) + else: + bonds_2, bonds_3, bonds_4, bb_index = prepare_bonds_old( + molecules, names, bonds, indices, config + ) + + # Bonds + bonds_2_atom1 = np.empty(len(bonds_2), dtype=int) + bonds_2_atom2 = np.empty(len(bonds_2), dtype=int) + bonds_2_equilibrium = np.empty(len(bonds_2), dtype=np.float64) + bonds_2_strength = np.empty(len(bonds_2), dtype=np.float64) + for i, b in enumerate(bonds_2): + bonds_2_atom1[i] = b[0] + bonds_2_atom2[i] = b[1] + bonds_2_equilibrium[i] = b[2] + bonds_2_strength[i] = b[3] + + # Angles + bonds_3_atom1 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom2 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom3 = np.empty(len(bonds_3), dtype=int) + bonds_3_equilibrium = np.empty(len(bonds_3), dtype=np.float64) + bonds_3_strength = np.empty(len(bonds_3), dtype=np.float64) + for i, b in enumerate(bonds_3): + bonds_3_atom1[i] = b[0] + bonds_3_atom2[i] = b[1] + bonds_3_atom3[i] = b[2] + bonds_3_equilibrium[i] = b[3] + bonds_3_strength[i] = b[4] + # Dihedrals + bonds_4_atom1 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom2 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom3 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom4 = np.empty(len(bonds_4), dtype=int) + number_of_coeff = 6 + len_of_coeff = 5 + bonds_4_coeff = np.empty( + (len(bonds_4), number_of_coeff, len_of_coeff), dtype=np.float64 + ) + bonds_4_type = np.empty(len(bonds_4), dtype=int) + bonds_4_last = np.zeros(len(bonds_4), dtype=int) + for i, b in enumerate(bonds_4): + bonds_4_atom1[i] = b[0] + bonds_4_atom2[i] = b[1] + bonds_4_atom3[i] = b[2] + bonds_4_atom4[i] = b[3] + bonds_4_coeff[i] = np.resize(b[4], (number_of_coeff, len_of_coeff)) + bonds_4_type[i] = b[5] + if topol is not None: + bonds_4_last[i] = b[6] + if topol is None: + bonds_4_last[bb_index] = 1 + + return ( + bonds_2_atom1, + bonds_2_atom2, + bonds_2_equilibrium, + bonds_2_strength, + bonds_3_atom1, + bonds_3_atom2, + bonds_3_atom3, + bonds_3_equilibrium, + bonds_3_strength, # noqa: E501 + bonds_4_atom1, + bonds_4_atom2, + bonds_4_atom3, + bonds_4_atom4, + bonds_4_coeff, + bonds_4_type, + bonds_4_last, # noqa: E501 + )
+ + +
[docs]def compute_bond_forces__plain(f_bonds, r, bonds_2, box_size): + """Computes forces resulting from bonded interactions + + .. deprecated:: 1.0.0 + :code:`compute_bond_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_bonds.fill(0.0) + energy = 0.0 + + for i, j, r0, k in bonds_2: + ri = r[i, :] + rj = r[j, :] + rij = rj - ri + + # Apply periodic boundary conditions to the distance rij + for dim in range(len(rij)): + rij[dim] -= box_size[dim] * np.around(rij[dim] / box_size[dim]) + dr = np.linalg.norm(rij) + df = -k * (dr - r0) + f_bond_vector = df * rij / dr + f_bonds[i, :] -= f_bond_vector + f_bonds[j, :] += f_bond_vector + + energy += 0.5 * k * (dr - r0) ** 2 + return energy
+ + +
[docs]def compute_angle_forces__plain(f_angles, r, bonds_3, box_size): + """Computes forces resulting from angular interactions + + .. deprecated:: 1.0.0 + :code:`compute_angle_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_angles.fill(0.0) + energy = 0.0 + + for a, b, c, theta0, k in bonds_3: + ra = r[a, :] - r[b, :] + rc = r[c, :] - r[b, :] + + for dim in range(len(ra)): + ra[dim] -= box_size[dim] * np.around(ra[dim] / box_size[dim]) + rc[dim] -= box_size[dim] * np.around(rc[dim] / box_size[dim]) + + xra = 1.0 / np.sqrt(np.dot(ra, ra)) + xrc = 1.0 / np.sqrt(np.dot(rc, rc)) + ea = ra * xra + ec = rc * xrc + + cosphi = np.dot(ea, ec) + theta = np.arccos(cosphi) + xsinph = 1.0 / np.sqrt(1.0 - cosphi**2) + + d = theta - theta0 + f = -k * d + + xrasin = xra * xsinph * f + xrcsin = xrc * xsinph * f + + fa = (ea * cosphi - ec) * xrasin + fc = (ec * cosphi - ea) * xrcsin + + f_angles[a, :] += fa + f_angles[c, :] += fc + f_angles[b, :] -= fa + fc + # f_angles[b, :] += -(fa + fc) + + energy -= 0.5 * f * d + + return energy
+ + +
[docs]def compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size): + """Computes forces resulting from dihedral interactions + + .. deprecated:: 1.0.0 + :code:`compute_dihedral_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_dihedrals.fill(0.0) + energy = 0.0 + + for a, b, c, d, coeffs, phase in bonds_4: + f = r[a, :] - r[b, :] + g = r[b, :] - r[c, :] + h = r[d, :] - r[c, :] + + for dim in range(3): + f -= box_size[dim] * np.around(f[dim] / box_size[dim]) + g -= box_size[dim] * np.around(g[dim] / box_size[dim]) + h -= box_size[dim] * np.around(h[dim] / box_size[dim]) + + v = np.cross(f, g) + w = np.cross(h, g) + vv = np.dot(v, v) + ww = np.dot(w, w) + gn = np.linalg.norm(g) + + cosphi = np.dot(v, w) + sinphi = np.dot(np.cross(v, w), g) / gn + phi = np.arctan2(sinphi, cosphi) + + fg = np.dot(f, g) + hg = np.dot(h, g) + sc = v * fg / (vv * gn) - w * hg / (ww * gn) + + df = 0 + + for m in range(len(coeffs[0])): + energy += coeffs[0][m] * (1 + np.cos(m * phi - coeffs[1][m])) + df += m * coeffs[0][m] * np.sin(m * phi - coeffs[1][m]) + + force_on_a = df * gn * v / vv + force_on_d = df * gn * w / ww + + f_dihedrals[a, :] -= force_on_a + f_dihedrals[b, :] += df * sc + force_on_a + f_dihedrals[c, :] -= df * sc + force_on_d + f_dihedrals[d, :] += force_on_d + return energy
+ + +
[docs]def dipole_forces_redistribution( + f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb +): + """Redistribute electrostatic forces calculated from topologically + reconstructed ghost dipole point charges to the backcone atoms of the protein. + """ + f_on_bead.fill(0.0) + for i, j, k, l, fd, matrix, dih_type, is_last in zip( + a, b, c, d, f_dipoles, trans_matrices, type_array, last_bb + ): + if dih_type == 1: + sum_force = fd[0] + fd[1] + diff_force = fd[0] - fd[1] + f_on_bead[i] += matrix[0] @ diff_force # Atom A + f_on_bead[j] += matrix[1] @ diff_force + 0.5 * sum_force # Atom B + f_on_bead[k] += matrix[2] @ diff_force + 0.5 * sum_force # Atom C + + if is_last == 1: + sum_force = fd[2] + fd[3] + diff_force = fd[2] - fd[3] + f_on_bead[j] += matrix[3] @ diff_force + f_on_bead[k] += matrix[4] @ diff_force + 0.5 * sum_force + f_on_bead[l] += matrix[5] @ diff_force + 0.5 * sum_force
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/_modules/hymd/hamiltonian.html b/v1.0.2/_modules/hymd/hamiltonian.html new file mode 100644 index 00000000..30d8d158 --- /dev/null +++ b/v1.0.2/_modules/hymd/hamiltonian.html @@ -0,0 +1,784 @@ + + + + + + hymd.hamiltonian — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.hamiltonian

+"""Interaction energy functionals.
+
+Implements field--particle interaction energy functionals depending on the
+field configuration. Extending HyMD with a new Hamiltonian is done by
+subclassing the :code:`Hamiltonian` superclass with logic intialized in the
+constructor.
+
+The grid-independent filtering function is defined in the :code:`Hamiltonian`
+superclass constructor. Hijack :code:`self.H` in a subclass to change the
+filter.
+"""
+import numpy as np
+import sympy
+
+
+
[docs]class Hamiltonian: + """Interaction energy functional superclass""" + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + self.config = config + self._setup()
+ +
[docs] def _setup(self): + """Superclass setup + + Sets up the grid-independent filtering function :code:`H`, and the + SymPy logic for symbolically differentiating interaction energy + functionals in Hamiltonian subclasses. + """ + if not hasattr(self.config, "simulation_volume"): + self.config.simulation_volume = np.prod(np.asarray(self.config.box_size)) + if not self.config.barostat: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.config.a = self.config.rho0 + if not self.config.rho0: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.phi = sympy.var("phi:%d" % (self.config.n_types)) + k = sympy.var("k:%d" % (3)) + + # electrostatics variables + self.psi = sympy.var("psi") + self.phi_q = sympy.var("phi_q") + if not self.config.self_energy: + self.config.self_energy = 0.0 + + def fourier_space_window_function(k): + return sympy.functions.elementary.exponential.exp( + -0.5 + * self.config.sigma**2 + * (k0**2 + k1**2 + k2**2) # noqa: F821, E501 + ) + + self.window_function_lambda = sympy.lambdify( + [k], fourier_space_window_function(k) + ) + + def H(k, v): + return v * self.window_function_lambda(k) + + self.H = H
+ + +
[docs]class SquaredPhi(Hamiltonian): + """Simple squared density interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + \\sum_k \\tilde\\phi_k + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`rho_0` is the + average density of the fully homogenous system. Expressing the species + densities in terms of fluctuations from the average, + + .. math:: + + \\mathrm{d}\\tilde\\phi_k = \\rho_0 - \\tilde\\phi_k, + + it is evident that this interaction energy functional is a slight change of + the :code:`DefaultNoChi` Hamiltonian, as the expanded interaction energy + density becomes + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + 6\\rho_0\\left[ + \\sum_k \\mathrm{d}\\tilde\\phi_k + \\right] + + + 9\\rho_0^2 + + + \\sum_k \\mathrm{d}\\tilde\\phi_k^2 + + + \\prod_{k\\not=l} + \\mathrm{d}\\tilde\\phi_k \\mathrm{d}\\tilde\\phi_l + \\right), + + identical to :code:`DefaultNoChi` apart from a constant energy shift + :math:`9\\rho_0^2`(which does not impact dynamics) and the + :math:`\\rho_0`--:math:`\\mathrm{d}\\tilde\\phi_k` cross-terms. These + cross-terms constitute contributions to the energy linear in + :math:`\\mathrm{d}\\tilde\\phi_k` absent in :code:`DefaultNoChi`, which has + only quadratic terms present. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(SquaredPhi, self).__init__(config) + super(SquaredPhi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0): + return 0.5 / (kappa * rho0) * (sum(phi)) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + ): + V_incompressibility = 1 / (kappa * rho0) * sum(phi) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultNoChi(Hamiltonian): + """Incompressibility-only interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. The :code:`SquaredPhi` Hamiltonian implements a similar + functional with an additional linear term component depending on + + .. math:: + + \\mathmr{d}\\tilde\\phi_k = \\tilde\\phi_k - \\rho_0 + + and not :math:`\\mathrm{d}\\tilde\\phi_k^2`. No explicit inter-species + interaction is present apart from the indirect interaction through the + incompressibility. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + hymd.input_parser.Config : + Configuration dataclass handler. + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultNoChi, self).__init__(config) + super(DefaultNoChi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0, a=self.config.a): + return 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultWithChi(Hamiltonian): + """Incompressibility and :math:`\\chi`-interactions energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = + \\frac{1}{2\\rho_0} + \\sum_{k,l}\\chi_{kl} \\tilde\\phi_k \\tilde\\phi_l + + + \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. :math:`\\chi_{ij}` is the Flory-Huggins-like + inter-species mixing energy. + """ + +
[docs] def __init__(self, config, unique_names, type_to_name_map): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultWithChi, self).__init__(config) + super(DefaultWithChi, self)._setup() + self.setup(unique_names, type_to_name_map)
+ +
[docs] def setup(self, unique_names, type_to_name_map): + """Setup the interaction energy potential and the external potential + + Parameters + ---------- + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + """ + self.type_to_name_map = type_to_name_map + self.chi_type_dictionary = { + tuple(sorted([c.atom_1, c.atom_2])): c.interaction_energy + for c in self.config.chi + } + self.phi_laplacian = [ + sympy.var("phi_laplacian%d(0:%d)" % (t, 3)) + for t in range(self.config.n_types) + ] + + def w( + phi, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + interaction = 0.0 + for i in range(self.config.n_types): + for j in range(i + 1, self.config.n_types): + ni = type_to_name_map[i] + nj = type_to_name_map[j] + names = sorted([ni, nj]) + c = chi_type_dictionary[tuple(names)] + + interaction += c * phi[i] * phi[j] / rho0 + incompressibility = 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + return incompressibility + interaction + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + t, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + + V_interaction = 0.0 + nk = type_to_name_map[t] + for i in range(self.config.n_types): + ni = type_to_name_map[i] + names = sorted([nk, ni]) + if ni != nk: + c = chi_type_dictionary[tuple(names)] + else: + c = 0.0 + # uncomment to count diagonal chi terms: + # c = chi_type_dictionary[tuple(names)] + V_interaction += c * phi[i] / rho0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[t])) + for t in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +def get_hamiltonian(config): + """Return appropriate Hamiltonian object based on the + config.hamiltonian string. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ---------- + hamiltonian : Hamiltonian + Hamiltonian object. + """ + if config.hamiltonian.lower() == "defaultnochi": + hamiltonian = DefaultNoChi(config) + elif config.hamiltonian.lower() == "defaultwithchi": + hamiltonian = DefaultWithChi( + config, config.unique_names, config.type_to_name_map + ) + elif config.hamiltonian.lower() == "squaredphi": + hamiltonian = SquaredPhi(config) + + return hamiltonian +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/_modules/hymd/input_parser.html b/v1.0.2/_modules/hymd/input_parser.html new file mode 100644 index 00000000..9b07b4a3 --- /dev/null +++ b/v1.0.2/_modules/hymd/input_parser.html @@ -0,0 +1,1622 @@ + + + + + + hymd.input_parser — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.input_parser

+"""Parses and handles the configuration information provided for the simulation
+"""
+import copy
+import tomli
+import datetime
+import logging
+import warnings
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass, field
+from typing import List, Union, ClassVar
+from .force import Bond, Angle, Dihedral, Chi, Dielectric_type, propensity_potential_coeffs
+from .barostat import Target_pressure
+from .logger import Logger
+
+
+
[docs]@dataclass +class Config: + """Configuration object + + Handles and verifies the simulation configuration specified in the + configuration file. + + Attributes + ---------- + gas_constant : float + Constant value of the gas constant, R (equivalently the Boltzmann + constant) in the units used internally in HyMD. + coulomb_constant : float + Constant value of the Coulomb constant which converts electric field + values to forces and electric potential values to energies in the units + used internally in HyMD. + n_steps: int + Number of time steps in the simulation. + time_step: float + *Outer* time step used in the simulation. If the rRESPA intergrator is + used, the *inner* time step (the time step used in the integration of + intramolecular bending, stretching, and torsional forces) is + :code:`time_step / respa_inner`. + box_size : list[float] or (D,) numpy.ndarray + Simulation box size of simulation in :code:`D` dimensions in units of + nanometers. + mesh_size : list[int] or int or numpy.ndarray + Number of grid points used for the discrete density grid. + sigma : float + Filter width representing the effective coarse-graining level of the + particles in the simulation. + kappa : float + Compressibility parameter used in the relaxed incompressibility term in + the interaction energy functional. + n_print : int, optional + Frequency of trajectory/energy output to the H5MD trajectory/energy + output file (in units of number of time steps). + tau : float, optional + The time scale of the CSVR thermostat coupling. + start_temperature : float, optional + Generate starting temperature by assigning all particle velocities + randomly according to the Maxwell-Boltzmann distribution at + :code:`start_temperature` Kelvin prior to starting the simulation. + target_temperature : float, optional + Couple the system to a heat bath at :code:`target_temperature` Kelvin. + mass : float, optional + Mass of the particles in the simulation. + hamiltonian : str, optional + Specifies the interaction energy functional :math:`W[\\tilde\\phi]` + for use with the particle-field interactions. Options: + :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`. + domain_decomposition : int, optional + Specifies the interval (in time steps) of domain decomposition + exchange, involving all MPI ranks sending and receiving particles + according to the particles’ positions in the integration box and the + MPI ranks’ assigned domain. + integrator : str, optional + Specifies the time integrator used in the simulation. Options: + :code:`velocity-verlet` or :code:`respa`. + respa_inner : int, optional + The number of inner time steps in the rRESPA integrator. This denotes + the number of intramolecular force calculations (stretching, bending, + torsional) are performed between each impulse applied from the field + forces. + file_name : str, optional + File path of the parsed configuration file. + name : str, optional + Name for the simulation. + tags : list[str], optional + Tags for the simulation. + bonds : list[Bond], optional + Specifies harmonic stretching potentials between particles in the + same molecule. + angle_bonds : list[Angle], optional + Specifies harmonic angular bending potentials between particles in the + same molecule. + dihedrals : list[Dihedral], optional + Specifies four-particle torsional potentials by cosine series. + chi : list[Chi], optional + Specifies :math:`\\chi`-interaction parameters between particle + species. + n_particles : int, optional + Specifies the total number of particles in the input. Optional keyword + for validation, ensuring the input HDF5 topology has the correct number + of particles and molecules. + max_molecule_size : int, optional + Maximum size of any single molecule in the system. Used to speed up + distribution of particles onto MPI ranks in a parallel fashion. + n_flush : int, optional + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be + written to disk (in units of number of :code:`n_print`). + thermostat_work : float + Work performed by the thermostat on the system. + thermostat_coupling_groups : list[str], optional + Specifies individual groups coupling independently to the CSVR + thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and + :code:`"C"` type particles, + :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would + thermalise types :code:`"A"` and :code:`"B"` together and couple + :code:`"C"` type particles to a different thermostat (all individual + thermostats are at the same temperature, i.e. target_temperature + Kelvin). + initial_energy : float + Value of the total energy prior to the start of the simulation. + cancel_com_momentum : int, optional + If :code:`True`, the total linear momentum of the center of mass is + removed before starting the simulation. If an integer is specifed, the + total linear momentum of the center of mass is removed every + :code:`remove_com_momentum` time steps. If :code:`False`, the linear + momentum is never removed. + coulombtype : str, optional + Specifies the type of electrostatic Coulomb interactions in the system. + The strength of the electrostatic forces is modulated by the relative + dielectric constant of the simulation medium, specified with the + :code:`dielectric_const` keyword. Charges for individual particles are + specified in the structure/topology HDF5 input file, not in the + configuration file. If no charges (or peptide backbone dipoles) are + present, the electrostatic forces will not be calculated even if this + keyword is set to :code:`"PIC_Spectral"`. + dielectric_const : float, optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. When + using helical propensity dihedrals, this keyword must be specified—even + if electrostatics are not included with the :code:`coulombtype` + keyword. + dielectric_type: list[float], optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. The list assigns + relative dielectric values to each bead type, and an anisotropic + dielectric function is obtained from a weighted average. + + + See also + -------- + hymd.input_parser.Bond : + Two-particle bond type dataclass. + hymd.input_parser.Angle : + Three-particle bond type dataclass. + hymd.input_parser.Dihedral : + Four-particle bond type dataclass. + """ + + gas_constant: ClassVar[float] = 0.0083144621 # kJ mol-1 K-1 + coulomb_constant: ClassVar[float] = 138.935458 # kJ nm mol-1 e-2 + + n_steps: int + time_step: float + mesh_size: Union[Union[List[int], np.ndarray], int] + sigma: float + kappa: float + + dtype: np.dtype = None + box_size: Union[List[float], np.ndarray] = None + n_print: int = None + tau: float = None + start_temperature: Union[float, bool] = None + target_temperature: Union[float, bool] = None + mass: float = None + hamiltonian: str = None + domain_decomposition: Union[int, bool] = None + integrator: str = None + respa_inner: int = 1 + file_name: str = "<config file path unknown>" + name: str = None + tags: List[str] = field(default_factory=list) + bonds: List[Bond] = field(default_factory=list) + angle_bonds: List[Angle] = field(default_factory=list) + dihedrals: List[Dihedral] = field(default_factory=list) + chi: List[Chi] = field(default_factory=list) + n_particles: int = None + max_molecule_size: int = None + n_flush: int = None + thermostat_work: float = 0.0 + thermostat_coupling_groups: List[List[str]] = field(default_factory=list) + initial_energy: float = None + cancel_com_momentum: Union[int, bool] = False + coulombtype: str = None + convergence_type: str = None + pol_mixing: float = None + dielectric_const: float = None + conv_crit: float = None + dielectric_type: List[Dielectric_type] = field(default_factory=list) + self_energy: float = None + type_charges: Union[List[float], np.ndarray] = None + + # For NPT runs + rho0: float = None + a: float = None + pressure: bool = False + barostat: str = None + barostat_type: str = None + tau_p: float = None + target_pressure: List[Target_pressure] = field(default_factory=list) + n_b: int = None + m: List[float] = field(default_factory=list) + + def __str__(self): + target_pressure_str = "\ttarget_pressure:\n" + "".join( + "\t\tP_L: " + + f"{self.target_pressure.P_L}\n" + + "\t\tP_N: " + + f"{self.target_pressure.P_N}\n" + ) + bonds_str = "\tbonds:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " f"{k.equilibrium}, {k.strength}\n") + for k in self.bonds + ] + ) + angle_str = "\tangle_bonds:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3}: " + + f"{k.equilibrium}, {k.strength}\n" + ) + for k in self.angle_bonds + ] + ) + dihedrals_str = "\tdihedrals:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: " + # This might need to be fixed/made prettier, probably + # there's an easier way + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ).join( + map( + str, + [ + [round(num, 3) for num in c_in] + if isinstance(c_in, list) + else c_in + for c_in in k.coeffs + ], + ) + ) + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ) + + f"dih_type = {k.dih_type}\n" + ) + for k in self.dihedrals + ] + ) + chi_str = "\tchi:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " + f"{k.interaction_energy}\n") + for k in self.chi + ] + ) + + """ If dielectric wanted as dictionary + dielectric_type_str = "\tdielectric_type:\n" + "".join( + [ + (f"\t\t{k.atom_1}: " + f"{k.dielectric_value}\n") + for k in self.dielectric_type + ] + ) + + """ + + thermostat_coupling_groups_str = "" + if any(self.thermostat_coupling_groups): + thermostat_coupling_groups_str = ( + "\tthermostat_coupling_groups:\n" + + "".join( + [ + "\t\t" + ", ".join([f"{n}" for n in ng]) + "\n" + for ng in self.thermostat_coupling_groups + ] + ) + ) + + ret_str = f'\n\n\tConfig: {self.file_name}\n\t{50 * "-"}\n' + for k, v in self.__dict__.items(): + if k not in ( + "target_pressure", + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "thermostat_coupling_groups", + ): + ret_str += f"\t{k}: {v}\n" + ret_str += ( + target_pressure_str + + bonds_str + + angle_str + + dihedrals_str + + chi_str + + thermostat_coupling_groups_str + ) + return ret_str
+ + +
[docs]def read_config_toml(file_path): + with open(file_path, "r") as in_file: + file_content = in_file.read() + return file_content
+ +
[docs]def parse_config_toml(toml_content, file_path=None, comm=MPI.COMM_WORLD): + config_dict = {} + + # read toml to a dictionary + toml_content = tomli.loads(toml_content) + + # Defaults = None + for n in ( + "box_size", + "n_print", + "tau", + "start_temperature", + "target_temperature", + "mass", + "hamiltonian", + "domain_decomposition", + "integrator", + "name", + "n_particles", + "max_molecule_size", + "coulombtype", + "convergence_type", + "dielectric_const", + "pol_mixing", + "conv_crit", + "dielectric_type", + "n_b", + "box_size", + "n_flush", + "self_energy", + "dtype", + ): + config_dict[n] = None + + # Defaults = [] + + for n in ( + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "tags", + "m", + "dielectric_type", + "target_pressure", + "type_charges", + ): + config_dict[n] = [] + + # Defaults: bool + config_dict["pressure"] = False + + # Flatten the .toml dictionary, ignoring the top level [tag] directives (if + # any). + for k, v in toml_content.items(): + if isinstance(v, dict): + if k == "nn": # Don't parse diff-hymd optimization options + continue + for nested_k, nested_v in v.items(): + config_dict[nested_k] = nested_v + else: + config_dict[k] = v + for k, v in config_dict.items(): + if k == "bonds": + config_dict["bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["bonds"][i] = Bond( + atom_1=b[0], + atom_2=b[1], + equilibrium=b[2], + strength=b[3], + ) + if k == "angle_bonds": + config_dict["angle_bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["angle_bonds"][i] = Angle( + atom_1=b[0], + atom_2=b[1], + atom_3=b[2], + equilibrium=b[3], + strength=b[4], + ) + if k == "dihedrals": + config_dict["dihedrals"] = [None] * len(v) + for i, b in enumerate(v): + try: + dih_type = int(b[2][0]) + except IndexError: + Logger.rank0.log( + logging.WARNING, "Dihedral type not provided, defaulting to 0." + ) + dih_type = 0 + + # Probably it's better to move this in check_dihedrals? + wrong_len = len(b[1]) not in (1, 2) + wrong_type_1 = len(b[1]) == 1 and not isinstance(b[1][0], float) + wrong_type_2 = len(b[1]) == 2 and not isinstance(b[1][0], list) + if wrong_len or wrong_type_1 or wrong_type_2: + err_str = ( + "The coefficients specified for the dihedral type " + "(0) do not match the correct structure. Either " + "use [lambda] or [[cn_prop], [dn_prop]], or select" + " the correct dihedral type." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise RuntimeError(err_str) + + # FIXME: this is messy af, I don't like it + if dih_type == 0 and isinstance(b[1][0], (float, int)): + coeff = propensity_potential_coeffs(b[1][0]) + elif dih_type == 1 and len(b[1]) == 3: + coeff = np.array( + propensity_potential_coeffs(b[1][0][0]).tolist() + + b[1][1:] + ) + elif dih_type == 2: + coeff = np.array(b[1]) + else: + coeff = np.insert(np.array(b[1]), 2, np.zeros((2, 5)), axis=0) + + config_dict["dihedrals"][i] = Dihedral( + atom_1=b[0][0], + atom_2=b[0][1], + atom_3=b[0][2], + atom_4=b[0][3], + coeffs=coeff, + dih_type=dih_type, + ) + if k == "chi": + config_dict["chi"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0], c[1]]) + config_dict["chi"][i] = Chi( + atom_1=c_[0], atom_2=c_[1], interaction_energy=c[2] + ) + + """ + if k == "dielectric_type": + config_dict["dielectric_type"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0][0]]) + config_dict["dielectric_type"][i] = Dielectric_type( + atom_1=c_[0], dielectric_value=c[1][0] + ) + """ + if k == "target_pressure": + if len(v) == 2: + config_dict["target_pressure"] = Target_pressure( + P_L=v[0], + P_N=v[1], # check condition # V array (still read as array?) + ) + elif len(v) == 1: + config_dict["target_pressure"] = Target_pressure(P_L=v[0], P_N=None) + else: + config_dict["target_pressure"] = Target_pressure(P_L=None, P_N=None) + + if file_path is not None: + config_dict["file_name"] = file_path + + for n in ( + "n_steps", "time_step", "mesh_size", "sigma", "kappa" + ): + if n not in config_dict: + err_str = ( + f"No {n} specified in config file {file_path}. Unable to start" + f" simulation." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return Config(**config_dict)
+ + +
[docs]def check_n_particles(config, indices, comm=MPI.COMM_WORLD): + n_particles = comm.allreduce(len(indices), MPI.SUM) + if config.n_particles is None: + config = copy.deepcopy(config) + config.n_particles = n_particles + info_str = ( + f"No n_particles found in toml file {config.file_name}, defaulting" + f" to indices.shape ({n_particles})" + ) + Logger.rank0.log(logging.INFO, info_str) + return config + + if n_particles != config.n_particles: + warn_str = ( + f"n_particles in {config.file_name} ({config.n_particles}) does " + "not match the shape of the indices array in the .HDF5 file " + f"({n_particles}). Defaulting to using indices.shape " + f"({n_particles})" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.n_particles = n_particles + return config
+ + +
[docs]def check_max_molecule_size(config, comm=MPI.COMM_WORLD): + if config.max_molecule_size is None: + info_str = ( + f"No max_molecule_size found in toml file {config.file_name}, " + f"defaulting to 201" + ) + Logger.rank0.log(logging.INFO, info_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + + if config.max_molecule_size < 1: + warn_str = ( + f"max_molecule_size in {config.file_name} must be a positive " + f"integer, not {config.max_molecule_size}, defaulting to 201" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + return config
+ + +def _find_unique_names(config, names, comm=MPI.COMM_WORLD): + unique_names = np.unique(names) + receive_buffer = comm.gather(unique_names, root=0) + + gathered_unique_names = None + if comm.Get_rank() == 0: + gathered_unique_names = np.unique(np.concatenate(receive_buffer)) + unique_names = comm.bcast(gathered_unique_names, root=0) + unique_names = sorted([n.decode("UTF-8") for n in unique_names]) + config.unique_names = unique_names + config.n_types = len(unique_names) + return config + + +def _setup_type_to_name_map(config, names, types, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + name_to_type_ = {} + for n, t in zip(names, types): + n = n.decode("utf-8") + if n not in name_to_type_: + name_to_type_[n] = t + receive_buffer = comm.gather(name_to_type_, root=0) + gathered_dict = None + if comm.Get_rank() == 0: + gathered_dict = {} + for d in receive_buffer: + for k, v in d.items(): + if k not in gathered_dict: + gathered_dict[k] = v + else: + assert v == gathered_dict[k] + name_to_type_map = comm.bcast(gathered_dict, root=0) + config.name_to_type_map = name_to_type_map + config.type_to_name_map = {v: k for k, v in name_to_type_map.items()} + return config + + +
[docs]def check_bonds(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for b in config.bonds: + if b.atom_1 not in unique_names or b.atom_2 not in unique_names: + missing_str = "" + if b.atom_1 not in unique_names: + if b.atom_2 not in unique_names: + if b.atom_1 == b.atom_2: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"neither {b.atom_1}, {b.atom_2} atoms" + else: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"no {b.atom_2} atoms" + + warn_str = ( + f"Bond type {b.atom_1}--{b.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_angles(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for a in config.angle_bonds: + if ( + a.atom_1 not in unique_names + or a.atom_2 not in unique_names + or a.atom_3 not in unique_names + ): + missing = [ + a.atom_1 not in unique_names, + a.atom_2 not in unique_names, + a.atom_3 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([a.atom_1, a.atom_2, a.atom_3]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Angle bond type {a.atom_1}--{a.atom_2}--{a.atom_3} " + f"specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_dihedrals(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for d in config.dihedrals: + if ( + d.atom_1 not in unique_names + or d.atom_2 not in unique_names + or d.atom_3 not in unique_names + or d.atom_4 not in unique_names + ): + missing = [ + d.atom_1 not in unique_names, + d.atom_2 not in unique_names, + d.atom_3 not in unique_names, + d.atom_4 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([d.atom_1, d.atom_2, d.atom_3, d.atom_4]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Dihedral type {d.atom_1}--{d.atom_2}--{d.atom_3}--{d.atom_4}" + f" specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_chi(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for c in config.chi: + if c.atom_1 not in unique_names or c.atom_2 not in unique_names: + missing_str = "" + if c.atom_1 not in unique_names: + if c.atom_2 not in unique_names: + if c.atom_1 == c.atom_2: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"neither {c.atom_1}, {c.atom_2} atoms" + else: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"no {c.atom_2} atoms" + + warn_str = ( + f"Chi interaction {c.atom_1}--{c.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + for i, n in enumerate(unique_names): + for m in unique_names[i + 1 :]: + found = False + for c in config.chi: + if (c.atom_1 == n and c.atom_2 == m) or ( + c.atom_1 == m and c.atom_2 == n + ): + found = True + if not found: + config.chi.append(Chi(atom_1=n, atom_2=m, interaction_energy=0.0)) + warn_str = ( + f"Atom types {n} and {m} found in the " + f"system, but no chi interaction {n}--{m} " + f"specified in {config.file_name}. Defaulting to " + f"chi[{n}, {m}] = 0" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_box_size(config, input_box, comm=MPI.COMM_WORLD): + if config.box_size is not None: + config.box_size = np.array(config.box_size, dtype=np.float32) + if input_box.all() and not np.allclose(config.box_size, input_box, atol=0.009): + err_str = ( + f"Box size specified in {config.file_name}: " + f"{config.box_size} does not match input box:" + f"{input_box}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + else: + if input_box.all(): + config.box_size = input_box + else: + err_str = f"No box information found" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + for b in config.box_size: + if b <= 0.0: + err_str = ( + f"Invalid box size specified in {config.file_name}: " + f"{config.box_size}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return config
+ + +
[docs]def check_integrator(config, comm=MPI.COMM_WORLD): + if config.integrator.lower() not in ("velocity-verlet", "respa"): + err_str = ( + f"Invalid integrator specified in {config.file_name}: " + f'{config.integrator}. Available options "velocity-verlet" or ' + f'"respa".' + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + if config.integrator.lower() == "respa": + if isinstance(config.respa_inner, float): + warn_str = ( + f"Number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner} specified " + f"as float, using {int(config.respa_inner)}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = int(config.respa_inner) + elif not isinstance(config.respa_inner, int): + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + + if config.respa_inner <= 0: + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + if config.integrator.lower() == "velocity-verlet" and config.respa_inner != 1: + warn_str = ( + f"Integrator type Velocity-Verlet specified in {config.file_name} " + f"and inner rRESPA time steps set to {config.respa_inner}. " + f"Using respa_inner = 1" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = 1 + + return config
+ + +
[docs]def check_hamiltonian(config, comm=MPI.COMM_WORLD): + valid_hamiltonians = ["defaultnochi", "defaultwithchi", "squaredphi"] + + if config.hamiltonian is None: + if len(config.chi) == 0: + warn_str = ( + f"No hamiltonian form and no chi interactions specified in " + f"{config.file_name}, defaulting to DefaultNoChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultNoChi" + else: + warn_str = ( + f"No hamiltonian form specified in {config.file_name}, but " + f"chi interactions are specified, defaulting to " + f"DefaultWithChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultWithChi" + elif config.hamiltonian.lower() not in valid_hamiltonians: + err_str = ( + f"The specified Hamiltonian {config.hamiltonian} was not " + f"recognized as a valid Hamiltonian." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise NotImplementedError(err_str) + + return config
+ + +
[docs]def check_n_flush(config, comm=MPI.COMM_WORLD): + if config.n_print: + if config.n_flush is None: + config.n_flush = 10000 // config.n_print + return config
+ + +
[docs]def check_n_print(config, comm=MPI.COMM_WORLD): + if ( + not isinstance(config.n_print, int) + and not isinstance(config.n_print, float) + and config.n_print is not None + ): + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if config.n_print is None or config.n_print <= 0: + config.n_print = False + elif not isinstance(config.n_print, int): + if isinstance(config.n_print, float): + warn_str = ( + f"n_print is a float ({config.n_print}), not int, using " + f"{int(round(config.n_print))}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + config.n_print = int(round(config.n_print)) + else: + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + return config
+ + +
[docs]def check_tau(config, comm=MPI.COMM_WORLD): + if config.tau is None and config.target_temperature is not None: + warn_str = "target temp specified but no tau, defaulting 0.7" + config.tau = 0.7 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_start_and_target_temperature(config, comm=MPI.COMM_WORLD): + """Validate provided starting and target thermostat temperatures + + Assesses the provided temperature target and ensures it is a non-negative + floating point number or :code:`False`. Ensures the starting temperature is + a non-negative floating point number or :code:`False`. + + If the value for either is :code:`None`, the returned configuration object + has the values defaulted to :code:`False` in each case. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ------- + validated_config : Config + Configuration object with validated :code:`target_temperature` and + :code:`start_temperature`. + """ + for t in ("start_temperature", "target_temperature"): + if getattr(config, t) is not None: + try: + if getattr(config, t) < 0: + warn_str = ( + f"{t} set to negative value ({getattr(config, t)}), " + f"defaulting to False" + ) + setattr(config, t, False) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + except TypeError as e: + err_str = ( + f"Could not interpret {t} = {repr(getattr(config, t))} as " + f"a number." + ) + raise TypeError(err_str) from e + + if config.start_temperature is None: + config.start_temperature = False + if config.target_temperature is None: + config.target_temperature = False + return config
+ + +
[docs]def check_mass(config, comm=MPI.COMM_WORLD): + if config.mass is None: + info_str = "no mass specified, defaulting to 72.0" + config.mass = 72.0 + Logger.rank0.log(logging.INFO, info_str) + elif not isinstance(config.mass, int) and not isinstance(config.mass, float): + err_str = ( + f"specified mass is invalid type {config.mass}, " f"({type(config.mass)})" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + elif config.mass < 0: + err_str = f"invalid mass specified, {config.mass}" + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + else: + config.mass = float(config.mass) + + return config
+ + +
[docs]def check_domain_decomposition(config, comm=MPI.COMM_WORLD): + dd = config.domain_decomposition + if dd is None or dd is False: + config.domain_decomposition = False + return config + + if isinstance(dd, int): + if dd < 0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + elif isinstance(dd, float): + if dd < 0.0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + else: + warn_str = ( + f"domain_decomposition ({config.domain_decomposition}) is not " + f"an integer, using {int(round(dd))}" + ) + config.domain_decomposition = int(round(dd)) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + else: + err_str = ( + f"invalid value for domain_decomposition " + f"({config.domain_decomposition}) use an integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + return config
+ + +
[docs]def check_name(config, comm=MPI.COMM_WORLD): + if config.name is None: + root_current_time = "" + if comm.Get_rank() == 0: + root_current_time = datetime.datetime.now().strftime("%m/%d/%Y, %H:%M:%S") + current_time = comm.bcast(root_current_time, root=0) + + if config.name is None: + config.name = "sim" + current_time + else: + config.name = str(config.name) + return config
+ + +
[docs]def check_NPT_conditions(config, comm=MPI.COMM_WORLD): + """ + Check validity of barostat_type, barostat, + a, rho0, target_pressure, tau_p + """ + if config.barostat is None: + if ( + config.tau_p is not None + or (config.target_pressure.P_L and config.target_pressure.P_N) is not None + ): + err_str = ( + "barostat not specified but config.tau_p " + "or config.target_pressure specified, cannot start simulation {config.barostat}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.a: + warn_str = "a specified but no barostat," "setting a to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.rho0: + warn_str = ( + "rho0 specified but no barostat," "setting rho0 to average density" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + if config.barostat is not None: + if not config.barostat_type: + config.barostat_type = "berendsen" + warn_str = "barostat_type not specified," "setting to berendsen" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.barostat != "isotropic" and config.barostat != "semiisotropic": + err_str = "barostat option not recognised. Valid options: isotropic, semiisotropic" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.target_pressure.P_L is None: + config.target_pressure.P_L = 1.0 # bar + config.target_pressure.P_N = None + if config.barostat == "semiisotropic": + config.target_pressure.P_N = 1.0 # bar + warn_str = ( + "barostat specified but no target_pressure, defaulting to 1.0 bar" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.tau_p is None: + if config.tau <= 0.1: + config.tau_p = config.tau * 10.0 + else: + config.tau_p = 1.0 + warn_str = "barostat specified but no tau_p, defaulting to " + str( + config.tau_p + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if not config.a: + err_str = "a not specified; cannot start simulation {config.a}" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if not config.rho0: + warn_str = "rho0 not specified;" "setting rho0 to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + return config
+ + +
[docs]def check_thermostat_coupling_groups(config, comm=MPI.COMM_WORLD): + if any(config.thermostat_coupling_groups): + found = [0 for _ in config.unique_names] + unique_names = [n for n in config.unique_names] + for i, group in enumerate(config.thermostat_coupling_groups): + for species in group: + try: + ind = unique_names.index(species) + found[ind] += 1 + except ValueError as e: + err_str = ( + f"Particle species {species} specified in thermostat " + f"coupling group {i}, but no {species} particles were " + "found in the system." + ) + raise ValueError(err_str) from e + if any([True if f > 1 else False for f in found]): + for i, f in enumerate(found): + if f > 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} specified in multiple " + "thermostat coupling groups; " + f"{config.thermostat_coupling_groups}." + ) + raise ValueError(err_str) + if not all([True if f == 1 else False for f in found]): + for i, f in enumerate(found): + if f != 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} not specified in any " + f"thermostat coupling group, but {species} particles " + "were found in the system" + ) + raise ValueError(err_str) + return config
+ + +
[docs]def check_m(config, comm=MPI.COMM_WORLD): + if config.m == []: + config.m = [1.0 for t in range(config.n_types)] + return config
+ + +
[docs]def check_n_b(config, comm=MPI.COMM_WORLD): + if config.n_b is None: + warn_str = f"config.n_b not specified." "Defaulting to 1" + config.n_b = 1 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_cancel_com_momentum(config, comm=MPI.COMM_WORLD): + if isinstance(config.cancel_com_momentum, int): + if config.cancel_com_momentum == 0 or config.cancel_com_momentum < 0: + config.cancel_com_momentum = False + elif not isinstance(config.cancel_com_momentum, bool): + err_str = ( + f"Could not interpret {config.cancel_com_momentum} as an integer " + f"or boolean." + ) + raise ValueError(err_str) + return config
+ + +
[docs]def sort_dielectric_by_type_id(config, charges, types): + """ + Creates a list of length N CG-particles, sorted after the charges from + the input HDF5 file. Used in file_io.py + """ + dielectric_val = np.zeros(config.n_types) + for j in range(config.n_types): + name = config.dielectric_type[j][0][0] + type_id = config.name_to_type_map[name] + dielectric_val[type_id] = config.dielectric_type[j][1][0] + config.dielectric_type = dielectric_val.copy() + + N = len(charges) + len_list = np.zeros(config.n_types) + dielectric_by_types = np.zeros(N) + for i in range(N): + dielectric_by_types[i] = dielectric_val[types[i]] + # print("types ", types) + # print("diel val", dielectric_by_types) + # print("charges", charges) + # print(config.name_to_type_map) + return dielectric_by_types # by types with each particle id
+ + +
[docs]def check_charges_types_list(config, types, charges, comm=MPI.COMM_WORLD): + """ + Creates a list of charge values of length types. + Charges are sorted according to type ID. Used in field.py. + # TODO: this is messy, we should fix it + """ + if charges is None: + config.type_charges = [0.0] * config.n_types + return config + + check_val = -100.0 # some random value that will never be encountered + charges_list = np.full(config.n_types, check_val) # gatherv cant handle None + rank = comm.Get_rank() + # print(charges_list) + for t_ in range(config.n_types): + if t_ in types: + charges_list[t_] = charges[types == t_][0] + + nprocs = int(comm.Get_size()) + recv_charges = None + if rank == 0: + recv_charges = np.full( + config.n_types * nprocs, check_val + ) # gatherv cant handle None + comm.Gather(charges_list, recv_charges, root=0) + + ## make a charges list + if rank == 0: + config_charges = np.zeros(config.n_types) + test_config = np.full(config.n_types, check_val) + for j in range(nprocs): + for i in range(config.n_types): + if recv_charges[i + j * config.n_types] != check_val: + config_charges[i] = recv_charges[i + j * config.n_types] + if np.any([test_config, config_charges]): + continue + else: + break + + # print(config_charges) + # print(config.name_to_type_map) + # print(charges[types == 0][0],charges[types == 1][0],charges[types == 2][0],charges[types == 3][0], + # charges[types == 4][0]) + else: + config_charges = np.zeros(config.n_types) + + comm.Bcast(config_charges, root=0) + # print("config_charges", config_charges , "rank", rank) + # print(recv_charges) + # rank = comm.Get_rank() + # print(all_charges) + config.type_charges = config_charges + return config
+ + +
[docs]def check_dielectric(config, comm=MPI.COMM_WORLD): + """ + Error handling for electrostatics. + Unit testing of toml/tomli input. + """ + err_str_const = "Dielectric constant not given." + if config.coulombtype == "PIC_Spectral": + assert config.dielectric_const != None, err_str_const + + err_str = "Dielectric list is empty." + if config.coulombtype == "PIC_Spectral_GPE": + assert len(config.dielectric_type) != 0, err_str + # default values + if config.pol_mixing is None: + config.pol_mixing = 0.6 + if config.conv_crit is None: + config.conv_crit = 1e-6 + return config
+ + +
[docs]def check_charges(config, charges, comm=MPI.COMM_WORLD): + """Check if charges across ranks sum to zero. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of floats with charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + """ + total_charge = comm.allreduce(np.sum(charges), MPI.SUM) + + if not np.isclose(total_charge, 0.0): + warn_str = ( + f"Charges in the input file do not sum to zero. " + f"Total charge is {total_charge}." + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + # if charges are ok, compute self energy + if config.coulombtype == "PIC_Spectral": + from .field import compute_self_energy_q + + config.self_energy = compute_self_energy_q(config, charges, comm=comm) + + return config
+ + +
[docs]def check_config( + config, indices, names, types, charges, input_box, comm=MPI.COMM_WORLD +): + """Performs various checks on the specfied config to ensure consistency + + Parameters + ---------- + config : Config + Configuration object. + indices : (N,) numpy.ndarray + Array of integer indices for :code:`N` particles. + names : (N,) numpy.ndarray + Array of string names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of integer type indices for :code:`N` particles. + charges : (N,) numpy.ndarray + Array of floats charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + + Returns + ------- + config : Config + Validated configuration object. + """ + config = _find_unique_names(config, names, comm=comm) + if types is not None: + config = _setup_type_to_name_map(config, names, types, comm=comm) + config = check_box_size(config, input_box, comm=comm) + config = check_integrator(config, comm=comm) + config = check_max_molecule_size(config, comm=comm) + config = check_tau(config, comm=comm) + config = check_start_and_target_temperature(config, comm=comm) + config = check_mass(config, comm=comm) + config = check_domain_decomposition(config, comm=comm) + config = check_name(config, comm=comm) + config = check_n_particles(config, indices, comm=comm) + config = check_chi(config, names, comm=comm) + config = check_bonds(config, names, comm=comm) + config = check_angles(config, names, comm=comm) + config = check_dihedrals(config, names, comm=comm) + config = check_hamiltonian(config, comm=comm) + config = check_NPT_conditions(config, comm=comm) + config = check_n_b(config, comm=comm) + config = check_m(config, comm=comm) + config = check_thermostat_coupling_groups(config, comm=comm) + config = check_cancel_com_momentum(config, comm=comm) + config = check_dielectric(config, comm=comm) + config = check_n_print(config, comm=comm) + config = check_n_flush(config, comm=comm) + config = check_charges_types_list(config, types, charges, comm=comm) + if charges is not None: + config = check_charges(config, charges, comm=comm) + + return config
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/_modules/hymd/integrator.html b/v1.0.2/_modules/hymd/integrator.html new file mode 100644 index 00000000..59dca879 --- /dev/null +++ b/v1.0.2/_modules/hymd/integrator.html @@ -0,0 +1,345 @@ + + + + + + hymd.integrator — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.integrator

+"""Integrates equations of motion.
+
+Implements the Velocity Verlet integrator. The *reversible reference system
+propagator algorithm* (rRESPA) integrator uses the Velocity Verlet functions
+inside the MD loop in the main module.
+"""
+
+
+
[docs]def integrate_velocity(velocities, accelerations, time_step): + """Velocity update step of the Velocity Verlet integration algorithm. + + Computes the velocity update step of the Velocity Verlet algorithm. The + :code:`velocities` argument is **not** changed in place. + + Parameters + ---------- + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + accelerations : (N, D) numpy.ndarray + Array of accelerations of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step + + .. math:: \\mathbf{v}_{\\text{new}} = \\mathbf{v} + \\frac{\\Delta t}{2m} + \\mathbf{f} + + before the positions are moved a full step using the updated half-step + velocities. + + See Also + -------- + integrate_position : The position update step of the Velocity Verlet + algorithm. + """ + return velocities + 0.5 * time_step * accelerations
+ + +
[docs]def integrate_position(positions, velocities, time_step): + """Position update step of the Velocity Verlet integration algorithm. + + Computes the position update step of the Velocity Verlet algorithm. The + :code:`positions` argument is **not** changed in place. + + Parameters + ---------- + positions : (N, D) numpy.ndarray + Array of positions of :code:`N` particles in :code:`D` dimensions. + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step, then the positions are updated a full step using the updated + velocities + + .. math:: \\mathbf{x}_{\\text{new}} = \\mathbf{x} + \\Delta t \\mathbf{v} + + See Also + -------- + integrate_velocity : The velocity update step of the Velocity Verlet + algorithm. + """ + return positions + time_step * velocities
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/_modules/hymd/logger.html b/v1.0.2/_modules/hymd/logger.html new file mode 100644 index 00000000..5144f45d --- /dev/null +++ b/v1.0.2/_modules/hymd/logger.html @@ -0,0 +1,534 @@ + + + + + + hymd.logger — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.logger

+"""Handles event logging for simulation information, warnings, and errors.
+"""
+import sys
+import os
+import logging
+from mpi4py import MPI
+from .version import __version__
+
+
+
[docs]class MPIFilterRoot(logging.Filter): + """Log output Filter wrapper class for the root MPI rank log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + if self.comm.Get_rank() == 0: + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True + else: + return False
+ + +
[docs]class MPIFilterAll(logging.Filter): + """Log output Filter wrapper class for the all-MPI-ranks log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True
+ + +class MPIFilterStdout(logging.Filter): + """Log output Filter wrapper class for filtering STDOUT log""" + + def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.funcName = "replica 0 " + record.funcName + if MPI.COMM_WORLD.Get_rank() == 0: + record.rank = MPI.COMM_WORLD.Get_rank() + record.size = MPI.COMM_WORLD.Get_size() + return True + else: + return False + + +
[docs]class Logger: + """Log output handler class + + Notes + ----- + This wraps the default python library :code:`logging`, see + `docs.python.org/3/library/logging.html`_. + + .. _`docs.python.org/3/library/logging.html`: + https://docs.python.org/3/library/logging.html + + Attributes + ---------- + level : int + Determines the verbosity level of the log, corresponding to + logging.level. Numerical values :code:`50` (:code:`logging.CRITICAL`), + :code:`40` (:code:`logging.ERROR`), :code:`30` + (:code:`logging.WARNING`), :code:`20` (:code:`logging.INFO`), + :code:`10` (:code:`logging.DEBUG`), and :code:`0` + (:code:`logging.UNSET`) are supported values. Any log event message + less severe than the specified level is ignored. All other event + messages are emitted. + log_file : str + Path to output log file. + format : str + Prepended dump string for each log event. Specifies the log event + level, the module emitting the event, the code line, the enclosing + function name, and the MPI rank writing the message. + date_format : str + Prepends the date before all log event messages. + formatter : logging.Formatter + Formatter handling the prepending of the information in `format` and + `date_format` to each log event message. Used by default for all + loggers. + rank0 : logging.Logger + Default logger object for the root MPI rank. + all_ranks : logging.Logger + Default logger object for messages being emitted from all MPI ranks + simultaneously. + """ + + level = None + log_file = None + format = " %(levelname)-8s [%(filename)s:%(lineno)d] <%(funcName)s> {rank %(rank)d/%(size)d} %(message)s" # noqa: E501 + date_format = "%(asctime)s" + formatter = logging.Formatter(fmt=date_format + format) + rank0 = logging.getLogger("HyMD.rank_0") + all_ranks = logging.getLogger("HyMD.all_ranks") + +
[docs] @classmethod + def setup(cls, default_level=logging.INFO, log_file=None, verbose=False, comm=MPI.COMM_WORLD): + """Sets up the logger object. + + If a :code:`log_file` path is provided, log event messages are output + to it. Otherwise, the logging messages are emitted to stdout. + + Parameters + ---------- + default_level : int, optional + Default verbosity level of the logger. Unless specified, it is + :code:`10` (:code:`logging.INFO`). + log_file : str, optional + Path to output log file. If `None` or not priovided, no log file is + used and all logging is done to stdout. + verbose : bool, optional + Increases the logging level to :code:`30` (:code:`logging.WARNING`) + if True, otherwise leaves the logging level unchanged. + """ + cls.level = default_level + cls.log_file = log_file + + log_to_stdout = False + if verbose: + log_to_stdout = True + + level = default_level + if not verbose: + level = logging.WARNING + cls.rank0.setLevel(level) + cls.all_ranks.setLevel(level) + + root_filter = MPIFilterRoot(comm) + all_filter = MPIFilterAll(comm) + cls.rank0.addFilter(root_filter) + cls.all_ranks.addFilter(all_filter) + + if (not log_file) and (not log_to_stdout): + return + if log_file: + cls.log_file_handler = logging.FileHandler(log_file) + cls.log_file_handler.setLevel(level) + cls.log_file_handler.setFormatter(cls.formatter) + + cls.rank0.addHandler(cls.log_file_handler) + cls.all_ranks.addHandler(cls.log_file_handler) + if log_to_stdout: + cls.log_to_stdout = True + cls.stdout_handler = logging.StreamHandler() + cls.stdout_handler.setLevel(level) + cls.stdout_handler.setStream(sys.stdout) + cls.stdout_handler.setFormatter(cls.formatter) + cls.stdout_handler.addFilter(MPIFilterStdout()) + + cls.rank0.addHandler(cls.stdout_handler) + cls.all_ranks.addHandler(cls.stdout_handler)
+ + +def format_timedelta(timedelta): + days = timedelta.days + hours, rem = divmod(timedelta.seconds, 3600) + minutes, seconds = divmod(rem, 60) + microseconds = timedelta.microseconds + ret_str = "" + if days != 0: + ret_str += f"{days} days " + ret_str += f"{hours:02d}:{minutes:02d}:{seconds:02d}.{microseconds:06d}" + return ret_str + + +def get_version(): + # Check if we are in a git repo and grab the commit hash and the branch if + # we are, append it to the version number in the output specification. + try: + import git + + try: + repo_dir = os.path.abspath( + os.path.join(os.path.dirname(__file__), os.pardir) + ) + repo = git.Repo(repo_dir) + commit = str(repo.head.commit)[:7] + branch = repo.active_branch + version = f"{__version__} [{branch} branch commit {commit}]" + except git.exc.InvalidGitRepositoryError: + version = f"{__version__}" + except ModuleNotFoundError: + version = f"{__version__}" + + return version + + +def print_header(): + banner = r""" + __ __ ____ __ _______ + / / / /_ __/ / /__ _________ _____ ______ / |/ / __ \ + / /_/ / / / / / / _ \/ ___/ __ `/ __ `/ ___/ / /|_/ / / / / + / __ / /_/ / / / __/ / / /_/ / /_/ (__ ) / / / / /_/ / + /_/ /_/\__, /_/_/\___/_/ \__,_/\__,_/____/ /_/ /_/_____/ + /____/ + """ + + refs_set = """ + + [1] Ledum, M.; Sen, S.; Li, X.; Carrer, M.; Feng Y.; Cascella, M.; Bore, S. L. + HylleraasMD: A Domain Decomposition-Based Hybrid Particle-Field Software for Multi-Scale Simulations of Soft Matter. + J. Chem. Theory Comput. 2023. + + [2] Ledum, M.; Carrer, M.; Sen, S.; Li, X.; Cascella, M.; Bore, S. L. + HyMD: Massively parallel hybrid particle-field molecular dynamics in Python. + J. Open Source Softw. 8(84), 4149, 2023. + + [3] Sen, S.; Ledum, M.; Bore, S. L.; Cascella, M. + Soft Matter under Pressure: Pushing Particle–Field Molecular Dynamics to the Isobaric Ensemble. + J Chem Inf Model 2023, 63(7), 1549-9596. + + [4] Bore, S. L.; Cascella, M. + Hamiltonian and alias-free hybrid particle–field molecular dynamics. + J. Chem. Phys. 2020, 153, 094106. + + [5] Pippig, M. PFFT: An extension of FFTW to massively parallel architectures. + SIAM J. Sci. Comput. 2013, 35, C213–C236. + +""" + + version = f"Version {get_version()}" + header = banner + header += version.center(56) + "\n\n" + #header += " Please read and cite the references below:" + header += " PLEASE READ AND CITE THE REFERENCES BELOW:" + header += refs_set + + return header +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/_modules/hymd/thermostat.html b/v1.0.2/_modules/hymd/thermostat.html new file mode 100644 index 00000000..013ca5ee --- /dev/null +++ b/v1.0.2/_modules/hymd/thermostat.html @@ -0,0 +1,491 @@ + + + + + + hymd.thermostat — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.thermostat

+"""Scales or otherwise modifies the particle velocities during simulation to
+simulate coupling to an external heat bath with temperature T₀.
+"""
+import numpy as np
+import logging
+from mpi4py import MPI
+from typing import Callable
+from .logger import Logger
+from .input_parser import Config
+
+
+def cancel_com_momentum(velocities, config, comm=MPI.COMM_WORLD):
+    com_velocity = comm.allreduce(np.sum(velocities[...], axis=0), MPI.SUM)
+    velocities[...] = velocities[...] - com_velocity / config.n_particles
+    return velocities
+
+
+def generate_initial_velocities(velocities, config, prng, comm=MPI.COMM_WORLD):
+    kT_start = config.gas_constant * config.start_temperature
+    n_particles_ = velocities.shape[0]
+    velocities[...] = prng.normal(
+        loc=0, scale=kT_start / config.mass, size=(n_particles_, 3)
+    )
+    velocities = cancel_com_momentum(velocities, config, comm=comm)
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    start_kinetic_energy_target = (
+        1.5 * config.gas_constant * config.n_particles * config.start_temperature
+    )
+    factor = np.sqrt(1.5 * config.n_particles * kT_start / kinetic_energy)
+    velocities[...] = velocities[...] * factor
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    Logger.rank0.log(
+        logging.INFO,
+        (
+            f"Initialized {config.n_particles} velocities, target kinetic "
+            f"energy: {start_kinetic_energy_target}, actual kinetic energy "
+            f"generated: {kinetic_energy}"
+        ),
+    )
+    return velocities
+
+
+
[docs]def _random_gaussian(prng: np.random.Generator) -> float: + """Draw a single random number from the standard normal distribution + Generate a number from the Gaussian distribution centered at zero with unit + standard deviation, :math:`N(0, 1)`. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + + Returns + ------- + float + A random number drawn from :math:`N(0, 1)`. + """ + return prng.normal()
+ + +
[docs]def _random_chi_squared(prng: np.random.Generator, M: int) -> float: + """Draw the sum of :code:`M` squared normally distributed values + + The value is generated by the Gamma distribution, in lieu of generating + :code:`M` Gaussian distributed numbers and summing their squares. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + M : int + Number of standard normally distributed numbers in the sum. + + Returns + ------- + float + The sum of :code:`M` squared normally distributed values centered at + zero with unit standard deviation. + + Notes + ----- + The sum of the squares of k independent standard normal random variables is + distributed according to a :math:`\\chi^2` distribution. + + .. math:: + + \\chi^2_1 + \\chi_2^2 + \\chi_3^2 + \\dots + \\chi_M^2 + \\sim + \\sigma^2\\chi^2(k) + + This is a special case of the :math:`\\Gamma` distribution, + :math:`\\Gamma(k/2, 2)`, and may be generated by + + .. math:: + + \\chi^2(k) \\sim 2 \\Gamma(k/2, 2) + + References + ---------- + Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of + Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. + J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246. + """ + return prng.chisquare(M)
+ + +
[docs]def csvr_thermostat( + velocity: np.ndarray, + names: np.ndarray, + config: Config, + prng: np.random.Generator, + comm: MPI.Intracomm = MPI.COMM_WORLD, + random_gaussian: Callable[[np.random.Generator], float] = _random_gaussian, + random_chi_squared: Callable[ + [np.random.Generator, int, float], float + ] = _random_chi_squared, + remove_center_of_mass_momentum: bool = True, +) -> np.ndarray: + """Canonical sampling through velocity rescaling thermostat + + Implements the CSVR thermostat. Rescales the system kinetic energy by a + stochastically chosen factor to keep the temperature constant. Requires + communcation of the kinetic energies calculated locally for each MPI rank. + The random numbers sampled through :code:`random_gaussian` and + :code:`random_chi_squared` are broadcast from the root rank to the other + ranks to ensure the scaling is performed with the same stochasticity for + all particles in the full system. + + The velocities are cleaned of center of mass momentum before the thermostat + is applied, and the center of mass momentum is subsequently reapplied. This + is performed for each thermostat coupling group, i.e. the center of mass + momenta of each *group* is separately removed and reapplied after + thermostatting. + + The implementation here is based on the derivation presented in the 2008 + Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper. + + Parameters + ---------- + velocity : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + names : (N,) numpy.ndarray + Array of particle names. + config : Config + Configuration dataclass containing simulation metadata and parameters. + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + random_gaussian : callable, optional + Function for generating standard normally distributed numbers. + random_chi_squared : callable, optional + Function for generating :math:`\\chi^2`-distributed numbers + remove_center_of_mass_momentum : bool, optional + If True, the center of mass of each coupling group is removed before + the thermostat is applied. The center of mass momenta are added back + after the kinetic energy rescaling is complete. + + See Also + -------- + _random_gaussian : + Used to sample Gaussian-distributed numbers. + _random_chi_squared : + Used to sample :math:`\\chi^2`-distributed numbers. + hymd.input_parser.Config : + Configuration dataclass handler. + + References + ---------- + G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). + G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008). + """ + if not any(config.thermostat_coupling_groups): + config.thermostat_coupling_groups = [config.unique_names.copy()] + for i, group in enumerate(config.thermostat_coupling_groups): + ind = np.where( + np.logical_or.reduce(list(names == np.string_(t) for t in group)) + ) + group_n_particles = comm.allreduce(len(ind[0]), MPI.SUM) + + # Clean velocities of center of mass momentum + if remove_center_of_mass_momentum and group_n_particles > 1: + com_velocity = comm.allreduce(np.sum(velocity[ind], axis=0)) + velocity_clean = velocity[ind] - com_velocity / group_n_particles + K = comm.allreduce(0.5 * config.mass * np.sum(velocity_clean[...] ** 2)) + else: + K = comm.allreduce(0.5 * config.mass * np.sum(velocity[...] ** 2)) + K_target = ( + 1.5 * config.gas_constant * group_n_particles * config.target_temperature + ) + N_f = 3 * group_n_particles + c = np.exp(-(config.time_step * config.respa_inner) / config.tau) + + # Random numbers are identical across ranks because all ranks have + # the same prng after the initialization of the velocities + R = random_gaussian(prng) + SNf = random_chi_squared(prng, N_f - 1) + + alpha2 = ( + c + + (1 - c) * (SNf + R**2) * K_target / (N_f * K) + + 2 * R * np.sqrt(c * (1 - c) * K_target / (N_f * K)) + ) + dK = K * (alpha2 - 1) + alpha = np.sqrt(alpha2) + + if remove_center_of_mass_momentum and group_n_particles > 1: + # Assign velocities and reapply the previously removed center + # of mass momentum removed + velocity_clean *= alpha + velocity[ind] = velocity_clean + com_velocity / group_n_particles + else: + velocity *= alpha + config.thermostat_work += dK
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/_modules/index.html b/v1.0.2/_modules/index.html new file mode 100644 index 00000000..b51873cc --- /dev/null +++ b/v1.0.2/_modules/index.html @@ -0,0 +1,279 @@ + + + + + + Overview: module code — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+ +
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/v1.0.2/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css new file mode 100644 index 00000000..1b057df2 --- /dev/null +++ b/v1.0.2/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css @@ -0,0 +1 @@ +.badge{border-radius:.25rem;display:inline-block;font-size:75%;font-weight:700;line-height:1;padding:.25em .4em;text-align:center;vertical-align:baseline;white-space:nowrap}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{border-radius:10rem;padding-left:.6em;padding-right:.6em}.badge-primary{background-color:#007bff;color:#fff}.badge-primary[href]:focus,.badge-primary[href]:hover{background-color:#0062cc;color:#fff;text-decoration:none}.badge-secondary{background-color:#6c757d;color:#fff}.badge-secondary[href]:focus,.badge-secondary[href]:hover{background-color:#545b62;color:#fff;text-decoration:none}.badge-success{background-color:#28a745;color:#fff}.badge-success[href]:focus,.badge-success[href]:hover{background-color:#1e7e34;color:#fff;text-decoration:none}.badge-info{background-color:#17a2b8;color:#fff}.badge-info[href]:focus,.badge-info[href]:hover{background-color:#117a8b;color:#fff;text-decoration:none}.badge-warning{background-color:#ffc107;color:#212529}.badge-warning[href]:focus,.badge-warning[href]:hover{background-color:#d39e00;color:#212529;text-decoration:none}.badge-danger{background-color:#dc3545;color:#fff}.badge-danger[href]:focus,.badge-danger[href]:hover{background-color:#bd2130;color:#fff;text-decoration:none}.badge-light{background-color:#f8f9fa;color:#212529}.badge-light[href]:focus,.badge-light[href]:hover{background-color:#dae0e5;color:#212529;text-decoration:none}.badge-dark{background-color:#343a40;color:#fff}.badge-dark[href]:focus,.badge-dark[href]:hover{background-color:#1d2124;color:#fff;text-decoration:none}.border-0{border:0 !important}.border-top-0{border-top:0 !important}.border-right-0{border-right:0 !important}.border-bottom-0{border-bottom:0 !important}.border-left-0{border-left:0 !important}.p-0{padding:0 !important}.pt-0,.py-0{padding-top:0 !important}.pr-0,.px-0{padding-right:0 !important}.pb-0,.py-0{padding-bottom:0 !important}.pl-0,.px-0{padding-left:0 !important}.p-1{padding:.25rem !important}.pt-1,.py-1{padding-top:.25rem !important}.pr-1,.px-1{padding-right:.25rem !important}.pb-1,.py-1{padding-bottom:.25rem !important}.pl-1,.px-1{padding-left:.25rem !important}.p-2{padding:.5rem !important}.pt-2,.py-2{padding-top:.5rem !important}.pr-2,.px-2{padding-right:.5rem !important}.pb-2,.py-2{padding-bottom:.5rem !important}.pl-2,.px-2{padding-left:.5rem !important}.p-3{padding:1rem !important}.pt-3,.py-3{padding-top:1rem !important}.pr-3,.px-3{padding-right:1rem !important}.pb-3,.py-3{padding-bottom:1rem !important}.pl-3,.px-3{padding-left:1rem !important}.p-4{padding:1.5rem !important}.pt-4,.py-4{padding-top:1.5rem !important}.pr-4,.px-4{padding-right:1.5rem !important}.pb-4,.py-4{padding-bottom:1.5rem !important}.pl-4,.px-4{padding-left:1.5rem !important}.p-5{padding:3rem !important}.pt-5,.py-5{padding-top:3rem !important}.pr-5,.px-5{padding-right:3rem !important}.pb-5,.py-5{padding-bottom:3rem !important}.pl-5,.px-5{padding-left:3rem !important}.m-0{margin:0 !important}.mt-0,.my-0{margin-top:0 !important}.mr-0,.mx-0{margin-right:0 !important}.mb-0,.my-0{margin-bottom:0 !important}.ml-0,.mx-0{margin-left:0 !important}.m-1{margin:.25rem !important}.mt-1,.my-1{margin-top:.25rem !important}.mr-1,.mx-1{margin-right:.25rem !important}.mb-1,.my-1{margin-bottom:.25rem !important}.ml-1,.mx-1{margin-left:.25rem !important}.m-2{margin:.5rem !important}.mt-2,.my-2{margin-top:.5rem !important}.mr-2,.mx-2{margin-right:.5rem !important}.mb-2,.my-2{margin-bottom:.5rem !important}.ml-2,.mx-2{margin-left:.5rem !important}.m-3{margin:1rem !important}.mt-3,.my-3{margin-top:1rem !important}.mr-3,.mx-3{margin-right:1rem !important}.mb-3,.my-3{margin-bottom:1rem !important}.ml-3,.mx-3{margin-left:1rem !important}.m-4{margin:1.5rem !important}.mt-4,.my-4{margin-top:1.5rem !important}.mr-4,.mx-4{margin-right:1.5rem !important}.mb-4,.my-4{margin-bottom:1.5rem !important}.ml-4,.mx-4{margin-left:1.5rem !important}.m-5{margin:3rem !important}.mt-5,.my-5{margin-top:3rem !important}.mr-5,.mx-5{margin-right:3rem !important}.mb-5,.my-5{margin-bottom:3rem !important}.ml-5,.mx-5{margin-left:3rem !important}.btn{background-color:transparent;border:1px solid transparent;border-radius:.25rem;color:#212529;cursor:pointer;display:inline-block;font-size:1rem;font-weight:400;line-height:1.5;padding:.375rem .75rem;text-align:center;transition:color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none;vertical-align:middle}.btn:hover{color:#212529;text-decoration:none}.btn:visited{color:#212529}.btn.focus,.btn:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.25);outline:0}.btn.disabled,.btn:disabled{opacity:.65}@media (prefers-reduced-motion: reduce){.btn{transition:none}}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary:visited{color:#fff}.btn-primary:hover{background-color:#0069d9;border-color:#0062cc;color:#fff}.btn-primary.focus,.btn-primary:focus{background-color:#0069d9;border-color:#0062cc;box-shadow:0 0 0 .2rem rgba(0,123,255,0.5);color:#fff}.btn-primary.disabled,.btn-primary:disabled{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary.active:not(:disabled):not(.disabled),.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{background-color:#0062cc;border-color:#005cbf;color:#fff}.btn-primary.active:not(:disabled):not(.disabled):focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-secondary{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary:visited{color:#fff}.btn-secondary:hover{background-color:#5a6268;border-color:#545b62;color:#fff}.btn-secondary.focus,.btn-secondary:focus{background-color:#5a6268;border-color:#545b62;box-shadow:0 0 0 .2rem rgba(108,117,125,0.5);color:#fff}.btn-secondary.disabled,.btn-secondary:disabled{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled),.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{background-color:#545b62;border-color:#4e555b;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled):focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-success{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success:visited{color:#fff}.btn-success:hover{background-color:#218838;border-color:#1e7e34;color:#fff}.btn-success.focus,.btn-success:focus{background-color:#218838;border-color:#1e7e34;box-shadow:0 0 0 .2rem rgba(40,167,69,0.5);color:#fff}.btn-success.disabled,.btn-success:disabled{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success.active:not(:disabled):not(.disabled),.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{background-color:#1e7e34;border-color:#1c7430;color:#fff}.btn-success.active:not(:disabled):not(.disabled):focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-info{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info:visited{color:#fff}.btn-info:hover{background-color:#138496;border-color:#117a8b;color:#fff}.btn-info.focus,.btn-info:focus{background-color:#138496;border-color:#117a8b;box-shadow:0 0 0 .2rem rgba(23,162,184,0.5);color:#fff}.btn-info.disabled,.btn-info:disabled{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info.active:not(:disabled):not(.disabled),.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{background-color:#117a8b;border-color:#10707f;color:#fff}.btn-info.active:not(:disabled):not(.disabled):focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-warning{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning:visited{color:#212529}.btn-warning:hover{background-color:#e0a800;border-color:#d39e00;color:#212529}.btn-warning.focus,.btn-warning:focus{background-color:#e0a800;border-color:#d39e00;box-shadow:0 0 0 .2rem rgba(255,193,7,0.5);color:#212529}.btn-warning.disabled,.btn-warning:disabled{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning.active:not(:disabled):not(.disabled),.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{background-color:#d39e00;border-color:#c69500;color:#212529}.btn-warning.active:not(:disabled):not(.disabled):focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-danger{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger:visited{color:#fff}.btn-danger:hover{background-color:#c82333;border-color:#bd2130;color:#fff}.btn-danger.focus,.btn-danger:focus{background-color:#c82333;border-color:#bd2130;box-shadow:0 0 0 .2rem rgba(220,53,69,0.5);color:#fff}.btn-danger.disabled,.btn-danger:disabled{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger.active:not(:disabled):not(.disabled),.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{background-color:#bd2130;border-color:#b21f2d;color:#fff}.btn-danger.active:not(:disabled):not(.disabled):focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-light{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light:visited{color:#212529}.btn-light:hover{background-color:#e2e6ea;border-color:#dae0e5;color:#212529}.btn-light.focus,.btn-light:focus{background-color:#e2e6ea;border-color:#dae0e5;box-shadow:0 0 0 .2rem rgba(248,249,250,0.5);color:#212529}.btn-light.disabled,.btn-light:disabled{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light.active:not(:disabled):not(.disabled),.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{background-color:#dae0e5;border-color:#d3d9df;color:#212529}.btn-light.active:not(:disabled):not(.disabled):focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-dark{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark:visited{color:#fff}.btn-dark:hover{background-color:#23272b;border-color:#1d2124;color:#fff}.btn-dark.focus,.btn-dark:focus{background-color:#23272b;border-color:#1d2124;box-shadow:0 0 0 .2rem rgba(52,58,64,0.5);color:#fff}.btn-dark.disabled,.btn-dark:disabled{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark.active:not(:disabled):not(.disabled),.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{background-color:#1d2124;border-color:#171a1d;color:#fff}.btn-dark.active:not(:disabled):not(.disabled):focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-primary{border-color:#007bff;color:#007bff}.btn-outline-primary:visited{color:#007bff}.btn-outline-primary:hover{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{background-color:transparent;color:#007bff}.btn-outline-primary.active:not(:disabled):not(.disabled),.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.active:not(:disabled):not(.disabled):focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-secondary{border-color:#6c757d;color:#6c757d}.btn-outline-secondary:visited{color:#6c757d}.btn-outline-secondary:hover{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{background-color:transparent;color:#6c757d}.btn-outline-secondary.active:not(:disabled):not(.disabled),.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.active:not(:disabled):not(.disabled):focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-success{border-color:#28a745;color:#28a745}.btn-outline-success:visited{color:#28a745}.btn-outline-success:hover{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{background-color:transparent;color:#28a745}.btn-outline-success.active:not(:disabled):not(.disabled),.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.active:not(:disabled):not(.disabled):focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-info{border-color:#17a2b8;color:#17a2b8}.btn-outline-info:visited{color:#17a2b8}.btn-outline-info:hover{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{background-color:transparent;color:#17a2b8}.btn-outline-info.active:not(:disabled):not(.disabled),.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.active:not(:disabled):not(.disabled):focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-warning{border-color:#ffc107;color:#ffc107}.btn-outline-warning:visited{color:#ffc107}.btn-outline-warning:hover{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{background-color:transparent;color:#ffc107}.btn-outline-warning.active:not(:disabled):not(.disabled),.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.active:not(:disabled):not(.disabled):focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-danger{border-color:#dc3545;color:#dc3545}.btn-outline-danger:visited{color:#dc3545}.btn-outline-danger:hover{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{background-color:transparent;color:#dc3545}.btn-outline-danger.active:not(:disabled):not(.disabled),.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.active:not(:disabled):not(.disabled):focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-light{border-color:#f8f9fa;color:#f8f9fa}.btn-outline-light:visited{color:#f8f9fa}.btn-outline-light:hover{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{background-color:transparent;color:#f8f9fa}.btn-outline-light.active:not(:disabled):not(.disabled),.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.active:not(:disabled):not(.disabled):focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-dark{border-color:#343a40;color:#343a40}.btn-outline-dark:visited{color:#343a40}.btn-outline-dark:hover{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{background-color:transparent;color:#343a40}.btn-outline-dark.active:not(:disabled):not(.disabled),.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.active:not(:disabled):not(.disabled):focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-link{color:#007bff;font-weight:400;text-decoration:none}.btn-link:hover{color:#0056b3;text-decoration:underline}.btn-link.focus,.btn-link:focus{box-shadow:none;text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{border-radius:.3rem;font-size:1.25rem;line-height:1.5;padding:.5rem 1rem}.btn-group-sm>.btn,.btn-sm{border-radius:.2rem;font-size:.875rem;line-height:1.5;padding:.25rem .5rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input.btn-block[type=button],input.btn-block[type=reset],input.btn-block[type=submit]{width:100%}.stretched-link::after{background-color:rgba(0,0,0,0);bottom:0;content:'';left:0;pointer-events:auto;position:absolute;right:0;top:0;z-index:1}.text-wrap{white-space:normal !important}.card{background-clip:border-box;background-color:#fff;border:1px solid rgba(0,0,0,0.125);border-radius:.25rem;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;min-width:0;position:relative;word-wrap:break-word}.card>hr{margin-left:0;margin-right:0}.card>.list-group:first-child .list-group-item:first-child{border-top-left-radius:.25rem;border-top-right-radius:.25rem}.card>.list-group:last-child .list-group-item:last-child{border-bottom-left-radius:.25rem;border-bottom-right-radius:.25rem}.card-body{-ms-flex:1 1 auto;flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-bottom:0;margin-top:-.375rem}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{background-color:rgba(0,0,0,0.03);border-bottom:1px solid rgba(0,0,0,0.125);margin-bottom:0;padding:.75rem 1.25rem}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-header+.list-group .list-group-item:first-child{border-top:0}.card-footer{background-color:rgba(0,0,0,0.03);border-top:1px solid rgba(0,0,0,0.125);padding:.75rem 1.25rem}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{border-bottom:0;margin-bottom:-.75rem;margin-left:-.625rem;margin-right:-.625rem}.card-header-pills{margin-left:-.625rem;margin-right:-.625rem}.card-img-overlay{bottom:0;left:0;padding:1.25rem;position:absolute;right:0;top:0}.card-img,.card-img-bottom,.card-img-top{-ms-flex-negative:0;flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-left-radius:calc(.25rem - 1px);border-bottom-right-radius:calc(.25rem - 1px)}.w-100{width:100% !important}.shadow{box-shadow:0 0.5rem 1rem rgba(0,0,0,0.15) !important}.bg-primary{background-color:#007bff !important}button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc !important}a.bg-primary:focus,a.bg-primary:hover{background-color:#0062cc !important}a.text-primary:focus,a.text-primary:hover{color:#121416 !important}.bg-secondary{background-color:#6c757d !important}button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62 !important}a.bg-secondary:focus,a.bg-secondary:hover{background-color:#545b62 !important}a.text-secondary:focus,a.text-secondary:hover{color:#121416 !important}.bg-success{background-color:#28a745 !important}button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34 !important}a.bg-success:focus,a.bg-success:hover{background-color:#1e7e34 !important}a.text-success:focus,a.text-success:hover{color:#121416 !important}.bg-info{background-color:#17a2b8 !important}button.bg-info:focus,button.bg-info:hover{background-color:#117a8b !important}a.bg-info:focus,a.bg-info:hover{background-color:#117a8b !important}a.text-info:focus,a.text-info:hover{color:#121416 !important}.bg-warning{background-color:#ffc107 !important}button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00 !important}a.bg-warning:focus,a.bg-warning:hover{background-color:#d39e00 !important}a.text-warning:focus,a.text-warning:hover{color:#121416 !important}.bg-danger{background-color:#dc3545 !important}button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130 !important}a.bg-danger:focus,a.bg-danger:hover{background-color:#bd2130 !important}a.text-danger:focus,a.text-danger:hover{color:#121416 !important}.bg-light{background-color:#f8f9fa !important}button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5 !important}a.bg-light:focus,a.bg-light:hover{background-color:#dae0e5 !important}a.text-light:focus,a.text-light:hover{color:#121416 !important}.bg-dark{background-color:#343a40 !important}button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124 !important}a.bg-dark:focus,a.bg-dark:hover{background-color:#1d2124 !important}a.text-dark:focus,a.text-dark:hover{color:#121416 !important}.bg-white{background-color:#fff !important}button.bg-white:focus,button.bg-white:hover{background-color:#e6e6e6 !important}a.bg-white:focus,a.bg-white:hover{background-color:#e6e6e6 !important}a.text-white:focus,a.text-white:hover{color:#121416 !important}.text-primary{color:#007bff !important}.text-secondary{color:#6c757d !important}.text-success{color:#28a745 !important}.text-info{color:#17a2b8 !important}.text-warning{color:#ffc107 !important}.text-danger{color:#dc3545 !important}.text-light{color:#f8f9fa !important}.text-dark{color:#343a40 !important}.text-white{color:#fff !important}.text-body{color:#212529 !important}.text-muted{color:#6c757d !important}.text-black-50{color:rgba(0,0,0,0.5) !important}.text-white-50{color:rgba(255,255,255,0.5) !important}.bg-transparent{background-color:transparent !important}.text-justify{text-align:justify !important}.text-left{text-align:left !important}.text-right{text-align:right !important}.text-center{text-align:center !important}.font-weight-light{font-weight:300 !important}.font-weight-lighter{font-weight:lighter !important}.font-weight-normal{font-weight:400 !important}.font-weight-bold{font-weight:700 !important}.font-weight-bolder{font-weight:bolder !important}.font-italic{font-style:italic !important}.container{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container{max-width:540px}}@media (min-width: 768px){.container{max-width:720px}}@media (min-width: 992px){.container{max-width:960px}}@media (min-width: 1200px){.container{max-width:1140px}}.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container,.container-sm{max-width:540px}}@media (min-width: 768px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width: 992px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width: 1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1140px}}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;margin-right:-15px}.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{padding-left:15px;padding-right:15px;position:relative;width:100%}@media (min-width: 576px){.col-sm{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-sm-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-sm-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-sm-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-sm-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-sm-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 768px){.col-md{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-md-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-md-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-md-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-md-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-md-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 992px){.col-lg{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-lg-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-lg-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-lg-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-lg-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-lg-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 1200px){.col-xl{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-xl-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-xl-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-xl-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-xl-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-xl-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}.d-flex{display:-ms-flexbox !important;display:flex !important}.sphinx-bs,.sphinx-bs *{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sphinx-bs p{margin-top:0} diff --git a/v1.0.2/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/v1.0.2/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css new file mode 100644 index 00000000..fc14abc8 --- /dev/null +++ b/v1.0.2/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css @@ -0,0 +1 @@ +details.dropdown .summary-title{padding-right:3em !important;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none}details.dropdown:hover{cursor:pointer}details.dropdown .summary-content{cursor:default}details.dropdown summary{list-style:none;padding:1em}details.dropdown summary .octicon.no-title{vertical-align:middle}details.dropdown[open] summary .octicon.no-title{visibility:hidden}details.dropdown summary::-webkit-details-marker{display:none}details.dropdown summary:focus{outline:none}details.dropdown summary:hover .summary-up svg,details.dropdown summary:hover .summary-down svg{opacity:1}details.dropdown .summary-up svg,details.dropdown .summary-down svg{display:block;opacity:.6}details.dropdown .summary-up,details.dropdown .summary-down{pointer-events:none;position:absolute;right:1em;top:.75em}details.dropdown[open] .summary-down{visibility:hidden}details.dropdown:not([open]) .summary-up{visibility:hidden}details.dropdown.fade-in[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out;animation:panels-fade-in .5s ease-in-out}details.dropdown.fade-in-slide-down[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out}@keyframes panels-fade-in{0%{opacity:0}100%{opacity:1}}@keyframes panels-slide-down{0%{transform:translate(0, -10px)}100%{transform:translate(0, 0)}}.octicon{display:inline-block;fill:currentColor;vertical-align:text-top}.tabbed-content{box-shadow:0 -.0625rem var(--tabs-color-overline),0 .0625rem var(--tabs-color-underline);display:none;order:99;padding-bottom:.75rem;padding-top:.75rem;width:100%}.tabbed-content>:first-child{margin-top:0 !important}.tabbed-content>:last-child{margin-bottom:0 !important}.tabbed-content>.tabbed-set{margin:0}.tabbed-set{border-radius:.125rem;display:flex;flex-wrap:wrap;margin:1em 0;position:relative}.tabbed-set>input{opacity:0;position:absolute}.tabbed-set>input:checked+label{border-color:var(--tabs-color-label-active);color:var(--tabs-color-label-active)}.tabbed-set>input:checked+label+.tabbed-content{display:block}.tabbed-set>input:focus+label{outline-style:auto}.tabbed-set>input:not(.focus-visible)+label{outline:none;-webkit-tap-highlight-color:transparent}.tabbed-set>label{border-bottom:.125rem solid transparent;color:var(--tabs-color-label-inactive);cursor:pointer;font-size:var(--tabs-size-label);font-weight:700;padding:1em 1.25em .5em;transition:color 250ms;width:auto;z-index:1}html .tabbed-set>label:hover{color:var(--tabs-color-label-active)} diff --git a/v1.0.2/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css b/v1.0.2/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css new file mode 100644 index 00000000..adc61662 --- /dev/null +++ b/v1.0.2/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css @@ -0,0 +1,7 @@ +:root { +--tabs-color-label-active: hsla(231, 99%, 66%, 1); +--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); +--tabs-color-overline: rgb(207, 236, 238); +--tabs-color-underline: rgb(207, 236, 238); +--tabs-size-label: 1rem; +} \ No newline at end of file diff --git a/v1.0.2/_sources/doc_pages/api.rst.txt b/v1.0.2/_sources/doc_pages/api.rst.txt new file mode 100644 index 00000000..c9f8837b --- /dev/null +++ b/v1.0.2/_sources/doc_pages/api.rst.txt @@ -0,0 +1,90 @@ +.. _api-label: + + +API reference +============= + +Integrator +---------- + +.. automodule:: hymd.integrator + :members: + + +Thermostat +---------- + +.. automodule:: hymd.thermostat + :members: csvr_thermostat, _random_chi_squared, _random_gaussian + :undoc-members: + + +Hamiltonian +----------- + +.. autoclass:: hymd.hamiltonian.Hamiltonian + :members: + + .. automethod:: __init__ + + .. automethod:: _setup + +.. autoclass:: hymd.hamiltonian.SquaredPhi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultNoChi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultWithChi + :members: + + .. automethod:: __init__ + + +Force +----- + +.. automodule:: hymd.force + :members: + :undoc-members: + + +Logger +------ + +.. autoclass:: hymd.logger.Logger + :members: + +.. autoclass:: hymd.logger.MPIFilterRoot + :members: + +.. autoclass:: hymd.logger.MPIFilterAll + :members: + + +Input parser +------------ + +.. automodule:: hymd.input_parser + :members: + :undoc-members: propensity_potential_coeffs + + +Field +----- + +.. automodule:: hymd.field + :members: + + +File input/output +----------------- + +.. automodule:: hymd.file_io + :members: diff --git a/v1.0.2/_sources/doc_pages/benchmarks.rst.txt b/v1.0.2/_sources/doc_pages/benchmarks.rst.txt new file mode 100644 index 00000000..edc8a863 --- /dev/null +++ b/v1.0.2/_sources/doc_pages/benchmarks.rst.txt @@ -0,0 +1,93 @@ +.. _benchmarks-label: + +Benchmarks +########## +Homopolymer melt test systems of :math:`30^2`, :math:`40^2`, and :math:`50^2` +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively. + +Bonded forces +^^^^^^^^^^^^^ +Legend label denotes the number of particles in the system. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) + time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 + ], dtype=np.float64) + nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 + ], dtype=np.float64,) + time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, + ], dtype=np.float64) + nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 + ], dtype=np.float64) + time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, + ], dtype=np.float64) + plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" + ) + plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" + ) + plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" + ) + plt.xlabel("CPUs", fontsize=15) + plt.ylabel("Time per step, us", fontsize=15) + plt.legend(fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.show() + + +Particle--field forces +^^^^^^^^^^^^^^^^^^^^^^ +Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + + mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] + mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + + mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + + mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + + mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] + mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + + mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + + mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + + plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048²") + plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024²") + plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512²") + plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256²") + plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128²") + plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64²") + plt.xlabel("CPUs", fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.ylabel("Time per step, s", fontsize=15) + plt.legend(loc="upper left", fontsize=15) + plt.show() diff --git a/v1.0.2/_sources/doc_pages/command_line.rst.txt b/v1.0.2/_sources/doc_pages/command_line.rst.txt new file mode 100644 index 00000000..5233710f --- /dev/null +++ b/v1.0.2/_sources/doc_pages/command_line.rst.txt @@ -0,0 +1,120 @@ +.. _commandline-label: + +Command line arguments +###################### +Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle--field interactions. + + +Required arguments +================== +:configuration file: + :code:`type` positional + + Specifies the :code:`.toml` format configuration file containing simulation details. See :ref:`config-label` for details. + +:structure and topology file: + :code:`type` positional + + Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See :ref:`topology-label` for details. + +Optional arguments +================== +:code:`-v --verbose` + :code:`type` optional + + Number of following arguments: :code:`0` or :code:`1` + + Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying :code:`-v` or :code:`--verbose` with no additional specification. This increases verbosity level by :code:`1`. Alternatively, it maye be specified by :code:`--verbose V` with :code:`V` being :code:`0`, :code:`1`, or :code:`2`. + +:code:`--profile` + :code:`type` optional + + Number of following arguments: :code:`0` + + Enables code profiling using :code:`cProfile`. This will output one profiling file per MPI rank invoked in the simulation. + +:code:`--double-precision` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision internally in HyMD (including in the FFTs). + +:code:`--double-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision in the output trajectory from HyMD. + +:code:`--velocity-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that velocities should be output to the HyMD trajectory. + +:code:`--force-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that forces should be output to the HyMD trajectory. + +:code:`--disable-mpio` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult. + +:code:`--logfile` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the path of a plain text log file in which stdout is mirrored during simulation runs. + +:code:`--seed` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the random seed used in the :code:`numpy` random library to generate velocities, thermostatting, etc. + +:code:`--disable-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any two-particle bonds present in the system. + +:code:`--disable-angle-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any three-particle bonds present in the system. + +:code:`--disable-dihedrals` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any four-particle bonds present in the system. + +:code:`--disable-dipole` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any topological reconstruction of peptide backbone dipoles present in the system. + +:code:`--disable-field` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any particle--field interactions present in the system. diff --git a/v1.0.2/_sources/doc_pages/config_file.rst.txt b/v1.0.2/_sources/doc_pages/config_file.rst.txt new file mode 100644 index 00000000..40ee0479 --- /dev/null +++ b/v1.0.2/_sources/doc_pages/config_file.rst.txt @@ -0,0 +1,194 @@ +.. _config-label: + +Configuration file +################## +The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order. + +The configuration file is a `toml`_ format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs. + +.. _`toml`: + https://github.com/toml-lang/toml + +.. role:: required + +Configuration file keywords +--------------------------- + +The following constitutes every possible keyword specification in HyMD +configuration files: + +Metadata keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying metadata for the H5MD output trajectory. + +:name: + :code:`string` [**optional**, default: :code:`None`] + + Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file. + + +:tags: + :code:`array` [:code:`string`] [**optional**, default: :code:`None`] + + Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file. + + +Particle keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying properties of particles and molecules in the +system. + +:n_particles: + :code:`integer` [**optional**, default: :code:`None`] + + Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules. + +:mass: + :code:`float` [**optional**, default: :code:`72.0`] {units: :math:`\text{u}=\text{g}\,\text{mol}^{-1}`} + + Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal. + +:max_molecule_size: + :code:`integer` [**optional**, default: :code:`201`] + + Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code **will** crash if there are molecules larger than :code:`max_molecule_size` in the topology/structure input file. + + +Simulation keywords +^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying simulation parameters. + +:n_steps: + :code:`integer` [:required:`required`] + + Total number of integration steps to perform for this simulation. + +:n_print: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of *number of time steps*). + +:n_flush: + :code:`integer` [**optional**, default: :code:`None`] + + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of *number of* :code:`n_print`, i.e. :code:`n_print = 13`, :code:`n_flush = 3` would result in the trajectory/energy being written to disk every :code:`13 x 3 = 39` *simulation steps*) + +:time_step: + :code:`float` [:required:`required`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time step per integration step. If the rRESPA multiple time step integrator is used (:code:`integrator = "respa"`), this specifies the **inner** time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is :code:`respa_inner` times the :code:`time_step` , and the total simulation time is :code:`n_steps` times :code:`time_step` times :code:`respa_inner` . + +:box_size: + :code:`array` [:code:`float`] [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable. + +:integrator: + :code:`string` [:required:`required`] (options: :code:`velocity-verlet` or :code:`respa`) + + Specifies the time integrator used in the simulation. If :code:`respa`, the *reversible reference system propagator algorithm (rRESPA)* :cite:`tuckerman1992reversible` integrator is used, with :code:`respa_inner` number of inner (intramolecular force) time steps. If :code:`velocity-verlet`, a normal Velocity Verlet integrator is used. If :code:`respa` and :code:`respa_inner = 1`, the rRESPA integrator is equivalent to the Velocity Verlet. + +:respa_inner: + :code:`integer` [**optional**, default: :code:`1`] + + The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces. + +:domain_decomposition: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Specifies the interval (in time steps) of *domain decomposition exchange*, involving all MPI ranks sending and receiving particles according to the particles' positions in the integration box and the MPI ranks' assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If :code:`True`, the decomposition is performed once (before starting the simulation). If :code:`False`, no decomposition is performed. + +:cancel_com_momentum: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + If :code:`True`, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every :code:`remove_com_momentum` time steps. If :code:`False`, the linear momentum is never removed. + +:start_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at :code:`start_temperature` Kelvin prior to starting the simulation. If :code:`False`, the velocities are not changed before starting the simulation. + +:target_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Couple the system to a heat bath at :code:`target_temperature` Kelvin by applying a *Canonical sampling through velocity rescaling* :cite:`Bussi2007JCP` thermostat with coupling strength :code:`tau`. If :code:`False`, no temperature control is applied. + +:tau: + :code:`float` [**optional**, default: :code:`0.7`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the CSVR thermostat coupling. In the limit of :code:`tau → ∞`, the Hamiltonian dynamics are preserved and no temperature coupling takes place. + +:thermostat_coupling_groups: + :code:`array` [:code:`array` [:code:`string`]] [**optional**, default: :code:`[]`] + + Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and :code:`"C"` type particles, :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would thermalise types :code:`"A"` and :code:`"B"` together and couple :code:`"C"` type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. :code:`target_temperature` Kelvin). +:hamiltonian: + :code:`string` [**optional**, default: :code:`"DefaultNohChi"`] (options: :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`) + + Specifies the interaction energy functional :math:`W[\tilde\phi]` for use with the particle-field interactions. See :ref:`functionals-label` for details. + + +Field keywords +^^^^^^^^^^^^^^ +Configuration keywords specifying field parameters. + +:mesh_size: + :code:`array` [:code:`integer`] or :code:`integer` [:required:`required`] + + Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is :code:`box_size / mesh_size`. + +:kappa: + :code:`float` [:required:`required`] {units: :math:`\text{kJ}^{-1}\text{mol}`} + + Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional :math:`W[\tilde\phi]`. See :ref:`functionals-label` for more details. + +:sigma: + :code:`float` [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See :ref:`filtering-label` for more details. + +:chi: + :code:`array` [:code:`array` [:code:`string`, :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}`} + + Array of :math:`\tilde\chi_\text{AB}`-parameters indicating the strength of the repulsive or attractive interaction between particles of type :code:`"A"` and the number density due to particles of type :code:`"B"`, and vice versa. Example: :code:`chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ]` would specify a repulsive :code:`"A"`--:code:`"B"` type interaction, and a weakly attractive :code:`"C"`--:code:`"D"` interaction. Self-interaction :math:`\tilde\chi`-terms are always zero. See :ref:`functionals-label` for more details. + + +Bond keywords +^^^^^^^^^^^^^ +Configuration keywords specifying bonds and bonds parameters. + +:bonds: + :code:`array` [:code:`array` [2 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{nm}=10^{-9}~\text{m}` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: :code:`bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ]` indicates a :code:`"A"`--:code:`"A"` bond of equilibrium length :code:`0.47` :math:`\text{nm}` with a bond strength of :code:`980.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding bond between :code:`"A"` and :code:`"B"` type particles with equilibrium length :code:`0.31` :math:`\text{nm}` and a strength of :code:`1250.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify stretching bonds. + +:angle_bonds: + :code:`array` [:code:`array` [3 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`{}^\circ` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: :code:`bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ]` indicates a :code:`"A"`--:code:`"A"`--:code:`"A"` angular bond that tries to keep the bond linear at :code:`180` degrees with a bending strength of :code:`55.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding angle bond between :code:`"A"`--:code:`"B"`--:code:`"B"` prefering the angle at :code:`120` degrees and a strength of :code:`25.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify angular bonds. + +:dihedrals: + :code:`array` [:code:`array` [4 :code:`string`, :code:`integer`, :code:`COSINE SERIES` ]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`} + + Specifies four-particle torsional potentials by cosine series. See :ref:`bonds-label` for details about how to specify dihedrals. + + + +Electrostatic keywords +^^^^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying electrostatics and electrostatic parameters. + +:coulombtype: + :code:`string` [**optional**, default: :code:`None`] (options: :code:`PIC_Spectral`) + + Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the :code:`dielectric_const` keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, *not* in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to `PIC_Spectral`. + +:dielectric_const: + :code:`float` [**optional**, default: :code:`None`] + + Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified---even if electrostatics are not included with the :code:`coulombtype` keyword. diff --git a/v1.0.2/_sources/doc_pages/constants_and_units.rst.txt b/v1.0.2/_sources/doc_pages/constants_and_units.rst.txt new file mode 100644 index 00000000..ee429829 --- /dev/null +++ b/v1.0.2/_sources/doc_pages/constants_and_units.rst.txt @@ -0,0 +1,80 @@ +.. _units-label: + +Constants and Units +################### + +HyMD uses the following units and constants internally and in all input and +output: + +.. list-table:: **Units** + :widths: 30 10 75 + :header-rows: 1 + + * - Quantity + - Symbol + - Unit + * - length + - :math:`r` + - :math:`\text{nm}=10^{-9}~\text{m}` + * - time + - :math:`t` + - :math:`\text{ps}=10^{-12}~\text{s}` + * - charge + - :math:`q` + - :math:`e=1.602176634 \cdot 10^{-19}~\text{C}` + * - mass + - :math:`m` + - :math:`\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}` + * - temperature + - :math:`\text{T}` + - :math:`\text{K}` + * - energy + - :math:`E` + - :math:`\text{kJ}\,\text{mol}^{-1}` + * - velocity + - :math:`v` + - :math:`\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}` + * - momentum + - :math:`P` + - :math:`\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}` + * - force + - :math:`\mathbf{F}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}` + * - pressure + - :math:`p` + - :math:`\text{bar}=100~\text{kPa}` + * - electric potential + - :math:`\Psi` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}` + * - electric field + - :math:`\mathbf{E}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}` + * - compressibility + - :math:`\kappa` + - :math:`\text{mol}\,\text{kJ}^{-1}` + * - field-interaction + - :math:`\tilde\chi` + - :math:`\text{kJ}\,\text{mol}^{-1}` + +.. list-table:: **Constants** + :widths: 30 10 75 + :header-rows: 1 + + * - Constant + - Symbol + - Value + * - gas constant + - :math:`R` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Boltzmann’s constant + - :math:`k_\text{B}` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Avogadro's constant + - :math:`N_\text{A}` + - :math:`6.02214076 \cdot 10^23~\text{mol}^{-1}` + * - Vacuum permittivity + - :math:`\varepsilon_0` + - :math:`8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2` + * - Coulomb constant + - :math:`k_\text{e}` + - :math:`138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}` diff --git a/v1.0.2/_sources/doc_pages/electrostatics.rst.txt b/v1.0.2/_sources/doc_pages/electrostatics.rst.txt new file mode 100644 index 00000000..7e11c09d --- /dev/null +++ b/v1.0.2/_sources/doc_pages/electrostatics.rst.txt @@ -0,0 +1,48 @@ +.. _electrostatics-label: + +Electrostatic interactions +########################## +In the filtered Hamiltonian hPF formalism :cite:`bore2020hamiltonian` the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle--mesh Ewald. + +The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered + +.. math:: + + \tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i), + +with :math:`q_i` being the charge of particle :math:`i` and :math:`H` is the +filtering function (see :ref:`filtering-label`). The value of the charge grid at +vertex :math:`(i,j,k)` is found by + +.. math:: + + \tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)] + +and the electrostatic potential :math:`\Psi_{ijk}` + +.. math:: + + \Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right], + +where :math:`k_\text{e}` is the Coulomb constant :math:`1/4\pi\varepsilon_0`. +The *electric field* is obtained by differentiation of the electrostatic +potential in Fourier space, + +.. math:: + + \mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)] + +from which the forces are interpolated back to the particle positions. + +Specifying electrostatics +^^^^^^^^^^^^^^^^^^^^^^^^^ +In HyMD, electrostatics are specified by the :code:`coulombtype` and +:code:`dielectric_const` keywords in the configuration file (see +:ref:`config-label`) and the :code:`/charge` dataset in the HDF5 format +structure/topology input file (see :ref:`topology-label`). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions. diff --git a/v1.0.2/_sources/doc_pages/examples.rst.txt b/v1.0.2/_sources/doc_pages/examples.rst.txt new file mode 100644 index 00000000..9f9c3655 --- /dev/null +++ b/v1.0.2/_sources/doc_pages/examples.rst.txt @@ -0,0 +1,621 @@ +.. _examples-label: + +Examples +######## +The following examples are ordered in *more or less* order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the `HyMD-tutorial`_ github repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Ideal gas +========= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true + :align: right + :width: 200 + +The simplest possible system is one with no interactions at all---intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like: + + +.. code-block:: toml + :caption: **ideal_gas.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = false # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + +A simple input structure/topology file :code:`ideal_gas.HDF5` is available in +the `HyMD-tutorial/ideal_gas`_ github repository (along with the code to +generate it). Run the (very) short simulation by + +.. code:: bash + + python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field \ + --velocity-output \ + --force-output + +with the :code:`--disable-field` argument to completely turn off all +particle--field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook `ideal_gas.ipynb`_ for details. + + +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas +.. _ideal_gas.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.ipynb + + +Ideal chains +============ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true + :align: right + :width: 200 + +The simplest available interaction is the harmonic two-particle bond (see +:ref:`bonds-label`), + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2. + +Extending the configuration file from the ideal gas case, we need to add a +:code:`bonds` specification. Note that the :code:`[bonds]` meta specifier is not +necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **ideal_chain.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + +A simple input structure/topology file :code:`ideal_chain.HDF5` with a few +coiled up ideal chain polymers is available in the +`HyMD-tutorial/ideal_chain`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field + +we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +`ideal_chain.ipynb`_. + + +.. _HyMD-tutorial/ideal_chain: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_chain +.. _ideal_chain.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/ideal_chain.ipynb + + +Stiff rods +========== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true + :align: right + :width: 200 + +Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the :code:`i--j--k` angle :math:`\theta` (see +:ref:`bonds-label`), + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2. + +Extending the configuration file from the ideal chain case, we need to add a +:code:`angle_bonds` specification. Note that the :code:`[bonds]` meta specifier +is not necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **rods.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + + angle_bonds = [ + ["A", "A", "A", 180.0, 100.0], # (i, j, k, equilibrium angle, strength) + ] + + +A simple input structure/topology file :code:`rods.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook `rods.ipynb`_. + + +.. _HyMD-tutorial/rods: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/rods +.. _rods.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.ipynb + + + +Helixes +======= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true + :align: right + :width: 200 + +Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle :math:`\phi` between the +:code:`i--j--k` plane and the :code:`j--k--l` plane (see :ref:`bonds-label`), + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n). + +The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a :code:`dihedrals` keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the :code:`dielectric_const` +keyword even though we are not including electrostatic forces in the current +simulation. Note that the :code:`[bonds]` meta specifier is not necessary, but +may be used to help organise the input file. + +.. code-block:: toml + :caption: **helixes.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + dielectric_const = 15.0 + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.31, 10000.0], # (i name, j name, equilibrium length, strength) + ] + + dihedrals = [ + [ + ["A", "A", "A", "A"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0] + ], + ] + +A simple input structure/topology file :code:`helixes.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook `helixes.ipynb`_. + + +.. _HyMD-tutorial/helixes: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/helixes +.. _helixes.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.ipynb + + +Phase separation +================ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true + :align: right + :width: 200 + +The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types :code:`A` and :code:`B`. Using the Hamiltonian + +.. math:: + + \mathcal{H}=H_0+W + +with :math:`\tilde\chi`--dependent interactions defined by (specified in the +configuration file by :code:`hamiltonian = DefaultWithChi`): + +.. math:: + + W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2. + + +.. code-block:: toml + :caption: **phase_separation.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + + [field] + mesh_size = [20, 20, 20] # FFT grid size + sigma = 1.0 # filtering length scale in nm + kappa = 0.05 # compressibility in mol/kJ + chi = [ + ['A', 'B', 5.0], # (name i, name j, strength) + ] + +A simple input structure/topology file :code:`phase_separation.HDF5` containing +an equal number of :code:`A` type and :code:`B` type particles is available in +the `HyMD-tutorial/phase_separation`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd phase_separation.toml phase_separation.HDF5 + +we may examine the resulting trajectory. In the case of a low interaction +strength :math:`\tilde\chi` of :code:`5.0` (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to :code:`40.0` (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +`phase_separation.ipynb`_. + + +.. _HyMD-tutorial/phase_separation: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/phase_separation +.. _phase_separation.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/phase_separation.ipynb + + +Diblock copolymers +================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true + :align: right + :width: 200 + +Having introduced particle--field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive :math:`\tilde\chi`--interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the :code:`integrator = "respa"` keyword. Putting the pieces together, the +configuration file may look like the following: + +.. code-block:: toml + :caption: **copolymer.toml** + + [simulation] + integrator = "respa" + respa_inner = 15 + n_steps = 2000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [10.0, 10.0, 10.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [50, 50, 50] # FFT grid size + sigma = 0.5 # filtering length scale in nm + chi = [ + ["A", "B", 30.0], # (i, j, strength) + ] + + [bonds] + bonds = [ + ["A", "A", 0.25, 1500.0], # (i, j, equilibrium length, strength) + ["A", "B", 0.25, 1500.0], + ["B", "B", 0.25, 1500.0], + ] + angle_bonds = [ + ["A", "A", "A", 180.0, 25.0], # (i, j, k, equilibrium angle, strength) + ["B", "B", "B", 180.0, 25.0], + ] + +A simple input structure/topology file :code:`copolymer.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/copolymer`_ github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten :code:`A` followed by ten :code:`B` type particles. +Running the simulation with + +.. code:: bash + + python3 -m hymd copolymer.toml copolymer.HDF5 + +the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +`copolymer.ipynb`_. + + +.. _HyMD-tutorial/copolymer: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/copolymer +.. _copolymer.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer.ipynb + + +Lipid bilayer self-assembly +=========================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true + :align: right + :width: 300 + +Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field--particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the :code:`thermostat_coupling_groups` keyword. With parameters +optimised in :cite:`ledum2020automated`, the configuration file looks like: + + +.. code-block:: toml + :caption: **lipid_self_assembly.toml** + + [simulation] + integrator = "respa" + respa_inner = 25 + n_steps = 3000 + n_print = 200 + n_flush = 1 + time_step = 0.01 + box_size = [9.96924, 9.96924, 10.03970] + start_temperature = 323 + target_temperature = 323 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.05 + domain_decomposition = 10001 + cancel_com_momentum = true + max_molecule_size = 15 + thermostat_coupling_groups = [ + ["N", "P", "G", "C"], + ["W"], + ] + + [field] + mesh_size = [25, 25, 25] + sigma = 1.0 + chi = [ + ["C", "W", 42.24], + ["G", "C", 10.47], + ["N", "W", -3.77], + ["G", "W", 4.53], + ["N", "P", -9.34], + ["P", "G", 8.04], + ["N", "G", 1.97], + ["P", "C", 14.72], + ["P", "W", -1.51], + ["N", "C", 13.56], + ] + + [bonds] + bonds = [ + ["N", "P", 0.47, 1250.0], + ["P", "G", 0.47, 1250.0], + ["G", "G", 0.37, 1250.0], + ["G", "C", 0.47, 1250.0], + ["C", "C", 0.47, 1250.0], + ] + angle_bonds = [ + ["P", "G", "G", 120.0, 25.0], + ["P", "G", "C", 180.0, 25.0], + ["G", "C", "C", 180.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +A randomly mixed input structure/topology file +:code:`lipid_self_assembly.HDF5` with a few hundred lipids in a roughy +:code:`10 x 10 x 10nm` box is available in the +`HyMD-tutorial/lipid_self_assembly`_ github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation + +.. code:: bash + + python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5 + +we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook `lipid_self_assembly.ipynb`_. + + +.. _HyMD-tutorial/lipid_self_assembly: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/lipid_self_assembly +.. _lipid_self_assembly.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/lipid_self_assembly.ipynb + + +Peptide in lipid bilayer +======================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true + :align: right + :width: 300 + +Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer. + + +The `configuration file`_ is available in the `HyMD-tutorial/peptide`_ github +repository (omitted here for brevity). + +A pre-equilibrated input structure/topology file :code:`peptide.HDF5` with a +few hundred lipids in a roughy :code:`20 x 20 x 20nm` box is available in the +`HyMD-tutorial/peptide`_ github repository. Running the simulation + +.. code:: bash + + python3 -m hymd peptide.toml peptide.HDF5 + +we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook `peptide.ipynb`_. + + +.. _HyMD-tutorial/peptide: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/peptide +.. _configuration file: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.toml +.. _peptide.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.ipynb + + +SDS +=== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true + :align: right + :width: 300 + +The last part we introduce is explicit electrostatic interactions through +particle--mesh Ewald. Enabling the electrostatic calculations is done via the +:code:`coulombtype` keyword. :code:`"PIC_Spectral"` is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the :code:`dielectric_const` keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge. + + + +.. code-block:: toml + :caption: **sds.toml** + + [simulation] + integrator = "respa" + respa_inner = 10 + n_steps = 3000 + n_print = 1500 + n_flush = + time_step = 0.01 + box_size = [8.3, 8.3, 8.3] + start_temperature = 298 + target_temperature = 298 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.1 + domain_decomposition = 10000 + cancel_com_momentum = true + max_molecule_size = 5 + thermostat_coupling_groups = [ + ["S", "C"], + ["W", "Na"], + ] + dielectric_const = 45.0 # dielectric constant for the simulation medium + coulombtype = "PIC_Spectral" # particle in cloud, spectral method + + [field] + mesh_size = [64, 64, 64] + sigma = 0.5 + chi = [ + ["S", "C", 13.50], + ["S", "Na", 0.00], + ["S", "W", -3.60], + ["C", "Na", 13.50], + ["C", "W", 33.75], + ["W", "Na", 0.00], + ] + + [bonds] + bonds = [ + ["S", "C", 0.50, 1250.0], + ["C", "C", 0.50, 1250.0], + ] + angle_bonds = [ + ["S", "C", "C", 170.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +An input structure/topology file :code:`sds.HDF5` with a couple thousand +randomly dispersed SDS chains is available in the `HyMD-tutorial/sds`_ github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a :code:`/charge` dataset. +Running the simulation with + +.. code:: bash + + python3 -m hymd sds.toml sds.HDF5 + +we observe the aggregation of the SDS into micellular structures---first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook `sds.ipynb`_. + + +.. _HyMD-tutorial/sds: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/sds +.. _sds.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/sds.ipynb diff --git a/v1.0.2/_sources/doc_pages/filtering.rst.txt b/v1.0.2/_sources/doc_pages/filtering.rst.txt new file mode 100644 index 00000000..02af68c6 --- /dev/null +++ b/v1.0.2/_sources/doc_pages/filtering.rst.txt @@ -0,0 +1,30 @@ +.. _filtering-label: + +Filtering +######### +The default grid-independent filter function used in HyMD is a Gaussian + +.. math:: + + H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] + +with reciprocal space representation + +.. math:: + + \hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +The coarse-graining parameter :math:`\sigma` determines a length scale of +particle extent and is given as configuration file input by + +.. code:: toml + + sigma = 0.75 + + +Implementing new filters +^^^^^^^^^^^^^^^^^^^^^^^^ +Implementing new filter functions is straightforward by hijacking +the :code:`setup` method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional. diff --git a/v1.0.2/_sources/doc_pages/installation.rst.txt b/v1.0.2/_sources/doc_pages/installation.rst.txt new file mode 100644 index 00000000..7cdc0d68 --- /dev/null +++ b/v1.0.2/_sources/doc_pages/installation.rst.txt @@ -0,0 +1,144 @@ +.. _installation-label: + +Installation +############ +HyMD may be installed using :code:`pip` by + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + + +Dependencies +============ +HyMD **requires** a working MPI compiler and HDF5. On an Ubuntu system, this +may be installed via + +.. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y libhdf5-openmpi-dev python3-mpi4py + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-cache-dir --no-binary=h5py h5py + +It is **highly recommended** to have MPI-enabled HDF5 and h5py. A +non-MPI-enabled h5py may be installed by simply + +.. code-block:: bash + + sudo apt-get update -y + sudo apt-get install libhdf5-serial-dev + python3 -m pip --upgrade install h5py + +A non-MPI-enabled HDF5 library with corresponding :code:`h5py` will work +(mostly), but is inconvenient and slow. Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +:code:`--disable-mpio` argument to HyMD, see :ref:`commandline-label`. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial. + +Install in docker +================= +A docker image with build essentials setup is available at `dockerhub`_ with tag +:code:`mortele/hymd`, + +.. code-block:: bash + + docker pull mortele/hymd:1.0 + docker run -it mortele/hynd:1.0 + /app# python3 -m pip install hymd + /app# python3 -m hymd [CONFIGURATION_FILE] [TOPOLOGY_FILE] + +.. _dockerhub: + https://hub.docker.com/repository/docker/mortele/hymd + + +Common issues +============= + +Numpy errors while importing the Fortran force kernels +------------------------------------------------------ + +.. code-block:: python3 + + RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd + + Traceback (most recent call last): + + (...) + + File "/..../HyMD/hymd/__init__.py", line 2, in + from .main import main # noqa: F401 + File "/..../HyMD/hymd/main.py", line 10, in + from .configure_runtime import configure_runtime + File "/..../hymd/configure_runtime.py", line 12, in + from .input_parser import read_config_toml, parse_config_toml + File "/..../HyMD/hymd/input_parser.py", line 12, in + from .force import Bond, Angle, Dihedral, Chi + File "/..../HyMD/hymd/force.py", line 8, in + from force_kernels import ( # noqa: F401 + ImportError: numpy.core.multiarray failed to import + +can normally be fixed by updating numpy versions, + +.. code-block:: bash + + python3 -m pip install -U numpy + + +Error building pfft-python due to missing curl/wget +--------------------------------------------------- + +.. code-block:: python3 + + Building wheel for pfft-python (setup.py) ... error + ERROR: Command errored out with exit status 1: + command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_ + cwd: /tmp/pip-install-fr6nt9m4/pfft-python/ + Complete output (56 lines): + running bdist_wheel + running build + running build_py + + (...) + + curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found + wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found + Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + Please check curl or wget + You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ + Traceback (most recent call last): + File "", line 1, in + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in + setup( + File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup + return distutils.core.setup(**attrs) + File "/usr/lib/python3.8/distutils/core.py", line 148, in setup + + (...) + + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions + build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:])) + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft + raise ValueError("could not build fftw; check MPICC?") + ValueError: could not build fftw; check MPICC? + ---------------------------------------- + ERROR: Failed building wheel for pfft-python + Running setup.py clean for pfft-python + Failed to build pfft-python + +can be fixed by installing either `curl`_ or `wget`_ + +.. code-block:: bash + + apt-get install -y curl wget + + +.. _`curl`: + https://curl.se/ + +.. _`wget`: + https://www.gnu.org/software/wget/ diff --git a/v1.0.2/_sources/doc_pages/interaction_energy_functionals.rst.txt b/v1.0.2/_sources/doc_pages/interaction_energy_functionals.rst.txt new file mode 100644 index 00000000..f33c004e --- /dev/null +++ b/v1.0.2/_sources/doc_pages/interaction_energy_functionals.rst.txt @@ -0,0 +1,98 @@ +.. _functionals-label: + +Interaction energy functionals +############################## +A few interaction energy functionals :math:`W` are defined in HyMD through +the :code:`Hamiltonian` class and associated subclasses. + +:math:`\chi`--interaction and :math:`\kappa`--incompressibility +=============================================================== +The most common hPF energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultWithChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where :math:`\tilde\chi_{\text{A}-\text{B}}` is the interaction energy between +overlapping densities of particle types :math:`\text{A}` and :math:`\text{B}`. +The incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\tilde\chi` +and :math:`\kappa` in the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + chi = [ + ["A", "B", 15.85], + ["B", "C", -5.70], + ... + ] + +Only :math:`\kappa`--incompressibility +====================================== +The only :math:`\kappa` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultNoChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where the incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Only :math:`\phi^2` +=================== +The :math:`\phi^2` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "SquaredPhi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2, + +where the :math:`\phi` squared term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Implementing new interaction energy forms +========================================= +Implementing new interaction energy functions is straightforward by subclassing +:code:`Hamiltonian` and applying :code:`sympy` differentiation to the symbolic +field objects. The :code:`sympy.lamdify` function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields. diff --git a/v1.0.2/_sources/doc_pages/intramolecular_bonds.rst.txt b/v1.0.2/_sources/doc_pages/intramolecular_bonds.rst.txt new file mode 100644 index 00000000..820e81bc --- /dev/null +++ b/v1.0.2/_sources/doc_pages/intramolecular_bonds.rst.txt @@ -0,0 +1,142 @@ +.. _bonds-label: + +Intramolecular bonds +#################### + +Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see :ref:`config-label`. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +:ref:`benchmarks-label`), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable. + +All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]). + + +Two-particle bonds +^^^^^^^^^^^^^^^^^^ +Stretching bonds in HyMD are implemented as harmonic spring potentials, + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2, + +where :math:`r=|\mathbf{r}|` is the inter-particle distance, :math:`k` is a +constant of dimension energy (units :math:`\text{kJ}\,\text{mol}^{-1}`), and +:math:`r_0` is the equilibrum length of the bond (units: :math:`\text{nm}`). The +force is calculated as + +.. math:: + + F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r}, + +where :math:`\mathbf{r}` is the vector pointing *from* :math:`i` *to* :math:`j`. + +In the configuration file, two-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_two_particle_example.toml + + [bonds] + bonds = [ + ["A", "A", 0.47, 1250.0], + ["A", "B", 0.37, 940.0], + ["B", "C", 0.50, 1010.0], + ["C", "A", 0.42, 550.0], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Three-particle bonds +^^^^^^^^^^^^^^^^^^^^ +Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle--particle--particle angle :math:`\theta`, + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2, + +where :math:`k` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}`), and :math:`\theta_0` is the equilibrum +angle of the bond (units: :math:`{}^\circ`). Defining the particles with labels +:math:`a`, :math:`b`, and :math:`c`, let :math:`\mathbf{r}_a` denote the vector +pointing from :math:`b` to :math:`a`, and correspondingly let +:math:`\mathbf{r}_c` point from :math:`b` to :math:`c`. The +:math:`a`--:math:`b`--:math:`c` may be computed through the law of Cosines, + +.. math:: + + \theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right] + +Then the force acting on :math:`a` and :math:`c` is + +.. math:: + + \mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a}, + + \mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c}, + +and + +.. math:: + + \mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c + +In the configuration file, three-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_three_particle_example.toml + + [bonds] + angle_bonds = [ + ["A", "A", "A", 180.0, 90.0], + ["A", "B", "A", 120.0, 55.0], + ["B", "C", "C", 30.0, 10.0], + ["C", "A", "B", 110.0, 25.5], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Four-particle bonds +^^^^^^^^^^^^^^^^^^^ +Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle :math:`\phi` between the +:math:`a`--:math:`b`--:math:`c` and :math:`b`--:math:`c`--:math:`d` planes, for +a dihedral bond quartet :math:`a`, :math:`b`, :math:`c`, and :math:`d`. The +potential takes the form + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n), + +where :math:`c_n` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`), and :math:`\phi_n` are +specified phase angles in the cosine series. + +In the configuration file, four-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_four_particle_example.toml + + [bonds] + dihedrals = [ + ["A", "B", "C", "D"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0], + ] diff --git a/v1.0.2/_sources/doc_pages/overview.rst.txt b/v1.0.2/_sources/doc_pages/overview.rst.txt new file mode 100644 index 00000000..0e4d6b65 --- /dev/null +++ b/v1.0.2/_sources/doc_pages/overview.rst.txt @@ -0,0 +1,166 @@ +.. _overview-label: + +================================ + Usage overview for HylleraasMD +================================ + +HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a `toml`_ format configuration file, along with a topology and structure +file specifying the input system in HDF5 format. + +.. _`toml`: + https://github.com/toml-lang/toml + +**Configuration file** + +The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a :code:`[5, 5, 5]` nm simulation box at 300 K may look like +the following: + +.. code-block:: toml + :caption: **config_simple_1.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "SquaredPhi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [30, 30, 30] # FFT grid size + sigma = 0.5 # filtering length scale in nm + +Note that for the version 1.0 release of HyMD, the :code:`[particles]`, +:code:`[simulation]`, and :code:`[field]` groups are optional specifiers for +structuring the configuration file. + +For a full specification of every recognised configuration keyword in HyMD, +please refer to :ref:`config-label`. + +**Topology and structure file** + +The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +:code:`N` particles may look like the following: + +.. code-block:: bash + :caption: **example_structure.HDF5** + + group / + # root group + + dataset /coordinates + # float32, shape (T, N, D,) + # Time steps of N rows of D dimensional coordinate data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /velocities + # float32, shape (T, N, D,) OPTIONAL + # Time steps of N rows of D dimensional velocity data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /bonds + # int32, shape (N, B,) OPTIONAL + # Each row i contains indices of the particles bonds from/to i + # B denotes the maximum bonds per particle + + dataset /indices + # int32, shape (N,) + # Index of each particle, 0--(N-1) + + dataset /molecules + # int32, shape (N,) + # Index of molecule each particle belongs to + # Used to construct bond network locally on MPI ranks + + dataset /names + # str10, shape (N,) + # Fixed size string array containing particle type names + + dataset /types + # int32, shape (N,) OPTIONAL + # Mapping of particle names to type indices + + +For a full specification of the topology and structure input file, see +:ref:`topology-label`. + +**Command line arguments** + +A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the :code:`config_simple_1.toml` and :code:`example_structure.HDF5` +files may look like the following: + +.. code-block:: bash + + mpirun -n ${MPI_NUM_RANKS} python3 -m hymd \ # HyMD executable + config_simple_1.toml \ # configuration file + example_structure.HDF5 \ # structure file + --logfile=log_out.txt \ # set logfile path + --seed 123456 \ # set random seed + --verbose 2 \ # set logging verbosity + --velocity-output # enable velocity in trajectory output + +For a full specification of all command line arguments, see +:ref:`commandline-label`. + +**More examples** + +For more thorough rundown and concrete usage examples, see +:ref:`examples-label`. + +Running parallel simulations +============================ +Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the **only** difference being how the python3 interpreter is +invoked. Prepending :code:`mpirun -n ${NPROCS}` to the usual +:code:`python3 -m hymd` runs the simulation with :code:`${NPROCS}` MPI ranks. + +Inputting + +.. code:: bash + + mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field + +sets up an example simulation of the `HyMD-tutorial/ideal_gas`_ system. For +more details about this system in particular, or other example simulations, see +the `HyMD-tutorial`_ repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas + + +Running tests +============= +Run serial code tests by + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd + cd hymd/ + python3 -m pip install pytest pytest-mpi + python3 -m pytest + +There is a small convenience script in :code:`hymd/` for running the MPI-enabled +tests, + +.. code-block:: bash + + chmod +x pytest-mpi + ./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no diff --git a/v1.0.2/_sources/doc_pages/theory.rst.txt b/v1.0.2/_sources/doc_pages/theory.rst.txt new file mode 100644 index 00000000..95d7842c --- /dev/null +++ b/v1.0.2/_sources/doc_pages/theory.rst.txt @@ -0,0 +1,114 @@ +.. _theory-label: + +Theory +###### +Hybrid particle--field simulations switch out the ordinary particle--particle +`Lennard-Jones`_ interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle--field densities are +defined as + +.. math:: + + \phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i), + +where :math:`\mathbf{r}` is a spatial coordinate, :math:`P` is a window function +used to distribute particle number densities onto a computational grid, and +:math:`\mathbf{r}_i` is the position of particle :math:`i` (of total :math:`N`). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of :math:`N` particles in :math:`M` molecules is + +.. math:: + + \mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})] + +with :math:`H_0` being a standard intramolecular Hamiltonian form (see +:ref:`bonds-label`) including kinetic terms, while :math:`W` is a density +dependent *interaction energy functional*. + +In the Hamiltonian hPF-MD formalism :cite:`bore2020hamiltonian`, the density +field is filtered using a grid-independent filtering function :math:`H`, + +.. math:: + + \tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}). + +The filter smooths the density, ensuring that :math:`\tilde\phi` and +:math:`W[\tilde\phi([\phi])]` both converge as the grid size is reduced. + +External potential +================== +The external potential acting on a particle is defined as the functional +derivative of :math:`W` with respect to :math:`\phi`. In the filtered formalism, +the potential takes the form + +.. math:: + + V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ + &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})}, + +under the assumption of a *local* form of the interaction energy functional, +:math:`W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]`. Note +that + +.. math:: + + \frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}). + +Force interpolation +=================== +The forces on particle :math:`i` are obtained by differentiation of the external +potential, + +.. math:: + + \mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i). + + +Reciprocal space calculations +============================= +The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density :math:`\phi_{ijk}` with CIC, we apply the filtering +and obtain the discrete version of the external potential by + +.. math:: + + \tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big] + +and + +.. math:: + + V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +The forces are obtained by differentiation of :math:`V` in Fourier space as + +.. math:: + + \nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +Filter +====== +By default, the filter used in HyMD is a simple Gaussian of the form + +.. math:: + + H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ + \hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +For more details about the filtering, see :ref:`filtering-label`. + +Hamiltonian form +================ +The default form of the interaction energy functional in HyMD is + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2. + +See :ref:`functionals-label` for details. + + +.. _`Lennard-Jones`: + https://en.wikipedia.org/wiki/Lennard-Jones_potential diff --git a/v1.0.2/_sources/doc_pages/topology_input.rst.txt b/v1.0.2/_sources/doc_pages/topology_input.rst.txt new file mode 100644 index 00000000..adabe129 --- /dev/null +++ b/v1.0.2/_sources/doc_pages/topology_input.rst.txt @@ -0,0 +1,77 @@ +.. _topology-label: + +============================ +Topology and structure file +============================ +The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root :code:`/` group. + +The `HyMD-tutorial`_ has multiple examples of structure files for various levels +of complexity. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Required datasets +================= +:/coordinates: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/indices: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/names: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`string` (:code:`length` between :code:`1` and :code:`16`)] + + The shape represents one particle name per :code:`N` particles. The datatype may be a string of length :code:`=<16`. + + + +Optional datasets +================= +:/velocities: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/types: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle type index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/molecules: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one molecule index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/bonds: + :code:`array` shape [:code:`N`, :code:`B`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents :code:`B` bond specifications (indices of different particles) per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/charge: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents one particle charge per :code:`N` particles. The data type may be either four or eight byte reals. diff --git a/v1.0.2/_sources/index.rst.txt b/v1.0.2/_sources/index.rst.txt new file mode 100644 index 00000000..435d79f3 --- /dev/null +++ b/v1.0.2/_sources/index.rst.txt @@ -0,0 +1,157 @@ +.. hymd documentation master file, created by + sphinx-quickstart on Thu Dec 16 13:31:43 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +############################### +HylleraasMD documentation +############################### + +:Release: + |release| +:Date: + |today| + +**HylleraasMD** (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems. + +HyMD can run canonical hPF-MD simulations :cite:`Milano2009JCP`, or filtered +density Hamiltonian hPF (HhPF-MD) simulations :cite:`bore2020hamiltonian`, with +or without explicit PME electrostatic interactions :cite:`kolli2018JCTC`. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +:cite:`Cascella2008,bore2018hybrid`. Martini +style elastic networks (ElNeDyn) :cite:`periole2009combining` are also +supported. + +HyMD uses the pmesh (`github.com/rainwoodman/pmesh`_) library for particle-mesh +operations, with the PPFT :cite:`pippig2013pfft` backend for FFTs through the +pfft-python bindings (`github.com/rainwoodman/pfft-python`_). File IO is done +via HDF5 formats to allow MPI parallel reads. + +User Guide +========== +The HylleraasMD :doc:`User Guide ` provides comprehensive information on how to run +simulations. Selected :doc:`Examples ` are available to guide new users. + +.. _`github.com/rainwoodman/pmesh`: + https://github.com/rainwoodman/pmesh +.. _`github.com/rainwoodman/pfft-python`: + https://github.com/rainwoodman/pfft-python + +Installing HyMD +=============== +The easiest approach is to install using pip_: + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + +For more information and **required dependencies**, see +:ref:`installation-label`. + +.. _pip: + http://www.pip-installer.org/en/latest/index.html + +Source Code +=========== +**Source code** is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the `GNU Lesser General Public +License v3.0`_. Obtain the source code with `git`_: + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git + +.. _GNU Lesser General Public License v3.0: + https://www.gnu.org/licenses/lgpl-3.0.html +.. _git: + https://git-scm.com/ + + +Development +=========== +HyMD is developed and maintained by researchers at the `Hylleraas Centre for +Quantum Molecular Sciences`_ at the `University of Oslo`_. + +|pic1| |pic2| + +.. _`Hylleraas Centre for Quantum Molecular Sciences`: + https://www.mn.uio.no/hylleraas/english/ +.. _`University of Oslo`: + https://www.uio.no/ + +.. |pic1| image:: img/hylleraas_centre_logo_black.png + :target: img/hylleraas_centre_logo_black.png + :width: 250 px + +.. |pic2| image:: img/uio_full_logo_eng_pos.png + :target: img/uio_full_logo_eng_pos.png + :width: 325 px + + + +References +========== +.. bibliography:: + :all: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. Contents +.. ======== + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Getting started + + ./doc_pages/installation + ./doc_pages/overview + ./doc_pages/config_file + ./doc_pages/topology_input + ./doc_pages/command_line + ./doc_pages/constants_and_units + + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Examples + + ./doc_pages/examples + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Theory + + ./doc_pages/theory + ./doc_pages/intramolecular_bonds + ./doc_pages/electrostatics + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Developer documentation + + ./doc_pages/interaction_energy_functionals + ./doc_pages/filtering + ./doc_pages/benchmarks + ./doc_pages/api diff --git a/v1.0.2/_static/basic.css b/v1.0.2/_static/basic.css new file mode 100644 index 00000000..be19270e --- /dev/null +++ b/v1.0.2/_static/basic.css @@ -0,0 +1,856 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/v1.0.2/_static/css/badge_only.css b/v1.0.2/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/v1.0.2/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/v1.0.2/_static/css/fonts/Roboto-Slab-Bold.woff b/v1.0.2/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/v1.0.2/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/v1.0.2/_static/css/fonts/Roboto-Slab-Bold.woff2 b/v1.0.2/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/v1.0.2/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/v1.0.2/_static/css/fonts/Roboto-Slab-Regular.woff b/v1.0.2/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/v1.0.2/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/v1.0.2/_static/css/fonts/Roboto-Slab-Regular.woff2 b/v1.0.2/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/v1.0.2/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/v1.0.2/_static/css/fonts/fontawesome-webfont.eot b/v1.0.2/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/v1.0.2/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/v1.0.2/_static/css/fonts/fontawesome-webfont.svg b/v1.0.2/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/v1.0.2/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v1.0.2/_static/css/fonts/fontawesome-webfont.ttf b/v1.0.2/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/v1.0.2/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/v1.0.2/_static/css/fonts/fontawesome-webfont.woff b/v1.0.2/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/v1.0.2/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/v1.0.2/_static/css/fonts/fontawesome-webfont.woff2 b/v1.0.2/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/v1.0.2/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/v1.0.2/_static/css/fonts/lato-bold-italic.woff b/v1.0.2/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/v1.0.2/_static/css/fonts/lato-bold-italic.woff differ diff --git a/v1.0.2/_static/css/fonts/lato-bold-italic.woff2 b/v1.0.2/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/v1.0.2/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/v1.0.2/_static/css/fonts/lato-bold.woff b/v1.0.2/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/v1.0.2/_static/css/fonts/lato-bold.woff differ diff --git a/v1.0.2/_static/css/fonts/lato-bold.woff2 b/v1.0.2/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/v1.0.2/_static/css/fonts/lato-bold.woff2 differ diff --git a/v1.0.2/_static/css/fonts/lato-normal-italic.woff b/v1.0.2/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/v1.0.2/_static/css/fonts/lato-normal-italic.woff differ diff --git a/v1.0.2/_static/css/fonts/lato-normal-italic.woff2 b/v1.0.2/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/v1.0.2/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/v1.0.2/_static/css/fonts/lato-normal.woff b/v1.0.2/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/v1.0.2/_static/css/fonts/lato-normal.woff differ diff --git a/v1.0.2/_static/css/fonts/lato-normal.woff2 b/v1.0.2/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/v1.0.2/_static/css/fonts/lato-normal.woff2 differ diff --git a/v1.0.2/_static/css/theme.css b/v1.0.2/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/v1.0.2/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/v1.0.2/_static/custom.css b/v1.0.2/_static/custom.css new file mode 100644 index 00000000..b20d6282 --- /dev/null +++ b/v1.0.2/_static/custom.css @@ -0,0 +1,91 @@ + +body{ + background: #FFFFFF !important; +} + +.wy-menu-vertical header, .wy-menu-vertical p.caption{ + color: #4EA0AF!important; +} +.wy-menu-vertical li.current{ + background-color: #f4f4f4!important; +} +.wy-menu-vertical li.toctree-l2.current>a{ + background-color: #ebebeb!important; +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{ + background-color: #e3e3e3!important; +} + +.rst-content .sidebar{ + background-color: #fff!important; + border-radius: 6px; + -moz-border-radius: 6px; + -webkit-border-radius: 6px; +} + +h1 > a, h2 > a, h3 > a, h4 > a, h5 > a, h6 > a { + color: #17d9ff; +} + +h1, h2, h3, h4, h5, h6 { + color: black; + font-weight: normal; + padding: 0; +} + +h1, h2, h3 { + margin-top: 30px; + margin-bottom: 20px; +} + +h1 { + color: white; + padding: 20px 20px 20px 45px; + margin: 20px 0 35px -45px; + background: linear-gradient(to left, #fff, #2b38ff)!important; + + width: calc(100% + 90px); + border-bottom: 3px solid #000; +} + +h2 { + padding: .2em 0; + border-bottom: 1px solid #ddd; +} + +h3 { + margin-top: 35px; +} + +h4 { + margin-top: 30px; +} + +h5 { + margin-top: 25px; +} + +.wy-nav-content{ + max-width: none!important; +} + +.wy-side-nav-search{ + background: #2b38ff!important; +} + +.wy-side-nav-search input[type=text]{ + border-color:#4DA0B0!important; +} + +.wy-side-nav-search input[type=text]{ + border-radius: 4px!important; +} + +#caption-api { + background: red !important; +} + +#caption-text-api { + text-color: blue !important; +} diff --git a/v1.0.2/_static/doctools.js b/v1.0.2/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/v1.0.2/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/v1.0.2/_static/documentation_options.js b/v1.0.2/_static/documentation_options.js new file mode 100644 index 00000000..52be6075 --- /dev/null +++ b/v1.0.2/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '1.0.2', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/v1.0.2/_static/file.png b/v1.0.2/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/v1.0.2/_static/file.png differ diff --git a/v1.0.2/_static/hymd_icon_white.png b/v1.0.2/_static/hymd_icon_white.png new file mode 100644 index 00000000..d0396a17 Binary files /dev/null and b/v1.0.2/_static/hymd_icon_white.png differ diff --git a/v1.0.2/_static/hymd_logl_white_text_abbr.png b/v1.0.2/_static/hymd_logl_white_text_abbr.png new file mode 100644 index 00000000..8c0e50c8 Binary files /dev/null and b/v1.0.2/_static/hymd_logl_white_text_abbr.png differ diff --git a/v1.0.2/_static/jquery-3.5.1.js b/v1.0.2/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/v1.0.2/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. API reference

+
+

4.1. Integrator

+

Integrates equations of motion.

+

Implements the Velocity Verlet integrator. The reversible reference system +propagator algorithm (rRESPA) integrator uses the Velocity Verlet functions +inside the MD loop in the main module.

+
+
+hymd.integrator.integrate_position(positions, velocities, time_step)[source]
+

Position update step of the Velocity Verlet integration algorithm.

+

Computes the position update step of the Velocity Verlet algorithm. The +positions argument is not changed in place.

+
+
Parameters:
+
+
positions(N, D) numpy.ndarray

Array of positions of N particles in D dimensions.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_velocity

The velocity update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step, then the positions are updated a full step using the updated +velocities

+
+\[\mathbf{x}_{\text{new}} = \mathbf{x} + \Delta t \mathbf{v}\]
+
+ +
+
+hymd.integrator.integrate_velocity(velocities, accelerations, time_step)[source]
+

Velocity update step of the Velocity Verlet integration algorithm.

+

Computes the velocity update step of the Velocity Verlet algorithm. The +velocities argument is not changed in place.

+
+
Parameters:
+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
accelerations(N, D) numpy.ndarray

Array of accelerations of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_position

The position update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step

+
+\[\mathbf{v}_{\text{new}} = \mathbf{v} + \frac{\Delta t}{2m} +\mathbf{f}\]
+

before the positions are moved a full step using the updated half-step +velocities.

+
+ +
+
+

4.2. Thermostat

+

Scales or otherwise modifies the particle velocities during simulation to +simulate coupling to an external heat bath with temperature T₀.

+
+
+hymd.thermostat._random_chi_squared(prng: numpy.random._generator.Generator, M: int)float[source]
+

Draw the sum of M squared normally distributed values

+

The value is generated by the Gamma distribution, in lieu of generating +M Gaussian distributed numbers and summing their squares.

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
Mint

Number of standard normally distributed numbers in the sum.

+
+
+
+
Returns:
+
+
float

The sum of M squared normally distributed values centered at +zero with unit standard deviation.

+
+
+
+
+

Notes

+

The sum of the squares of k independent standard normal random variables is +distributed according to a \(\chi^2\) distribution.

+
+\[\chi^2_1 + \chi_2^2 + \chi_3^2 + \dots + \chi_M^2 +\sim +\sigma^2\chi^2(k)\]
+

This is a special case of the \(\Gamma\) distribution, +\(\Gamma(k/2, 2)\), and may be generated by

+
+\[\chi^2(k) \sim 2 \Gamma(k/2, 2)\]
+

References

+

Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of +Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. +J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246.

+
+ +
+
+hymd.thermostat._random_gaussian(prng: numpy.random._generator.Generator)float[source]
+

Draw a single random number from the standard normal distribution +Generate a number from the Gaussian distribution centered at zero with unit +standard deviation, \(N(0, 1)\).

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
+
+
Returns:
+
+
float

A random number drawn from \(N(0, 1)\).

+
+
+
+
+
+ +
+
+hymd.thermostat.csvr_thermostat(velocity: numpy.ndarray, names: numpy.ndarray, config: hymd.input_parser.Config, prng: numpy.random._generator.Generator, comm: mpi4py.MPI.Intracomm = <mpi4py.MPI.Intracomm object>, random_gaussian: Callable[[numpy.random._generator.Generator], float] = <function _random_gaussian>, random_chi_squared: Callable[[numpy.random._generator.Generator, int, float], float] = <function _random_chi_squared>, remove_center_of_mass_momentum: bool = True)numpy.ndarray[source]
+

Canonical sampling through velocity rescaling thermostat

+

Implements the CSVR thermostat. Rescales the system kinetic energy by a +stochastically chosen factor to keep the temperature constant. Requires +communcation of the kinetic energies calculated locally for each MPI rank. +The random numbers sampled through random_gaussian and +random_chi_squared are broadcast from the root rank to the other +ranks to ensure the scaling is performed with the same stochasticity for +all particles in the full system.

+

The velocities are cleaned of center of mass momentum before the thermostat +is applied, and the center of mass momentum is subsequently reapplied. This +is performed for each thermostat coupling group, i.e. the center of mass +momenta of each group is separately removed and reapplied after +thermostatting.

+

The implementation here is based on the derivation presented in the 2008 +Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper.

+
+
Parameters:
+
+
velocity(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
names(N,) numpy.ndarray

Array of particle names.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
random_gaussiancallable, optional

Function for generating standard normally distributed numbers.

+
+
random_chi_squaredcallable, optional

Function for generating \(\chi^2\)-distributed numbers

+
+
remove_center_of_mass_momentumbool, optional

If True, the center of mass of each coupling group is removed before +the thermostat is applied. The center of mass momenta are added back +after the kinetic energy rescaling is complete.

+
+
+
+
+
+

See also

+
+
_random_gaussian

Used to sample Gaussian-distributed numbers.

+
+
_random_chi_squared

Used to sample \(\chi^2\)-distributed numbers.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +

References

+

G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). +G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008).

+
+ +
+
+

4.3. Hamiltonian

+
+
+class hymd.hamiltonian.Hamiltonian(config)[source]
+

Interaction energy functional superclass

+
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+_setup()[source]
+

Superclass setup

+

Sets up the grid-independent filtering function H, and the +SymPy logic for symbolically differentiating interaction energy +functionals in Hamiltonian subclasses.

+
+ +
+ +
+
+class hymd.hamiltonian.SquaredPhi(config)[source]
+

Simple squared density interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + \sum_k \tilde\phi_k + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(rho_0\) is the +average density of the fully homogenous system. Expressing the species +densities in terms of fluctuations from the average,

+
+\[\mathrm{d}\tilde\phi_k = \rho_0 - \tilde\phi_k,\]
+

it is evident that this interaction energy functional is a slight change of +the DefaultNoChi Hamiltonian, as the expanded interaction energy +density becomes

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + 6\rho_0\left[ + \sum_k \mathrm{d}\tilde\phi_k + \right] + + + 9\rho_0^2 + + + \sum_k \mathrm{d}\tilde\phi_k^2 + + + \prod_{k\not=l} + \mathrm{d}\tilde\phi_k \mathrm{d}\tilde\phi_l + \right),\]
+

identical to DefaultNoChi apart from a constant energy shift +\(9\rho_0^2`(which does not impact dynamics) and the +:math:\)rho_0`–\(\mathrm{d}\tilde\phi_k\) cross-terms. These +cross-terms constitute contributions to the energy linear in +\(\mathrm{d}\tilde\phi_k\) absent in DefaultNoChi, which has +only quadratic terms present.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultNoChi(config)[source]
+

Incompressibility-only interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a +\right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. The SquaredPhi Hamiltonian implements a similar +functional with an additional linear term component depending on

+
+\[\mathmr{d}\tilde\phi_k = \tilde\phi_k - \rho_0\]
+

and not \(\mathrm{d}\tilde\phi_k^2\). No explicit inter-species +interaction is present apart from the indirect interaction through the +incompressibility.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultWithChi(config, unique_names, type_to_name_map)[source]
+

Incompressibility and \(\chi\)-interactions energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = + \frac{1}{2\rho_0} + \sum_{k,l}\chi_{kl} \tilde\phi_k \tilde\phi_l + + + \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. \(\chi_{ij}\) is the Flory-Huggins-like +inter-species mixing energy.

+
+
+__init__(config, unique_names, type_to_name_map)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup(unique_names, type_to_name_map)[source]
+

Setup the interaction energy potential and the external potential

+
+
Parameters:
+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+ +
+ +
+
+

4.4. Force

+

Calculates intramolecular forces between bonded particles in molecules

+
+
+class hymd.force.Angle(atom_1: str, atom_2: str, equilibrium: float, strength: float, atom_3: str)[source]
+

Dataclass representing a single three-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any three-particle bond between particles of specific types A, +B, and C (where A, B, and C may be +different or the same). Harmonic angular three-particle bonds in HyMD take +the form

+
+\[V_3(\mathbf{r}_1, \mathbf{r}_2, \mathbf{r}_3) = + \frac{1}{2}k + \left( + \cos^{-1} + \left[ + \frac{ + (\mathbf{r}_1-\mathbf{r}_2) + \cdot + (\mathbf{r}_3-\mathbf{r}_2) + } + { + \vert\mathbf{r}_1-\mathbf{r}_2\vert + \vert\mathbf{r}_3-\mathbf{r}_2\vert + } + \right] - \theta_0 + \right)^2\]
+
+

See also

+
+
Bond

Two-particle bond type dataclass

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
equilibriumfloat

Equilibrium angle at which the energy associated with the +three-particle angular bond vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient.

+
+
+
+
+
+
+atom_3: str
+
+ +
+ +
+
+class hymd.force.Bond(atom_1: str, atom_2: str, equilibrium: float, strength: float)[source]
+

Dataclass representing a single two-particle bond type

+

A bond type is a bond strength and equilibrium distance associated with +any bond between particles of specific types A and B +(where A and B may be the same or different). Harmonic +two-particle bonds in HyMD take the form

+
+\[V_2(\mathbf{r}_1, \mathbf{r}_2) = + \frac{1}{2}k + \left( + \vert \mathbf{r}_1 - \mathbf{r}_2 \vert - r_0 + \right)^2,\]
+

where \(k\) is the bond strength (spring constant) and \(r_0\) is +the equilibrium bond length (at which the energy is zero).

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
equilibriumfloat

Equilibrium distance at which the energy associated with the bond +vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient (spring constant).

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+equilibrium: float
+
+ +
+
+strength: float
+
+ +
+ +
+
+class hymd.force.Chi(atom_1: str, atom_2: str, interaction_energy: float)[source]
+

Dataclass representing a single \(\chi\) mixing interaction type

+

An interaction mixing energy type is a mixing energy associated with +density overlap between species of types A and B +(specified as inputs atom_1 and atom_2). A positive mixing +energy promotes phase separation, a negative mixing energy promotes mixing. +The interaction energy density (provided the DefaultWithChi +Hamiltonian is used) takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} + \sum_{k,l}\chi_{k,l} \tilde\phi_k\tilde\phi_l,\]
+

where \(\chi_{k,l}\) denotes the mixing energy between species +\(k\) and \(l\), with \(\kappa\) being the incompressibility. +The value of the interaction mixing energy parameter may be extracted from +Flory-Huggins theory.

+
+

See also

+
+
hymd.hamiltonian.DefaultWithChi

Interaction energy functional using \(\chi\)-interactions.

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
interaction_energyfloat

Interaction mixing energy.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+interaction_energy: float
+
+ +
+ +
+
+class hymd.force.Dielectric_type(atom_1: str, dielectric_value: float)[source]
+
+
+atom_1: str
+
+ +
+
+dielectric_value: float
+
+ +
+ +
+
+class hymd.force.Dihedral(atom_1: str, atom_2: str, atom_3: str, atom_4: str, coeffs: numpy.ndarray, dih_type: int)[source]
+

Dataclass representing a single four-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any four-particle torsional bond between particles of specific types +A, B, C, and D (where A, B, +C, and D may be different or the same). Dihedral +four-particle bonds in HyMD take different forms depending on the +dih_type parameter.

+

In the following, let \(\phi\) denote the angle between the planes +spanned by the relative positions of atoms A-B-C +and B-C-D. If dih_type = 0, then

+
+\[V_4(\phi) = \sum_n c_n + \left( + 1 + \cos\left[ + n\phi - d_n + \right] + \right),\]
+

where \(c_n\) are energy coefficients and \(d_n\) are propensity +phases. By default, the cosine sum is truncated at five terms. If +coeffs provides only a single float, this is used as the coiling +propensity parameter \(\lambda\). In this case, \(c_n\) and +\(d_n\) are automatically set to values which promote alpha helical +(\(\lambda=-1\)), beta sheet (\(\lambda=1\)), or a mixed +(\(1>\lambda>-1\)) structure (using values provided by Bore et al. +(2018)). In this case, the full potential takes the form

+
+\[V_4(\phi;\lambda) = + \frac{1}{2}(1-\lambda) V_{\text{prop},\alpha}(\phi) + + + \frac{1}{2}(1+\lambda) V_{\text{prop},\beta}(\phi) + + + (1-\vert\lambda\vert) V_{\text{prop}, \text{coil}}(\phi),\]
+

with each of the \(V_{\mathrm{prop}, X}\) being fixed cosine series +potentials with pre-set \(c_n\) -s and \(d_n\) -s.

+

If dih_type = 1, then a combined bending torsional (CBT) potential +is employed,

+
+\[V_4(\phi,\gamma;\lambda) = + V_4(\phi;\lambda) + + + \frac{1}{2}K(\phi)(\gamma - \gamma_0)^2,\]
+

where \(V_4(\phi;\lambda)\) specifies the potential as given by the +coiling propensity parameter above, \(K(\phi)\) is a separate cosine +series potential acting as the angular three-particle bond strength, and +\(\gamma_0\) is the three-particle bond equilibrium angle. In this +case, the coeffs parameter must specify both a \(\lambda\) +value, in additon to the energy and phases dictating the \(K(\phi)\) +potential.

+

References

+

Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018.

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
atom_4str

Type name of particle 4.

+
+
coeffslist[list[float]] or list[float] or numpy.ndarray

Dihedral coefficients defining the series expansion of the dihedral +energy.

+
+
dih_typeint

Specifies the type of dihedral used; If 0, then coeffs +must contain either two lists of five energy coefficients +\(c_n\) and five propensity phases \(d_n\) or a single +floating point number defining the \(\lambda\) coiling propensity +parameter. If 1, the combined bending-torsional potential is +used, and coeffs must specify \(\lambda\) and two lists +containing energy coefficients and propensity phases for the +\(V_\text{prop}\) propensity potential, defined in terms of cosine +series.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+atom_3: str
+
+ +
+
+atom_4: str
+
+ +
+
+coeffs: numpy.ndarray
+
+ +
+
+dih_type: int
+
+ +
+ +
+
+hymd.force.compute_angle_forces__plain(f_angles, r, bonds_3, box_size)[source]
+

Computes forces resulting from angular interactions

+
+

Deprecated since version 1.0.0: compute_angle_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_bond_forces__plain(f_bonds, r, bonds_2, box_size)[source]
+

Computes forces resulting from bonded interactions

+
+

Deprecated since version 1.0.0: compute_bond_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size)[source]
+

Computes forces resulting from dihedral interactions

+
+

Deprecated since version 1.0.0: compute_dihedral_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.dipole_forces_redistribution(f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb)[source]
+

Redistribute electrostatic forces calculated from topologically +reconstructed ghost dipole point charges to the backcone atoms of the protein.

+
+ +
+
+hymd.force.find_all_paths(G, u, n)[source]
+

Helper function that recursively finds all paths of given lenght ‘n + 1’ inside a network ‘G’. +Adapted from https://stackoverflow.com/a/28103735.

+
+ +
+
+hymd.force.prepare_bonds(molecules, names, bonds, indices, config, topol=None)[source]
+

Rearrange the bond information for usage in compiled Fortran kernels

+

Restructures the lists resulting from the execution of +prepare_bonds_old into numpy arrays suitable for calls to optimized +Fortran code calculating bonded forces and energiesself.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2_atom_1(B,) numpy.ndarray

Local index of particle 1 for each of B constructed +two-particle bonds.

+
+
bonds_2_atom_2(B,) numpy.ndarray

Local index of particle 2 for each of B constructed +two-particle bonds.

+
+
bonds_2_equilibrium(B,) numpy.ndarray

Equilibrium distance for each of B constructed two-particle +bonds.

+
+
bonds_2_strength(B,) numpy.ndarray

Bond strength for each of B constructed two-particle +bonds.

+
+
bonds_3_atom_1(A,) numpy.ndarray

Local index of particle 1 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_2(A,) numpy.ndarray

Local index of particle 2 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_3(A,) numpy.ndarray

Local index of particle 3 for each of A constructed +three-particle bonds.

+
+
bonds_3_equilibrium(A,) numpy.ndarray

Equilibrium angle for each of A constructed three-particle +bonds.

+
+
bonds_3_strength(A,) numpy.ndarray

Bond strength for each of A constructed three-particle +bonds.

+
+
bonds_4_atom_1(D,) numpy.ndarray

Local index of particle 1 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_2(D,) numpy.ndarray

Local index of particle 2 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_3(D,) numpy.ndarray

Local index of particle 3 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_4(D,) numpy.ndarray

Local index of particle 4 for each of D constructed +four-particle bonds.

+
+
bonds_4_coeff(D,) numpy.ndarray

Cosine series coefficients for each of D constructed +four-particle bonds.

+
+
bonds_4_type(D,) numpy.ndarray

Dihedral type for each of D constructed four-particle +bonds.

+
+
bonds_4_last(D,) numpy.ndarray

Flags indicating if dih_type is 1 for each of D +constructed four-particle bonds.

+
+
+
+
+
+

See also

+
+
prepare_bonds_old

Used internally to reconstruct the bonded interactions types from the connectivity information in the structure/topology input file and the bonded types specified in the configuration file.

+
+
+ +
+ +
+
+hymd.force.prepare_bonds_old(molecules, names, bonds, indices, config)[source]
+

Find bonded interactions from connectivity and bond types information

+
+

Deprecated since version 1.0.0: prepare_bonds_old was replaced by prepare_bonds for +use with compiled Fortran kernels prior to 1.0.0 release.

+
+

Prepares the necessary equilibrium and bond strength information needed by +the intramolecular interaction functions. This is performed locally on each +MPI rank, as the domain decomposition ensures that for all molecules all +consituent particles are always contained on the same MPI rankself.

+

This function traverses the bond connectivity information provided in the +structure/topology input file and indentifies any two-, three-, or +four-particle potential bonds. For each connected chain of two, three, or +four particles, a matching to bond types is attempted. If the corresponding +names match, a bond object is initialized.

+

In order to investigate the connectivity, a graph is created using +networkx functionality.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2list

List of lists containing local particle indices, equilibrium +distance, and bond strength coefficient for each reconstructed +two-particle bond.

+
+
bonds_3

List of lists containing local particle indices, equilibrium angle, +and bond strength coefficient for each reconstructed three-particle +bond.

+
+
bonds_4

List of lists containing local particle indices, dihedral type index, +and dihedral coefficients for each reconstructed four-particle +torsional bond.

+
+
bb_indexlist

List indicating the dihedral type of each four-particle bond in +bonds_4.

+
+
+
+
+
+

See also

+
+
Bond

Two-particle bond type dataclass.

+
+
Angle

Three-particle angular bond type dataclass.

+
+
Dihedral

Four-particle torsional bond type dataclass.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+hymd.force.prepare_index_based_bonds(molecules, topol)[source]
+
+ +
+
+hymd.force.propensity_potential_coeffs(x: float)[source]
+
+ +
+
+

4.5. Logger

+
+
+class hymd.logger.Logger[source]
+

Log output handler class

+

Notes

+

This wraps the default python library logging, see +docs.python.org/3/library/logging.html.

+
+
Attributes:
+
+
levelint

Determines the verbosity level of the log, corresponding to +logging.level. Numerical values 50 (logging.CRITICAL), +40 (logging.ERROR), 30 +(logging.WARNING), 20 (logging.INFO), +10 (logging.DEBUG), and 0 +(logging.UNSET) are supported values. Any log event message +less severe than the specified level is ignored. All other event +messages are emitted.

+
+
log_filestr

Path to output log file.

+
+
formatstr

Prepended dump string for each log event. Specifies the log event +level, the module emitting the event, the code line, the enclosing +function name, and the MPI rank writing the message.

+
+
date_formatstr

Prepends the date before all log event messages.

+
+
formatterlogging.Formatter

Formatter handling the prepending of the information in format and +date_format to each log event message. Used by default for all +loggers.

+
+
rank0logging.Logger

Default logger object for the root MPI rank.

+
+
all_rankslogging.Logger

Default logger object for messages being emitted from all MPI ranks +simultaneously.

+
+
+
+
+
+
+classmethod setup(default_level=20, log_file=None, verbose=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Sets up the logger object.

+

If a log_file path is provided, log event messages are output +to it. Otherwise, the logging messages are emitted to stdout.

+
+
Parameters:
+
+
default_levelint, optional

Default verbosity level of the logger. Unless specified, it is +10 (logging.INFO).

+
+
log_filestr, optional

Path to output log file. If None or not priovided, no log file is +used and all logging is done to stdout.

+
+
verbosebool, optional

Increases the logging level to 30 (logging.WARNING) +if True, otherwise leaves the logging level unchanged.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterRoot(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the root MPI rank log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterAll(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the all-MPI-ranks log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+

4.6. Input parser

+

Parses and handles the configuration information provided for the simulation

+
+
+class hymd.input_parser.Config(n_steps: int, time_step: float, mesh_size: Union[List[int], numpy.ndarray, int], sigma: float, kappa: float, dtype: Optional[numpy.dtype] = None, box_size: Optional[Union[List[float], numpy.ndarray]] = None, n_print: Optional[int] = None, tau: Optional[float] = None, start_temperature: Optional[Union[float, bool]] = None, target_temperature: Optional[Union[float, bool]] = None, mass: Optional[float] = None, hamiltonian: Optional[str] = None, domain_decomposition: Optional[Union[int, bool]] = None, integrator: Optional[str] = None, respa_inner: int = 1, file_name: str = '<config file path unknown>', name: Optional[str] = None, tags: List[str] = <factory>, bonds: List[hymd.force.Bond] = <factory>, angle_bonds: List[hymd.force.Angle] = <factory>, dihedrals: List[hymd.force.Dihedral] = <factory>, chi: List[hymd.force.Chi] = <factory>, n_particles: Optional[int] = None, max_molecule_size: Optional[int] = None, n_flush: Optional[int] = None, thermostat_work: float = 0.0, thermostat_coupling_groups: List[List[str]] = <factory>, initial_energy: Optional[float] = None, cancel_com_momentum: Union[int, bool] = False, coulombtype: Optional[str] = None, convergence_type: Optional[str] = None, pol_mixing: Optional[float] = None, dielectric_const: Optional[float] = None, conv_crit: Optional[float] = None, dielectric_type: List[hymd.force.Dielectric_type] = <factory>, self_energy: Optional[float] = None, type_charges: Optional[Union[List[float], numpy.ndarray]] = None, rho0: Optional[float] = None, a: Optional[float] = None, pressure: bool = False, barostat: Optional[str] = None, barostat_type: Optional[str] = None, tau_p: Optional[float] = None, target_pressure: List[hymd.barostat.Target_pressure] = <factory>, n_b: Optional[int] = None, m: List[float] = <factory>)[source]
+

Configuration object

+

Handles and verifies the simulation configuration specified in the +configuration file.

+
+

See also

+
+
hymd.input_parser.Bond

Two-particle bond type dataclass.

+
+
hymd.input_parser.Angle

Three-particle bond type dataclass.

+
+
hymd.input_parser.Dihedral

Four-particle bond type dataclass.

+
+
+ +
+
Attributes:
+
+
gas_constantfloat

Constant value of the gas constant, R (equivalently the Boltzmann +constant) in the units used internally in HyMD.

+
+
coulomb_constantfloat

Constant value of the Coulomb constant which converts electric field +values to forces and electric potential values to energies in the units +used internally in HyMD.

+
+
n_steps: int

Number of time steps in the simulation.

+
+
time_step: float

Outer time step used in the simulation. If the rRESPA intergrator is +used, the inner time step (the time step used in the integration of +intramolecular bending, stretching, and torsional forces) is +time_step / respa_inner.

+
+
box_sizelist[float] or (D,) numpy.ndarray

Simulation box size of simulation in D dimensions in units of +nanometers.

+
+
mesh_sizelist[int] or int or numpy.ndarray

Number of grid points used for the discrete density grid.

+
+
sigmafloat

Filter width representing the effective coarse-graining level of the +particles in the simulation.

+
+
kappafloat

Compressibility parameter used in the relaxed incompressibility term in +the interaction energy functional.

+
+
n_printint, optional

Frequency of trajectory/energy output to the H5MD trajectory/energy +output file (in units of number of time steps).

+
+
taufloat, optional

The time scale of the CSVR thermostat coupling.

+
+
start_temperaturefloat, optional

Generate starting temperature by assigning all particle velocities +randomly according to the Maxwell-Boltzmann distribution at +start_temperature Kelvin prior to starting the simulation.

+
+
target_temperaturefloat, optional

Couple the system to a heat bath at target_temperature Kelvin.

+
+
massfloat, optional

Mass of the particles in the simulation.

+
+
hamiltonianstr, optional

Specifies the interaction energy functional \(W[\tilde\phi]\) +for use with the particle-field interactions. Options: +SquaredPhi, DefaultNohChi, or DefaultWithChi.

+
+
domain_decompositionint, optional

Specifies the interval (in time steps) of domain decomposition +exchange, involving all MPI ranks sending and receiving particles +according to the particles’ positions in the integration box and the +MPI ranks’ assigned domain.

+
+
integratorstr, optional

Specifies the time integrator used in the simulation. Options: +velocity-verlet or respa.

+
+
respa_innerint, optional

The number of inner time steps in the rRESPA integrator. This denotes +the number of intramolecular force calculations (stretching, bending, +torsional) are performed between each impulse applied from the field +forces.

+
+
file_namestr, optional

File path of the parsed configuration file.

+
+
namestr, optional

Name for the simulation.

+
+
tagslist[str], optional

Tags for the simulation.

+
+
bondslist[Bond], optional

Specifies harmonic stretching potentials between particles in the +same molecule.

+
+
angle_bondslist[Angle], optional

Specifies harmonic angular bending potentials between particles in the +same molecule.

+
+
dihedralslist[Dihedral], optional

Specifies four-particle torsional potentials by cosine series.

+
+
chilist[Chi], optional

Specifies \(\chi\)-interaction parameters between particle +species.

+
+
n_particlesint, optional

Specifies the total number of particles in the input. Optional keyword +for validation, ensuring the input HDF5 topology has the correct number +of particles and molecules.

+
+
max_molecule_sizeint, optional

Maximum size of any single molecule in the system. Used to speed up +distribution of particles onto MPI ranks in a parallel fashion.

+
+
n_flushint, optional

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be +written to disk (in units of number of n_print).

+
+
thermostat_workfloat

Work performed by the thermostat on the system.

+
+
thermostat_coupling_groupslist[str], optional

Specifies individual groups coupling independently to the CSVR +thermostat. E.g. in a system containing "A", "B", and +"C" type particles, +thermostat_coupling_groups = [["A", "B"], ["C"],] would +thermalise types "A" and "B" together and couple +"C" type particles to a different thermostat (all individual +thermostats are at the same temperature, i.e. target_temperature +Kelvin).

+
+
initial_energyfloat

Value of the total energy prior to the start of the simulation.

+
+
cancel_com_momentumint, optional

If True, the total linear momentum of the center of mass is +removed before starting the simulation. If an integer is specifed, the +total linear momentum of the center of mass is removed every +remove_com_momentum time steps. If False, the linear +momentum is never removed.

+
+
coulombtypestr, optional

Specifies the type of electrostatic Coulomb interactions in the system. +The strength of the electrostatic forces is modulated by the relative +dielectric constant of the simulation medium, specified with the +dielectric_const keyword. Charges for individual particles are +specified in the structure/topology HDF5 input file, not in the +configuration file. If no charges (or peptide backbone dipoles) are +present, the electrostatic forces will not be calculated even if this +keyword is set to "PIC_Spectral".

+
+
dielectric_constfloat, optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. When +using helical propensity dihedrals, this keyword must be specified—even +if electrostatics are not included with the coulombtype +keyword.

+
+
dielectric_type: list[float], optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. The list assigns +relative dielectric values to each bead type, and an anisotropic +dielectric function is obtained from a weighted average.

+
+
+
+
+
+
+a: float = None
+
+ +
+
+angle_bonds: List[hymd.force.Angle]
+
+ +
+
+barostat: str = None
+
+ +
+
+barostat_type: str = None
+
+ +
+
+bonds: List[hymd.force.Bond]
+
+ +
+
+box_size: Union[List[float], numpy.ndarray] = None
+
+ +
+
+cancel_com_momentum: Union[int, bool] = False
+
+ +
+
+chi: List[hymd.force.Chi]
+
+ +
+
+conv_crit: float = None
+
+ +
+
+convergence_type: str = None
+
+ +
+
+coulomb_constant: ClassVar[float] = 138.935458
+
+ +
+
+coulombtype: str = None
+
+ +
+
+dielectric_const: float = None
+
+ +
+
+dielectric_type: List[hymd.force.Dielectric_type]
+
+ +
+
+dihedrals: List[hymd.force.Dihedral]
+
+ +
+
+domain_decomposition: Union[int, bool] = None
+
+ +
+
+dtype: numpy.dtype = None
+
+ +
+
+file_name: str = '<config file path unknown>'
+
+ +
+
+gas_constant: ClassVar[float] = 0.0083144621
+
+ +
+
+hamiltonian: str = None
+
+ +
+
+initial_energy: float = None
+
+ +
+
+integrator: str = None
+
+ +
+
+kappa: float
+
+ +
+
+m: List[float]
+
+ +
+
+mass: float = None
+
+ +
+
+max_molecule_size: int = None
+
+ +
+
+mesh_size: Union[List[int], numpy.ndarray, int]
+
+ +
+
+n_b: int = None
+
+ +
+
+n_flush: int = None
+
+ +
+
+n_particles: int = None
+
+ +
+
+n_print: int = None
+
+ +
+
+n_steps: int
+
+ +
+
+name: str = None
+
+ +
+
+pol_mixing: float = None
+
+ +
+
+pressure: bool = False
+
+ +
+
+respa_inner: int = 1
+
+ +
+
+rho0: float = None
+
+ +
+
+self_energy: float = None
+
+ +
+
+sigma: float
+
+ +
+
+start_temperature: Union[float, bool] = None
+
+ +
+
+tags: List[str]
+
+ +
+
+target_pressure: List[hymd.barostat.Target_pressure]
+
+ +
+
+target_temperature: Union[float, bool] = None
+
+ +
+
+tau: float = None
+
+ +
+
+tau_p: float = None
+
+ +
+
+thermostat_coupling_groups: List[List[str]]
+
+ +
+
+thermostat_work: float = 0.0
+
+ +
+
+time_step: float
+
+ +
+
+type_charges: Union[List[float], numpy.ndarray] = None
+
+ +
+ +
+
+hymd.input_parser.check_NPT_conditions(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check validity of barostat_type, barostat, +a, rho0, target_pressure, tau_p

+
+ +
+
+hymd.input_parser.check_angles(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_bonds(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_box_size(config, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_cancel_com_momentum(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_charges(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if charges across ranks sum to zero.

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of floats with charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_charges_types_list(config, types, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates a list of charge values of length types. +Charges are sorted according to type ID. Used in field.py. +# TODO: this is messy, we should fix it

+
+ +
+
+hymd.input_parser.check_chi(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_config(config, indices, names, types, charges, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs various checks on the specfied config to ensure consistency

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
indices(N,) numpy.ndarray

Array of integer indices for N particles.

+
+
names(N,) numpy.ndarray

Array of string names for N particles.

+
+
types(N,) numpy.ndarray

Array of integer type indices for N particles.

+
+
charges(N,) numpy.ndarray

Array of floats charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
Returns:
+
+
configConfig

Validated configuration object.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_dielectric(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Error handling for electrostatics. +Unit testing of toml/tomli input.

+
+ +
+
+hymd.input_parser.check_dihedrals(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_domain_decomposition(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_hamiltonian(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_integrator(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_m(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_mass(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_max_molecule_size(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_b(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_flush(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_particles(config, indices, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_print(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_name(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_start_and_target_temperature(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Validate provided starting and target thermostat temperatures

+

Assesses the provided temperature target and ensures it is a non-negative +floating point number or False. Ensures the starting temperature is +a non-negative floating point number or False.

+

If the value for either is None, the returned configuration object +has the values defaulted to False in each case.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
validated_configConfig

Configuration object with validated target_temperature and +start_temperature.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_tau(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_thermostat_coupling_groups(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.parse_config_toml(toml_content, file_path=None, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.read_config_toml(file_path)[source]
+
+ +
+
+hymd.input_parser.sort_dielectric_by_type_id(config, charges, types)[source]
+

Creates a list of length N CG-particles, sorted after the charges from +the input HDF5 file. Used in file_io.py

+
+ +
+
+

4.7. Field

+

Forces and energies from the discretized particle-field grid interactions

+
+
+hymd.field.compute_field_and_kinetic_energy(phi, phi_q, psi, velocity, hamiltonian, positions, types, v_ext, config, layouts, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the particle-field and kinetic energy contributions

+

Calculates the kinetic energy through

+
+\[E_k = \sum_j \frac{1}{2}m_j\mathbf{v}_j\cdot\mathbf{v}_j,\]
+

and the particle-field energy by

+
+\[E_\text{field} = \int\mathrm{d}\mathbf{r}\, + w[\tilde\phi],\]
+

where \(w\) is the interaction energy functional density.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
velocity(N,D) numpy.ndarray

Array of velocities for N particles in D dimensions. +Local for each MPI rank.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Local for each MPI rank–the full computational grid is +represented by the collective fields of all MPI ranks.

+
+
configConfig

Configuration object.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field

Computes the up-to-date external potential for use in calculating the particle-field energy.

+
+
+ +
+ +
+
+hymd.field.compute_field_energy_q_GPE(config, phi_eps, field_q_energy, dot_elec, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the electrostatic energy after electrosatic forces is +calculated.

+

From the definition of the elecrostatic potential \(\Psi\), the energy +is

+
+
+
W = frac{1}{2}intmathrm{d}mathbf{r},

epsilon(mathbf{r})} left(mathbf{E}cdot mathbf{E}right),

+
+
+
+

where \(\epsilon(\mathbf{r})}\) is the anisotropic, spatially dependent, +relative dielectric of the simulation medium.

+
+
Parameters:
+
+
confighymd.input_parser.Config

Configuration object.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
field_q_energyfloat

Total elecrostatic energy.

+
+
dot_elecpmesh.pm.RealField

Pmesh RealField object for storing \(|\mathbf{E(r)}|^{2}\) +on the computational grid. Local for each MPI rank – the full computational +grid is represented by the collective fields of all MPI ranks.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field_force_q_GPE

Compute the electrosatic force from an anisotropic dielectric general Poisson equation.

+
+
+ +
+ +
+
+hymd.field.compute_field_force(layouts, r, force_mesh, force, types, n_types)[source]
+

Interpolate particle-field forces from the grid onto particle positions

+

Backmaps the forces calculated on the grid to particle positions using the +window function \(P\) (by default cloud-in-cell [CIC]). In the +following, let \(\mathbf{F}_j\) denote the force acting on the +particle with index \(j\) and position \(\mathbf{r}_j\). The +interpolated force is

+
+\[\mathbf{F}_j = -\sum_k\nabla V_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(V_{j_k}\) is the discretized external potential at grid vertex +\(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid vertex +with index \(j_k\), and \(h^3\) is the volume of each grid voxel. +The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
r(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
force(N,D) numpy.ndarray

Array of forces for N particles in D dimensions. Local +for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
n_typesint

Number of different unique types present in the simulation system. +n_types is global, i.e. the same for all MPI ranks even if some +ranks contain zero particles of certain types.

+
+
+
+
+
+ +
+
+hymd.field.compute_self_energy_q(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the self energy for the interaction due to the Ewald scheme +used to compute the electrostatics. The energy is stored in config.

+

The self interaction energy is given by:

+
+\[U_{self} = \sqrt{\frac{1}{2\pi\sigma^2}} \sum_{i=1}^{N} q_i^2\]
+

where \(q_i\) are the charges and \(\sigma\) is the half-width +of the Gaussian filter.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
Returns:
+
+
field_q_self_energyfloat

Electrostatic self energy.

+
+
+
+
+
+ +
+
+hymd.field.domain_decomposition(positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs domain decomposition

+

Rearranges the MPI rank memory layout into one that better mimics the PFFT +pencil grid 2D decomposition. As molecules are always required to be fully +contained on a single MPI rank, a perfect decomposition is not always +possible. The best decomposition which leaves the center of mass of all +molecules in their respective correct domains is used, with possible +overlap into neighbouring domains if the spatial extent of any molecule +crosses domain boundaries.

+
+
Parameters:
+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
*args

Variable length argument list containing arrays to include in the +domain decomposition.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
bonds(N,M) numpy.ndarray, optional

Array of M bonds originating from each of N particles.

+
+
verboseint, optional

Specify the logging event verbosity of this function.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
Domain decomposedcode:positions and any array specified in
+
:code:`*args`, in addition tocode:bonds and molecules if these
+
arrays were provided as input.
+
+
+
+
+ +
+
+hymd.field.initialize_pm(pmesh, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates the necessary pmesh objects for pfft operations.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pmobject ‘pmesh.pm.ParticleMesh’
+
field_listlist[pmesh.pm.RealField], (multiple)

Essential list of pmesh objects required for MD

+
+
list_coulomblist[pmesh.pm.RealField], (multiple)

Additional list of pmesh objects required for electrostatics.

+
+
+
+
+
+ +
+
+hymd.field.update_field(phi, phi_laplacian, phi_transfer, layouts, force_mesh, hamiltonian, pm, positions, types, config, v_ext, phi_fourier, v_ext_fourier, m, compute_potential=False)[source]
+

Calculate the particle-field potential and force density

+

If compute_potential is True, the energy may subsequently +be computed by calling compute_field_and_kinetic_energy.

+

Computes the particle-field external potential \(V_\text{ext}\) from +particle number densities through the smoothed density field, +\(\phi(\mathbf{r})\). With \(P\) being the cloud-in-cell (CIC) +window function, the density and filtered densities are computed as

+
+\[\phi(\mathbf{r}) = \sum_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\phi(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +external potential is computed in reciprocal space as

+
+\[V_\text{ext} = \mathrm{FFT}^{-1}\left[ + \mathrm{FFT} + \left( + \frac{\partial w}{\partial \tilde\phi} + \right) + \mathrm{FFT}(H) +\right],\]
+

where \(w\) is the interaction energy functional. Differentiating +\(V_\text{ext}\) is done by simply applying \(i\mathbf{k}\) in +Fourier space, and the resulting forces are back-transformed to direct +space and interpolated to particle positions by

+
+\[\mathbf{F}_j = -\sum_{j_k} \nabla V_{j_k} + P(\mathbf{r}_{j_k} - \mathbf{r}_j)h^3,\]
+

where \(j_k\) are the neighbouring vertices of particle \(j\) at +position \(\mathbf{r}_j\), and \(h^3\) is the volume of each grid +voxel.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Pre-allocated, but empty; any values +in this field are discarded. Changed in-place. Local for each MPI +rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
configConfig

Configuration object.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Pre-allocated, but empty; any values in this field are +discarded Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
phi_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computational grid is represented by the collective fields of all +MPI ranks.

+
+
v_ext_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplesField objects containing discretized +particle-field external potential values in reciprocal space on the +computational grid; D+1 fields in D dimensions for each +particle type. D copies are made after calculation for later +use in force calculation, because the force transfer function +application differentiates the field in-place, ruining the contents +for differentiation in the remaining D-1 spatial directions. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
m: list[float], (M,)

pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. +Defaults to 1.0 for all particle types.

+
+
compute_potentialbool, optional

If True, a D+1-th copy of the Fourier transformed +external potential field is made to be used later in particle-field +energy calculation. If False, only D copies are made.

+
+
+
+
+
+

See also

+
+
compute_field_and_kinetic_energy

Compute the particle-field energy after the external potential is calculated.

+
+
+ +
+ +
+
+hymd.field.update_field_force_q(charges, phi_q, phi_q_fourier, psi, psi_fourier, elec_field_fourier, elec_field, elec_forces, layout_q, hamiltonian, pm, positions, config)[source]
+

Calculate the electrostatic particle-field forces on the grid

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential is computed in reciprocal space as

+
+\[\Phi = \mathrm{FFT}^{-1}\left[ + \frac{4\pi k_e}{\varepsilon \vert\mathbf{k}\vert^2} + \mathrm{FFT}(\rho)\mathrm{FFT}(H) +\right],\]
+

with the electric field

+
+\[\mathbf{E} = \mathrm{FFT}^{-1}\left[ + -i\mathbf{k}\,\mathrm{FFT}(\Psi) +\right].\]
+

In the following, let \(\mathbf{F}_j\) denote the electrostatic force +acting on the particle with index \(j\) and position +\(\mathbf{r}_j\). The interpolated electrostatic force is

+
+\[\mathbf{F}_j = \sum_k q_j\mathbf{E}_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(\mathbf{E}_{j_k}\) is the discretized electric field at grid +vertex \(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid +vertex with index \(j_k\), and \(h^3\) is the volume of each grid +voxel. The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty; any values in this field +are discarded. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
elec_field_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +electric field values in reciprocal space on the computational grid. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
+
+
+
+ +
+
+hymd.field.update_field_force_q_GPE(conv_fun, phi, types, charges, phi_q, phi_q_fourier, phi_eps, phi_eps_fourier, phi_eta, phi_eta_fourier, phi_pol_prev, phi_pol, elec_field, elec_forces, elec_field_contrib, psi, Vbar_elec, Vbar_elec_fourier, force_mesh_elec, force_mesh_elec_fourier, hamiltonian, layout_q, layouts, pm, positions, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Calculate the electrostatic particle-field forces on the grid, arising from +a general Poisson equation, i.e. anisotropic permittivity/dielectric. +The function is called when tomli input config.coulombtype = “PIC_Spectral_GPE.”

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential for a variable dielectric does not have an +analytical expression, and is computed in reciprocal through an iterative +method.

+

The GPE states that

+
+\[\nabla \cdot \left(\epsilon(\mathbf{r}) +\nabla{\mathbf{\psi(r)}}\right) = -\rho({\mathbf{r}}).\]
+

where \(\epsilon(\mathbf{r})\) is the relative dielectric function.

+
+
Parameters:
+
+
conv_funConvergence function.

Returns a scalar. Depends on MPI allreduce for similar convergence +across MPI ranks.

+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_eps_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_etapmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +gradients of the relative dielectric values on the computational grid. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank–the +full computational grid is represented by the collective fields of all MPI ranks.

+
+
phi_eta_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated discretized +Fourier transformed gradient relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_pol_prevpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charge values on the computational grid. Parameter in +the iterative method.Pre-allocated,but empty. Changedin-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_polpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charges on the computational grid. Parameter in the iterative +method, updating the next quess in solving for the electrostatic potential. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank– +the full computational grid is represented by the collective fields of +all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all +MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
elec_field_contribpmesh.pm.RealField

Pmesh RealField object for storing +\(|\mathbf{E(r)}|^2/\phi_{0}\) on the computational grid. +Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
psipmesh.pm.RealField

Pmesh RealField object for storing electrostatic potential +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
Vbar_elecmesh.pm.RealField

Pmesh RealField object for storing functional derivatives of +:math:`|w({ phi })_{elec}`on the computational grid. +Pre-allocated, but empty. Changed in-place. Local for each MPI rank– +the full computational grid is represented by the collective fields of

+
+

all MPI ranks.

+
+
+
Vbar_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated functional +derivatives of \(\|w(\{ \phi \})_{elec}\) in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
force_mesh_elecpmesh.pm.RealField

Pmesh RealField object for storing electrostatic force values +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
force_mesh_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated electrostatic +force values in reciprocal space on the computational grid. Local for +each MPI rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
layouts: list[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
comm: mpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
compute_field_energy_q_GPE

Compute the electrostatic energy after electrosatic force is calculated for a variable (anisotropic) dielectric general Poisson equation.

+
+
+ +
+ +
+
+

4.8. File input/output

+

Handle file input/output in parllel HDF5 fashion

+
+
+class hymd.file_io.OutDataset(dest_directory, config, double_out=False, disable_mpio=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

HDF5 dataset handler for file output

+
+
+close_file(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Closes the HDF5 output file

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+
+flush()[source]
+

Flushes output buffers, forcing file writes

+
+ +
+
+is_open(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if HDF5 output file is open

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+ +
+
+hymd.file_io.distribute_input(in_file, rank, size, n_particles, max_molecule_size=201, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Assign global arrays onto MPI ranks, attempting load balancing

+

Distributes approximately equal numbers of particles (workload) onto each +independent MPI rank, while respecting the requirement that any molecule +must be fully contained on a single MPI rank only (no splitting molecules +across multiple CPUs).

+
+
Parameters:
+
+
in_fileh5py.File

HDF5 input file object.

+
+
rankint

Local rank number for this MPI rank.

+
+
sizeint

Global size of the MPI communicator (number of total CPUs).

+
+
n_particlesint

Total number of particles.

+
+
max_molecule_sizeint, optional

Maximum size of any molecule present in the system. Used to initially +guess where the MPI rank boundaries (start/end indices) in the global +arrays should be placed. If molecules of size +>max_molecule_size exist in the simulation system, HyMD +might work as expected. Or it might fail spectacularly.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
rank_range

Starting and ending indices in the global arrays for each MPI rank.

+
+
+
+
+
+ +
+
+hymd.file_io.setup_time_dependent_element(name, parent_group, n_frames, shape, dtype, units=None)[source]
+

Helper function for setting up time-dependent HDF5 group datasets

+

All output groups must adhere to the H5MD standard, meaning a structure of

+
+
┗━ group particle group (e.g. all) or observables group
+
+
┗━ group time-dependent data
+
+
┣━ dataset step shape=(n_frames,)
+
┣━ dataset time shape=(n_frames,)
+
┗━ dataset value shape=(n_frames, *)
+
+
+
+

is necessary.

+

References

+
+
H5MD specification :

https://www.nongnu.org/h5md/h5md.html

+
+
+
+ +
+
+hymd.file_io.store_data(h5md, step, frame, indices, positions, velocities, forces, box_size, temperature, pressure, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, field_energy, field_q_energy, plumed_bias, time_step, config, velocity_out=False, force_out=False, charge_out=False, plumed_out=False, dump_per_particle=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Writes time-step data to HDF5 output file

+

Handles all quantities which change during simulation, as opposed to +static quanitities (see store_static).

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
stepint

Step number.

+
+
frameint

Output frame number (step // n_print).

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
positions(N,) numpy.ndarray

Array of positions for N particles in D dimensions.

+
+
velocities(N,) numpy.ndarray

Array of velocities for N particles in D dimensions.

+
+
forces(N,) numpy.ndarray

Array of forces for N particles in D dimensions.

+
+
box_size(D,) numpy.ndarray

Array containing the simulation box size.

+
+
temperaturefloat

Calculated instantaneous temperature.

+
+
kinetic_energyfloat

Calculated instantaneous kinetic energy.

+
+
bond2_energyfloat

Calculated instantaneous harmonic two-particle bond energy.

+
+
bond3_energyfloat

Calculated instantaneous harmonic angular three-particle bond energy.

+
+
bond4_energyfloat

Calculated instantaneous dihedral four-particle torsion energy.

+
+
field_energyfloat

Calculated instantaneous particle-field energy.

+
+
field_q_energyfloat

Calculated instantaneous electrostatic energy.

+
+
plumed_biasfloat

PLUMED instantaneous bias energy.

+
+
time_stepfloat

Value of the time step.

+
+
configConfig

Configuration object.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charge_outbool, optional

If True, electrostatic energies are written to the output +HDF5 file.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to the output HDF5 file.

+
+
dump_per_particlebool, optional

If True, all quantities are written per particle.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
store_static

Outputs all static time-independent quantities to the HDF5 output file

+
+
+ +
+ +
+
+hymd.file_io.store_static(h5md, rank_range, names, types, indices, config, bonds_2_atom1, bonds_2_atom2, molecules=None, velocity_out=False, force_out=False, charges=False, dielectrics=False, plumed_out=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Outputs all static time-independent quantities to the HDF5 output file

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
rank_rangelist[int]

Start and end indices for global arrays for each MPI rank.

+
+
names(N,) numpy.ndarray

Array of names for N particles.

+
+
types(N,) numpy.ndarray

Array of type indices for N particles.

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
configConfig

Configuration object.

+
+
bonds_2_atom1(B,) numpy.ndarray

Array of indices of the first particle for B total +two-particle bonds.

+
+
bonds_2_atom2(B,) numpy.ndarray

Array of indices of the second particle for B total +two-particle bonds.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles.

+
+
dielectrics(N,) numpy.ndarray

Array of particle relative dielectric values for N particles.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to output HDF5 file.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
prepare_bonds

Constructs two-, three-, and four-particle bonds from toplogy input file and bond configuration information.

+
+
distribute_input

Distributes input arrays onto MPI ranks, attempting load balancing.

+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/doc_pages/benchmarks.html b/v1.0.2/doc_pages/benchmarks.html new file mode 100644 index 00000000..73ee0b7a --- /dev/null +++ b/v1.0.2/doc_pages/benchmarks.html @@ -0,0 +1,299 @@ + + + + + + + 3. Benchmarks — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Benchmarks

+

Homopolymer melt test systems of \(30^2\), \(40^2\), and \(50^2\) +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively.

+
+

3.1. Bonded forces

+

Legend label denotes the number of particles in the system.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-1.png +
+
+
+

3.2. Particle–field forces

+

Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-2.png +
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/doc_pages/command_line.html b/v1.0.2/doc_pages/command_line.html new file mode 100644 index 00000000..a7dd8551 --- /dev/null +++ b/v1.0.2/doc_pages/command_line.html @@ -0,0 +1,356 @@ + + + + + + + 5. Command line arguments — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. Command line arguments

+

Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle–field interactions.

+
+

5.1. Required arguments

+
+
configuration file:
+

type positional

+

Specifies the .toml format configuration file containing simulation details. See Configuration file for details.

+
+
structure and topology file:
+

type positional

+

Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See Topology and structure file for details.

+
+
+
+
+

5.2. Optional arguments

+
+
-v  --verbose

type optional

+

Number of following arguments: 0 or 1

+

Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying -v or --verbose with no additional specification. This increases verbosity level by 1. Alternatively, it maye be specified by --verbose V with V being 0, 1, or 2.

+
+
--profile

type optional

+

Number of following arguments: 0

+

Enables code profiling using cProfile. This will output one profiling file per MPI rank invoked in the simulation.

+
+
--double-precision

type optional

+

Number of following arguments: 0

+

Specify usage of double precision internally in HyMD (including in the FFTs).

+
+
--double-output

type optional

+

Number of following arguments: 0

+

Specify usage of double precision in the output trajectory from HyMD.

+
+
--velocity-output

type optional

+

Number of following arguments: 0

+

Specify that velocities should be output to the HyMD trajectory.

+
+
--force-output

type optional

+

Number of following arguments: 0

+

Specify that forces should be output to the HyMD trajectory.

+
+
--disable-mpio

type optional

+

Number of following arguments: 0

+

Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult.

+
+
--logfile

type optional

+

Number of following arguments: 1

+

Specifies the path of a plain text log file in which stdout is mirrored during simulation runs.

+
+
--seed

type optional

+

Number of following arguments: 1

+

Specifies the random seed used in the numpy random library to generate velocities, thermostatting, etc.

+
+
--disable-bonds

type optional

+

Number of following arguments: 0

+

Disable any two-particle bonds present in the system.

+
+
--disable-angle-bonds

type optional

+

Number of following arguments: 0

+

Disable any three-particle bonds present in the system.

+
+
--disable-dihedrals

type optional

+

Number of following arguments: 0

+

Disable any four-particle bonds present in the system.

+
+
--disable-dipole

type optional

+

Number of following arguments: 0

+

Disable any topological reconstruction of peptide backbone dipoles present in the system.

+
+
--disable-field

type optional

+

Number of following arguments: 0

+

Disable any particle–field interactions present in the system.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/doc_pages/config_file.html b/v1.0.2/doc_pages/config_file.html new file mode 100644 index 00000000..2fef3a12 --- /dev/null +++ b/v1.0.2/doc_pages/config_file.html @@ -0,0 +1,443 @@ + + + + + + + 3. Configuration file — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Configuration file

+

The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order.

+

The configuration file is a toml format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs.

+
+

3.1. Configuration file keywords

+

The following constitutes every possible keyword specification in HyMD +configuration files:

+
+

3.1.1. Metadata keywords

+

Configuration keywords specifying metadata for the H5MD output trajectory.

+
+
name:
+

string [optional, default: None]

+

Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file.

+
+
tags:
+

array [string] [optional, default: None]

+

Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file.

+
+
+
+
+

3.1.2. Particle keywords

+

Configuration keywords specifying properties of particles and molecules in the +system.

+
+
n_particles:
+

integer [optional, default: None]

+

Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules.

+
+
mass:
+

float [optional, default: 72.0] {units: \(\text{u}=\text{g}\,\text{mol}^{-1}\)}

+

Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal.

+
+
max_molecule_size:
+

integer [optional, default: 201]

+

Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code will crash if there are molecules larger than max_molecule_size in the topology/structure input file.

+
+
+
+
+

3.1.3. Simulation keywords

+

Configuration keywords specifying simulation parameters.

+
+
n_steps:
+

integer [required]

+

Total number of integration steps to perform for this simulation.

+
+
n_print:
+

integer or boolean [optional, default: False]

+

Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of number of time steps).

+
+
n_flush:
+

integer [optional, default: None]

+

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of number of n_print, i.e. n_print = 13, n_flush = 3 would result in the trajectory/energy being written to disk every 13 x 3 = 39 simulation steps)

+
+
time_step:
+

float [required] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time step per integration step. If the rRESPA multiple time step integrator is used (integrator = "respa"), this specifies the inner time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is respa_inner times the time_step , and the total simulation time is n_steps times time_step times respa_inner .

+
+
box_size:
+

array [float] [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable.

+
+
integrator:
+

string [required] (options: velocity-verlet or respa)

+

Specifies the time integrator used in the simulation. If respa, the reversible reference system propagator algorithm (rRESPA) [Tuckerman et al., 1992] integrator is used, with respa_inner number of inner (intramolecular force) time steps. If velocity-verlet, a normal Velocity Verlet integrator is used. If respa and respa_inner = 1, the rRESPA integrator is equivalent to the Velocity Verlet.

+
+
respa_inner:
+

integer [optional, default: 1]

+

The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces.

+
+
domain_decomposition:
+

integer or boolean [optional, default: False]

+

Specifies the interval (in time steps) of domain decomposition exchange, involving all MPI ranks sending and receiving particles according to the particles’ positions in the integration box and the MPI ranks’ assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If True, the decomposition is performed once (before starting the simulation). If False, no decomposition is performed.

+
+
cancel_com_momentum:
+

integer or boolean [optional, default: False]

+

If True, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every remove_com_momentum time steps. If False, the linear momentum is never removed.

+
+
start_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at start_temperature Kelvin prior to starting the simulation. If False, the velocities are not changed before starting the simulation.

+
+
target_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Couple the system to a heat bath at target_temperature Kelvin by applying a Canonical sampling through velocity rescaling [Bussi et al., 2007] thermostat with coupling strength tau. If False, no temperature control is applied.

+
+
tau:
+

float [optional, default: 0.7] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the CSVR thermostat coupling. In the limit of tau , the Hamiltonian dynamics are preserved and no temperature coupling takes place.

+
+
thermostat_coupling_groups:
+

array [array [string]] [optional, default: []]

+

Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing "A", "B", and "C" type particles, thermostat_coupling_groups = [["A", "B"], ["C"],] would thermalise types "A" and "B" together and couple "C" type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. target_temperature Kelvin).

+
+
hamiltonian:
+

string [optional, default: "DefaultNohChi"] (options: SquaredPhi, DefaultNohChi, or DefaultWithChi)

+

Specifies the interaction energy functional \(W[\tilde\phi]\) for use with the particle-field interactions. See Interaction energy functionals for details.

+
+
+
+
+

3.1.4. Field keywords

+

Configuration keywords specifying field parameters.

+
+
mesh_size:
+

array [integer] or integer [required]

+

Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is box_size / mesh_size.

+
+
kappa:
+

float [required] {units: \(\text{kJ}^{-1}\text{mol}\)}

+

Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional \(W[\tilde\phi]\). See Interaction energy functionals for more details.

+
+
sigma:
+

float [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See Filtering for more details.

+
+
chi:
+

array [array [string, float]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\)}

+

Array of \(\tilde\chi_\text{AB}\)-parameters indicating the strength of the repulsive or attractive interaction between particles of type "A" and the number density due to particles of type "B", and vice versa. Example: chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ] would specify a repulsive "A""B" type interaction, and a weakly attractive "C""D" interaction. Self-interaction \(\tilde\chi\)-terms are always zero. See Interaction energy functionals for more details.

+
+
+
+
+

3.1.5. Bond keywords

+

Configuration keywords specifying bonds and bonds parameters.

+
+
bonds:
+

array [array [2 string, 2 float]] [optional, default: []] {units: \(\text{nm}=10^{-9}~\text{m}\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+

Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ] indicates a "A""A" bond of equilibrium length 0.47 \(\text{nm}\) with a bond strength of 980.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding bond between "A" and "B" type particles with equilibrium length 0.31 \(\text{nm}\) and a strength of 1250.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify stretching bonds.

+
+
angle_bonds:
+

array [array [3 string, 2 float]] [optional, default: []] {units: \({}^\circ\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+
+

Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ] indicates a "A""A""A" angular bond that tries to keep the bond linear at 180 degrees with a bending strength of 55.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding angle bond between "A""B""B" prefering the angle at 120 degrees and a strength of 25.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify angular bonds.

+
+
+
dihedrals:
+

array [array [4 string, integer, COSINE SERIES ]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)}

+

Specifies four-particle torsional potentials by cosine series. See Intramolecular bonds for details about how to specify dihedrals.

+
+
+
+
+

3.1.6. Electrostatic keywords

+

Configuration keywords specifying electrostatics and electrostatic parameters.

+
+
coulombtype:
+

string [optional, default: None] (options: PIC_Spectral)

+

Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the dielectric_const keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, not in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to PIC_Spectral.

+
+
dielectric_const:
+

float [optional, default: None]

+

Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified—even if electrostatics are not included with the coulombtype keyword.

+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/doc_pages/constants_and_units.html b/v1.0.2/doc_pages/constants_and_units.html new file mode 100644 index 00000000..03dedad0 --- /dev/null +++ b/v1.0.2/doc_pages/constants_and_units.html @@ -0,0 +1,390 @@ + + + + + + + 6. Constants and Units — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

6. Constants and Units

+

HyMD uses the following units and constants internally and in all input and +output:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Units

Quantity

Symbol

Unit

length

\(r\)

\(\text{nm}=10^{-9}~\text{m}\)

time

\(t\)

\(\text{ps}=10^{-12}~\text{s}\)

charge

\(q\)

\(e=1.602176634 \cdot 10^{-19}~\text{C}\)

mass

\(m\)

\(\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}\)

temperature

\(\text{T}\)

\(\text{K}\)

energy

\(E\)

\(\text{kJ}\,\text{mol}^{-1}\)

velocity

\(v\)

\(\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}\)

momentum

\(P\)

\(\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}\)

force

\(\mathbf{F}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}\)

pressure

\(p\)

\(\text{bar}=100~\text{kPa}\)

electric potential

\(\Psi\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}\)

electric field

\(\mathbf{E}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}\)

compressibility

\(\kappa\)

\(\text{mol}\,\text{kJ}^{-1}\)

field-interaction

\(\tilde\chi\)

\(\text{kJ}\,\text{mol}^{-1}\)

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants

Constant

Symbol

Value

gas constant

\(R\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Boltzmann’s constant

\(k_\text{B}\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Avogadro’s constant

\(N_\text{A}\)

\(6.02214076 \cdot 10^23~\text{mol}^{-1}\)

Vacuum permittivity

\(\varepsilon_0\)

\(8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2\)

Coulomb constant

\(k_\text{e}\)

\(138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}\)

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/doc_pages/electrostatics.html b/v1.0.2/doc_pages/electrostatics.html new file mode 100644 index 00000000..b8250576 --- /dev/null +++ b/v1.0.2/doc_pages/electrostatics.html @@ -0,0 +1,311 @@ + + + + + + + 3. Electrostatic interactions — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Electrostatic interactions

+

In the filtered Hamiltonian hPF formalism [Bore and Cascella, 2020] the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle–mesh Ewald.

+

The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered

+
+\[\tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i),\]
+

with \(q_i\) being the charge of particle \(i\) and \(H\) is the +filtering function (see Filtering). The value of the charge grid at +vertex \((i,j,k)\) is found by

+
+\[\tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)]\]
+

and the electrostatic potential \(\Psi_{ijk}\)

+
+\[\Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right],\]
+

where \(k_\text{e}\) is the Coulomb constant \(1/4\pi\varepsilon_0\). +The electric field is obtained by differentiation of the electrostatic +potential in Fourier space,

+
+\[\mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)]\]
+

from which the forces are interpolated back to the particle positions.

+
+

3.1. Specifying electrostatics

+

In HyMD, electrostatics are specified by the coulombtype and +dielectric_const keywords in the configuration file (see +Configuration file) and the /charge dataset in the HDF5 format +structure/topology input file (see Topology and structure file). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/doc_pages/examples.html b/v1.0.2/doc_pages/examples.html new file mode 100644 index 00000000..cb015925 --- /dev/null +++ b/v1.0.2/doc_pages/examples.html @@ -0,0 +1,759 @@ + + + + + + + 1. Examples — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Examples

+

The following examples are ordered in more or less order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the HyMD-tutorial github repository.

+
+

1.1. Ideal gas

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true +

The simplest possible system is one with no interactions at all—intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like:

+
+
ideal_gas.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = false         # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+
+
+

A simple input structure/topology file ideal_gas.HDF5 is available in +the HyMD-tutorial/ideal_gas github repository (along with the code to +generate it). Run the (very) short simulation by

+
python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field   \
+                                              --velocity-output \
+                                              --force-output
+
+
+

with the --disable-field argument to completely turn off all +particle–field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook ideal_gas.ipynb for details.

+
+
+

1.2. Ideal chains

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true +

The simplest available interaction is the harmonic two-particle bond (see +Intramolecular bonds),

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2.\]
+

Extending the configuration file from the ideal gas case, we need to add a +bonds specification. Note that the [bonds] meta specifier is not +necessary, but may be used to help organise the input file.

+
+
ideal_chain.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+
+
+

A simple input structure/topology file ideal_chain.HDF5 with a few +coiled up ideal chain polymers is available in the +HyMD-tutorial/ideal_chain github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field
+
+
+

we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +ideal_chain.ipynb.

+
+
+

1.3. Stiff rods

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true +

Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the i--j--k angle \(\theta\) (see +Intramolecular bonds),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2.\]
+

Extending the configuration file from the ideal chain case, we need to add a +angle_bonds specification. Note that the [bonds] meta specifier +is not necessary, but may be used to help organise the input file.

+
+
rods.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+angle_bonds = [
+  ["A", "A", "A", 180.0, 100.0],   # (i, j, k, equilibrium angle, strength)
+]
+
+
+
+

A simple input structure/topology file rods.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook rods.ipynb.

+
+
+

1.4. Helixes

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true +

Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle \(\phi\) between the +i--j--k plane and the j--k--l plane (see Intramolecular bonds),

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n).\]
+

The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a dihedrals keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the dielectric_const +keyword even though we are not including electrostatic forces in the current +simulation. Note that the [bonds] meta specifier is not necessary, but +may be used to help organise the input file.

+
+
helixes.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+dielectric_const = 15.0
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.31, 10000.0],       # (i name, j name, equilibrium length, strength)
+]
+
+dihedrals = [
+  [
+    ["A", "A", "A", "A"],
+    [
+      [-1],
+      [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+      [0.08, 0.46, 1.65, -0.96, 0.38],
+    ],
+    [1.0]
+  ],
+]
+
+
+
+

A simple input structure/topology file helixes.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook helixes.ipynb.

+
+
+

1.5. Phase separation

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true +

The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types A and B. Using the Hamiltonian

+
+\[\mathcal{H}=H_0+W\]
+

with \(\tilde\chi\)–dependent interactions defined by (specified in the +configuration file by hamiltonian = DefaultWithChi):

+
+\[W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2.\]
+
+
phase_separation.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+
+[field]
+mesh_size = [20, 20, 20]           # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+kappa = 0.05                       # compressibility in mol/kJ
+chi = [
+  ['A', 'B', 5.0],                 # (name i, name j, strength)
+]
+
+
+
+

A simple input structure/topology file phase_separation.HDF5 containing +an equal number of A type and B type particles is available in +the HyMD-tutorial/phase_separation github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd phase_separation.toml phase_separation.HDF5
+
+
+

we may examine the resulting trajectory. In the case of a low interaction +strength \(\tilde\chi\) of 5.0 (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to 40.0 (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +phase_separation.ipynb.

+
+
+

1.6. Diblock copolymers

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true +

Having introduced particle–field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive \(\tilde\chi\)–interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the integrator = "respa" keyword. Putting the pieces together, the +configuration file may look like the following:

+
+
copolymer.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 15
+n_steps = 2000                     # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [10.0, 10.0, 10.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [50, 50, 50]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+chi = [
+  ["A", "B", 30.0],                # (i, j, strength)
+]
+
+[bonds]
+bonds = [
+  ["A", "A", 0.25, 1500.0],        # (i, j, equilibrium length, strength)
+  ["A", "B", 0.25, 1500.0],
+  ["B", "B", 0.25, 1500.0],
+]
+angle_bonds = [
+  ["A", "A", "A", 180.0, 25.0],    # (i, j, k, equilibrium angle, strength)
+  ["B", "B", "B", 180.0, 25.0],
+]
+
+
+
+

A simple input structure/topology file copolymer.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/copolymer github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten A followed by ten B type particles. +Running the simulation with

+
python3 -m hymd copolymer.toml copolymer.HDF5
+
+
+

the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +copolymer.ipynb.

+
+
+

1.7. Lipid bilayer self-assembly

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true +

Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field–particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the thermostat_coupling_groups keyword. With parameters +optimised in [Ledum et al., 2020], the configuration file looks like:

+
+
lipid_self_assembly.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 25
+n_steps = 3000
+n_print = 200
+n_flush = 1
+time_step = 0.01
+box_size = [9.96924, 9.96924, 10.03970]
+start_temperature = 323
+target_temperature = 323
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.05
+domain_decomposition = 10001
+cancel_com_momentum = true
+max_molecule_size = 15
+thermostat_coupling_groups = [
+  ["N", "P", "G", "C"],
+  ["W"],
+]
+
+[field]
+mesh_size = [25, 25, 25]
+sigma = 1.0
+chi = [
+  ["C", "W", 42.24],
+  ["G", "C", 10.47],
+  ["N", "W", -3.77],
+  ["G", "W", 4.53],
+  ["N", "P", -9.34],
+  ["P", "G", 8.04],
+  ["N", "G", 1.97],
+  ["P", "C", 14.72],
+  ["P", "W", -1.51],
+  ["N", "C", 13.56],
+]
+
+[bonds]
+bonds = [
+  ["N", "P", 0.47, 1250.0],
+  ["P", "G", 0.47, 1250.0],
+  ["G", "G", 0.37, 1250.0],
+  ["G", "C", 0.47, 1250.0],
+  ["C", "C", 0.47, 1250.0],
+]
+angle_bonds = [
+  ["P", "G", "G", 120.0, 25.0],
+  ["P", "G", "C", 180.0, 25.0],
+  ["G", "C", "C", 180.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

A randomly mixed input structure/topology file +lipid_self_assembly.HDF5 with a few hundred lipids in a roughy +10 x 10 x 10nm box is available in the +HyMD-tutorial/lipid_self_assembly github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation

+
python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5
+
+
+

we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook lipid_self_assembly.ipynb.

+
+
+

1.8. Peptide in lipid bilayer

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true +

Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer.

+

The configuration file is available in the HyMD-tutorial/peptide github +repository (omitted here for brevity).

+

A pre-equilibrated input structure/topology file peptide.HDF5 with a +few hundred lipids in a roughy 20 x 20 x 20nm box is available in the +HyMD-tutorial/peptide github repository. Running the simulation

+
python3 -m hymd peptide.toml peptide.HDF5
+
+
+

we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook peptide.ipynb.

+
+
+

1.9. SDS

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true +

The last part we introduce is explicit electrostatic interactions through +particle–mesh Ewald. Enabling the electrostatic calculations is done via the +coulombtype keyword. "PIC_Spectral" is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the dielectric_const keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge.

+
+
sds.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 10
+n_steps = 3000
+n_print = 1500
+n_flush =
+time_step = 0.01
+box_size = [8.3, 8.3, 8.3]
+start_temperature = 298
+target_temperature = 298
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.1
+domain_decomposition = 10000
+cancel_com_momentum = true
+max_molecule_size = 5
+thermostat_coupling_groups = [
+  ["S", "C"],
+  ["W", "Na"],
+]
+dielectric_const = 45.0              # dielectric constant for the simulation medium
+coulombtype = "PIC_Spectral"         # particle in cloud, spectral method
+
+[field]
+mesh_size = [64, 64, 64]
+sigma = 0.5
+chi = [
+  ["S", "C",  13.50],
+  ["S", "Na",  0.00],
+  ["S", "W",  -3.60],
+  ["C", "Na", 13.50],
+  ["C", "W",  33.75],
+  ["W", "Na",  0.00],
+]
+
+[bonds]
+bonds = [
+  ["S",   "C",   0.50, 1250.0],
+  ["C",   "C",   0.50, 1250.0],
+]
+angle_bonds = [
+  ["S", "C", "C", 170.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

An input structure/topology file sds.HDF5 with a couple thousand +randomly dispersed SDS chains is available in the HyMD-tutorial/sds github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a /charge dataset. +Running the simulation with

+
python3 -m hymd sds.toml sds.HDF5
+
+
+

we observe the aggregation of the SDS into micellular structures—first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook sds.ipynb.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/doc_pages/filtering.html b/v1.0.2/doc_pages/filtering.html new file mode 100644 index 00000000..d529a5d4 --- /dev/null +++ b/v1.0.2/doc_pages/filtering.html @@ -0,0 +1,298 @@ + + + + + + + 2. Filtering — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Filtering

+

The default grid-independent filter function used in HyMD is a Gaussian

+
+\[H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right]\]
+

with reciprocal space representation

+
+\[\hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right].\]
+

The coarse-graining parameter \(\sigma\) determines a length scale of +particle extent and is given as configuration file input by

+
sigma = 0.75
+
+
+
+

2.1. Implementing new filters

+

Implementing new filter functions is straightforward by hijacking +the setup method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/doc_pages/installation.html b/v1.0.2/doc_pages/installation.html new file mode 100644 index 00000000..7eeb630b --- /dev/null +++ b/v1.0.2/doc_pages/installation.html @@ -0,0 +1,394 @@ + + + + + + + 1. Installation — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Installation

+

HyMD may be installed using pip by

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+
+

1.1. Dependencies

+

HyMD requires a working MPI compiler and HDF5. On an Ubuntu system, this +may be installed via

+
sudo apt-get update -y
+sudo apt-get install -y libhdf5-openmpi-dev python3-mpi4py
+CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-cache-dir --no-binary=h5py h5py
+
+
+

It is highly recommended to have MPI-enabled HDF5 and h5py. A +non-MPI-enabled h5py may be installed by simply

+
sudo apt-get update -y
+sudo apt-get install libhdf5-serial-dev
+python3 -m pip --upgrade install h5py
+
+
+

A non-MPI-enabled HDF5 library with corresponding h5py will work +(mostly), but is inconvenient and slow. Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +--disable-mpio argument to HyMD, see Command line arguments. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial.

+
+
+

1.2. Install in docker

+

A docker image with build essentials setup is available at dockerhub with tag +mortele/hymd,

+
docker pull mortele/hymd:1.0
+docker run -it mortele/hynd:1.0
+/app# python3 -m pip install hymd
+/app# python3 -m hymd [CONFIGURATION_FILE] [TOPOLOGY_FILE]
+
+
+
+
+

1.3. Common issues

+
+

1.3.1. Numpy errors while importing the Fortran force kernels

+
RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd
+
+Traceback (most recent call last):
+
+  (...)
+
+File "/..../HyMD/hymd/__init__.py", line 2, in <module>
+  from .main import main  # noqa: F401
+File "/..../HyMD/hymd/main.py", line 10, in <module>
+  from .configure_runtime import configure_runtime
+File "/..../hymd/configure_runtime.py", line 12, in <module>
+  from .input_parser import read_config_toml, parse_config_toml
+File "/..../HyMD/hymd/input_parser.py", line 12, in <module>
+  from .force import Bond, Angle, Dihedral, Chi
+File "/..../HyMD/hymd/force.py", line 8, in <module>
+  from force_kernels import (  # noqa: F401
+ImportError: numpy.core.multiarray failed to import
+
+
+

can normally be fixed by updating numpy versions,

+
python3 -m pip install -U numpy
+
+
+
+
+

1.3.2. Error building pfft-python due to missing curl/wget

+
Building wheel for pfft-python (setup.py) ... error
+ERROR: Command errored out with exit status 1:
+command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_
+cwd: /tmp/pip-install-fr6nt9m4/pfft-python/
+Complete output (56 lines):
+running bdist_wheel
+running build
+running build_py
+
+  (...)
+
+curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found
+wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found
+Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+Please check curl or wget
+You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/
+Traceback (most recent call last):
+  File "<string>", line 1, in <module>
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in <module>
+    setup(
+  File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup
+    return distutils.core.setup(**attrs)
+  File "/usr/lib/python3.8/distutils/core.py", line 148, in setup
+
+  (...)
+
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions
+    build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:]))
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft
+    raise ValueError("could not build fftw; check MPICC?")
+ValueError: could not build fftw; check MPICC?
+----------------------------------------
+ERROR: Failed building wheel for pfft-python
+Running setup.py clean for pfft-python
+Failed to build pfft-python
+
+
+

can be fixed by installing either curl or wget

+
apt-get install -y curl wget
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/doc_pages/interaction_energy_functionals.html b/v1.0.2/doc_pages/interaction_energy_functionals.html new file mode 100644 index 00000000..84639745 --- /dev/null +++ b/v1.0.2/doc_pages/interaction_energy_functionals.html @@ -0,0 +1,351 @@ + + + + + + + 1. Interaction energy functionals — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Interaction energy functionals

+

A few interaction energy functionals \(W\) are defined in HyMD through +the Hamiltonian class and associated subclasses.

+
+

1.1. \(\chi\)–interaction and \(\kappa\)–incompressibility

+

The most common hPF energy functional is specified by

+
hamiltonian = "DefaultWithChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where \(\tilde\chi_{\text{A}-\text{B}}\) is the interaction energy between +overlapping densities of particle types \(\text{A}\) and \(\text{B}\). +The incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\tilde\chi\) +and \(\kappa\) in the configuration file (see Configuration file)

+
kappa = 0.05
+chi = [
+   ["A", "B", 15.85],
+   ["B", "C", -5.70],
+   ...
+]
+
+
+
+
+

1.2. Only \(\kappa\)–incompressibility

+

The only \(\kappa\) interactions energy functional is specified by

+
hamiltonian = "DefaultNoChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where the incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.3. Only \(\phi^2\)

+

The \(\phi^2\) interactions energy functional is specified by

+
hamiltonian = "SquaredPhi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2,\]
+

where the \(\phi\) squared term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.4. Implementing new interaction energy forms

+

Implementing new interaction energy functions is straightforward by subclassing +Hamiltonian and applying sympy differentiation to the symbolic +field objects. The sympy.lamdify function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/doc_pages/intramolecular_bonds.html b/v1.0.2/doc_pages/intramolecular_bonds.html new file mode 100644 index 00000000..51070a77 --- /dev/null +++ b/v1.0.2/doc_pages/intramolecular_bonds.html @@ -0,0 +1,391 @@ + + + + + + + 2. Intramolecular bonds — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Intramolecular bonds

+

Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see Configuration file. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +Benchmarks), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable.

+

All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]).

+
+

2.1. Two-particle bonds

+

Stretching bonds in HyMD are implemented as harmonic spring potentials,

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2,\]
+

where \(r=|\mathbf{r}|\) is the inter-particle distance, \(k\) is a +constant of dimension energy (units \(\text{kJ}\,\text{mol}^{-1}\)), and +\(r_0\) is the equilibrum length of the bond (units: \(\text{nm}\)). The +force is calculated as

+
+\[F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r},\]
+

where \(\mathbf{r}\) is the vector pointing from \(i\) to \(j\).

+

In the configuration file, two-particle bonds are specified per particle type:

+
+
configuration_two_particle_example.toml
+
[bonds]
+bonds = [
+   ["A", "A", 0.47, 1250.0],
+   ["A", "B", 0.37,  940.0],
+   ["B", "C", 0.50, 1010.0],
+   ["C", "A", 0.42,  550.0],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.2. Three-particle bonds

+

Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle–particle–particle angle \(\theta\),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2,\]
+

where \(k\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\)), and \(\theta_0\) is the equilibrum +angle of the bond (units: \({}^\circ\)). Defining the particles with labels +\(a\), \(b\), and \(c\), let \(\mathbf{r}_a\) denote the vector +pointing from \(b\) to \(a\), and correspondingly let +\(\mathbf{r}_c\) point from \(b\) to \(c\). The +\(a\)\(b\)\(c\) may be computed through the law of Cosines,

+
+\[\theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right]\]
+

Then the force acting on \(a\) and \(c\) is

+
+\[ \begin{align}\begin{aligned}\mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a},\\\mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c},\end{aligned}\end{align} \]
+

and

+
+\[\mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c\]
+

In the configuration file, three-particle bonds are specified per particle type:

+
+
configuration_three_particle_example.toml
+
[bonds]
+angle_bonds = [
+   ["A", "A", "A", 180.0, 90.0],
+   ["A", "B", "A", 120.0, 55.0],
+   ["B", "C", "C",  30.0, 10.0],
+   ["C", "A", "B", 110.0, 25.5],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.3. Four-particle bonds

+

Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle \(\phi\) between the +\(a\)\(b\)\(c\) and \(b\)\(c\)\(d\) planes, for +a dihedral bond quartet \(a\), \(b\), \(c\), and \(d\). The +potential takes the form

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n),\]
+

where \(c_n\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)), and \(\phi_n\) are +specified phase angles in the cosine series.

+

In the configuration file, four-particle bonds are specified per particle type:

+
+
configuration_four_particle_example.toml
+
[bonds]
+dihedrals = [
+   ["A", "B", "C", "D"],
+   [
+     [-1],
+     [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+     [0.08, 0.46, 1.65, -0.96, 0.38],
+   ],
+   [1.0],
+]
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/doc_pages/overview.html b/v1.0.2/doc_pages/overview.html new file mode 100644 index 00000000..56cbb574 --- /dev/null +++ b/v1.0.2/doc_pages/overview.html @@ -0,0 +1,412 @@ + + + + + + + 2. Usage overview for HylleraasMD — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Usage overview for HylleraasMD

+

HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a toml format configuration file, along with a topology and structure +file specifying the input system in HDF5 format.

+

Configuration file

+

The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a [5, 5, 5] nm simulation box at 300 K may look like +the following:

+
+
config_simple_1.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "SquaredPhi"         # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [30, 30, 30]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+
+
+
+

Note that for the version 1.0 release of HyMD, the [particles], +[simulation], and [field] groups are optional specifiers for +structuring the configuration file.

+

For a full specification of every recognised configuration keyword in HyMD, +please refer to Configuration file.

+

Topology and structure file

+

The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +N particles may look like the following:

+
+
example_structure.HDF5
+
group   /
+   # root group
+
+dataset /coordinates
+   # float32, shape (T, N, D,)
+   # Time steps of N rows of D dimensional coordinate data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /velocities
+   # float32, shape (T, N, D,) OPTIONAL
+   # Time steps of N rows of D dimensional velocity data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /bonds
+   # int32,   shape (N, B,)    OPTIONAL
+   # Each row i contains indices of the particles bonds from/to i
+   # B denotes the maximum bonds per particle
+
+dataset /indices
+   # int32,   shape (N,)
+   # Index of each particle, 0--(N-1)
+
+dataset /molecules
+   # int32,   shape (N,)
+   # Index of molecule each particle belongs to
+   # Used to construct bond network locally on MPI ranks
+
+dataset /names
+   # str10,   shape (N,)
+   # Fixed size string array containing particle type names
+
+dataset /types
+   # int32,   shape (N,)       OPTIONAL
+   # Mapping of particle names to type indices
+
+
+
+

For a full specification of the topology and structure input file, see +Topology and structure file.

+

Command line arguments

+

A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the config_simple_1.toml and example_structure.HDF5 +files may look like the following:

+
mpirun -n ${MPI_NUM_RANKS} python3 -m hymd         \  # HyMD executable
+                           config_simple_1.toml    \  # configuration file
+                           example_structure.HDF5  \  # structure file
+                           --logfile=log_out.txt   \  # set logfile path
+                           --seed 123456           \  # set random seed
+                           --verbose 2             \  # set logging verbosity
+                           --velocity-output          # enable velocity in trajectory output
+
+
+

For a full specification of all command line arguments, see +Command line arguments.

+

More examples

+

For more thorough rundown and concrete usage examples, see +Examples.

+
+

2.1. Running parallel simulations

+

Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the only difference being how the python3 interpreter is +invoked. Prepending mpirun -n ${NPROCS} to the usual +python3 -m hymd runs the simulation with ${NPROCS} MPI ranks.

+

Inputting

+
mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field
+
+
+

sets up an example simulation of the HyMD-tutorial/ideal_gas system. For +more details about this system in particular, or other example simulations, see +the HyMD-tutorial repository.

+
+
+

2.2. Running tests

+

Run serial code tests by

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd
+cd hymd/
+python3 -m pip install pytest pytest-mpi
+python3 -m pytest
+
+
+

There is a small convenience script in hymd/ for running the MPI-enabled +tests,

+
chmod +x pytest-mpi
+./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/doc_pages/theory.html b/v1.0.2/doc_pages/theory.html new file mode 100644 index 00000000..23a75ef8 --- /dev/null +++ b/v1.0.2/doc_pages/theory.html @@ -0,0 +1,354 @@ + + + + + + + 1. Theory — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Theory

+

Hybrid particle–field simulations switch out the ordinary particle–particle +Lennard-Jones interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle–field densities are +defined as

+
+\[\phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i),\]
+

where \(\mathbf{r}\) is a spatial coordinate, \(P\) is a window function +used to distribute particle number densities onto a computational grid, and +\(\mathbf{r}_i\) is the position of particle \(i\) (of total \(N\)). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of \(N\) particles in \(M\) molecules is

+
+\[\mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})]\]
+

with \(H_0\) being a standard intramolecular Hamiltonian form (see +Intramolecular bonds) including kinetic terms, while \(W\) is a density +dependent interaction energy functional.

+

In the Hamiltonian hPF-MD formalism [Bore and Cascella, 2020], the density +field is filtered using a grid-independent filtering function \(H\),

+
+\[\tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}).\]
+

The filter smooths the density, ensuring that \(\tilde\phi\) and +\(W[\tilde\phi([\phi])]\) both converge as the grid size is reduced.

+
+

1.1. External potential

+

The external potential acting on a particle is defined as the functional +derivative of \(W\) with respect to \(\phi\). In the filtered formalism, +the potential takes the form

+
+\[\begin{split}V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ +&= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})},\end{split}\]
+

under the assumption of a local form of the interaction energy functional, +\(W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]\). Note +that

+
+\[\frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}).\]
+
+
+

1.2. Force interpolation

+

The forces on particle \(i\) are obtained by differentiation of the external +potential,

+
+\[\mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i).\]
+
+
+

1.3. Reciprocal space calculations

+

The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density \(\phi_{ijk}\) with CIC, we apply the filtering +and obtain the discrete version of the external potential by

+
+\[\tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big]\]
+

and

+
+\[V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+

The forces are obtained by differentiation of \(V\) in Fourier space as

+
+\[\nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+
+
+

1.4. Filter

+

By default, the filter used in HyMD is a simple Gaussian of the form

+
+\[\begin{split}H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ +\hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right].\end{split}\]
+

For more details about the filtering, see Filtering.

+
+
+

1.5. Hamiltonian form

+

The default form of the interaction energy functional in HyMD is

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2.\]
+

See Interaction energy functionals for details.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/doc_pages/topology_input.html b/v1.0.2/doc_pages/topology_input.html new file mode 100644 index 00000000..df7eaddb --- /dev/null +++ b/v1.0.2/doc_pages/topology_input.html @@ -0,0 +1,335 @@ + + + + + + + 4. Topology and structure file — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Topology and structure file

+

The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root / group.

+

The HyMD-tutorial has multiple examples of structure files for various levels +of complexity.

+
+

4.1. Required datasets

+
+
/coordinates:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/indices:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/names:
+

array shape [N,]

+

datatype [string (length between 1 and 16)]

+

The shape represents one particle name per N particles. The datatype may be a string of length =<16.

+
+
+
+
+

4.2. Optional datasets

+
+
/velocities:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/types:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle type index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/molecules:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one molecule index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/bonds:
+

array shape [N, B,]

+

datatype [int32 or int64]

+

The shape represents B bond specifications (indices of different particles) per N particles. The data type may be either 32 or 64 bit integers.

+
+
/charge:
+

array shape [N,]

+

datatype [float32 or float64]

+

The shape represents one particle charge per N particles. The data type may be either four or eight byte reals.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/genindex.html b/v1.0.2/genindex.html new file mode 100644 index 00000000..a7706f12 --- /dev/null +++ b/v1.0.2/genindex.html @@ -0,0 +1,813 @@ + + + + + + Index — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + +
+ +

F

+ + + +
+ +

G

+ + +
+ +

H

+ + + +
    +
  • + hymd.input_parser + +
  • +
  • + hymd.integrator + +
  • +
  • + hymd.thermostat + +
  • +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/index.html b/v1.0.2/index.html new file mode 100644 index 00000000..a01d2664 --- /dev/null +++ b/v1.0.2/index.html @@ -0,0 +1,395 @@ + + + + + + + HylleraasMD documentation — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

HylleraasMD documentation

+
+
Release:
+

1.0.2

+
+
Date:
+

Jan 07, 2022

+
+
+

HylleraasMD (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems.

+

HyMD can run canonical hPF-MD simulations [Milano and Kawakatsu, 2009], or filtered +density Hamiltonian hPF (HhPF-MD) simulations [Bore and Cascella, 2020], with +or without explicit PME electrostatic interactions [Kolli et al., 2018]. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +[Bore et al., 2018, Cascella et al., 2008]. Martini +style elastic networks (ElNeDyn) [Periole et al., 2009] are also +supported.

+

HyMD uses the pmesh (github.com/rainwoodman/pmesh) library for particle-mesh +operations, with the PPFT [Pippig, 2013] backend for FFTs through the +pfft-python bindings (github.com/rainwoodman/pfft-python). File IO is done +via HDF5 formats to allow MPI parallel reads.

+
+

User Guide

+

The HylleraasMD User Guide provides comprehensive information on how to run +simulations. Selected Examples are available to guide new users.

+
+
+

Installing HyMD

+

The easiest approach is to install using pip:

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+

For more information and required dependencies, see +Installation.

+
+
+

Source Code

+

Source code is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the GNU Lesser General Public +License v3.0. Obtain the source code with git:

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git
+
+
+
+
+

Development

+

HyMD is developed and maintained by researchers at the Hylleraas Centre for +Quantum Molecular Sciences at the University of Oslo.

+

pic1 pic2

+
+
+

References

+
+
+[BC20] +

Sigbjørn Løland Bore and Michele Cascella. Hamiltonian and alias-free hybrid particle–field molecular dynamics. J. Chem. Phys., 153(9):094106, 2020. doi:10.1063/5.0020733.

+
+
+[BMC18] +

Sigbjørn Løland Bore, Giuseppe Milano, and Michele Cascella. Hybrid particle-field model for conformational dynamics of peptide chains. J. Chem. Theory Comput., 14(2):1120–1130, 2018. doi:10.1021/acs.jctc.7b01160.

+
+
+[BDP07] +

Giovanni Bussi, Davide Donadio, and Michele Parrinello. Canonical sampling through velocity rescaling. J. Chem. Phys., 126(1):014101, 2007. doi:10.1063/1.2408420.

+
+
+[CNCDP08] +

Michele Cascella, Marilisa A. Neri, Paolo Carloni, and Matteo Dal Peraro. Topologically based multipolar reconstruction of electrostatic interactions in multiscale simulations of proteins. J. Chem. Theory Comput., 4(8):1378–1385, 2008. doi:10.1021/ct800122x.

+
+
+[KDNB+18] +

Hima Bindu Kolli, Antonio De Nicola, Sigbjørn Løland Bore, Ken Schäfer, Gregor Diezemann, Jürgen Gauss, Toshihiro Kawakatsu, Zhong-Yuan Lu, You-Liang Zhu, Giuseppe Milano, and Michele Cascella. Hybrid particle-field molecular dynamics simulations of charged amphiphiles in an aqueous environment. J. Chem. Theory Comput., 14(9):4928–4937, 2018. doi:10.26434/chemrxiv.6264644.v1.

+
+
+[LBC20] +

Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Automated determination of hybrid particle-field parameters by machine learning. Mol. Phys., 118(19-20):e1785571, 2020. doi:10.1080/00268976.2020.1785571.

+
+
+[MK09] +

Giuseppe Milano and Toshihiro Kawakatsu. Hybrid particle-field molecular dynamics simulations for dense polymer systems. J. Chem. Phys., 130(21):214106, 2009. doi:10.1063/1.3142103.

+
+
+[PCMC09] +

Xavier Periole, Marco Cavalli, Siewert-Jan Marrink, and Marco A Ceruso. Combining an elastic network with a coarse-grained molecular force field: structure, dynamics, and intermolecular recognition. Journal of chemical theory and computation, 5(9):2531–2543, 2009. doi:10.1021/ct9002114.

+
+
+[Pip13] +

Michael Pippig. Pfft: an extension of fftw to massively parallel architectures. SIAM J. Sci. Comput., 35(3):C213–C236, 2013. doi:10.1137/120885887.

+
+
+[TBM92] +

MBBJM Tuckerman, Bruce J Berne, and Glenn J Martyna. Reversible multiple time scale molecular dynamics. J. Chem. Phys., 97(3):1990–2001, 1992. doi:10.1063/1.463137.

+
+
+
+
+
+

Indices and tables

+ +
+
+
+
+
+
+
+
+
+ + + +
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+ + + + + +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/objects.inv b/v1.0.2/objects.inv new file mode 100644 index 00000000..33e220e0 Binary files /dev/null and b/v1.0.2/objects.inv differ diff --git a/v1.0.2/py-modindex.html b/v1.0.2/py-modindex.html new file mode 100644 index 00000000..dabf0593 --- /dev/null +++ b/v1.0.2/py-modindex.html @@ -0,0 +1,321 @@ + + + + + + Python Module Index — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ h +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ h
+ hymd +
    + hymd.field +
    + hymd.file_io +
    + hymd.force +
    + hymd.input_parser +
    + hymd.integrator +
    + hymd.thermostat +
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.2/search.html b/v1.0.2/search.html new file mode 100644 index 00000000..ee7792f2 --- /dev/null +++ b/v1.0.2/search.html @@ -0,0 +1,291 @@ + + + + + + Search — hymd 1.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v1.0.2/searchindex.js b/v1.0.2/searchindex.js new file mode 100644 index 00000000..732d6d49 --- /dev/null +++ b/v1.0.2/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["doc_pages/api","doc_pages/benchmarks","doc_pages/command_line","doc_pages/config_file","doc_pages/constants_and_units","doc_pages/electrostatics","doc_pages/examples","doc_pages/filtering","doc_pages/installation","doc_pages/interaction_energy_functionals","doc_pages/intramolecular_bonds","doc_pages/overview","doc_pages/theory","doc_pages/topology_input","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,"sphinxcontrib.bibtex":9,sphinx:56},filenames:["doc_pages/api.rst","doc_pages/benchmarks.rst","doc_pages/command_line.rst","doc_pages/config_file.rst","doc_pages/constants_and_units.rst","doc_pages/electrostatics.rst","doc_pages/examples.rst","doc_pages/filtering.rst","doc_pages/installation.rst","doc_pages/interaction_energy_functionals.rst","doc_pages/intramolecular_bonds.rst","doc_pages/overview.rst","doc_pages/theory.rst","doc_pages/topology_input.rst","index.rst"],objects:{"hymd.field":{compute_field_and_kinetic_energy:[0,1,1,""],compute_field_energy_q_GPE:[0,1,1,""],compute_field_force:[0,1,1,""],compute_self_energy_q:[0,1,1,""],domain_decomposition:[0,1,1,""],initialize_pm:[0,1,1,""],update_field:[0,1,1,""],update_field_force_q:[0,1,1,""],update_field_force_q_GPE:[0,1,1,""]},"hymd.file_io":{OutDataset:[0,2,1,""],distribute_input:[0,1,1,""],setup_time_dependent_element:[0,1,1,""],store_data:[0,1,1,""],store_static:[0,1,1,""]},"hymd.file_io.OutDataset":{close_file:[0,3,1,""],flush:[0,3,1,""],is_open:[0,3,1,""]},"hymd.force":{Angle:[0,2,1,""],Bond:[0,2,1,""],Chi:[0,2,1,""],Dielectric_type:[0,2,1,""],Dihedral:[0,2,1,""],compute_angle_forces__plain:[0,1,1,""],compute_bond_forces__plain:[0,1,1,""],compute_dihedral_forces__plain:[0,1,1,""],dipole_forces_redistribution:[0,1,1,""],find_all_paths:[0,1,1,""],prepare_bonds:[0,1,1,""],prepare_bonds_old:[0,1,1,""],prepare_index_based_bonds:[0,1,1,""],propensity_potential_coeffs:[0,1,1,""]},"hymd.force.Angle":{atom_3:[0,4,1,""]},"hymd.force.Bond":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],equilibrium:[0,4,1,""],strength:[0,4,1,""]},"hymd.force.Chi":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],interaction_energy:[0,4,1,""]},"hymd.force.Dielectric_type":{atom_1:[0,4,1,""],dielectric_value:[0,4,1,""]},"hymd.force.Dihedral":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],atom_3:[0,4,1,""],atom_4:[0,4,1,""],coeffs:[0,4,1,""],dih_type:[0,4,1,""]},"hymd.hamiltonian":{DefaultNoChi:[0,2,1,""],DefaultWithChi:[0,2,1,""],Hamiltonian:[0,2,1,""],SquaredPhi:[0,2,1,""]},"hymd.hamiltonian.DefaultNoChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.DefaultWithChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.Hamiltonian":{__init__:[0,3,1,""],_setup:[0,3,1,""]},"hymd.hamiltonian.SquaredPhi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.input_parser":{Config:[0,2,1,""],check_NPT_conditions:[0,1,1,""],check_angles:[0,1,1,""],check_bonds:[0,1,1,""],check_box_size:[0,1,1,""],check_cancel_com_momentum:[0,1,1,""],check_charges:[0,1,1,""],check_charges_types_list:[0,1,1,""],check_chi:[0,1,1,""],check_config:[0,1,1,""],check_dielectric:[0,1,1,""],check_dihedrals:[0,1,1,""],check_domain_decomposition:[0,1,1,""],check_hamiltonian:[0,1,1,""],check_integrator:[0,1,1,""],check_m:[0,1,1,""],check_mass:[0,1,1,""],check_max_molecule_size:[0,1,1,""],check_n_b:[0,1,1,""],check_n_flush:[0,1,1,""],check_n_particles:[0,1,1,""],check_n_print:[0,1,1,""],check_name:[0,1,1,""],check_start_and_target_temperature:[0,1,1,""],check_tau:[0,1,1,""],check_thermostat_coupling_groups:[0,1,1,""],parse_config_toml:[0,1,1,""],read_config_toml:[0,1,1,""],sort_dielectric_by_type_id:[0,1,1,""]},"hymd.input_parser.Config":{a:[0,4,1,""],angle_bonds:[0,4,1,""],barostat:[0,4,1,""],barostat_type:[0,4,1,""],bonds:[0,4,1,""],box_size:[0,4,1,""],cancel_com_momentum:[0,4,1,""],chi:[0,4,1,""],conv_crit:[0,4,1,""],convergence_type:[0,4,1,""],coulomb_constant:[0,4,1,""],coulombtype:[0,4,1,""],dielectric_const:[0,4,1,""],dielectric_type:[0,4,1,""],dihedrals:[0,4,1,""],domain_decomposition:[0,4,1,""],dtype:[0,4,1,""],file_name:[0,4,1,""],gas_constant:[0,4,1,""],hamiltonian:[0,4,1,""],initial_energy:[0,4,1,""],integrator:[0,4,1,""],kappa:[0,4,1,""],m:[0,4,1,""],mass:[0,4,1,""],max_molecule_size:[0,4,1,""],mesh_size:[0,4,1,""],n_b:[0,4,1,""],n_flush:[0,4,1,""],n_particles:[0,4,1,""],n_print:[0,4,1,""],n_steps:[0,4,1,""],name:[0,4,1,""],pol_mixing:[0,4,1,""],pressure:[0,4,1,""],respa_inner:[0,4,1,""],rho0:[0,4,1,""],self_energy:[0,4,1,""],sigma:[0,4,1,""],start_temperature:[0,4,1,""],tags:[0,4,1,""],target_pressure:[0,4,1,""],target_temperature:[0,4,1,""],tau:[0,4,1,""],tau_p:[0,4,1,""],thermostat_coupling_groups:[0,4,1,""],thermostat_work:[0,4,1,""],time_step:[0,4,1,""],type_charges:[0,4,1,""]},"hymd.integrator":{integrate_position:[0,1,1,""],integrate_velocity:[0,1,1,""]},"hymd.logger":{Logger:[0,2,1,""],MPIFilterAll:[0,2,1,""],MPIFilterRoot:[0,2,1,""]},"hymd.logger.Logger":{setup:[0,3,1,""]},"hymd.logger.MPIFilterAll":{filter:[0,3,1,""]},"hymd.logger.MPIFilterRoot":{filter:[0,3,1,""]},"hymd.thermostat":{_random_chi_squared:[0,1,1,""],_random_gaussian:[0,1,1,""],csvr_thermostat:[0,1,1,""]},hymd:{field:[0,0,0,"-"],file_io:[0,0,0,"-"],force:[0,0,0,"-"],input_parser:[0,0,0,"-"],integrator:[0,0,0,"-"],thermostat:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0020733":14,"00268976":14,"0083144621":0,"01036426965":4,"014101":[0,14],"02214076":4,"03642696562":4,"03970":6,"08790868":[6,10],"094106":14,"0xd":8,"0xe":8,"100":[4,6,11],"1000":6,"10000":6,"10001":6,"1010":10,"1021":14,"1063":14,"1080":14,"10nm":6,"110":10,"1120":[0,14],"1130":[0,14],"1137":14,"118":14,"120":[3,6,10],"120885887":14,"120ff":0,"123456":11,"1250":[3,6,10],"126":[0,14],"130":14,"1378":14,"138":[0,4],"1385":14,"144":8,"148":8,"1500":6,"153":14,"170":6,"1785571":14,"179":0,"180":[3,6,10],"1974":0,"1981":0,"1990":14,"1992":[3,14],"200":[6,10],"2000":6,"2001":14,"2007":[0,3,14],"2008":[0,14],"2009":14,"201":[0,3],"2013":14,"2018":[0,14],"2020":[5,6,12,14],"2022":14,"20nm":6,"214106":14,"223":0,"224":1,"2408420":14,"2408724":[6,10],"246":0,"251":[6,10],"2531":14,"2543":14,"26434":14,"28103735":0,"298":6,"2_1":0,"2don2d":8,"2nd":0,"300":[6,11],"3000":6,"3142103":14,"3144621":4,"323":6,"449":[6,10],"463137":14,"48626121":[6,10],"4928":14,"4937":14,"533":1,"544":[6,10],"550":10,"59427866":[6,10],"602176634":4,"610":[6,10],"6264644":14,"66053906660":4,"7b01160":14,"85418781281":4,"935458":[0,4],"940":10,"96924":6,"980":3,"9918564":[6,10],"boolean":3,"byte":13,"case":[0,3,6,10],"class":[0,9],"default":[0,3,7,11,12,13],"float":[0,3],"function":[0,3,5,6,7,11,12],"int":[0,5,6,9,12],"long":[5,6],"new":[0,10,13,14],"public":14,"return":[0,8],"short":[6,11],"sigbj\u00e3":14,"static":0,"switch":12,"true":[0,3,6],"while":[0,12],Adding:6,For:[0,11,12,14],The:[0,3,5,6,7,9,10,11,12,13,14],Then:10,There:11,These:0,Used:[0,3,11],Using:[6,9],With:[0,6],__file__:8,__init__:[0,8],_gener:0,_random_chi_squar:0,_random_gaussian:0,_setup:0,about:[3,11,12],abov:[0,6],absent:0,acceler:0,accompani:6,accord:[0,3],accur:14,acid:6,across:[0,3],acs:14,act:[0,10,12],adapt:0,add:[5,6],added:0,adding:6,addison:0,addit:[0,2,5,11],addition:14,additon:0,adher:0,affect:0,affili:[0,2],after:[0,10,12],against:8,aggreg:6,ahren:0,alanin:6,algorithm:[0,3,12],alia:14,all:[0,2,3,4,6,8,10,11,14],all_nam:0,all_rank:0,alloc:0,allow:[11,14],allreduc:0,along:[6,11],alpha3:8,alpha:0,also:[6,8,14],altern:2,alwai:[0,3],amino:6,amphiphil:14,analyt:0,angl:[0,2,3,6,8,10],angle_bond:[0,3,6,10],angular:[0,3,6,10],ani:[0,2,3],anisotrop:0,antonio:14,apart:0,api:8,app:8,appli:[0,3,7,9,12],applic:0,approach:14,approxim:0,apt:8,aqueou:14,architectur:14,arg:0,argument:[0,6,8,11],argv:8,aris:0,around:10,arrai:[0,3,11,13],arriv:6,art:0,aspect:3,assess:0,assign:[0,3,10],associ:[0,9],assum:3,assumpt:12,atom:0,atom_1:0,atom_2:0,atom_3:0,atom_4:0,attach:13,attempt:0,attr:8,attract:3,attribut:0,autom:14,automat:[0,7,9],avail:[6,8,14],averag:[0,9],avogadro:4,back:[0,5],backbon:[0,2,3,14],backcon:0,backend:14,backmap:0,balanc:0,ballist:6,bar:4,barostat:0,barostat_typ:0,base:[0,14],bath:[0,3],bb_index:0,bc20:14,bdist_wheel:8,bdp07:14,bead:0,becaus:0,becom:0,befor:[0,3,6],being:[0,2,3,5,10,11,12],belong:11,below:6,benchmark:10,bend:[0,3,10,14],bern:14,besid:2,best:0,beta:0,better:0,between:[0,3,5,6,9,10,12,13],bia:0,big:12,bin:8,binari:8,bind:14,bindu:14,bio:14,bit:[0,13],blueprint:0,bmc18:14,boltzmann:[0,3,4],bond2_energi:0,bond3_energi:0,bond4_energi:0,bond:[0,2,6,8,11,12,13],bonds_2:0,bonds_2_atom1:0,bonds_2_atom2:0,bonds_2_atom_1:0,bonds_2_atom_2:0,bonds_2_equilibrium:0,bonds_2_strength:0,bonds_3:0,bonds_3_atom_1:0,bonds_3_atom_2:0,bonds_3_atom_3:0,bonds_3_equilibrium:0,bonds_3_strength:0,bonds_4:0,bonds_4_atom_1:0,bonds_4_atom_2:0,bonds_4_atom_3:0,bonds_4_atom_4:0,bonds_4_coeff:0,bonds_4_last:0,bonds_4_typ:0,bool:0,bore:[0,5,12,14],both:[0,12],boundari:[0,3],box:[0,3,6,11],box_siz:[0,3,6,11],breviti:6,broadcast:0,bruce:14,buffer:[0,3],build_extens:8,build_pfft:8,build_pi:8,built:8,bussi:[0,3,14],c213:14,c236:14,c_n:[0,6,10],cach:8,calcul:[0,3,6,10],calibr:0,call:[0,8],callabl:0,can:[6,8,14],cancel_com_momentum:[0,3,6],canon:[0,3,14],capabl:2,captur:11,carloni:14,carri:6,cascella:[5,11,12,14],caval:14,cbt:0,cdot10:4,cdot:[0,4,10],cell:[0,12],center:[0,3],centr:14,certain:[0,2],ceruso:14,chain:[0,14],chang:[0,3],changedin:0,charg:[0,3,4,5,6,13,14],charge_out:0,check:[0,8],check_angl:0,check_bond:0,check_box_s:0,check_cancel_com_momentum:0,check_charg:0,check_charges_types_list:0,check_chi:0,check_config:0,check_dielectr:0,check_dihedr:0,check_domain_decomposit:0,check_hamiltonian:0,check_integr:0,check_m:0,check_mass:0,check_max_molecule_s:0,check_n_b:0,check_n_flush:0,check_n_particl:0,check_n_print:0,check_nam:0,check_npt_condit:0,check_start_and_target_temperatur:0,check_tau:0,check_thermostat_coupling_group:0,chem:[0,14],chemic:14,chemrxiv:14,chi:[0,3,4,6,8],chi_2:0,chi_3:0,chi_:[0,3,6,9,12],chi_m:0,chmod:11,chosen:0,cic:[0,5,12],circ:[3,10],circumv:12,classmethod:0,classvar:0,clean:[0,8],clone:[11,14],close:[0,8],close_fil:0,closest:0,cloud:[0,6,12],cncdp08:14,coars:[0,3,7,14],code:[0,1,2,3,6,8,11],coeff:0,coeffici:0,coil:[0,6],collect:[0,13],com:[0,8,11,14],combin:[0,6,14],comm:0,comm_world:0,command:[8,11],common:9,commuic:0,commun:[0,3,10],communc:0,compar:6,compat:2,compil:[0,8],compiler_so:8,complesfield:0,complet:[0,6,8],complex:[6,13],complexfield:0,compon:0,comprehens:14,compress:[0,3,4,6,9,11],comput:[0,5,10,12,14],compute_angle_forces__plain:0,compute_bond_forces__plain:0,compute_dihedral_forces__plain:0,compute_field_and_kinetic_energi:0,compute_field_energy_q_gp:0,compute_field_forc:0,compute_potenti:0,compute_self_energy_q:0,concret:11,condit:6,config:0,config_simple_1:11,configur:[0,2,5,6,7,9,10,11],configuration_fil:8,configuration_four_particle_exampl:10,configuration_three_particle_exampl:10,configuration_two_particle_exampl:10,configure_runtim:8,conform:[6,13,14],connect:0,conserv:1,consid:6,consist:[0,6],consit:6,consitu:0,constant:[0,3,5,6,10],constitut:[0,2,3],construct:[0,10,11],constructor:0,contain:[0,1,2,3,6,11],content:[0,6],contribut:0,control:3,conv_crit:0,conv_fun:0,conveni:11,converg:[0,12],convergence_typ:0,convert:0,coordin:[11,12,13],copi:0,core:8,correct:[0,3],correspond:[0,3,8],correspondingli:10,cos:[0,6,10],cosin:[0,3,6,10],cost:[3,10],could:8,coulomb:[0,3,4,5],coulomb_const:0,coulombtyp:[0,3,5,6],counter:6,coupl:[0,3,6,11],cprofil:2,cpu:[0,10],crash:3,creat:[0,9],critic:[0,6],cross:0,csvr:[0,3],csvr_thermostat:0,ct800122x:14,ct9002114:14,current:6,cwd:8,cython:[8,14],d_n:0,dal:14,data:[0,6,11,13],dataclass:0,dataset:[0,5,6,11],datatyp:13,date:[0,14],date_format:0,david:14,debug:[0,2],decompos:0,decomposit:[0,3,10],default_level:0,defaultnochi:[0,6,9],defaultnohchi:[0,3],defaultwithchi:[0,3,6,9],defin:[0,6,9,10,12],definit:0,degre:3,delta:[0,12],denot:[0,1,3,9,10,11],dens:14,densiti:[0,3,5,9,12,14],depend:[0,6,10,12,14],deprec:0,deriv:[0,12],design:6,dest_directori:0,detail:[2,3,6,11,12],determin:[0,2,7,14],dev:8,develop:6,deviat:[0,3],dict:0,dictat:0,dictionari:0,dielectr:[0,3,6],dielectric_const:[0,3,5,6],dielectric_typ:0,dielectric_valu:0,dieter:0,diezemann:14,differ:[0,3,6,11,13],differenti:[0,5,7,9,12],difficult:2,dih_typ:0,dihedr:[0,2,3,5,6,8,10,14],dimens:[0,10,11,13],dimension:11,dipol:[0,2,3,5,6,14],dipole_forces_redistribut:0,dir:8,direct:[0,3],directori:11,disabl:[2,6,8,11],disable_mpio:0,discard:0,discret:[0,12],discretis:12,disk:[0,3],dispers:6,dist:8,distanc:[0,3,10],distinct:0,distribut:[0,3,5,6,12],distribute_input:0,distutil:8,doc:0,dockerhub:8,dodecyl:6,doe:[0,10],doi:14,domain:[0,3,10],domain_decomposit:[0,3,6],donadio:[0,14],done:[0,6,14],dopc:6,dot:0,dot_elec:0,doubl:2,double_out:0,download:8,dppc:6,draw:0,drawn:0,driver:11,dtype:0,due:[0,3],dump:0,dump_per_particl:0,dure:[0,2,3,10,11],dynam:[0,3,11,12,14],e1785571:14,e_k:0,each:[0,3,6,10,11],easiest:14,effect:[0,3],effici:10,eight:13,either:[0,3,8,13],elast:14,elec:0,elec_field:0,elec_field_contrib:0,elec_field_fouri:0,elec_forc:0,elecrostat:0,electr:[0,4,5],electrosat:0,electrostat:[0,6,14],elnedyn:14,elucid:6,embed:6,emit:0,emploi:0,empti:0,enabl:[2,6,8,11],enclos:0,end:0,energi:[0,1,3,4,6,7,10,11,12],energiesself:0,ensur:[0,3,6,12],entri:3,environ:14,epsilon:0,equal:[0,3,6],equat:0,equilibr:6,equilibrium:[0,3,6],equilibrum:10,equival:[0,3],error:0,essenti:[0,1,8],etc:[2,3],even:[0,3,6,8],event:0,everi:[0,3,6,10,11],evid:0,ewald:[0,5,6],examin:6,exampl:[3,11,13,14],example_structur:11,except:10,exchang:[0,3],exec:8,execut:[0,11],exist:0,exit:8,exp:[7,12],expand:0,expans:0,expect:0,expens:[3,12],explicit:[0,6,10,14],express:0,ext:0,extend:6,extens:14,extent:[0,7],extern:0,extract:0,f401:8,f_angl:0,f_bond:0,f_dihedr:0,f_dipol:0,f_on_bead:0,factor:0,factori:0,fail:[0,8],fals:[0,3,6],fashion:[0,3],fast:12,fer:14,few:[6,9,10,11],fft:[0,1,2,3,5,6,11,12,14],fftw3:8,fftw:[8,14],field:[2,4,5,6,9,11,12,14],field_energi:0,field_list:0,field_q_energi:0,field_q_self_energi:0,file:[2,5,6,7,8,9,10,11,14],file_io:0,file_nam:0,file_path:0,filter:[0,3,5,6,11,14],find:0,find_all_path:0,first:[0,3,6,11],five:0,fix:[0,8,11],flag:[0,13],flat:11,float32:[11,13],float64:13,flori:0,fluctuat:0,flush:[0,3],follow:[0,2,3,4,6,11],forc:[2,3,4,5,6,10,14],force_kernel:8,force_mesh:0,force_mesh_elec:0,force_mesh_elec_fouri:0,force_out:0,forego:2,form:[0,5,10],formal:[5,12],format:[0,2,3,5,11,13,14],formatt:0,fortran:[0,10],forward:0,found:[5,8],four:[0,2,3,6,13],fourier:[0,5,12],fr6nt9m4:8,frac:[0,5,6,7,9,10,12],frame:[0,11,13],free:14,frequenc:[0,3],from:[0,2,3,5,6,8,9,10,11,14],full:[0,9,11],fulli:[0,6],fundament:11,gamma:0,gamma_0:0,gas:[0,4],gas_const:0,gather:0,gauss:14,gaussian:[0,3,7,12],gener:[0,2,3,6,14],get:8,getattr:8,ghost:0,giovanni:14,git:[11,14],github:[6,8,11,14],giusepp:14,given:[0,3,6,7],glenn:14,global:0,gnu:14,govern:9,gpe:0,gradient:0,grain:[0,3,7,14],graph:0,gregor:14,grid:[0,1,3,5,6,7,11,12],group:[0,3,6,11,13,14],guess:0,gyrat:6,h5md:[0,3],h5py:[0,2,8],h_0:[6,12],half:0,hamiltonian:[3,5,6,7,9,11,14],handl:0,handler:0,happen:10,harmon:[0,3,6,10],has:[0,3,13],hat:[7,12],have:[0,6,8],hdf5:[0,2,3,5,6,8,11,13,14],hdf5_mpi:8,head:6,heat:[0,3],helic:[0,3,5,6],help:6,helper:0,here:[0,6],hhpf:14,highli:[8,10,11],hijack:7,hima:14,hire:1,homogen:0,homopolym:1,homopolypeptid:6,how:[3,11,14],howev:6,hpf:[3,5,9,11,12,14],html:0,http:[0,8,11,14],huggin:0,hundr:[6,10],hybrid:[11,12,14],hylleraa:14,hymd:[0,2,3,4,5,6,7,8,9,10,11,12,13],hynd:8,ideal:10,ideal_chain:6,ideal_ga:[6,11],ident:0,ignor:0,ijk:[5,12],imag:8,impact:0,implement:[0,10],importerror:8,impuls:[0,3],in_fil:0,includ:[0,2,3,6,12,14],incompress:[0,3],inconveni:8,increas:[0,2,6],indentifi:0,independ:[0,3,7,12],index:[0,11,13,14],indic:[0,2,3,10,11,13],indirect:0,individu:[0,3,6],induc:5,infer:10,info:0,inform:[0,10,14],ingredi:6,initi:0,initial_energi:0,initialis:11,initialize_pm:0,inner:[0,3],input:[2,3,4,5,6,7,11,13],input_box:0,input_pars:[0,8],insid:[0,3,6],instal:[2,11],install_pfft:8,instantan:0,int32:[11,13],int64:13,integ:[0,3,6,13],integr:[3,6,11],integrate_posit:0,integrate_veloc:0,intend:8,inter:[0,10],interact:[0,2,3,4,6,7,11,12,14],interaction_energi:0,interfac:0,intergr:0,intermediari:0,intermolecular:[6,14],intern:[0,2,4,10],interpol:[0,5],interpret:11,interv:[0,3],intmathrm:0,intracomm:0,intramolecular:[0,3,6,12,14],intrins:5,introduc:6,investig:0,invok:[2,11],involv:[0,3,10],ion:6,ipynb:6,is_open:0,iter:0,j_k:0,jan:14,jctc:14,join:8,jone:12,journal:14,jupyt:6,k_e:0,kappa:[0,3,4,6,11,12],kawakatsu:14,kdnb:14,keep:[0,3],kelvin:[0,3,6,11],ken:14,kernel:[0,10],keyword:[0,5,6,11],kinet:[0,12],kinetic_energi:0,knuth:0,kolli:14,kpa:4,label:[1,10],lambda:0,lamdifi:9,land:14,laplacian:0,larg:11,larger:3,last:[6,8,11,13],last_bb:0,later:[0,6],law:10,layout:0,layout_q:0,lbc20:14,learn:14,leav:0,ledum:[6,14],left:[0,5,6,7,9,10,12],legend:1,lenght:0,length:[0,3,4,6,7,10,11,13],lennard:12,less:[0,6],lesser:14,let:[0,10],level:[0,2,3,13],liang:14,lib:8,libhdf5:8,librari:[0,2,8,14],licens:14,lieu:0,like:[0,6,11],limit:3,line:[0,8,11],linear:[0,3],lipid_self_assembl:6,list:0,list_coulomb:0,load:0,local:[0,10,11,12],log:[0,2,11],log_fil:0,log_out:11,logfil:[2,11],logger:2,logic:0,logrecord:0,look:[6,11],loop:0,lost:3,low:6,m_j:0,machin:[2,14],made:0,mai:[0,2,3,6,8,10,11,13],main:[0,8,11],maintain:14,make:6,manner:6,manual:8,map:[0,11],marco:14,marilisa:14,marrink:14,martini:[6,14],martyna:14,mass:[0,3,4,13],massiv:14,match:0,math:0,mathbf:[0,4,5,6,9,10,12],mathcal:[6,12],mathmr:0,mathrm:[0,5,6,9,10,12],matteo:14,matter:[6,10,14],max_molecule_s:[0,3,6],maximum:[0,3,10,11],maxwel:[0,3],may:2,mbbjm:14,mean:[0,2,3],measur:10,medium:[0,3,6],melt:1,membran:6,memori:0,mesh:[0,1,3,5,6,14],mesh_siz:[0,3,6,11],messag:0,messi:0,meta:6,metadata:0,method:[0,1,6,7],mh_0:12,micellular:6,michael:14,michel:14,might:0,milano:14,mimic:0,minim:6,minuscul:10,mirror:2,mix:[0,6],mk09:14,model:[6,14],modifi:0,modul:[0,3,8,14],mol:[3,4,6,10,11,14],molecul:[0,3,11,12,13],molecular:[2,11,12,14],momenta:[0,11],momentum:[0,3,4],monoatom:6,more:[2,3,6,11,12,14],mortel:8,morten:14,most:[8,9,11,12],mostli:[2,8],motion:[0,6],move:0,mpi4pi:[0,8,14],mpi:[0,2,3,8,10,11,14],mpi_num_rank:11,mpicc:8,mpifilteral:0,mpifilterroot:0,mpio:[2,8],mpirun:11,multiarrai:8,multipl:[0,3,6,11,13,14],multipolar:14,multiscal:14,must:[0,3],n_b:0,n_flush:[0,3,6],n_frame:0,n_particl:[0,3],n_print:[0,3,6,11],n_step:[0,3,6,11],n_type:0,nabla:[0,12],name:[0,2,3,6,10,11,13],nanomet:[0,1],nanosecond:6,ndarrai:0,ne5et1y_:8,necessari:[0,6],necessit:[8,9],need:[0,6],neg:[0,6],neighbour:0,neri:14,network:[0,10,11,13,14],networkx:0,neutralis:6,never:[0,3],nevertheless:3,next:[0,6],nicola:14,non:[0,2,6,8],none:[0,3],nongnu:0,noqa:8,normal:[0,2,3,8,12],notabl:11,note:[0,6,8,11,12],notebook:6,now:6,nproc:11,npt:0,nq_i:5,number:[0,1,2,3,6,11,12,13],numer:0,numpi:[0,2,9,14],nvt:0,object:[0,9],oblat:6,observ:[0,6],obtain:[0,5,12,14],off:6,omit:6,onc:[3,10],one:[0,2,3,6,13],onli:[0,6,10,11],onto:[0,3,5,12],open:[0,8],openmpi:8,oper:[0,3,12,14],oppos:0,optim:[0,10],optimis:[6,10],option:[0,3,6,11],order:[0,3,6,10,11],ordinari:[5,12],org:0,organis:6,origin:0,oslo:14,other:[0,11],otherwis:0,out:[8,12],outdataset:0,outer:0,output:[2,3,4,6,8,11],outsid:3,over:0,overlap:[0,9],packag:[8,11,14],page:14,paint:0,paolo:14,paper:0,parallel:[0,2,3,8,14],paramet:[0,3,6,7,9,14],parent_group:0,parllel:0,parrinello:[0,14],pars:[0,3],parse_config_toml:[0,8],part:[5,6,12],partial:0,particl:[0,2,5,6,7,9,11,12,13,14],particlemesh:0,particular:11,path:[0,2,11],pcmc09:14,pdf:1,pencil:0,peptid:[0,2,3,5,14],per:[0,2,3,10,11,13],peraro:14,perfect:0,perform:[0,3,10,11,12],periol:14,perman:[10,14],permitt:[0,4],pfft:[0,14],pfft_build_dir:8,phase:[0,10],phase_separ:6,phi:[0,3,6,10,12],phi_0:[6,9,12],phi_:[0,6,9,12],phi_ep:0,phi_eps_fouri:0,phi_eta:0,phi_eta_fouri:0,phi_fouri:0,phi_k:0,phi_l:0,phi_laplacian:0,phi_n:[6,10],phi_pol:0,phi_pol_prev:0,phi_q:0,phi_q_fouri:0,phi_transf:0,phospholipid:6,phy:[0,14],pic_spectr:[0,3,6],pic_spectral_gp:0,piec:6,pip13:14,pip:[8,11,14],pippig:14,place:[0,3],plain:2,plane:[0,6,10],pleas:[8,11],plume:0,plumed_bia:0,plumed_out:0,pme:14,pmesh:[0,14],png:1,point:[0,1,10,13],poisson:0,pol_mix:0,polar:0,polym:[6,14],posit:[0,2,3,5,6,11,12],possibl:[0,3,6,14],potenti:[0,3,4,5,7,10,14],ppft:14,practic:10,pre:[0,6],precis:[1,2],prefer:3,prepar:0,prepare_bond:0,prepare_bonds_old:0,prepare_index_based_bond:0,prepend:[0,11],present:[0,2,3,6],preserv:3,pressur:[0,4],previou:0,previous:6,prior:[0,3],priovid:0,prng:0,prod_:0,profil:2,program:[0,11],project:5,promot:0,prop:0,propag:[0,3],propens:[0,3,5,6],propensity_potential_coeff:0,properti:3,protein:[0,14],provid:[0,2,3,11,13,14],psi:[0,4,5],psi_:5,psi_fouri:0,pull:8,put:6,pytest:11,python3:[6,8,11,14],python:[0,11,14],q_i:[0,5],q_j:0,quadrat:0,quanit:0,quantiti:[0,4],quantum:14,quartet:10,quess:0,r_0:[0,6,10],r_a:10,r_c:10,rad:[3,10],radial:6,radii:6,radiu:6,rainwoodman:[8,14],rais:[6,8],random:[0,2,11],random_chi_squar:0,random_gaussian:0,randomli:[0,3,6],rang:5,rank0:0,rank:[0,2,3,10,11],rank_rang:0,rankself:0,rare:10,read:[0,8,11,14],read_config_toml:[0,8],readout:0,real:13,realfield:0,realist:6,reappli:0,rearrang:0,receiv:[0,3],recent:8,reciproc:[0,7],recognis:11,recognit:14,recommend:8,reconstruct:[0,2,5,6,10,14],record:0,recreat:14,recurs:0,redistribut:0,reduc:[3,12],refer:[3,11],regim:6,regul:[0,3],rel:[0,3,6,10],relax:[0,3],releas:[0,6,8,11,14],remain:[0,6],remov:[0,3],remove_center_of_mass_momentum:0,remove_com_momentum:[0,3],replac:[0,8],repositori:[6,11],repres:[0,3,13],represent:7,repuls:3,requir:[0,3,8,10,11,14],rescal:[0,3,14],research:14,respa:[0,3,6],respa_inn:[0,3,6],respect:[0,1,12],restructur:0,result:[0,3,6,9],revers:[0,3,14],rgen:14,rho0:0,rho:[0,5],rho_0:0,rho_:5,right:[0,5,6,7,9,10,12],rightarrow:10,root:[0,11,13],roughi:6,row:11,rrespa:[0,3,6],ruin:0,run:[0,2,3,6,8,10,14],rundown:11,runtimeerror:8,same:[0,3,6],sampl:[0,3,14],scalar:0,scale:[0,3,6,7,10,11,14],sch:14,scheme:[0,6],sci:14,scienc:14,script:11,sds:6,search:14,second:[0,11],see:[0,2,3,5,6,8,9,10,11,12,14],seed:[2,11],select:[11,14],self:[0,3,8],self_energi:0,seminumer:0,send:[0,3],separ:0,seri:[0,3,6,10],serial:[8,11],serialis:3,set:[0,3,11],setup:[0,6,7,8,13],setup_time_dependent_el:0,setuptool:8,sever:0,shape:[0,6,11,13],sheet:0,shift:0,should:[0,2,10],shown:6,siam:14,siewert:14,sigbj:14,sigma:[0,3,6,7,11,12],sim:0,similar:0,simpl:[0,6,11,12],simplest:6,simpli:[0,8],simul:[0,2,6,8,10,12,13,14],simultan:0,sinc:0,singl:[0,3,6],size:[0,3,6,11,12],slight:0,slow:8,slowli:12,small:[3,11],smear:5,smooth:[0,12],sodium:6,soft:[6,14],solv:0,solvent:6,some:[0,3],sort:0,sort_dielectric_by_type_id:0,sourc:[0,1],space:[0,3,5,7],span:0,spatial:[0,3,11,12],specfi:0,speci:0,special:0,specif:[0,2,3,6,9,10,11,13],specifi:[0,2,3,6,9,10,11,13],spectacularli:0,spectral:6,speed:[0,3],spheric:6,spheroid:6,split:0,spontan:6,spring:[0,10],sqrt:[0,7,12],squar:[0,9],squaredphi:[0,3,9,11],stabil:6,stabl:6,stackoverflow:0,standard:[0,3,12,14],start:[0,3,6,10,13],start_temperatur:[0,3,6],state:0,statu:8,stdout:[0,2],step:[0,3,6,10,11],stiff:3,stochast:0,store:0,store_data:0,store_stat:0,str10:11,str:0,straightforward:[7,9],stream:0,strength:[0,3,6,11],stretch:[0,3,10,14],string:[0,3,8,11,13],structur:[0,2,3,5,6,11,14],style:14,sub:6,subclass:[0,9],subsequ:[0,5,6,10],sudo:8,suitabl:0,sulfat:6,sum:0,sum_:[0,5,9,12],sum_i:0,sum_j:0,sum_k:0,sum_n:[0,6,10],summari:11,superclass:[0,7],support:[0,6,14],swap:10,symbol:[0,4,9],sympi:[0,9],sys:8,system:[0,1,2,3,6,8,9,11,12,14],tag:[0,3,8],take:[0,3,5,9,10,11,12],taken:0,tar:8,target:0,target_pressur:0,target_temperatur:[0,3,6,11],tau:[0,3,6,11],tau_p:0,tbm92:14,temperatur:[0,3,4,6,11],ten:6,term:[0,3,6,9,12],test:[0,1],text:[0,2,3,4,5,6,9,10,12],than:[0,3],theori:[0,14],thermalis:[0,3],thermostat:[2,3,6,11],thermostat_coupling_group:[0,3,6],thermostat_work:0,theta:[6,10],theta_0:[0,6,10],thi:[0,2,3,6,8,9,10,11,12],thorough:11,though:6,thousand:[6,10],three:[0,2,3,6],through:[0,3,6,7,9,10,14],tild:[0,3,4,5,6,9,12],time:[0,3,4,6,10,11,14],time_step:[0,3,6,11],tmp:8,todo:0,togeth:[0,3,6],token:8,toml:[0,2,3,6,10,11],toml_cont:0,tomli:0,too:3,toplog:0,topol:0,topolog:[0,2,3,5,6,11,14],topology_fil:8,torsion:[0,3,10,14],toshihiro:14,total:[0,3,6,11,12],traceback:8,trajectori:[0,2,3,6,11],trans_matric:0,transfer:[0,10],transform:[0,9,12],travers:0,tri:3,truncat:0,tuckerman:[3,14],turn:6,tutori:[6,11,13],two:[0,2,3,6],txt:11,type:[0,2,3,5,6,9,10,11,13],type_arrai:0,type_charg:0,type_to_name_map:0,ubuntu:8,uio:[11,14],unchang:0,under:[6,12,14],union:0,uniqu:0,unique_nam:0,unit:[0,3,10],univers:14,unknown:0,unless:[0,3],unset:0,unstabl:3,until:6,updat:[0,8],update_field:0,update_field_force_q:0,update_field_force_q_gp:0,upgrad:[8,14],usag:[0,2],use:[0,3,5,6,8],used:[0,1,2,3,6,7,9,11,12,13],uses:[0,4,12,14],using:[0,2,3,8,12,14],usr:8,usual:11,v_2:[0,6,10],v_3:[0,6,10],v_4:[0,6,10],v_ext:0,v_ext_fouri:0,vacuum:4,valid:[0,3],validated_config:0,valu:[0,3,4,5,6,10],valueerror:8,vanish:0,varepsilon:0,varepsilon_0:[4,5],vari:12,variabl:0,variant:6,variou:[0,13],vbar_elec:0,vbar_elec_fouri:0,vector:10,vectoris:9,veloc:[0,2,3,4,6,11,13,14],velocity_out:0,velocti:0,verbos:[0,2,11],veri:[6,10],verifi:0,verlet:[0,3,6,11],versa:3,version:[0,6,8,11,12],vert:0,vertex:[0,5],vertic:0,via:[6,8,14],vice:3,vol:0,volum:0,voxel:0,wai:[8,12],warn:0,weakli:3,weight:0,well:6,were:0,weslei:0,wheel:8,when:[0,3,10],where:[0,5,9,10,12],which:[0,2,3,5,6,9,10,11],width:[0,3],window:[0,5,12],without:[0,8,14],work:[0,8],workload:0,would:[0,3],wrap:0,wrapper:0,write:[0,3],written:[0,3],www:0,xavier:14,yield:6,you:[8,10,14],yuan:14,zero:[0,3],zhong:14,zhu:14},titles:["4. API reference","3. Benchmarks","5. Command line arguments","3. Configuration file","6. Constants and Units","3. Electrostatic interactions","1. Examples","2. Filtering","1. Installation","1. Interaction energy functionals","2. Intramolecular bonds","2. Usage overview for HylleraasMD","1. Theory","4. Topology and structure file","HylleraasMD documentation"],titleterms:{"function":9,"import":8,"new":[7,9],"while":8,SDS:6,api:0,argument:2,assembl:6,benchmark:1,bilay:6,bond:[1,3,10],build:8,calcul:12,chain:6,chi:9,code:14,command:2,common:8,configur:3,constant:4,copolym:6,curl:8,dataset:13,depend:8,develop:14,diblock:6,docker:8,document:14,due:8,electrostat:[3,5],energi:9,error:8,exampl:6,extern:12,field:[0,1,3],file:[0,3,13],filter:[7,12],forc:[0,1,8,12],form:[9,12],fortran:8,four:10,gas:6,guid:14,hamiltonian:[0,12],helix:6,hylleraasmd:[11,14],hymd:14,ideal:6,implement:[7,9],incompress:9,indic:14,input:0,instal:[8,14],integr:0,interact:[5,9],interpol:12,intramolecular:10,issu:8,kappa:9,kernel:8,keyword:3,line:2,lipid:6,logger:0,metadata:3,miss:8,numpi:8,onli:9,option:[2,13],output:0,overview:11,parallel:11,parser:0,particl:[1,3,10],peptid:6,pfft:8,phase:6,phi:9,potenti:12,python:8,reciproc:12,refer:[0,14],requir:[2,13],rod:6,run:11,self:6,separ:6,simul:[3,11],sourc:14,space:12,specifi:5,stiff:6,structur:13,tabl:14,test:11,theori:12,thermostat:0,three:10,topolog:13,two:10,unit:4,usag:11,user:14,wget:8}}) \ No newline at end of file diff --git a/v1.0.3/.buildinfo b/v1.0.3/.buildinfo new file mode 100644 index 00000000..73418241 --- /dev/null +++ b/v1.0.3/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 0bf02588e02046ed0cd546df59ba7b9b +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v1.0.3/.doctrees/doc_pages/api.doctree b/v1.0.3/.doctrees/doc_pages/api.doctree new file mode 100644 index 00000000..e1a0caf7 Binary files /dev/null and b/v1.0.3/.doctrees/doc_pages/api.doctree differ diff --git a/v1.0.3/.doctrees/doc_pages/benchmarks.doctree b/v1.0.3/.doctrees/doc_pages/benchmarks.doctree new file mode 100644 index 00000000..bde531f4 Binary files /dev/null and b/v1.0.3/.doctrees/doc_pages/benchmarks.doctree differ diff --git a/v1.0.3/.doctrees/doc_pages/command_line.doctree b/v1.0.3/.doctrees/doc_pages/command_line.doctree new file mode 100644 index 00000000..26647480 Binary files /dev/null and b/v1.0.3/.doctrees/doc_pages/command_line.doctree differ diff --git a/v1.0.3/.doctrees/doc_pages/config_file.doctree b/v1.0.3/.doctrees/doc_pages/config_file.doctree new file mode 100644 index 00000000..f25baa4a Binary files /dev/null and b/v1.0.3/.doctrees/doc_pages/config_file.doctree differ diff --git a/v1.0.3/.doctrees/doc_pages/constants_and_units.doctree b/v1.0.3/.doctrees/doc_pages/constants_and_units.doctree new file mode 100644 index 00000000..4a5c04aa Binary files /dev/null and b/v1.0.3/.doctrees/doc_pages/constants_and_units.doctree differ diff --git a/v1.0.3/.doctrees/doc_pages/electrostatics.doctree b/v1.0.3/.doctrees/doc_pages/electrostatics.doctree new file mode 100644 index 00000000..4e4e3a27 Binary files /dev/null and b/v1.0.3/.doctrees/doc_pages/electrostatics.doctree differ diff --git a/v1.0.3/.doctrees/doc_pages/examples.doctree b/v1.0.3/.doctrees/doc_pages/examples.doctree new file mode 100644 index 00000000..b1580fb1 Binary files /dev/null and b/v1.0.3/.doctrees/doc_pages/examples.doctree differ diff --git a/v1.0.3/.doctrees/doc_pages/filtering.doctree b/v1.0.3/.doctrees/doc_pages/filtering.doctree new file mode 100644 index 00000000..12a7fe5b Binary files /dev/null and b/v1.0.3/.doctrees/doc_pages/filtering.doctree differ diff --git a/v1.0.3/.doctrees/doc_pages/installation.doctree b/v1.0.3/.doctrees/doc_pages/installation.doctree new file mode 100644 index 00000000..7f2d47f3 Binary files /dev/null and b/v1.0.3/.doctrees/doc_pages/installation.doctree differ diff --git a/v1.0.3/.doctrees/doc_pages/interaction_energy_functionals.doctree b/v1.0.3/.doctrees/doc_pages/interaction_energy_functionals.doctree new file mode 100644 index 00000000..8d1630ea Binary files /dev/null and b/v1.0.3/.doctrees/doc_pages/interaction_energy_functionals.doctree differ diff --git a/v1.0.3/.doctrees/doc_pages/intramolecular_bonds.doctree b/v1.0.3/.doctrees/doc_pages/intramolecular_bonds.doctree new file mode 100644 index 00000000..8bade598 Binary files /dev/null and b/v1.0.3/.doctrees/doc_pages/intramolecular_bonds.doctree differ diff --git a/v1.0.3/.doctrees/doc_pages/overview.doctree b/v1.0.3/.doctrees/doc_pages/overview.doctree new file mode 100644 index 00000000..5785895a Binary files /dev/null and b/v1.0.3/.doctrees/doc_pages/overview.doctree differ diff --git a/v1.0.3/.doctrees/doc_pages/theory.doctree b/v1.0.3/.doctrees/doc_pages/theory.doctree new file mode 100644 index 00000000..94288c90 Binary files /dev/null and b/v1.0.3/.doctrees/doc_pages/theory.doctree differ diff --git a/v1.0.3/.doctrees/doc_pages/topology_input.doctree b/v1.0.3/.doctrees/doc_pages/topology_input.doctree new file mode 100644 index 00000000..6d668cf7 Binary files /dev/null and b/v1.0.3/.doctrees/doc_pages/topology_input.doctree differ diff --git a/v1.0.3/.doctrees/environment.pickle b/v1.0.3/.doctrees/environment.pickle new file mode 100644 index 00000000..35504bdf Binary files /dev/null and b/v1.0.3/.doctrees/environment.pickle differ diff --git a/v1.0.3/.doctrees/index.doctree b/v1.0.3/.doctrees/index.doctree new file mode 100644 index 00000000..44a475a9 Binary files /dev/null and b/v1.0.3/.doctrees/index.doctree differ diff --git a/v1.0.3/_downloads/14e724b5b4949c8976ab872f18e7a854/benchmarks-2.py b/v1.0.3/_downloads/14e724b5b4949c8976ab872f18e7a854/benchmarks-2.py new file mode 100644 index 00000000..60b3af65 --- /dev/null +++ b/v1.0.3/_downloads/14e724b5b4949c8976ab872f18e7a854/benchmarks-2.py @@ -0,0 +1,33 @@ +import numpy as np +import matplotlib.pyplot as plt + +mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] +mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + +mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + +mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + +mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] +mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + +mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + +mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + +plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048²") +plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024²") +plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512²") +plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256²") +plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128²") +plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64²") +plt.xlabel("CPUs", fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.ylabel("Time per step, s", fontsize=15) +plt.legend(loc="upper left", fontsize=15) +plt.show() \ No newline at end of file diff --git a/v1.0.3/_downloads/8a5fe1e89db556909ae8bf2455081dbd/benchmarks-1.hires.png b/v1.0.3/_downloads/8a5fe1e89db556909ae8bf2455081dbd/benchmarks-1.hires.png new file mode 100644 index 00000000..173b39f3 Binary files /dev/null and b/v1.0.3/_downloads/8a5fe1e89db556909ae8bf2455081dbd/benchmarks-1.hires.png differ diff --git a/v1.0.3/_downloads/a0bd1a2d53352bff776289412ecd1582/benchmarks-2.pdf b/v1.0.3/_downloads/a0bd1a2d53352bff776289412ecd1582/benchmarks-2.pdf new file mode 100644 index 00000000..a197e76c Binary files /dev/null and b/v1.0.3/_downloads/a0bd1a2d53352bff776289412ecd1582/benchmarks-2.pdf differ diff --git a/v1.0.3/_downloads/a1a9c29887ecdeb0e5785fdc55f952b2/benchmarks-2.png b/v1.0.3/_downloads/a1a9c29887ecdeb0e5785fdc55f952b2/benchmarks-2.png new file mode 100644 index 00000000..d3c84f99 Binary files /dev/null and b/v1.0.3/_downloads/a1a9c29887ecdeb0e5785fdc55f952b2/benchmarks-2.png differ diff --git a/v1.0.3/_downloads/a9aaeb9c37c00e725f84ef61676c374b/benchmarks-1.png b/v1.0.3/_downloads/a9aaeb9c37c00e725f84ef61676c374b/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.3/_downloads/a9aaeb9c37c00e725f84ef61676c374b/benchmarks-1.png differ diff --git a/v1.0.3/_downloads/d162ac04c9b2eef82b2fd822c0cce6e5/benchmarks-2.hires.png b/v1.0.3/_downloads/d162ac04c9b2eef82b2fd822c0cce6e5/benchmarks-2.hires.png new file mode 100644 index 00000000..d8487c6d Binary files /dev/null and b/v1.0.3/_downloads/d162ac04c9b2eef82b2fd822c0cce6e5/benchmarks-2.hires.png differ diff --git a/v1.0.3/_downloads/e48972d74a896da20f676d5f8a1fd7ab/benchmarks-1.py b/v1.0.3/_downloads/e48972d74a896da20f676d5f8a1fd7ab/benchmarks-1.py new file mode 100644 index 00000000..deb4348f --- /dev/null +++ b/v1.0.3/_downloads/e48972d74a896da20f676d5f8a1fd7ab/benchmarks-1.py @@ -0,0 +1,38 @@ +import numpy as np +import matplotlib.pyplot as plt +nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) +time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 +], dtype=np.float64) +nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 +], dtype=np.float64,) +time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, +], dtype=np.float64) +nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 +], dtype=np.float64) +time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, +], dtype=np.float64) +plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" +) +plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" +) +plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" +) +plt.xlabel("CPUs", fontsize=15) +plt.ylabel("Time per step, us", fontsize=15) +plt.legend(fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.show() \ No newline at end of file diff --git a/v1.0.3/_downloads/f8776b96f427fe918bc2b7e0a68379c4/benchmarks-1.pdf b/v1.0.3/_downloads/f8776b96f427fe918bc2b7e0a68379c4/benchmarks-1.pdf new file mode 100644 index 00000000..538cf2d3 Binary files /dev/null and b/v1.0.3/_downloads/f8776b96f427fe918bc2b7e0a68379c4/benchmarks-1.pdf differ diff --git a/v1.0.3/_images/benchmarks-1.png b/v1.0.3/_images/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.3/_images/benchmarks-1.png differ diff --git a/v1.0.3/_images/benchmarks-2.png b/v1.0.3/_images/benchmarks-2.png new file mode 100644 index 00000000..d3c84f99 Binary files /dev/null and b/v1.0.3/_images/benchmarks-2.png differ diff --git a/v1.0.3/_images/hylleraas_centre_logo_black.png b/v1.0.3/_images/hylleraas_centre_logo_black.png new file mode 100644 index 00000000..40826396 Binary files /dev/null and b/v1.0.3/_images/hylleraas_centre_logo_black.png differ diff --git a/v1.0.3/_images/uio_full_logo_eng_pos.png b/v1.0.3/_images/uio_full_logo_eng_pos.png new file mode 100644 index 00000000..6c603139 Binary files /dev/null and b/v1.0.3/_images/uio_full_logo_eng_pos.png differ diff --git a/v1.0.3/_modules/hymd/field.html b/v1.0.3/_modules/hymd/field.html new file mode 100644 index 00000000..89335c8f --- /dev/null +++ b/v1.0.3/_modules/hymd/field.html @@ -0,0 +1,1451 @@ + + + + + + hymd.field — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.field

+"""Forces and energies from the discretized particle-field grid interactions
+"""
+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import warnings
+
+
+
[docs]def initialize_pm(pmesh, config, comm=MPI.COMM_WORLD): + """ + Creates the necessary pmesh objects for pfft operations. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + config : Config + Configuration dataclass containing simulation metadata and parameters. + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm : object 'pmesh.pm.ParticleMesh' + field_list : list[pmesh.pm.RealField], (multiple) + Essential list of pmesh objects required for MD + list_coulomb : list[pmesh.pm.RealField], (multiple) + Additional list of pmesh objects required for electrostatics. + """ + + if config.dtype == np.float64: + pmeshtype = "f8" + else: + pmeshtype = "f4" + # Ignore numpy numpy.VisibleDeprecationWarning: Creating an ndarray from + # ragged nested sequences until it is fixed in pmesh + with warnings.catch_warnings(): + warnings.filterwarnings( + action="ignore", + category=np.VisibleDeprecationWarning, + message=r"Creating an ndarray from ragged nested sequences", + ) + # The first argument of ParticleMesh has to be a tuple + pm = pmesh.ParticleMesh( + config.mesh_size, BoxSize=config.box_size, dtype=pmeshtype, comm=comm + ) + phi = [pm.create("real", value=0.0) for _ in range(config.n_types)] + phi_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] # noqa: E501 + force_on_grid = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + v_ext_fourier = [pm.create("complex", value=0.0) for _ in range(4)] + v_ext = [pm.create("real", value=0.0) for _ in range(config.n_types)] + + phi_transfer = [pm.create("complex", value=0.0) for _ in range(3)] + + phi_laplacian = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + + # Initialize charge density fields + coulomb_list = [] + elec_common_list = [None, None, None, None] + _SPACE_DIM = config.box_size.size + + if config.coulombtype == "PIC_Spectral_GPE" or config.coulombtype == "PIC_Spectral": + phi_q = pm.create("real", value=0.0) + phi_q_fourier = pm.create("complex", value=0.0) + psi = pm.create("real", value=0.0) + elec_field = [pm.create("real", value=0.0) for _ in range(_SPACE_DIM)] + + elec_common_list = [phi_q, phi_q_fourier, psi, elec_field] + + if config.coulombtype == "PIC_Spectral": + elec_field_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] # for force calculation + psi_fourier = pm.create("complex", value=0.0) + + coulomb_list = [ + elec_field_fourier, + psi_fourier, + ] + + if ( + config.coulombtype == "PIC_Spectral_GPE" + ): ## initializing the density mesh #dielectric_flag + phi_eps = pm.create( + "real", value=0.0 + ) ## real contrib of the epsilon dielectric painted to grid + phi_eps_fourier = pm.create("complex", value=0.0) # complex contrib of phi eps + phi_eta = [ + pm.create("real", value=0.0) for _ in range(_SPACE_DIM) + ] ## real contrib of factor in polarization charge density + phi_eta_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] ## fourier of factor in polarization charge density + phi_pol = pm.create( + "real", value=0.0 + ) ## real contrib of the polarization charge + phi_pol_prev = pm.create("real", value=0.0) + elec_dot = pm.create("real", value=0.0) + elec_field_contrib = pm.create( + "real", value=0.0 + ) # needed for pol energies later + + # External potential and force meshes + Vbar_elec = [pm.create("real", value=0.0) for _ in range(config.n_types)] + Vbar_elec_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] + force_mesh_elec = [ + [pm.create("real", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + force_mesh_elec_fourier = [ + [pm.create("complex", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + + coulomb_list = [ + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol, + phi_pol_prev, + elec_dot, + elec_field_contrib, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + ] + + field_list = [ + phi, + phi_fourier, + force_on_grid, + v_ext_fourier, + v_ext, + phi_transfer, + phi_laplacian, + ] + + return (pm, field_list, elec_common_list, coulomb_list)
+ + +
[docs]def compute_field_force(layouts, r, force_mesh, force, types, n_types): + """Interpolate particle-field forces from the grid onto particle positions + + Backmaps the forces calculated on the grid to particle positions using the + window function :math:`P` (by default cloud-in-cell [CIC]). In the + following, let :math:`\\mathbf{F}_j` denote the force acting on the + particle with index :math:`j` and position :math:`\\mathbf{r}_j`. The + interpolated force is + + .. math:: + + \\mathbf{F}_j = -\\sum_k\\nabla V_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`V_{j_k}` is the discretized external potential at grid vertex + :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid vertex + with index :math:`j_k`, and :math:`h^3` is the volume of each grid voxel. + The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + r : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + force : (N,D) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. Local + for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + n_types : int + Number of different unique types present in the simulation system. + :code:`n_types` is global, i.e. the same for all MPI ranks even if some + ranks contain zero particles of certain types. + """ + for t in range(n_types): + ind = types == t + for d in range(3): + force[ind, d] = force_mesh[t][d].readout(r[ind], layout=layouts[t])
+ + +
[docs]def compute_self_energy_q(config, charges, comm=MPI.COMM_WORLD): + """Compute the self energy for the interaction due to the Ewald scheme + used to compute the electrostatics. The energy is stored in :code:`config`. + + The self interaction energy is given by: + + .. math:: + + U_{self} = \\sqrt{\\frac{1}{2\\pi\\sigma^2}} \\sum_{i=1}^{N} q_i^2 + + where :math:`q_i` are the charges and :math:`\\sigma` is the half-width + of the Gaussian filter. + + Parameters + ---------- + config : Config + Configuration object. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + comm : mpi4py.Comm + MPI communicator to use for rank communication. + + Returns + ------- + field_q_self_energy : float + Electrostatic self energy. + """ + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + prefac = elec_conversion_factor * np.sqrt( + 1.0 / (2.0 * np.pi * config.sigma * config.sigma) + ) + _squared_charges = charges * charges + squared_charges_sum = comm.allreduce(np.sum(_squared_charges)) + return prefac * squared_charges_sum
+ + +
[docs]def update_field_force_q( + charges, + phi_q, + phi_q_fourier, + psi, + psi_fourier, + elec_field_fourier, + elec_field, + elec_forces, + layout_q, + hamiltonian, + pm, + positions, + config, +): + """Calculate the electrostatic particle-field forces on the grid + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential is computed in reciprocal space as + + .. math:: + + \\Phi = \\mathrm{FFT}^{-1}\\left[ + \\frac{4\\pi k_e}{\\varepsilon \\vert\\mathbf{k}\\vert^2} + \\mathrm{FFT}(\\rho)\\mathrm{FFT}(H) + \\right], + + with the electric field + + .. math:: + + \\mathbf{E} = \\mathrm{FFT}^{-1}\\left[ + -i\\mathbf{k}\\,\\mathrm{FFT}(\\Psi) + \\right]. + + In the following, let :math:`\\mathbf{F}_j` denote the electrostatic force + acting on the particle with index :math:`j` and position + :math:`\\mathbf{r}_j`. The interpolated electrostatic force is + + .. math:: + + \\mathbf{F}_j = \\sum_k q_j\\mathbf{E}_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`\\mathbf{E}_{j_k}` is the discretized electric field at grid + vertex :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid + vertex with index :math:`j_k`, and :math:`h^3` is the volume of each grid + voxel. The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty; any values in this field + are discarded. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + elec_field_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + electric field values in reciprocal space on the computational grid. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + n_dimensions = config.box_size.size + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + # charges to grid + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) + phi_q /= volume_per_cell + # print("phi_q", np.sum(phi_q)) + phi_q.r2c(out=phi_q_fourier) + + # smear charges with filter + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + + # solve Poisson equation in Fourier space to get electrostatic potential + def poisson_transfer_function(k, v): + return 4.0 * np.pi * elec_conversion_factor * v / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(poisson_transfer_function, out=psi_fourier) + # print("psi_fourier", np.sum(psi_fourier)) + psi_fourier.c2r(out=psi) + # print("phi_q * psi update_field", np.sum(phi_q * psi)) + + # exit() + + # compute electric field directly from smeared charged densities in Fourier + for _d in np.arange(n_dimensions): + + def poisson_transfer_function(k, v, d=_d): + return ( + -1j + * k[d] + * 4.0 + * np.pi + * elec_conversion_factor + * v + / k.normp(p=2, zeromode=1) + ) + + phi_q_fourier.apply(poisson_transfer_function, out=elec_field_fourier[_d]) + elec_field_fourier[_d].c2r(out=elec_field[_d]) + + # get electrostatic force from electric field + for _d in np.arange(n_dimensions): + elec_forces[:, _d] = charges * ( + elec_field[_d].readout(positions, layout=layout_q) + )
+ + +def comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, +): + for t in range(config.n_types): + np.copyto(phi_transfer[0].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[1].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[2].value, phi_fourier[t].value, casting="no", where=True) + + # Evaluate laplacian of phi in fourier space + for d in range(3): + + def laplacian_transfer(k, v, d=d): + return -k[d] ** 2 * v + + phi_transfer[d].apply(laplacian_transfer, out=Ellipsis) + phi_transfer[d].c2r(out=phi_laplacian[t][d]) + + +
[docs]def update_field( + phi, + phi_laplacian, + phi_transfer, + layouts, + force_mesh, + hamiltonian, + pm, + positions, + types, + config, + v_ext, + phi_fourier, + v_ext_fourier, + m, + compute_potential=False, +): + """Calculate the particle-field potential and force density + + If :code:`compute_potential` is :code:`True`, the energy may subsequently + be computed by calling :code:`compute_field_and_kinetic_energy`. + + Computes the particle-field external potential :math:`V_\\text{ext}` from + particle number densities through the smoothed density field, + :math:`\\phi(\\mathbf{r})`. With :math:`P` being the cloud-in-cell (CIC) + window function, the density and filtered densities are computed as + + .. math:: + + \\phi(\\mathbf{r}) = \\sum_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\phi(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\phi(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + external potential is computed in reciprocal space as + + .. math:: + + V_\\text{ext} = \\mathrm{FFT}^{-1}\\left[ + \\mathrm{FFT} + \\left( + \\frac{\\partial w}{\\partial \\tilde\\phi} + \\right) + \\mathrm{FFT}(H) + \\right], + + where :math:`w` is the interaction energy functional. Differentiating + :math:`V_\\text{ext}` is done by simply applying :math:`i\\mathbf{k}` in + Fourier space, and the resulting forces are back-transformed to direct + space and interpolated to particle positions by + + .. math:: + + \\mathbf{F}_j = -\\sum_{j_k} \\nabla V_{j_k} + P(\\mathbf{r}_{j_k} - \\mathbf{r}_j)h^3, + + where :math:`j_k` are the neighbouring vertices of particle :math:`j` at + position :math:`\\mathbf{r}_j`, and :math:`h^3` is the volume of each grid + voxel. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Pre-allocated, but empty; any values + in this field are discarded. Changed in-place. Local for each MPI + rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + config : Config + Configuration object. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Pre-allocated, but empty; any values in this field are + discarded Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + phi_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computational grid is represented by the collective fields of all + MPI ranks. + v_ext_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplesField` objects containing discretized + particle-field external potential values in reciprocal space on the + computational grid; :code:`D+1` fields in D dimensions for each + particle type. :code:`D` copies are made after calculation for later + use in force calculation, because the `force transfer function` + application differentiates the field in-place, ruining the contents + for differentiation in the remaining :code:`D-1` spatial directions. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + m: list[float], (M,) + pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. + Defaults to 1.0 for all particle types. + compute_potential : bool, optional + If :code:`True`, a :code:`D+1`-th copy of the Fourier transformed + external potential field is made to be used later in particle-field + energy calculation. If :code:`False`, only :code:`D` copies are made. + + See also + -------- + compute_field_and_kinetic_energy : + Compute the particle-field energy after the external potential is + calculated. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + for t in range(config.n_types): + pm.paint(positions[types == t], mass=m[t], layout=layouts[t], out=phi[t]) + phi[t] /= volume_per_cell + phi[t].r2c(out=phi_fourier[t]) + phi_fourier[t].apply(hamiltonian.H, out=Ellipsis) + phi_fourier[t].c2r(out=phi[t]) + + # External potential + for t in range(config.n_types): + v = hamiltonian.v_ext[t](phi) + + v.r2c(out=v_ext_fourier[0]) + v_ext_fourier[0].apply(hamiltonian.H, out=Ellipsis) + np.copyto( + v_ext_fourier[1].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + np.copyto( + v_ext_fourier[2].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + if compute_potential: + np.copyto( + v_ext_fourier[3].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + + # Differentiate the external potential in fourier space + for d in range(3): + + def force_transfer_function(k, v, d=d): + return -k[d] * 1j * v + + v_ext_fourier[d].apply(force_transfer_function, out=Ellipsis) + v_ext_fourier[d].c2r(out=force_mesh[t][d]) + + if compute_potential: + v_ext_fourier[3].c2r(out=v_ext[t])
+ + +
[docs]def compute_field_and_kinetic_energy( + phi, + phi_q, + psi, + velocity, + hamiltonian, + positions, + types, + v_ext, + config, + layouts, + comm=MPI.COMM_WORLD, +): + """Compute the particle-field and kinetic energy contributions + + Calculates the kinetic energy through + + .. math:: + + E_k = \\sum_j \\frac{1}{2}m_j\\mathbf{v}_j\\cdot\\mathbf{v}_j, + + and the particle-field energy by + + .. math:: + + E_\\text{field} = \\int\\mathrm{d}\\mathbf{r}\\, + w[\\tilde\\phi], + + where :math:`w` is the interaction energy functional `density`. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + velocity : (N,D) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Local for each MPI rank--the full computational grid is + represented by the collective fields of all MPI ranks. + config : Config + Configuration object. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field : + Computes the up-to-date external potential for use in calculating the + particle-field energy. + """ + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + field_energy = w_0.csum() # w to W + + kinetic_energy = comm.allreduce(0.5 * config.mass * np.sum(velocity**2)) + + if config.coulombtype == "PIC_Spectral": + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + field_q_energy = w_elec.csum() + else: + field_q_energy = 0.0 + + return field_energy, kinetic_energy, field_q_energy
+ + +
[docs]def compute_field_energy_q_GPE( + config, + phi_eps, + field_q_energy, + dot_elec, + comm=MPI.COMM_WORLD, +): + """ + Compute the electrostatic energy after electrosatic forces is + calculated. + + From the definition of the elecrostatic potential :math:`\\Psi`, the energy + is + + W = \\frac{1}{2}\\int\\mathrm{d}\\mathbf{r}\\, + \\epsilon(\\mathbf{r})} \\left(\\mathbf{E}\\cdot \\mathbf{E}\\right), + + where :math:`\\epsilon(\\mathbf{r})}` is the anisotropic, spatially dependent, + relative dielectric of the simulation medium. + + Parameters + ---------- + config : hymd.input_parser.Config + Configuration object. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + field_q_energy : float + Total elecrostatic energy. + dot_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing :math:`|\\mathbf{E(r)}|^{2}` + on the computational grid. Local for each MPI rank -- the full computational + grid is represented by the collective fields of all MPI ranks. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field_force_q_GPE: + Compute the electrosatic force from an anisotropic dielectric general + Poisson equation. + """ + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + # ^ due to integration on local cell before allreduce + + eps_0 = 1.0 / (config.coulomb_constant * 4 * np.pi) + field_q_energy = ( + volume_per_cell * (0.5 * eps_0) * comm.allreduce(np.sum(phi_eps * dot_elec)) + ) + + return field_q_energy
+ + +
[docs]def update_field_force_q_GPE( + conv_fun, + phi, + types, + charges, + phi_q, + phi_q_fourier, + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol_prev, + phi_pol, + elec_field, + elec_forces, + elec_field_contrib, + psi, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + hamiltonian, + layout_q, + layouts, + pm, + positions, + config, + comm=MPI.COMM_WORLD, +): + """ + Calculate the electrostatic particle-field forces on the grid, arising from + a general Poisson equation, i.e. anisotropic permittivity/dielectric. + The function is called when tomli input config.coulombtype = "PIC_Spectral_GPE." + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential for a variable dielectric does not have an + analytical expression, and is computed in reciprocal through an iterative + method. + + The GPE states that + + .. math:: + + \\nabla \\cdot \\left(\\epsilon(\\mathbf{r}) + \\nabla{\\mathbf{\\psi(r)}}\\right) = -\\rho({\\mathbf{r}}). + + where :math:`\\epsilon(\\mathbf{r})` is the relative dielectric function. + + Parameters + ---------- + conv_fun : Convergence function. + Returns a scalar. Depends on MPI allreduce for similar convergence + across MPI ranks. + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_eta : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + gradients of the relative dielectric values on the computational grid. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank--the + full computational grid is represented by the collective fields of all MPI ranks. + phi_eta_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated discretized + Fourier transformed gradient relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol_prev : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charge values on the computational grid. Parameter in + the iterative method.Pre-allocated,but empty. Changedin-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charges on the computational grid. Parameter in the iterative + method, updating the next quess in solving for the electrostatic potential. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all + MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + elec_field_contrib : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing + :math:`|\\mathbf{E(r)}|^2/\\phi_{0}` on the computational grid. + Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + psi : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic potential + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + Vbar_elec : mesh.pm.RealField + Pmesh :code:`RealField` object for storing functional derivatives of + :math:`\\|w(\\{ \\phi \\})_{elec}`on the computational grid. + Pre-allocated, but empty. Changed in-place. Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + Vbar_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated functional + derivatives of :math:`\\|w(\\{ \\phi \\})_{elec}` in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + force_mesh_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic force values + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + force_mesh_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated electrostatic + force values in reciprocal space on the computational grid. Local for + each MPI rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + layouts: list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + comm: mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + compute_field_energy_q_GPE: + Compute the electrostatic energy after electrosatic force is + calculated for a variable (anisotropic) dielectric general Poisson equation. + """ + + ## basic setup + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + ## old protocol in gen_qe_hpf_use_self + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) ## + ## scale and fft + ## old protocol in gen_qe_hpf_use_self + phi_q /= volume_per_cell + phi_q.r2c(out=phi_q_fourier) + + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + ## ^------ use the same gaussian as the \kai interaciton + phi_q_fourier.c2r(out=phi_q) ## this phi_q is after applying the smearing function + + denom_phi_tot = pm.create("real", value=0.0) + num_types = pm.create("real", value=0.0) + ### ^ ----- Calculate the relative dielectric (permittivity) to field + ### ------- from a mean contribution of particle number densities + + for t_ in range(config.n_types): + num_types = num_types + (config.dielectric_type[t_]) * phi[t_] + denom_phi_tot = denom_phi_tot + phi[t_] + + np.divide(num_types, denom_phi_tot, where=np.abs(denom_phi_tot > 1e-6), out=phi_eps) + + phi_eps.r2c(out=phi_eps_fourier) # FFT dielectric + + # phi_q_eps = (phi_q/phi_eps) + np.divide(phi_q, phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_q) + + _SPACE_DIM = 3 + ##^--------- constants needed throughout the calculations + + ### method for finding the gradient (fourier space), using the spatial dimension of k + for _d in np.arange(_SPACE_DIM): + + def gradient_transfer_function(k, x, d=_d): + return 1j * k[d] * x + + phi_eps_fourier.apply(gradient_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=phi_eta[_d]) + np.divide(phi_eta[_d], phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_eta[_d]) + + ### iterative GPE solver ### + ### ---------------------------------------------- + max_iter = 100 + i = 0 + delta = 1.0 + # phi_pol_prev = pm.create("real", value = 0.0) + ### ^------ set to zero before each iterative procedure or soft start + conv_criteria = config.conv_crit # conv. criteria (default 1e-6) + w = config.pol_mixing # polarization mixing param (default 0.6) + while i < max_iter and delta > conv_criteria: + (phi_q + phi_pol_prev).r2c(out=phi_q_fourier) + for _d in np.arange(_SPACE_DIM): + + def iterate_apply_k_vec(k, additive_terms, d=_d): + return additive_terms * (-1j * k[d]) / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(iterate_apply_k_vec, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + + phi_pol = -( + phi_eta[0] * elec_field[0] + + phi_eta[1] * elec_field[1] + + phi_eta[2] * elec_field[2] + ) + ### ^-- Following a negative sign convention (-ik) of the FT, a neg sign is + ### --- mathematically correct by the definition of the GPE (double - -> +) + phi_pol = w * phi_pol + (1.0 - w) * phi_pol_prev + diff = np.abs(phi_pol - phi_pol_prev) + delta = conv_fun(comm, diff) # decided from toml input + phi_pol_prev = phi_pol.copy() + i = i + 1 + # print("Stopping after iteration {:d} with stop crit {:.2e}, delta {:.2e}".format(i,conv_criteria,delta)) + + # compute_potential = True + def k_norm_divide(k, potential): + return potential / k.normp(p=2, zeromode=1) + + ## > Electrostatic potential + eps0_inv = config.coulomb_constant * 4 * np.pi + ## ^ the 1/(4pi eps0)*4*pi = 1/eps0 + ((eps0_inv) * (phi_q + phi_pol)).r2c(out=phi_q_fourier) + phi_q_fourier.apply(k_norm_divide, out=phi_q_fourier) + phi_q_fourier.c2r(out=psi) + ### ^ electrostatic potential for the GPE + + for _d in np.arange(_SPACE_DIM): + + def field_transfer_function(k, x, d=_d): + return ( + -1j * k[d] * x + ) ## negative sign relation, due to E = - nabla psi relation + + phi_q_fourier.apply(field_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + ## ^-------- Method: Obtaining the electric field from electrostatic potential + ## Assuming the electric field is conserved. + ## Assumption holds if no magnetic flux (magnetic induced fields) + + ############## Obtain forces ############## + elec_dot = ( + elec_field[0] * elec_field[0] + + elec_field[1] * elec_field[1] + + elec_field[2] * elec_field[2] + ) + # needed for energy calculations + + np.divide( + elec_dot, + denom_phi_tot, + where=np.abs(denom_phi_tot > 1e-6), + out=elec_field_contrib, + ) + + eps0_inv = config.coulomb_constant * 4 * np.pi + + for t_ in range(config.n_types): + Vbar_elec[t_] = ( + config.type_charges[t_] * psi + - (0.5 / eps0_inv) + * (config.dielectric_type[t_] - phi_eps) + * elec_field_contrib + ) + + # Obtain Vext,k + for t_ in range(config.n_types): + Vbar_elec[t_].r2c(out=Vbar_elec_fourier[t_]) + Vbar_elec_fourier[t_].apply(hamiltonian.H, out=Vbar_elec_fourier[t_]) + + # force terms + # F = - grad Vext + for t_ in range(config.n_types): + for _d in np.arange(_SPACE_DIM): + + def force_transfer_function(k, x, d=_d): + return -1j * k[_d] * x ## negative gradient + + Vbar_elec_fourier[t_].apply( + force_transfer_function, out=force_mesh_elec_fourier[t_][_d] + ) + force_mesh_elec_fourier[t_][_d].c2r(out=force_mesh_elec[t_][_d]) + elec_forces[types == t_, _d] = force_mesh_elec[t_][_d].readout( + positions[types == t_], layout=layouts[t_] + ) + + return Vbar_elec, phi_eps, elec_dot
+ + +
[docs]def domain_decomposition( + positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=MPI.COMM_WORLD +): + """Performs domain decomposition + + Rearranges the MPI rank memory layout into one that better mimics the PFFT + pencil grid 2D decomposition. As molecules are always required to be fully + contained on a single MPI rank, a perfect decomposition is not always + possible. The best decomposition which leaves the center of mass of all + molecules in their respective correct domains is used, with possible + overlap into neighbouring domains if the spatial extent of any molecule + crosses domain boundaries. + + Parameters + ---------- + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + *args + Variable length argument list containing arrays to include in the + domain decomposition. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + bonds : (N,M) numpy.ndarray, optional + Array of :code:`M` bonds originating from each of :code:`N` particles. + verbose : int, optional + Specify the logging event verbosity of this function. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + Domain decomposed :code:`positions` and any array specified in + :code:`*args`, in addition to :code:`bonds` and :code:`molecules` if these + arrays were provided as input. + """ + if molecules is not None: + if not topol: + assert bonds is not None, "bonds must be provided with molecules" + unique_molecules = np.sort(np.unique(molecules)) + molecules_com = np.empty_like(positions) + for m in unique_molecules: + ind = molecules == m + r = positions[ind, :][0, :] + molecules_com[ind, :] = r + layout = pm.decompose(molecules_com, smoothing=0) + if not topol: + args = (*args, bonds, molecules) + else: + args = (*args, molecules) + else: + layout = pm.decompose(positions, smoothing=0) + if verbose > 1: + Logger.rank0.log( + logging.INFO, + "DOMAIN_DECOMP: Total number of particles to be exchanged = %d", + np.sum(layout.get_exchange_cost()), + ) + return layout.exchange(positions, *args)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/_modules/hymd/file_io.html b/v1.0.3/_modules/hymd/file_io.html new file mode 100644 index 00000000..8b318347 --- /dev/null +++ b/v1.0.3/_modules/hymd/file_io.html @@ -0,0 +1,1147 @@ + + + + + + hymd.file_io — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.file_io

+"""Handle file input/output in parllel HDF5 fashion
+"""
+import numpy as np
+import h5py
+import os
+import logging
+import getpass
+from mpi4py import MPI
+from .logger import Logger, get_version
+
+
+
[docs]class OutDataset: + """HDF5 dataset handler for file output""" + + def __init__( + self, + dest_directory, + config, + double_out=False, + disable_mpio=False, + comm=MPI.COMM_WORLD, + ): + """Constructor + + Parameters + ---------- + dest_directory : str + Ouput directory for saving data. + config : Config + Configuration object. + double_out : bool, optional + If :code:`True`, the output HDF5 objects are written in eight byte + floating point representation. Otherwise, four byte single + precision is used. + disable_mpio : bool, optional + If :code:`True`, disables parallel MPI-enabled HDF5 file output. + This is a compatibility option used if HDF5 is not compiled with + MPI support. This makes everything much harder by splitting all + output in one file per MPI rank, and having an MPI-enabled HDF5 + library is **highly recommended**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + """ + self.disable_mpio = disable_mpio + self.config = config + if double_out: + self.float_dtype = "float64" + else: + self.float_dtype = "float32" + + if disable_mpio: + self.file = h5py.File( + os.path.join( + dest_directory, f"sim.hdf5-{comm.rank:6d}-of-{comm.size:6d}" + ), + "w", + ) + else: + self.file = h5py.File( + os.path.join(dest_directory, "sim.H5"), "w", driver="mpio", comm=comm + ) + +
[docs] def is_open(self, comm=MPI.COMM_WORLD): + """Check if HDF5 output file is open + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + return self.file.__bool__()
+ +
[docs] def close_file(self, comm=MPI.COMM_WORLD): + """Closes the HDF5 output file + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + self.file.close()
+ +
[docs] def flush(self): + """Flushes output buffers, forcing file writes""" + self.file.flush()
+ + +
[docs]def setup_time_dependent_element( + name, parent_group, n_frames, shape, dtype, units=None +): + """Helper function for setting up time-dependent HDF5 group datasets + + All output groups must adhere to the H5MD standard, meaning a structure of + + + | ┗━ **group** particle group (e.g. :code:`all`) or :code:`observables` group + | ┗━ **group** time-dependent data + | ┣━ **dataset** :code:`step` :code:`shape=(n_frames,)` + | ┣━ **dataset** :code:`time` :code:`shape=(n_frames,)` + | ┗━ **dataset** :code:`value` :code:`shape=(n_frames, *)` + + is necessary. + + References + ---------- + H5MD specification : + https://www.nongnu.org/h5md/h5md.html + """ # noqa: E501 + group = parent_group.create_group(name) + step = group.create_dataset("step", (n_frames,), "int32") + time = group.create_dataset("time", (n_frames,), "float32") + value = group.create_dataset("value", (n_frames, *shape), dtype) + + if units is not None: + value.attrs["unit"] = units + time.attrs["unit"] = "ps" + return group, step, time, value
+ + +
[docs]def store_static( + h5md, + rank_range, + names, + types, + indices, + config, + bonds_2_atom1, + bonds_2_atom2, + molecules=None, + velocity_out=False, + force_out=False, + charges=False, + dielectrics=False, + plumed_out=False, + comm=MPI.COMM_WORLD, +): + """Outputs all static time-independent quantities to the HDF5 output file + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + rank_range : list[int] + Start and end indices for global arrays for each MPI rank. + names : (N,) numpy.ndarray + Array of names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of type indices for :code:`N` particles. + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + config : Config + Configuration object. + bonds_2_atom1 : (B,) numpy.ndarray + Array of indices of the first particle for :code:`B` total + two-particle bonds. + bonds_2_atom2 : (B,) numpy.ndarray + Array of indices of the second particle for :code:`B` total + two-particle bonds. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. + dielectrics : (N,) numpy.ndarray + Array of particle relative dielectric values for :code:`N` particles. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to output HDF5 file. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + prepare_bonds : + Constructs two-, three-, and four-particle bonds from toplogy input + file and bond configuration information. + distribute_input : + Distributes input arrays onto MPI ranks, attempting load balancing. + """ + dtype = h5md.float_dtype + + h5md_group = h5md.file.create_group("/h5md") + h5md.h5md_group = h5md_group + h5md.observables = h5md.file.create_group("/observables") + h5md.connectivity = h5md.file.create_group("/connectivity") + h5md.parameters = h5md.file.create_group("/parameters") + + h5md_group.attrs["version"] = np.array([1, 1], dtype=int) + author_group = h5md_group.create_group("author") + author_group.attrs["name"] = np.string_(getpass.getuser()) + creator_group = h5md_group.create_group("creator") + creator_group.attrs["name"] = np.string_("Hylleraas MD") + + # Get HyMD version + creator_group.attrs["version"] = np.string_(get_version()) + + h5md.particles_group = h5md.file.create_group("/particles") + h5md.all_particles = h5md.particles_group.create_group("all") + mass = h5md.all_particles.create_dataset("mass", (config.n_particles,), dtype) + mass[...] = config.mass + + if charges is not False: + charge = h5md.all_particles.create_dataset( + "charge", (config.n_particles,), dtype="float32" + ) + charge[indices] = charges + if dielectrics is not False: + dielectric = h5md.all_particles.create_dataset( + "dielectric", (config.n_particles,), dtype="float32" + ) + dielectric[indices] = dielectrics + + box = h5md.all_particles.create_group("box") + box.attrs["dimension"] = 3 + box.attrs["boundary"] = np.array( + [np.string_(s) for s in 3 * ["periodic"]], dtype="S8" + ) + + n_frames = config.n_steps // config.n_print + if np.mod(config.n_steps - 1, config.n_print) != 0: + n_frames += 1 + if np.mod(config.n_steps, config.n_print) == 1: + n_frames += 1 + if n_frames == config.n_steps: + n_frames += 1 + + species = h5md.all_particles.create_dataset( + "species", + (config.n_particles,), + dtype="i", + ) + + ( + _, + h5md.positions_step, + h5md.positions_time, + h5md.positions, + ) = setup_time_dependent_element( + "position", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm", + ) + if velocity_out: + ( + _, + h5md.velocities_step, + h5md.velocities_time, + h5md.velocities, + ) = setup_time_dependent_element( + "velocity", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm ps-1", + ) + if force_out: + ( + _, + h5md.forces_step, + h5md.forces_time, + h5md.forces, + ) = setup_time_dependent_element( + "force", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="kJ mol-1 nm-1", + ) + ( + _, + h5md.total_energy_step, + h5md.total_energy_time, + h5md.total_energy, + ) = setup_time_dependent_element( + "total_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.kinetc_energy_step, + h5md.kinetc_energy_time, + h5md.kinetc_energy, + ) = setup_time_dependent_element( + "kinetic_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.potential_energy_step, + h5md.potential_energy_time, + h5md.potential_energy, + ) = setup_time_dependent_element( + "potential_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.bond_energy_step, + h5md.bond_energy_time, + h5md.bond_energy, + ) = setup_time_dependent_element( + "bond_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.angle_energy_step, + h5md.angle_energy_time, + h5md.angle_energy, + ) = setup_time_dependent_element( + "angle_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.dihedral_energy_step, + h5md.dihedral_energy_time, + h5md.dihedral_energy, + ) = setup_time_dependent_element( + "dihedral_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.field_energy_step, + h5md.field_energy_time, + h5md.field_energy, + ) = setup_time_dependent_element( + "field_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + if charges is not False: + ( + _, + h5md.field_q_energy_step, + h5md.field_q_energy_time, + h5md.field_q_energy, + ) = setup_time_dependent_element( + "field_q_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) # <-------- xinmeng + if plumed_out is not False: + ( + _, + h5md.plumed_bias_step, + h5md.plumed_bias_time, + h5md.plumed_bias, + ) = setup_time_dependent_element( + "plumed_bias", h5md.observables, n_frames, (1,), dtype, units="kJ mol-1" # noqa: E501 + ) + ( + _, + h5md.total_momentum_step, + h5md.total_momentum_time, + h5md.total_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "total_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm g ps-1 mol-1", + ) + ( + _, + h5md.angular_momentum_step, + h5md.angular_momentum_time, + h5md.angular_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "angular_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm+2 g ps-1 mol-1", + ) + ( + _, + h5md.torque_step, + h5md.torque_time, + h5md.torque, + ) = setup_time_dependent_element( # noqa: E501 + "torque", + h5md.observables, + n_frames, + (3,), + dtype, + units="kJ nm+2 mol-1", + ) + ( + _, + h5md.temperature_step, + h5md.temperature_time, + h5md.temperature, + ) = setup_time_dependent_element( + "temperature", h5md.observables, n_frames, (3,), dtype, units="K" + ) + ( + _, + h5md.thermostat_work_step, + h5md.thermostat_work_time, + h5md.thermostat_work, + ) = setup_time_dependent_element( + "thermostat_work", + h5md.observables, + n_frames, + (1,), + "float32", + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.pressure_step, + h5md.pressure_time, + h5md.pressure, + ) = setup_time_dependent_element( + "pressure", h5md.observables, n_frames, (18,), "float32", units="Bar" + ) + (_, h5md.box_step, h5md.box_time, h5md.box_value,) = setup_time_dependent_element( + "edges", box, n_frames, (3, 3), "float32", units="nm" + ) + + ind_sort = np.argsort(indices) + for i in ind_sort: + species[indices[i]] = config.name_to_type_map[names[i].decode("utf-8")] + + h5md.parameters.attrs["config.toml"] = np.string_(str(config)) + vmd_group = h5md.parameters.create_group("vmd_structure") + index_of_species = vmd_group.create_dataset( + "indexOfSpecies", (config.n_types,), "i" + ) + index_of_species[:] = np.array(list(range(config.n_types))) + + # VMD-h5mdplugin maximum name/type name length is 16 characters (for + # whatever reason [VMD internals?]). + name_dataset = vmd_group.create_dataset("name", (config.n_types,), "S16") + type_dataset = vmd_group.create_dataset("type", (config.n_types,), "S16") + if molecules is not None: + resid_dataset = vmd_group.create_dataset( + "resid", + (config.n_particles,), + "i", + ) + + # Change this + for i, n in config.type_to_name_map.items(): + name_dataset[i] = np.string_(n[:16]) + if n == "W": + type_dataset[i] = np.string_("solvent") + else: + type_dataset[i] = np.string_("membrane") + + total_bonds = comm.allreduce(len(bonds_2_atom1), MPI.SUM) + n_bonds_local = len(bonds_2_atom1) + + receive_buffer = comm.gather(n_bonds_local, root=0) + n_bonds_global = None + if comm.Get_rank() == 0: + n_bonds_global = receive_buffer + n_bonds_global = np.array(comm.bcast(n_bonds_global, root=0)) + rank_bond_start = np.sum(n_bonds_global[: comm.Get_rank()]) + + bonds_from = vmd_group.create_dataset("bond_from", (total_bonds,), "i") + bonds_to = vmd_group.create_dataset("bond_to", (total_bonds,), "i") + for i in range(n_bonds_local): + a = bonds_2_atom1[i] + b = bonds_2_atom2[i] + bonds_from[rank_bond_start + i] = indices[a] + 1 + bonds_to[rank_bond_start + i] = indices[b] + 1 + + if molecules is not None: + resid_dataset[indices[ind_sort]] = molecules
+ + +# store data old vs +""" +h5md, step, frame, indices, positions, velocities, forces, box_size, +temperature, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, +field_energy, field_q_energy, time_step, config, velocity_out=False, +force_out=False, charge_out=False, dump_per_particle=False, +""" + + +
[docs]def store_data( + h5md, + step, + frame, + indices, + positions, + velocities, + forces, + box_size, + temperature, + pressure, + kinetic_energy, + bond2_energy, + bond3_energy, + bond4_energy, + field_energy, + field_q_energy, + plumed_bias, + time_step, + config, + velocity_out=False, + force_out=False, + charge_out=False, + plumed_out=False, + dump_per_particle=False, + comm=MPI.COMM_WORLD, +): + """Writes time-step data to HDF5 output file + + Handles all quantities which change during simulation, as opposed to + static quanitities (see :code:`store_static`). + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + step : int + Step number. + frame : int + Output frame number (:code:`step // n_print`). + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + positions : (N,) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + velocities : (N,) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + forces : (N,) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. + box_size : (D,) numpy.ndarray + Array containing the simulation box size. + temperature : float + Calculated instantaneous temperature. + kinetic_energy : float + Calculated instantaneous kinetic energy. + bond2_energy : float + Calculated instantaneous harmonic two-particle bond energy. + bond3_energy : float + Calculated instantaneous harmonic angular three-particle bond energy. + bond4_energy : float + Calculated instantaneous dihedral four-particle torsion energy. + field_energy : float + Calculated instantaneous particle-field energy. + field_q_energy : float + Calculated instantaneous electrostatic energy. + plumed_bias : float + PLUMED instantaneous bias energy. + time_step : float + Value of the time step. + config : Config + Configuration object. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charge_out : bool, optional + If :code:`True`, electrostatic energies are written to the output + HDF5 file. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to the output HDF5 file. + dump_per_particle : bool, optional + If :code:`True`, all quantities are written **per particle**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + store_static : + Outputs all static time-independent quantities to the HDF5 output file + """ + for dset in ( + h5md.positions_step, + h5md.total_energy_step, + h5md.potential_energy_step, + h5md.kinetc_energy_step, + h5md.bond_energy_step, + h5md.angle_energy_step, + h5md.dihedral_energy_step, + h5md.field_energy_step, + h5md.total_momentum_step, + h5md.angular_momentum_step, + h5md.torque_step, + h5md.temperature_step, + h5md.pressure_step, + h5md.box_step, + h5md.thermostat_work_step, + ): + dset[frame] = step + + for dset in ( + h5md.positions_time, + h5md.total_energy_time, + h5md.potential_energy_time, + h5md.kinetc_energy_time, + h5md.bond_energy_time, + h5md.angle_energy_time, + h5md.dihedral_energy_time, + h5md.field_energy_time, + h5md.total_momentum_time, + h5md.angular_momentum_time, + h5md.torque_time, + h5md.temperature_time, + h5md.pressure_time, + h5md.box_time, + h5md.thermostat_work_time, + ): + dset[frame] = step * time_step + + if velocity_out: + h5md.velocities_step[frame] = step + h5md.velocities_time[frame] = step * time_step + if force_out: + h5md.forces_step[frame] = step + h5md.forces_time[frame] = step * time_step + if charge_out: + h5md.field_q_energy_step[frame] = step + h5md.field_q_energy_time[frame] = step * time_step + if plumed_out: + h5md.plumed_bias_step[frame] = step + h5md.plumed_bias_time[frame] = step * time_step + + ind_sort = np.argsort(indices) + h5md.positions[frame, indices[ind_sort]] = positions[ind_sort] + + if velocity_out: + h5md.velocities[frame, indices[ind_sort]] = velocities[ind_sort] + if force_out: + h5md.forces[frame, indices[ind_sort]] = forces[ind_sort] + if charge_out: + h5md.field_q_energy[frame] = field_q_energy + if plumed_out: + h5md.plumed_bias[frame] = plumed_bias + + potential_energy = ( + bond2_energy + bond3_energy + bond4_energy + field_energy + field_q_energy + ) + + total_momentum = config.mass * comm.allreduce(np.sum(velocities, axis=0), MPI.SUM) + angular_momentum = config.mass * comm.allreduce( + np.sum(np.cross(positions, velocities), axis=0), MPI.SUM + ) + torque = config.mass * comm.allreduce( + np.sum(np.cross(positions, forces), axis=0), MPI.SUM + ) + h5md.total_energy[frame] = kinetic_energy + potential_energy + h5md.potential_energy[frame] = potential_energy + h5md.kinetc_energy[frame] = kinetic_energy + h5md.bond_energy[frame] = bond2_energy + h5md.angle_energy[frame] = bond3_energy + h5md.dihedral_energy[frame] = bond4_energy + h5md.field_energy[frame] = field_energy + h5md.total_momentum[frame, :] = total_momentum + h5md.angular_momentum[frame, :] = angular_momentum + h5md.torque[frame, :] = torque + h5md.temperature[frame] = temperature + h5md.pressure[frame] = pressure + for d in range(3): + h5md.box_value[frame, d, d] = box_size[d] + h5md.thermostat_work[frame] = config.thermostat_work + + fmt_ = [ + "step", + "time", + "temp", + "tot E", + "kin E", + "pot E", + "field E", + "elec E", + "bond E", + "ang E", + "dih E", + "bias E", + "Px", + "Py", + "Pz", + "ΔH" if config.target_temperature else "ΔE", + ] + fmt_ = np.array(fmt_) + + # create mask to show only energies != 0 + en_array = np.array([ + field_energy, + field_q_energy, + bond2_energy, + bond3_energy, + bond4_energy, + plumed_bias, + ]) + mask = np.full_like(fmt_, True, dtype=bool) + mask[range(6,12)] = en_array != 0. + + header_ = fmt_[mask].shape[0] * "{:>13}" + if config.initial_energy is None: + fmt_[-1] = "" + + divide_by = 1.0 + if dump_per_particle: + for i in range(3, 9): + fmt_[i] = fmt_[i][:-2] + "E/N" + fmt_[-1] += "/N" + divide_by = config.n_particles + total_energy = kinetic_energy + potential_energy + if config.initial_energy is not None: + if config.target_temperature: + H_tilde = total_energy - config.initial_energy - config.thermostat_work + else: + H_tilde = total_energy - config.initial_energy + else: + H_tilde = 0.0 + + header = header_.format(*fmt_[mask]) + data_fmt = f'{"{:13}"}{(fmt_[mask].shape[0]-1) * "{:13.5g}" }' + all_data = [ + step, + time_step * step, + temperature, + total_energy / divide_by, + kinetic_energy / divide_by, + potential_energy / divide_by, + field_energy / divide_by, + field_q_energy / divide_by, + bond2_energy / divide_by, + bond3_energy / divide_by, + bond4_energy / divide_by, + plumed_bias / divide_by, + total_momentum[0] / divide_by, + total_momentum[1] / divide_by, + total_momentum[2] / divide_by, + H_tilde / divide_by, + ] + data = data_fmt.format(*[val for i, val in enumerate(all_data) if mask[i]]) + Logger.rank0.log(logging.INFO, ("\n" + header + "\n" + data))
+ + +
[docs]def distribute_input( + in_file, rank, size, n_particles, max_molecule_size=201, comm=MPI.COMM_WORLD +): + """Assign global arrays onto MPI ranks, attempting load balancing + + Distributes approximately equal numbers of particles (workload) onto each + independent MPI rank, while respecting the requirement that any molecule + must be fully contained on a single MPI rank only (no splitting molecules + across multiple CPUs). + + Parameters + ---------- + in_file : h5py.File + HDF5 input file object. + rank : int + Local rank number for this MPI rank. + size : int + Global size of the MPI communicator (number of total CPUs). + n_particles : int + Total number of particles. + max_molecule_size : int, optional + Maximum size of any molecule present in the system. Used to initially + guess where the MPI rank boundaries (start/end indices) in the global + arrays should be placed. If molecules of size + :code:`>max_molecule_size` exist in the simulation system, HyMD + **might** work as expected. Or it might fail spectacularly. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + rank_range : + Starting and ending indices in the global arrays for each MPI rank. + """ + if n_particles is None: + n_particles = len(in_file["indices"]) + np_per_MPI = n_particles // size + + molecules_flag = False + if "molecules" in in_file: + molecules_flag = True + + if not molecules_flag: + if rank == size - 1: + np_cum_mpi = [rank * np_per_MPI, n_particles] + else: + np_cum_mpi = [rank * np_per_MPI, (rank + 1) * np_per_MPI] + p_mpi_range = list(range(np_cum_mpi[0], np_cum_mpi[1])) + return p_mpi_range, molecules_flag + + # To avoid splitting molecules across multiple different ranks, we need + # to read in some extra indices before/after the expected break points + # and iterate until we find a molecule break. + # + # Implicitly assuming no molecule is bigger than + # min(max_molecule_size, n_particles // n_MPI_ranks) atoms. + max_molecule_size += 2 + grab_extra = max_molecule_size if np_per_MPI > max_molecule_size else np_per_MPI + if rank == 0: + mpi_range_start = 0 + if size == 1: + mpi_range_end = n_particles + else: + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + elif rank == size - 1: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = n_particles + else: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + + molecules = in_file["molecules"][mpi_range_start:mpi_range_end] + indices = in_file["indices"][mpi_range_start:mpi_range_end] + molecule_end_indices = np.nonzero(np.diff(molecules))[0] + + p_mpi_range = [None, None] + if rank == 0: + p_mpi_range[0] = 0 + if size == 1: + p_mpi_range[1] = n_particles + else: + p_mpi_range[1] = indices[ + molecule_end_indices[molecule_end_indices >= np_per_MPI][0] + 1 + ] + elif rank == size - 1: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = n_particles + else: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = ( + indices[molecule_end_indices[molecule_end_indices > np_per_MPI][0]] + + 1 # noqa: E501 + ) + return list(range(p_mpi_range[0], p_mpi_range[1])), molecules_flag
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/_modules/hymd/force.html b/v1.0.3/_modules/hymd/force.html new file mode 100644 index 00000000..58db518c --- /dev/null +++ b/v1.0.3/_modules/hymd/force.html @@ -0,0 +1,1150 @@ + + + + + + hymd.force — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.force

+"""Calculates intramolecular forces between bonded particles in molecules
+"""
+import numpy as np
+import networkx as nx
+from dataclasses import dataclass
+
+# Imported here so we can call from force import compute_bond_forces__fortran
+from force_kernels import cbf as compute_bond_forces__fortran  # noqa: F401
+from force_kernels import (  # noqa: F401
+    caf as compute_angle_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cdf as compute_dihedral_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cbf_d as compute_bond_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    caf_d as compute_angle_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    cdf_d as compute_dihedral_forces__fortran__double,
+)
+
+
+
[docs]@dataclass # might not be needed +class Dielectric_type: + atom_1: str + dielectric_value: float
+ + +
[docs]@dataclass +class Bond: + """Dataclass representing a single two-particle bond type + + A `bond type` is a bond strength and equilibrium distance associated with + any bond between particles of specific types :code:`A` and :code:`B` + (where :code:`A` and :code:`B` may be the same or different). Harmonic + two-particle bonds in HyMD take the form + + .. math:: + + V_2(\\mathbf{r}_1, \\mathbf{r}_2) = + \\frac{1}{2}k + \\left( + \\vert \\mathbf{r}_1 - \\mathbf{r}_2 \\vert - r_0 + \\right)^2, + + where :math:`k` is the bond strength (spring constant) and :math:`r_0` is + the equilibrium bond length (at which the energy is zero). + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + equilibrium : float + Equilibrium distance at which the energy associated with the bond + vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient (spring constant). + """ + + atom_1: str + atom_2: str + equilibrium: float + strength: float
+ + +
[docs]@dataclass +class Angle(Bond): + """Dataclass representing a single three-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any three-particle bond between particles of specific types :code:`A`, + :code:`B`, and :code:`C` (where :code:`A`, :code:`B`, and :code:`C` may be + different or the same). Harmonic angular three-particle bonds in HyMD take + the form + + .. math:: + + V_3(\\mathbf{r}_1, \\mathbf{r}_2, \\mathbf{r}_3) = + \\frac{1}{2}k + \\left( + \\cos^{-1} + \\left[ + \\frac{ + (\\mathbf{r}_1-\\mathbf{r}_2) + \\cdot + (\\mathbf{r}_3-\\mathbf{r}_2) + } + { + \\vert\\mathbf{r}_1-\\mathbf{r}_2\\vert + \\vert\\mathbf{r}_3-\\mathbf{r}_2\\vert + } + \\right] - \\theta_0 + \\right)^2 + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + equilibrium : float + Equilibrium angle at which the energy associated with the + three-particle angular bond vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient. + + See also + -------- + Bond : + Two-particle bond type dataclass + """ + + atom_3: str
+ + +
[docs]@dataclass +class Dihedral: + """Dataclass representing a single four-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any four-particle torsional bond between particles of specific types + :code:`A`, :code:`B`, :code:`C`, and :code:`D` (where :code:`A`, :code:`B`, + :code:`C`, and :code:`D` may be different or the same). Dihedral + four-particle bonds in HyMD take different forms depending on the + :code:`dih_type` parameter. + + In the following, let :math:`\\phi` denote the angle between the planes + spanned by the relative positions of atoms :code:`A`-:code:`B`-:code:`C` + and :code:`B`-:code:`C`-:code:`D`. If :code:`dih_type = 0`, then + + .. math:: + + V_4(\\phi) = \\sum_n c_n + \\left( + 1 + \\cos\\left[ + n\\phi - d_n + \\right] + \\right), + + where :math:`c_n` are energy coefficients and :math:`d_n` are propensity + phases. By default, the cosine sum is truncated at five terms. If + :code:`coeffs` provides only a single float, this is used as the coiling + propensity parameter :math:`\\lambda`. In this case, :math:`c_n` and + :math:`d_n` are automatically set to values which promote alpha helical + (:math:`\\lambda=-1`), beta sheet (:math:`\\lambda=1`), or a mixed + (:math:`1>\\lambda>-1`) structure (using values provided by Bore et al. + (2018)). In this case, the full potential takes the form + + .. math:: + + V_4(\\phi;\\lambda) = + \\frac{1}{2}(1-\\lambda) V_{\\text{prop},\\alpha}(\\phi) + + + \\frac{1}{2}(1+\\lambda) V_{\\text{prop},\\beta}(\\phi) + + + (1-\\vert\\lambda\\vert) V_{\\text{prop}, \\text{coil}}(\\phi), + + with each of the :math:`V_{\\mathrm{prop}, X}` being fixed cosine series + potentials with pre-set :math:`c_n` -s and :math:`d_n` -s. + + If :code:`dih_type = 1`, then a combined bending torsional (CBT) potential + is employed, + + .. math:: + + V_4(\\phi,\\gamma;\\lambda) = + V_4(\\phi;\\lambda) + + + \\frac{1}{2}K(\\phi)(\\gamma - \\gamma_0)^2, + + where :math:`V_4(\\phi;\\lambda)` specifies the potential as given by the + coiling propensity parameter above, :math:`K(\\phi)` is a separate cosine + series potential acting as the angular three-particle bond strength, and + :math:`\\gamma_0` is the three-particle bond equilibrium angle. In this + case, the :code:`coeffs` parameter must specify *both* a :math:`\\lambda` + value, in additon to the energy and phases dictating the :math:`K(\\phi)` + potential. + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + atom_4 : str + Type name of particle 4. + coeffs : list[list[float]] or list[float] or numpy.ndarray + Dihedral coefficients defining the series expansion of the dihedral + energy. + dih_type : int + Specifies the type of dihedral used; If :code:`0`, then :code:`coeffs` + must contain **either** two lists of five energy coefficients + :math:`c_n` and five propensity phases :math:`d_n` **or** a single + floating point number defining the :math:`\\lambda` coiling propensity + parameter. If :code:`1`, the combined bending-torsional potential is + used, and :code:`coeffs` must specify :math:`\\lambda` *and* two lists + containing energy coefficients and propensity phases for the + :math:`V_\\text{prop}` propensity potential, defined in terms of cosine + series. + + References + ---------- + Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018. + """ + + atom_1: str + atom_2: str + atom_3: str + atom_4: str + coeffs: np.ndarray + dih_type: int
+ + +
[docs]@dataclass +class Chi: + """Dataclass representing a single :math:`\\chi` mixing interaction type + + An `interaction mixing energy type` is a mixing energy associated with + density overlap between species of types :code:`A` and :code:`B` + (specified as inputs :code:`atom_1` and :code:`atom_2`). A positive mixing + energy promotes phase separation, a negative mixing energy promotes mixing. + The interaction energy density (provided the :code:`DefaultWithChi` + Hamiltonian is used) takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} + \\sum_{k,l}\\chi_{k,l} \\tilde\\phi_k\\tilde\\phi_l, + + where :math:`\\chi_{k,l}` denotes the mixing energy between species + :math:`k` and :math:`l`, with :math:`\\kappa` being the incompressibility. + The value of the interaction mixing energy parameter may be extracted from + `Flory-Huggins theory`_. + + .. _`Flory-Huggins theory`: + https://en.wikipedia.org/wiki/Flory%E2%80%93Huggins_solution_theory + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + interaction_energy : float + Interaction mixing energy. + + See also + -------- + hymd.hamiltonian.DefaultWithChi : + Interaction energy functional using :math:`\\chi`-interactions. + """ + + atom_1: str + atom_2: str + interaction_energy: float
+ + +
[docs]def find_all_paths(G, u, n): + """Helper function that recursively finds all paths of given lenght 'n + 1' inside a network 'G'. + Adapted from https://stackoverflow.com/a/28103735.""" + if n == 0: + return [[u]] + paths = [] + for neighbor in G.neighbors(u): + for path in find_all_paths(G, neighbor, n - 1): + if u not in path: + paths.append([u] + path) + return paths
+ + +
[docs]def propensity_potential_coeffs(x: float): + alpha_coeffs = np.array( + [ + [7.406, -5.298, -2.570, 1.336, 0.739], + [-0.28632126, 1.2099146, 1.18122138, 0.49075168, 0.98495911], + ] + ) + beta_coeffs = np.array( + [ + [3.770, 5.929, -4.151, -0.846, 0.190], + [-0.2300693, -0.0583289, 0.99342396, 1.03237971, 2.90160988], + ] + ) + coil_coeffs = np.array( + [ + [1.416, -0.739, 0.990, -0.397, 0.136], + [1.3495933, 0.45649087, 2.30441057, -0.12274901, -0.26179939], + ] + ) + + zero_add = np.zeros((2, 5)) + if np.isclose(x, -1): + return np.concatenate((alpha_coeffs, zero_add)) + elif np.isclose(x, 0): + return np.concatenate((coil_coeffs, zero_add)) + elif np.isclose(x, 1): + return np.concatenate((beta_coeffs, zero_add)) + + abs_x = np.abs(x) + if abs_x > 1: + err_str = ( + f"The provided value of lambda = {x} is out of lambda definition range, " + f"[-1.0, 1.0]." + ) + Logger.rank0.log(logging.ERROR, err_str) + else: + coil_coeffs[0] *= 1 - abs_x + if x < 0: + alpha_coeffs[0] *= 0.5 * (abs_x - x) + return np.concatenate((alpha_coeffs, coil_coeffs)) + else: + beta_coeffs[0] *= 0.5 * (abs_x + x) + return np.concatenate((beta_coeffs, coil_coeffs))
+ + +
[docs]def prepare_bonds_old(molecules, names, bonds, indices, config): + """Find bonded interactions from connectivity and bond types information + + .. deprecated:: 1.0.0 + :code:`prepare_bonds_old` was replaced by :code:`prepare_bonds` for + use with compiled Fortran kernels prior to 1.0.0 release. + + Prepares the necessary equilibrium and bond strength information needed by + the intramolecular interaction functions. This is performed locally on each + MPI rank, as the domain decomposition ensures that for all molecules *all* + consituent particles are always contained on *the same* MPI rankself. + + This function traverses the bond connectivity information provided in the + structure/topology input file and indentifies any two-, three-, or + four-particle potential bonds. For each connected chain of two, three, or + four particles, a matching to bond types is attempted. If the corresponding + names match, a bond object is initialized. + + In order to investigate the connectivity, a graph is created using + networkx functionality. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2 : list + List of lists containing *local* particle indices, equilibrium + distance, and bond strength coefficient for each reconstructed + two-particle bond. + bonds_3 : + List of lists containing *local* particle indices, equilibrium angle, + and bond strength coefficient for each reconstructed three-particle + bond. + bonds_4 : + List of lists containing *local* particle indices, dihedral type index, + and dihedral coefficients for each reconstructed four-particle + torsional bond. + bb_index : list + List indicating the dihedral type of each four-particle bond in + :code:`bonds_4`. + + See also + -------- + Bond : + Two-particle bond type dataclass. + Angle : + Three-particle angular bond type dataclass. + Dihedral : + Four-particle torsional bond type dataclass. + hymd.input_parser.Config + Configuration dataclass handler. + """ + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + bb_index = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + bb_dihedral = 0 + bond_graph = nx.Graph() + + for local_index, global_index in enumerate(indices): + if molecules[local_index] != mol: + continue + + bond_graph.add_node( + global_index, + name=names[local_index].decode("UTF-8"), + local_index=local_index, + ) + for bond in [b for b in bonds[local_index] if b != -1]: + bond_graph.add_edge(global_index, bond) + + connectivity = nx.all_pairs_shortest_path(bond_graph) + for c in connectivity: + i = c[0] + connected = c[1] + for j, path in connected.items(): + if len(path) == 2 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for b in config.bonds: + match_forward = name_i == b.atom_1 and name_j == b.atom_2 + match_backward = name_i == b.atom_2 and name_j == b.atom_1 + if match_forward or match_backward: + bonds_2.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[j]["local_index"], + b.equilibrium, + b.strength, + ] + ) + + if len(path) == 3 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_mid = bond_graph.nodes()[path[1]]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for a in config.angle_bonds: + match_forward = ( + name_i == a.atom_1 + and name_mid == a.atom_2 + and name_j == a.atom_3 + ) + match_backward = ( + name_i == a.atom_3 + and name_mid == a.atom_2 + and name_j == a.atom_1 + ) + if match_forward or match_backward: + bonds_3.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[path[1]]["local_index"], + bond_graph.nodes()[j]["local_index"], + np.radians(a.equilibrium), + a.strength, + ] + ) + + all_paths_len_four = find_all_paths(bond_graph, i, 3) + for p in all_paths_len_four: + name_i = bond_graph.nodes()[i]["name"] + name_mid_1 = bond_graph.nodes()[p[1]]["name"] + name_mid_2 = bond_graph.nodes()[p[2]]["name"] + name_j = bond_graph.nodes()[p[3]]["name"] + + for a in config.dihedrals: + match_forward = ( + name_i == a.atom_1 + and name_mid_1 == a.atom_2 + and name_mid_2 == a.atom_3 + and name_j == a.atom_4 + ) + if ( + match_forward + and [ + bond_graph.nodes()[p[3]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[i]["local_index"], + a.coeffs, + a.dih_type, + ] + not in bonds_4 + ): + bonds_4.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[3]]["local_index"], + a.coeffs, + a.dih_type, + ] + ) + if a.dih_type == 1: + bb_dihedral = len(bonds_4) + + if bb_dihedral: + bb_index.append(bb_dihedral - 1) + + return bonds_2, bonds_3, bonds_4, bb_index
+ + +
[docs]def prepare_index_based_bonds(molecules, topol): + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + resid = mol + 1 + top_summary = topol["system"]["molecules"] + resname = None + test_mol_number = 0 + for molname in top_summary: + test_mol_number += molname[1] + if resid <= test_mol_number: + resname = molname[0] + break + + if resname is None: + break + + if "bonds" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for bond in topol[resname]["bonds"]: + index_i = bond[0] - 1 + first_id + index_j = bond[1] - 1 + first_id + # bond[2] is the bond type, inherited by the itp format. Not used + equilibrium = bond[3] + strength = bond[4] + bonds_2.append([index_i, index_j, equilibrium, strength]) + + if "angles" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["angles"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + # angle[3] is the angle type, inherited by the itp format. Not used + equilibrium = np.radians(angle[4]) + strength = angle[5] + bonds_3.append([index_i, index_j, index_k, equilibrium, strength]) + + if "dihedrals" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["dihedrals"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + index_l = angle[3] - 1 + first_id + dih_type = angle[4] + coeff = angle[5] + if dih_type == 0 and isinstance(coeff[0], (float, int)): + coeff = propensity_potential_coeffs(coeff[0]) + elif dih_type == 1 and len(coeff) == 3: + coeff = np.array( + propensity_potential_coeffs(coeff[0][0]).tolist() + + coeff[1:] + ) + elif dih_type == 2: + coeff = np.array(coeff) + else: + coeff = np.insert(np.array(coeff), 2, np.zeros((2, 5)), axis=0) + bonds_4.append([index_i, index_j, index_k, index_l, coeff, dih_type, 0]) + return bonds_2, bonds_3, bonds_4
+ + +
[docs]def prepare_bonds(molecules, names, bonds, indices, config, topol=None): + """Rearrange the bond information for usage in compiled Fortran kernels + + Restructures the lists resulting from the execution of + :code:`prepare_bonds_old` into numpy arrays suitable for calls to optimized + Fortran code calculating bonded forces and energiesself. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2_atom_1 : (B,) numpy.ndarray + Local index of particle 1 for each of :code:`B` constructed + two-particle bonds. + bonds_2_atom_2 : (B,) numpy.ndarray + Local index of particle 2 for each of :code:`B` constructed + two-particle bonds. + bonds_2_equilibrium : (B,) numpy.ndarray + Equilibrium distance for each of :code:`B` constructed two-particle + bonds. + bonds_2_strength : (B,) numpy.ndarray + Bond strength for each of :code:`B` constructed two-particle + bonds. + bonds_3_atom_1 : (A,) numpy.ndarray + Local index of particle 1 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_2 : (A,) numpy.ndarray + Local index of particle 2 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_3 : (A,) numpy.ndarray + Local index of particle 3 for each of :code:`A` constructed + three-particle bonds. + bonds_3_equilibrium : (A,) numpy.ndarray + Equilibrium angle for each of :code:`A` constructed three-particle + bonds. + bonds_3_strength : (A,) numpy.ndarray + Bond strength for each of :code:`A` constructed three-particle + bonds. + bonds_4_atom_1 : (D,) numpy.ndarray + Local index of particle 1 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_2 : (D,) numpy.ndarray + Local index of particle 2 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_3 : (D,) numpy.ndarray + Local index of particle 3 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_4 : (D,) numpy.ndarray + Local index of particle 4 for each of :code:`D` constructed + four-particle bonds. + bonds_4_coeff : (D,) numpy.ndarray + Cosine series coefficients for each of :code:`D` constructed + four-particle bonds. + bonds_4_type : (D,) numpy.ndarray + Dihedral type for each of :code:`D` constructed four-particle + bonds. + bonds_4_last : (D,) numpy.ndarray + Flags indicating if :code:`dih_type` is :code:`1` for each of :code:`D` + constructed four-particle bonds. + + See also + -------- + prepare_bonds_old : + Used internally to reconstruct the bonded interactions types from the + connectivity information in the structure/topology input file and the + bonded types specified in the configuration file. + """ + if topol is not None: + bonds_2, bonds_3, bonds_4 = prepare_index_based_bonds( + molecules, topol + ) + else: + bonds_2, bonds_3, bonds_4, bb_index = prepare_bonds_old( + molecules, names, bonds, indices, config + ) + + # Bonds + bonds_2_atom1 = np.empty(len(bonds_2), dtype=int) + bonds_2_atom2 = np.empty(len(bonds_2), dtype=int) + bonds_2_equilibrium = np.empty(len(bonds_2), dtype=np.float64) + bonds_2_strength = np.empty(len(bonds_2), dtype=np.float64) + for i, b in enumerate(bonds_2): + bonds_2_atom1[i] = b[0] + bonds_2_atom2[i] = b[1] + bonds_2_equilibrium[i] = b[2] + bonds_2_strength[i] = b[3] + + # Angles + bonds_3_atom1 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom2 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom3 = np.empty(len(bonds_3), dtype=int) + bonds_3_equilibrium = np.empty(len(bonds_3), dtype=np.float64) + bonds_3_strength = np.empty(len(bonds_3), dtype=np.float64) + for i, b in enumerate(bonds_3): + bonds_3_atom1[i] = b[0] + bonds_3_atom2[i] = b[1] + bonds_3_atom3[i] = b[2] + bonds_3_equilibrium[i] = b[3] + bonds_3_strength[i] = b[4] + # Dihedrals + bonds_4_atom1 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom2 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom3 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom4 = np.empty(len(bonds_4), dtype=int) + number_of_coeff = 6 + len_of_coeff = 5 + bonds_4_coeff = np.empty( + (len(bonds_4), number_of_coeff, len_of_coeff), dtype=np.float64 + ) + bonds_4_type = np.empty(len(bonds_4), dtype=int) + bonds_4_last = np.zeros(len(bonds_4), dtype=int) + for i, b in enumerate(bonds_4): + bonds_4_atom1[i] = b[0] + bonds_4_atom2[i] = b[1] + bonds_4_atom3[i] = b[2] + bonds_4_atom4[i] = b[3] + bonds_4_coeff[i] = np.resize(b[4], (number_of_coeff, len_of_coeff)) + bonds_4_type[i] = b[5] + if topol is not None: + bonds_4_last[i] = b[6] + if topol is None: + bonds_4_last[bb_index] = 1 + + return ( + bonds_2_atom1, + bonds_2_atom2, + bonds_2_equilibrium, + bonds_2_strength, + bonds_3_atom1, + bonds_3_atom2, + bonds_3_atom3, + bonds_3_equilibrium, + bonds_3_strength, # noqa: E501 + bonds_4_atom1, + bonds_4_atom2, + bonds_4_atom3, + bonds_4_atom4, + bonds_4_coeff, + bonds_4_type, + bonds_4_last, # noqa: E501 + )
+ + +
[docs]def compute_bond_forces__plain(f_bonds, r, bonds_2, box_size): + """Computes forces resulting from bonded interactions + + .. deprecated:: 1.0.0 + :code:`compute_bond_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_bonds.fill(0.0) + energy = 0.0 + + for i, j, r0, k in bonds_2: + ri = r[i, :] + rj = r[j, :] + rij = rj - ri + + # Apply periodic boundary conditions to the distance rij + for dim in range(len(rij)): + rij[dim] -= box_size[dim] * np.around(rij[dim] / box_size[dim]) + dr = np.linalg.norm(rij) + df = -k * (dr - r0) + f_bond_vector = df * rij / dr + f_bonds[i, :] -= f_bond_vector + f_bonds[j, :] += f_bond_vector + + energy += 0.5 * k * (dr - r0) ** 2 + return energy
+ + +
[docs]def compute_angle_forces__plain(f_angles, r, bonds_3, box_size): + """Computes forces resulting from angular interactions + + .. deprecated:: 1.0.0 + :code:`compute_angle_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_angles.fill(0.0) + energy = 0.0 + + for a, b, c, theta0, k in bonds_3: + ra = r[a, :] - r[b, :] + rc = r[c, :] - r[b, :] + + for dim in range(len(ra)): + ra[dim] -= box_size[dim] * np.around(ra[dim] / box_size[dim]) + rc[dim] -= box_size[dim] * np.around(rc[dim] / box_size[dim]) + + xra = 1.0 / np.sqrt(np.dot(ra, ra)) + xrc = 1.0 / np.sqrt(np.dot(rc, rc)) + ea = ra * xra + ec = rc * xrc + + cosphi = np.dot(ea, ec) + theta = np.arccos(cosphi) + xsinph = 1.0 / np.sqrt(1.0 - cosphi**2) + + d = theta - theta0 + f = -k * d + + xrasin = xra * xsinph * f + xrcsin = xrc * xsinph * f + + fa = (ea * cosphi - ec) * xrasin + fc = (ec * cosphi - ea) * xrcsin + + f_angles[a, :] += fa + f_angles[c, :] += fc + f_angles[b, :] -= fa + fc + # f_angles[b, :] += -(fa + fc) + + energy -= 0.5 * f * d + + return energy
+ + +
[docs]def compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size): + """Computes forces resulting from dihedral interactions + + .. deprecated:: 1.0.0 + :code:`compute_dihedral_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_dihedrals.fill(0.0) + energy = 0.0 + + for a, b, c, d, coeffs, phase in bonds_4: + f = r[a, :] - r[b, :] + g = r[b, :] - r[c, :] + h = r[d, :] - r[c, :] + + for dim in range(3): + f -= box_size[dim] * np.around(f[dim] / box_size[dim]) + g -= box_size[dim] * np.around(g[dim] / box_size[dim]) + h -= box_size[dim] * np.around(h[dim] / box_size[dim]) + + v = np.cross(f, g) + w = np.cross(h, g) + vv = np.dot(v, v) + ww = np.dot(w, w) + gn = np.linalg.norm(g) + + cosphi = np.dot(v, w) + sinphi = np.dot(np.cross(v, w), g) / gn + phi = np.arctan2(sinphi, cosphi) + + fg = np.dot(f, g) + hg = np.dot(h, g) + sc = v * fg / (vv * gn) - w * hg / (ww * gn) + + df = 0 + + for m in range(len(coeffs[0])): + energy += coeffs[0][m] * (1 + np.cos(m * phi - coeffs[1][m])) + df += m * coeffs[0][m] * np.sin(m * phi - coeffs[1][m]) + + force_on_a = df * gn * v / vv + force_on_d = df * gn * w / ww + + f_dihedrals[a, :] -= force_on_a + f_dihedrals[b, :] += df * sc + force_on_a + f_dihedrals[c, :] -= df * sc + force_on_d + f_dihedrals[d, :] += force_on_d + return energy
+ + +
[docs]def dipole_forces_redistribution( + f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb +): + """Redistribute electrostatic forces calculated from topologically + reconstructed ghost dipole point charges to the backcone atoms of the protein. + """ + f_on_bead.fill(0.0) + for i, j, k, l, fd, matrix, dih_type, is_last in zip( + a, b, c, d, f_dipoles, trans_matrices, type_array, last_bb + ): + if dih_type == 1: + sum_force = fd[0] + fd[1] + diff_force = fd[0] - fd[1] + f_on_bead[i] += matrix[0] @ diff_force # Atom A + f_on_bead[j] += matrix[1] @ diff_force + 0.5 * sum_force # Atom B + f_on_bead[k] += matrix[2] @ diff_force + 0.5 * sum_force # Atom C + + if is_last == 1: + sum_force = fd[2] + fd[3] + diff_force = fd[2] - fd[3] + f_on_bead[j] += matrix[3] @ diff_force + f_on_bead[k] += matrix[4] @ diff_force + 0.5 * sum_force + f_on_bead[l] += matrix[5] @ diff_force + 0.5 * sum_force
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/_modules/hymd/hamiltonian.html b/v1.0.3/_modules/hymd/hamiltonian.html new file mode 100644 index 00000000..e44e22cb --- /dev/null +++ b/v1.0.3/_modules/hymd/hamiltonian.html @@ -0,0 +1,785 @@ + + + + + + hymd.hamiltonian — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.hamiltonian

+"""Interaction energy functionals.
+
+Implements field--particle interaction energy functionals depending on the
+field configuration. Extending HyMD with a new Hamiltonian is done by
+subclassing the :code:`Hamiltonian` superclass with logic intialized in the
+constructor.
+
+The grid-independent filtering function is defined in the :code:`Hamiltonian`
+superclass constructor. Hijack :code:`self.H` in a subclass to change the
+filter.
+"""
+import numpy as np
+import sympy
+
+
+
[docs]class Hamiltonian: + """Interaction energy functional superclass""" + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + self.config = config + self._setup()
+ +
[docs] def _setup(self): + """Superclass setup + + Sets up the grid-independent filtering function :code:`H`, and the + SymPy logic for symbolically differentiating interaction energy + functionals in Hamiltonian subclasses. + """ + if not hasattr(self.config, "simulation_volume"): + self.config.simulation_volume = np.prod(np.asarray(self.config.box_size)) + if not self.config.barostat: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.config.a = self.config.rho0 + if not self.config.rho0: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.phi = sympy.var("phi:%d" % (self.config.n_types)) + k = sympy.var("k:%d" % (3)) + + # electrostatics variables + self.psi = sympy.var("psi") + self.phi_q = sympy.var("phi_q") + if not self.config.self_energy: + self.config.self_energy = 0.0 + + def fourier_space_window_function(k): + return sympy.functions.elementary.exponential.exp( + -0.5 + * self.config.sigma**2 + * (k0**2 + k1**2 + k2**2) # noqa: F821, E501 + ) + + self.window_function_lambda = sympy.lambdify( + [k], fourier_space_window_function(k) + ) + + def H(k, v): + return v * self.window_function_lambda(k) + + self.H = H
+ + +
[docs]class SquaredPhi(Hamiltonian): + """Simple squared density interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + \\sum_k \\tilde\\phi_k + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`rho_0` is the + average density of the fully homogenous system. Expressing the species + densities in terms of fluctuations from the average, + + .. math:: + + \\mathrm{d}\\tilde\\phi_k = \\rho_0 - \\tilde\\phi_k, + + it is evident that this interaction energy functional is a slight change of + the :code:`DefaultNoChi` Hamiltonian, as the expanded interaction energy + density becomes + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + 6\\rho_0\\left[ + \\sum_k \\mathrm{d}\\tilde\\phi_k + \\right] + + + 9\\rho_0^2 + + + \\sum_k \\mathrm{d}\\tilde\\phi_k^2 + + + \\prod_{k\\not=l} + \\mathrm{d}\\tilde\\phi_k \\mathrm{d}\\tilde\\phi_l + \\right), + + identical to :code:`DefaultNoChi` apart from a constant energy shift + :math:`9\\rho_0^2`(which does not impact dynamics) and the + :math:`\\rho_0`--:math:`\\mathrm{d}\\tilde\\phi_k` cross-terms. These + cross-terms constitute contributions to the energy linear in + :math:`\\mathrm{d}\\tilde\\phi_k` absent in :code:`DefaultNoChi`, which has + only quadratic terms present. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(SquaredPhi, self).__init__(config) + super(SquaredPhi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0): + return 0.5 / (kappa * rho0) * (sum(phi)) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + ): + V_incompressibility = 1 / (kappa * rho0) * sum(phi) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultNoChi(Hamiltonian): + """Incompressibility-only interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. The :code:`SquaredPhi` Hamiltonian implements a similar + functional with an additional linear term component depending on + + .. math:: + + \\mathmr{d}\\tilde\\phi_k = \\tilde\\phi_k - \\rho_0 + + and not :math:`\\mathrm{d}\\tilde\\phi_k^2`. No explicit inter-species + interaction is present apart from the indirect interaction through the + incompressibility. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + hymd.input_parser.Config : + Configuration dataclass handler. + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultNoChi, self).__init__(config) + super(DefaultNoChi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0, a=self.config.a): + return 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultWithChi(Hamiltonian): + """Incompressibility and :math:`\\chi`-interactions energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = + \\frac{1}{2\\rho_0} + \\sum_{k,l}\\chi_{kl} \\tilde\\phi_k \\tilde\\phi_l + + + \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. :math:`\\chi_{ij}` is the Flory-Huggins-like + inter-species mixing energy. + """ + +
[docs] def __init__(self, config, unique_names, type_to_name_map): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultWithChi, self).__init__(config) + super(DefaultWithChi, self)._setup() + self.setup(unique_names, type_to_name_map)
+ +
[docs] def setup(self, unique_names, type_to_name_map): + """Setup the interaction energy potential and the external potential + + Parameters + ---------- + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + """ + self.type_to_name_map = type_to_name_map + self.chi_type_dictionary = { + tuple(sorted([c.atom_1, c.atom_2])): c.interaction_energy + for c in self.config.chi + } + self.phi_laplacian = [ + sympy.var("phi_laplacian%d(0:%d)" % (t, 3)) + for t in range(self.config.n_types) + ] + + def w( + phi, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + interaction = 0.0 + for i in range(self.config.n_types): + for j in range(i + 1, self.config.n_types): + ni = type_to_name_map[i] + nj = type_to_name_map[j] + names = sorted([ni, nj]) + c = chi_type_dictionary[tuple(names)] + + interaction += c * phi[i] * phi[j] / rho0 + incompressibility = 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + return incompressibility + interaction + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + t, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + + V_interaction = 0.0 + nk = type_to_name_map[t] + for i in range(self.config.n_types): + ni = type_to_name_map[i] + names = sorted([nk, ni]) + if ni != nk: + c = chi_type_dictionary[tuple(names)] + else: + c = 0.0 + # uncomment to count diagonal chi terms: + # c = chi_type_dictionary[tuple(names)] + V_interaction += c * phi[i] / rho0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[t])) + for t in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +def get_hamiltonian(config): + """Return appropriate Hamiltonian object based on the + config.hamiltonian string. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ---------- + hamiltonian : Hamiltonian + Hamiltonian object. + """ + if config.hamiltonian.lower() == "defaultnochi": + hamiltonian = DefaultNoChi(config) + elif config.hamiltonian.lower() == "defaultwithchi": + hamiltonian = DefaultWithChi( + config, config.unique_names, config.type_to_name_map + ) + elif config.hamiltonian.lower() == "squaredphi": + hamiltonian = SquaredPhi(config) + + return hamiltonian +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/_modules/hymd/input_parser.html b/v1.0.3/_modules/hymd/input_parser.html new file mode 100644 index 00000000..acb0d5e7 --- /dev/null +++ b/v1.0.3/_modules/hymd/input_parser.html @@ -0,0 +1,1623 @@ + + + + + + hymd.input_parser — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.input_parser

+"""Parses and handles the configuration information provided for the simulation
+"""
+import copy
+import tomli
+import datetime
+import logging
+import warnings
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass, field
+from typing import List, Union, ClassVar
+from .force import Bond, Angle, Dihedral, Chi, Dielectric_type, propensity_potential_coeffs
+from .barostat import Target_pressure
+from .logger import Logger
+
+
+
[docs]@dataclass +class Config: + """Configuration object + + Handles and verifies the simulation configuration specified in the + configuration file. + + Attributes + ---------- + gas_constant : float + Constant value of the gas constant, R (equivalently the Boltzmann + constant) in the units used internally in HyMD. + coulomb_constant : float + Constant value of the Coulomb constant which converts electric field + values to forces and electric potential values to energies in the units + used internally in HyMD. + n_steps: int + Number of time steps in the simulation. + time_step: float + *Outer* time step used in the simulation. If the rRESPA intergrator is + used, the *inner* time step (the time step used in the integration of + intramolecular bending, stretching, and torsional forces) is + :code:`time_step / respa_inner`. + box_size : list[float] or (D,) numpy.ndarray + Simulation box size of simulation in :code:`D` dimensions in units of + nanometers. + mesh_size : list[int] or int or numpy.ndarray + Number of grid points used for the discrete density grid. + sigma : float + Filter width representing the effective coarse-graining level of the + particles in the simulation. + kappa : float + Compressibility parameter used in the relaxed incompressibility term in + the interaction energy functional. + n_print : int, optional + Frequency of trajectory/energy output to the H5MD trajectory/energy + output file (in units of number of time steps). + tau : float, optional + The time scale of the CSVR thermostat coupling. + start_temperature : float, optional + Generate starting temperature by assigning all particle velocities + randomly according to the Maxwell-Boltzmann distribution at + :code:`start_temperature` Kelvin prior to starting the simulation. + target_temperature : float, optional + Couple the system to a heat bath at :code:`target_temperature` Kelvin. + mass : float, optional + Mass of the particles in the simulation. + hamiltonian : str, optional + Specifies the interaction energy functional :math:`W[\\tilde\\phi]` + for use with the particle-field interactions. Options: + :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`. + domain_decomposition : int, optional + Specifies the interval (in time steps) of domain decomposition + exchange, involving all MPI ranks sending and receiving particles + according to the particles’ positions in the integration box and the + MPI ranks’ assigned domain. + integrator : str, optional + Specifies the time integrator used in the simulation. Options: + :code:`velocity-verlet` or :code:`respa`. + respa_inner : int, optional + The number of inner time steps in the rRESPA integrator. This denotes + the number of intramolecular force calculations (stretching, bending, + torsional) are performed between each impulse applied from the field + forces. + file_name : str, optional + File path of the parsed configuration file. + name : str, optional + Name for the simulation. + tags : list[str], optional + Tags for the simulation. + bonds : list[Bond], optional + Specifies harmonic stretching potentials between particles in the + same molecule. + angle_bonds : list[Angle], optional + Specifies harmonic angular bending potentials between particles in the + same molecule. + dihedrals : list[Dihedral], optional + Specifies four-particle torsional potentials by cosine series. + chi : list[Chi], optional + Specifies :math:`\\chi`-interaction parameters between particle + species. + n_particles : int, optional + Specifies the total number of particles in the input. Optional keyword + for validation, ensuring the input HDF5 topology has the correct number + of particles and molecules. + max_molecule_size : int, optional + Maximum size of any single molecule in the system. Used to speed up + distribution of particles onto MPI ranks in a parallel fashion. + n_flush : int, optional + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be + written to disk (in units of number of :code:`n_print`). + thermostat_work : float + Work performed by the thermostat on the system. + thermostat_coupling_groups : list[str], optional + Specifies individual groups coupling independently to the CSVR + thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and + :code:`"C"` type particles, + :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would + thermalise types :code:`"A"` and :code:`"B"` together and couple + :code:`"C"` type particles to a different thermostat (all individual + thermostats are at the same temperature, i.e. target_temperature + Kelvin). + initial_energy : float + Value of the total energy prior to the start of the simulation. + cancel_com_momentum : int, optional + If :code:`True`, the total linear momentum of the center of mass is + removed before starting the simulation. If an integer is specifed, the + total linear momentum of the center of mass is removed every + :code:`remove_com_momentum` time steps. If :code:`False`, the linear + momentum is never removed. + coulombtype : str, optional + Specifies the type of electrostatic Coulomb interactions in the system. + The strength of the electrostatic forces is modulated by the relative + dielectric constant of the simulation medium, specified with the + :code:`dielectric_const` keyword. Charges for individual particles are + specified in the structure/topology HDF5 input file, not in the + configuration file. If no charges (or peptide backbone dipoles) are + present, the electrostatic forces will not be calculated even if this + keyword is set to :code:`"PIC_Spectral"`. + dielectric_const : float, optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. When + using helical propensity dihedrals, this keyword must be specified—even + if electrostatics are not included with the :code:`coulombtype` + keyword. + dielectric_type: list[float], optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. The list assigns + relative dielectric values to each bead type, and an anisotropic + dielectric function is obtained from a weighted average. + + + See also + -------- + hymd.input_parser.Bond : + Two-particle bond type dataclass. + hymd.input_parser.Angle : + Three-particle bond type dataclass. + hymd.input_parser.Dihedral : + Four-particle bond type dataclass. + """ + + gas_constant: ClassVar[float] = 0.0083144621 # kJ mol-1 K-1 + coulomb_constant: ClassVar[float] = 138.935458 # kJ nm mol-1 e-2 + + n_steps: int + time_step: float + mesh_size: Union[Union[List[int], np.ndarray], int] + sigma: float + kappa: float + + dtype: np.dtype = None + box_size: Union[List[float], np.ndarray] = None + n_print: int = None + tau: float = None + start_temperature: Union[float, bool] = None + target_temperature: Union[float, bool] = None + mass: float = None + hamiltonian: str = None + domain_decomposition: Union[int, bool] = None + integrator: str = None + respa_inner: int = 1 + file_name: str = "<config file path unknown>" + name: str = None + tags: List[str] = field(default_factory=list) + bonds: List[Bond] = field(default_factory=list) + angle_bonds: List[Angle] = field(default_factory=list) + dihedrals: List[Dihedral] = field(default_factory=list) + chi: List[Chi] = field(default_factory=list) + n_particles: int = None + max_molecule_size: int = None + n_flush: int = None + thermostat_work: float = 0.0 + thermostat_coupling_groups: List[List[str]] = field(default_factory=list) + initial_energy: float = None + cancel_com_momentum: Union[int, bool] = False + coulombtype: str = None + convergence_type: str = None + pol_mixing: float = None + dielectric_const: float = None + conv_crit: float = None + dielectric_type: List[Dielectric_type] = field(default_factory=list) + self_energy: float = None + type_charges: Union[List[float], np.ndarray] = None + + # For NPT runs + rho0: float = None + a: float = None + pressure: bool = False + barostat: str = None + barostat_type: str = None + tau_p: float = None + target_pressure: List[Target_pressure] = field(default_factory=list) + n_b: int = None + m: List[float] = field(default_factory=list) + + def __str__(self): + target_pressure_str = "\ttarget_pressure:\n" + "".join( + "\t\tP_L: " + + f"{self.target_pressure.P_L}\n" + + "\t\tP_N: " + + f"{self.target_pressure.P_N}\n" + ) + bonds_str = "\tbonds:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " f"{k.equilibrium}, {k.strength}\n") + for k in self.bonds + ] + ) + angle_str = "\tangle_bonds:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3}: " + + f"{k.equilibrium}, {k.strength}\n" + ) + for k in self.angle_bonds + ] + ) + dihedrals_str = "\tdihedrals:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: " + # This might need to be fixed/made prettier, probably + # there's an easier way + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ).join( + map( + str, + [ + [round(num, 3) for num in c_in] + if isinstance(c_in, list) + else c_in + for c_in in k.coeffs + ], + ) + ) + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ) + + f"dih_type = {k.dih_type}\n" + ) + for k in self.dihedrals + ] + ) + chi_str = "\tchi:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " + f"{k.interaction_energy}\n") + for k in self.chi + ] + ) + + """ If dielectric wanted as dictionary + dielectric_type_str = "\tdielectric_type:\n" + "".join( + [ + (f"\t\t{k.atom_1}: " + f"{k.dielectric_value}\n") + for k in self.dielectric_type + ] + ) + + """ + + thermostat_coupling_groups_str = "" + if any(self.thermostat_coupling_groups): + thermostat_coupling_groups_str = ( + "\tthermostat_coupling_groups:\n" + + "".join( + [ + "\t\t" + ", ".join([f"{n}" for n in ng]) + "\n" + for ng in self.thermostat_coupling_groups + ] + ) + ) + + ret_str = f'\n\n\tConfig: {self.file_name}\n\t{50 * "-"}\n' + for k, v in self.__dict__.items(): + if k not in ( + "target_pressure", + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "thermostat_coupling_groups", + ): + ret_str += f"\t{k}: {v}\n" + ret_str += ( + target_pressure_str + + bonds_str + + angle_str + + dihedrals_str + + chi_str + + thermostat_coupling_groups_str + ) + return ret_str
+ + +
[docs]def read_config_toml(file_path): + with open(file_path, "r") as in_file: + file_content = in_file.read() + return file_content
+ +
[docs]def parse_config_toml(toml_content, file_path=None, comm=MPI.COMM_WORLD): + config_dict = {} + + # read toml to a dictionary + toml_content = tomli.loads(toml_content) + + # Defaults = None + for n in ( + "box_size", + "n_print", + "tau", + "start_temperature", + "target_temperature", + "mass", + "hamiltonian", + "domain_decomposition", + "integrator", + "name", + "n_particles", + "max_molecule_size", + "coulombtype", + "convergence_type", + "dielectric_const", + "pol_mixing", + "conv_crit", + "dielectric_type", + "n_b", + "box_size", + "n_flush", + "self_energy", + "dtype", + ): + config_dict[n] = None + + # Defaults = [] + + for n in ( + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "tags", + "m", + "dielectric_type", + "target_pressure", + "type_charges", + ): + config_dict[n] = [] + + # Defaults: bool + config_dict["pressure"] = False + + # Flatten the .toml dictionary, ignoring the top level [tag] directives (if + # any). + for k, v in toml_content.items(): + if isinstance(v, dict): + if k == "nn": # Don't parse diff-hymd optimization options + continue + for nested_k, nested_v in v.items(): + config_dict[nested_k] = nested_v + else: + config_dict[k] = v + for k, v in config_dict.items(): + if k == "bonds": + config_dict["bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["bonds"][i] = Bond( + atom_1=b[0], + atom_2=b[1], + equilibrium=b[2], + strength=b[3], + ) + if k == "angle_bonds": + config_dict["angle_bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["angle_bonds"][i] = Angle( + atom_1=b[0], + atom_2=b[1], + atom_3=b[2], + equilibrium=b[3], + strength=b[4], + ) + if k == "dihedrals": + config_dict["dihedrals"] = [None] * len(v) + for i, b in enumerate(v): + try: + dih_type = int(b[2][0]) + except IndexError: + Logger.rank0.log( + logging.WARNING, "Dihedral type not provided, defaulting to 0." + ) + dih_type = 0 + + # Probably it's better to move this in check_dihedrals? + wrong_len = len(b[1]) not in (1, 2) + wrong_type_1 = len(b[1]) == 1 and not isinstance(b[1][0], float) + wrong_type_2 = len(b[1]) == 2 and not isinstance(b[1][0], list) + if wrong_len or wrong_type_1 or wrong_type_2: + err_str = ( + "The coefficients specified for the dihedral type " + "(0) do not match the correct structure. Either " + "use [lambda] or [[cn_prop], [dn_prop]], or select" + " the correct dihedral type." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise RuntimeError(err_str) + + # FIXME: this is messy af, I don't like it + if dih_type == 0 and isinstance(b[1][0], (float, int)): + coeff = propensity_potential_coeffs(b[1][0]) + elif dih_type == 1 and len(b[1]) == 3: + coeff = np.array( + propensity_potential_coeffs(b[1][0][0]).tolist() + + b[1][1:] + ) + elif dih_type == 2: + coeff = np.array(b[1]) + else: + coeff = np.insert(np.array(b[1]), 2, np.zeros((2, 5)), axis=0) + + config_dict["dihedrals"][i] = Dihedral( + atom_1=b[0][0], + atom_2=b[0][1], + atom_3=b[0][2], + atom_4=b[0][3], + coeffs=coeff, + dih_type=dih_type, + ) + if k == "chi": + config_dict["chi"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0], c[1]]) + config_dict["chi"][i] = Chi( + atom_1=c_[0], atom_2=c_[1], interaction_energy=c[2] + ) + + """ + if k == "dielectric_type": + config_dict["dielectric_type"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0][0]]) + config_dict["dielectric_type"][i] = Dielectric_type( + atom_1=c_[0], dielectric_value=c[1][0] + ) + """ + if k == "target_pressure": + if len(v) == 2: + config_dict["target_pressure"] = Target_pressure( + P_L=v[0], + P_N=v[1], # check condition # V array (still read as array?) + ) + elif len(v) == 1: + config_dict["target_pressure"] = Target_pressure(P_L=v[0], P_N=None) + else: + config_dict["target_pressure"] = Target_pressure(P_L=None, P_N=None) + + if file_path is not None: + config_dict["file_name"] = file_path + + for n in ( + "n_steps", "time_step", "mesh_size", "sigma", "kappa" + ): + if n not in config_dict: + err_str = ( + f"No {n} specified in config file {file_path}. Unable to start" + f" simulation." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return Config(**config_dict)
+ + +
[docs]def check_n_particles(config, indices, comm=MPI.COMM_WORLD): + n_particles = comm.allreduce(len(indices), MPI.SUM) + if config.n_particles is None: + config = copy.deepcopy(config) + config.n_particles = n_particles + info_str = ( + f"No n_particles found in toml file {config.file_name}, defaulting" + f" to indices.shape ({n_particles})" + ) + Logger.rank0.log(logging.INFO, info_str) + return config + + if n_particles != config.n_particles: + warn_str = ( + f"n_particles in {config.file_name} ({config.n_particles}) does " + "not match the shape of the indices array in the .HDF5 file " + f"({n_particles}). Defaulting to using indices.shape " + f"({n_particles})" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.n_particles = n_particles + return config
+ + +
[docs]def check_max_molecule_size(config, comm=MPI.COMM_WORLD): + if config.max_molecule_size is None: + info_str = ( + f"No max_molecule_size found in toml file {config.file_name}, " + f"defaulting to 201" + ) + Logger.rank0.log(logging.INFO, info_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + + if config.max_molecule_size < 1: + warn_str = ( + f"max_molecule_size in {config.file_name} must be a positive " + f"integer, not {config.max_molecule_size}, defaulting to 201" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + return config
+ + +def _find_unique_names(config, names, comm=MPI.COMM_WORLD): + unique_names = np.unique(names) + receive_buffer = comm.gather(unique_names, root=0) + + gathered_unique_names = None + if comm.Get_rank() == 0: + gathered_unique_names = np.unique(np.concatenate(receive_buffer)) + unique_names = comm.bcast(gathered_unique_names, root=0) + unique_names = sorted([n.decode("UTF-8") for n in unique_names]) + config.unique_names = unique_names + config.n_types = len(unique_names) + return config + + +def _setup_type_to_name_map(config, names, types, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + name_to_type_ = {} + for n, t in zip(names, types): + n = n.decode("utf-8") + if n not in name_to_type_: + name_to_type_[n] = t + receive_buffer = comm.gather(name_to_type_, root=0) + gathered_dict = None + if comm.Get_rank() == 0: + gathered_dict = {} + for d in receive_buffer: + for k, v in d.items(): + if k not in gathered_dict: + gathered_dict[k] = v + else: + assert v == gathered_dict[k] + name_to_type_map = comm.bcast(gathered_dict, root=0) + config.name_to_type_map = name_to_type_map + config.type_to_name_map = {v: k for k, v in name_to_type_map.items()} + return config + + +
[docs]def check_bonds(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for b in config.bonds: + if b.atom_1 not in unique_names or b.atom_2 not in unique_names: + missing_str = "" + if b.atom_1 not in unique_names: + if b.atom_2 not in unique_names: + if b.atom_1 == b.atom_2: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"neither {b.atom_1}, {b.atom_2} atoms" + else: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"no {b.atom_2} atoms" + + warn_str = ( + f"Bond type {b.atom_1}--{b.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_angles(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for a in config.angle_bonds: + if ( + a.atom_1 not in unique_names + or a.atom_2 not in unique_names + or a.atom_3 not in unique_names + ): + missing = [ + a.atom_1 not in unique_names, + a.atom_2 not in unique_names, + a.atom_3 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([a.atom_1, a.atom_2, a.atom_3]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Angle bond type {a.atom_1}--{a.atom_2}--{a.atom_3} " + f"specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_dihedrals(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for d in config.dihedrals: + if ( + d.atom_1 not in unique_names + or d.atom_2 not in unique_names + or d.atom_3 not in unique_names + or d.atom_4 not in unique_names + ): + missing = [ + d.atom_1 not in unique_names, + d.atom_2 not in unique_names, + d.atom_3 not in unique_names, + d.atom_4 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([d.atom_1, d.atom_2, d.atom_3, d.atom_4]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Dihedral type {d.atom_1}--{d.atom_2}--{d.atom_3}--{d.atom_4}" + f" specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_chi(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for c in config.chi: + if c.atom_1 not in unique_names or c.atom_2 not in unique_names: + missing_str = "" + if c.atom_1 not in unique_names: + if c.atom_2 not in unique_names: + if c.atom_1 == c.atom_2: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"neither {c.atom_1}, {c.atom_2} atoms" + else: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"no {c.atom_2} atoms" + + warn_str = ( + f"Chi interaction {c.atom_1}--{c.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + for i, n in enumerate(unique_names): + for m in unique_names[i + 1 :]: + found = False + for c in config.chi: + if (c.atom_1 == n and c.atom_2 == m) or ( + c.atom_1 == m and c.atom_2 == n + ): + found = True + if not found: + config.chi.append(Chi(atom_1=n, atom_2=m, interaction_energy=0.0)) + warn_str = ( + f"Atom types {n} and {m} found in the " + f"system, but no chi interaction {n}--{m} " + f"specified in {config.file_name}. Defaulting to " + f"chi[{n}, {m}] = 0" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_box_size(config, input_box, comm=MPI.COMM_WORLD): + if config.box_size is not None: + config.box_size = np.array(config.box_size, dtype=np.float32) + if input_box.all() and not np.allclose(config.box_size, input_box, atol=0.009): + err_str = ( + f"Box size specified in {config.file_name}: " + f"{config.box_size} does not match input box:" + f"{input_box}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + else: + if input_box.all(): + config.box_size = input_box + else: + err_str = f"No box information found" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + for b in config.box_size: + if b <= 0.0: + err_str = ( + f"Invalid box size specified in {config.file_name}: " + f"{config.box_size}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return config
+ + +
[docs]def check_integrator(config, comm=MPI.COMM_WORLD): + if config.integrator.lower() not in ("velocity-verlet", "respa"): + err_str = ( + f"Invalid integrator specified in {config.file_name}: " + f'{config.integrator}. Available options "velocity-verlet" or ' + f'"respa".' + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + if config.integrator.lower() == "respa": + if isinstance(config.respa_inner, float): + warn_str = ( + f"Number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner} specified " + f"as float, using {int(config.respa_inner)}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = int(config.respa_inner) + elif not isinstance(config.respa_inner, int): + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + + if config.respa_inner <= 0: + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + if config.integrator.lower() == "velocity-verlet" and config.respa_inner != 1: + warn_str = ( + f"Integrator type Velocity-Verlet specified in {config.file_name} " + f"and inner rRESPA time steps set to {config.respa_inner}. " + f"Using respa_inner = 1" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = 1 + + return config
+ + +
[docs]def check_hamiltonian(config, comm=MPI.COMM_WORLD): + valid_hamiltonians = ["defaultnochi", "defaultwithchi", "squaredphi"] + + if config.hamiltonian is None: + if len(config.chi) == 0: + warn_str = ( + f"No hamiltonian form and no chi interactions specified in " + f"{config.file_name}, defaulting to DefaultNoChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultNoChi" + else: + warn_str = ( + f"No hamiltonian form specified in {config.file_name}, but " + f"chi interactions are specified, defaulting to " + f"DefaultWithChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultWithChi" + elif config.hamiltonian.lower() not in valid_hamiltonians: + err_str = ( + f"The specified Hamiltonian {config.hamiltonian} was not " + f"recognized as a valid Hamiltonian." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise NotImplementedError(err_str) + + return config
+ + +
[docs]def check_n_flush(config, comm=MPI.COMM_WORLD): + if config.n_print: + if config.n_flush is None: + config.n_flush = 10000 // config.n_print + return config
+ + +
[docs]def check_n_print(config, comm=MPI.COMM_WORLD): + if ( + not isinstance(config.n_print, int) + and not isinstance(config.n_print, float) + and config.n_print is not None + ): + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if config.n_print is None or config.n_print <= 0: + config.n_print = False + elif not isinstance(config.n_print, int): + if isinstance(config.n_print, float): + warn_str = ( + f"n_print is a float ({config.n_print}), not int, using " + f"{int(round(config.n_print))}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + config.n_print = int(round(config.n_print)) + else: + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + return config
+ + +
[docs]def check_tau(config, comm=MPI.COMM_WORLD): + if config.tau is None and config.target_temperature is not None: + warn_str = "target temp specified but no tau, defaulting 0.7" + config.tau = 0.7 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_start_and_target_temperature(config, comm=MPI.COMM_WORLD): + """Validate provided starting and target thermostat temperatures + + Assesses the provided temperature target and ensures it is a non-negative + floating point number or :code:`False`. Ensures the starting temperature is + a non-negative floating point number or :code:`False`. + + If the value for either is :code:`None`, the returned configuration object + has the values defaulted to :code:`False` in each case. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ------- + validated_config : Config + Configuration object with validated :code:`target_temperature` and + :code:`start_temperature`. + """ + for t in ("start_temperature", "target_temperature"): + if getattr(config, t) is not None: + try: + if getattr(config, t) < 0: + warn_str = ( + f"{t} set to negative value ({getattr(config, t)}), " + f"defaulting to False" + ) + setattr(config, t, False) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + except TypeError as e: + err_str = ( + f"Could not interpret {t} = {repr(getattr(config, t))} as " + f"a number." + ) + raise TypeError(err_str) from e + + if config.start_temperature is None: + config.start_temperature = False + if config.target_temperature is None: + config.target_temperature = False + return config
+ + +
[docs]def check_mass(config, comm=MPI.COMM_WORLD): + if config.mass is None: + info_str = "no mass specified, defaulting to 72.0" + config.mass = 72.0 + Logger.rank0.log(logging.INFO, info_str) + elif not isinstance(config.mass, int) and not isinstance(config.mass, float): + err_str = ( + f"specified mass is invalid type {config.mass}, " f"({type(config.mass)})" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + elif config.mass < 0: + err_str = f"invalid mass specified, {config.mass}" + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + else: + config.mass = float(config.mass) + + return config
+ + +
[docs]def check_domain_decomposition(config, comm=MPI.COMM_WORLD): + dd = config.domain_decomposition + if dd is None or dd is False: + config.domain_decomposition = False + return config + + if isinstance(dd, int): + if dd < 0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + elif isinstance(dd, float): + if dd < 0.0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + else: + warn_str = ( + f"domain_decomposition ({config.domain_decomposition}) is not " + f"an integer, using {int(round(dd))}" + ) + config.domain_decomposition = int(round(dd)) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + else: + err_str = ( + f"invalid value for domain_decomposition " + f"({config.domain_decomposition}) use an integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + return config
+ + +
[docs]def check_name(config, comm=MPI.COMM_WORLD): + if config.name is None: + root_current_time = "" + if comm.Get_rank() == 0: + root_current_time = datetime.datetime.now().strftime("%m/%d/%Y, %H:%M:%S") + current_time = comm.bcast(root_current_time, root=0) + + if config.name is None: + config.name = "sim" + current_time + else: + config.name = str(config.name) + return config
+ + +
[docs]def check_NPT_conditions(config, comm=MPI.COMM_WORLD): + """ + Check validity of barostat_type, barostat, + a, rho0, target_pressure, tau_p + """ + if config.barostat is None: + if ( + config.tau_p is not None + or (config.target_pressure.P_L and config.target_pressure.P_N) is not None + ): + err_str = ( + "barostat not specified but config.tau_p " + "or config.target_pressure specified, cannot start simulation {config.barostat}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.a: + warn_str = "a specified but no barostat," "setting a to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.rho0: + warn_str = ( + "rho0 specified but no barostat," "setting rho0 to average density" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + if config.barostat is not None: + if not config.barostat_type: + config.barostat_type = "berendsen" + warn_str = "barostat_type not specified," "setting to berendsen" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.barostat != "isotropic" and config.barostat != "semiisotropic": + err_str = "barostat option not recognised. Valid options: isotropic, semiisotropic" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.target_pressure.P_L is None: + config.target_pressure.P_L = 1.0 # bar + config.target_pressure.P_N = None + if config.barostat == "semiisotropic": + config.target_pressure.P_N = 1.0 # bar + warn_str = ( + "barostat specified but no target_pressure, defaulting to 1.0 bar" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.tau_p is None: + if config.tau <= 0.1: + config.tau_p = config.tau * 10.0 + else: + config.tau_p = 1.0 + warn_str = "barostat specified but no tau_p, defaulting to " + str( + config.tau_p + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if not config.a: + err_str = "a not specified; cannot start simulation {config.a}" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if not config.rho0: + warn_str = "rho0 not specified;" "setting rho0 to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + return config
+ + +
[docs]def check_thermostat_coupling_groups(config, comm=MPI.COMM_WORLD): + if any(config.thermostat_coupling_groups): + found = [0 for _ in config.unique_names] + unique_names = [n for n in config.unique_names] + for i, group in enumerate(config.thermostat_coupling_groups): + for species in group: + try: + ind = unique_names.index(species) + found[ind] += 1 + except ValueError as e: + err_str = ( + f"Particle species {species} specified in thermostat " + f"coupling group {i}, but no {species} particles were " + "found in the system." + ) + raise ValueError(err_str) from e + if any([True if f > 1 else False for f in found]): + for i, f in enumerate(found): + if f > 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} specified in multiple " + "thermostat coupling groups; " + f"{config.thermostat_coupling_groups}." + ) + raise ValueError(err_str) + if not all([True if f == 1 else False for f in found]): + for i, f in enumerate(found): + if f != 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} not specified in any " + f"thermostat coupling group, but {species} particles " + "were found in the system" + ) + raise ValueError(err_str) + return config
+ + +
[docs]def check_m(config, comm=MPI.COMM_WORLD): + if config.m == []: + config.m = [1.0 for t in range(config.n_types)] + return config
+ + +
[docs]def check_n_b(config, comm=MPI.COMM_WORLD): + if config.n_b is None: + warn_str = f"config.n_b not specified." "Defaulting to 1" + config.n_b = 1 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_cancel_com_momentum(config, comm=MPI.COMM_WORLD): + if isinstance(config.cancel_com_momentum, int): + if config.cancel_com_momentum == 0 or config.cancel_com_momentum < 0: + config.cancel_com_momentum = False + elif not isinstance(config.cancel_com_momentum, bool): + err_str = ( + f"Could not interpret {config.cancel_com_momentum} as an integer " + f"or boolean." + ) + raise ValueError(err_str) + return config
+ + +
[docs]def sort_dielectric_by_type_id(config, charges, types): + """ + Creates a list of length N CG-particles, sorted after the charges from + the input HDF5 file. Used in file_io.py + """ + dielectric_val = np.zeros(config.n_types) + for j in range(config.n_types): + name = config.dielectric_type[j][0][0] + type_id = config.name_to_type_map[name] + dielectric_val[type_id] = config.dielectric_type[j][1][0] + config.dielectric_type = dielectric_val.copy() + + N = len(charges) + len_list = np.zeros(config.n_types) + dielectric_by_types = np.zeros(N) + for i in range(N): + dielectric_by_types[i] = dielectric_val[types[i]] + # print("types ", types) + # print("diel val", dielectric_by_types) + # print("charges", charges) + # print(config.name_to_type_map) + return dielectric_by_types # by types with each particle id
+ + +
[docs]def check_charges_types_list(config, types, charges, comm=MPI.COMM_WORLD): + """ + Creates a list of charge values of length types. + Charges are sorted according to type ID. Used in field.py. + # TODO: this is messy, we should fix it + """ + if charges is None: + config.type_charges = [0.0] * config.n_types + return config + + check_val = -100.0 # some random value that will never be encountered + charges_list = np.full(config.n_types, check_val) # gatherv cant handle None + rank = comm.Get_rank() + # print(charges_list) + for t_ in range(config.n_types): + if t_ in types: + charges_list[t_] = charges[types == t_][0] + + nprocs = int(comm.Get_size()) + recv_charges = None + if rank == 0: + recv_charges = np.full( + config.n_types * nprocs, check_val + ) # gatherv cant handle None + comm.Gather(charges_list, recv_charges, root=0) + + ## make a charges list + if rank == 0: + config_charges = np.zeros(config.n_types) + test_config = np.full(config.n_types, check_val) + for j in range(nprocs): + for i in range(config.n_types): + if recv_charges[i + j * config.n_types] != check_val: + config_charges[i] = recv_charges[i + j * config.n_types] + if np.any([test_config, config_charges]): + continue + else: + break + + # print(config_charges) + # print(config.name_to_type_map) + # print(charges[types == 0][0],charges[types == 1][0],charges[types == 2][0],charges[types == 3][0], + # charges[types == 4][0]) + else: + config_charges = np.zeros(config.n_types) + + comm.Bcast(config_charges, root=0) + # print("config_charges", config_charges , "rank", rank) + # print(recv_charges) + # rank = comm.Get_rank() + # print(all_charges) + config.type_charges = config_charges + return config
+ + +
[docs]def check_dielectric(config, comm=MPI.COMM_WORLD): + """ + Error handling for electrostatics. + Unit testing of toml/tomli input. + """ + err_str_const = "Dielectric constant not given." + if config.coulombtype == "PIC_Spectral": + assert config.dielectric_const != None, err_str_const + + err_str = "Dielectric list is empty." + if config.coulombtype == "PIC_Spectral_GPE": + assert len(config.dielectric_type) != 0, err_str + # default values + if config.pol_mixing is None: + config.pol_mixing = 0.6 + if config.conv_crit is None: + config.conv_crit = 1e-6 + return config
+ + +
[docs]def check_charges(config, charges, comm=MPI.COMM_WORLD): + """Check if charges across ranks sum to zero. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of floats with charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + """ + total_charge = comm.allreduce(np.sum(charges), MPI.SUM) + + if not np.isclose(total_charge, 0.0): + warn_str = ( + f"Charges in the input file do not sum to zero. " + f"Total charge is {total_charge}." + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + # if charges are ok, compute self energy + if config.coulombtype == "PIC_Spectral": + from .field import compute_self_energy_q + + config.self_energy = compute_self_energy_q(config, charges, comm=comm) + + return config
+ + +
[docs]def check_config( + config, indices, names, types, charges, input_box, comm=MPI.COMM_WORLD +): + """Performs various checks on the specfied config to ensure consistency + + Parameters + ---------- + config : Config + Configuration object. + indices : (N,) numpy.ndarray + Array of integer indices for :code:`N` particles. + names : (N,) numpy.ndarray + Array of string names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of integer type indices for :code:`N` particles. + charges : (N,) numpy.ndarray + Array of floats charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + + Returns + ------- + config : Config + Validated configuration object. + """ + config = _find_unique_names(config, names, comm=comm) + if types is not None: + config = _setup_type_to_name_map(config, names, types, comm=comm) + config = check_box_size(config, input_box, comm=comm) + config = check_integrator(config, comm=comm) + config = check_max_molecule_size(config, comm=comm) + config = check_tau(config, comm=comm) + config = check_start_and_target_temperature(config, comm=comm) + config = check_mass(config, comm=comm) + config = check_domain_decomposition(config, comm=comm) + config = check_name(config, comm=comm) + config = check_n_particles(config, indices, comm=comm) + config = check_chi(config, names, comm=comm) + config = check_bonds(config, names, comm=comm) + config = check_angles(config, names, comm=comm) + config = check_dihedrals(config, names, comm=comm) + config = check_hamiltonian(config, comm=comm) + config = check_NPT_conditions(config, comm=comm) + config = check_n_b(config, comm=comm) + config = check_m(config, comm=comm) + config = check_thermostat_coupling_groups(config, comm=comm) + config = check_cancel_com_momentum(config, comm=comm) + config = check_dielectric(config, comm=comm) + config = check_n_print(config, comm=comm) + config = check_n_flush(config, comm=comm) + config = check_charges_types_list(config, types, charges, comm=comm) + if charges is not None: + config = check_charges(config, charges, comm=comm) + + return config
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/_modules/hymd/integrator.html b/v1.0.3/_modules/hymd/integrator.html new file mode 100644 index 00000000..164ece6f --- /dev/null +++ b/v1.0.3/_modules/hymd/integrator.html @@ -0,0 +1,346 @@ + + + + + + hymd.integrator — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.integrator

+"""Integrates equations of motion.
+
+Implements the Velocity Verlet integrator. The *reversible reference system
+propagator algorithm* (rRESPA) integrator uses the Velocity Verlet functions
+inside the MD loop in the main module.
+"""
+
+
+
[docs]def integrate_velocity(velocities, accelerations, time_step): + """Velocity update step of the Velocity Verlet integration algorithm. + + Computes the velocity update step of the Velocity Verlet algorithm. The + :code:`velocities` argument is **not** changed in place. + + Parameters + ---------- + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + accelerations : (N, D) numpy.ndarray + Array of accelerations of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step + + .. math:: \\mathbf{v}_{\\text{new}} = \\mathbf{v} + \\frac{\\Delta t}{2m} + \\mathbf{f} + + before the positions are moved a full step using the updated half-step + velocities. + + See Also + -------- + integrate_position : The position update step of the Velocity Verlet + algorithm. + """ + return velocities + 0.5 * time_step * accelerations
+ + +
[docs]def integrate_position(positions, velocities, time_step): + """Position update step of the Velocity Verlet integration algorithm. + + Computes the position update step of the Velocity Verlet algorithm. The + :code:`positions` argument is **not** changed in place. + + Parameters + ---------- + positions : (N, D) numpy.ndarray + Array of positions of :code:`N` particles in :code:`D` dimensions. + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step, then the positions are updated a full step using the updated + velocities + + .. math:: \\mathbf{x}_{\\text{new}} = \\mathbf{x} + \\Delta t \\mathbf{v} + + See Also + -------- + integrate_velocity : The velocity update step of the Velocity Verlet + algorithm. + """ + return positions + time_step * velocities
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/_modules/hymd/logger.html b/v1.0.3/_modules/hymd/logger.html new file mode 100644 index 00000000..d8e76027 --- /dev/null +++ b/v1.0.3/_modules/hymd/logger.html @@ -0,0 +1,535 @@ + + + + + + hymd.logger — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.logger

+"""Handles event logging for simulation information, warnings, and errors.
+"""
+import sys
+import os
+import logging
+from mpi4py import MPI
+from .version import __version__
+
+
+
[docs]class MPIFilterRoot(logging.Filter): + """Log output Filter wrapper class for the root MPI rank log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + if self.comm.Get_rank() == 0: + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True + else: + return False
+ + +
[docs]class MPIFilterAll(logging.Filter): + """Log output Filter wrapper class for the all-MPI-ranks log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True
+ + +class MPIFilterStdout(logging.Filter): + """Log output Filter wrapper class for filtering STDOUT log""" + + def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.funcName = "replica 0 " + record.funcName + if MPI.COMM_WORLD.Get_rank() == 0: + record.rank = MPI.COMM_WORLD.Get_rank() + record.size = MPI.COMM_WORLD.Get_size() + return True + else: + return False + + +
[docs]class Logger: + """Log output handler class + + Notes + ----- + This wraps the default python library :code:`logging`, see + `docs.python.org/3/library/logging.html`_. + + .. _`docs.python.org/3/library/logging.html`: + https://docs.python.org/3/library/logging.html + + Attributes + ---------- + level : int + Determines the verbosity level of the log, corresponding to + logging.level. Numerical values :code:`50` (:code:`logging.CRITICAL`), + :code:`40` (:code:`logging.ERROR`), :code:`30` + (:code:`logging.WARNING`), :code:`20` (:code:`logging.INFO`), + :code:`10` (:code:`logging.DEBUG`), and :code:`0` + (:code:`logging.UNSET`) are supported values. Any log event message + less severe than the specified level is ignored. All other event + messages are emitted. + log_file : str + Path to output log file. + format : str + Prepended dump string for each log event. Specifies the log event + level, the module emitting the event, the code line, the enclosing + function name, and the MPI rank writing the message. + date_format : str + Prepends the date before all log event messages. + formatter : logging.Formatter + Formatter handling the prepending of the information in `format` and + `date_format` to each log event message. Used by default for all + loggers. + rank0 : logging.Logger + Default logger object for the root MPI rank. + all_ranks : logging.Logger + Default logger object for messages being emitted from all MPI ranks + simultaneously. + """ + + level = None + log_file = None + format = " %(levelname)-8s [%(filename)s:%(lineno)d] <%(funcName)s> {rank %(rank)d/%(size)d} %(message)s" # noqa: E501 + date_format = "%(asctime)s" + formatter = logging.Formatter(fmt=date_format + format) + rank0 = logging.getLogger("HyMD.rank_0") + all_ranks = logging.getLogger("HyMD.all_ranks") + +
[docs] @classmethod + def setup(cls, default_level=logging.INFO, log_file=None, verbose=False, comm=MPI.COMM_WORLD): + """Sets up the logger object. + + If a :code:`log_file` path is provided, log event messages are output + to it. Otherwise, the logging messages are emitted to stdout. + + Parameters + ---------- + default_level : int, optional + Default verbosity level of the logger. Unless specified, it is + :code:`10` (:code:`logging.INFO`). + log_file : str, optional + Path to output log file. If `None` or not priovided, no log file is + used and all logging is done to stdout. + verbose : bool, optional + Increases the logging level to :code:`30` (:code:`logging.WARNING`) + if True, otherwise leaves the logging level unchanged. + """ + cls.level = default_level + cls.log_file = log_file + + log_to_stdout = False + if verbose: + log_to_stdout = True + + level = default_level + if not verbose: + level = logging.WARNING + cls.rank0.setLevel(level) + cls.all_ranks.setLevel(level) + + root_filter = MPIFilterRoot(comm) + all_filter = MPIFilterAll(comm) + cls.rank0.addFilter(root_filter) + cls.all_ranks.addFilter(all_filter) + + if (not log_file) and (not log_to_stdout): + return + if log_file: + cls.log_file_handler = logging.FileHandler(log_file) + cls.log_file_handler.setLevel(level) + cls.log_file_handler.setFormatter(cls.formatter) + + cls.rank0.addHandler(cls.log_file_handler) + cls.all_ranks.addHandler(cls.log_file_handler) + if log_to_stdout: + cls.log_to_stdout = True + cls.stdout_handler = logging.StreamHandler() + cls.stdout_handler.setLevel(level) + cls.stdout_handler.setStream(sys.stdout) + cls.stdout_handler.setFormatter(cls.formatter) + cls.stdout_handler.addFilter(MPIFilterStdout()) + + cls.rank0.addHandler(cls.stdout_handler) + cls.all_ranks.addHandler(cls.stdout_handler)
+ + +def format_timedelta(timedelta): + days = timedelta.days + hours, rem = divmod(timedelta.seconds, 3600) + minutes, seconds = divmod(rem, 60) + microseconds = timedelta.microseconds + ret_str = "" + if days != 0: + ret_str += f"{days} days " + ret_str += f"{hours:02d}:{minutes:02d}:{seconds:02d}.{microseconds:06d}" + return ret_str + + +def get_version(): + # Check if we are in a git repo and grab the commit hash and the branch if + # we are, append it to the version number in the output specification. + try: + import git + + try: + repo_dir = os.path.abspath( + os.path.join(os.path.dirname(__file__), os.pardir) + ) + repo = git.Repo(repo_dir) + commit = str(repo.head.commit)[:7] + branch = repo.active_branch + version = f"{__version__} [{branch} branch commit {commit}]" + except git.exc.InvalidGitRepositoryError: + version = f"{__version__}" + except ModuleNotFoundError: + version = f"{__version__}" + + return version + + +def print_header(): + banner = r""" + __ __ ____ __ _______ + / / / /_ __/ / /__ _________ _____ ______ / |/ / __ \ + / /_/ / / / / / / _ \/ ___/ __ `/ __ `/ ___/ / /|_/ / / / / + / __ / /_/ / / / __/ / / /_/ / /_/ (__ ) / / / / /_/ / + /_/ /_/\__, /_/_/\___/_/ \__,_/\__,_/____/ /_/ /_/_____/ + /____/ + """ + + refs_set = """ + + [1] Ledum, M.; Sen, S.; Li, X.; Carrer, M.; Feng Y.; Cascella, M.; Bore, S. L. + HylleraasMD: A Domain Decomposition-Based Hybrid Particle-Field Software for Multi-Scale Simulations of Soft Matter. + J. Chem. Theory Comput. 2023. + + [2] Ledum, M.; Carrer, M.; Sen, S.; Li, X.; Cascella, M.; Bore, S. L. + HyMD: Massively parallel hybrid particle-field molecular dynamics in Python. + J. Open Source Softw. 8(84), 4149, 2023. + + [3] Sen, S.; Ledum, M.; Bore, S. L.; Cascella, M. + Soft Matter under Pressure: Pushing Particle–Field Molecular Dynamics to the Isobaric Ensemble. + J Chem Inf Model 2023, 63(7), 1549-9596. + + [4] Bore, S. L.; Cascella, M. + Hamiltonian and alias-free hybrid particle–field molecular dynamics. + J. Chem. Phys. 2020, 153, 094106. + + [5] Pippig, M. PFFT: An extension of FFTW to massively parallel architectures. + SIAM J. Sci. Comput. 2013, 35, C213–C236. + +""" + + version = f"Version {get_version()}" + header = banner + header += version.center(56) + "\n\n" + #header += " Please read and cite the references below:" + header += " PLEASE READ AND CITE THE REFERENCES BELOW:" + header += refs_set + + return header +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/_modules/hymd/thermostat.html b/v1.0.3/_modules/hymd/thermostat.html new file mode 100644 index 00000000..e2b95502 --- /dev/null +++ b/v1.0.3/_modules/hymd/thermostat.html @@ -0,0 +1,492 @@ + + + + + + hymd.thermostat — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.thermostat

+"""Scales or otherwise modifies the particle velocities during simulation to
+simulate coupling to an external heat bath with temperature T₀.
+"""
+import numpy as np
+import logging
+from mpi4py import MPI
+from typing import Callable
+from .logger import Logger
+from .input_parser import Config
+
+
+def cancel_com_momentum(velocities, config, comm=MPI.COMM_WORLD):
+    com_velocity = comm.allreduce(np.sum(velocities[...], axis=0), MPI.SUM)
+    velocities[...] = velocities[...] - com_velocity / config.n_particles
+    return velocities
+
+
+def generate_initial_velocities(velocities, config, prng, comm=MPI.COMM_WORLD):
+    kT_start = config.gas_constant * config.start_temperature
+    n_particles_ = velocities.shape[0]
+    velocities[...] = prng.normal(
+        loc=0, scale=kT_start / config.mass, size=(n_particles_, 3)
+    )
+    velocities = cancel_com_momentum(velocities, config, comm=comm)
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    start_kinetic_energy_target = (
+        1.5 * config.gas_constant * config.n_particles * config.start_temperature
+    )
+    factor = np.sqrt(1.5 * config.n_particles * kT_start / kinetic_energy)
+    velocities[...] = velocities[...] * factor
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    Logger.rank0.log(
+        logging.INFO,
+        (
+            f"Initialized {config.n_particles} velocities, target kinetic "
+            f"energy: {start_kinetic_energy_target}, actual kinetic energy "
+            f"generated: {kinetic_energy}"
+        ),
+    )
+    return velocities
+
+
+
[docs]def _random_gaussian(prng: np.random.Generator) -> float: + """Draw a single random number from the standard normal distribution + Generate a number from the Gaussian distribution centered at zero with unit + standard deviation, :math:`N(0, 1)`. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + + Returns + ------- + float + A random number drawn from :math:`N(0, 1)`. + """ + return prng.normal()
+ + +
[docs]def _random_chi_squared(prng: np.random.Generator, M: int) -> float: + """Draw the sum of :code:`M` squared normally distributed values + + The value is generated by the Gamma distribution, in lieu of generating + :code:`M` Gaussian distributed numbers and summing their squares. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + M : int + Number of standard normally distributed numbers in the sum. + + Returns + ------- + float + The sum of :code:`M` squared normally distributed values centered at + zero with unit standard deviation. + + Notes + ----- + The sum of the squares of k independent standard normal random variables is + distributed according to a :math:`\\chi^2` distribution. + + .. math:: + + \\chi^2_1 + \\chi_2^2 + \\chi_3^2 + \\dots + \\chi_M^2 + \\sim + \\sigma^2\\chi^2(k) + + This is a special case of the :math:`\\Gamma` distribution, + :math:`\\Gamma(k/2, 2)`, and may be generated by + + .. math:: + + \\chi^2(k) \\sim 2 \\Gamma(k/2, 2) + + References + ---------- + Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of + Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. + J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246. + """ + return prng.chisquare(M)
+ + +
[docs]def csvr_thermostat( + velocity: np.ndarray, + names: np.ndarray, + config: Config, + prng: np.random.Generator, + comm: MPI.Intracomm = MPI.COMM_WORLD, + random_gaussian: Callable[[np.random.Generator], float] = _random_gaussian, + random_chi_squared: Callable[ + [np.random.Generator, int, float], float + ] = _random_chi_squared, + remove_center_of_mass_momentum: bool = True, +) -> np.ndarray: + """Canonical sampling through velocity rescaling thermostat + + Implements the CSVR thermostat. Rescales the system kinetic energy by a + stochastically chosen factor to keep the temperature constant. Requires + communcation of the kinetic energies calculated locally for each MPI rank. + The random numbers sampled through :code:`random_gaussian` and + :code:`random_chi_squared` are broadcast from the root rank to the other + ranks to ensure the scaling is performed with the same stochasticity for + all particles in the full system. + + The velocities are cleaned of center of mass momentum before the thermostat + is applied, and the center of mass momentum is subsequently reapplied. This + is performed for each thermostat coupling group, i.e. the center of mass + momenta of each *group* is separately removed and reapplied after + thermostatting. + + The implementation here is based on the derivation presented in the 2008 + Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper. + + Parameters + ---------- + velocity : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + names : (N,) numpy.ndarray + Array of particle names. + config : Config + Configuration dataclass containing simulation metadata and parameters. + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + random_gaussian : callable, optional + Function for generating standard normally distributed numbers. + random_chi_squared : callable, optional + Function for generating :math:`\\chi^2`-distributed numbers + remove_center_of_mass_momentum : bool, optional + If True, the center of mass of each coupling group is removed before + the thermostat is applied. The center of mass momenta are added back + after the kinetic energy rescaling is complete. + + See Also + -------- + _random_gaussian : + Used to sample Gaussian-distributed numbers. + _random_chi_squared : + Used to sample :math:`\\chi^2`-distributed numbers. + hymd.input_parser.Config : + Configuration dataclass handler. + + References + ---------- + G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). + G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008). + """ + if not any(config.thermostat_coupling_groups): + config.thermostat_coupling_groups = [config.unique_names.copy()] + for i, group in enumerate(config.thermostat_coupling_groups): + ind = np.where( + np.logical_or.reduce(list(names == np.string_(t) for t in group)) + ) + group_n_particles = comm.allreduce(len(ind[0]), MPI.SUM) + + # Clean velocities of center of mass momentum + if remove_center_of_mass_momentum and group_n_particles > 1: + com_velocity = comm.allreduce(np.sum(velocity[ind], axis=0)) + velocity_clean = velocity[ind] - com_velocity / group_n_particles + K = comm.allreduce(0.5 * config.mass * np.sum(velocity_clean[...] ** 2)) + else: + K = comm.allreduce(0.5 * config.mass * np.sum(velocity[...] ** 2)) + K_target = ( + 1.5 * config.gas_constant * group_n_particles * config.target_temperature + ) + N_f = 3 * group_n_particles + c = np.exp(-(config.time_step * config.respa_inner) / config.tau) + + # Random numbers are identical across ranks because all ranks have + # the same prng after the initialization of the velocities + R = random_gaussian(prng) + SNf = random_chi_squared(prng, N_f - 1) + + alpha2 = ( + c + + (1 - c) * (SNf + R**2) * K_target / (N_f * K) + + 2 * R * np.sqrt(c * (1 - c) * K_target / (N_f * K)) + ) + dK = K * (alpha2 - 1) + alpha = np.sqrt(alpha2) + + if remove_center_of_mass_momentum and group_n_particles > 1: + # Assign velocities and reapply the previously removed center + # of mass momentum removed + velocity_clean *= alpha + velocity[ind] = velocity_clean + com_velocity / group_n_particles + else: + velocity *= alpha + config.thermostat_work += dK
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/_modules/index.html b/v1.0.3/_modules/index.html new file mode 100644 index 00000000..36e54af0 --- /dev/null +++ b/v1.0.3/_modules/index.html @@ -0,0 +1,280 @@ + + + + + + Overview: module code — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+ +
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/v1.0.3/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css new file mode 100644 index 00000000..1b057df2 --- /dev/null +++ b/v1.0.3/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css @@ -0,0 +1 @@ +.badge{border-radius:.25rem;display:inline-block;font-size:75%;font-weight:700;line-height:1;padding:.25em .4em;text-align:center;vertical-align:baseline;white-space:nowrap}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{border-radius:10rem;padding-left:.6em;padding-right:.6em}.badge-primary{background-color:#007bff;color:#fff}.badge-primary[href]:focus,.badge-primary[href]:hover{background-color:#0062cc;color:#fff;text-decoration:none}.badge-secondary{background-color:#6c757d;color:#fff}.badge-secondary[href]:focus,.badge-secondary[href]:hover{background-color:#545b62;color:#fff;text-decoration:none}.badge-success{background-color:#28a745;color:#fff}.badge-success[href]:focus,.badge-success[href]:hover{background-color:#1e7e34;color:#fff;text-decoration:none}.badge-info{background-color:#17a2b8;color:#fff}.badge-info[href]:focus,.badge-info[href]:hover{background-color:#117a8b;color:#fff;text-decoration:none}.badge-warning{background-color:#ffc107;color:#212529}.badge-warning[href]:focus,.badge-warning[href]:hover{background-color:#d39e00;color:#212529;text-decoration:none}.badge-danger{background-color:#dc3545;color:#fff}.badge-danger[href]:focus,.badge-danger[href]:hover{background-color:#bd2130;color:#fff;text-decoration:none}.badge-light{background-color:#f8f9fa;color:#212529}.badge-light[href]:focus,.badge-light[href]:hover{background-color:#dae0e5;color:#212529;text-decoration:none}.badge-dark{background-color:#343a40;color:#fff}.badge-dark[href]:focus,.badge-dark[href]:hover{background-color:#1d2124;color:#fff;text-decoration:none}.border-0{border:0 !important}.border-top-0{border-top:0 !important}.border-right-0{border-right:0 !important}.border-bottom-0{border-bottom:0 !important}.border-left-0{border-left:0 !important}.p-0{padding:0 !important}.pt-0,.py-0{padding-top:0 !important}.pr-0,.px-0{padding-right:0 !important}.pb-0,.py-0{padding-bottom:0 !important}.pl-0,.px-0{padding-left:0 !important}.p-1{padding:.25rem !important}.pt-1,.py-1{padding-top:.25rem !important}.pr-1,.px-1{padding-right:.25rem !important}.pb-1,.py-1{padding-bottom:.25rem !important}.pl-1,.px-1{padding-left:.25rem !important}.p-2{padding:.5rem !important}.pt-2,.py-2{padding-top:.5rem !important}.pr-2,.px-2{padding-right:.5rem !important}.pb-2,.py-2{padding-bottom:.5rem !important}.pl-2,.px-2{padding-left:.5rem !important}.p-3{padding:1rem !important}.pt-3,.py-3{padding-top:1rem !important}.pr-3,.px-3{padding-right:1rem !important}.pb-3,.py-3{padding-bottom:1rem !important}.pl-3,.px-3{padding-left:1rem !important}.p-4{padding:1.5rem !important}.pt-4,.py-4{padding-top:1.5rem !important}.pr-4,.px-4{padding-right:1.5rem !important}.pb-4,.py-4{padding-bottom:1.5rem !important}.pl-4,.px-4{padding-left:1.5rem !important}.p-5{padding:3rem !important}.pt-5,.py-5{padding-top:3rem !important}.pr-5,.px-5{padding-right:3rem !important}.pb-5,.py-5{padding-bottom:3rem !important}.pl-5,.px-5{padding-left:3rem !important}.m-0{margin:0 !important}.mt-0,.my-0{margin-top:0 !important}.mr-0,.mx-0{margin-right:0 !important}.mb-0,.my-0{margin-bottom:0 !important}.ml-0,.mx-0{margin-left:0 !important}.m-1{margin:.25rem !important}.mt-1,.my-1{margin-top:.25rem !important}.mr-1,.mx-1{margin-right:.25rem !important}.mb-1,.my-1{margin-bottom:.25rem !important}.ml-1,.mx-1{margin-left:.25rem !important}.m-2{margin:.5rem !important}.mt-2,.my-2{margin-top:.5rem !important}.mr-2,.mx-2{margin-right:.5rem !important}.mb-2,.my-2{margin-bottom:.5rem !important}.ml-2,.mx-2{margin-left:.5rem !important}.m-3{margin:1rem !important}.mt-3,.my-3{margin-top:1rem !important}.mr-3,.mx-3{margin-right:1rem !important}.mb-3,.my-3{margin-bottom:1rem !important}.ml-3,.mx-3{margin-left:1rem !important}.m-4{margin:1.5rem !important}.mt-4,.my-4{margin-top:1.5rem !important}.mr-4,.mx-4{margin-right:1.5rem !important}.mb-4,.my-4{margin-bottom:1.5rem !important}.ml-4,.mx-4{margin-left:1.5rem !important}.m-5{margin:3rem !important}.mt-5,.my-5{margin-top:3rem !important}.mr-5,.mx-5{margin-right:3rem !important}.mb-5,.my-5{margin-bottom:3rem !important}.ml-5,.mx-5{margin-left:3rem !important}.btn{background-color:transparent;border:1px solid transparent;border-radius:.25rem;color:#212529;cursor:pointer;display:inline-block;font-size:1rem;font-weight:400;line-height:1.5;padding:.375rem .75rem;text-align:center;transition:color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none;vertical-align:middle}.btn:hover{color:#212529;text-decoration:none}.btn:visited{color:#212529}.btn.focus,.btn:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.25);outline:0}.btn.disabled,.btn:disabled{opacity:.65}@media (prefers-reduced-motion: reduce){.btn{transition:none}}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary:visited{color:#fff}.btn-primary:hover{background-color:#0069d9;border-color:#0062cc;color:#fff}.btn-primary.focus,.btn-primary:focus{background-color:#0069d9;border-color:#0062cc;box-shadow:0 0 0 .2rem rgba(0,123,255,0.5);color:#fff}.btn-primary.disabled,.btn-primary:disabled{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary.active:not(:disabled):not(.disabled),.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{background-color:#0062cc;border-color:#005cbf;color:#fff}.btn-primary.active:not(:disabled):not(.disabled):focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-secondary{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary:visited{color:#fff}.btn-secondary:hover{background-color:#5a6268;border-color:#545b62;color:#fff}.btn-secondary.focus,.btn-secondary:focus{background-color:#5a6268;border-color:#545b62;box-shadow:0 0 0 .2rem rgba(108,117,125,0.5);color:#fff}.btn-secondary.disabled,.btn-secondary:disabled{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled),.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{background-color:#545b62;border-color:#4e555b;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled):focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-success{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success:visited{color:#fff}.btn-success:hover{background-color:#218838;border-color:#1e7e34;color:#fff}.btn-success.focus,.btn-success:focus{background-color:#218838;border-color:#1e7e34;box-shadow:0 0 0 .2rem rgba(40,167,69,0.5);color:#fff}.btn-success.disabled,.btn-success:disabled{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success.active:not(:disabled):not(.disabled),.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{background-color:#1e7e34;border-color:#1c7430;color:#fff}.btn-success.active:not(:disabled):not(.disabled):focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-info{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info:visited{color:#fff}.btn-info:hover{background-color:#138496;border-color:#117a8b;color:#fff}.btn-info.focus,.btn-info:focus{background-color:#138496;border-color:#117a8b;box-shadow:0 0 0 .2rem rgba(23,162,184,0.5);color:#fff}.btn-info.disabled,.btn-info:disabled{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info.active:not(:disabled):not(.disabled),.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{background-color:#117a8b;border-color:#10707f;color:#fff}.btn-info.active:not(:disabled):not(.disabled):focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-warning{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning:visited{color:#212529}.btn-warning:hover{background-color:#e0a800;border-color:#d39e00;color:#212529}.btn-warning.focus,.btn-warning:focus{background-color:#e0a800;border-color:#d39e00;box-shadow:0 0 0 .2rem rgba(255,193,7,0.5);color:#212529}.btn-warning.disabled,.btn-warning:disabled{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning.active:not(:disabled):not(.disabled),.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{background-color:#d39e00;border-color:#c69500;color:#212529}.btn-warning.active:not(:disabled):not(.disabled):focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-danger{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger:visited{color:#fff}.btn-danger:hover{background-color:#c82333;border-color:#bd2130;color:#fff}.btn-danger.focus,.btn-danger:focus{background-color:#c82333;border-color:#bd2130;box-shadow:0 0 0 .2rem rgba(220,53,69,0.5);color:#fff}.btn-danger.disabled,.btn-danger:disabled{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger.active:not(:disabled):not(.disabled),.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{background-color:#bd2130;border-color:#b21f2d;color:#fff}.btn-danger.active:not(:disabled):not(.disabled):focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-light{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light:visited{color:#212529}.btn-light:hover{background-color:#e2e6ea;border-color:#dae0e5;color:#212529}.btn-light.focus,.btn-light:focus{background-color:#e2e6ea;border-color:#dae0e5;box-shadow:0 0 0 .2rem rgba(248,249,250,0.5);color:#212529}.btn-light.disabled,.btn-light:disabled{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light.active:not(:disabled):not(.disabled),.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{background-color:#dae0e5;border-color:#d3d9df;color:#212529}.btn-light.active:not(:disabled):not(.disabled):focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-dark{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark:visited{color:#fff}.btn-dark:hover{background-color:#23272b;border-color:#1d2124;color:#fff}.btn-dark.focus,.btn-dark:focus{background-color:#23272b;border-color:#1d2124;box-shadow:0 0 0 .2rem rgba(52,58,64,0.5);color:#fff}.btn-dark.disabled,.btn-dark:disabled{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark.active:not(:disabled):not(.disabled),.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{background-color:#1d2124;border-color:#171a1d;color:#fff}.btn-dark.active:not(:disabled):not(.disabled):focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-primary{border-color:#007bff;color:#007bff}.btn-outline-primary:visited{color:#007bff}.btn-outline-primary:hover{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{background-color:transparent;color:#007bff}.btn-outline-primary.active:not(:disabled):not(.disabled),.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.active:not(:disabled):not(.disabled):focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-secondary{border-color:#6c757d;color:#6c757d}.btn-outline-secondary:visited{color:#6c757d}.btn-outline-secondary:hover{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{background-color:transparent;color:#6c757d}.btn-outline-secondary.active:not(:disabled):not(.disabled),.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.active:not(:disabled):not(.disabled):focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-success{border-color:#28a745;color:#28a745}.btn-outline-success:visited{color:#28a745}.btn-outline-success:hover{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{background-color:transparent;color:#28a745}.btn-outline-success.active:not(:disabled):not(.disabled),.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.active:not(:disabled):not(.disabled):focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-info{border-color:#17a2b8;color:#17a2b8}.btn-outline-info:visited{color:#17a2b8}.btn-outline-info:hover{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{background-color:transparent;color:#17a2b8}.btn-outline-info.active:not(:disabled):not(.disabled),.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.active:not(:disabled):not(.disabled):focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-warning{border-color:#ffc107;color:#ffc107}.btn-outline-warning:visited{color:#ffc107}.btn-outline-warning:hover{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{background-color:transparent;color:#ffc107}.btn-outline-warning.active:not(:disabled):not(.disabled),.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.active:not(:disabled):not(.disabled):focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-danger{border-color:#dc3545;color:#dc3545}.btn-outline-danger:visited{color:#dc3545}.btn-outline-danger:hover{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{background-color:transparent;color:#dc3545}.btn-outline-danger.active:not(:disabled):not(.disabled),.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.active:not(:disabled):not(.disabled):focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-light{border-color:#f8f9fa;color:#f8f9fa}.btn-outline-light:visited{color:#f8f9fa}.btn-outline-light:hover{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{background-color:transparent;color:#f8f9fa}.btn-outline-light.active:not(:disabled):not(.disabled),.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.active:not(:disabled):not(.disabled):focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-dark{border-color:#343a40;color:#343a40}.btn-outline-dark:visited{color:#343a40}.btn-outline-dark:hover{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{background-color:transparent;color:#343a40}.btn-outline-dark.active:not(:disabled):not(.disabled),.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.active:not(:disabled):not(.disabled):focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-link{color:#007bff;font-weight:400;text-decoration:none}.btn-link:hover{color:#0056b3;text-decoration:underline}.btn-link.focus,.btn-link:focus{box-shadow:none;text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{border-radius:.3rem;font-size:1.25rem;line-height:1.5;padding:.5rem 1rem}.btn-group-sm>.btn,.btn-sm{border-radius:.2rem;font-size:.875rem;line-height:1.5;padding:.25rem .5rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input.btn-block[type=button],input.btn-block[type=reset],input.btn-block[type=submit]{width:100%}.stretched-link::after{background-color:rgba(0,0,0,0);bottom:0;content:'';left:0;pointer-events:auto;position:absolute;right:0;top:0;z-index:1}.text-wrap{white-space:normal !important}.card{background-clip:border-box;background-color:#fff;border:1px solid rgba(0,0,0,0.125);border-radius:.25rem;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;min-width:0;position:relative;word-wrap:break-word}.card>hr{margin-left:0;margin-right:0}.card>.list-group:first-child .list-group-item:first-child{border-top-left-radius:.25rem;border-top-right-radius:.25rem}.card>.list-group:last-child .list-group-item:last-child{border-bottom-left-radius:.25rem;border-bottom-right-radius:.25rem}.card-body{-ms-flex:1 1 auto;flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-bottom:0;margin-top:-.375rem}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{background-color:rgba(0,0,0,0.03);border-bottom:1px solid rgba(0,0,0,0.125);margin-bottom:0;padding:.75rem 1.25rem}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-header+.list-group .list-group-item:first-child{border-top:0}.card-footer{background-color:rgba(0,0,0,0.03);border-top:1px solid rgba(0,0,0,0.125);padding:.75rem 1.25rem}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{border-bottom:0;margin-bottom:-.75rem;margin-left:-.625rem;margin-right:-.625rem}.card-header-pills{margin-left:-.625rem;margin-right:-.625rem}.card-img-overlay{bottom:0;left:0;padding:1.25rem;position:absolute;right:0;top:0}.card-img,.card-img-bottom,.card-img-top{-ms-flex-negative:0;flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-left-radius:calc(.25rem - 1px);border-bottom-right-radius:calc(.25rem - 1px)}.w-100{width:100% !important}.shadow{box-shadow:0 0.5rem 1rem rgba(0,0,0,0.15) !important}.bg-primary{background-color:#007bff !important}button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc !important}a.bg-primary:focus,a.bg-primary:hover{background-color:#0062cc !important}a.text-primary:focus,a.text-primary:hover{color:#121416 !important}.bg-secondary{background-color:#6c757d !important}button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62 !important}a.bg-secondary:focus,a.bg-secondary:hover{background-color:#545b62 !important}a.text-secondary:focus,a.text-secondary:hover{color:#121416 !important}.bg-success{background-color:#28a745 !important}button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34 !important}a.bg-success:focus,a.bg-success:hover{background-color:#1e7e34 !important}a.text-success:focus,a.text-success:hover{color:#121416 !important}.bg-info{background-color:#17a2b8 !important}button.bg-info:focus,button.bg-info:hover{background-color:#117a8b !important}a.bg-info:focus,a.bg-info:hover{background-color:#117a8b !important}a.text-info:focus,a.text-info:hover{color:#121416 !important}.bg-warning{background-color:#ffc107 !important}button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00 !important}a.bg-warning:focus,a.bg-warning:hover{background-color:#d39e00 !important}a.text-warning:focus,a.text-warning:hover{color:#121416 !important}.bg-danger{background-color:#dc3545 !important}button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130 !important}a.bg-danger:focus,a.bg-danger:hover{background-color:#bd2130 !important}a.text-danger:focus,a.text-danger:hover{color:#121416 !important}.bg-light{background-color:#f8f9fa !important}button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5 !important}a.bg-light:focus,a.bg-light:hover{background-color:#dae0e5 !important}a.text-light:focus,a.text-light:hover{color:#121416 !important}.bg-dark{background-color:#343a40 !important}button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124 !important}a.bg-dark:focus,a.bg-dark:hover{background-color:#1d2124 !important}a.text-dark:focus,a.text-dark:hover{color:#121416 !important}.bg-white{background-color:#fff !important}button.bg-white:focus,button.bg-white:hover{background-color:#e6e6e6 !important}a.bg-white:focus,a.bg-white:hover{background-color:#e6e6e6 !important}a.text-white:focus,a.text-white:hover{color:#121416 !important}.text-primary{color:#007bff !important}.text-secondary{color:#6c757d !important}.text-success{color:#28a745 !important}.text-info{color:#17a2b8 !important}.text-warning{color:#ffc107 !important}.text-danger{color:#dc3545 !important}.text-light{color:#f8f9fa !important}.text-dark{color:#343a40 !important}.text-white{color:#fff !important}.text-body{color:#212529 !important}.text-muted{color:#6c757d !important}.text-black-50{color:rgba(0,0,0,0.5) !important}.text-white-50{color:rgba(255,255,255,0.5) !important}.bg-transparent{background-color:transparent !important}.text-justify{text-align:justify !important}.text-left{text-align:left !important}.text-right{text-align:right !important}.text-center{text-align:center !important}.font-weight-light{font-weight:300 !important}.font-weight-lighter{font-weight:lighter !important}.font-weight-normal{font-weight:400 !important}.font-weight-bold{font-weight:700 !important}.font-weight-bolder{font-weight:bolder !important}.font-italic{font-style:italic !important}.container{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container{max-width:540px}}@media (min-width: 768px){.container{max-width:720px}}@media (min-width: 992px){.container{max-width:960px}}@media (min-width: 1200px){.container{max-width:1140px}}.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container,.container-sm{max-width:540px}}@media (min-width: 768px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width: 992px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width: 1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1140px}}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;margin-right:-15px}.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{padding-left:15px;padding-right:15px;position:relative;width:100%}@media (min-width: 576px){.col-sm{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-sm-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-sm-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-sm-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-sm-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-sm-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 768px){.col-md{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-md-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-md-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-md-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-md-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-md-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 992px){.col-lg{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-lg-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-lg-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-lg-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-lg-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-lg-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 1200px){.col-xl{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-xl-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-xl-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-xl-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-xl-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-xl-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}.d-flex{display:-ms-flexbox !important;display:flex !important}.sphinx-bs,.sphinx-bs *{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sphinx-bs p{margin-top:0} diff --git a/v1.0.3/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/v1.0.3/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css new file mode 100644 index 00000000..fc14abc8 --- /dev/null +++ b/v1.0.3/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css @@ -0,0 +1 @@ +details.dropdown .summary-title{padding-right:3em !important;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none}details.dropdown:hover{cursor:pointer}details.dropdown .summary-content{cursor:default}details.dropdown summary{list-style:none;padding:1em}details.dropdown summary .octicon.no-title{vertical-align:middle}details.dropdown[open] summary .octicon.no-title{visibility:hidden}details.dropdown summary::-webkit-details-marker{display:none}details.dropdown summary:focus{outline:none}details.dropdown summary:hover .summary-up svg,details.dropdown summary:hover .summary-down svg{opacity:1}details.dropdown .summary-up svg,details.dropdown .summary-down svg{display:block;opacity:.6}details.dropdown .summary-up,details.dropdown .summary-down{pointer-events:none;position:absolute;right:1em;top:.75em}details.dropdown[open] .summary-down{visibility:hidden}details.dropdown:not([open]) .summary-up{visibility:hidden}details.dropdown.fade-in[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out;animation:panels-fade-in .5s ease-in-out}details.dropdown.fade-in-slide-down[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out}@keyframes panels-fade-in{0%{opacity:0}100%{opacity:1}}@keyframes panels-slide-down{0%{transform:translate(0, -10px)}100%{transform:translate(0, 0)}}.octicon{display:inline-block;fill:currentColor;vertical-align:text-top}.tabbed-content{box-shadow:0 -.0625rem var(--tabs-color-overline),0 .0625rem var(--tabs-color-underline);display:none;order:99;padding-bottom:.75rem;padding-top:.75rem;width:100%}.tabbed-content>:first-child{margin-top:0 !important}.tabbed-content>:last-child{margin-bottom:0 !important}.tabbed-content>.tabbed-set{margin:0}.tabbed-set{border-radius:.125rem;display:flex;flex-wrap:wrap;margin:1em 0;position:relative}.tabbed-set>input{opacity:0;position:absolute}.tabbed-set>input:checked+label{border-color:var(--tabs-color-label-active);color:var(--tabs-color-label-active)}.tabbed-set>input:checked+label+.tabbed-content{display:block}.tabbed-set>input:focus+label{outline-style:auto}.tabbed-set>input:not(.focus-visible)+label{outline:none;-webkit-tap-highlight-color:transparent}.tabbed-set>label{border-bottom:.125rem solid transparent;color:var(--tabs-color-label-inactive);cursor:pointer;font-size:var(--tabs-size-label);font-weight:700;padding:1em 1.25em .5em;transition:color 250ms;width:auto;z-index:1}html .tabbed-set>label:hover{color:var(--tabs-color-label-active)} diff --git a/v1.0.3/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css b/v1.0.3/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css new file mode 100644 index 00000000..adc61662 --- /dev/null +++ b/v1.0.3/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css @@ -0,0 +1,7 @@ +:root { +--tabs-color-label-active: hsla(231, 99%, 66%, 1); +--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); +--tabs-color-overline: rgb(207, 236, 238); +--tabs-color-underline: rgb(207, 236, 238); +--tabs-size-label: 1rem; +} \ No newline at end of file diff --git a/v1.0.3/_sources/doc_pages/api.rst.txt b/v1.0.3/_sources/doc_pages/api.rst.txt new file mode 100644 index 00000000..c9f8837b --- /dev/null +++ b/v1.0.3/_sources/doc_pages/api.rst.txt @@ -0,0 +1,90 @@ +.. _api-label: + + +API reference +============= + +Integrator +---------- + +.. automodule:: hymd.integrator + :members: + + +Thermostat +---------- + +.. automodule:: hymd.thermostat + :members: csvr_thermostat, _random_chi_squared, _random_gaussian + :undoc-members: + + +Hamiltonian +----------- + +.. autoclass:: hymd.hamiltonian.Hamiltonian + :members: + + .. automethod:: __init__ + + .. automethod:: _setup + +.. autoclass:: hymd.hamiltonian.SquaredPhi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultNoChi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultWithChi + :members: + + .. automethod:: __init__ + + +Force +----- + +.. automodule:: hymd.force + :members: + :undoc-members: + + +Logger +------ + +.. autoclass:: hymd.logger.Logger + :members: + +.. autoclass:: hymd.logger.MPIFilterRoot + :members: + +.. autoclass:: hymd.logger.MPIFilterAll + :members: + + +Input parser +------------ + +.. automodule:: hymd.input_parser + :members: + :undoc-members: propensity_potential_coeffs + + +Field +----- + +.. automodule:: hymd.field + :members: + + +File input/output +----------------- + +.. automodule:: hymd.file_io + :members: diff --git a/v1.0.3/_sources/doc_pages/benchmarks.rst.txt b/v1.0.3/_sources/doc_pages/benchmarks.rst.txt new file mode 100644 index 00000000..edc8a863 --- /dev/null +++ b/v1.0.3/_sources/doc_pages/benchmarks.rst.txt @@ -0,0 +1,93 @@ +.. _benchmarks-label: + +Benchmarks +########## +Homopolymer melt test systems of :math:`30^2`, :math:`40^2`, and :math:`50^2` +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively. + +Bonded forces +^^^^^^^^^^^^^ +Legend label denotes the number of particles in the system. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) + time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 + ], dtype=np.float64) + nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 + ], dtype=np.float64,) + time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, + ], dtype=np.float64) + nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 + ], dtype=np.float64) + time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, + ], dtype=np.float64) + plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" + ) + plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" + ) + plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" + ) + plt.xlabel("CPUs", fontsize=15) + plt.ylabel("Time per step, us", fontsize=15) + plt.legend(fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.show() + + +Particle--field forces +^^^^^^^^^^^^^^^^^^^^^^ +Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + + mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] + mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + + mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + + mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + + mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] + mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + + mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + + mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + + plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048²") + plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024²") + plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512²") + plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256²") + plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128²") + plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64²") + plt.xlabel("CPUs", fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.ylabel("Time per step, s", fontsize=15) + plt.legend(loc="upper left", fontsize=15) + plt.show() diff --git a/v1.0.3/_sources/doc_pages/command_line.rst.txt b/v1.0.3/_sources/doc_pages/command_line.rst.txt new file mode 100644 index 00000000..5233710f --- /dev/null +++ b/v1.0.3/_sources/doc_pages/command_line.rst.txt @@ -0,0 +1,120 @@ +.. _commandline-label: + +Command line arguments +###################### +Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle--field interactions. + + +Required arguments +================== +:configuration file: + :code:`type` positional + + Specifies the :code:`.toml` format configuration file containing simulation details. See :ref:`config-label` for details. + +:structure and topology file: + :code:`type` positional + + Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See :ref:`topology-label` for details. + +Optional arguments +================== +:code:`-v --verbose` + :code:`type` optional + + Number of following arguments: :code:`0` or :code:`1` + + Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying :code:`-v` or :code:`--verbose` with no additional specification. This increases verbosity level by :code:`1`. Alternatively, it maye be specified by :code:`--verbose V` with :code:`V` being :code:`0`, :code:`1`, or :code:`2`. + +:code:`--profile` + :code:`type` optional + + Number of following arguments: :code:`0` + + Enables code profiling using :code:`cProfile`. This will output one profiling file per MPI rank invoked in the simulation. + +:code:`--double-precision` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision internally in HyMD (including in the FFTs). + +:code:`--double-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision in the output trajectory from HyMD. + +:code:`--velocity-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that velocities should be output to the HyMD trajectory. + +:code:`--force-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that forces should be output to the HyMD trajectory. + +:code:`--disable-mpio` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult. + +:code:`--logfile` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the path of a plain text log file in which stdout is mirrored during simulation runs. + +:code:`--seed` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the random seed used in the :code:`numpy` random library to generate velocities, thermostatting, etc. + +:code:`--disable-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any two-particle bonds present in the system. + +:code:`--disable-angle-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any three-particle bonds present in the system. + +:code:`--disable-dihedrals` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any four-particle bonds present in the system. + +:code:`--disable-dipole` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any topological reconstruction of peptide backbone dipoles present in the system. + +:code:`--disable-field` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any particle--field interactions present in the system. diff --git a/v1.0.3/_sources/doc_pages/config_file.rst.txt b/v1.0.3/_sources/doc_pages/config_file.rst.txt new file mode 100644 index 00000000..40ee0479 --- /dev/null +++ b/v1.0.3/_sources/doc_pages/config_file.rst.txt @@ -0,0 +1,194 @@ +.. _config-label: + +Configuration file +################## +The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order. + +The configuration file is a `toml`_ format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs. + +.. _`toml`: + https://github.com/toml-lang/toml + +.. role:: required + +Configuration file keywords +--------------------------- + +The following constitutes every possible keyword specification in HyMD +configuration files: + +Metadata keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying metadata for the H5MD output trajectory. + +:name: + :code:`string` [**optional**, default: :code:`None`] + + Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file. + + +:tags: + :code:`array` [:code:`string`] [**optional**, default: :code:`None`] + + Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file. + + +Particle keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying properties of particles and molecules in the +system. + +:n_particles: + :code:`integer` [**optional**, default: :code:`None`] + + Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules. + +:mass: + :code:`float` [**optional**, default: :code:`72.0`] {units: :math:`\text{u}=\text{g}\,\text{mol}^{-1}`} + + Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal. + +:max_molecule_size: + :code:`integer` [**optional**, default: :code:`201`] + + Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code **will** crash if there are molecules larger than :code:`max_molecule_size` in the topology/structure input file. + + +Simulation keywords +^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying simulation parameters. + +:n_steps: + :code:`integer` [:required:`required`] + + Total number of integration steps to perform for this simulation. + +:n_print: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of *number of time steps*). + +:n_flush: + :code:`integer` [**optional**, default: :code:`None`] + + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of *number of* :code:`n_print`, i.e. :code:`n_print = 13`, :code:`n_flush = 3` would result in the trajectory/energy being written to disk every :code:`13 x 3 = 39` *simulation steps*) + +:time_step: + :code:`float` [:required:`required`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time step per integration step. If the rRESPA multiple time step integrator is used (:code:`integrator = "respa"`), this specifies the **inner** time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is :code:`respa_inner` times the :code:`time_step` , and the total simulation time is :code:`n_steps` times :code:`time_step` times :code:`respa_inner` . + +:box_size: + :code:`array` [:code:`float`] [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable. + +:integrator: + :code:`string` [:required:`required`] (options: :code:`velocity-verlet` or :code:`respa`) + + Specifies the time integrator used in the simulation. If :code:`respa`, the *reversible reference system propagator algorithm (rRESPA)* :cite:`tuckerman1992reversible` integrator is used, with :code:`respa_inner` number of inner (intramolecular force) time steps. If :code:`velocity-verlet`, a normal Velocity Verlet integrator is used. If :code:`respa` and :code:`respa_inner = 1`, the rRESPA integrator is equivalent to the Velocity Verlet. + +:respa_inner: + :code:`integer` [**optional**, default: :code:`1`] + + The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces. + +:domain_decomposition: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Specifies the interval (in time steps) of *domain decomposition exchange*, involving all MPI ranks sending and receiving particles according to the particles' positions in the integration box and the MPI ranks' assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If :code:`True`, the decomposition is performed once (before starting the simulation). If :code:`False`, no decomposition is performed. + +:cancel_com_momentum: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + If :code:`True`, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every :code:`remove_com_momentum` time steps. If :code:`False`, the linear momentum is never removed. + +:start_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at :code:`start_temperature` Kelvin prior to starting the simulation. If :code:`False`, the velocities are not changed before starting the simulation. + +:target_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Couple the system to a heat bath at :code:`target_temperature` Kelvin by applying a *Canonical sampling through velocity rescaling* :cite:`Bussi2007JCP` thermostat with coupling strength :code:`tau`. If :code:`False`, no temperature control is applied. + +:tau: + :code:`float` [**optional**, default: :code:`0.7`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the CSVR thermostat coupling. In the limit of :code:`tau → ∞`, the Hamiltonian dynamics are preserved and no temperature coupling takes place. + +:thermostat_coupling_groups: + :code:`array` [:code:`array` [:code:`string`]] [**optional**, default: :code:`[]`] + + Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and :code:`"C"` type particles, :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would thermalise types :code:`"A"` and :code:`"B"` together and couple :code:`"C"` type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. :code:`target_temperature` Kelvin). +:hamiltonian: + :code:`string` [**optional**, default: :code:`"DefaultNohChi"`] (options: :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`) + + Specifies the interaction energy functional :math:`W[\tilde\phi]` for use with the particle-field interactions. See :ref:`functionals-label` for details. + + +Field keywords +^^^^^^^^^^^^^^ +Configuration keywords specifying field parameters. + +:mesh_size: + :code:`array` [:code:`integer`] or :code:`integer` [:required:`required`] + + Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is :code:`box_size / mesh_size`. + +:kappa: + :code:`float` [:required:`required`] {units: :math:`\text{kJ}^{-1}\text{mol}`} + + Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional :math:`W[\tilde\phi]`. See :ref:`functionals-label` for more details. + +:sigma: + :code:`float` [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See :ref:`filtering-label` for more details. + +:chi: + :code:`array` [:code:`array` [:code:`string`, :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}`} + + Array of :math:`\tilde\chi_\text{AB}`-parameters indicating the strength of the repulsive or attractive interaction between particles of type :code:`"A"` and the number density due to particles of type :code:`"B"`, and vice versa. Example: :code:`chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ]` would specify a repulsive :code:`"A"`--:code:`"B"` type interaction, and a weakly attractive :code:`"C"`--:code:`"D"` interaction. Self-interaction :math:`\tilde\chi`-terms are always zero. See :ref:`functionals-label` for more details. + + +Bond keywords +^^^^^^^^^^^^^ +Configuration keywords specifying bonds and bonds parameters. + +:bonds: + :code:`array` [:code:`array` [2 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{nm}=10^{-9}~\text{m}` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: :code:`bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ]` indicates a :code:`"A"`--:code:`"A"` bond of equilibrium length :code:`0.47` :math:`\text{nm}` with a bond strength of :code:`980.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding bond between :code:`"A"` and :code:`"B"` type particles with equilibrium length :code:`0.31` :math:`\text{nm}` and a strength of :code:`1250.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify stretching bonds. + +:angle_bonds: + :code:`array` [:code:`array` [3 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`{}^\circ` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: :code:`bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ]` indicates a :code:`"A"`--:code:`"A"`--:code:`"A"` angular bond that tries to keep the bond linear at :code:`180` degrees with a bending strength of :code:`55.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding angle bond between :code:`"A"`--:code:`"B"`--:code:`"B"` prefering the angle at :code:`120` degrees and a strength of :code:`25.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify angular bonds. + +:dihedrals: + :code:`array` [:code:`array` [4 :code:`string`, :code:`integer`, :code:`COSINE SERIES` ]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`} + + Specifies four-particle torsional potentials by cosine series. See :ref:`bonds-label` for details about how to specify dihedrals. + + + +Electrostatic keywords +^^^^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying electrostatics and electrostatic parameters. + +:coulombtype: + :code:`string` [**optional**, default: :code:`None`] (options: :code:`PIC_Spectral`) + + Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the :code:`dielectric_const` keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, *not* in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to `PIC_Spectral`. + +:dielectric_const: + :code:`float` [**optional**, default: :code:`None`] + + Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified---even if electrostatics are not included with the :code:`coulombtype` keyword. diff --git a/v1.0.3/_sources/doc_pages/constants_and_units.rst.txt b/v1.0.3/_sources/doc_pages/constants_and_units.rst.txt new file mode 100644 index 00000000..ee429829 --- /dev/null +++ b/v1.0.3/_sources/doc_pages/constants_and_units.rst.txt @@ -0,0 +1,80 @@ +.. _units-label: + +Constants and Units +################### + +HyMD uses the following units and constants internally and in all input and +output: + +.. list-table:: **Units** + :widths: 30 10 75 + :header-rows: 1 + + * - Quantity + - Symbol + - Unit + * - length + - :math:`r` + - :math:`\text{nm}=10^{-9}~\text{m}` + * - time + - :math:`t` + - :math:`\text{ps}=10^{-12}~\text{s}` + * - charge + - :math:`q` + - :math:`e=1.602176634 \cdot 10^{-19}~\text{C}` + * - mass + - :math:`m` + - :math:`\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}` + * - temperature + - :math:`\text{T}` + - :math:`\text{K}` + * - energy + - :math:`E` + - :math:`\text{kJ}\,\text{mol}^{-1}` + * - velocity + - :math:`v` + - :math:`\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}` + * - momentum + - :math:`P` + - :math:`\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}` + * - force + - :math:`\mathbf{F}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}` + * - pressure + - :math:`p` + - :math:`\text{bar}=100~\text{kPa}` + * - electric potential + - :math:`\Psi` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}` + * - electric field + - :math:`\mathbf{E}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}` + * - compressibility + - :math:`\kappa` + - :math:`\text{mol}\,\text{kJ}^{-1}` + * - field-interaction + - :math:`\tilde\chi` + - :math:`\text{kJ}\,\text{mol}^{-1}` + +.. list-table:: **Constants** + :widths: 30 10 75 + :header-rows: 1 + + * - Constant + - Symbol + - Value + * - gas constant + - :math:`R` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Boltzmann’s constant + - :math:`k_\text{B}` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Avogadro's constant + - :math:`N_\text{A}` + - :math:`6.02214076 \cdot 10^23~\text{mol}^{-1}` + * - Vacuum permittivity + - :math:`\varepsilon_0` + - :math:`8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2` + * - Coulomb constant + - :math:`k_\text{e}` + - :math:`138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}` diff --git a/v1.0.3/_sources/doc_pages/electrostatics.rst.txt b/v1.0.3/_sources/doc_pages/electrostatics.rst.txt new file mode 100644 index 00000000..7e11c09d --- /dev/null +++ b/v1.0.3/_sources/doc_pages/electrostatics.rst.txt @@ -0,0 +1,48 @@ +.. _electrostatics-label: + +Electrostatic interactions +########################## +In the filtered Hamiltonian hPF formalism :cite:`bore2020hamiltonian` the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle--mesh Ewald. + +The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered + +.. math:: + + \tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i), + +with :math:`q_i` being the charge of particle :math:`i` and :math:`H` is the +filtering function (see :ref:`filtering-label`). The value of the charge grid at +vertex :math:`(i,j,k)` is found by + +.. math:: + + \tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)] + +and the electrostatic potential :math:`\Psi_{ijk}` + +.. math:: + + \Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right], + +where :math:`k_\text{e}` is the Coulomb constant :math:`1/4\pi\varepsilon_0`. +The *electric field* is obtained by differentiation of the electrostatic +potential in Fourier space, + +.. math:: + + \mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)] + +from which the forces are interpolated back to the particle positions. + +Specifying electrostatics +^^^^^^^^^^^^^^^^^^^^^^^^^ +In HyMD, electrostatics are specified by the :code:`coulombtype` and +:code:`dielectric_const` keywords in the configuration file (see +:ref:`config-label`) and the :code:`/charge` dataset in the HDF5 format +structure/topology input file (see :ref:`topology-label`). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions. diff --git a/v1.0.3/_sources/doc_pages/examples.rst.txt b/v1.0.3/_sources/doc_pages/examples.rst.txt new file mode 100644 index 00000000..9f9c3655 --- /dev/null +++ b/v1.0.3/_sources/doc_pages/examples.rst.txt @@ -0,0 +1,621 @@ +.. _examples-label: + +Examples +######## +The following examples are ordered in *more or less* order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the `HyMD-tutorial`_ github repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Ideal gas +========= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true + :align: right + :width: 200 + +The simplest possible system is one with no interactions at all---intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like: + + +.. code-block:: toml + :caption: **ideal_gas.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = false # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + +A simple input structure/topology file :code:`ideal_gas.HDF5` is available in +the `HyMD-tutorial/ideal_gas`_ github repository (along with the code to +generate it). Run the (very) short simulation by + +.. code:: bash + + python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field \ + --velocity-output \ + --force-output + +with the :code:`--disable-field` argument to completely turn off all +particle--field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook `ideal_gas.ipynb`_ for details. + + +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas +.. _ideal_gas.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.ipynb + + +Ideal chains +============ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true + :align: right + :width: 200 + +The simplest available interaction is the harmonic two-particle bond (see +:ref:`bonds-label`), + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2. + +Extending the configuration file from the ideal gas case, we need to add a +:code:`bonds` specification. Note that the :code:`[bonds]` meta specifier is not +necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **ideal_chain.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + +A simple input structure/topology file :code:`ideal_chain.HDF5` with a few +coiled up ideal chain polymers is available in the +`HyMD-tutorial/ideal_chain`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field + +we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +`ideal_chain.ipynb`_. + + +.. _HyMD-tutorial/ideal_chain: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_chain +.. _ideal_chain.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/ideal_chain.ipynb + + +Stiff rods +========== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true + :align: right + :width: 200 + +Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the :code:`i--j--k` angle :math:`\theta` (see +:ref:`bonds-label`), + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2. + +Extending the configuration file from the ideal chain case, we need to add a +:code:`angle_bonds` specification. Note that the :code:`[bonds]` meta specifier +is not necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **rods.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + + angle_bonds = [ + ["A", "A", "A", 180.0, 100.0], # (i, j, k, equilibrium angle, strength) + ] + + +A simple input structure/topology file :code:`rods.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook `rods.ipynb`_. + + +.. _HyMD-tutorial/rods: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/rods +.. _rods.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.ipynb + + + +Helixes +======= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true + :align: right + :width: 200 + +Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle :math:`\phi` between the +:code:`i--j--k` plane and the :code:`j--k--l` plane (see :ref:`bonds-label`), + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n). + +The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a :code:`dihedrals` keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the :code:`dielectric_const` +keyword even though we are not including electrostatic forces in the current +simulation. Note that the :code:`[bonds]` meta specifier is not necessary, but +may be used to help organise the input file. + +.. code-block:: toml + :caption: **helixes.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + dielectric_const = 15.0 + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.31, 10000.0], # (i name, j name, equilibrium length, strength) + ] + + dihedrals = [ + [ + ["A", "A", "A", "A"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0] + ], + ] + +A simple input structure/topology file :code:`helixes.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook `helixes.ipynb`_. + + +.. _HyMD-tutorial/helixes: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/helixes +.. _helixes.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.ipynb + + +Phase separation +================ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true + :align: right + :width: 200 + +The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types :code:`A` and :code:`B`. Using the Hamiltonian + +.. math:: + + \mathcal{H}=H_0+W + +with :math:`\tilde\chi`--dependent interactions defined by (specified in the +configuration file by :code:`hamiltonian = DefaultWithChi`): + +.. math:: + + W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2. + + +.. code-block:: toml + :caption: **phase_separation.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + + [field] + mesh_size = [20, 20, 20] # FFT grid size + sigma = 1.0 # filtering length scale in nm + kappa = 0.05 # compressibility in mol/kJ + chi = [ + ['A', 'B', 5.0], # (name i, name j, strength) + ] + +A simple input structure/topology file :code:`phase_separation.HDF5` containing +an equal number of :code:`A` type and :code:`B` type particles is available in +the `HyMD-tutorial/phase_separation`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd phase_separation.toml phase_separation.HDF5 + +we may examine the resulting trajectory. In the case of a low interaction +strength :math:`\tilde\chi` of :code:`5.0` (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to :code:`40.0` (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +`phase_separation.ipynb`_. + + +.. _HyMD-tutorial/phase_separation: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/phase_separation +.. _phase_separation.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/phase_separation.ipynb + + +Diblock copolymers +================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true + :align: right + :width: 200 + +Having introduced particle--field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive :math:`\tilde\chi`--interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the :code:`integrator = "respa"` keyword. Putting the pieces together, the +configuration file may look like the following: + +.. code-block:: toml + :caption: **copolymer.toml** + + [simulation] + integrator = "respa" + respa_inner = 15 + n_steps = 2000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [10.0, 10.0, 10.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [50, 50, 50] # FFT grid size + sigma = 0.5 # filtering length scale in nm + chi = [ + ["A", "B", 30.0], # (i, j, strength) + ] + + [bonds] + bonds = [ + ["A", "A", 0.25, 1500.0], # (i, j, equilibrium length, strength) + ["A", "B", 0.25, 1500.0], + ["B", "B", 0.25, 1500.0], + ] + angle_bonds = [ + ["A", "A", "A", 180.0, 25.0], # (i, j, k, equilibrium angle, strength) + ["B", "B", "B", 180.0, 25.0], + ] + +A simple input structure/topology file :code:`copolymer.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/copolymer`_ github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten :code:`A` followed by ten :code:`B` type particles. +Running the simulation with + +.. code:: bash + + python3 -m hymd copolymer.toml copolymer.HDF5 + +the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +`copolymer.ipynb`_. + + +.. _HyMD-tutorial/copolymer: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/copolymer +.. _copolymer.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer.ipynb + + +Lipid bilayer self-assembly +=========================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true + :align: right + :width: 300 + +Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field--particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the :code:`thermostat_coupling_groups` keyword. With parameters +optimised in :cite:`ledum2020automated`, the configuration file looks like: + + +.. code-block:: toml + :caption: **lipid_self_assembly.toml** + + [simulation] + integrator = "respa" + respa_inner = 25 + n_steps = 3000 + n_print = 200 + n_flush = 1 + time_step = 0.01 + box_size = [9.96924, 9.96924, 10.03970] + start_temperature = 323 + target_temperature = 323 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.05 + domain_decomposition = 10001 + cancel_com_momentum = true + max_molecule_size = 15 + thermostat_coupling_groups = [ + ["N", "P", "G", "C"], + ["W"], + ] + + [field] + mesh_size = [25, 25, 25] + sigma = 1.0 + chi = [ + ["C", "W", 42.24], + ["G", "C", 10.47], + ["N", "W", -3.77], + ["G", "W", 4.53], + ["N", "P", -9.34], + ["P", "G", 8.04], + ["N", "G", 1.97], + ["P", "C", 14.72], + ["P", "W", -1.51], + ["N", "C", 13.56], + ] + + [bonds] + bonds = [ + ["N", "P", 0.47, 1250.0], + ["P", "G", 0.47, 1250.0], + ["G", "G", 0.37, 1250.0], + ["G", "C", 0.47, 1250.0], + ["C", "C", 0.47, 1250.0], + ] + angle_bonds = [ + ["P", "G", "G", 120.0, 25.0], + ["P", "G", "C", 180.0, 25.0], + ["G", "C", "C", 180.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +A randomly mixed input structure/topology file +:code:`lipid_self_assembly.HDF5` with a few hundred lipids in a roughy +:code:`10 x 10 x 10nm` box is available in the +`HyMD-tutorial/lipid_self_assembly`_ github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation + +.. code:: bash + + python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5 + +we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook `lipid_self_assembly.ipynb`_. + + +.. _HyMD-tutorial/lipid_self_assembly: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/lipid_self_assembly +.. _lipid_self_assembly.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/lipid_self_assembly.ipynb + + +Peptide in lipid bilayer +======================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true + :align: right + :width: 300 + +Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer. + + +The `configuration file`_ is available in the `HyMD-tutorial/peptide`_ github +repository (omitted here for brevity). + +A pre-equilibrated input structure/topology file :code:`peptide.HDF5` with a +few hundred lipids in a roughy :code:`20 x 20 x 20nm` box is available in the +`HyMD-tutorial/peptide`_ github repository. Running the simulation + +.. code:: bash + + python3 -m hymd peptide.toml peptide.HDF5 + +we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook `peptide.ipynb`_. + + +.. _HyMD-tutorial/peptide: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/peptide +.. _configuration file: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.toml +.. _peptide.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.ipynb + + +SDS +=== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true + :align: right + :width: 300 + +The last part we introduce is explicit electrostatic interactions through +particle--mesh Ewald. Enabling the electrostatic calculations is done via the +:code:`coulombtype` keyword. :code:`"PIC_Spectral"` is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the :code:`dielectric_const` keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge. + + + +.. code-block:: toml + :caption: **sds.toml** + + [simulation] + integrator = "respa" + respa_inner = 10 + n_steps = 3000 + n_print = 1500 + n_flush = + time_step = 0.01 + box_size = [8.3, 8.3, 8.3] + start_temperature = 298 + target_temperature = 298 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.1 + domain_decomposition = 10000 + cancel_com_momentum = true + max_molecule_size = 5 + thermostat_coupling_groups = [ + ["S", "C"], + ["W", "Na"], + ] + dielectric_const = 45.0 # dielectric constant for the simulation medium + coulombtype = "PIC_Spectral" # particle in cloud, spectral method + + [field] + mesh_size = [64, 64, 64] + sigma = 0.5 + chi = [ + ["S", "C", 13.50], + ["S", "Na", 0.00], + ["S", "W", -3.60], + ["C", "Na", 13.50], + ["C", "W", 33.75], + ["W", "Na", 0.00], + ] + + [bonds] + bonds = [ + ["S", "C", 0.50, 1250.0], + ["C", "C", 0.50, 1250.0], + ] + angle_bonds = [ + ["S", "C", "C", 170.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +An input structure/topology file :code:`sds.HDF5` with a couple thousand +randomly dispersed SDS chains is available in the `HyMD-tutorial/sds`_ github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a :code:`/charge` dataset. +Running the simulation with + +.. code:: bash + + python3 -m hymd sds.toml sds.HDF5 + +we observe the aggregation of the SDS into micellular structures---first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook `sds.ipynb`_. + + +.. _HyMD-tutorial/sds: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/sds +.. _sds.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/sds.ipynb diff --git a/v1.0.3/_sources/doc_pages/filtering.rst.txt b/v1.0.3/_sources/doc_pages/filtering.rst.txt new file mode 100644 index 00000000..02af68c6 --- /dev/null +++ b/v1.0.3/_sources/doc_pages/filtering.rst.txt @@ -0,0 +1,30 @@ +.. _filtering-label: + +Filtering +######### +The default grid-independent filter function used in HyMD is a Gaussian + +.. math:: + + H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] + +with reciprocal space representation + +.. math:: + + \hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +The coarse-graining parameter :math:`\sigma` determines a length scale of +particle extent and is given as configuration file input by + +.. code:: toml + + sigma = 0.75 + + +Implementing new filters +^^^^^^^^^^^^^^^^^^^^^^^^ +Implementing new filter functions is straightforward by hijacking +the :code:`setup` method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional. diff --git a/v1.0.3/_sources/doc_pages/installation.rst.txt b/v1.0.3/_sources/doc_pages/installation.rst.txt new file mode 100644 index 00000000..773eb2f4 --- /dev/null +++ b/v1.0.3/_sources/doc_pages/installation.rst.txt @@ -0,0 +1,162 @@ +.. _installation-label: + +Installation +############ +HyMD may be installed using :code:`pip` by + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + + +Dependencies +============ +HyMD **requires** a working MPI compiler and HDF5. On an Ubuntu system, this +may be installed via + +.. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y libhdf5-openmpi-dev python3-mpi4py + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-cache-dir --no-binary=h5py h5py + +It is **highly recommended** to have MPI-enabled HDF5 and h5py. A +non-MPI-enabled h5py may be installed by simply + +.. code-block:: bash + + sudo apt-get update -y + sudo apt-get install libhdf5-serial-dev + python3 -m pip --upgrade install h5py + +A non-MPI-enabled HDF5 library with corresponding :code:`h5py` will work +(mostly), but is inconvenient and slow. Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +:code:`--disable-mpio` argument to HyMD, see :ref:`commandline-label`. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial. + +Install in docker +================= +A docker image with build essentials setup is available at `dockerhub`_ with tag +:code:`mortele/hymd`, + +.. code-block:: bash + + docker pull mortele/hymd:latest + docker run -it mortele/hymd + /app$ python3 -m pip install hymd + + # Grab example input files + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5 + + # Run simulation + /app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose + +.. _dockerhub: + https://hub.docker.com/repository/docker/mortele/hymd + + +Run interactively in Google Colaboratory +======================================== +A `Google Colaboratory`_ jupyter notebook is setup `here`_ with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Common issues +============= + +Numpy errors while importing the Fortran force kernels +------------------------------------------------------ + +.. code-block:: python + + RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd + + Traceback (most recent call last): + + (...) + + File "/..../HyMD/hymd/__init__.py", line 2, in + from .main import main # noqa: F401 + File "/..../HyMD/hymd/main.py", line 10, in + from .configure_runtime import configure_runtime + File "/..../hymd/configure_runtime.py", line 12, in + from .input_parser import read_config_toml, parse_config_toml + File "/..../HyMD/hymd/input_parser.py", line 12, in + from .force import Bond, Angle, Dihedral, Chi + File "/..../HyMD/hymd/force.py", line 8, in + from force_kernels import ( # noqa: F401 + ImportError: numpy.core.multiarray failed to import + +can normally be fixed by updating numpy versions, + +.. code-block:: bash + + python3 -m pip install -U numpy + + +Error building pfft-python due to missing curl/wget +--------------------------------------------------- + +.. code-block:: python + + Building wheel for pfft-python (setup.py) ... error + ERROR: Command errored out with exit status 1: + command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_ + cwd: /tmp/pip-install-fr6nt9m4/pfft-python/ + Complete output (56 lines): + running bdist_wheel + running build + running build_py + + (...) + + curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found + wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found + Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + Please check curl or wget + You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ + Traceback (most recent call last): + File "", line 1, in + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in + setup( + File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup + return distutils.core.setup(**attrs) + File "/usr/lib/python3.8/distutils/core.py", line 148, in setup + + (...) + + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions + build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:])) + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft + raise ValueError("could not build fftw; check MPICC?") + ValueError: could not build fftw; check MPICC? + ---------------------------------------- + ERROR: Failed building wheel for pfft-python + Running setup.py clean for pfft-python + Failed to build pfft-python + +can be fixed by installing either `curl`_ or `wget`_ + +.. code-block:: bash + + apt-get install -y curl wget + + +.. _`curl`: + https://curl.se/ + +.. _`wget`: + https://www.gnu.org/software/wget/ diff --git a/v1.0.3/_sources/doc_pages/interaction_energy_functionals.rst.txt b/v1.0.3/_sources/doc_pages/interaction_energy_functionals.rst.txt new file mode 100644 index 00000000..f33c004e --- /dev/null +++ b/v1.0.3/_sources/doc_pages/interaction_energy_functionals.rst.txt @@ -0,0 +1,98 @@ +.. _functionals-label: + +Interaction energy functionals +############################## +A few interaction energy functionals :math:`W` are defined in HyMD through +the :code:`Hamiltonian` class and associated subclasses. + +:math:`\chi`--interaction and :math:`\kappa`--incompressibility +=============================================================== +The most common hPF energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultWithChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where :math:`\tilde\chi_{\text{A}-\text{B}}` is the interaction energy between +overlapping densities of particle types :math:`\text{A}` and :math:`\text{B}`. +The incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\tilde\chi` +and :math:`\kappa` in the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + chi = [ + ["A", "B", 15.85], + ["B", "C", -5.70], + ... + ] + +Only :math:`\kappa`--incompressibility +====================================== +The only :math:`\kappa` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultNoChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where the incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Only :math:`\phi^2` +=================== +The :math:`\phi^2` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "SquaredPhi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2, + +where the :math:`\phi` squared term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Implementing new interaction energy forms +========================================= +Implementing new interaction energy functions is straightforward by subclassing +:code:`Hamiltonian` and applying :code:`sympy` differentiation to the symbolic +field objects. The :code:`sympy.lamdify` function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields. diff --git a/v1.0.3/_sources/doc_pages/intramolecular_bonds.rst.txt b/v1.0.3/_sources/doc_pages/intramolecular_bonds.rst.txt new file mode 100644 index 00000000..820e81bc --- /dev/null +++ b/v1.0.3/_sources/doc_pages/intramolecular_bonds.rst.txt @@ -0,0 +1,142 @@ +.. _bonds-label: + +Intramolecular bonds +#################### + +Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see :ref:`config-label`. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +:ref:`benchmarks-label`), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable. + +All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]). + + +Two-particle bonds +^^^^^^^^^^^^^^^^^^ +Stretching bonds in HyMD are implemented as harmonic spring potentials, + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2, + +where :math:`r=|\mathbf{r}|` is the inter-particle distance, :math:`k` is a +constant of dimension energy (units :math:`\text{kJ}\,\text{mol}^{-1}`), and +:math:`r_0` is the equilibrum length of the bond (units: :math:`\text{nm}`). The +force is calculated as + +.. math:: + + F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r}, + +where :math:`\mathbf{r}` is the vector pointing *from* :math:`i` *to* :math:`j`. + +In the configuration file, two-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_two_particle_example.toml + + [bonds] + bonds = [ + ["A", "A", 0.47, 1250.0], + ["A", "B", 0.37, 940.0], + ["B", "C", 0.50, 1010.0], + ["C", "A", 0.42, 550.0], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Three-particle bonds +^^^^^^^^^^^^^^^^^^^^ +Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle--particle--particle angle :math:`\theta`, + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2, + +where :math:`k` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}`), and :math:`\theta_0` is the equilibrum +angle of the bond (units: :math:`{}^\circ`). Defining the particles with labels +:math:`a`, :math:`b`, and :math:`c`, let :math:`\mathbf{r}_a` denote the vector +pointing from :math:`b` to :math:`a`, and correspondingly let +:math:`\mathbf{r}_c` point from :math:`b` to :math:`c`. The +:math:`a`--:math:`b`--:math:`c` may be computed through the law of Cosines, + +.. math:: + + \theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right] + +Then the force acting on :math:`a` and :math:`c` is + +.. math:: + + \mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a}, + + \mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c}, + +and + +.. math:: + + \mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c + +In the configuration file, three-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_three_particle_example.toml + + [bonds] + angle_bonds = [ + ["A", "A", "A", 180.0, 90.0], + ["A", "B", "A", 120.0, 55.0], + ["B", "C", "C", 30.0, 10.0], + ["C", "A", "B", 110.0, 25.5], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Four-particle bonds +^^^^^^^^^^^^^^^^^^^ +Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle :math:`\phi` between the +:math:`a`--:math:`b`--:math:`c` and :math:`b`--:math:`c`--:math:`d` planes, for +a dihedral bond quartet :math:`a`, :math:`b`, :math:`c`, and :math:`d`. The +potential takes the form + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n), + +where :math:`c_n` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`), and :math:`\phi_n` are +specified phase angles in the cosine series. + +In the configuration file, four-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_four_particle_example.toml + + [bonds] + dihedrals = [ + ["A", "B", "C", "D"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0], + ] diff --git a/v1.0.3/_sources/doc_pages/overview.rst.txt b/v1.0.3/_sources/doc_pages/overview.rst.txt new file mode 100644 index 00000000..0e4d6b65 --- /dev/null +++ b/v1.0.3/_sources/doc_pages/overview.rst.txt @@ -0,0 +1,166 @@ +.. _overview-label: + +================================ + Usage overview for HylleraasMD +================================ + +HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a `toml`_ format configuration file, along with a topology and structure +file specifying the input system in HDF5 format. + +.. _`toml`: + https://github.com/toml-lang/toml + +**Configuration file** + +The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a :code:`[5, 5, 5]` nm simulation box at 300 K may look like +the following: + +.. code-block:: toml + :caption: **config_simple_1.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "SquaredPhi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [30, 30, 30] # FFT grid size + sigma = 0.5 # filtering length scale in nm + +Note that for the version 1.0 release of HyMD, the :code:`[particles]`, +:code:`[simulation]`, and :code:`[field]` groups are optional specifiers for +structuring the configuration file. + +For a full specification of every recognised configuration keyword in HyMD, +please refer to :ref:`config-label`. + +**Topology and structure file** + +The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +:code:`N` particles may look like the following: + +.. code-block:: bash + :caption: **example_structure.HDF5** + + group / + # root group + + dataset /coordinates + # float32, shape (T, N, D,) + # Time steps of N rows of D dimensional coordinate data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /velocities + # float32, shape (T, N, D,) OPTIONAL + # Time steps of N rows of D dimensional velocity data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /bonds + # int32, shape (N, B,) OPTIONAL + # Each row i contains indices of the particles bonds from/to i + # B denotes the maximum bonds per particle + + dataset /indices + # int32, shape (N,) + # Index of each particle, 0--(N-1) + + dataset /molecules + # int32, shape (N,) + # Index of molecule each particle belongs to + # Used to construct bond network locally on MPI ranks + + dataset /names + # str10, shape (N,) + # Fixed size string array containing particle type names + + dataset /types + # int32, shape (N,) OPTIONAL + # Mapping of particle names to type indices + + +For a full specification of the topology and structure input file, see +:ref:`topology-label`. + +**Command line arguments** + +A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the :code:`config_simple_1.toml` and :code:`example_structure.HDF5` +files may look like the following: + +.. code-block:: bash + + mpirun -n ${MPI_NUM_RANKS} python3 -m hymd \ # HyMD executable + config_simple_1.toml \ # configuration file + example_structure.HDF5 \ # structure file + --logfile=log_out.txt \ # set logfile path + --seed 123456 \ # set random seed + --verbose 2 \ # set logging verbosity + --velocity-output # enable velocity in trajectory output + +For a full specification of all command line arguments, see +:ref:`commandline-label`. + +**More examples** + +For more thorough rundown and concrete usage examples, see +:ref:`examples-label`. + +Running parallel simulations +============================ +Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the **only** difference being how the python3 interpreter is +invoked. Prepending :code:`mpirun -n ${NPROCS}` to the usual +:code:`python3 -m hymd` runs the simulation with :code:`${NPROCS}` MPI ranks. + +Inputting + +.. code:: bash + + mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field + +sets up an example simulation of the `HyMD-tutorial/ideal_gas`_ system. For +more details about this system in particular, or other example simulations, see +the `HyMD-tutorial`_ repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas + + +Running tests +============= +Run serial code tests by + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd + cd hymd/ + python3 -m pip install pytest pytest-mpi + python3 -m pytest + +There is a small convenience script in :code:`hymd/` for running the MPI-enabled +tests, + +.. code-block:: bash + + chmod +x pytest-mpi + ./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no diff --git a/v1.0.3/_sources/doc_pages/theory.rst.txt b/v1.0.3/_sources/doc_pages/theory.rst.txt new file mode 100644 index 00000000..95d7842c --- /dev/null +++ b/v1.0.3/_sources/doc_pages/theory.rst.txt @@ -0,0 +1,114 @@ +.. _theory-label: + +Theory +###### +Hybrid particle--field simulations switch out the ordinary particle--particle +`Lennard-Jones`_ interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle--field densities are +defined as + +.. math:: + + \phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i), + +where :math:`\mathbf{r}` is a spatial coordinate, :math:`P` is a window function +used to distribute particle number densities onto a computational grid, and +:math:`\mathbf{r}_i` is the position of particle :math:`i` (of total :math:`N`). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of :math:`N` particles in :math:`M` molecules is + +.. math:: + + \mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})] + +with :math:`H_0` being a standard intramolecular Hamiltonian form (see +:ref:`bonds-label`) including kinetic terms, while :math:`W` is a density +dependent *interaction energy functional*. + +In the Hamiltonian hPF-MD formalism :cite:`bore2020hamiltonian`, the density +field is filtered using a grid-independent filtering function :math:`H`, + +.. math:: + + \tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}). + +The filter smooths the density, ensuring that :math:`\tilde\phi` and +:math:`W[\tilde\phi([\phi])]` both converge as the grid size is reduced. + +External potential +================== +The external potential acting on a particle is defined as the functional +derivative of :math:`W` with respect to :math:`\phi`. In the filtered formalism, +the potential takes the form + +.. math:: + + V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ + &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})}, + +under the assumption of a *local* form of the interaction energy functional, +:math:`W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]`. Note +that + +.. math:: + + \frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}). + +Force interpolation +=================== +The forces on particle :math:`i` are obtained by differentiation of the external +potential, + +.. math:: + + \mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i). + + +Reciprocal space calculations +============================= +The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density :math:`\phi_{ijk}` with CIC, we apply the filtering +and obtain the discrete version of the external potential by + +.. math:: + + \tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big] + +and + +.. math:: + + V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +The forces are obtained by differentiation of :math:`V` in Fourier space as + +.. math:: + + \nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +Filter +====== +By default, the filter used in HyMD is a simple Gaussian of the form + +.. math:: + + H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ + \hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +For more details about the filtering, see :ref:`filtering-label`. + +Hamiltonian form +================ +The default form of the interaction energy functional in HyMD is + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2. + +See :ref:`functionals-label` for details. + + +.. _`Lennard-Jones`: + https://en.wikipedia.org/wiki/Lennard-Jones_potential diff --git a/v1.0.3/_sources/doc_pages/topology_input.rst.txt b/v1.0.3/_sources/doc_pages/topology_input.rst.txt new file mode 100644 index 00000000..adabe129 --- /dev/null +++ b/v1.0.3/_sources/doc_pages/topology_input.rst.txt @@ -0,0 +1,77 @@ +.. _topology-label: + +============================ +Topology and structure file +============================ +The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root :code:`/` group. + +The `HyMD-tutorial`_ has multiple examples of structure files for various levels +of complexity. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Required datasets +================= +:/coordinates: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/indices: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/names: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`string` (:code:`length` between :code:`1` and :code:`16`)] + + The shape represents one particle name per :code:`N` particles. The datatype may be a string of length :code:`=<16`. + + + +Optional datasets +================= +:/velocities: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/types: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle type index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/molecules: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one molecule index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/bonds: + :code:`array` shape [:code:`N`, :code:`B`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents :code:`B` bond specifications (indices of different particles) per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/charge: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents one particle charge per :code:`N` particles. The data type may be either four or eight byte reals. diff --git a/v1.0.3/_sources/index.rst.txt b/v1.0.3/_sources/index.rst.txt new file mode 100644 index 00000000..ff4059ba --- /dev/null +++ b/v1.0.3/_sources/index.rst.txt @@ -0,0 +1,168 @@ +.. hymd documentation master file, created by + sphinx-quickstart on Thu Dec 16 13:31:43 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +############################### +HylleraasMD documentation +############################### + +:Release: + |release| +:Date: + |today| + +**HylleraasMD** (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems. + +HyMD can run canonical hPF-MD simulations :cite:`Milano2009JCP`, or filtered +density Hamiltonian hPF (HhPF-MD) simulations :cite:`bore2020hamiltonian`, with +or without explicit PME electrostatic interactions :cite:`kolli2018JCTC`. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +:cite:`Cascella2008,bore2018hybrid`. Martini +style elastic networks (ElNeDyn) :cite:`periole2009combining` are also +supported. + +HyMD uses the pmesh (`github.com/rainwoodman/pmesh`_) library for particle-mesh +operations, with the PPFT :cite:`pippig2013pfft` backend for FFTs through the +pfft-python bindings (`github.com/rainwoodman/pfft-python`_). File IO is done +via HDF5 formats to allow MPI parallel reads. + +User Guide +========== +The HylleraasMD :doc:`User Guide ` provides comprehensive information on how to run +simulations. Selected :doc:`Examples ` are available to guide new users. + +.. _`github.com/rainwoodman/pmesh`: + https://github.com/rainwoodman/pmesh +.. _`github.com/rainwoodman/pfft-python`: + https://github.com/rainwoodman/pfft-python + +Installing HyMD +=============== +The easiest approach is to install using pip_: + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + +For more information and **required dependencies**, see +:ref:`installation-label`. + +.. _pip: + http://www.pip-installer.org/en/latest/index.html + + +Run in Google colab +------------------- +Run HyMD interactively in `Google Colaboratory`_ jupyter notebook `here`_. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Source Code +=========== +**Source code** is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the `GNU Lesser General Public +License v3.0`_. Obtain the source code with `git`_: + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git + +.. _GNU Lesser General Public License v3.0: + https://www.gnu.org/licenses/lgpl-3.0.html +.. _git: + https://git-scm.com/ + + +Development +=========== +HyMD is developed and maintained by researchers at the `Hylleraas Centre for +Quantum Molecular Sciences`_ at the `University of Oslo`_. + +|pic1| |pic2| + +.. _`Hylleraas Centre for Quantum Molecular Sciences`: + https://www.mn.uio.no/hylleraas/english/ +.. _`University of Oslo`: + https://www.uio.no/ + +.. |pic1| image:: img/hylleraas_centre_logo_black.png + :target: img/hylleraas_centre_logo_black.png + :width: 250 px + +.. |pic2| image:: img/uio_full_logo_eng_pos.png + :target: img/uio_full_logo_eng_pos.png + :width: 325 px + + + +References +========== +.. bibliography:: + :all: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. Contents +.. ======== + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Getting started + + ./doc_pages/installation + ./doc_pages/overview + ./doc_pages/config_file + ./doc_pages/topology_input + ./doc_pages/command_line + ./doc_pages/constants_and_units + + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Examples + + ./doc_pages/examples + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Theory + + ./doc_pages/theory + ./doc_pages/intramolecular_bonds + ./doc_pages/electrostatics + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Developer documentation + + ./doc_pages/interaction_energy_functionals + ./doc_pages/filtering + ./doc_pages/benchmarks + ./doc_pages/api diff --git a/v1.0.3/_static/basic.css b/v1.0.3/_static/basic.css new file mode 100644 index 00000000..be19270e --- /dev/null +++ b/v1.0.3/_static/basic.css @@ -0,0 +1,856 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/v1.0.3/_static/css/badge_only.css b/v1.0.3/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/v1.0.3/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/v1.0.3/_static/css/fonts/Roboto-Slab-Bold.woff b/v1.0.3/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/v1.0.3/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/v1.0.3/_static/css/fonts/Roboto-Slab-Bold.woff2 b/v1.0.3/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/v1.0.3/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/v1.0.3/_static/css/fonts/Roboto-Slab-Regular.woff b/v1.0.3/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/v1.0.3/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/v1.0.3/_static/css/fonts/Roboto-Slab-Regular.woff2 b/v1.0.3/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/v1.0.3/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/v1.0.3/_static/css/fonts/fontawesome-webfont.eot b/v1.0.3/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/v1.0.3/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/v1.0.3/_static/css/fonts/fontawesome-webfont.svg b/v1.0.3/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/v1.0.3/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v1.0.3/_static/css/fonts/fontawesome-webfont.ttf b/v1.0.3/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/v1.0.3/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/v1.0.3/_static/css/fonts/fontawesome-webfont.woff b/v1.0.3/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/v1.0.3/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/v1.0.3/_static/css/fonts/fontawesome-webfont.woff2 b/v1.0.3/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/v1.0.3/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/v1.0.3/_static/css/fonts/lato-bold-italic.woff b/v1.0.3/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/v1.0.3/_static/css/fonts/lato-bold-italic.woff differ diff --git a/v1.0.3/_static/css/fonts/lato-bold-italic.woff2 b/v1.0.3/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/v1.0.3/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/v1.0.3/_static/css/fonts/lato-bold.woff b/v1.0.3/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/v1.0.3/_static/css/fonts/lato-bold.woff differ diff --git a/v1.0.3/_static/css/fonts/lato-bold.woff2 b/v1.0.3/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/v1.0.3/_static/css/fonts/lato-bold.woff2 differ diff --git a/v1.0.3/_static/css/fonts/lato-normal-italic.woff b/v1.0.3/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/v1.0.3/_static/css/fonts/lato-normal-italic.woff differ diff --git a/v1.0.3/_static/css/fonts/lato-normal-italic.woff2 b/v1.0.3/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/v1.0.3/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/v1.0.3/_static/css/fonts/lato-normal.woff b/v1.0.3/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/v1.0.3/_static/css/fonts/lato-normal.woff differ diff --git a/v1.0.3/_static/css/fonts/lato-normal.woff2 b/v1.0.3/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/v1.0.3/_static/css/fonts/lato-normal.woff2 differ diff --git a/v1.0.3/_static/css/theme.css b/v1.0.3/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/v1.0.3/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/v1.0.3/_static/custom.css b/v1.0.3/_static/custom.css new file mode 100644 index 00000000..b20d6282 --- /dev/null +++ b/v1.0.3/_static/custom.css @@ -0,0 +1,91 @@ + +body{ + background: #FFFFFF !important; +} + +.wy-menu-vertical header, .wy-menu-vertical p.caption{ + color: #4EA0AF!important; +} +.wy-menu-vertical li.current{ + background-color: #f4f4f4!important; +} +.wy-menu-vertical li.toctree-l2.current>a{ + background-color: #ebebeb!important; +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{ + background-color: #e3e3e3!important; +} + +.rst-content .sidebar{ + background-color: #fff!important; + border-radius: 6px; + -moz-border-radius: 6px; + -webkit-border-radius: 6px; +} + +h1 > a, h2 > a, h3 > a, h4 > a, h5 > a, h6 > a { + color: #17d9ff; +} + +h1, h2, h3, h4, h5, h6 { + color: black; + font-weight: normal; + padding: 0; +} + +h1, h2, h3 { + margin-top: 30px; + margin-bottom: 20px; +} + +h1 { + color: white; + padding: 20px 20px 20px 45px; + margin: 20px 0 35px -45px; + background: linear-gradient(to left, #fff, #2b38ff)!important; + + width: calc(100% + 90px); + border-bottom: 3px solid #000; +} + +h2 { + padding: .2em 0; + border-bottom: 1px solid #ddd; +} + +h3 { + margin-top: 35px; +} + +h4 { + margin-top: 30px; +} + +h5 { + margin-top: 25px; +} + +.wy-nav-content{ + max-width: none!important; +} + +.wy-side-nav-search{ + background: #2b38ff!important; +} + +.wy-side-nav-search input[type=text]{ + border-color:#4DA0B0!important; +} + +.wy-side-nav-search input[type=text]{ + border-radius: 4px!important; +} + +#caption-api { + background: red !important; +} + +#caption-text-api { + text-color: blue !important; +} diff --git a/v1.0.3/_static/doctools.js b/v1.0.3/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/v1.0.3/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/v1.0.3/_static/documentation_options.js b/v1.0.3/_static/documentation_options.js new file mode 100644 index 00000000..92593364 --- /dev/null +++ b/v1.0.3/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '1.0.3', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/v1.0.3/_static/file.png b/v1.0.3/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/v1.0.3/_static/file.png differ diff --git a/v1.0.3/_static/hymd_icon_white.png b/v1.0.3/_static/hymd_icon_white.png new file mode 100644 index 00000000..d0396a17 Binary files /dev/null and b/v1.0.3/_static/hymd_icon_white.png differ diff --git a/v1.0.3/_static/hymd_logl_white_text_abbr.png b/v1.0.3/_static/hymd_logl_white_text_abbr.png new file mode 100644 index 00000000..8c0e50c8 Binary files /dev/null and b/v1.0.3/_static/hymd_logl_white_text_abbr.png differ diff --git a/v1.0.3/_static/jquery-3.5.1.js b/v1.0.3/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/v1.0.3/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. API reference

+
+

4.1. Integrator

+

Integrates equations of motion.

+

Implements the Velocity Verlet integrator. The reversible reference system +propagator algorithm (rRESPA) integrator uses the Velocity Verlet functions +inside the MD loop in the main module.

+
+
+hymd.integrator.integrate_position(positions, velocities, time_step)[source]
+

Position update step of the Velocity Verlet integration algorithm.

+

Computes the position update step of the Velocity Verlet algorithm. The +positions argument is not changed in place.

+
+
Parameters:
+
+
positions(N, D) numpy.ndarray

Array of positions of N particles in D dimensions.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_velocity

The velocity update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step, then the positions are updated a full step using the updated +velocities

+
+\[\mathbf{x}_{\text{new}} = \mathbf{x} + \Delta t \mathbf{v}\]
+
+ +
+
+hymd.integrator.integrate_velocity(velocities, accelerations, time_step)[source]
+

Velocity update step of the Velocity Verlet integration algorithm.

+

Computes the velocity update step of the Velocity Verlet algorithm. The +velocities argument is not changed in place.

+
+
Parameters:
+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
accelerations(N, D) numpy.ndarray

Array of accelerations of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_position

The position update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step

+
+\[\mathbf{v}_{\text{new}} = \mathbf{v} + \frac{\Delta t}{2m} +\mathbf{f}\]
+

before the positions are moved a full step using the updated half-step +velocities.

+
+ +
+
+

4.2. Thermostat

+

Scales or otherwise modifies the particle velocities during simulation to +simulate coupling to an external heat bath with temperature T₀.

+
+
+hymd.thermostat._random_chi_squared(prng: numpy.random._generator.Generator, M: int)float[source]
+

Draw the sum of M squared normally distributed values

+

The value is generated by the Gamma distribution, in lieu of generating +M Gaussian distributed numbers and summing their squares.

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
Mint

Number of standard normally distributed numbers in the sum.

+
+
+
+
Returns:
+
+
float

The sum of M squared normally distributed values centered at +zero with unit standard deviation.

+
+
+
+
+

Notes

+

The sum of the squares of k independent standard normal random variables is +distributed according to a \(\chi^2\) distribution.

+
+\[\chi^2_1 + \chi_2^2 + \chi_3^2 + \dots + \chi_M^2 +\sim +\sigma^2\chi^2(k)\]
+

This is a special case of the \(\Gamma\) distribution, +\(\Gamma(k/2, 2)\), and may be generated by

+
+\[\chi^2(k) \sim 2 \Gamma(k/2, 2)\]
+

References

+

Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of +Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. +J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246.

+
+ +
+
+hymd.thermostat._random_gaussian(prng: numpy.random._generator.Generator)float[source]
+

Draw a single random number from the standard normal distribution +Generate a number from the Gaussian distribution centered at zero with unit +standard deviation, \(N(0, 1)\).

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
+
+
Returns:
+
+
float

A random number drawn from \(N(0, 1)\).

+
+
+
+
+
+ +
+
+hymd.thermostat.csvr_thermostat(velocity: numpy.ndarray, names: numpy.ndarray, config: hymd.input_parser.Config, prng: numpy.random._generator.Generator, comm: mpi4py.MPI.Intracomm = <mpi4py.MPI.Intracomm object>, random_gaussian: Callable[[numpy.random._generator.Generator], float] = <function _random_gaussian>, random_chi_squared: Callable[[numpy.random._generator.Generator, int, float], float] = <function _random_chi_squared>, remove_center_of_mass_momentum: bool = True)numpy.ndarray[source]
+

Canonical sampling through velocity rescaling thermostat

+

Implements the CSVR thermostat. Rescales the system kinetic energy by a +stochastically chosen factor to keep the temperature constant. Requires +communcation of the kinetic energies calculated locally for each MPI rank. +The random numbers sampled through random_gaussian and +random_chi_squared are broadcast from the root rank to the other +ranks to ensure the scaling is performed with the same stochasticity for +all particles in the full system.

+

The velocities are cleaned of center of mass momentum before the thermostat +is applied, and the center of mass momentum is subsequently reapplied. This +is performed for each thermostat coupling group, i.e. the center of mass +momenta of each group is separately removed and reapplied after +thermostatting.

+

The implementation here is based on the derivation presented in the 2008 +Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper.

+
+
Parameters:
+
+
velocity(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
names(N,) numpy.ndarray

Array of particle names.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
random_gaussiancallable, optional

Function for generating standard normally distributed numbers.

+
+
random_chi_squaredcallable, optional

Function for generating \(\chi^2\)-distributed numbers

+
+
remove_center_of_mass_momentumbool, optional

If True, the center of mass of each coupling group is removed before +the thermostat is applied. The center of mass momenta are added back +after the kinetic energy rescaling is complete.

+
+
+
+
+
+

See also

+
+
_random_gaussian

Used to sample Gaussian-distributed numbers.

+
+
_random_chi_squared

Used to sample \(\chi^2\)-distributed numbers.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +

References

+

G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). +G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008).

+
+ +
+
+

4.3. Hamiltonian

+
+
+class hymd.hamiltonian.Hamiltonian(config)[source]
+

Interaction energy functional superclass

+
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+_setup()[source]
+

Superclass setup

+

Sets up the grid-independent filtering function H, and the +SymPy logic for symbolically differentiating interaction energy +functionals in Hamiltonian subclasses.

+
+ +
+ +
+
+class hymd.hamiltonian.SquaredPhi(config)[source]
+

Simple squared density interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + \sum_k \tilde\phi_k + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(rho_0\) is the +average density of the fully homogenous system. Expressing the species +densities in terms of fluctuations from the average,

+
+\[\mathrm{d}\tilde\phi_k = \rho_0 - \tilde\phi_k,\]
+

it is evident that this interaction energy functional is a slight change of +the DefaultNoChi Hamiltonian, as the expanded interaction energy +density becomes

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + 6\rho_0\left[ + \sum_k \mathrm{d}\tilde\phi_k + \right] + + + 9\rho_0^2 + + + \sum_k \mathrm{d}\tilde\phi_k^2 + + + \prod_{k\not=l} + \mathrm{d}\tilde\phi_k \mathrm{d}\tilde\phi_l + \right),\]
+

identical to DefaultNoChi apart from a constant energy shift +\(9\rho_0^2`(which does not impact dynamics) and the +:math:\)rho_0`–\(\mathrm{d}\tilde\phi_k\) cross-terms. These +cross-terms constitute contributions to the energy linear in +\(\mathrm{d}\tilde\phi_k\) absent in DefaultNoChi, which has +only quadratic terms present.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultNoChi(config)[source]
+

Incompressibility-only interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a +\right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. The SquaredPhi Hamiltonian implements a similar +functional with an additional linear term component depending on

+
+\[\mathmr{d}\tilde\phi_k = \tilde\phi_k - \rho_0\]
+

and not \(\mathrm{d}\tilde\phi_k^2\). No explicit inter-species +interaction is present apart from the indirect interaction through the +incompressibility.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultWithChi(config, unique_names, type_to_name_map)[source]
+

Incompressibility and \(\chi\)-interactions energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = + \frac{1}{2\rho_0} + \sum_{k,l}\chi_{kl} \tilde\phi_k \tilde\phi_l + + + \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. \(\chi_{ij}\) is the Flory-Huggins-like +inter-species mixing energy.

+
+
+__init__(config, unique_names, type_to_name_map)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup(unique_names, type_to_name_map)[source]
+

Setup the interaction energy potential and the external potential

+
+
Parameters:
+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+ +
+ +
+
+

4.4. Force

+

Calculates intramolecular forces between bonded particles in molecules

+
+
+class hymd.force.Angle(atom_1: str, atom_2: str, equilibrium: float, strength: float, atom_3: str)[source]
+

Dataclass representing a single three-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any three-particle bond between particles of specific types A, +B, and C (where A, B, and C may be +different or the same). Harmonic angular three-particle bonds in HyMD take +the form

+
+\[V_3(\mathbf{r}_1, \mathbf{r}_2, \mathbf{r}_3) = + \frac{1}{2}k + \left( + \cos^{-1} + \left[ + \frac{ + (\mathbf{r}_1-\mathbf{r}_2) + \cdot + (\mathbf{r}_3-\mathbf{r}_2) + } + { + \vert\mathbf{r}_1-\mathbf{r}_2\vert + \vert\mathbf{r}_3-\mathbf{r}_2\vert + } + \right] - \theta_0 + \right)^2\]
+
+

See also

+
+
Bond

Two-particle bond type dataclass

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
equilibriumfloat

Equilibrium angle at which the energy associated with the +three-particle angular bond vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient.

+
+
+
+
+
+
+atom_3: str
+
+ +
+ +
+
+class hymd.force.Bond(atom_1: str, atom_2: str, equilibrium: float, strength: float)[source]
+

Dataclass representing a single two-particle bond type

+

A bond type is a bond strength and equilibrium distance associated with +any bond between particles of specific types A and B +(where A and B may be the same or different). Harmonic +two-particle bonds in HyMD take the form

+
+\[V_2(\mathbf{r}_1, \mathbf{r}_2) = + \frac{1}{2}k + \left( + \vert \mathbf{r}_1 - \mathbf{r}_2 \vert - r_0 + \right)^2,\]
+

where \(k\) is the bond strength (spring constant) and \(r_0\) is +the equilibrium bond length (at which the energy is zero).

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
equilibriumfloat

Equilibrium distance at which the energy associated with the bond +vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient (spring constant).

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+equilibrium: float
+
+ +
+
+strength: float
+
+ +
+ +
+
+class hymd.force.Chi(atom_1: str, atom_2: str, interaction_energy: float)[source]
+

Dataclass representing a single \(\chi\) mixing interaction type

+

An interaction mixing energy type is a mixing energy associated with +density overlap between species of types A and B +(specified as inputs atom_1 and atom_2). A positive mixing +energy promotes phase separation, a negative mixing energy promotes mixing. +The interaction energy density (provided the DefaultWithChi +Hamiltonian is used) takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} + \sum_{k,l}\chi_{k,l} \tilde\phi_k\tilde\phi_l,\]
+

where \(\chi_{k,l}\) denotes the mixing energy between species +\(k\) and \(l\), with \(\kappa\) being the incompressibility. +The value of the interaction mixing energy parameter may be extracted from +Flory-Huggins theory.

+
+

See also

+
+
hymd.hamiltonian.DefaultWithChi

Interaction energy functional using \(\chi\)-interactions.

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
interaction_energyfloat

Interaction mixing energy.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+interaction_energy: float
+
+ +
+ +
+
+class hymd.force.Dielectric_type(atom_1: str, dielectric_value: float)[source]
+
+
+atom_1: str
+
+ +
+
+dielectric_value: float
+
+ +
+ +
+
+class hymd.force.Dihedral(atom_1: str, atom_2: str, atom_3: str, atom_4: str, coeffs: numpy.ndarray, dih_type: int)[source]
+

Dataclass representing a single four-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any four-particle torsional bond between particles of specific types +A, B, C, and D (where A, B, +C, and D may be different or the same). Dihedral +four-particle bonds in HyMD take different forms depending on the +dih_type parameter.

+

In the following, let \(\phi\) denote the angle between the planes +spanned by the relative positions of atoms A-B-C +and B-C-D. If dih_type = 0, then

+
+\[V_4(\phi) = \sum_n c_n + \left( + 1 + \cos\left[ + n\phi - d_n + \right] + \right),\]
+

where \(c_n\) are energy coefficients and \(d_n\) are propensity +phases. By default, the cosine sum is truncated at five terms. If +coeffs provides only a single float, this is used as the coiling +propensity parameter \(\lambda\). In this case, \(c_n\) and +\(d_n\) are automatically set to values which promote alpha helical +(\(\lambda=-1\)), beta sheet (\(\lambda=1\)), or a mixed +(\(1>\lambda>-1\)) structure (using values provided by Bore et al. +(2018)). In this case, the full potential takes the form

+
+\[V_4(\phi;\lambda) = + \frac{1}{2}(1-\lambda) V_{\text{prop},\alpha}(\phi) + + + \frac{1}{2}(1+\lambda) V_{\text{prop},\beta}(\phi) + + + (1-\vert\lambda\vert) V_{\text{prop}, \text{coil}}(\phi),\]
+

with each of the \(V_{\mathrm{prop}, X}\) being fixed cosine series +potentials with pre-set \(c_n\) -s and \(d_n\) -s.

+

If dih_type = 1, then a combined bending torsional (CBT) potential +is employed,

+
+\[V_4(\phi,\gamma;\lambda) = + V_4(\phi;\lambda) + + + \frac{1}{2}K(\phi)(\gamma - \gamma_0)^2,\]
+

where \(V_4(\phi;\lambda)\) specifies the potential as given by the +coiling propensity parameter above, \(K(\phi)\) is a separate cosine +series potential acting as the angular three-particle bond strength, and +\(\gamma_0\) is the three-particle bond equilibrium angle. In this +case, the coeffs parameter must specify both a \(\lambda\) +value, in additon to the energy and phases dictating the \(K(\phi)\) +potential.

+

References

+

Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018.

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
atom_4str

Type name of particle 4.

+
+
coeffslist[list[float]] or list[float] or numpy.ndarray

Dihedral coefficients defining the series expansion of the dihedral +energy.

+
+
dih_typeint

Specifies the type of dihedral used; If 0, then coeffs +must contain either two lists of five energy coefficients +\(c_n\) and five propensity phases \(d_n\) or a single +floating point number defining the \(\lambda\) coiling propensity +parameter. If 1, the combined bending-torsional potential is +used, and coeffs must specify \(\lambda\) and two lists +containing energy coefficients and propensity phases for the +\(V_\text{prop}\) propensity potential, defined in terms of cosine +series.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+atom_3: str
+
+ +
+
+atom_4: str
+
+ +
+
+coeffs: numpy.ndarray
+
+ +
+
+dih_type: int
+
+ +
+ +
+
+hymd.force.compute_angle_forces__plain(f_angles, r, bonds_3, box_size)[source]
+

Computes forces resulting from angular interactions

+
+

Deprecated since version 1.0.0: compute_angle_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_bond_forces__plain(f_bonds, r, bonds_2, box_size)[source]
+

Computes forces resulting from bonded interactions

+
+

Deprecated since version 1.0.0: compute_bond_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size)[source]
+

Computes forces resulting from dihedral interactions

+
+

Deprecated since version 1.0.0: compute_dihedral_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.dipole_forces_redistribution(f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb)[source]
+

Redistribute electrostatic forces calculated from topologically +reconstructed ghost dipole point charges to the backcone atoms of the protein.

+
+ +
+
+hymd.force.find_all_paths(G, u, n)[source]
+

Helper function that recursively finds all paths of given lenght ‘n + 1’ inside a network ‘G’. +Adapted from https://stackoverflow.com/a/28103735.

+
+ +
+
+hymd.force.prepare_bonds(molecules, names, bonds, indices, config, topol=None)[source]
+

Rearrange the bond information for usage in compiled Fortran kernels

+

Restructures the lists resulting from the execution of +prepare_bonds_old into numpy arrays suitable for calls to optimized +Fortran code calculating bonded forces and energiesself.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2_atom_1(B,) numpy.ndarray

Local index of particle 1 for each of B constructed +two-particle bonds.

+
+
bonds_2_atom_2(B,) numpy.ndarray

Local index of particle 2 for each of B constructed +two-particle bonds.

+
+
bonds_2_equilibrium(B,) numpy.ndarray

Equilibrium distance for each of B constructed two-particle +bonds.

+
+
bonds_2_strength(B,) numpy.ndarray

Bond strength for each of B constructed two-particle +bonds.

+
+
bonds_3_atom_1(A,) numpy.ndarray

Local index of particle 1 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_2(A,) numpy.ndarray

Local index of particle 2 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_3(A,) numpy.ndarray

Local index of particle 3 for each of A constructed +three-particle bonds.

+
+
bonds_3_equilibrium(A,) numpy.ndarray

Equilibrium angle for each of A constructed three-particle +bonds.

+
+
bonds_3_strength(A,) numpy.ndarray

Bond strength for each of A constructed three-particle +bonds.

+
+
bonds_4_atom_1(D,) numpy.ndarray

Local index of particle 1 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_2(D,) numpy.ndarray

Local index of particle 2 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_3(D,) numpy.ndarray

Local index of particle 3 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_4(D,) numpy.ndarray

Local index of particle 4 for each of D constructed +four-particle bonds.

+
+
bonds_4_coeff(D,) numpy.ndarray

Cosine series coefficients for each of D constructed +four-particle bonds.

+
+
bonds_4_type(D,) numpy.ndarray

Dihedral type for each of D constructed four-particle +bonds.

+
+
bonds_4_last(D,) numpy.ndarray

Flags indicating if dih_type is 1 for each of D +constructed four-particle bonds.

+
+
+
+
+
+

See also

+
+
prepare_bonds_old

Used internally to reconstruct the bonded interactions types from the connectivity information in the structure/topology input file and the bonded types specified in the configuration file.

+
+
+ +
+ +
+
+hymd.force.prepare_bonds_old(molecules, names, bonds, indices, config)[source]
+

Find bonded interactions from connectivity and bond types information

+
+

Deprecated since version 1.0.0: prepare_bonds_old was replaced by prepare_bonds for +use with compiled Fortran kernels prior to 1.0.0 release.

+
+

Prepares the necessary equilibrium and bond strength information needed by +the intramolecular interaction functions. This is performed locally on each +MPI rank, as the domain decomposition ensures that for all molecules all +consituent particles are always contained on the same MPI rankself.

+

This function traverses the bond connectivity information provided in the +structure/topology input file and indentifies any two-, three-, or +four-particle potential bonds. For each connected chain of two, three, or +four particles, a matching to bond types is attempted. If the corresponding +names match, a bond object is initialized.

+

In order to investigate the connectivity, a graph is created using +networkx functionality.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2list

List of lists containing local particle indices, equilibrium +distance, and bond strength coefficient for each reconstructed +two-particle bond.

+
+
bonds_3

List of lists containing local particle indices, equilibrium angle, +and bond strength coefficient for each reconstructed three-particle +bond.

+
+
bonds_4

List of lists containing local particle indices, dihedral type index, +and dihedral coefficients for each reconstructed four-particle +torsional bond.

+
+
bb_indexlist

List indicating the dihedral type of each four-particle bond in +bonds_4.

+
+
+
+
+
+

See also

+
+
Bond

Two-particle bond type dataclass.

+
+
Angle

Three-particle angular bond type dataclass.

+
+
Dihedral

Four-particle torsional bond type dataclass.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+hymd.force.prepare_index_based_bonds(molecules, topol)[source]
+
+ +
+
+hymd.force.propensity_potential_coeffs(x: float)[source]
+
+ +
+
+

4.5. Logger

+
+
+class hymd.logger.Logger[source]
+

Log output handler class

+

Notes

+

This wraps the default python library logging, see +docs.python.org/3/library/logging.html.

+
+
Attributes:
+
+
levelint

Determines the verbosity level of the log, corresponding to +logging.level. Numerical values 50 (logging.CRITICAL), +40 (logging.ERROR), 30 +(logging.WARNING), 20 (logging.INFO), +10 (logging.DEBUG), and 0 +(logging.UNSET) are supported values. Any log event message +less severe than the specified level is ignored. All other event +messages are emitted.

+
+
log_filestr

Path to output log file.

+
+
formatstr

Prepended dump string for each log event. Specifies the log event +level, the module emitting the event, the code line, the enclosing +function name, and the MPI rank writing the message.

+
+
date_formatstr

Prepends the date before all log event messages.

+
+
formatterlogging.Formatter

Formatter handling the prepending of the information in format and +date_format to each log event message. Used by default for all +loggers.

+
+
rank0logging.Logger

Default logger object for the root MPI rank.

+
+
all_rankslogging.Logger

Default logger object for messages being emitted from all MPI ranks +simultaneously.

+
+
+
+
+
+
+classmethod setup(default_level=20, log_file=None, verbose=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Sets up the logger object.

+

If a log_file path is provided, log event messages are output +to it. Otherwise, the logging messages are emitted to stdout.

+
+
Parameters:
+
+
default_levelint, optional

Default verbosity level of the logger. Unless specified, it is +10 (logging.INFO).

+
+
log_filestr, optional

Path to output log file. If None or not priovided, no log file is +used and all logging is done to stdout.

+
+
verbosebool, optional

Increases the logging level to 30 (logging.WARNING) +if True, otherwise leaves the logging level unchanged.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterRoot(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the root MPI rank log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterAll(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the all-MPI-ranks log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+

4.6. Input parser

+

Parses and handles the configuration information provided for the simulation

+
+
+class hymd.input_parser.Config(n_steps: int, time_step: float, mesh_size: Union[List[int], numpy.ndarray, int], sigma: float, kappa: float, dtype: Optional[numpy.dtype] = None, box_size: Optional[Union[List[float], numpy.ndarray]] = None, n_print: Optional[int] = None, tau: Optional[float] = None, start_temperature: Optional[Union[float, bool]] = None, target_temperature: Optional[Union[float, bool]] = None, mass: Optional[float] = None, hamiltonian: Optional[str] = None, domain_decomposition: Optional[Union[int, bool]] = None, integrator: Optional[str] = None, respa_inner: int = 1, file_name: str = '<config file path unknown>', name: Optional[str] = None, tags: List[str] = <factory>, bonds: List[hymd.force.Bond] = <factory>, angle_bonds: List[hymd.force.Angle] = <factory>, dihedrals: List[hymd.force.Dihedral] = <factory>, chi: List[hymd.force.Chi] = <factory>, n_particles: Optional[int] = None, max_molecule_size: Optional[int] = None, n_flush: Optional[int] = None, thermostat_work: float = 0.0, thermostat_coupling_groups: List[List[str]] = <factory>, initial_energy: Optional[float] = None, cancel_com_momentum: Union[int, bool] = False, coulombtype: Optional[str] = None, convergence_type: Optional[str] = None, pol_mixing: Optional[float] = None, dielectric_const: Optional[float] = None, conv_crit: Optional[float] = None, dielectric_type: List[hymd.force.Dielectric_type] = <factory>, self_energy: Optional[float] = None, type_charges: Optional[Union[List[float], numpy.ndarray]] = None, rho0: Optional[float] = None, a: Optional[float] = None, pressure: bool = False, barostat: Optional[str] = None, barostat_type: Optional[str] = None, tau_p: Optional[float] = None, target_pressure: List[hymd.barostat.Target_pressure] = <factory>, n_b: Optional[int] = None, m: List[float] = <factory>)[source]
+

Configuration object

+

Handles and verifies the simulation configuration specified in the +configuration file.

+
+

See also

+
+
hymd.input_parser.Bond

Two-particle bond type dataclass.

+
+
hymd.input_parser.Angle

Three-particle bond type dataclass.

+
+
hymd.input_parser.Dihedral

Four-particle bond type dataclass.

+
+
+ +
+
Attributes:
+
+
gas_constantfloat

Constant value of the gas constant, R (equivalently the Boltzmann +constant) in the units used internally in HyMD.

+
+
coulomb_constantfloat

Constant value of the Coulomb constant which converts electric field +values to forces and electric potential values to energies in the units +used internally in HyMD.

+
+
n_steps: int

Number of time steps in the simulation.

+
+
time_step: float

Outer time step used in the simulation. If the rRESPA intergrator is +used, the inner time step (the time step used in the integration of +intramolecular bending, stretching, and torsional forces) is +time_step / respa_inner.

+
+
box_sizelist[float] or (D,) numpy.ndarray

Simulation box size of simulation in D dimensions in units of +nanometers.

+
+
mesh_sizelist[int] or int or numpy.ndarray

Number of grid points used for the discrete density grid.

+
+
sigmafloat

Filter width representing the effective coarse-graining level of the +particles in the simulation.

+
+
kappafloat

Compressibility parameter used in the relaxed incompressibility term in +the interaction energy functional.

+
+
n_printint, optional

Frequency of trajectory/energy output to the H5MD trajectory/energy +output file (in units of number of time steps).

+
+
taufloat, optional

The time scale of the CSVR thermostat coupling.

+
+
start_temperaturefloat, optional

Generate starting temperature by assigning all particle velocities +randomly according to the Maxwell-Boltzmann distribution at +start_temperature Kelvin prior to starting the simulation.

+
+
target_temperaturefloat, optional

Couple the system to a heat bath at target_temperature Kelvin.

+
+
massfloat, optional

Mass of the particles in the simulation.

+
+
hamiltonianstr, optional

Specifies the interaction energy functional \(W[\tilde\phi]\) +for use with the particle-field interactions. Options: +SquaredPhi, DefaultNohChi, or DefaultWithChi.

+
+
domain_decompositionint, optional

Specifies the interval (in time steps) of domain decomposition +exchange, involving all MPI ranks sending and receiving particles +according to the particles’ positions in the integration box and the +MPI ranks’ assigned domain.

+
+
integratorstr, optional

Specifies the time integrator used in the simulation. Options: +velocity-verlet or respa.

+
+
respa_innerint, optional

The number of inner time steps in the rRESPA integrator. This denotes +the number of intramolecular force calculations (stretching, bending, +torsional) are performed between each impulse applied from the field +forces.

+
+
file_namestr, optional

File path of the parsed configuration file.

+
+
namestr, optional

Name for the simulation.

+
+
tagslist[str], optional

Tags for the simulation.

+
+
bondslist[Bond], optional

Specifies harmonic stretching potentials between particles in the +same molecule.

+
+
angle_bondslist[Angle], optional

Specifies harmonic angular bending potentials between particles in the +same molecule.

+
+
dihedralslist[Dihedral], optional

Specifies four-particle torsional potentials by cosine series.

+
+
chilist[Chi], optional

Specifies \(\chi\)-interaction parameters between particle +species.

+
+
n_particlesint, optional

Specifies the total number of particles in the input. Optional keyword +for validation, ensuring the input HDF5 topology has the correct number +of particles and molecules.

+
+
max_molecule_sizeint, optional

Maximum size of any single molecule in the system. Used to speed up +distribution of particles onto MPI ranks in a parallel fashion.

+
+
n_flushint, optional

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be +written to disk (in units of number of n_print).

+
+
thermostat_workfloat

Work performed by the thermostat on the system.

+
+
thermostat_coupling_groupslist[str], optional

Specifies individual groups coupling independently to the CSVR +thermostat. E.g. in a system containing "A", "B", and +"C" type particles, +thermostat_coupling_groups = [["A", "B"], ["C"],] would +thermalise types "A" and "B" together and couple +"C" type particles to a different thermostat (all individual +thermostats are at the same temperature, i.e. target_temperature +Kelvin).

+
+
initial_energyfloat

Value of the total energy prior to the start of the simulation.

+
+
cancel_com_momentumint, optional

If True, the total linear momentum of the center of mass is +removed before starting the simulation. If an integer is specifed, the +total linear momentum of the center of mass is removed every +remove_com_momentum time steps. If False, the linear +momentum is never removed.

+
+
coulombtypestr, optional

Specifies the type of electrostatic Coulomb interactions in the system. +The strength of the electrostatic forces is modulated by the relative +dielectric constant of the simulation medium, specified with the +dielectric_const keyword. Charges for individual particles are +specified in the structure/topology HDF5 input file, not in the +configuration file. If no charges (or peptide backbone dipoles) are +present, the electrostatic forces will not be calculated even if this +keyword is set to "PIC_Spectral".

+
+
dielectric_constfloat, optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. When +using helical propensity dihedrals, this keyword must be specified—even +if electrostatics are not included with the coulombtype +keyword.

+
+
dielectric_type: list[float], optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. The list assigns +relative dielectric values to each bead type, and an anisotropic +dielectric function is obtained from a weighted average.

+
+
+
+
+
+
+a: float = None
+
+ +
+
+angle_bonds: List[hymd.force.Angle]
+
+ +
+
+barostat: str = None
+
+ +
+
+barostat_type: str = None
+
+ +
+
+bonds: List[hymd.force.Bond]
+
+ +
+
+box_size: Union[List[float], numpy.ndarray] = None
+
+ +
+
+cancel_com_momentum: Union[int, bool] = False
+
+ +
+
+chi: List[hymd.force.Chi]
+
+ +
+
+conv_crit: float = None
+
+ +
+
+convergence_type: str = None
+
+ +
+
+coulomb_constant: ClassVar[float] = 138.935458
+
+ +
+
+coulombtype: str = None
+
+ +
+
+dielectric_const: float = None
+
+ +
+
+dielectric_type: List[hymd.force.Dielectric_type]
+
+ +
+
+dihedrals: List[hymd.force.Dihedral]
+
+ +
+
+domain_decomposition: Union[int, bool] = None
+
+ +
+
+dtype: numpy.dtype = None
+
+ +
+
+file_name: str = '<config file path unknown>'
+
+ +
+
+gas_constant: ClassVar[float] = 0.0083144621
+
+ +
+
+hamiltonian: str = None
+
+ +
+
+initial_energy: float = None
+
+ +
+
+integrator: str = None
+
+ +
+
+kappa: float
+
+ +
+
+m: List[float]
+
+ +
+
+mass: float = None
+
+ +
+
+max_molecule_size: int = None
+
+ +
+
+mesh_size: Union[List[int], numpy.ndarray, int]
+
+ +
+
+n_b: int = None
+
+ +
+
+n_flush: int = None
+
+ +
+
+n_particles: int = None
+
+ +
+
+n_print: int = None
+
+ +
+
+n_steps: int
+
+ +
+
+name: str = None
+
+ +
+
+pol_mixing: float = None
+
+ +
+
+pressure: bool = False
+
+ +
+
+respa_inner: int = 1
+
+ +
+
+rho0: float = None
+
+ +
+
+self_energy: float = None
+
+ +
+
+sigma: float
+
+ +
+
+start_temperature: Union[float, bool] = None
+
+ +
+
+tags: List[str]
+
+ +
+
+target_pressure: List[hymd.barostat.Target_pressure]
+
+ +
+
+target_temperature: Union[float, bool] = None
+
+ +
+
+tau: float = None
+
+ +
+
+tau_p: float = None
+
+ +
+
+thermostat_coupling_groups: List[List[str]]
+
+ +
+
+thermostat_work: float = 0.0
+
+ +
+
+time_step: float
+
+ +
+
+type_charges: Union[List[float], numpy.ndarray] = None
+
+ +
+ +
+
+hymd.input_parser.check_NPT_conditions(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check validity of barostat_type, barostat, +a, rho0, target_pressure, tau_p

+
+ +
+
+hymd.input_parser.check_angles(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_bonds(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_box_size(config, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_cancel_com_momentum(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_charges(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if charges across ranks sum to zero.

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of floats with charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_charges_types_list(config, types, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates a list of charge values of length types. +Charges are sorted according to type ID. Used in field.py. +# TODO: this is messy, we should fix it

+
+ +
+
+hymd.input_parser.check_chi(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_config(config, indices, names, types, charges, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs various checks on the specfied config to ensure consistency

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
indices(N,) numpy.ndarray

Array of integer indices for N particles.

+
+
names(N,) numpy.ndarray

Array of string names for N particles.

+
+
types(N,) numpy.ndarray

Array of integer type indices for N particles.

+
+
charges(N,) numpy.ndarray

Array of floats charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
Returns:
+
+
configConfig

Validated configuration object.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_dielectric(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Error handling for electrostatics. +Unit testing of toml/tomli input.

+
+ +
+
+hymd.input_parser.check_dihedrals(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_domain_decomposition(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_hamiltonian(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_integrator(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_m(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_mass(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_max_molecule_size(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_b(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_flush(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_particles(config, indices, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_print(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_name(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_start_and_target_temperature(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Validate provided starting and target thermostat temperatures

+

Assesses the provided temperature target and ensures it is a non-negative +floating point number or False. Ensures the starting temperature is +a non-negative floating point number or False.

+

If the value for either is None, the returned configuration object +has the values defaulted to False in each case.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
validated_configConfig

Configuration object with validated target_temperature and +start_temperature.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_tau(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_thermostat_coupling_groups(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.parse_config_toml(toml_content, file_path=None, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.read_config_toml(file_path)[source]
+
+ +
+
+hymd.input_parser.sort_dielectric_by_type_id(config, charges, types)[source]
+

Creates a list of length N CG-particles, sorted after the charges from +the input HDF5 file. Used in file_io.py

+
+ +
+
+

4.7. Field

+

Forces and energies from the discretized particle-field grid interactions

+
+
+hymd.field.compute_field_and_kinetic_energy(phi, phi_q, psi, velocity, hamiltonian, positions, types, v_ext, config, layouts, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the particle-field and kinetic energy contributions

+

Calculates the kinetic energy through

+
+\[E_k = \sum_j \frac{1}{2}m_j\mathbf{v}_j\cdot\mathbf{v}_j,\]
+

and the particle-field energy by

+
+\[E_\text{field} = \int\mathrm{d}\mathbf{r}\, + w[\tilde\phi],\]
+

where \(w\) is the interaction energy functional density.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
velocity(N,D) numpy.ndarray

Array of velocities for N particles in D dimensions. +Local for each MPI rank.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Local for each MPI rank–the full computational grid is +represented by the collective fields of all MPI ranks.

+
+
configConfig

Configuration object.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field

Computes the up-to-date external potential for use in calculating the particle-field energy.

+
+
+ +
+ +
+
+hymd.field.compute_field_energy_q_GPE(config, phi_eps, field_q_energy, dot_elec, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the electrostatic energy after electrosatic forces is +calculated.

+

From the definition of the elecrostatic potential \(\Psi\), the energy +is

+
+
+
W = frac{1}{2}intmathrm{d}mathbf{r},

epsilon(mathbf{r})} left(mathbf{E}cdot mathbf{E}right),

+
+
+
+

where \(\epsilon(\mathbf{r})}\) is the anisotropic, spatially dependent, +relative dielectric of the simulation medium.

+
+
Parameters:
+
+
confighymd.input_parser.Config

Configuration object.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
field_q_energyfloat

Total elecrostatic energy.

+
+
dot_elecpmesh.pm.RealField

Pmesh RealField object for storing \(|\mathbf{E(r)}|^{2}\) +on the computational grid. Local for each MPI rank – the full computational +grid is represented by the collective fields of all MPI ranks.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field_force_q_GPE

Compute the electrosatic force from an anisotropic dielectric general Poisson equation.

+
+
+ +
+ +
+
+hymd.field.compute_field_force(layouts, r, force_mesh, force, types, n_types)[source]
+

Interpolate particle-field forces from the grid onto particle positions

+

Backmaps the forces calculated on the grid to particle positions using the +window function \(P\) (by default cloud-in-cell [CIC]). In the +following, let \(\mathbf{F}_j\) denote the force acting on the +particle with index \(j\) and position \(\mathbf{r}_j\). The +interpolated force is

+
+\[\mathbf{F}_j = -\sum_k\nabla V_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(V_{j_k}\) is the discretized external potential at grid vertex +\(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid vertex +with index \(j_k\), and \(h^3\) is the volume of each grid voxel. +The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
r(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
force(N,D) numpy.ndarray

Array of forces for N particles in D dimensions. Local +for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
n_typesint

Number of different unique types present in the simulation system. +n_types is global, i.e. the same for all MPI ranks even if some +ranks contain zero particles of certain types.

+
+
+
+
+
+ +
+
+hymd.field.compute_self_energy_q(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the self energy for the interaction due to the Ewald scheme +used to compute the electrostatics. The energy is stored in config.

+

The self interaction energy is given by:

+
+\[U_{self} = \sqrt{\frac{1}{2\pi\sigma^2}} \sum_{i=1}^{N} q_i^2\]
+

where \(q_i\) are the charges and \(\sigma\) is the half-width +of the Gaussian filter.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
Returns:
+
+
field_q_self_energyfloat

Electrostatic self energy.

+
+
+
+
+
+ +
+
+hymd.field.domain_decomposition(positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs domain decomposition

+

Rearranges the MPI rank memory layout into one that better mimics the PFFT +pencil grid 2D decomposition. As molecules are always required to be fully +contained on a single MPI rank, a perfect decomposition is not always +possible. The best decomposition which leaves the center of mass of all +molecules in their respective correct domains is used, with possible +overlap into neighbouring domains if the spatial extent of any molecule +crosses domain boundaries.

+
+
Parameters:
+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
*args

Variable length argument list containing arrays to include in the +domain decomposition.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
bonds(N,M) numpy.ndarray, optional

Array of M bonds originating from each of N particles.

+
+
verboseint, optional

Specify the logging event verbosity of this function.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
Domain decomposedcode:positions and any array specified in
+
:code:`*args`, in addition tocode:bonds and molecules if these
+
arrays were provided as input.
+
+
+
+
+ +
+
+hymd.field.initialize_pm(pmesh, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates the necessary pmesh objects for pfft operations.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pmobject ‘pmesh.pm.ParticleMesh’
+
field_listlist[pmesh.pm.RealField], (multiple)

Essential list of pmesh objects required for MD

+
+
list_coulomblist[pmesh.pm.RealField], (multiple)

Additional list of pmesh objects required for electrostatics.

+
+
+
+
+
+ +
+
+hymd.field.update_field(phi, phi_laplacian, phi_transfer, layouts, force_mesh, hamiltonian, pm, positions, types, config, v_ext, phi_fourier, v_ext_fourier, m, compute_potential=False)[source]
+

Calculate the particle-field potential and force density

+

If compute_potential is True, the energy may subsequently +be computed by calling compute_field_and_kinetic_energy.

+

Computes the particle-field external potential \(V_\text{ext}\) from +particle number densities through the smoothed density field, +\(\phi(\mathbf{r})\). With \(P\) being the cloud-in-cell (CIC) +window function, the density and filtered densities are computed as

+
+\[\phi(\mathbf{r}) = \sum_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\phi(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +external potential is computed in reciprocal space as

+
+\[V_\text{ext} = \mathrm{FFT}^{-1}\left[ + \mathrm{FFT} + \left( + \frac{\partial w}{\partial \tilde\phi} + \right) + \mathrm{FFT}(H) +\right],\]
+

where \(w\) is the interaction energy functional. Differentiating +\(V_\text{ext}\) is done by simply applying \(i\mathbf{k}\) in +Fourier space, and the resulting forces are back-transformed to direct +space and interpolated to particle positions by

+
+\[\mathbf{F}_j = -\sum_{j_k} \nabla V_{j_k} + P(\mathbf{r}_{j_k} - \mathbf{r}_j)h^3,\]
+

where \(j_k\) are the neighbouring vertices of particle \(j\) at +position \(\mathbf{r}_j\), and \(h^3\) is the volume of each grid +voxel.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Pre-allocated, but empty; any values +in this field are discarded. Changed in-place. Local for each MPI +rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
configConfig

Configuration object.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Pre-allocated, but empty; any values in this field are +discarded Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
phi_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computational grid is represented by the collective fields of all +MPI ranks.

+
+
v_ext_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplesField objects containing discretized +particle-field external potential values in reciprocal space on the +computational grid; D+1 fields in D dimensions for each +particle type. D copies are made after calculation for later +use in force calculation, because the force transfer function +application differentiates the field in-place, ruining the contents +for differentiation in the remaining D-1 spatial directions. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
m: list[float], (M,)

pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. +Defaults to 1.0 for all particle types.

+
+
compute_potentialbool, optional

If True, a D+1-th copy of the Fourier transformed +external potential field is made to be used later in particle-field +energy calculation. If False, only D copies are made.

+
+
+
+
+
+

See also

+
+
compute_field_and_kinetic_energy

Compute the particle-field energy after the external potential is calculated.

+
+
+ +
+ +
+
+hymd.field.update_field_force_q(charges, phi_q, phi_q_fourier, psi, psi_fourier, elec_field_fourier, elec_field, elec_forces, layout_q, hamiltonian, pm, positions, config)[source]
+

Calculate the electrostatic particle-field forces on the grid

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential is computed in reciprocal space as

+
+\[\Phi = \mathrm{FFT}^{-1}\left[ + \frac{4\pi k_e}{\varepsilon \vert\mathbf{k}\vert^2} + \mathrm{FFT}(\rho)\mathrm{FFT}(H) +\right],\]
+

with the electric field

+
+\[\mathbf{E} = \mathrm{FFT}^{-1}\left[ + -i\mathbf{k}\,\mathrm{FFT}(\Psi) +\right].\]
+

In the following, let \(\mathbf{F}_j\) denote the electrostatic force +acting on the particle with index \(j\) and position +\(\mathbf{r}_j\). The interpolated electrostatic force is

+
+\[\mathbf{F}_j = \sum_k q_j\mathbf{E}_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(\mathbf{E}_{j_k}\) is the discretized electric field at grid +vertex \(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid +vertex with index \(j_k\), and \(h^3\) is the volume of each grid +voxel. The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty; any values in this field +are discarded. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
elec_field_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +electric field values in reciprocal space on the computational grid. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
+
+
+
+ +
+
+hymd.field.update_field_force_q_GPE(conv_fun, phi, types, charges, phi_q, phi_q_fourier, phi_eps, phi_eps_fourier, phi_eta, phi_eta_fourier, phi_pol_prev, phi_pol, elec_field, elec_forces, elec_field_contrib, psi, Vbar_elec, Vbar_elec_fourier, force_mesh_elec, force_mesh_elec_fourier, hamiltonian, layout_q, layouts, pm, positions, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Calculate the electrostatic particle-field forces on the grid, arising from +a general Poisson equation, i.e. anisotropic permittivity/dielectric. +The function is called when tomli input config.coulombtype = “PIC_Spectral_GPE.”

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential for a variable dielectric does not have an +analytical expression, and is computed in reciprocal through an iterative +method.

+

The GPE states that

+
+\[\nabla \cdot \left(\epsilon(\mathbf{r}) +\nabla{\mathbf{\psi(r)}}\right) = -\rho({\mathbf{r}}).\]
+

where \(\epsilon(\mathbf{r})\) is the relative dielectric function.

+
+
Parameters:
+
+
conv_funConvergence function.

Returns a scalar. Depends on MPI allreduce for similar convergence +across MPI ranks.

+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_eps_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_etapmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +gradients of the relative dielectric values on the computational grid. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank–the +full computational grid is represented by the collective fields of all MPI ranks.

+
+
phi_eta_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated discretized +Fourier transformed gradient relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_pol_prevpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charge values on the computational grid. Parameter in +the iterative method.Pre-allocated,but empty. Changedin-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_polpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charges on the computational grid. Parameter in the iterative +method, updating the next quess in solving for the electrostatic potential. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank– +the full computational grid is represented by the collective fields of +all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all +MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
elec_field_contribpmesh.pm.RealField

Pmesh RealField object for storing +\(|\mathbf{E(r)}|^2/\phi_{0}\) on the computational grid. +Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
psipmesh.pm.RealField

Pmesh RealField object for storing electrostatic potential +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
Vbar_elecmesh.pm.RealField

Pmesh RealField object for storing functional derivatives of +:math:`|w({ phi })_{elec}`on the computational grid. +Pre-allocated, but empty. Changed in-place. Local for each MPI rank– +the full computational grid is represented by the collective fields of

+
+

all MPI ranks.

+
+
+
Vbar_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated functional +derivatives of \(\|w(\{ \phi \})_{elec}\) in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
force_mesh_elecpmesh.pm.RealField

Pmesh RealField object for storing electrostatic force values +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
force_mesh_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated electrostatic +force values in reciprocal space on the computational grid. Local for +each MPI rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
layouts: list[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
comm: mpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
compute_field_energy_q_GPE

Compute the electrostatic energy after electrosatic force is calculated for a variable (anisotropic) dielectric general Poisson equation.

+
+
+ +
+ +
+
+

4.8. File input/output

+

Handle file input/output in parllel HDF5 fashion

+
+
+class hymd.file_io.OutDataset(dest_directory, config, double_out=False, disable_mpio=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

HDF5 dataset handler for file output

+
+
+close_file(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Closes the HDF5 output file

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+
+flush()[source]
+

Flushes output buffers, forcing file writes

+
+ +
+
+is_open(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if HDF5 output file is open

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+ +
+
+hymd.file_io.distribute_input(in_file, rank, size, n_particles, max_molecule_size=201, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Assign global arrays onto MPI ranks, attempting load balancing

+

Distributes approximately equal numbers of particles (workload) onto each +independent MPI rank, while respecting the requirement that any molecule +must be fully contained on a single MPI rank only (no splitting molecules +across multiple CPUs).

+
+
Parameters:
+
+
in_fileh5py.File

HDF5 input file object.

+
+
rankint

Local rank number for this MPI rank.

+
+
sizeint

Global size of the MPI communicator (number of total CPUs).

+
+
n_particlesint

Total number of particles.

+
+
max_molecule_sizeint, optional

Maximum size of any molecule present in the system. Used to initially +guess where the MPI rank boundaries (start/end indices) in the global +arrays should be placed. If molecules of size +>max_molecule_size exist in the simulation system, HyMD +might work as expected. Or it might fail spectacularly.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
rank_range

Starting and ending indices in the global arrays for each MPI rank.

+
+
+
+
+
+ +
+
+hymd.file_io.setup_time_dependent_element(name, parent_group, n_frames, shape, dtype, units=None)[source]
+

Helper function for setting up time-dependent HDF5 group datasets

+

All output groups must adhere to the H5MD standard, meaning a structure of

+
+
┗━ group particle group (e.g. all) or observables group
+
+
┗━ group time-dependent data
+
+
┣━ dataset step shape=(n_frames,)
+
┣━ dataset time shape=(n_frames,)
+
┗━ dataset value shape=(n_frames, *)
+
+
+
+

is necessary.

+

References

+
+
H5MD specification :

https://www.nongnu.org/h5md/h5md.html

+
+
+
+ +
+
+hymd.file_io.store_data(h5md, step, frame, indices, positions, velocities, forces, box_size, temperature, pressure, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, field_energy, field_q_energy, plumed_bias, time_step, config, velocity_out=False, force_out=False, charge_out=False, plumed_out=False, dump_per_particle=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Writes time-step data to HDF5 output file

+

Handles all quantities which change during simulation, as opposed to +static quanitities (see store_static).

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
stepint

Step number.

+
+
frameint

Output frame number (step // n_print).

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
positions(N,) numpy.ndarray

Array of positions for N particles in D dimensions.

+
+
velocities(N,) numpy.ndarray

Array of velocities for N particles in D dimensions.

+
+
forces(N,) numpy.ndarray

Array of forces for N particles in D dimensions.

+
+
box_size(D,) numpy.ndarray

Array containing the simulation box size.

+
+
temperaturefloat

Calculated instantaneous temperature.

+
+
kinetic_energyfloat

Calculated instantaneous kinetic energy.

+
+
bond2_energyfloat

Calculated instantaneous harmonic two-particle bond energy.

+
+
bond3_energyfloat

Calculated instantaneous harmonic angular three-particle bond energy.

+
+
bond4_energyfloat

Calculated instantaneous dihedral four-particle torsion energy.

+
+
field_energyfloat

Calculated instantaneous particle-field energy.

+
+
field_q_energyfloat

Calculated instantaneous electrostatic energy.

+
+
plumed_biasfloat

PLUMED instantaneous bias energy.

+
+
time_stepfloat

Value of the time step.

+
+
configConfig

Configuration object.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charge_outbool, optional

If True, electrostatic energies are written to the output +HDF5 file.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to the output HDF5 file.

+
+
dump_per_particlebool, optional

If True, all quantities are written per particle.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
store_static

Outputs all static time-independent quantities to the HDF5 output file

+
+
+ +
+ +
+
+hymd.file_io.store_static(h5md, rank_range, names, types, indices, config, bonds_2_atom1, bonds_2_atom2, molecules=None, velocity_out=False, force_out=False, charges=False, dielectrics=False, plumed_out=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Outputs all static time-independent quantities to the HDF5 output file

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
rank_rangelist[int]

Start and end indices for global arrays for each MPI rank.

+
+
names(N,) numpy.ndarray

Array of names for N particles.

+
+
types(N,) numpy.ndarray

Array of type indices for N particles.

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
configConfig

Configuration object.

+
+
bonds_2_atom1(B,) numpy.ndarray

Array of indices of the first particle for B total +two-particle bonds.

+
+
bonds_2_atom2(B,) numpy.ndarray

Array of indices of the second particle for B total +two-particle bonds.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles.

+
+
dielectrics(N,) numpy.ndarray

Array of particle relative dielectric values for N particles.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to output HDF5 file.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
prepare_bonds

Constructs two-, three-, and four-particle bonds from toplogy input file and bond configuration information.

+
+
distribute_input

Distributes input arrays onto MPI ranks, attempting load balancing.

+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/doc_pages/benchmarks.html b/v1.0.3/doc_pages/benchmarks.html new file mode 100644 index 00000000..817f5625 --- /dev/null +++ b/v1.0.3/doc_pages/benchmarks.html @@ -0,0 +1,300 @@ + + + + + + + 3. Benchmarks — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Benchmarks

+

Homopolymer melt test systems of \(30^2\), \(40^2\), and \(50^2\) +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively.

+
+

3.1. Bonded forces

+

Legend label denotes the number of particles in the system.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-1.png +
+
+
+

3.2. Particle–field forces

+

Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-2.png +
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/doc_pages/command_line.html b/v1.0.3/doc_pages/command_line.html new file mode 100644 index 00000000..b7689b87 --- /dev/null +++ b/v1.0.3/doc_pages/command_line.html @@ -0,0 +1,357 @@ + + + + + + + 5. Command line arguments — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. Command line arguments

+

Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle–field interactions.

+
+

5.1. Required arguments

+
+
configuration file:
+

type positional

+

Specifies the .toml format configuration file containing simulation details. See Configuration file for details.

+
+
structure and topology file:
+

type positional

+

Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See Topology and structure file for details.

+
+
+
+
+

5.2. Optional arguments

+
+
-v  --verbose

type optional

+

Number of following arguments: 0 or 1

+

Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying -v or --verbose with no additional specification. This increases verbosity level by 1. Alternatively, it maye be specified by --verbose V with V being 0, 1, or 2.

+
+
--profile

type optional

+

Number of following arguments: 0

+

Enables code profiling using cProfile. This will output one profiling file per MPI rank invoked in the simulation.

+
+
--double-precision

type optional

+

Number of following arguments: 0

+

Specify usage of double precision internally in HyMD (including in the FFTs).

+
+
--double-output

type optional

+

Number of following arguments: 0

+

Specify usage of double precision in the output trajectory from HyMD.

+
+
--velocity-output

type optional

+

Number of following arguments: 0

+

Specify that velocities should be output to the HyMD trajectory.

+
+
--force-output

type optional

+

Number of following arguments: 0

+

Specify that forces should be output to the HyMD trajectory.

+
+
--disable-mpio

type optional

+

Number of following arguments: 0

+

Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult.

+
+
--logfile

type optional

+

Number of following arguments: 1

+

Specifies the path of a plain text log file in which stdout is mirrored during simulation runs.

+
+
--seed

type optional

+

Number of following arguments: 1

+

Specifies the random seed used in the numpy random library to generate velocities, thermostatting, etc.

+
+
--disable-bonds

type optional

+

Number of following arguments: 0

+

Disable any two-particle bonds present in the system.

+
+
--disable-angle-bonds

type optional

+

Number of following arguments: 0

+

Disable any three-particle bonds present in the system.

+
+
--disable-dihedrals

type optional

+

Number of following arguments: 0

+

Disable any four-particle bonds present in the system.

+
+
--disable-dipole

type optional

+

Number of following arguments: 0

+

Disable any topological reconstruction of peptide backbone dipoles present in the system.

+
+
--disable-field

type optional

+

Number of following arguments: 0

+

Disable any particle–field interactions present in the system.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/doc_pages/config_file.html b/v1.0.3/doc_pages/config_file.html new file mode 100644 index 00000000..719c6b4f --- /dev/null +++ b/v1.0.3/doc_pages/config_file.html @@ -0,0 +1,444 @@ + + + + + + + 3. Configuration file — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Configuration file

+

The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order.

+

The configuration file is a toml format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs.

+
+

3.1. Configuration file keywords

+

The following constitutes every possible keyword specification in HyMD +configuration files:

+
+

3.1.1. Metadata keywords

+

Configuration keywords specifying metadata for the H5MD output trajectory.

+
+
name:
+

string [optional, default: None]

+

Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file.

+
+
tags:
+

array [string] [optional, default: None]

+

Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file.

+
+
+
+
+

3.1.2. Particle keywords

+

Configuration keywords specifying properties of particles and molecules in the +system.

+
+
n_particles:
+

integer [optional, default: None]

+

Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules.

+
+
mass:
+

float [optional, default: 72.0] {units: \(\text{u}=\text{g}\,\text{mol}^{-1}\)}

+

Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal.

+
+
max_molecule_size:
+

integer [optional, default: 201]

+

Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code will crash if there are molecules larger than max_molecule_size in the topology/structure input file.

+
+
+
+
+

3.1.3. Simulation keywords

+

Configuration keywords specifying simulation parameters.

+
+
n_steps:
+

integer [required]

+

Total number of integration steps to perform for this simulation.

+
+
n_print:
+

integer or boolean [optional, default: False]

+

Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of number of time steps).

+
+
n_flush:
+

integer [optional, default: None]

+

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of number of n_print, i.e. n_print = 13, n_flush = 3 would result in the trajectory/energy being written to disk every 13 x 3 = 39 simulation steps)

+
+
time_step:
+

float [required] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time step per integration step. If the rRESPA multiple time step integrator is used (integrator = "respa"), this specifies the inner time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is respa_inner times the time_step , and the total simulation time is n_steps times time_step times respa_inner .

+
+
box_size:
+

array [float] [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable.

+
+
integrator:
+

string [required] (options: velocity-verlet or respa)

+

Specifies the time integrator used in the simulation. If respa, the reversible reference system propagator algorithm (rRESPA) [Tuckerman et al., 1992] integrator is used, with respa_inner number of inner (intramolecular force) time steps. If velocity-verlet, a normal Velocity Verlet integrator is used. If respa and respa_inner = 1, the rRESPA integrator is equivalent to the Velocity Verlet.

+
+
respa_inner:
+

integer [optional, default: 1]

+

The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces.

+
+
domain_decomposition:
+

integer or boolean [optional, default: False]

+

Specifies the interval (in time steps) of domain decomposition exchange, involving all MPI ranks sending and receiving particles according to the particles’ positions in the integration box and the MPI ranks’ assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If True, the decomposition is performed once (before starting the simulation). If False, no decomposition is performed.

+
+
cancel_com_momentum:
+

integer or boolean [optional, default: False]

+

If True, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every remove_com_momentum time steps. If False, the linear momentum is never removed.

+
+
start_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at start_temperature Kelvin prior to starting the simulation. If False, the velocities are not changed before starting the simulation.

+
+
target_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Couple the system to a heat bath at target_temperature Kelvin by applying a Canonical sampling through velocity rescaling [Bussi et al., 2007] thermostat with coupling strength tau. If False, no temperature control is applied.

+
+
tau:
+

float [optional, default: 0.7] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the CSVR thermostat coupling. In the limit of tau , the Hamiltonian dynamics are preserved and no temperature coupling takes place.

+
+
thermostat_coupling_groups:
+

array [array [string]] [optional, default: []]

+

Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing "A", "B", and "C" type particles, thermostat_coupling_groups = [["A", "B"], ["C"],] would thermalise types "A" and "B" together and couple "C" type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. target_temperature Kelvin).

+
+
hamiltonian:
+

string [optional, default: "DefaultNohChi"] (options: SquaredPhi, DefaultNohChi, or DefaultWithChi)

+

Specifies the interaction energy functional \(W[\tilde\phi]\) for use with the particle-field interactions. See Interaction energy functionals for details.

+
+
+
+
+

3.1.4. Field keywords

+

Configuration keywords specifying field parameters.

+
+
mesh_size:
+

array [integer] or integer [required]

+

Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is box_size / mesh_size.

+
+
kappa:
+

float [required] {units: \(\text{kJ}^{-1}\text{mol}\)}

+

Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional \(W[\tilde\phi]\). See Interaction energy functionals for more details.

+
+
sigma:
+

float [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See Filtering for more details.

+
+
chi:
+

array [array [string, float]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\)}

+

Array of \(\tilde\chi_\text{AB}\)-parameters indicating the strength of the repulsive or attractive interaction between particles of type "A" and the number density due to particles of type "B", and vice versa. Example: chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ] would specify a repulsive "A""B" type interaction, and a weakly attractive "C""D" interaction. Self-interaction \(\tilde\chi\)-terms are always zero. See Interaction energy functionals for more details.

+
+
+
+
+

3.1.5. Bond keywords

+

Configuration keywords specifying bonds and bonds parameters.

+
+
bonds:
+

array [array [2 string, 2 float]] [optional, default: []] {units: \(\text{nm}=10^{-9}~\text{m}\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+

Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ] indicates a "A""A" bond of equilibrium length 0.47 \(\text{nm}\) with a bond strength of 980.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding bond between "A" and "B" type particles with equilibrium length 0.31 \(\text{nm}\) and a strength of 1250.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify stretching bonds.

+
+
angle_bonds:
+

array [array [3 string, 2 float]] [optional, default: []] {units: \({}^\circ\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+
+

Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ] indicates a "A""A""A" angular bond that tries to keep the bond linear at 180 degrees with a bending strength of 55.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding angle bond between "A""B""B" prefering the angle at 120 degrees and a strength of 25.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify angular bonds.

+
+
+
dihedrals:
+

array [array [4 string, integer, COSINE SERIES ]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)}

+

Specifies four-particle torsional potentials by cosine series. See Intramolecular bonds for details about how to specify dihedrals.

+
+
+
+
+

3.1.6. Electrostatic keywords

+

Configuration keywords specifying electrostatics and electrostatic parameters.

+
+
coulombtype:
+

string [optional, default: None] (options: PIC_Spectral)

+

Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the dielectric_const keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, not in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to PIC_Spectral.

+
+
dielectric_const:
+

float [optional, default: None]

+

Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified—even if electrostatics are not included with the coulombtype keyword.

+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/doc_pages/constants_and_units.html b/v1.0.3/doc_pages/constants_and_units.html new file mode 100644 index 00000000..7c26403e --- /dev/null +++ b/v1.0.3/doc_pages/constants_and_units.html @@ -0,0 +1,391 @@ + + + + + + + 6. Constants and Units — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

6. Constants and Units

+

HyMD uses the following units and constants internally and in all input and +output:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Units

Quantity

Symbol

Unit

length

\(r\)

\(\text{nm}=10^{-9}~\text{m}\)

time

\(t\)

\(\text{ps}=10^{-12}~\text{s}\)

charge

\(q\)

\(e=1.602176634 \cdot 10^{-19}~\text{C}\)

mass

\(m\)

\(\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}\)

temperature

\(\text{T}\)

\(\text{K}\)

energy

\(E\)

\(\text{kJ}\,\text{mol}^{-1}\)

velocity

\(v\)

\(\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}\)

momentum

\(P\)

\(\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}\)

force

\(\mathbf{F}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}\)

pressure

\(p\)

\(\text{bar}=100~\text{kPa}\)

electric potential

\(\Psi\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}\)

electric field

\(\mathbf{E}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}\)

compressibility

\(\kappa\)

\(\text{mol}\,\text{kJ}^{-1}\)

field-interaction

\(\tilde\chi\)

\(\text{kJ}\,\text{mol}^{-1}\)

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants

Constant

Symbol

Value

gas constant

\(R\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Boltzmann’s constant

\(k_\text{B}\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Avogadro’s constant

\(N_\text{A}\)

\(6.02214076 \cdot 10^23~\text{mol}^{-1}\)

Vacuum permittivity

\(\varepsilon_0\)

\(8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2\)

Coulomb constant

\(k_\text{e}\)

\(138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}\)

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/doc_pages/electrostatics.html b/v1.0.3/doc_pages/electrostatics.html new file mode 100644 index 00000000..4e64f909 --- /dev/null +++ b/v1.0.3/doc_pages/electrostatics.html @@ -0,0 +1,312 @@ + + + + + + + 3. Electrostatic interactions — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Electrostatic interactions

+

In the filtered Hamiltonian hPF formalism [Bore and Cascella, 2020] the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle–mesh Ewald.

+

The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered

+
+\[\tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i),\]
+

with \(q_i\) being the charge of particle \(i\) and \(H\) is the +filtering function (see Filtering). The value of the charge grid at +vertex \((i,j,k)\) is found by

+
+\[\tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)]\]
+

and the electrostatic potential \(\Psi_{ijk}\)

+
+\[\Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right],\]
+

where \(k_\text{e}\) is the Coulomb constant \(1/4\pi\varepsilon_0\). +The electric field is obtained by differentiation of the electrostatic +potential in Fourier space,

+
+\[\mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)]\]
+

from which the forces are interpolated back to the particle positions.

+
+

3.1. Specifying electrostatics

+

In HyMD, electrostatics are specified by the coulombtype and +dielectric_const keywords in the configuration file (see +Configuration file) and the /charge dataset in the HDF5 format +structure/topology input file (see Topology and structure file). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/doc_pages/examples.html b/v1.0.3/doc_pages/examples.html new file mode 100644 index 00000000..f91d8a93 --- /dev/null +++ b/v1.0.3/doc_pages/examples.html @@ -0,0 +1,760 @@ + + + + + + + 1. Examples — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Examples

+

The following examples are ordered in more or less order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the HyMD-tutorial github repository.

+
+

1.1. Ideal gas

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true +

The simplest possible system is one with no interactions at all—intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like:

+
+
ideal_gas.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = false         # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+
+
+

A simple input structure/topology file ideal_gas.HDF5 is available in +the HyMD-tutorial/ideal_gas github repository (along with the code to +generate it). Run the (very) short simulation by

+
python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field   \
+                                              --velocity-output \
+                                              --force-output
+
+
+

with the --disable-field argument to completely turn off all +particle–field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook ideal_gas.ipynb for details.

+
+
+

1.2. Ideal chains

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true +

The simplest available interaction is the harmonic two-particle bond (see +Intramolecular bonds),

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2.\]
+

Extending the configuration file from the ideal gas case, we need to add a +bonds specification. Note that the [bonds] meta specifier is not +necessary, but may be used to help organise the input file.

+
+
ideal_chain.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+
+
+

A simple input structure/topology file ideal_chain.HDF5 with a few +coiled up ideal chain polymers is available in the +HyMD-tutorial/ideal_chain github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field
+
+
+

we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +ideal_chain.ipynb.

+
+
+

1.3. Stiff rods

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true +

Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the i--j--k angle \(\theta\) (see +Intramolecular bonds),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2.\]
+

Extending the configuration file from the ideal chain case, we need to add a +angle_bonds specification. Note that the [bonds] meta specifier +is not necessary, but may be used to help organise the input file.

+
+
rods.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+angle_bonds = [
+  ["A", "A", "A", 180.0, 100.0],   # (i, j, k, equilibrium angle, strength)
+]
+
+
+
+

A simple input structure/topology file rods.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook rods.ipynb.

+
+
+

1.4. Helixes

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true +

Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle \(\phi\) between the +i--j--k plane and the j--k--l plane (see Intramolecular bonds),

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n).\]
+

The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a dihedrals keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the dielectric_const +keyword even though we are not including electrostatic forces in the current +simulation. Note that the [bonds] meta specifier is not necessary, but +may be used to help organise the input file.

+
+
helixes.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+dielectric_const = 15.0
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.31, 10000.0],       # (i name, j name, equilibrium length, strength)
+]
+
+dihedrals = [
+  [
+    ["A", "A", "A", "A"],
+    [
+      [-1],
+      [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+      [0.08, 0.46, 1.65, -0.96, 0.38],
+    ],
+    [1.0]
+  ],
+]
+
+
+
+

A simple input structure/topology file helixes.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook helixes.ipynb.

+
+
+

1.5. Phase separation

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true +

The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types A and B. Using the Hamiltonian

+
+\[\mathcal{H}=H_0+W\]
+

with \(\tilde\chi\)–dependent interactions defined by (specified in the +configuration file by hamiltonian = DefaultWithChi):

+
+\[W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2.\]
+
+
phase_separation.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+
+[field]
+mesh_size = [20, 20, 20]           # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+kappa = 0.05                       # compressibility in mol/kJ
+chi = [
+  ['A', 'B', 5.0],                 # (name i, name j, strength)
+]
+
+
+
+

A simple input structure/topology file phase_separation.HDF5 containing +an equal number of A type and B type particles is available in +the HyMD-tutorial/phase_separation github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd phase_separation.toml phase_separation.HDF5
+
+
+

we may examine the resulting trajectory. In the case of a low interaction +strength \(\tilde\chi\) of 5.0 (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to 40.0 (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +phase_separation.ipynb.

+
+
+

1.6. Diblock copolymers

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true +

Having introduced particle–field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive \(\tilde\chi\)–interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the integrator = "respa" keyword. Putting the pieces together, the +configuration file may look like the following:

+
+
copolymer.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 15
+n_steps = 2000                     # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [10.0, 10.0, 10.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [50, 50, 50]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+chi = [
+  ["A", "B", 30.0],                # (i, j, strength)
+]
+
+[bonds]
+bonds = [
+  ["A", "A", 0.25, 1500.0],        # (i, j, equilibrium length, strength)
+  ["A", "B", 0.25, 1500.0],
+  ["B", "B", 0.25, 1500.0],
+]
+angle_bonds = [
+  ["A", "A", "A", 180.0, 25.0],    # (i, j, k, equilibrium angle, strength)
+  ["B", "B", "B", 180.0, 25.0],
+]
+
+
+
+

A simple input structure/topology file copolymer.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/copolymer github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten A followed by ten B type particles. +Running the simulation with

+
python3 -m hymd copolymer.toml copolymer.HDF5
+
+
+

the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +copolymer.ipynb.

+
+
+

1.7. Lipid bilayer self-assembly

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true +

Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field–particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the thermostat_coupling_groups keyword. With parameters +optimised in [Ledum et al., 2020], the configuration file looks like:

+
+
lipid_self_assembly.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 25
+n_steps = 3000
+n_print = 200
+n_flush = 1
+time_step = 0.01
+box_size = [9.96924, 9.96924, 10.03970]
+start_temperature = 323
+target_temperature = 323
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.05
+domain_decomposition = 10001
+cancel_com_momentum = true
+max_molecule_size = 15
+thermostat_coupling_groups = [
+  ["N", "P", "G", "C"],
+  ["W"],
+]
+
+[field]
+mesh_size = [25, 25, 25]
+sigma = 1.0
+chi = [
+  ["C", "W", 42.24],
+  ["G", "C", 10.47],
+  ["N", "W", -3.77],
+  ["G", "W", 4.53],
+  ["N", "P", -9.34],
+  ["P", "G", 8.04],
+  ["N", "G", 1.97],
+  ["P", "C", 14.72],
+  ["P", "W", -1.51],
+  ["N", "C", 13.56],
+]
+
+[bonds]
+bonds = [
+  ["N", "P", 0.47, 1250.0],
+  ["P", "G", 0.47, 1250.0],
+  ["G", "G", 0.37, 1250.0],
+  ["G", "C", 0.47, 1250.0],
+  ["C", "C", 0.47, 1250.0],
+]
+angle_bonds = [
+  ["P", "G", "G", 120.0, 25.0],
+  ["P", "G", "C", 180.0, 25.0],
+  ["G", "C", "C", 180.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

A randomly mixed input structure/topology file +lipid_self_assembly.HDF5 with a few hundred lipids in a roughy +10 x 10 x 10nm box is available in the +HyMD-tutorial/lipid_self_assembly github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation

+
python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5
+
+
+

we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook lipid_self_assembly.ipynb.

+
+
+

1.8. Peptide in lipid bilayer

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true +

Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer.

+

The configuration file is available in the HyMD-tutorial/peptide github +repository (omitted here for brevity).

+

A pre-equilibrated input structure/topology file peptide.HDF5 with a +few hundred lipids in a roughy 20 x 20 x 20nm box is available in the +HyMD-tutorial/peptide github repository. Running the simulation

+
python3 -m hymd peptide.toml peptide.HDF5
+
+
+

we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook peptide.ipynb.

+
+
+

1.9. SDS

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true +

The last part we introduce is explicit electrostatic interactions through +particle–mesh Ewald. Enabling the electrostatic calculations is done via the +coulombtype keyword. "PIC_Spectral" is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the dielectric_const keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge.

+
+
sds.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 10
+n_steps = 3000
+n_print = 1500
+n_flush =
+time_step = 0.01
+box_size = [8.3, 8.3, 8.3]
+start_temperature = 298
+target_temperature = 298
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.1
+domain_decomposition = 10000
+cancel_com_momentum = true
+max_molecule_size = 5
+thermostat_coupling_groups = [
+  ["S", "C"],
+  ["W", "Na"],
+]
+dielectric_const = 45.0              # dielectric constant for the simulation medium
+coulombtype = "PIC_Spectral"         # particle in cloud, spectral method
+
+[field]
+mesh_size = [64, 64, 64]
+sigma = 0.5
+chi = [
+  ["S", "C",  13.50],
+  ["S", "Na",  0.00],
+  ["S", "W",  -3.60],
+  ["C", "Na", 13.50],
+  ["C", "W",  33.75],
+  ["W", "Na",  0.00],
+]
+
+[bonds]
+bonds = [
+  ["S",   "C",   0.50, 1250.0],
+  ["C",   "C",   0.50, 1250.0],
+]
+angle_bonds = [
+  ["S", "C", "C", 170.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

An input structure/topology file sds.HDF5 with a couple thousand +randomly dispersed SDS chains is available in the HyMD-tutorial/sds github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a /charge dataset. +Running the simulation with

+
python3 -m hymd sds.toml sds.HDF5
+
+
+

we observe the aggregation of the SDS into micellular structures—first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook sds.ipynb.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/doc_pages/filtering.html b/v1.0.3/doc_pages/filtering.html new file mode 100644 index 00000000..1efee130 --- /dev/null +++ b/v1.0.3/doc_pages/filtering.html @@ -0,0 +1,299 @@ + + + + + + + 2. Filtering — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Filtering

+

The default grid-independent filter function used in HyMD is a Gaussian

+
+\[H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right]\]
+

with reciprocal space representation

+
+\[\hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right].\]
+

The coarse-graining parameter \(\sigma\) determines a length scale of +particle extent and is given as configuration file input by

+
sigma = 0.75
+
+
+
+

2.1. Implementing new filters

+

Implementing new filter functions is straightforward by hijacking +the setup method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/doc_pages/installation.html b/v1.0.3/doc_pages/installation.html new file mode 100644 index 00000000..388c8441 --- /dev/null +++ b/v1.0.3/doc_pages/installation.html @@ -0,0 +1,407 @@ + + + + + + + 1. Installation — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Installation

+

HyMD may be installed using pip by

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+
+

1.1. Dependencies

+

HyMD requires a working MPI compiler and HDF5. On an Ubuntu system, this +may be installed via

+
sudo apt-get update -y
+sudo apt-get install -y libhdf5-openmpi-dev python3-mpi4py
+CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-cache-dir --no-binary=h5py h5py
+
+
+

It is highly recommended to have MPI-enabled HDF5 and h5py. A +non-MPI-enabled h5py may be installed by simply

+
sudo apt-get update -y
+sudo apt-get install libhdf5-serial-dev
+python3 -m pip --upgrade install h5py
+
+
+

A non-MPI-enabled HDF5 library with corresponding h5py will work +(mostly), but is inconvenient and slow. Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +--disable-mpio argument to HyMD, see Command line arguments. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial.

+
+
+

1.2. Install in docker

+

A docker image with build essentials setup is available at dockerhub with tag +mortele/hymd,

+
docker pull mortele/hymd:latest
+docker run -it mortele/hymd
+/app$ python3 -m pip install hymd
+
+# Grab example input files
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5
+
+# Run simulation
+/app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose
+
+
+
+
+

1.3. Run interactively in Google Colaboratory

+

A Google Colaboratory jupyter notebook is setup here with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons.

+
+
+

1.4. Common issues

+
+

1.4.1. Numpy errors while importing the Fortran force kernels

+
RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd
+
+Traceback (most recent call last):
+
+  (...)
+
+File "/..../HyMD/hymd/__init__.py", line 2, in <module>
+  from .main import main  # noqa: F401
+File "/..../HyMD/hymd/main.py", line 10, in <module>
+  from .configure_runtime import configure_runtime
+File "/..../hymd/configure_runtime.py", line 12, in <module>
+  from .input_parser import read_config_toml, parse_config_toml
+File "/..../HyMD/hymd/input_parser.py", line 12, in <module>
+  from .force import Bond, Angle, Dihedral, Chi
+File "/..../HyMD/hymd/force.py", line 8, in <module>
+  from force_kernels import (  # noqa: F401
+ImportError: numpy.core.multiarray failed to import
+
+
+

can normally be fixed by updating numpy versions,

+
python3 -m pip install -U numpy
+
+
+
+
+

1.4.2. Error building pfft-python due to missing curl/wget

+
Building wheel for pfft-python (setup.py) ... error
+ERROR: Command errored out with exit status 1:
+command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_
+cwd: /tmp/pip-install-fr6nt9m4/pfft-python/
+Complete output (56 lines):
+running bdist_wheel
+running build
+running build_py
+
+  (...)
+
+curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found
+wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found
+Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+Please check curl or wget
+You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/
+Traceback (most recent call last):
+  File "<string>", line 1, in <module>
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in <module>
+    setup(
+  File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup
+    return distutils.core.setup(**attrs)
+  File "/usr/lib/python3.8/distutils/core.py", line 148, in setup
+
+  (...)
+
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions
+    build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:]))
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft
+    raise ValueError("could not build fftw; check MPICC?")
+ValueError: could not build fftw; check MPICC?
+----------------------------------------
+ERROR: Failed building wheel for pfft-python
+Running setup.py clean for pfft-python
+Failed to build pfft-python
+
+
+

can be fixed by installing either curl or wget

+
apt-get install -y curl wget
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/doc_pages/interaction_energy_functionals.html b/v1.0.3/doc_pages/interaction_energy_functionals.html new file mode 100644 index 00000000..765388a5 --- /dev/null +++ b/v1.0.3/doc_pages/interaction_energy_functionals.html @@ -0,0 +1,352 @@ + + + + + + + 1. Interaction energy functionals — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Interaction energy functionals

+

A few interaction energy functionals \(W\) are defined in HyMD through +the Hamiltonian class and associated subclasses.

+
+

1.1. \(\chi\)–interaction and \(\kappa\)–incompressibility

+

The most common hPF energy functional is specified by

+
hamiltonian = "DefaultWithChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where \(\tilde\chi_{\text{A}-\text{B}}\) is the interaction energy between +overlapping densities of particle types \(\text{A}\) and \(\text{B}\). +The incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\tilde\chi\) +and \(\kappa\) in the configuration file (see Configuration file)

+
kappa = 0.05
+chi = [
+   ["A", "B", 15.85],
+   ["B", "C", -5.70],
+   ...
+]
+
+
+
+
+

1.2. Only \(\kappa\)–incompressibility

+

The only \(\kappa\) interactions energy functional is specified by

+
hamiltonian = "DefaultNoChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where the incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.3. Only \(\phi^2\)

+

The \(\phi^2\) interactions energy functional is specified by

+
hamiltonian = "SquaredPhi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2,\]
+

where the \(\phi\) squared term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.4. Implementing new interaction energy forms

+

Implementing new interaction energy functions is straightforward by subclassing +Hamiltonian and applying sympy differentiation to the symbolic +field objects. The sympy.lamdify function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/doc_pages/intramolecular_bonds.html b/v1.0.3/doc_pages/intramolecular_bonds.html new file mode 100644 index 00000000..bb8e5276 --- /dev/null +++ b/v1.0.3/doc_pages/intramolecular_bonds.html @@ -0,0 +1,392 @@ + + + + + + + 2. Intramolecular bonds — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Intramolecular bonds

+

Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see Configuration file. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +Benchmarks), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable.

+

All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]).

+
+

2.1. Two-particle bonds

+

Stretching bonds in HyMD are implemented as harmonic spring potentials,

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2,\]
+

where \(r=|\mathbf{r}|\) is the inter-particle distance, \(k\) is a +constant of dimension energy (units \(\text{kJ}\,\text{mol}^{-1}\)), and +\(r_0\) is the equilibrum length of the bond (units: \(\text{nm}\)). The +force is calculated as

+
+\[F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r},\]
+

where \(\mathbf{r}\) is the vector pointing from \(i\) to \(j\).

+

In the configuration file, two-particle bonds are specified per particle type:

+
+
configuration_two_particle_example.toml
+
[bonds]
+bonds = [
+   ["A", "A", 0.47, 1250.0],
+   ["A", "B", 0.37,  940.0],
+   ["B", "C", 0.50, 1010.0],
+   ["C", "A", 0.42,  550.0],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.2. Three-particle bonds

+

Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle–particle–particle angle \(\theta\),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2,\]
+

where \(k\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\)), and \(\theta_0\) is the equilibrum +angle of the bond (units: \({}^\circ\)). Defining the particles with labels +\(a\), \(b\), and \(c\), let \(\mathbf{r}_a\) denote the vector +pointing from \(b\) to \(a\), and correspondingly let +\(\mathbf{r}_c\) point from \(b\) to \(c\). The +\(a\)\(b\)\(c\) may be computed through the law of Cosines,

+
+\[\theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right]\]
+

Then the force acting on \(a\) and \(c\) is

+
+\[ \begin{align}\begin{aligned}\mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a},\\\mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c},\end{aligned}\end{align} \]
+

and

+
+\[\mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c\]
+

In the configuration file, three-particle bonds are specified per particle type:

+
+
configuration_three_particle_example.toml
+
[bonds]
+angle_bonds = [
+   ["A", "A", "A", 180.0, 90.0],
+   ["A", "B", "A", 120.0, 55.0],
+   ["B", "C", "C",  30.0, 10.0],
+   ["C", "A", "B", 110.0, 25.5],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.3. Four-particle bonds

+

Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle \(\phi\) between the +\(a\)\(b\)\(c\) and \(b\)\(c\)\(d\) planes, for +a dihedral bond quartet \(a\), \(b\), \(c\), and \(d\). The +potential takes the form

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n),\]
+

where \(c_n\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)), and \(\phi_n\) are +specified phase angles in the cosine series.

+

In the configuration file, four-particle bonds are specified per particle type:

+
+
configuration_four_particle_example.toml
+
[bonds]
+dihedrals = [
+   ["A", "B", "C", "D"],
+   [
+     [-1],
+     [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+     [0.08, 0.46, 1.65, -0.96, 0.38],
+   ],
+   [1.0],
+]
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/doc_pages/overview.html b/v1.0.3/doc_pages/overview.html new file mode 100644 index 00000000..05727a84 --- /dev/null +++ b/v1.0.3/doc_pages/overview.html @@ -0,0 +1,413 @@ + + + + + + + 2. Usage overview for HylleraasMD — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Usage overview for HylleraasMD

+

HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a toml format configuration file, along with a topology and structure +file specifying the input system in HDF5 format.

+

Configuration file

+

The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a [5, 5, 5] nm simulation box at 300 K may look like +the following:

+
+
config_simple_1.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "SquaredPhi"         # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [30, 30, 30]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+
+
+
+

Note that for the version 1.0 release of HyMD, the [particles], +[simulation], and [field] groups are optional specifiers for +structuring the configuration file.

+

For a full specification of every recognised configuration keyword in HyMD, +please refer to Configuration file.

+

Topology and structure file

+

The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +N particles may look like the following:

+
+
example_structure.HDF5
+
group   /
+   # root group
+
+dataset /coordinates
+   # float32, shape (T, N, D,)
+   # Time steps of N rows of D dimensional coordinate data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /velocities
+   # float32, shape (T, N, D,) OPTIONAL
+   # Time steps of N rows of D dimensional velocity data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /bonds
+   # int32,   shape (N, B,)    OPTIONAL
+   # Each row i contains indices of the particles bonds from/to i
+   # B denotes the maximum bonds per particle
+
+dataset /indices
+   # int32,   shape (N,)
+   # Index of each particle, 0--(N-1)
+
+dataset /molecules
+   # int32,   shape (N,)
+   # Index of molecule each particle belongs to
+   # Used to construct bond network locally on MPI ranks
+
+dataset /names
+   # str10,   shape (N,)
+   # Fixed size string array containing particle type names
+
+dataset /types
+   # int32,   shape (N,)       OPTIONAL
+   # Mapping of particle names to type indices
+
+
+
+

For a full specification of the topology and structure input file, see +Topology and structure file.

+

Command line arguments

+

A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the config_simple_1.toml and example_structure.HDF5 +files may look like the following:

+
mpirun -n ${MPI_NUM_RANKS} python3 -m hymd         \  # HyMD executable
+                           config_simple_1.toml    \  # configuration file
+                           example_structure.HDF5  \  # structure file
+                           --logfile=log_out.txt   \  # set logfile path
+                           --seed 123456           \  # set random seed
+                           --verbose 2             \  # set logging verbosity
+                           --velocity-output          # enable velocity in trajectory output
+
+
+

For a full specification of all command line arguments, see +Command line arguments.

+

More examples

+

For more thorough rundown and concrete usage examples, see +Examples.

+
+

2.1. Running parallel simulations

+

Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the only difference being how the python3 interpreter is +invoked. Prepending mpirun -n ${NPROCS} to the usual +python3 -m hymd runs the simulation with ${NPROCS} MPI ranks.

+

Inputting

+
mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field
+
+
+

sets up an example simulation of the HyMD-tutorial/ideal_gas system. For +more details about this system in particular, or other example simulations, see +the HyMD-tutorial repository.

+
+
+

2.2. Running tests

+

Run serial code tests by

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd
+cd hymd/
+python3 -m pip install pytest pytest-mpi
+python3 -m pytest
+
+
+

There is a small convenience script in hymd/ for running the MPI-enabled +tests,

+
chmod +x pytest-mpi
+./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/doc_pages/theory.html b/v1.0.3/doc_pages/theory.html new file mode 100644 index 00000000..e4a11386 --- /dev/null +++ b/v1.0.3/doc_pages/theory.html @@ -0,0 +1,355 @@ + + + + + + + 1. Theory — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Theory

+

Hybrid particle–field simulations switch out the ordinary particle–particle +Lennard-Jones interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle–field densities are +defined as

+
+\[\phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i),\]
+

where \(\mathbf{r}\) is a spatial coordinate, \(P\) is a window function +used to distribute particle number densities onto a computational grid, and +\(\mathbf{r}_i\) is the position of particle \(i\) (of total \(N\)). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of \(N\) particles in \(M\) molecules is

+
+\[\mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})]\]
+

with \(H_0\) being a standard intramolecular Hamiltonian form (see +Intramolecular bonds) including kinetic terms, while \(W\) is a density +dependent interaction energy functional.

+

In the Hamiltonian hPF-MD formalism [Bore and Cascella, 2020], the density +field is filtered using a grid-independent filtering function \(H\),

+
+\[\tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}).\]
+

The filter smooths the density, ensuring that \(\tilde\phi\) and +\(W[\tilde\phi([\phi])]\) both converge as the grid size is reduced.

+
+

1.1. External potential

+

The external potential acting on a particle is defined as the functional +derivative of \(W\) with respect to \(\phi\). In the filtered formalism, +the potential takes the form

+
+\[\begin{split}V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ +&= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})},\end{split}\]
+

under the assumption of a local form of the interaction energy functional, +\(W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]\). Note +that

+
+\[\frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}).\]
+
+
+

1.2. Force interpolation

+

The forces on particle \(i\) are obtained by differentiation of the external +potential,

+
+\[\mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i).\]
+
+
+

1.3. Reciprocal space calculations

+

The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density \(\phi_{ijk}\) with CIC, we apply the filtering +and obtain the discrete version of the external potential by

+
+\[\tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big]\]
+

and

+
+\[V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+

The forces are obtained by differentiation of \(V\) in Fourier space as

+
+\[\nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+
+
+

1.4. Filter

+

By default, the filter used in HyMD is a simple Gaussian of the form

+
+\[\begin{split}H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ +\hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right].\end{split}\]
+

For more details about the filtering, see Filtering.

+
+
+

1.5. Hamiltonian form

+

The default form of the interaction energy functional in HyMD is

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2.\]
+

See Interaction energy functionals for details.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/doc_pages/topology_input.html b/v1.0.3/doc_pages/topology_input.html new file mode 100644 index 00000000..9d38e79c --- /dev/null +++ b/v1.0.3/doc_pages/topology_input.html @@ -0,0 +1,336 @@ + + + + + + + 4. Topology and structure file — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Topology and structure file

+

The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root / group.

+

The HyMD-tutorial has multiple examples of structure files for various levels +of complexity.

+
+

4.1. Required datasets

+
+
/coordinates:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/indices:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/names:
+

array shape [N,]

+

datatype [string (length between 1 and 16)]

+

The shape represents one particle name per N particles. The datatype may be a string of length =<16.

+
+
+
+
+

4.2. Optional datasets

+
+
/velocities:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/types:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle type index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/molecules:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one molecule index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/bonds:
+

array shape [N, B,]

+

datatype [int32 or int64]

+

The shape represents B bond specifications (indices of different particles) per N particles. The data type may be either 32 or 64 bit integers.

+
+
/charge:
+

array shape [N,]

+

datatype [float32 or float64]

+

The shape represents one particle charge per N particles. The data type may be either four or eight byte reals.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/genindex.html b/v1.0.3/genindex.html new file mode 100644 index 00000000..cc8fa15f --- /dev/null +++ b/v1.0.3/genindex.html @@ -0,0 +1,814 @@ + + + + + + Index — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + +
+ +

F

+ + + +
+ +

G

+ + +
+ +

H

+ + + +
    +
  • + hymd.input_parser + +
  • +
  • + hymd.integrator + +
  • +
  • + hymd.thermostat + +
  • +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/index.html b/v1.0.3/index.html new file mode 100644 index 00000000..2bc71645 --- /dev/null +++ b/v1.0.3/index.html @@ -0,0 +1,400 @@ + + + + + + + HylleraasMD documentation — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

HylleraasMD documentation

+
+
Release:
+

1.0.3

+
+
Date:
+

Jan 07, 2022

+
+
+

HylleraasMD (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems.

+

HyMD can run canonical hPF-MD simulations [Milano and Kawakatsu, 2009], or filtered +density Hamiltonian hPF (HhPF-MD) simulations [Bore and Cascella, 2020], with +or without explicit PME electrostatic interactions [Kolli et al., 2018]. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +[Bore et al., 2018, Cascella et al., 2008]. Martini +style elastic networks (ElNeDyn) [Periole et al., 2009] are also +supported.

+

HyMD uses the pmesh (github.com/rainwoodman/pmesh) library for particle-mesh +operations, with the PPFT [Pippig, 2013] backend for FFTs through the +pfft-python bindings (github.com/rainwoodman/pfft-python). File IO is done +via HDF5 formats to allow MPI parallel reads.

+
+

User Guide

+

The HylleraasMD User Guide provides comprehensive information on how to run +simulations. Selected Examples are available to guide new users.

+
+
+

Installing HyMD

+

The easiest approach is to install using pip:

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+

For more information and required dependencies, see +Installation.

+
+

Run in Google colab

+

Run HyMD interactively in Google Colaboratory jupyter notebook here.

+
+
+
+

Source Code

+

Source code is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the GNU Lesser General Public +License v3.0. Obtain the source code with git:

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git
+
+
+
+
+

Development

+

HyMD is developed and maintained by researchers at the Hylleraas Centre for +Quantum Molecular Sciences at the University of Oslo.

+

pic1 pic2

+
+
+

References

+
+
+[BC20] +

Sigbjørn Løland Bore and Michele Cascella. Hamiltonian and alias-free hybrid particle–field molecular dynamics. J. Chem. Phys., 153(9):094106, 2020. doi:10.1063/5.0020733.

+
+
+[BMC18] +

Sigbjørn Løland Bore, Giuseppe Milano, and Michele Cascella. Hybrid particle-field model for conformational dynamics of peptide chains. J. Chem. Theory Comput., 14(2):1120–1130, 2018. doi:10.1021/acs.jctc.7b01160.

+
+
+[BDP07] +

Giovanni Bussi, Davide Donadio, and Michele Parrinello. Canonical sampling through velocity rescaling. J. Chem. Phys., 126(1):014101, 2007. doi:10.1063/1.2408420.

+
+
+[CNCDP08] +

Michele Cascella, Marilisa A. Neri, Paolo Carloni, and Matteo Dal Peraro. Topologically based multipolar reconstruction of electrostatic interactions in multiscale simulations of proteins. J. Chem. Theory Comput., 4(8):1378–1385, 2008. doi:10.1021/ct800122x.

+
+
+[KDNB+18] +

Hima Bindu Kolli, Antonio De Nicola, Sigbjørn Løland Bore, Ken Schäfer, Gregor Diezemann, Jürgen Gauss, Toshihiro Kawakatsu, Zhong-Yuan Lu, You-Liang Zhu, Giuseppe Milano, and Michele Cascella. Hybrid particle-field molecular dynamics simulations of charged amphiphiles in an aqueous environment. J. Chem. Theory Comput., 14(9):4928–4937, 2018. doi:10.26434/chemrxiv.6264644.v1.

+
+
+[LBC20] +

Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Automated determination of hybrid particle-field parameters by machine learning. Mol. Phys., 118(19-20):e1785571, 2020. doi:10.1080/00268976.2020.1785571.

+
+
+[MK09] +

Giuseppe Milano and Toshihiro Kawakatsu. Hybrid particle-field molecular dynamics simulations for dense polymer systems. J. Chem. Phys., 130(21):214106, 2009. doi:10.1063/1.3142103.

+
+
+[PCMC09] +

Xavier Periole, Marco Cavalli, Siewert-Jan Marrink, and Marco A Ceruso. Combining an elastic network with a coarse-grained molecular force field: structure, dynamics, and intermolecular recognition. Journal of chemical theory and computation, 5(9):2531–2543, 2009. doi:10.1021/ct9002114.

+
+
+[Pip13] +

Michael Pippig. Pfft: an extension of fftw to massively parallel architectures. SIAM J. Sci. Comput., 35(3):C213–C236, 2013. doi:10.1137/120885887.

+
+
+[TBM92] +

MBBJM Tuckerman, Bruce J Berne, and Glenn J Martyna. Reversible multiple time scale molecular dynamics. J. Chem. Phys., 97(3):1990–2001, 1992. doi:10.1063/1.463137.

+
+
+
+
+
+

Indices and tables

+ +
+
+
+
+
+
+
+
+
+ + + +
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+ + + + + +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/objects.inv b/v1.0.3/objects.inv new file mode 100644 index 00000000..d8405063 Binary files /dev/null and b/v1.0.3/objects.inv differ diff --git a/v1.0.3/py-modindex.html b/v1.0.3/py-modindex.html new file mode 100644 index 00000000..7d8cad6b --- /dev/null +++ b/v1.0.3/py-modindex.html @@ -0,0 +1,322 @@ + + + + + + Python Module Index — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ h +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ h
+ hymd +
    + hymd.field +
    + hymd.file_io +
    + hymd.force +
    + hymd.input_parser +
    + hymd.integrator +
    + hymd.thermostat +
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.3/search.html b/v1.0.3/search.html new file mode 100644 index 00000000..1d711e91 --- /dev/null +++ b/v1.0.3/search.html @@ -0,0 +1,292 @@ + + + + + + Search — hymd 1.0.3 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.3 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v1.0.3/searchindex.js b/v1.0.3/searchindex.js new file mode 100644 index 00000000..524f18c6 --- /dev/null +++ b/v1.0.3/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["doc_pages/api","doc_pages/benchmarks","doc_pages/command_line","doc_pages/config_file","doc_pages/constants_and_units","doc_pages/electrostatics","doc_pages/examples","doc_pages/filtering","doc_pages/installation","doc_pages/interaction_energy_functionals","doc_pages/intramolecular_bonds","doc_pages/overview","doc_pages/theory","doc_pages/topology_input","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,"sphinxcontrib.bibtex":9,sphinx:56},filenames:["doc_pages/api.rst","doc_pages/benchmarks.rst","doc_pages/command_line.rst","doc_pages/config_file.rst","doc_pages/constants_and_units.rst","doc_pages/electrostatics.rst","doc_pages/examples.rst","doc_pages/filtering.rst","doc_pages/installation.rst","doc_pages/interaction_energy_functionals.rst","doc_pages/intramolecular_bonds.rst","doc_pages/overview.rst","doc_pages/theory.rst","doc_pages/topology_input.rst","index.rst"],objects:{"hymd.field":{compute_field_and_kinetic_energy:[0,1,1,""],compute_field_energy_q_GPE:[0,1,1,""],compute_field_force:[0,1,1,""],compute_self_energy_q:[0,1,1,""],domain_decomposition:[0,1,1,""],initialize_pm:[0,1,1,""],update_field:[0,1,1,""],update_field_force_q:[0,1,1,""],update_field_force_q_GPE:[0,1,1,""]},"hymd.file_io":{OutDataset:[0,2,1,""],distribute_input:[0,1,1,""],setup_time_dependent_element:[0,1,1,""],store_data:[0,1,1,""],store_static:[0,1,1,""]},"hymd.file_io.OutDataset":{close_file:[0,3,1,""],flush:[0,3,1,""],is_open:[0,3,1,""]},"hymd.force":{Angle:[0,2,1,""],Bond:[0,2,1,""],Chi:[0,2,1,""],Dielectric_type:[0,2,1,""],Dihedral:[0,2,1,""],compute_angle_forces__plain:[0,1,1,""],compute_bond_forces__plain:[0,1,1,""],compute_dihedral_forces__plain:[0,1,1,""],dipole_forces_redistribution:[0,1,1,""],find_all_paths:[0,1,1,""],prepare_bonds:[0,1,1,""],prepare_bonds_old:[0,1,1,""],prepare_index_based_bonds:[0,1,1,""],propensity_potential_coeffs:[0,1,1,""]},"hymd.force.Angle":{atom_3:[0,4,1,""]},"hymd.force.Bond":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],equilibrium:[0,4,1,""],strength:[0,4,1,""]},"hymd.force.Chi":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],interaction_energy:[0,4,1,""]},"hymd.force.Dielectric_type":{atom_1:[0,4,1,""],dielectric_value:[0,4,1,""]},"hymd.force.Dihedral":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],atom_3:[0,4,1,""],atom_4:[0,4,1,""],coeffs:[0,4,1,""],dih_type:[0,4,1,""]},"hymd.hamiltonian":{DefaultNoChi:[0,2,1,""],DefaultWithChi:[0,2,1,""],Hamiltonian:[0,2,1,""],SquaredPhi:[0,2,1,""]},"hymd.hamiltonian.DefaultNoChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.DefaultWithChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.Hamiltonian":{__init__:[0,3,1,""],_setup:[0,3,1,""]},"hymd.hamiltonian.SquaredPhi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.input_parser":{Config:[0,2,1,""],check_NPT_conditions:[0,1,1,""],check_angles:[0,1,1,""],check_bonds:[0,1,1,""],check_box_size:[0,1,1,""],check_cancel_com_momentum:[0,1,1,""],check_charges:[0,1,1,""],check_charges_types_list:[0,1,1,""],check_chi:[0,1,1,""],check_config:[0,1,1,""],check_dielectric:[0,1,1,""],check_dihedrals:[0,1,1,""],check_domain_decomposition:[0,1,1,""],check_hamiltonian:[0,1,1,""],check_integrator:[0,1,1,""],check_m:[0,1,1,""],check_mass:[0,1,1,""],check_max_molecule_size:[0,1,1,""],check_n_b:[0,1,1,""],check_n_flush:[0,1,1,""],check_n_particles:[0,1,1,""],check_n_print:[0,1,1,""],check_name:[0,1,1,""],check_start_and_target_temperature:[0,1,1,""],check_tau:[0,1,1,""],check_thermostat_coupling_groups:[0,1,1,""],parse_config_toml:[0,1,1,""],read_config_toml:[0,1,1,""],sort_dielectric_by_type_id:[0,1,1,""]},"hymd.input_parser.Config":{a:[0,4,1,""],angle_bonds:[0,4,1,""],barostat:[0,4,1,""],barostat_type:[0,4,1,""],bonds:[0,4,1,""],box_size:[0,4,1,""],cancel_com_momentum:[0,4,1,""],chi:[0,4,1,""],conv_crit:[0,4,1,""],convergence_type:[0,4,1,""],coulomb_constant:[0,4,1,""],coulombtype:[0,4,1,""],dielectric_const:[0,4,1,""],dielectric_type:[0,4,1,""],dihedrals:[0,4,1,""],domain_decomposition:[0,4,1,""],dtype:[0,4,1,""],file_name:[0,4,1,""],gas_constant:[0,4,1,""],hamiltonian:[0,4,1,""],initial_energy:[0,4,1,""],integrator:[0,4,1,""],kappa:[0,4,1,""],m:[0,4,1,""],mass:[0,4,1,""],max_molecule_size:[0,4,1,""],mesh_size:[0,4,1,""],n_b:[0,4,1,""],n_flush:[0,4,1,""],n_particles:[0,4,1,""],n_print:[0,4,1,""],n_steps:[0,4,1,""],name:[0,4,1,""],pol_mixing:[0,4,1,""],pressure:[0,4,1,""],respa_inner:[0,4,1,""],rho0:[0,4,1,""],self_energy:[0,4,1,""],sigma:[0,4,1,""],start_temperature:[0,4,1,""],tags:[0,4,1,""],target_pressure:[0,4,1,""],target_temperature:[0,4,1,""],tau:[0,4,1,""],tau_p:[0,4,1,""],thermostat_coupling_groups:[0,4,1,""],thermostat_work:[0,4,1,""],time_step:[0,4,1,""],type_charges:[0,4,1,""]},"hymd.integrator":{integrate_position:[0,1,1,""],integrate_velocity:[0,1,1,""]},"hymd.logger":{Logger:[0,2,1,""],MPIFilterAll:[0,2,1,""],MPIFilterRoot:[0,2,1,""]},"hymd.logger.Logger":{setup:[0,3,1,""]},"hymd.logger.MPIFilterAll":{filter:[0,3,1,""]},"hymd.logger.MPIFilterRoot":{filter:[0,3,1,""]},"hymd.thermostat":{_random_chi_squared:[0,1,1,""],_random_gaussian:[0,1,1,""],csvr_thermostat:[0,1,1,""]},hymd:{field:[0,0,0,"-"],file_io:[0,0,0,"-"],force:[0,0,0,"-"],input_parser:[0,0,0,"-"],integrator:[0,0,0,"-"],thermostat:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0020733":14,"00268976":14,"0083144621":0,"01036426965":4,"014101":[0,14],"02214076":4,"03642696562":4,"03970":6,"08790868":[6,10],"094106":14,"0xd":8,"0xe":8,"100":[4,6,11],"1000":6,"10000":6,"10001":6,"1010":10,"1021":14,"1063":14,"1080":14,"10nm":6,"110":10,"1120":[0,14],"1130":[0,14],"1137":14,"118":14,"120":[3,6,10],"120885887":14,"120ff":0,"123456":11,"1250":[3,6,10],"126":[0,14],"130":14,"1378":14,"138":[0,4],"1385":14,"144":8,"148":8,"1500":6,"153":14,"170":6,"1785571":14,"179":0,"180":[3,6,10],"1974":0,"1981":0,"1990":14,"1992":[3,14],"200":[6,10],"2000":6,"2001":14,"2007":[0,3,14],"2008":[0,14],"2009":14,"201":[0,3],"2013":14,"2018":[0,14],"2020":[5,6,12,14],"2022":14,"20nm":6,"214106":14,"223":0,"224":1,"2408420":14,"2408724":[6,10],"246":0,"251":[6,10],"2531":14,"2543":14,"26434":14,"28103735":0,"298":6,"2_1":0,"2don2d":8,"2nd":0,"300":[6,11],"3000":6,"3142103":14,"3144621":4,"323":6,"449":[6,10],"463137":14,"48626121":[6,10],"4928":14,"4937":14,"533":1,"544":[6,10],"550":10,"59427866":[6,10],"602176634":4,"610":[6,10],"6264644":14,"66053906660":4,"7b01160":14,"85418781281":4,"935458":[0,4],"940":10,"96924":6,"980":3,"9918564":[6,10],"boolean":3,"byte":13,"case":[0,3,6,10],"class":[0,9],"default":[0,3,7,11,12,13],"float":[0,3],"function":[0,3,5,6,7,11,12],"int":[0,5,6,9,12],"long":[5,6],"new":[0,10,13,14],"public":14,"return":[0,8],"short":[6,11],"sigbj\u00e3":14,"static":0,"switch":12,"true":[0,3,6],"while":[0,12],Adding:6,For:[0,11,12,14],The:[0,3,5,6,7,9,10,11,12,13,14],Then:10,There:11,These:0,Used:[0,3,11],Using:[6,9],With:[0,6],__file__:8,__init__:[0,8],_gener:0,_random_chi_squar:0,_random_gaussian:0,_setup:0,about:[3,11,12],abov:[0,6],absent:0,acceler:0,accompani:6,accord:[0,3],accur:14,acid:6,across:[0,3],acs:14,act:[0,10,12],adapt:0,add:[5,6],added:0,adding:6,addison:0,addit:[0,2,5,11],addition:14,additon:0,adher:0,affect:0,affili:[0,2],after:[0,10,12],against:8,aggreg:6,ahren:0,alanin:6,algorithm:[0,3,12],alia:14,all:[0,2,3,4,6,8,10,11,14],all_nam:0,all_rank:0,alloc:0,allow:[11,14],allreduc:0,along:[6,11],alpha3:8,alpha:0,also:[6,8,14],altern:2,alwai:[0,3],amino:6,amphiphil:14,analyt:0,angl:[0,2,3,6,8,10],angle_bond:[0,3,6,10],angular:[0,3,6,10],ani:[0,2,3],anisotrop:0,antonio:14,apart:0,api:8,app:8,appli:[0,3,7,9,12],applic:0,approach:14,approxim:0,apt:8,aqueou:14,architectur:14,arg:0,argument:[0,6,8,11],argv:8,aris:0,around:10,arrai:[0,3,11,13],arriv:6,art:0,aspect:3,assess:0,assign:[0,3,10],associ:[0,9],assum:3,assumpt:12,atom:0,atom_1:0,atom_2:0,atom_3:0,atom_4:0,attach:13,attempt:0,attr:8,attract:3,attribut:0,autom:14,automat:[0,7,9],avail:[6,8,14],averag:[0,9],avogadro:4,back:[0,5],backbon:[0,2,3,14],backcon:0,backend:14,backmap:0,balanc:0,ballist:6,bar:4,barostat:0,barostat_typ:0,base:[0,14],bath:[0,3],bb_index:0,bc20:14,bdist_wheel:8,bdp07:14,bead:0,becaus:0,becom:0,befor:[0,3,6],being:[0,2,3,5,10,11,12],belong:11,below:6,benchmark:10,bend:[0,3,10,14],bern:14,besid:2,best:0,beta:0,better:0,between:[0,3,5,6,9,10,12,13],bia:0,big:12,bin:8,binari:8,bind:14,bindu:14,bio:14,bit:[0,13],blueprint:0,bmc18:14,boltzmann:[0,3,4],bond2_energi:0,bond3_energi:0,bond4_energi:0,bond:[0,2,6,8,11,12,13],bonds_2:0,bonds_2_atom1:0,bonds_2_atom2:0,bonds_2_atom_1:0,bonds_2_atom_2:0,bonds_2_equilibrium:0,bonds_2_strength:0,bonds_3:0,bonds_3_atom_1:0,bonds_3_atom_2:0,bonds_3_atom_3:0,bonds_3_equilibrium:0,bonds_3_strength:0,bonds_4:0,bonds_4_atom_1:0,bonds_4_atom_2:0,bonds_4_atom_3:0,bonds_4_atom_4:0,bonds_4_coeff:0,bonds_4_last:0,bonds_4_typ:0,bool:0,bore:[0,5,12,14],both:[0,12],boundari:[0,3],box:[0,3,6,11],box_siz:[0,3,6,11],breviti:6,broadcast:0,browser:8,bruce:14,buffer:[0,3],build_extens:8,build_pfft:8,build_pi:8,built:8,bussi:[0,3,14],c213:14,c236:14,c_n:[0,6,10],cach:8,calcul:[0,3,6,10],calibr:0,call:[0,8],callabl:0,can:[6,8,14],cancel_com_momentum:[0,3,6],canon:[0,3,14],capabl:2,captur:11,carloni:14,carri:6,cascella:[5,8,11,12,14],caval:14,cbt:0,cdot10:4,cdot:[0,4,10],cell:[0,12],center:[0,3],centr:14,certain:[0,2],ceruso:14,chain:[0,14],chang:[0,3],changedin:0,charg:[0,3,4,5,6,13,14],charge_out:0,check:[0,8],check_angl:0,check_bond:0,check_box_s:0,check_cancel_com_momentum:0,check_charg:0,check_charges_types_list:0,check_chi:0,check_config:0,check_dielectr:0,check_dihedr:0,check_domain_decomposit:0,check_hamiltonian:0,check_integr:0,check_m:0,check_mass:0,check_max_molecule_s:0,check_n_b:0,check_n_flush:0,check_n_particl:0,check_n_print:0,check_nam:0,check_npt_condit:0,check_start_and_target_temperatur:0,check_tau:0,check_thermostat_coupling_group:0,chem:[0,14],chemic:14,chemrxiv:14,chi:[0,3,4,6,8],chi_2:0,chi_3:0,chi_:[0,3,6,9,12],chi_m:0,chmod:11,chosen:0,cic:[0,5,12],circ:[3,10],circumv:12,classmethod:0,classvar:0,clean:[0,8],clone:[11,14],close:[0,8],close_fil:0,closest:0,cloud:[0,6,12],cncdp08:14,coars:[0,3,7,14],code:[0,1,2,3,6,8,11],coeff:0,coeffici:0,coil:[0,6],colab:8,colaboratori:14,collect:[0,13],com:[0,8,11,14],combin:[0,6,14],comm:0,comm_world:0,command:[8,11],common:9,commuic:0,commun:[0,3,10],communc:0,compar:6,compat:2,compil:[0,8],compiler_so:8,complesfield:0,complet:[0,6,8],complex:[6,13],complexfield:0,compon:0,comprehens:14,compress:[0,3,4,6,9,11],comput:[0,5,10,12,14],compute_angle_forces__plain:0,compute_bond_forces__plain:0,compute_dihedral_forces__plain:0,compute_field_and_kinetic_energi:0,compute_field_energy_q_gp:0,compute_field_forc:0,compute_potenti:0,compute_self_energy_q:0,concret:11,condit:6,config:0,config_simple_1:11,configur:[0,2,5,6,7,9,10,11],configuration_four_particle_exampl:10,configuration_three_particle_exampl:10,configuration_two_particle_exampl:10,configure_runtim:8,conform:[6,13,14],connect:0,conserv:1,consid:6,consist:[0,6],consit:6,consitu:0,constant:[0,3,5,6,10],constitut:[0,2,3],construct:[0,10,11],constructor:0,contain:[0,1,2,3,6,11],content:[0,6],contribut:0,control:3,conv_crit:0,conv_fun:0,conveni:11,converg:[0,12],convergence_typ:0,convert:0,coordin:[11,12,13],copi:0,core:8,correct:[0,3],correspond:[0,3,8],correspondingli:10,cos:[0,6,10],cosin:[0,3,6,10],cost:[3,10],could:8,coulomb:[0,3,4,5],coulomb_const:0,coulombtyp:[0,3,5,6],counter:6,coupl:[0,3,6,11],cprofil:2,cpu:[0,10],crash:3,creat:[0,9],critic:[0,6],cross:0,csvr:[0,3],csvr_thermostat:0,ct800122x:14,ct9002114:14,current:6,cwd:8,cython:[8,14],d_n:0,dal:14,data:[0,6,11,13],dataclass:0,dataset:[0,5,6,11],datatyp:13,date:[0,14],date_format:0,david:14,debug:[0,2],decompos:0,decomposit:[0,3,10],default_level:0,defaultnochi:[0,6,9],defaultnohchi:[0,3],defaultwithchi:[0,3,6,9],defin:[0,6,9,10,12],definit:0,degre:3,delta:[0,12],denot:[0,1,3,9,10,11],dens:14,densiti:[0,3,5,9,12,14],depend:[0,6,10,12,14],deprec:0,deriv:[0,12],design:6,dest_directori:0,detail:[2,3,6,11,12],determin:[0,2,7,14],dev:8,develop:6,deviat:[0,3],dict:0,dictat:0,dictionari:0,dielectr:[0,3,6],dielectric_const:[0,3,5,6],dielectric_typ:0,dielectric_valu:0,dieter:0,diezemann:14,differ:[0,3,6,11,13],differenti:[0,5,7,9,12],difficult:2,dih_typ:0,dihedr:[0,2,3,5,6,8,10,14],dimens:[0,10,11,13],dimension:11,dipol:[0,2,3,5,6,14],dipole_forces_redistribut:0,dir:8,direct:[0,3],directori:11,disabl:[2,6,8,11],disable_mpio:0,discard:0,discret:[0,12],discretis:12,disk:[0,3],dispers:6,dist:8,distanc:[0,3,10],distinct:0,distribut:[0,3,5,6,12],distribute_input:0,distutil:8,doc:0,dockerhub:8,dodecyl:6,doe:[0,10],doi:14,domain:[0,3,10],domain_decomposit:[0,3,6],donadio:[0,14],done:[0,6,14],dopc:6,dot:0,dot_elec:0,doubl:2,double_out:0,download:8,dppc:6,draw:0,drawn:0,driver:11,dtype:0,due:[0,3],dump:0,dump_per_particl:0,dure:[0,2,3,10,11],dynam:[0,3,11,12,14],e1785571:14,e_k:0,each:[0,3,6,10,11],easiest:14,effect:[0,3],effici:10,eight:13,either:[0,3,8,13],elast:14,elec:0,elec_field:0,elec_field_contrib:0,elec_field_fouri:0,elec_forc:0,elecrostat:0,electr:[0,4,5],electrosat:0,electrostat:[0,6,14],elnedyn:14,elucid:6,embed:6,emit:0,emploi:0,empti:0,enabl:[2,6,8,11],enclos:0,end:0,energi:[0,1,3,4,6,7,10,11,12],energiesself:0,ensur:[0,3,6,12],entri:3,environ:14,epsilon:0,equal:[0,3,6],equat:0,equilibr:6,equilibrium:[0,3,6],equilibrum:10,equival:[0,3],error:0,essenti:[0,1,8],etc:[2,3],even:[0,3,6,8],event:0,everi:[0,3,6,10,11],evid:0,ewald:[0,5,6],examin:6,exampl:[3,8,11,13,14],example_structur:11,except:10,exchang:[0,3],exec:8,execut:[0,8,11],exist:0,exit:8,exp:[7,12],expand:0,expans:0,expect:0,expens:[3,12],explicit:[0,6,10,14],express:0,ext:0,extend:6,extens:14,extent:[0,7],extern:0,extract:0,f401:8,f_angl:0,f_bond:0,f_dihedr:0,f_dipol:0,f_on_bead:0,factor:0,factori:0,fail:[0,8],fals:[0,3,6],fashion:[0,3],fast:12,fer:14,few:[6,9,10,11],fft:[0,1,2,3,5,6,11,12,14],fftw3:8,fftw:[8,14],field:[2,4,5,6,9,11,12,14],field_energi:0,field_list:0,field_q_energi:0,field_q_self_energi:0,file:[2,5,6,7,8,9,10,11,14],file_io:0,file_nam:0,file_path:0,filter:[0,3,5,6,11,14],find:0,find_all_path:0,first:[0,3,6,11],five:0,fix:[0,8,11],flag:[0,13],flat:11,float32:[11,13],float64:13,flori:0,fluctuat:0,flush:[0,3],follow:[0,2,3,4,6,11],forc:[2,3,4,5,6,10,14],force_kernel:8,force_mesh:0,force_mesh_elec:0,force_mesh_elec_fouri:0,force_out:0,forego:2,form:[0,5,10],formal:[5,12],format:[0,2,3,5,11,13,14],formatt:0,fortran:[0,10],forward:0,found:[5,8],four:[0,2,3,6,13],fourier:[0,5,12],fr6nt9m4:8,frac:[0,5,6,7,9,10,12],frame:[0,11,13],free:14,frequenc:[0,3],from:[0,2,3,5,6,8,9,10,11,14],full:[0,9,11],fulli:[0,6,8],fundament:11,gamma:0,gamma_0:0,gas:[0,4],gas_const:0,gather:0,gauss:14,gaussian:[0,3,7,12],gener:[0,2,3,6,14],get:8,getattr:8,ghost:0,giovanni:14,git:[11,14],github:[6,8,11,14],githubusercont:8,giusepp:14,given:[0,3,6,7],glenn:14,global:0,gnu:14,govern:9,gpe:0,grab:8,gradient:0,grain:[0,3,7,14],graph:0,gregor:14,grid:[0,1,3,5,6,7,11,12],group:[0,3,6,8,11,13,14],guess:0,gyrat:6,h5md:[0,3],h5py:[0,2,8],h_0:[6,12],half:0,hamiltonian:[3,5,6,7,9,11,14],handl:0,handler:0,happen:10,harmon:[0,3,6,10],has:[0,3,13],hat:[7,12],have:[0,6,8],hdf5:[0,2,3,5,6,8,11,13,14],hdf5_mpi:8,head:6,heat:[0,3],helic:[0,3,5,6],help:6,helper:0,here:[0,6,8,14],hhpf:14,highli:[8,10,11],hijack:7,hima:14,hire:1,homogen:0,homopolym:1,homopolypeptid:6,how:[3,11,14],howev:6,hpf:[3,5,9,11,12,14],html:0,http:[0,8,11,14],huggin:0,hundr:[6,10],hybrid:[11,12,14],hylleraa:14,hymd:[0,2,3,4,5,6,7,8,9,10,11,12,13],ideal:10,ideal_chain:[6,8],ideal_ga:[6,11],ident:0,ignor:0,ijk:[5,12],imag:8,impact:0,implement:[0,10],importerror:8,impuls:[0,3],in_fil:0,includ:[0,2,3,6,12,14],incompress:[0,3],inconveni:8,increas:[0,2,6],indentifi:0,independ:[0,3,7,12],index:[0,11,13,14],indic:[0,2,3,10,11,13],indirect:0,individu:[0,3,6],induc:5,infer:10,info:0,inform:[0,10,14],ingredi:6,initi:0,initial_energi:0,initialis:11,initialize_pm:0,inner:[0,3],input:[2,3,4,5,6,7,8,11,13],input_box:0,input_pars:[0,8],insid:[0,3,6],instal:[2,11],install_pfft:8,instantan:0,int32:[11,13],int64:13,integ:[0,3,6,13],integr:[3,6,11],integrate_posit:0,integrate_veloc:0,intend:8,inter:[0,10],interact:[0,2,3,4,6,7,11,12,14],interaction_energi:0,interfac:0,intergr:0,intermediari:0,intermolecular:[6,14],intern:[0,2,4,10],interpol:[0,5],interpret:11,interv:[0,3],intmathrm:0,intracomm:0,intramolecular:[0,3,6,12,14],intrins:5,introduc:6,investig:0,invok:[2,11],involv:[0,3,10],ion:6,ipynb:6,is_open:0,iter:0,j_k:0,jan:14,jctc:14,join:8,jone:12,journal:14,jupyt:[6,8,14],k_e:0,kappa:[0,3,4,6,11,12],kawakatsu:14,kdnb:14,keep:[0,3],kelvin:[0,3,6,11],ken:14,kernel:[0,10],keyword:[0,5,6,11],kinet:[0,12],kinetic_energi:0,knuth:0,kolli:14,kpa:4,label:[1,10],lambda:0,lamdifi:9,land:14,laplacian:0,larg:[8,11],larger:3,last:[6,8,11,13],last_bb:0,later:[0,6],latest:8,law:10,layout:0,layout_q:0,lbc20:14,learn:14,leav:0,ledum:[6,14],left:[0,5,6,7,9,10,12],legend:1,lenght:0,length:[0,3,4,6,7,10,11,13],lennard:12,less:[0,6],lesser:14,let:[0,10],level:[0,2,3,13],liang:14,lib:8,libhdf5:8,librari:[0,2,8,14],licens:14,lieu:0,like:[0,6,11],limit:3,line:[0,8,11],linear:[0,3],lipid_self_assembl:6,list:0,list_coulomb:0,load:0,local:[0,10,11,12],log:[0,2,11],log_fil:0,log_out:11,logfil:[2,11],logger:2,logic:0,logrecord:0,look:[6,11],loop:0,lost:3,low:6,m_j:0,machin:[2,14],made:0,mai:[0,2,3,6,8,10,11,13],main:[0,8,11],maintain:14,make:6,manner:6,manual:8,map:[0,11],marco:14,marilisa:14,marrink:14,martini:[6,14],martyna:14,mass:[0,3,4,13],massiv:14,match:0,math:0,mathbf:[0,4,5,6,9,10,12],mathcal:[6,12],mathmr:0,mathrm:[0,5,6,9,10,12],matteo:14,matter:[6,10,14],max_molecule_s:[0,3,6],maximum:[0,3,10,11],maxwel:[0,3],may:2,mbbjm:14,mean:[0,2,3],measur:10,medium:[0,3,6],melt:1,membran:6,memori:0,mesh:[0,1,3,5,6,14],mesh_siz:[0,3,6,11],messag:0,messi:0,meta:6,metadata:0,method:[0,1,6,7],mh_0:12,micellular:6,michael:14,michel:14,might:0,milano:14,mimic:0,minim:6,minuscul:10,mirror:2,mix:[0,6],mk09:14,model:[6,14],modifi:0,modul:[0,3,8,14],mol:[3,4,6,10,11,14],molecul:[0,3,11,12,13],molecular:[2,11,12,14],momenta:[0,11],momentum:[0,3,4],monoatom:6,more:[2,3,6,11,12,14],mortel:8,morten:14,most:[8,9,11,12],mostli:[2,8],motion:[0,6],move:0,mpi4pi:[0,8,14],mpi:[0,2,3,8,10,11,14],mpi_num_rank:11,mpicc:8,mpifilteral:0,mpifilterroot:0,mpio:[2,8],mpirun:11,multiarrai:8,multipl:[0,3,6,11,13,14],multipolar:14,multiscal:14,must:[0,3],n_b:0,n_flush:[0,3,6],n_frame:0,n_particl:[0,3],n_print:[0,3,6,11],n_step:[0,3,6,11],n_type:0,nabla:[0,12],name:[0,2,3,6,10,11,13],nanomet:[0,1],nanosecond:6,ndarrai:0,ne5et1y_:8,necessari:[0,6],necessit:[8,9],need:[0,6],neg:[0,6],neighbour:0,neri:14,network:[0,10,11,13,14],networkx:0,neutralis:6,never:[0,3],nevertheless:3,next:[0,6],nicola:14,non:[0,2,6,8],none:[0,3],nongnu:0,noqa:8,normal:[0,2,3,8,12],notabl:11,note:[0,6,8,11,12],notebook:[6,8,14],now:6,nproc:11,npt:0,nq_i:5,number:[0,1,2,3,6,11,12,13],numer:0,numpi:[0,2,9,14],nvt:0,object:[0,9],oblat:6,observ:[0,6],obtain:[0,5,12,14],obviou:8,off:6,omit:6,onc:[3,10],one:[0,2,3,6,13],onli:[0,6,10,11],onto:[0,3,5,12],open:[0,8],openmpi:8,oper:[0,3,12,14],oppos:0,optim:[0,10],optimis:[6,10],option:[0,3,6,11],order:[0,3,6,10,11],ordinari:[5,12],org:0,organis:6,origin:0,oslo:14,other:[0,11],otherwis:0,out:[8,12],outdataset:0,outer:0,output:[2,3,4,6,8,11],outsid:3,over:0,overlap:[0,9],packag:[8,11,14],page:14,paint:0,paolo:14,paper:0,parallel:[0,2,3,8,14],paramet:[0,3,6,7,9,14],parent_group:0,parllel:0,parrinello:[0,14],pars:[0,3],parse_config_toml:[0,8],part:[5,6,12],partial:0,particl:[0,2,5,6,7,9,11,12,13,14],particlemesh:0,particular:11,path:[0,2,11],pcmc09:14,pdf:1,pencil:0,peptid:[0,2,3,5,14],per:[0,2,3,10,11,13],peraro:14,perfect:0,perform:[0,3,10,11,12],periol:14,perman:[10,14],permitt:[0,4],pfft:[0,14],pfft_build_dir:8,phase:[0,10],phase_separ:6,phi:[0,3,6,10,12],phi_0:[6,9,12],phi_:[0,6,9,12],phi_ep:0,phi_eps_fouri:0,phi_eta:0,phi_eta_fouri:0,phi_fouri:0,phi_k:0,phi_l:0,phi_laplacian:0,phi_n:[6,10],phi_pol:0,phi_pol_prev:0,phi_q:0,phi_q_fouri:0,phi_transf:0,phospholipid:6,phy:[0,14],pic_spectr:[0,3,6],pic_spectral_gp:0,piec:6,pip13:14,pip:[8,11,14],pippig:14,place:[0,3],plain:2,plane:[0,6,10],pleas:[8,11],plume:0,plumed_bia:0,plumed_out:0,pme:14,pmesh:[0,14],png:1,point:[0,1,10,13],poisson:0,pol_mix:0,polar:0,polym:[6,14],posit:[0,2,3,5,6,11,12],possibl:[0,3,6,14],potenti:[0,3,4,5,7,10,14],ppft:14,practic:10,pre:[0,6],precis:[1,2],prefer:3,prepar:0,prepare_bond:0,prepare_bonds_old:0,prepare_index_based_bond:0,prepend:[0,11],present:[0,2,3,6],preserv:3,pressur:[0,4],pretti:8,previou:0,previous:6,prior:[0,3],priovid:0,prng:0,prod_:0,profil:2,program:[0,11],project:5,promot:0,prop:0,propag:[0,3],propens:[0,3,5,6],propensity_potential_coeff:0,properti:3,protein:[0,14],provid:[0,2,3,11,13,14],psi:[0,4,5],psi_:5,psi_fouri:0,pull:8,put:6,pytest:11,python3:[6,8,11,14],python:[0,11,14],q_i:[0,5],q_j:0,quadrat:0,quanit:0,quantiti:[0,4],quantum:14,quartet:10,quess:0,r_0:[0,6,10],r_a:10,r_c:10,rad:[3,10],radial:6,radii:6,radiu:6,rainwoodman:[8,14],rais:[6,8],random:[0,2,11],random_chi_squar:0,random_gaussian:0,randomli:[0,3,6],rang:5,rank0:0,rank:[0,2,3,10,11],rank_rang:0,rankself:0,rare:10,raw:8,read:[0,8,11,14],read_config_toml:[0,8],readout:0,real:13,realfield:0,realist:6,reappli:0,rearrang:0,reason:8,receiv:[0,3],recent:8,reciproc:[0,7],recognis:11,recognit:14,recommend:8,reconstruct:[0,2,5,6,10,14],record:0,recreat:14,recurs:0,redistribut:0,reduc:[3,12],refer:[3,11],regim:6,regul:[0,3],rel:[0,3,6,10],relax:[0,3],releas:[0,6,8,11,14],remain:[0,6],remov:[0,3],remove_center_of_mass_momentum:0,remove_com_momentum:[0,3],replac:[0,8],repositori:[6,11],repres:[0,3,13],represent:7,repuls:3,requir:[0,3,8,10,11,14],rescal:[0,3,14],research:14,respa:[0,3,6],respa_inn:[0,3,6],respect:[0,1,12],restructur:0,result:[0,3,6,9],revers:[0,3,14],rgen:14,rho0:0,rho:[0,5],rho_0:0,rho_:5,right:[0,5,6,7,9,10,12],rightarrow:10,root:[0,11,13],roughi:6,row:11,rrespa:[0,3,6],ruin:0,run:[0,2,3,6,10],rundown:11,runtimeerror:8,same:[0,3,6],sampl:[0,3,14],scalar:0,scale:[0,3,6,7,8,10,11,14],sch:14,scheme:[0,6],sci:14,scienc:14,script:11,sds:6,search:14,second:[0,11],see:[0,2,3,5,6,8,9,10,11,12,14],seed:[2,11],select:[11,14],self:[0,3,8],self_energi:0,seminumer:0,send:[0,3],separ:0,seri:[0,3,6,10],serial:[8,11],serialis:3,set:[0,3,11],setup:[0,6,7,8,13],setup_time_dependent_el:0,setuptool:8,sever:0,shape:[0,6,11,13],sheet:0,shift:0,should:[0,2,10],shown:6,siam:14,siewert:14,sigbj:14,sigma:[0,3,6,7,11,12],sim:0,similar:0,simpl:[0,6,11,12],simplest:6,simpli:[0,8],simul:[0,2,6,8,10,12,13,14],simultan:0,sinc:0,singl:[0,3,6],size:[0,3,6,11,12],slight:0,slow:8,slowli:12,small:[3,11],smear:5,smooth:[0,12],sodium:6,soft:[6,14],solv:0,solvent:6,some:[0,3],sort:0,sort_dielectric_by_type_id:0,sourc:[0,1],space:[0,3,5,7],span:0,spatial:[0,3,11,12],specfi:0,speci:0,special:0,specif:[0,2,3,6,9,10,11,13],specifi:[0,2,3,6,9,10,11,13],spectacularli:0,spectral:6,speed:[0,3],spheric:6,spheroid:6,split:0,spontan:6,spring:[0,10],sqrt:[0,7,12],squar:[0,9],squaredphi:[0,3,9,11],stabil:6,stabl:6,stackoverflow:0,standard:[0,3,12,14],start:[0,3,6,10,13],start_temperatur:[0,3,6],state:0,statu:8,stdout:[0,2],step:[0,3,6,10,11],stiff:3,stochast:0,store:0,store_data:0,store_stat:0,str10:11,str:0,straightforward:[7,9],stream:0,strength:[0,3,6,11],stretch:[0,3,10,14],string:[0,3,8,11,13],structur:[0,2,3,5,6,11,14],style:14,sub:6,subclass:[0,9],subsequ:[0,5,6,10],sudo:8,suitabl:0,sulfat:6,sum:0,sum_:[0,5,9,12],sum_i:0,sum_j:0,sum_k:0,sum_n:[0,6,10],summari:11,superclass:[0,7],support:[0,6,14],swap:10,symbol:[0,4,9],sympi:[0,9],sys:8,system:[0,1,2,3,6,8,9,11,12,14],tag:[0,3,8],take:[0,3,5,9,10,11,12],taken:0,tar:8,target:0,target_pressur:0,target_temperatur:[0,3,6,11],tau:[0,3,6,11],tau_p:0,tbm92:14,temperatur:[0,3,4,6,11],ten:6,term:[0,3,6,9,12],test:[0,1],text:[0,2,3,4,5,6,9,10,12],than:[0,3],theori:[0,14],thermalis:[0,3],thermostat:[2,3,6,11],thermostat_coupling_group:[0,3,6],thermostat_work:0,theta:[6,10],theta_0:[0,6,10],thi:[0,2,3,6,8,9,10,11,12],thorough:11,though:6,thousand:[6,10],three:[0,2,3,6],through:[0,3,6,7,9,10,14],tild:[0,3,4,5,6,9,12],time:[0,3,4,6,10,11,14],time_step:[0,3,6,11],tmp:8,todo:0,togeth:[0,3,6],token:8,toml:[0,2,3,6,8,10,11],toml_cont:0,tomli:0,too:3,toplog:0,topol:0,topolog:[0,2,3,5,6,11,14],torsion:[0,3,10,14],toshihiro:14,total:[0,3,6,11,12],traceback:8,trajectori:[0,2,3,6,11],trans_matric:0,transfer:[0,10],transform:[0,9,12],travers:0,tri:3,truncat:0,tuckerman:[3,14],turn:6,tutori:[6,8,11,13],two:[0,2,3,6],txt:11,type:[0,2,3,5,6,9,10,11,13],type_arrai:0,type_charg:0,type_to_name_map:0,ubuntu:8,uio:[8,11,14],unchang:0,under:[6,12,14],union:0,uniqu:0,unique_nam:0,unit:[0,3,10],univers:14,unknown:0,unless:[0,3],unset:0,unstabl:3,until:6,updat:[0,8],update_field:0,update_field_force_q:0,update_field_force_q_gp:0,upgrad:[8,14],usag:[0,2],use:[0,3,5,6,8],used:[0,1,2,3,6,7,9,11,12,13],uses:[0,4,12,14],using:[0,2,3,8,12,14],usr:8,usual:11,v_2:[0,6,10],v_3:[0,6,10],v_4:[0,6,10],v_ext:0,v_ext_fouri:0,vacuum:4,valid:[0,3],validated_config:0,valu:[0,3,4,5,6,10],valueerror:8,vanish:0,varepsilon:0,varepsilon_0:[4,5],vari:12,variabl:0,variant:6,variou:[0,13],vbar_elec:0,vbar_elec_fouri:0,vector:10,vectoris:9,veloc:[0,2,3,4,6,11,13,14],velocity_out:0,velocti:0,verbos:[0,2,8,11],veri:[6,10],verifi:0,verlet:[0,3,6,11],versa:3,version:[0,6,8,11,12],vert:0,vertex:[0,5],vertic:0,via:[6,8,14],vice:3,vol:0,volum:0,voxel:0,wai:[8,12],warn:0,weakli:3,weight:0,well:6,were:0,weslei:0,wheel:8,when:[0,3,10],where:[0,5,9,10,12],which:[0,2,3,5,6,9,10,11],width:[0,3],window:[0,5,12],without:[0,8,14],work:[0,8],workload:0,would:[0,3],wrap:0,wrapper:0,write:[0,3],written:[0,3],www:0,xavier:14,yield:6,you:[8,10,14],yuan:14,zero:[0,3],zhong:14,zhu:14},titles:["4. API reference","3. Benchmarks","5. Command line arguments","3. Configuration file","6. Constants and Units","3. Electrostatic interactions","1. Examples","2. Filtering","1. Installation","1. Interaction energy functionals","2. Intramolecular bonds","2. Usage overview for HylleraasMD","1. Theory","4. Topology and structure file","HylleraasMD documentation"],titleterms:{"function":9,"import":8,"new":[7,9],"while":8,SDS:6,api:0,argument:2,assembl:6,benchmark:1,bilay:6,bond:[1,3,10],build:8,calcul:12,chain:6,chi:9,code:14,colab:14,colaboratori:8,command:2,common:8,configur:3,constant:4,copolym:6,curl:8,dataset:13,depend:8,develop:14,diblock:6,docker:8,document:14,due:8,electrostat:[3,5],energi:9,error:8,exampl:6,extern:12,field:[0,1,3],file:[0,3,13],filter:[7,12],forc:[0,1,8,12],form:[9,12],fortran:8,four:10,gas:6,googl:[8,14],guid:14,hamiltonian:[0,12],helix:6,hylleraasmd:[11,14],hymd:14,ideal:6,implement:[7,9],incompress:9,indic:14,input:0,instal:[8,14],integr:0,interact:[5,8,9],interpol:12,intramolecular:10,issu:8,kappa:9,kernel:8,keyword:3,line:2,lipid:6,logger:0,metadata:3,miss:8,numpi:8,onli:9,option:[2,13],output:0,overview:11,parallel:11,parser:0,particl:[1,3,10],peptid:6,pfft:8,phase:6,phi:9,potenti:12,python:8,reciproc:12,refer:[0,14],requir:[2,13],rod:6,run:[8,11,14],self:6,separ:6,simul:[3,11],sourc:14,space:12,specifi:5,stiff:6,structur:13,tabl:14,test:11,theori:12,thermostat:0,three:10,topolog:13,two:10,unit:4,usag:11,user:14,wget:8}}) \ No newline at end of file diff --git a/v1.0.4/.buildinfo b/v1.0.4/.buildinfo new file mode 100644 index 00000000..38ac6410 --- /dev/null +++ b/v1.0.4/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 76dc762dc2225c2b8b0bc04007fd3a92 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v1.0.4/.doctrees/doc_pages/api.doctree b/v1.0.4/.doctrees/doc_pages/api.doctree new file mode 100644 index 00000000..0eb5dae1 Binary files /dev/null and b/v1.0.4/.doctrees/doc_pages/api.doctree differ diff --git a/v1.0.4/.doctrees/doc_pages/benchmarks.doctree b/v1.0.4/.doctrees/doc_pages/benchmarks.doctree new file mode 100644 index 00000000..7a5374b9 Binary files /dev/null and b/v1.0.4/.doctrees/doc_pages/benchmarks.doctree differ diff --git a/v1.0.4/.doctrees/doc_pages/command_line.doctree b/v1.0.4/.doctrees/doc_pages/command_line.doctree new file mode 100644 index 00000000..9ddfdf7a Binary files /dev/null and b/v1.0.4/.doctrees/doc_pages/command_line.doctree differ diff --git a/v1.0.4/.doctrees/doc_pages/config_file.doctree b/v1.0.4/.doctrees/doc_pages/config_file.doctree new file mode 100644 index 00000000..c8d9b103 Binary files /dev/null and b/v1.0.4/.doctrees/doc_pages/config_file.doctree differ diff --git a/v1.0.4/.doctrees/doc_pages/constants_and_units.doctree b/v1.0.4/.doctrees/doc_pages/constants_and_units.doctree new file mode 100644 index 00000000..441bf669 Binary files /dev/null and b/v1.0.4/.doctrees/doc_pages/constants_and_units.doctree differ diff --git a/v1.0.4/.doctrees/doc_pages/electrostatics.doctree b/v1.0.4/.doctrees/doc_pages/electrostatics.doctree new file mode 100644 index 00000000..1e58c235 Binary files /dev/null and b/v1.0.4/.doctrees/doc_pages/electrostatics.doctree differ diff --git a/v1.0.4/.doctrees/doc_pages/examples.doctree b/v1.0.4/.doctrees/doc_pages/examples.doctree new file mode 100644 index 00000000..30868bb4 Binary files /dev/null and b/v1.0.4/.doctrees/doc_pages/examples.doctree differ diff --git a/v1.0.4/.doctrees/doc_pages/filtering.doctree b/v1.0.4/.doctrees/doc_pages/filtering.doctree new file mode 100644 index 00000000..48ebaff5 Binary files /dev/null and b/v1.0.4/.doctrees/doc_pages/filtering.doctree differ diff --git a/v1.0.4/.doctrees/doc_pages/installation.doctree b/v1.0.4/.doctrees/doc_pages/installation.doctree new file mode 100644 index 00000000..9ccc4890 Binary files /dev/null and b/v1.0.4/.doctrees/doc_pages/installation.doctree differ diff --git a/v1.0.4/.doctrees/doc_pages/interaction_energy_functionals.doctree b/v1.0.4/.doctrees/doc_pages/interaction_energy_functionals.doctree new file mode 100644 index 00000000..dbf1d6b3 Binary files /dev/null and b/v1.0.4/.doctrees/doc_pages/interaction_energy_functionals.doctree differ diff --git a/v1.0.4/.doctrees/doc_pages/intramolecular_bonds.doctree b/v1.0.4/.doctrees/doc_pages/intramolecular_bonds.doctree new file mode 100644 index 00000000..a2e4ff64 Binary files /dev/null and b/v1.0.4/.doctrees/doc_pages/intramolecular_bonds.doctree differ diff --git a/v1.0.4/.doctrees/doc_pages/overview.doctree b/v1.0.4/.doctrees/doc_pages/overview.doctree new file mode 100644 index 00000000..38f11e6b Binary files /dev/null and b/v1.0.4/.doctrees/doc_pages/overview.doctree differ diff --git a/v1.0.4/.doctrees/doc_pages/theory.doctree b/v1.0.4/.doctrees/doc_pages/theory.doctree new file mode 100644 index 00000000..2586b085 Binary files /dev/null and b/v1.0.4/.doctrees/doc_pages/theory.doctree differ diff --git a/v1.0.4/.doctrees/doc_pages/topology_input.doctree b/v1.0.4/.doctrees/doc_pages/topology_input.doctree new file mode 100644 index 00000000..3d4ea3e1 Binary files /dev/null and b/v1.0.4/.doctrees/doc_pages/topology_input.doctree differ diff --git a/v1.0.4/.doctrees/environment.pickle b/v1.0.4/.doctrees/environment.pickle new file mode 100644 index 00000000..2d64c619 Binary files /dev/null and b/v1.0.4/.doctrees/environment.pickle differ diff --git a/v1.0.4/.doctrees/index.doctree b/v1.0.4/.doctrees/index.doctree new file mode 100644 index 00000000..fc7b3c22 Binary files /dev/null and b/v1.0.4/.doctrees/index.doctree differ diff --git a/v1.0.4/_downloads/0d76ecdc223cebaf4d354af3c0265adf/benchmarks-1.hires.png b/v1.0.4/_downloads/0d76ecdc223cebaf4d354af3c0265adf/benchmarks-1.hires.png new file mode 100644 index 00000000..173b39f3 Binary files /dev/null and b/v1.0.4/_downloads/0d76ecdc223cebaf4d354af3c0265adf/benchmarks-1.hires.png differ diff --git a/v1.0.4/_downloads/12f91f9a60c17befb168e0bf35c08b62/benchmarks-2.hires.png b/v1.0.4/_downloads/12f91f9a60c17befb168e0bf35c08b62/benchmarks-2.hires.png new file mode 100644 index 00000000..82806426 Binary files /dev/null and b/v1.0.4/_downloads/12f91f9a60c17befb168e0bf35c08b62/benchmarks-2.hires.png differ diff --git a/v1.0.4/_downloads/26df5feb7a07be4d3f2cd3cb1f71ce59/benchmarks-1.png b/v1.0.4/_downloads/26df5feb7a07be4d3f2cd3cb1f71ce59/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.4/_downloads/26df5feb7a07be4d3f2cd3cb1f71ce59/benchmarks-1.png differ diff --git a/v1.0.4/_downloads/47ef8a438236689bde889b7945718929/benchmarks-2.png b/v1.0.4/_downloads/47ef8a438236689bde889b7945718929/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v1.0.4/_downloads/47ef8a438236689bde889b7945718929/benchmarks-2.png differ diff --git a/v1.0.4/_downloads/49e39cd5edf35c42a8624884236b9a08/benchmarks-1.pdf b/v1.0.4/_downloads/49e39cd5edf35c42a8624884236b9a08/benchmarks-1.pdf new file mode 100644 index 00000000..053bcafd Binary files /dev/null and b/v1.0.4/_downloads/49e39cd5edf35c42a8624884236b9a08/benchmarks-1.pdf differ diff --git a/v1.0.4/_downloads/c43dbc5b4e7435e9562730db2fdda156/benchmarks-2.pdf b/v1.0.4/_downloads/c43dbc5b4e7435e9562730db2fdda156/benchmarks-2.pdf new file mode 100644 index 00000000..b3b3d990 Binary files /dev/null and b/v1.0.4/_downloads/c43dbc5b4e7435e9562730db2fdda156/benchmarks-2.pdf differ diff --git a/v1.0.4/_downloads/d28cb0da3dc630cd5e5d4ea7fb4c6a62/benchmarks-1.py b/v1.0.4/_downloads/d28cb0da3dc630cd5e5d4ea7fb4c6a62/benchmarks-1.py new file mode 100644 index 00000000..deb4348f --- /dev/null +++ b/v1.0.4/_downloads/d28cb0da3dc630cd5e5d4ea7fb4c6a62/benchmarks-1.py @@ -0,0 +1,38 @@ +import numpy as np +import matplotlib.pyplot as plt +nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) +time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 +], dtype=np.float64) +nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 +], dtype=np.float64,) +time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, +], dtype=np.float64) +nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 +], dtype=np.float64) +time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, +], dtype=np.float64) +plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" +) +plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" +) +plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" +) +plt.xlabel("CPUs", fontsize=15) +plt.ylabel("Time per step, us", fontsize=15) +plt.legend(fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.show() \ No newline at end of file diff --git a/v1.0.4/_downloads/d439f4acf1149f7eec7abca1ce727e3e/benchmarks-2.py b/v1.0.4/_downloads/d439f4acf1149f7eec7abca1ce727e3e/benchmarks-2.py new file mode 100644 index 00000000..fd287cbc --- /dev/null +++ b/v1.0.4/_downloads/d439f4acf1149f7eec7abca1ce727e3e/benchmarks-2.py @@ -0,0 +1,33 @@ +import numpy as np +import matplotlib.pyplot as plt + +mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] +mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + +mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + +mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + +mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] +mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + +mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + +mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + +plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") +plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") +plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") +plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") +plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") +plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") +plt.xlabel("CPUs", fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.ylabel("Time per step, s", fontsize=15) +plt.legend(loc="upper left", fontsize=15) +plt.show() \ No newline at end of file diff --git a/v1.0.4/_images/benchmarks-1.png b/v1.0.4/_images/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.4/_images/benchmarks-1.png differ diff --git a/v1.0.4/_images/benchmarks-2.png b/v1.0.4/_images/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v1.0.4/_images/benchmarks-2.png differ diff --git a/v1.0.4/_images/hylleraas_centre_logo_black.png b/v1.0.4/_images/hylleraas_centre_logo_black.png new file mode 100644 index 00000000..40826396 Binary files /dev/null and b/v1.0.4/_images/hylleraas_centre_logo_black.png differ diff --git a/v1.0.4/_images/uio_full_logo_eng_pos.png b/v1.0.4/_images/uio_full_logo_eng_pos.png new file mode 100644 index 00000000..6c603139 Binary files /dev/null and b/v1.0.4/_images/uio_full_logo_eng_pos.png differ diff --git a/v1.0.4/_modules/hymd/field.html b/v1.0.4/_modules/hymd/field.html new file mode 100644 index 00000000..0fb52aee --- /dev/null +++ b/v1.0.4/_modules/hymd/field.html @@ -0,0 +1,1451 @@ + + + + + + hymd.field — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.field

+"""Forces and energies from the discretized particle-field grid interactions
+"""
+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import warnings
+
+
+
[docs]def initialize_pm(pmesh, config, comm=MPI.COMM_WORLD): + """ + Creates the necessary pmesh objects for pfft operations. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + config : Config + Configuration dataclass containing simulation metadata and parameters. + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm : object 'pmesh.pm.ParticleMesh' + field_list : list[pmesh.pm.RealField], (multiple) + Essential list of pmesh objects required for MD + list_coulomb : list[pmesh.pm.RealField], (multiple) + Additional list of pmesh objects required for electrostatics. + """ + + if config.dtype == np.float64: + pmeshtype = "f8" + else: + pmeshtype = "f4" + # Ignore numpy numpy.VisibleDeprecationWarning: Creating an ndarray from + # ragged nested sequences until it is fixed in pmesh + with warnings.catch_warnings(): + warnings.filterwarnings( + action="ignore", + category=np.VisibleDeprecationWarning, + message=r"Creating an ndarray from ragged nested sequences", + ) + # The first argument of ParticleMesh has to be a tuple + pm = pmesh.ParticleMesh( + config.mesh_size, BoxSize=config.box_size, dtype=pmeshtype, comm=comm + ) + phi = [pm.create("real", value=0.0) for _ in range(config.n_types)] + phi_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] # noqa: E501 + force_on_grid = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + v_ext_fourier = [pm.create("complex", value=0.0) for _ in range(4)] + v_ext = [pm.create("real", value=0.0) for _ in range(config.n_types)] + + phi_transfer = [pm.create("complex", value=0.0) for _ in range(3)] + + phi_laplacian = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + + # Initialize charge density fields + coulomb_list = [] + elec_common_list = [None, None, None, None] + _SPACE_DIM = config.box_size.size + + if config.coulombtype == "PIC_Spectral_GPE" or config.coulombtype == "PIC_Spectral": + phi_q = pm.create("real", value=0.0) + phi_q_fourier = pm.create("complex", value=0.0) + psi = pm.create("real", value=0.0) + elec_field = [pm.create("real", value=0.0) for _ in range(_SPACE_DIM)] + + elec_common_list = [phi_q, phi_q_fourier, psi, elec_field] + + if config.coulombtype == "PIC_Spectral": + elec_field_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] # for force calculation + psi_fourier = pm.create("complex", value=0.0) + + coulomb_list = [ + elec_field_fourier, + psi_fourier, + ] + + if ( + config.coulombtype == "PIC_Spectral_GPE" + ): ## initializing the density mesh #dielectric_flag + phi_eps = pm.create( + "real", value=0.0 + ) ## real contrib of the epsilon dielectric painted to grid + phi_eps_fourier = pm.create("complex", value=0.0) # complex contrib of phi eps + phi_eta = [ + pm.create("real", value=0.0) for _ in range(_SPACE_DIM) + ] ## real contrib of factor in polarization charge density + phi_eta_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] ## fourier of factor in polarization charge density + phi_pol = pm.create( + "real", value=0.0 + ) ## real contrib of the polarization charge + phi_pol_prev = pm.create("real", value=0.0) + elec_dot = pm.create("real", value=0.0) + elec_field_contrib = pm.create( + "real", value=0.0 + ) # needed for pol energies later + + # External potential and force meshes + Vbar_elec = [pm.create("real", value=0.0) for _ in range(config.n_types)] + Vbar_elec_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] + force_mesh_elec = [ + [pm.create("real", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + force_mesh_elec_fourier = [ + [pm.create("complex", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + + coulomb_list = [ + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol, + phi_pol_prev, + elec_dot, + elec_field_contrib, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + ] + + field_list = [ + phi, + phi_fourier, + force_on_grid, + v_ext_fourier, + v_ext, + phi_transfer, + phi_laplacian, + ] + + return (pm, field_list, elec_common_list, coulomb_list)
+ + +
[docs]def compute_field_force(layouts, r, force_mesh, force, types, n_types): + """Interpolate particle-field forces from the grid onto particle positions + + Backmaps the forces calculated on the grid to particle positions using the + window function :math:`P` (by default cloud-in-cell [CIC]). In the + following, let :math:`\\mathbf{F}_j` denote the force acting on the + particle with index :math:`j` and position :math:`\\mathbf{r}_j`. The + interpolated force is + + .. math:: + + \\mathbf{F}_j = -\\sum_k\\nabla V_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`V_{j_k}` is the discretized external potential at grid vertex + :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid vertex + with index :math:`j_k`, and :math:`h^3` is the volume of each grid voxel. + The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + r : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + force : (N,D) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. Local + for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + n_types : int + Number of different unique types present in the simulation system. + :code:`n_types` is global, i.e. the same for all MPI ranks even if some + ranks contain zero particles of certain types. + """ + for t in range(n_types): + ind = types == t + for d in range(3): + force[ind, d] = force_mesh[t][d].readout(r[ind], layout=layouts[t])
+ + +
[docs]def compute_self_energy_q(config, charges, comm=MPI.COMM_WORLD): + """Compute the self energy for the interaction due to the Ewald scheme + used to compute the electrostatics. The energy is stored in :code:`config`. + + The self interaction energy is given by: + + .. math:: + + U_{self} = \\sqrt{\\frac{1}{2\\pi\\sigma^2}} \\sum_{i=1}^{N} q_i^2 + + where :math:`q_i` are the charges and :math:`\\sigma` is the half-width + of the Gaussian filter. + + Parameters + ---------- + config : Config + Configuration object. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + comm : mpi4py.Comm + MPI communicator to use for rank communication. + + Returns + ------- + field_q_self_energy : float + Electrostatic self energy. + """ + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + prefac = elec_conversion_factor * np.sqrt( + 1.0 / (2.0 * np.pi * config.sigma * config.sigma) + ) + _squared_charges = charges * charges + squared_charges_sum = comm.allreduce(np.sum(_squared_charges)) + return prefac * squared_charges_sum
+ + +
[docs]def update_field_force_q( + charges, + phi_q, + phi_q_fourier, + psi, + psi_fourier, + elec_field_fourier, + elec_field, + elec_forces, + layout_q, + hamiltonian, + pm, + positions, + config, +): + """Calculate the electrostatic particle-field forces on the grid + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential is computed in reciprocal space as + + .. math:: + + \\Phi = \\mathrm{FFT}^{-1}\\left[ + \\frac{4\\pi k_e}{\\varepsilon \\vert\\mathbf{k}\\vert^2} + \\mathrm{FFT}(\\rho)\\mathrm{FFT}(H) + \\right], + + with the electric field + + .. math:: + + \\mathbf{E} = \\mathrm{FFT}^{-1}\\left[ + -i\\mathbf{k}\\,\\mathrm{FFT}(\\Psi) + \\right]. + + In the following, let :math:`\\mathbf{F}_j` denote the electrostatic force + acting on the particle with index :math:`j` and position + :math:`\\mathbf{r}_j`. The interpolated electrostatic force is + + .. math:: + + \\mathbf{F}_j = \\sum_k q_j\\mathbf{E}_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`\\mathbf{E}_{j_k}` is the discretized electric field at grid + vertex :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid + vertex with index :math:`j_k`, and :math:`h^3` is the volume of each grid + voxel. The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty; any values in this field + are discarded. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + elec_field_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + electric field values in reciprocal space on the computational grid. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + n_dimensions = config.box_size.size + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + # charges to grid + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) + phi_q /= volume_per_cell + # print("phi_q", np.sum(phi_q)) + phi_q.r2c(out=phi_q_fourier) + + # smear charges with filter + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + + # solve Poisson equation in Fourier space to get electrostatic potential + def poisson_transfer_function(k, v): + return 4.0 * np.pi * elec_conversion_factor * v / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(poisson_transfer_function, out=psi_fourier) + # print("psi_fourier", np.sum(psi_fourier)) + psi_fourier.c2r(out=psi) + # print("phi_q * psi update_field", np.sum(phi_q * psi)) + + # exit() + + # compute electric field directly from smeared charged densities in Fourier + for _d in np.arange(n_dimensions): + + def poisson_transfer_function(k, v, d=_d): + return ( + -1j + * k[d] + * 4.0 + * np.pi + * elec_conversion_factor + * v + / k.normp(p=2, zeromode=1) + ) + + phi_q_fourier.apply(poisson_transfer_function, out=elec_field_fourier[_d]) + elec_field_fourier[_d].c2r(out=elec_field[_d]) + + # get electrostatic force from electric field + for _d in np.arange(n_dimensions): + elec_forces[:, _d] = charges * ( + elec_field[_d].readout(positions, layout=layout_q) + )
+ + +def comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, +): + for t in range(config.n_types): + np.copyto(phi_transfer[0].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[1].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[2].value, phi_fourier[t].value, casting="no", where=True) + + # Evaluate laplacian of phi in fourier space + for d in range(3): + + def laplacian_transfer(k, v, d=d): + return -k[d] ** 2 * v + + phi_transfer[d].apply(laplacian_transfer, out=Ellipsis) + phi_transfer[d].c2r(out=phi_laplacian[t][d]) + + +
[docs]def update_field( + phi, + phi_laplacian, + phi_transfer, + layouts, + force_mesh, + hamiltonian, + pm, + positions, + types, + config, + v_ext, + phi_fourier, + v_ext_fourier, + m, + compute_potential=False, +): + """Calculate the particle-field potential and force density + + If :code:`compute_potential` is :code:`True`, the energy may subsequently + be computed by calling :code:`compute_field_and_kinetic_energy`. + + Computes the particle-field external potential :math:`V_\\text{ext}` from + particle number densities through the smoothed density field, + :math:`\\phi(\\mathbf{r})`. With :math:`P` being the cloud-in-cell (CIC) + window function, the density and filtered densities are computed as + + .. math:: + + \\phi(\\mathbf{r}) = \\sum_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\phi(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\phi(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + external potential is computed in reciprocal space as + + .. math:: + + V_\\text{ext} = \\mathrm{FFT}^{-1}\\left[ + \\mathrm{FFT} + \\left( + \\frac{\\partial w}{\\partial \\tilde\\phi} + \\right) + \\mathrm{FFT}(H) + \\right], + + where :math:`w` is the interaction energy functional. Differentiating + :math:`V_\\text{ext}` is done by simply applying :math:`i\\mathbf{k}` in + Fourier space, and the resulting forces are back-transformed to direct + space and interpolated to particle positions by + + .. math:: + + \\mathbf{F}_j = -\\sum_{j_k} \\nabla V_{j_k} + P(\\mathbf{r}_{j_k} - \\mathbf{r}_j)h^3, + + where :math:`j_k` are the neighbouring vertices of particle :math:`j` at + position :math:`\\mathbf{r}_j`, and :math:`h^3` is the volume of each grid + voxel. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Pre-allocated, but empty; any values + in this field are discarded. Changed in-place. Local for each MPI + rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + config : Config + Configuration object. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Pre-allocated, but empty; any values in this field are + discarded Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + phi_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computational grid is represented by the collective fields of all + MPI ranks. + v_ext_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplesField` objects containing discretized + particle-field external potential values in reciprocal space on the + computational grid; :code:`D+1` fields in D dimensions for each + particle type. :code:`D` copies are made after calculation for later + use in force calculation, because the `force transfer function` + application differentiates the field in-place, ruining the contents + for differentiation in the remaining :code:`D-1` spatial directions. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + m: list[float], (M,) + pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. + Defaults to 1.0 for all particle types. + compute_potential : bool, optional + If :code:`True`, a :code:`D+1`-th copy of the Fourier transformed + external potential field is made to be used later in particle-field + energy calculation. If :code:`False`, only :code:`D` copies are made. + + See also + -------- + compute_field_and_kinetic_energy : + Compute the particle-field energy after the external potential is + calculated. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + for t in range(config.n_types): + pm.paint(positions[types == t], mass=m[t], layout=layouts[t], out=phi[t]) + phi[t] /= volume_per_cell + phi[t].r2c(out=phi_fourier[t]) + phi_fourier[t].apply(hamiltonian.H, out=Ellipsis) + phi_fourier[t].c2r(out=phi[t]) + + # External potential + for t in range(config.n_types): + v = hamiltonian.v_ext[t](phi) + + v.r2c(out=v_ext_fourier[0]) + v_ext_fourier[0].apply(hamiltonian.H, out=Ellipsis) + np.copyto( + v_ext_fourier[1].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + np.copyto( + v_ext_fourier[2].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + if compute_potential: + np.copyto( + v_ext_fourier[3].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + + # Differentiate the external potential in fourier space + for d in range(3): + + def force_transfer_function(k, v, d=d): + return -k[d] * 1j * v + + v_ext_fourier[d].apply(force_transfer_function, out=Ellipsis) + v_ext_fourier[d].c2r(out=force_mesh[t][d]) + + if compute_potential: + v_ext_fourier[3].c2r(out=v_ext[t])
+ + +
[docs]def compute_field_and_kinetic_energy( + phi, + phi_q, + psi, + velocity, + hamiltonian, + positions, + types, + v_ext, + config, + layouts, + comm=MPI.COMM_WORLD, +): + """Compute the particle-field and kinetic energy contributions + + Calculates the kinetic energy through + + .. math:: + + E_k = \\sum_j \\frac{1}{2}m_j\\mathbf{v}_j\\cdot\\mathbf{v}_j, + + and the particle-field energy by + + .. math:: + + E_\\text{field} = \\int\\mathrm{d}\\mathbf{r}\\, + w[\\tilde\\phi], + + where :math:`w` is the interaction energy functional `density`. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + velocity : (N,D) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Local for each MPI rank--the full computational grid is + represented by the collective fields of all MPI ranks. + config : Config + Configuration object. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field : + Computes the up-to-date external potential for use in calculating the + particle-field energy. + """ + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + field_energy = w_0.csum() # w to W + + kinetic_energy = comm.allreduce(0.5 * config.mass * np.sum(velocity**2)) + + if config.coulombtype == "PIC_Spectral": + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + field_q_energy = w_elec.csum() + else: + field_q_energy = 0.0 + + return field_energy, kinetic_energy, field_q_energy
+ + +
[docs]def compute_field_energy_q_GPE( + config, + phi_eps, + field_q_energy, + dot_elec, + comm=MPI.COMM_WORLD, +): + """ + Compute the electrostatic energy after electrosatic forces is + calculated. + + From the definition of the elecrostatic potential :math:`\\Psi`, the energy + is + + W = \\frac{1}{2}\\int\\mathrm{d}\\mathbf{r}\\, + \\epsilon(\\mathbf{r})} \\left(\\mathbf{E}\\cdot \\mathbf{E}\\right), + + where :math:`\\epsilon(\\mathbf{r})}` is the anisotropic, spatially dependent, + relative dielectric of the simulation medium. + + Parameters + ---------- + config : hymd.input_parser.Config + Configuration object. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + field_q_energy : float + Total elecrostatic energy. + dot_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing :math:`|\\mathbf{E(r)}|^{2}` + on the computational grid. Local for each MPI rank -- the full computational + grid is represented by the collective fields of all MPI ranks. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field_force_q_GPE: + Compute the electrosatic force from an anisotropic dielectric general + Poisson equation. + """ + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + # ^ due to integration on local cell before allreduce + + eps_0 = 1.0 / (config.coulomb_constant * 4 * np.pi) + field_q_energy = ( + volume_per_cell * (0.5 * eps_0) * comm.allreduce(np.sum(phi_eps * dot_elec)) + ) + + return field_q_energy
+ + +
[docs]def update_field_force_q_GPE( + conv_fun, + phi, + types, + charges, + phi_q, + phi_q_fourier, + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol_prev, + phi_pol, + elec_field, + elec_forces, + elec_field_contrib, + psi, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + hamiltonian, + layout_q, + layouts, + pm, + positions, + config, + comm=MPI.COMM_WORLD, +): + """ + Calculate the electrostatic particle-field forces on the grid, arising from + a general Poisson equation, i.e. anisotropic permittivity/dielectric. + The function is called when tomli input config.coulombtype = "PIC_Spectral_GPE." + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential for a variable dielectric does not have an + analytical expression, and is computed in reciprocal through an iterative + method. + + The GPE states that + + .. math:: + + \\nabla \\cdot \\left(\\epsilon(\\mathbf{r}) + \\nabla{\\mathbf{\\psi(r)}}\\right) = -\\rho({\\mathbf{r}}). + + where :math:`\\epsilon(\\mathbf{r})` is the relative dielectric function. + + Parameters + ---------- + conv_fun : Convergence function. + Returns a scalar. Depends on MPI allreduce for similar convergence + across MPI ranks. + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_eta : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + gradients of the relative dielectric values on the computational grid. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank--the + full computational grid is represented by the collective fields of all MPI ranks. + phi_eta_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated discretized + Fourier transformed gradient relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol_prev : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charge values on the computational grid. Parameter in + the iterative method.Pre-allocated,but empty. Changedin-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charges on the computational grid. Parameter in the iterative + method, updating the next quess in solving for the electrostatic potential. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all + MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + elec_field_contrib : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing + :math:`|\\mathbf{E(r)}|^2/\\phi_{0}` on the computational grid. + Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + psi : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic potential + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + Vbar_elec : mesh.pm.RealField + Pmesh :code:`RealField` object for storing functional derivatives of + :math:`\\|w(\\{ \\phi \\})_{elec}`on the computational grid. + Pre-allocated, but empty. Changed in-place. Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + Vbar_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated functional + derivatives of :math:`\\|w(\\{ \\phi \\})_{elec}` in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + force_mesh_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic force values + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + force_mesh_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated electrostatic + force values in reciprocal space on the computational grid. Local for + each MPI rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + layouts: list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + comm: mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + compute_field_energy_q_GPE: + Compute the electrostatic energy after electrosatic force is + calculated for a variable (anisotropic) dielectric general Poisson equation. + """ + + ## basic setup + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + ## old protocol in gen_qe_hpf_use_self + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) ## + ## scale and fft + ## old protocol in gen_qe_hpf_use_self + phi_q /= volume_per_cell + phi_q.r2c(out=phi_q_fourier) + + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + ## ^------ use the same gaussian as the \kai interaciton + phi_q_fourier.c2r(out=phi_q) ## this phi_q is after applying the smearing function + + denom_phi_tot = pm.create("real", value=0.0) + num_types = pm.create("real", value=0.0) + ### ^ ----- Calculate the relative dielectric (permittivity) to field + ### ------- from a mean contribution of particle number densities + + for t_ in range(config.n_types): + num_types = num_types + (config.dielectric_type[t_]) * phi[t_] + denom_phi_tot = denom_phi_tot + phi[t_] + + np.divide(num_types, denom_phi_tot, where=np.abs(denom_phi_tot > 1e-6), out=phi_eps) + + phi_eps.r2c(out=phi_eps_fourier) # FFT dielectric + + # phi_q_eps = (phi_q/phi_eps) + np.divide(phi_q, phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_q) + + _SPACE_DIM = 3 + ##^--------- constants needed throughout the calculations + + ### method for finding the gradient (fourier space), using the spatial dimension of k + for _d in np.arange(_SPACE_DIM): + + def gradient_transfer_function(k, x, d=_d): + return 1j * k[d] * x + + phi_eps_fourier.apply(gradient_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=phi_eta[_d]) + np.divide(phi_eta[_d], phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_eta[_d]) + + ### iterative GPE solver ### + ### ---------------------------------------------- + max_iter = 100 + i = 0 + delta = 1.0 + # phi_pol_prev = pm.create("real", value = 0.0) + ### ^------ set to zero before each iterative procedure or soft start + conv_criteria = config.conv_crit # conv. criteria (default 1e-6) + w = config.pol_mixing # polarization mixing param (default 0.6) + while i < max_iter and delta > conv_criteria: + (phi_q + phi_pol_prev).r2c(out=phi_q_fourier) + for _d in np.arange(_SPACE_DIM): + + def iterate_apply_k_vec(k, additive_terms, d=_d): + return additive_terms * (-1j * k[d]) / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(iterate_apply_k_vec, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + + phi_pol = -( + phi_eta[0] * elec_field[0] + + phi_eta[1] * elec_field[1] + + phi_eta[2] * elec_field[2] + ) + ### ^-- Following a negative sign convention (-ik) of the FT, a neg sign is + ### --- mathematically correct by the definition of the GPE (double - -> +) + phi_pol = w * phi_pol + (1.0 - w) * phi_pol_prev + diff = np.abs(phi_pol - phi_pol_prev) + delta = conv_fun(comm, diff) # decided from toml input + phi_pol_prev = phi_pol.copy() + i = i + 1 + # print("Stopping after iteration {:d} with stop crit {:.2e}, delta {:.2e}".format(i,conv_criteria,delta)) + + # compute_potential = True + def k_norm_divide(k, potential): + return potential / k.normp(p=2, zeromode=1) + + ## > Electrostatic potential + eps0_inv = config.coulomb_constant * 4 * np.pi + ## ^ the 1/(4pi eps0)*4*pi = 1/eps0 + ((eps0_inv) * (phi_q + phi_pol)).r2c(out=phi_q_fourier) + phi_q_fourier.apply(k_norm_divide, out=phi_q_fourier) + phi_q_fourier.c2r(out=psi) + ### ^ electrostatic potential for the GPE + + for _d in np.arange(_SPACE_DIM): + + def field_transfer_function(k, x, d=_d): + return ( + -1j * k[d] * x + ) ## negative sign relation, due to E = - nabla psi relation + + phi_q_fourier.apply(field_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + ## ^-------- Method: Obtaining the electric field from electrostatic potential + ## Assuming the electric field is conserved. + ## Assumption holds if no magnetic flux (magnetic induced fields) + + ############## Obtain forces ############## + elec_dot = ( + elec_field[0] * elec_field[0] + + elec_field[1] * elec_field[1] + + elec_field[2] * elec_field[2] + ) + # needed for energy calculations + + np.divide( + elec_dot, + denom_phi_tot, + where=np.abs(denom_phi_tot > 1e-6), + out=elec_field_contrib, + ) + + eps0_inv = config.coulomb_constant * 4 * np.pi + + for t_ in range(config.n_types): + Vbar_elec[t_] = ( + config.type_charges[t_] * psi + - (0.5 / eps0_inv) + * (config.dielectric_type[t_] - phi_eps) + * elec_field_contrib + ) + + # Obtain Vext,k + for t_ in range(config.n_types): + Vbar_elec[t_].r2c(out=Vbar_elec_fourier[t_]) + Vbar_elec_fourier[t_].apply(hamiltonian.H, out=Vbar_elec_fourier[t_]) + + # force terms + # F = - grad Vext + for t_ in range(config.n_types): + for _d in np.arange(_SPACE_DIM): + + def force_transfer_function(k, x, d=_d): + return -1j * k[_d] * x ## negative gradient + + Vbar_elec_fourier[t_].apply( + force_transfer_function, out=force_mesh_elec_fourier[t_][_d] + ) + force_mesh_elec_fourier[t_][_d].c2r(out=force_mesh_elec[t_][_d]) + elec_forces[types == t_, _d] = force_mesh_elec[t_][_d].readout( + positions[types == t_], layout=layouts[t_] + ) + + return Vbar_elec, phi_eps, elec_dot
+ + +
[docs]def domain_decomposition( + positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=MPI.COMM_WORLD +): + """Performs domain decomposition + + Rearranges the MPI rank memory layout into one that better mimics the PFFT + pencil grid 2D decomposition. As molecules are always required to be fully + contained on a single MPI rank, a perfect decomposition is not always + possible. The best decomposition which leaves the center of mass of all + molecules in their respective correct domains is used, with possible + overlap into neighbouring domains if the spatial extent of any molecule + crosses domain boundaries. + + Parameters + ---------- + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + *args + Variable length argument list containing arrays to include in the + domain decomposition. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + bonds : (N,M) numpy.ndarray, optional + Array of :code:`M` bonds originating from each of :code:`N` particles. + verbose : int, optional + Specify the logging event verbosity of this function. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + Domain decomposed :code:`positions` and any array specified in + :code:`*args`, in addition to :code:`bonds` and :code:`molecules` if these + arrays were provided as input. + """ + if molecules is not None: + if not topol: + assert bonds is not None, "bonds must be provided with molecules" + unique_molecules = np.sort(np.unique(molecules)) + molecules_com = np.empty_like(positions) + for m in unique_molecules: + ind = molecules == m + r = positions[ind, :][0, :] + molecules_com[ind, :] = r + layout = pm.decompose(molecules_com, smoothing=0) + if not topol: + args = (*args, bonds, molecules) + else: + args = (*args, molecules) + else: + layout = pm.decompose(positions, smoothing=0) + if verbose > 1: + Logger.rank0.log( + logging.INFO, + "DOMAIN_DECOMP: Total number of particles to be exchanged = %d", + np.sum(layout.get_exchange_cost()), + ) + return layout.exchange(positions, *args)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/_modules/hymd/file_io.html b/v1.0.4/_modules/hymd/file_io.html new file mode 100644 index 00000000..a80a9add --- /dev/null +++ b/v1.0.4/_modules/hymd/file_io.html @@ -0,0 +1,1147 @@ + + + + + + hymd.file_io — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.file_io

+"""Handle file input/output in parllel HDF5 fashion
+"""
+import numpy as np
+import h5py
+import os
+import logging
+import getpass
+from mpi4py import MPI
+from .logger import Logger, get_version
+
+
+
[docs]class OutDataset: + """HDF5 dataset handler for file output""" + + def __init__( + self, + dest_directory, + config, + double_out=False, + disable_mpio=False, + comm=MPI.COMM_WORLD, + ): + """Constructor + + Parameters + ---------- + dest_directory : str + Ouput directory for saving data. + config : Config + Configuration object. + double_out : bool, optional + If :code:`True`, the output HDF5 objects are written in eight byte + floating point representation. Otherwise, four byte single + precision is used. + disable_mpio : bool, optional + If :code:`True`, disables parallel MPI-enabled HDF5 file output. + This is a compatibility option used if HDF5 is not compiled with + MPI support. This makes everything much harder by splitting all + output in one file per MPI rank, and having an MPI-enabled HDF5 + library is **highly recommended**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + """ + self.disable_mpio = disable_mpio + self.config = config + if double_out: + self.float_dtype = "float64" + else: + self.float_dtype = "float32" + + if disable_mpio: + self.file = h5py.File( + os.path.join( + dest_directory, f"sim.hdf5-{comm.rank:6d}-of-{comm.size:6d}" + ), + "w", + ) + else: + self.file = h5py.File( + os.path.join(dest_directory, "sim.H5"), "w", driver="mpio", comm=comm + ) + +
[docs] def is_open(self, comm=MPI.COMM_WORLD): + """Check if HDF5 output file is open + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + return self.file.__bool__()
+ +
[docs] def close_file(self, comm=MPI.COMM_WORLD): + """Closes the HDF5 output file + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + self.file.close()
+ +
[docs] def flush(self): + """Flushes output buffers, forcing file writes""" + self.file.flush()
+ + +
[docs]def setup_time_dependent_element( + name, parent_group, n_frames, shape, dtype, units=None +): + """Helper function for setting up time-dependent HDF5 group datasets + + All output groups must adhere to the H5MD standard, meaning a structure of + + + | ┗━ **group** particle group (e.g. :code:`all`) or :code:`observables` group + | ┗━ **group** time-dependent data + | ┣━ **dataset** :code:`step` :code:`shape=(n_frames,)` + | ┣━ **dataset** :code:`time` :code:`shape=(n_frames,)` + | ┗━ **dataset** :code:`value` :code:`shape=(n_frames, *)` + + is necessary. + + References + ---------- + H5MD specification : + https://www.nongnu.org/h5md/h5md.html + """ # noqa: E501 + group = parent_group.create_group(name) + step = group.create_dataset("step", (n_frames,), "int32") + time = group.create_dataset("time", (n_frames,), "float32") + value = group.create_dataset("value", (n_frames, *shape), dtype) + + if units is not None: + value.attrs["unit"] = units + time.attrs["unit"] = "ps" + return group, step, time, value
+ + +
[docs]def store_static( + h5md, + rank_range, + names, + types, + indices, + config, + bonds_2_atom1, + bonds_2_atom2, + molecules=None, + velocity_out=False, + force_out=False, + charges=False, + dielectrics=False, + plumed_out=False, + comm=MPI.COMM_WORLD, +): + """Outputs all static time-independent quantities to the HDF5 output file + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + rank_range : list[int] + Start and end indices for global arrays for each MPI rank. + names : (N,) numpy.ndarray + Array of names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of type indices for :code:`N` particles. + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + config : Config + Configuration object. + bonds_2_atom1 : (B,) numpy.ndarray + Array of indices of the first particle for :code:`B` total + two-particle bonds. + bonds_2_atom2 : (B,) numpy.ndarray + Array of indices of the second particle for :code:`B` total + two-particle bonds. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. + dielectrics : (N,) numpy.ndarray + Array of particle relative dielectric values for :code:`N` particles. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to output HDF5 file. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + prepare_bonds : + Constructs two-, three-, and four-particle bonds from toplogy input + file and bond configuration information. + distribute_input : + Distributes input arrays onto MPI ranks, attempting load balancing. + """ + dtype = h5md.float_dtype + + h5md_group = h5md.file.create_group("/h5md") + h5md.h5md_group = h5md_group + h5md.observables = h5md.file.create_group("/observables") + h5md.connectivity = h5md.file.create_group("/connectivity") + h5md.parameters = h5md.file.create_group("/parameters") + + h5md_group.attrs["version"] = np.array([1, 1], dtype=int) + author_group = h5md_group.create_group("author") + author_group.attrs["name"] = np.string_(getpass.getuser()) + creator_group = h5md_group.create_group("creator") + creator_group.attrs["name"] = np.string_("Hylleraas MD") + + # Get HyMD version + creator_group.attrs["version"] = np.string_(get_version()) + + h5md.particles_group = h5md.file.create_group("/particles") + h5md.all_particles = h5md.particles_group.create_group("all") + mass = h5md.all_particles.create_dataset("mass", (config.n_particles,), dtype) + mass[...] = config.mass + + if charges is not False: + charge = h5md.all_particles.create_dataset( + "charge", (config.n_particles,), dtype="float32" + ) + charge[indices] = charges + if dielectrics is not False: + dielectric = h5md.all_particles.create_dataset( + "dielectric", (config.n_particles,), dtype="float32" + ) + dielectric[indices] = dielectrics + + box = h5md.all_particles.create_group("box") + box.attrs["dimension"] = 3 + box.attrs["boundary"] = np.array( + [np.string_(s) for s in 3 * ["periodic"]], dtype="S8" + ) + + n_frames = config.n_steps // config.n_print + if np.mod(config.n_steps - 1, config.n_print) != 0: + n_frames += 1 + if np.mod(config.n_steps, config.n_print) == 1: + n_frames += 1 + if n_frames == config.n_steps: + n_frames += 1 + + species = h5md.all_particles.create_dataset( + "species", + (config.n_particles,), + dtype="i", + ) + + ( + _, + h5md.positions_step, + h5md.positions_time, + h5md.positions, + ) = setup_time_dependent_element( + "position", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm", + ) + if velocity_out: + ( + _, + h5md.velocities_step, + h5md.velocities_time, + h5md.velocities, + ) = setup_time_dependent_element( + "velocity", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm ps-1", + ) + if force_out: + ( + _, + h5md.forces_step, + h5md.forces_time, + h5md.forces, + ) = setup_time_dependent_element( + "force", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="kJ mol-1 nm-1", + ) + ( + _, + h5md.total_energy_step, + h5md.total_energy_time, + h5md.total_energy, + ) = setup_time_dependent_element( + "total_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.kinetc_energy_step, + h5md.kinetc_energy_time, + h5md.kinetc_energy, + ) = setup_time_dependent_element( + "kinetic_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.potential_energy_step, + h5md.potential_energy_time, + h5md.potential_energy, + ) = setup_time_dependent_element( + "potential_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.bond_energy_step, + h5md.bond_energy_time, + h5md.bond_energy, + ) = setup_time_dependent_element( + "bond_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.angle_energy_step, + h5md.angle_energy_time, + h5md.angle_energy, + ) = setup_time_dependent_element( + "angle_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.dihedral_energy_step, + h5md.dihedral_energy_time, + h5md.dihedral_energy, + ) = setup_time_dependent_element( + "dihedral_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.field_energy_step, + h5md.field_energy_time, + h5md.field_energy, + ) = setup_time_dependent_element( + "field_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + if charges is not False: + ( + _, + h5md.field_q_energy_step, + h5md.field_q_energy_time, + h5md.field_q_energy, + ) = setup_time_dependent_element( + "field_q_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) # <-------- xinmeng + if plumed_out is not False: + ( + _, + h5md.plumed_bias_step, + h5md.plumed_bias_time, + h5md.plumed_bias, + ) = setup_time_dependent_element( + "plumed_bias", h5md.observables, n_frames, (1,), dtype, units="kJ mol-1" # noqa: E501 + ) + ( + _, + h5md.total_momentum_step, + h5md.total_momentum_time, + h5md.total_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "total_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm g ps-1 mol-1", + ) + ( + _, + h5md.angular_momentum_step, + h5md.angular_momentum_time, + h5md.angular_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "angular_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm+2 g ps-1 mol-1", + ) + ( + _, + h5md.torque_step, + h5md.torque_time, + h5md.torque, + ) = setup_time_dependent_element( # noqa: E501 + "torque", + h5md.observables, + n_frames, + (3,), + dtype, + units="kJ nm+2 mol-1", + ) + ( + _, + h5md.temperature_step, + h5md.temperature_time, + h5md.temperature, + ) = setup_time_dependent_element( + "temperature", h5md.observables, n_frames, (3,), dtype, units="K" + ) + ( + _, + h5md.thermostat_work_step, + h5md.thermostat_work_time, + h5md.thermostat_work, + ) = setup_time_dependent_element( + "thermostat_work", + h5md.observables, + n_frames, + (1,), + "float32", + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.pressure_step, + h5md.pressure_time, + h5md.pressure, + ) = setup_time_dependent_element( + "pressure", h5md.observables, n_frames, (18,), "float32", units="Bar" + ) + (_, h5md.box_step, h5md.box_time, h5md.box_value,) = setup_time_dependent_element( + "edges", box, n_frames, (3, 3), "float32", units="nm" + ) + + ind_sort = np.argsort(indices) + for i in ind_sort: + species[indices[i]] = config.name_to_type_map[names[i].decode("utf-8")] + + h5md.parameters.attrs["config.toml"] = np.string_(str(config)) + vmd_group = h5md.parameters.create_group("vmd_structure") + index_of_species = vmd_group.create_dataset( + "indexOfSpecies", (config.n_types,), "i" + ) + index_of_species[:] = np.array(list(range(config.n_types))) + + # VMD-h5mdplugin maximum name/type name length is 16 characters (for + # whatever reason [VMD internals?]). + name_dataset = vmd_group.create_dataset("name", (config.n_types,), "S16") + type_dataset = vmd_group.create_dataset("type", (config.n_types,), "S16") + if molecules is not None: + resid_dataset = vmd_group.create_dataset( + "resid", + (config.n_particles,), + "i", + ) + + # Change this + for i, n in config.type_to_name_map.items(): + name_dataset[i] = np.string_(n[:16]) + if n == "W": + type_dataset[i] = np.string_("solvent") + else: + type_dataset[i] = np.string_("membrane") + + total_bonds = comm.allreduce(len(bonds_2_atom1), MPI.SUM) + n_bonds_local = len(bonds_2_atom1) + + receive_buffer = comm.gather(n_bonds_local, root=0) + n_bonds_global = None + if comm.Get_rank() == 0: + n_bonds_global = receive_buffer + n_bonds_global = np.array(comm.bcast(n_bonds_global, root=0)) + rank_bond_start = np.sum(n_bonds_global[: comm.Get_rank()]) + + bonds_from = vmd_group.create_dataset("bond_from", (total_bonds,), "i") + bonds_to = vmd_group.create_dataset("bond_to", (total_bonds,), "i") + for i in range(n_bonds_local): + a = bonds_2_atom1[i] + b = bonds_2_atom2[i] + bonds_from[rank_bond_start + i] = indices[a] + 1 + bonds_to[rank_bond_start + i] = indices[b] + 1 + + if molecules is not None: + resid_dataset[indices[ind_sort]] = molecules
+ + +# store data old vs +""" +h5md, step, frame, indices, positions, velocities, forces, box_size, +temperature, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, +field_energy, field_q_energy, time_step, config, velocity_out=False, +force_out=False, charge_out=False, dump_per_particle=False, +""" + + +
[docs]def store_data( + h5md, + step, + frame, + indices, + positions, + velocities, + forces, + box_size, + temperature, + pressure, + kinetic_energy, + bond2_energy, + bond3_energy, + bond4_energy, + field_energy, + field_q_energy, + plumed_bias, + time_step, + config, + velocity_out=False, + force_out=False, + charge_out=False, + plumed_out=False, + dump_per_particle=False, + comm=MPI.COMM_WORLD, +): + """Writes time-step data to HDF5 output file + + Handles all quantities which change during simulation, as opposed to + static quanitities (see :code:`store_static`). + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + step : int + Step number. + frame : int + Output frame number (:code:`step // n_print`). + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + positions : (N,) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + velocities : (N,) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + forces : (N,) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. + box_size : (D,) numpy.ndarray + Array containing the simulation box size. + temperature : float + Calculated instantaneous temperature. + kinetic_energy : float + Calculated instantaneous kinetic energy. + bond2_energy : float + Calculated instantaneous harmonic two-particle bond energy. + bond3_energy : float + Calculated instantaneous harmonic angular three-particle bond energy. + bond4_energy : float + Calculated instantaneous dihedral four-particle torsion energy. + field_energy : float + Calculated instantaneous particle-field energy. + field_q_energy : float + Calculated instantaneous electrostatic energy. + plumed_bias : float + PLUMED instantaneous bias energy. + time_step : float + Value of the time step. + config : Config + Configuration object. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charge_out : bool, optional + If :code:`True`, electrostatic energies are written to the output + HDF5 file. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to the output HDF5 file. + dump_per_particle : bool, optional + If :code:`True`, all quantities are written **per particle**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + store_static : + Outputs all static time-independent quantities to the HDF5 output file + """ + for dset in ( + h5md.positions_step, + h5md.total_energy_step, + h5md.potential_energy_step, + h5md.kinetc_energy_step, + h5md.bond_energy_step, + h5md.angle_energy_step, + h5md.dihedral_energy_step, + h5md.field_energy_step, + h5md.total_momentum_step, + h5md.angular_momentum_step, + h5md.torque_step, + h5md.temperature_step, + h5md.pressure_step, + h5md.box_step, + h5md.thermostat_work_step, + ): + dset[frame] = step + + for dset in ( + h5md.positions_time, + h5md.total_energy_time, + h5md.potential_energy_time, + h5md.kinetc_energy_time, + h5md.bond_energy_time, + h5md.angle_energy_time, + h5md.dihedral_energy_time, + h5md.field_energy_time, + h5md.total_momentum_time, + h5md.angular_momentum_time, + h5md.torque_time, + h5md.temperature_time, + h5md.pressure_time, + h5md.box_time, + h5md.thermostat_work_time, + ): + dset[frame] = step * time_step + + if velocity_out: + h5md.velocities_step[frame] = step + h5md.velocities_time[frame] = step * time_step + if force_out: + h5md.forces_step[frame] = step + h5md.forces_time[frame] = step * time_step + if charge_out: + h5md.field_q_energy_step[frame] = step + h5md.field_q_energy_time[frame] = step * time_step + if plumed_out: + h5md.plumed_bias_step[frame] = step + h5md.plumed_bias_time[frame] = step * time_step + + ind_sort = np.argsort(indices) + h5md.positions[frame, indices[ind_sort]] = positions[ind_sort] + + if velocity_out: + h5md.velocities[frame, indices[ind_sort]] = velocities[ind_sort] + if force_out: + h5md.forces[frame, indices[ind_sort]] = forces[ind_sort] + if charge_out: + h5md.field_q_energy[frame] = field_q_energy + if plumed_out: + h5md.plumed_bias[frame] = plumed_bias + + potential_energy = ( + bond2_energy + bond3_energy + bond4_energy + field_energy + field_q_energy + ) + + total_momentum = config.mass * comm.allreduce(np.sum(velocities, axis=0), MPI.SUM) + angular_momentum = config.mass * comm.allreduce( + np.sum(np.cross(positions, velocities), axis=0), MPI.SUM + ) + torque = config.mass * comm.allreduce( + np.sum(np.cross(positions, forces), axis=0), MPI.SUM + ) + h5md.total_energy[frame] = kinetic_energy + potential_energy + h5md.potential_energy[frame] = potential_energy + h5md.kinetc_energy[frame] = kinetic_energy + h5md.bond_energy[frame] = bond2_energy + h5md.angle_energy[frame] = bond3_energy + h5md.dihedral_energy[frame] = bond4_energy + h5md.field_energy[frame] = field_energy + h5md.total_momentum[frame, :] = total_momentum + h5md.angular_momentum[frame, :] = angular_momentum + h5md.torque[frame, :] = torque + h5md.temperature[frame] = temperature + h5md.pressure[frame] = pressure + for d in range(3): + h5md.box_value[frame, d, d] = box_size[d] + h5md.thermostat_work[frame] = config.thermostat_work + + fmt_ = [ + "step", + "time", + "temp", + "tot E", + "kin E", + "pot E", + "field E", + "elec E", + "bond E", + "ang E", + "dih E", + "bias E", + "Px", + "Py", + "Pz", + "ΔH" if config.target_temperature else "ΔE", + ] + fmt_ = np.array(fmt_) + + # create mask to show only energies != 0 + en_array = np.array([ + field_energy, + field_q_energy, + bond2_energy, + bond3_energy, + bond4_energy, + plumed_bias, + ]) + mask = np.full_like(fmt_, True, dtype=bool) + mask[range(6,12)] = en_array != 0. + + header_ = fmt_[mask].shape[0] * "{:>13}" + if config.initial_energy is None: + fmt_[-1] = "" + + divide_by = 1.0 + if dump_per_particle: + for i in range(3, 9): + fmt_[i] = fmt_[i][:-2] + "E/N" + fmt_[-1] += "/N" + divide_by = config.n_particles + total_energy = kinetic_energy + potential_energy + if config.initial_energy is not None: + if config.target_temperature: + H_tilde = total_energy - config.initial_energy - config.thermostat_work + else: + H_tilde = total_energy - config.initial_energy + else: + H_tilde = 0.0 + + header = header_.format(*fmt_[mask]) + data_fmt = f'{"{:13}"}{(fmt_[mask].shape[0]-1) * "{:13.5g}" }' + all_data = [ + step, + time_step * step, + temperature, + total_energy / divide_by, + kinetic_energy / divide_by, + potential_energy / divide_by, + field_energy / divide_by, + field_q_energy / divide_by, + bond2_energy / divide_by, + bond3_energy / divide_by, + bond4_energy / divide_by, + plumed_bias / divide_by, + total_momentum[0] / divide_by, + total_momentum[1] / divide_by, + total_momentum[2] / divide_by, + H_tilde / divide_by, + ] + data = data_fmt.format(*[val for i, val in enumerate(all_data) if mask[i]]) + Logger.rank0.log(logging.INFO, ("\n" + header + "\n" + data))
+ + +
[docs]def distribute_input( + in_file, rank, size, n_particles, max_molecule_size=201, comm=MPI.COMM_WORLD +): + """Assign global arrays onto MPI ranks, attempting load balancing + + Distributes approximately equal numbers of particles (workload) onto each + independent MPI rank, while respecting the requirement that any molecule + must be fully contained on a single MPI rank only (no splitting molecules + across multiple CPUs). + + Parameters + ---------- + in_file : h5py.File + HDF5 input file object. + rank : int + Local rank number for this MPI rank. + size : int + Global size of the MPI communicator (number of total CPUs). + n_particles : int + Total number of particles. + max_molecule_size : int, optional + Maximum size of any molecule present in the system. Used to initially + guess where the MPI rank boundaries (start/end indices) in the global + arrays should be placed. If molecules of size + :code:`>max_molecule_size` exist in the simulation system, HyMD + **might** work as expected. Or it might fail spectacularly. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + rank_range : + Starting and ending indices in the global arrays for each MPI rank. + """ + if n_particles is None: + n_particles = len(in_file["indices"]) + np_per_MPI = n_particles // size + + molecules_flag = False + if "molecules" in in_file: + molecules_flag = True + + if not molecules_flag: + if rank == size - 1: + np_cum_mpi = [rank * np_per_MPI, n_particles] + else: + np_cum_mpi = [rank * np_per_MPI, (rank + 1) * np_per_MPI] + p_mpi_range = list(range(np_cum_mpi[0], np_cum_mpi[1])) + return p_mpi_range, molecules_flag + + # To avoid splitting molecules across multiple different ranks, we need + # to read in some extra indices before/after the expected break points + # and iterate until we find a molecule break. + # + # Implicitly assuming no molecule is bigger than + # min(max_molecule_size, n_particles // n_MPI_ranks) atoms. + max_molecule_size += 2 + grab_extra = max_molecule_size if np_per_MPI > max_molecule_size else np_per_MPI + if rank == 0: + mpi_range_start = 0 + if size == 1: + mpi_range_end = n_particles + else: + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + elif rank == size - 1: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = n_particles + else: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + + molecules = in_file["molecules"][mpi_range_start:mpi_range_end] + indices = in_file["indices"][mpi_range_start:mpi_range_end] + molecule_end_indices = np.nonzero(np.diff(molecules))[0] + + p_mpi_range = [None, None] + if rank == 0: + p_mpi_range[0] = 0 + if size == 1: + p_mpi_range[1] = n_particles + else: + p_mpi_range[1] = indices[ + molecule_end_indices[molecule_end_indices >= np_per_MPI][0] + 1 + ] + elif rank == size - 1: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = n_particles + else: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = ( + indices[molecule_end_indices[molecule_end_indices > np_per_MPI][0]] + + 1 # noqa: E501 + ) + return list(range(p_mpi_range[0], p_mpi_range[1])), molecules_flag
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/_modules/hymd/force.html b/v1.0.4/_modules/hymd/force.html new file mode 100644 index 00000000..d85a1059 --- /dev/null +++ b/v1.0.4/_modules/hymd/force.html @@ -0,0 +1,1150 @@ + + + + + + hymd.force — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.force

+"""Calculates intramolecular forces between bonded particles in molecules
+"""
+import numpy as np
+import networkx as nx
+from dataclasses import dataclass
+
+# Imported here so we can call from force import compute_bond_forces__fortran
+from force_kernels import cbf as compute_bond_forces__fortran  # noqa: F401
+from force_kernels import (  # noqa: F401
+    caf as compute_angle_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cdf as compute_dihedral_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cbf_d as compute_bond_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    caf_d as compute_angle_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    cdf_d as compute_dihedral_forces__fortran__double,
+)
+
+
+
[docs]@dataclass # might not be needed +class Dielectric_type: + atom_1: str + dielectric_value: float
+ + +
[docs]@dataclass +class Bond: + """Dataclass representing a single two-particle bond type + + A `bond type` is a bond strength and equilibrium distance associated with + any bond between particles of specific types :code:`A` and :code:`B` + (where :code:`A` and :code:`B` may be the same or different). Harmonic + two-particle bonds in HyMD take the form + + .. math:: + + V_2(\\mathbf{r}_1, \\mathbf{r}_2) = + \\frac{1}{2}k + \\left( + \\vert \\mathbf{r}_1 - \\mathbf{r}_2 \\vert - r_0 + \\right)^2, + + where :math:`k` is the bond strength (spring constant) and :math:`r_0` is + the equilibrium bond length (at which the energy is zero). + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + equilibrium : float + Equilibrium distance at which the energy associated with the bond + vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient (spring constant). + """ + + atom_1: str + atom_2: str + equilibrium: float + strength: float
+ + +
[docs]@dataclass +class Angle(Bond): + """Dataclass representing a single three-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any three-particle bond between particles of specific types :code:`A`, + :code:`B`, and :code:`C` (where :code:`A`, :code:`B`, and :code:`C` may be + different or the same). Harmonic angular three-particle bonds in HyMD take + the form + + .. math:: + + V_3(\\mathbf{r}_1, \\mathbf{r}_2, \\mathbf{r}_3) = + \\frac{1}{2}k + \\left( + \\cos^{-1} + \\left[ + \\frac{ + (\\mathbf{r}_1-\\mathbf{r}_2) + \\cdot + (\\mathbf{r}_3-\\mathbf{r}_2) + } + { + \\vert\\mathbf{r}_1-\\mathbf{r}_2\\vert + \\vert\\mathbf{r}_3-\\mathbf{r}_2\\vert + } + \\right] - \\theta_0 + \\right)^2 + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + equilibrium : float + Equilibrium angle at which the energy associated with the + three-particle angular bond vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient. + + See also + -------- + Bond : + Two-particle bond type dataclass + """ + + atom_3: str
+ + +
[docs]@dataclass +class Dihedral: + """Dataclass representing a single four-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any four-particle torsional bond between particles of specific types + :code:`A`, :code:`B`, :code:`C`, and :code:`D` (where :code:`A`, :code:`B`, + :code:`C`, and :code:`D` may be different or the same). Dihedral + four-particle bonds in HyMD take different forms depending on the + :code:`dih_type` parameter. + + In the following, let :math:`\\phi` denote the angle between the planes + spanned by the relative positions of atoms :code:`A`-:code:`B`-:code:`C` + and :code:`B`-:code:`C`-:code:`D`. If :code:`dih_type = 0`, then + + .. math:: + + V_4(\\phi) = \\sum_n c_n + \\left( + 1 + \\cos\\left[ + n\\phi - d_n + \\right] + \\right), + + where :math:`c_n` are energy coefficients and :math:`d_n` are propensity + phases. By default, the cosine sum is truncated at five terms. If + :code:`coeffs` provides only a single float, this is used as the coiling + propensity parameter :math:`\\lambda`. In this case, :math:`c_n` and + :math:`d_n` are automatically set to values which promote alpha helical + (:math:`\\lambda=-1`), beta sheet (:math:`\\lambda=1`), or a mixed + (:math:`1>\\lambda>-1`) structure (using values provided by Bore et al. + (2018)). In this case, the full potential takes the form + + .. math:: + + V_4(\\phi;\\lambda) = + \\frac{1}{2}(1-\\lambda) V_{\\text{prop},\\alpha}(\\phi) + + + \\frac{1}{2}(1+\\lambda) V_{\\text{prop},\\beta}(\\phi) + + + (1-\\vert\\lambda\\vert) V_{\\text{prop}, \\text{coil}}(\\phi), + + with each of the :math:`V_{\\mathrm{prop}, X}` being fixed cosine series + potentials with pre-set :math:`c_n` -s and :math:`d_n` -s. + + If :code:`dih_type = 1`, then a combined bending torsional (CBT) potential + is employed, + + .. math:: + + V_4(\\phi,\\gamma;\\lambda) = + V_4(\\phi;\\lambda) + + + \\frac{1}{2}K(\\phi)(\\gamma - \\gamma_0)^2, + + where :math:`V_4(\\phi;\\lambda)` specifies the potential as given by the + coiling propensity parameter above, :math:`K(\\phi)` is a separate cosine + series potential acting as the angular three-particle bond strength, and + :math:`\\gamma_0` is the three-particle bond equilibrium angle. In this + case, the :code:`coeffs` parameter must specify *both* a :math:`\\lambda` + value, in additon to the energy and phases dictating the :math:`K(\\phi)` + potential. + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + atom_4 : str + Type name of particle 4. + coeffs : list[list[float]] or list[float] or numpy.ndarray + Dihedral coefficients defining the series expansion of the dihedral + energy. + dih_type : int + Specifies the type of dihedral used; If :code:`0`, then :code:`coeffs` + must contain **either** two lists of five energy coefficients + :math:`c_n` and five propensity phases :math:`d_n` **or** a single + floating point number defining the :math:`\\lambda` coiling propensity + parameter. If :code:`1`, the combined bending-torsional potential is + used, and :code:`coeffs` must specify :math:`\\lambda` *and* two lists + containing energy coefficients and propensity phases for the + :math:`V_\\text{prop}` propensity potential, defined in terms of cosine + series. + + References + ---------- + Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018. + """ + + atom_1: str + atom_2: str + atom_3: str + atom_4: str + coeffs: np.ndarray + dih_type: int
+ + +
[docs]@dataclass +class Chi: + """Dataclass representing a single :math:`\\chi` mixing interaction type + + An `interaction mixing energy type` is a mixing energy associated with + density overlap between species of types :code:`A` and :code:`B` + (specified as inputs :code:`atom_1` and :code:`atom_2`). A positive mixing + energy promotes phase separation, a negative mixing energy promotes mixing. + The interaction energy density (provided the :code:`DefaultWithChi` + Hamiltonian is used) takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} + \\sum_{k,l}\\chi_{k,l} \\tilde\\phi_k\\tilde\\phi_l, + + where :math:`\\chi_{k,l}` denotes the mixing energy between species + :math:`k` and :math:`l`, with :math:`\\kappa` being the incompressibility. + The value of the interaction mixing energy parameter may be extracted from + `Flory-Huggins theory`_. + + .. _`Flory-Huggins theory`: + https://en.wikipedia.org/wiki/Flory%E2%80%93Huggins_solution_theory + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + interaction_energy : float + Interaction mixing energy. + + See also + -------- + hymd.hamiltonian.DefaultWithChi : + Interaction energy functional using :math:`\\chi`-interactions. + """ + + atom_1: str + atom_2: str + interaction_energy: float
+ + +
[docs]def find_all_paths(G, u, n): + """Helper function that recursively finds all paths of given lenght 'n + 1' inside a network 'G'. + Adapted from https://stackoverflow.com/a/28103735.""" + if n == 0: + return [[u]] + paths = [] + for neighbor in G.neighbors(u): + for path in find_all_paths(G, neighbor, n - 1): + if u not in path: + paths.append([u] + path) + return paths
+ + +
[docs]def propensity_potential_coeffs(x: float): + alpha_coeffs = np.array( + [ + [7.406, -5.298, -2.570, 1.336, 0.739], + [-0.28632126, 1.2099146, 1.18122138, 0.49075168, 0.98495911], + ] + ) + beta_coeffs = np.array( + [ + [3.770, 5.929, -4.151, -0.846, 0.190], + [-0.2300693, -0.0583289, 0.99342396, 1.03237971, 2.90160988], + ] + ) + coil_coeffs = np.array( + [ + [1.416, -0.739, 0.990, -0.397, 0.136], + [1.3495933, 0.45649087, 2.30441057, -0.12274901, -0.26179939], + ] + ) + + zero_add = np.zeros((2, 5)) + if np.isclose(x, -1): + return np.concatenate((alpha_coeffs, zero_add)) + elif np.isclose(x, 0): + return np.concatenate((coil_coeffs, zero_add)) + elif np.isclose(x, 1): + return np.concatenate((beta_coeffs, zero_add)) + + abs_x = np.abs(x) + if abs_x > 1: + err_str = ( + f"The provided value of lambda = {x} is out of lambda definition range, " + f"[-1.0, 1.0]." + ) + Logger.rank0.log(logging.ERROR, err_str) + else: + coil_coeffs[0] *= 1 - abs_x + if x < 0: + alpha_coeffs[0] *= 0.5 * (abs_x - x) + return np.concatenate((alpha_coeffs, coil_coeffs)) + else: + beta_coeffs[0] *= 0.5 * (abs_x + x) + return np.concatenate((beta_coeffs, coil_coeffs))
+ + +
[docs]def prepare_bonds_old(molecules, names, bonds, indices, config): + """Find bonded interactions from connectivity and bond types information + + .. deprecated:: 1.0.0 + :code:`prepare_bonds_old` was replaced by :code:`prepare_bonds` for + use with compiled Fortran kernels prior to 1.0.0 release. + + Prepares the necessary equilibrium and bond strength information needed by + the intramolecular interaction functions. This is performed locally on each + MPI rank, as the domain decomposition ensures that for all molecules *all* + consituent particles are always contained on *the same* MPI rankself. + + This function traverses the bond connectivity information provided in the + structure/topology input file and indentifies any two-, three-, or + four-particle potential bonds. For each connected chain of two, three, or + four particles, a matching to bond types is attempted. If the corresponding + names match, a bond object is initialized. + + In order to investigate the connectivity, a graph is created using + networkx functionality. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2 : list + List of lists containing *local* particle indices, equilibrium + distance, and bond strength coefficient for each reconstructed + two-particle bond. + bonds_3 : + List of lists containing *local* particle indices, equilibrium angle, + and bond strength coefficient for each reconstructed three-particle + bond. + bonds_4 : + List of lists containing *local* particle indices, dihedral type index, + and dihedral coefficients for each reconstructed four-particle + torsional bond. + bb_index : list + List indicating the dihedral type of each four-particle bond in + :code:`bonds_4`. + + See also + -------- + Bond : + Two-particle bond type dataclass. + Angle : + Three-particle angular bond type dataclass. + Dihedral : + Four-particle torsional bond type dataclass. + hymd.input_parser.Config + Configuration dataclass handler. + """ + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + bb_index = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + bb_dihedral = 0 + bond_graph = nx.Graph() + + for local_index, global_index in enumerate(indices): + if molecules[local_index] != mol: + continue + + bond_graph.add_node( + global_index, + name=names[local_index].decode("UTF-8"), + local_index=local_index, + ) + for bond in [b for b in bonds[local_index] if b != -1]: + bond_graph.add_edge(global_index, bond) + + connectivity = nx.all_pairs_shortest_path(bond_graph) + for c in connectivity: + i = c[0] + connected = c[1] + for j, path in connected.items(): + if len(path) == 2 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for b in config.bonds: + match_forward = name_i == b.atom_1 and name_j == b.atom_2 + match_backward = name_i == b.atom_2 and name_j == b.atom_1 + if match_forward or match_backward: + bonds_2.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[j]["local_index"], + b.equilibrium, + b.strength, + ] + ) + + if len(path) == 3 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_mid = bond_graph.nodes()[path[1]]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for a in config.angle_bonds: + match_forward = ( + name_i == a.atom_1 + and name_mid == a.atom_2 + and name_j == a.atom_3 + ) + match_backward = ( + name_i == a.atom_3 + and name_mid == a.atom_2 + and name_j == a.atom_1 + ) + if match_forward or match_backward: + bonds_3.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[path[1]]["local_index"], + bond_graph.nodes()[j]["local_index"], + np.radians(a.equilibrium), + a.strength, + ] + ) + + all_paths_len_four = find_all_paths(bond_graph, i, 3) + for p in all_paths_len_four: + name_i = bond_graph.nodes()[i]["name"] + name_mid_1 = bond_graph.nodes()[p[1]]["name"] + name_mid_2 = bond_graph.nodes()[p[2]]["name"] + name_j = bond_graph.nodes()[p[3]]["name"] + + for a in config.dihedrals: + match_forward = ( + name_i == a.atom_1 + and name_mid_1 == a.atom_2 + and name_mid_2 == a.atom_3 + and name_j == a.atom_4 + ) + if ( + match_forward + and [ + bond_graph.nodes()[p[3]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[i]["local_index"], + a.coeffs, + a.dih_type, + ] + not in bonds_4 + ): + bonds_4.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[3]]["local_index"], + a.coeffs, + a.dih_type, + ] + ) + if a.dih_type == 1: + bb_dihedral = len(bonds_4) + + if bb_dihedral: + bb_index.append(bb_dihedral - 1) + + return bonds_2, bonds_3, bonds_4, bb_index
+ + +
[docs]def prepare_index_based_bonds(molecules, topol): + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + resid = mol + 1 + top_summary = topol["system"]["molecules"] + resname = None + test_mol_number = 0 + for molname in top_summary: + test_mol_number += molname[1] + if resid <= test_mol_number: + resname = molname[0] + break + + if resname is None: + break + + if "bonds" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for bond in topol[resname]["bonds"]: + index_i = bond[0] - 1 + first_id + index_j = bond[1] - 1 + first_id + # bond[2] is the bond type, inherited by the itp format. Not used + equilibrium = bond[3] + strength = bond[4] + bonds_2.append([index_i, index_j, equilibrium, strength]) + + if "angles" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["angles"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + # angle[3] is the angle type, inherited by the itp format. Not used + equilibrium = np.radians(angle[4]) + strength = angle[5] + bonds_3.append([index_i, index_j, index_k, equilibrium, strength]) + + if "dihedrals" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["dihedrals"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + index_l = angle[3] - 1 + first_id + dih_type = angle[4] + coeff = angle[5] + if dih_type == 0 and isinstance(coeff[0], (float, int)): + coeff = propensity_potential_coeffs(coeff[0]) + elif dih_type == 1 and len(coeff) == 3: + coeff = np.array( + propensity_potential_coeffs(coeff[0][0]).tolist() + + coeff[1:] + ) + elif dih_type == 2: + coeff = np.array(coeff) + else: + coeff = np.insert(np.array(coeff), 2, np.zeros((2, 5)), axis=0) + bonds_4.append([index_i, index_j, index_k, index_l, coeff, dih_type, 0]) + return bonds_2, bonds_3, bonds_4
+ + +
[docs]def prepare_bonds(molecules, names, bonds, indices, config, topol=None): + """Rearrange the bond information for usage in compiled Fortran kernels + + Restructures the lists resulting from the execution of + :code:`prepare_bonds_old` into numpy arrays suitable for calls to optimized + Fortran code calculating bonded forces and energiesself. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2_atom_1 : (B,) numpy.ndarray + Local index of particle 1 for each of :code:`B` constructed + two-particle bonds. + bonds_2_atom_2 : (B,) numpy.ndarray + Local index of particle 2 for each of :code:`B` constructed + two-particle bonds. + bonds_2_equilibrium : (B,) numpy.ndarray + Equilibrium distance for each of :code:`B` constructed two-particle + bonds. + bonds_2_strength : (B,) numpy.ndarray + Bond strength for each of :code:`B` constructed two-particle + bonds. + bonds_3_atom_1 : (A,) numpy.ndarray + Local index of particle 1 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_2 : (A,) numpy.ndarray + Local index of particle 2 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_3 : (A,) numpy.ndarray + Local index of particle 3 for each of :code:`A` constructed + three-particle bonds. + bonds_3_equilibrium : (A,) numpy.ndarray + Equilibrium angle for each of :code:`A` constructed three-particle + bonds. + bonds_3_strength : (A,) numpy.ndarray + Bond strength for each of :code:`A` constructed three-particle + bonds. + bonds_4_atom_1 : (D,) numpy.ndarray + Local index of particle 1 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_2 : (D,) numpy.ndarray + Local index of particle 2 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_3 : (D,) numpy.ndarray + Local index of particle 3 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_4 : (D,) numpy.ndarray + Local index of particle 4 for each of :code:`D` constructed + four-particle bonds. + bonds_4_coeff : (D,) numpy.ndarray + Cosine series coefficients for each of :code:`D` constructed + four-particle bonds. + bonds_4_type : (D,) numpy.ndarray + Dihedral type for each of :code:`D` constructed four-particle + bonds. + bonds_4_last : (D,) numpy.ndarray + Flags indicating if :code:`dih_type` is :code:`1` for each of :code:`D` + constructed four-particle bonds. + + See also + -------- + prepare_bonds_old : + Used internally to reconstruct the bonded interactions types from the + connectivity information in the structure/topology input file and the + bonded types specified in the configuration file. + """ + if topol is not None: + bonds_2, bonds_3, bonds_4 = prepare_index_based_bonds( + molecules, topol + ) + else: + bonds_2, bonds_3, bonds_4, bb_index = prepare_bonds_old( + molecules, names, bonds, indices, config + ) + + # Bonds + bonds_2_atom1 = np.empty(len(bonds_2), dtype=int) + bonds_2_atom2 = np.empty(len(bonds_2), dtype=int) + bonds_2_equilibrium = np.empty(len(bonds_2), dtype=np.float64) + bonds_2_strength = np.empty(len(bonds_2), dtype=np.float64) + for i, b in enumerate(bonds_2): + bonds_2_atom1[i] = b[0] + bonds_2_atom2[i] = b[1] + bonds_2_equilibrium[i] = b[2] + bonds_2_strength[i] = b[3] + + # Angles + bonds_3_atom1 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom2 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom3 = np.empty(len(bonds_3), dtype=int) + bonds_3_equilibrium = np.empty(len(bonds_3), dtype=np.float64) + bonds_3_strength = np.empty(len(bonds_3), dtype=np.float64) + for i, b in enumerate(bonds_3): + bonds_3_atom1[i] = b[0] + bonds_3_atom2[i] = b[1] + bonds_3_atom3[i] = b[2] + bonds_3_equilibrium[i] = b[3] + bonds_3_strength[i] = b[4] + # Dihedrals + bonds_4_atom1 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom2 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom3 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom4 = np.empty(len(bonds_4), dtype=int) + number_of_coeff = 6 + len_of_coeff = 5 + bonds_4_coeff = np.empty( + (len(bonds_4), number_of_coeff, len_of_coeff), dtype=np.float64 + ) + bonds_4_type = np.empty(len(bonds_4), dtype=int) + bonds_4_last = np.zeros(len(bonds_4), dtype=int) + for i, b in enumerate(bonds_4): + bonds_4_atom1[i] = b[0] + bonds_4_atom2[i] = b[1] + bonds_4_atom3[i] = b[2] + bonds_4_atom4[i] = b[3] + bonds_4_coeff[i] = np.resize(b[4], (number_of_coeff, len_of_coeff)) + bonds_4_type[i] = b[5] + if topol is not None: + bonds_4_last[i] = b[6] + if topol is None: + bonds_4_last[bb_index] = 1 + + return ( + bonds_2_atom1, + bonds_2_atom2, + bonds_2_equilibrium, + bonds_2_strength, + bonds_3_atom1, + bonds_3_atom2, + bonds_3_atom3, + bonds_3_equilibrium, + bonds_3_strength, # noqa: E501 + bonds_4_atom1, + bonds_4_atom2, + bonds_4_atom3, + bonds_4_atom4, + bonds_4_coeff, + bonds_4_type, + bonds_4_last, # noqa: E501 + )
+ + +
[docs]def compute_bond_forces__plain(f_bonds, r, bonds_2, box_size): + """Computes forces resulting from bonded interactions + + .. deprecated:: 1.0.0 + :code:`compute_bond_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_bonds.fill(0.0) + energy = 0.0 + + for i, j, r0, k in bonds_2: + ri = r[i, :] + rj = r[j, :] + rij = rj - ri + + # Apply periodic boundary conditions to the distance rij + for dim in range(len(rij)): + rij[dim] -= box_size[dim] * np.around(rij[dim] / box_size[dim]) + dr = np.linalg.norm(rij) + df = -k * (dr - r0) + f_bond_vector = df * rij / dr + f_bonds[i, :] -= f_bond_vector + f_bonds[j, :] += f_bond_vector + + energy += 0.5 * k * (dr - r0) ** 2 + return energy
+ + +
[docs]def compute_angle_forces__plain(f_angles, r, bonds_3, box_size): + """Computes forces resulting from angular interactions + + .. deprecated:: 1.0.0 + :code:`compute_angle_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_angles.fill(0.0) + energy = 0.0 + + for a, b, c, theta0, k in bonds_3: + ra = r[a, :] - r[b, :] + rc = r[c, :] - r[b, :] + + for dim in range(len(ra)): + ra[dim] -= box_size[dim] * np.around(ra[dim] / box_size[dim]) + rc[dim] -= box_size[dim] * np.around(rc[dim] / box_size[dim]) + + xra = 1.0 / np.sqrt(np.dot(ra, ra)) + xrc = 1.0 / np.sqrt(np.dot(rc, rc)) + ea = ra * xra + ec = rc * xrc + + cosphi = np.dot(ea, ec) + theta = np.arccos(cosphi) + xsinph = 1.0 / np.sqrt(1.0 - cosphi**2) + + d = theta - theta0 + f = -k * d + + xrasin = xra * xsinph * f + xrcsin = xrc * xsinph * f + + fa = (ea * cosphi - ec) * xrasin + fc = (ec * cosphi - ea) * xrcsin + + f_angles[a, :] += fa + f_angles[c, :] += fc + f_angles[b, :] -= fa + fc + # f_angles[b, :] += -(fa + fc) + + energy -= 0.5 * f * d + + return energy
+ + +
[docs]def compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size): + """Computes forces resulting from dihedral interactions + + .. deprecated:: 1.0.0 + :code:`compute_dihedral_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_dihedrals.fill(0.0) + energy = 0.0 + + for a, b, c, d, coeffs, phase in bonds_4: + f = r[a, :] - r[b, :] + g = r[b, :] - r[c, :] + h = r[d, :] - r[c, :] + + for dim in range(3): + f -= box_size[dim] * np.around(f[dim] / box_size[dim]) + g -= box_size[dim] * np.around(g[dim] / box_size[dim]) + h -= box_size[dim] * np.around(h[dim] / box_size[dim]) + + v = np.cross(f, g) + w = np.cross(h, g) + vv = np.dot(v, v) + ww = np.dot(w, w) + gn = np.linalg.norm(g) + + cosphi = np.dot(v, w) + sinphi = np.dot(np.cross(v, w), g) / gn + phi = np.arctan2(sinphi, cosphi) + + fg = np.dot(f, g) + hg = np.dot(h, g) + sc = v * fg / (vv * gn) - w * hg / (ww * gn) + + df = 0 + + for m in range(len(coeffs[0])): + energy += coeffs[0][m] * (1 + np.cos(m * phi - coeffs[1][m])) + df += m * coeffs[0][m] * np.sin(m * phi - coeffs[1][m]) + + force_on_a = df * gn * v / vv + force_on_d = df * gn * w / ww + + f_dihedrals[a, :] -= force_on_a + f_dihedrals[b, :] += df * sc + force_on_a + f_dihedrals[c, :] -= df * sc + force_on_d + f_dihedrals[d, :] += force_on_d + return energy
+ + +
[docs]def dipole_forces_redistribution( + f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb +): + """Redistribute electrostatic forces calculated from topologically + reconstructed ghost dipole point charges to the backcone atoms of the protein. + """ + f_on_bead.fill(0.0) + for i, j, k, l, fd, matrix, dih_type, is_last in zip( + a, b, c, d, f_dipoles, trans_matrices, type_array, last_bb + ): + if dih_type == 1: + sum_force = fd[0] + fd[1] + diff_force = fd[0] - fd[1] + f_on_bead[i] += matrix[0] @ diff_force # Atom A + f_on_bead[j] += matrix[1] @ diff_force + 0.5 * sum_force # Atom B + f_on_bead[k] += matrix[2] @ diff_force + 0.5 * sum_force # Atom C + + if is_last == 1: + sum_force = fd[2] + fd[3] + diff_force = fd[2] - fd[3] + f_on_bead[j] += matrix[3] @ diff_force + f_on_bead[k] += matrix[4] @ diff_force + 0.5 * sum_force + f_on_bead[l] += matrix[5] @ diff_force + 0.5 * sum_force
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/_modules/hymd/hamiltonian.html b/v1.0.4/_modules/hymd/hamiltonian.html new file mode 100644 index 00000000..e03d6b6b --- /dev/null +++ b/v1.0.4/_modules/hymd/hamiltonian.html @@ -0,0 +1,785 @@ + + + + + + hymd.hamiltonian — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.hamiltonian

+"""Interaction energy functionals.
+
+Implements field--particle interaction energy functionals depending on the
+field configuration. Extending HyMD with a new Hamiltonian is done by
+subclassing the :code:`Hamiltonian` superclass with logic intialized in the
+constructor.
+
+The grid-independent filtering function is defined in the :code:`Hamiltonian`
+superclass constructor. Hijack :code:`self.H` in a subclass to change the
+filter.
+"""
+import numpy as np
+import sympy
+
+
+
[docs]class Hamiltonian: + """Interaction energy functional superclass""" + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + self.config = config + self._setup()
+ +
[docs] def _setup(self): + """Superclass setup + + Sets up the grid-independent filtering function :code:`H`, and the + SymPy logic for symbolically differentiating interaction energy + functionals in Hamiltonian subclasses. + """ + if not hasattr(self.config, "simulation_volume"): + self.config.simulation_volume = np.prod(np.asarray(self.config.box_size)) + if not self.config.barostat: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.config.a = self.config.rho0 + if not self.config.rho0: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.phi = sympy.var("phi:%d" % (self.config.n_types)) + k = sympy.var("k:%d" % (3)) + + # electrostatics variables + self.psi = sympy.var("psi") + self.phi_q = sympy.var("phi_q") + if not self.config.self_energy: + self.config.self_energy = 0.0 + + def fourier_space_window_function(k): + return sympy.functions.elementary.exponential.exp( + -0.5 + * self.config.sigma**2 + * (k0**2 + k1**2 + k2**2) # noqa: F821, E501 + ) + + self.window_function_lambda = sympy.lambdify( + [k], fourier_space_window_function(k) + ) + + def H(k, v): + return v * self.window_function_lambda(k) + + self.H = H
+ + +
[docs]class SquaredPhi(Hamiltonian): + """Simple squared density interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + \\sum_k \\tilde\\phi_k + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`rho_0` is the + average density of the fully homogenous system. Expressing the species + densities in terms of fluctuations from the average, + + .. math:: + + \\mathrm{d}\\tilde\\phi_k = \\rho_0 - \\tilde\\phi_k, + + it is evident that this interaction energy functional is a slight change of + the :code:`DefaultNoChi` Hamiltonian, as the expanded interaction energy + density becomes + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + 6\\rho_0\\left[ + \\sum_k \\mathrm{d}\\tilde\\phi_k + \\right] + + + 9\\rho_0^2 + + + \\sum_k \\mathrm{d}\\tilde\\phi_k^2 + + + \\prod_{k\\not=l} + \\mathrm{d}\\tilde\\phi_k \\mathrm{d}\\tilde\\phi_l + \\right), + + identical to :code:`DefaultNoChi` apart from a constant energy shift + :math:`9\\rho_0^2`(which does not impact dynamics) and the + :math:`\\rho_0`--:math:`\\mathrm{d}\\tilde\\phi_k` cross-terms. These + cross-terms constitute contributions to the energy linear in + :math:`\\mathrm{d}\\tilde\\phi_k` absent in :code:`DefaultNoChi`, which has + only quadratic terms present. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(SquaredPhi, self).__init__(config) + super(SquaredPhi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0): + return 0.5 / (kappa * rho0) * (sum(phi)) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + ): + V_incompressibility = 1 / (kappa * rho0) * sum(phi) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultNoChi(Hamiltonian): + """Incompressibility-only interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. The :code:`SquaredPhi` Hamiltonian implements a similar + functional with an additional linear term component depending on + + .. math:: + + \\mathmr{d}\\tilde\\phi_k = \\tilde\\phi_k - \\rho_0 + + and not :math:`\\mathrm{d}\\tilde\\phi_k^2`. No explicit inter-species + interaction is present apart from the indirect interaction through the + incompressibility. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + hymd.input_parser.Config : + Configuration dataclass handler. + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultNoChi, self).__init__(config) + super(DefaultNoChi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0, a=self.config.a): + return 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultWithChi(Hamiltonian): + """Incompressibility and :math:`\\chi`-interactions energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = + \\frac{1}{2\\rho_0} + \\sum_{k,l}\\chi_{kl} \\tilde\\phi_k \\tilde\\phi_l + + + \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. :math:`\\chi_{ij}` is the Flory-Huggins-like + inter-species mixing energy. + """ + +
[docs] def __init__(self, config, unique_names, type_to_name_map): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultWithChi, self).__init__(config) + super(DefaultWithChi, self)._setup() + self.setup(unique_names, type_to_name_map)
+ +
[docs] def setup(self, unique_names, type_to_name_map): + """Setup the interaction energy potential and the external potential + + Parameters + ---------- + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + """ + self.type_to_name_map = type_to_name_map + self.chi_type_dictionary = { + tuple(sorted([c.atom_1, c.atom_2])): c.interaction_energy + for c in self.config.chi + } + self.phi_laplacian = [ + sympy.var("phi_laplacian%d(0:%d)" % (t, 3)) + for t in range(self.config.n_types) + ] + + def w( + phi, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + interaction = 0.0 + for i in range(self.config.n_types): + for j in range(i + 1, self.config.n_types): + ni = type_to_name_map[i] + nj = type_to_name_map[j] + names = sorted([ni, nj]) + c = chi_type_dictionary[tuple(names)] + + interaction += c * phi[i] * phi[j] / rho0 + incompressibility = 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + return incompressibility + interaction + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + t, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + + V_interaction = 0.0 + nk = type_to_name_map[t] + for i in range(self.config.n_types): + ni = type_to_name_map[i] + names = sorted([nk, ni]) + if ni != nk: + c = chi_type_dictionary[tuple(names)] + else: + c = 0.0 + # uncomment to count diagonal chi terms: + # c = chi_type_dictionary[tuple(names)] + V_interaction += c * phi[i] / rho0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[t])) + for t in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +def get_hamiltonian(config): + """Return appropriate Hamiltonian object based on the + config.hamiltonian string. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ---------- + hamiltonian : Hamiltonian + Hamiltonian object. + """ + if config.hamiltonian.lower() == "defaultnochi": + hamiltonian = DefaultNoChi(config) + elif config.hamiltonian.lower() == "defaultwithchi": + hamiltonian = DefaultWithChi( + config, config.unique_names, config.type_to_name_map + ) + elif config.hamiltonian.lower() == "squaredphi": + hamiltonian = SquaredPhi(config) + + return hamiltonian +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/_modules/hymd/input_parser.html b/v1.0.4/_modules/hymd/input_parser.html new file mode 100644 index 00000000..7deedc17 --- /dev/null +++ b/v1.0.4/_modules/hymd/input_parser.html @@ -0,0 +1,1623 @@ + + + + + + hymd.input_parser — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.input_parser

+"""Parses and handles the configuration information provided for the simulation
+"""
+import copy
+import tomli
+import datetime
+import logging
+import warnings
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass, field
+from typing import List, Union, ClassVar
+from .force import Bond, Angle, Dihedral, Chi, Dielectric_type, propensity_potential_coeffs
+from .barostat import Target_pressure
+from .logger import Logger
+
+
+
[docs]@dataclass +class Config: + """Configuration object + + Handles and verifies the simulation configuration specified in the + configuration file. + + Attributes + ---------- + gas_constant : float + Constant value of the gas constant, R (equivalently the Boltzmann + constant) in the units used internally in HyMD. + coulomb_constant : float + Constant value of the Coulomb constant which converts electric field + values to forces and electric potential values to energies in the units + used internally in HyMD. + n_steps: int + Number of time steps in the simulation. + time_step: float + *Outer* time step used in the simulation. If the rRESPA intergrator is + used, the *inner* time step (the time step used in the integration of + intramolecular bending, stretching, and torsional forces) is + :code:`time_step / respa_inner`. + box_size : list[float] or (D,) numpy.ndarray + Simulation box size of simulation in :code:`D` dimensions in units of + nanometers. + mesh_size : list[int] or int or numpy.ndarray + Number of grid points used for the discrete density grid. + sigma : float + Filter width representing the effective coarse-graining level of the + particles in the simulation. + kappa : float + Compressibility parameter used in the relaxed incompressibility term in + the interaction energy functional. + n_print : int, optional + Frequency of trajectory/energy output to the H5MD trajectory/energy + output file (in units of number of time steps). + tau : float, optional + The time scale of the CSVR thermostat coupling. + start_temperature : float, optional + Generate starting temperature by assigning all particle velocities + randomly according to the Maxwell-Boltzmann distribution at + :code:`start_temperature` Kelvin prior to starting the simulation. + target_temperature : float, optional + Couple the system to a heat bath at :code:`target_temperature` Kelvin. + mass : float, optional + Mass of the particles in the simulation. + hamiltonian : str, optional + Specifies the interaction energy functional :math:`W[\\tilde\\phi]` + for use with the particle-field interactions. Options: + :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`. + domain_decomposition : int, optional + Specifies the interval (in time steps) of domain decomposition + exchange, involving all MPI ranks sending and receiving particles + according to the particles’ positions in the integration box and the + MPI ranks’ assigned domain. + integrator : str, optional + Specifies the time integrator used in the simulation. Options: + :code:`velocity-verlet` or :code:`respa`. + respa_inner : int, optional + The number of inner time steps in the rRESPA integrator. This denotes + the number of intramolecular force calculations (stretching, bending, + torsional) are performed between each impulse applied from the field + forces. + file_name : str, optional + File path of the parsed configuration file. + name : str, optional + Name for the simulation. + tags : list[str], optional + Tags for the simulation. + bonds : list[Bond], optional + Specifies harmonic stretching potentials between particles in the + same molecule. + angle_bonds : list[Angle], optional + Specifies harmonic angular bending potentials between particles in the + same molecule. + dihedrals : list[Dihedral], optional + Specifies four-particle torsional potentials by cosine series. + chi : list[Chi], optional + Specifies :math:`\\chi`-interaction parameters between particle + species. + n_particles : int, optional + Specifies the total number of particles in the input. Optional keyword + for validation, ensuring the input HDF5 topology has the correct number + of particles and molecules. + max_molecule_size : int, optional + Maximum size of any single molecule in the system. Used to speed up + distribution of particles onto MPI ranks in a parallel fashion. + n_flush : int, optional + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be + written to disk (in units of number of :code:`n_print`). + thermostat_work : float + Work performed by the thermostat on the system. + thermostat_coupling_groups : list[str], optional + Specifies individual groups coupling independently to the CSVR + thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and + :code:`"C"` type particles, + :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would + thermalise types :code:`"A"` and :code:`"B"` together and couple + :code:`"C"` type particles to a different thermostat (all individual + thermostats are at the same temperature, i.e. target_temperature + Kelvin). + initial_energy : float + Value of the total energy prior to the start of the simulation. + cancel_com_momentum : int, optional + If :code:`True`, the total linear momentum of the center of mass is + removed before starting the simulation. If an integer is specifed, the + total linear momentum of the center of mass is removed every + :code:`remove_com_momentum` time steps. If :code:`False`, the linear + momentum is never removed. + coulombtype : str, optional + Specifies the type of electrostatic Coulomb interactions in the system. + The strength of the electrostatic forces is modulated by the relative + dielectric constant of the simulation medium, specified with the + :code:`dielectric_const` keyword. Charges for individual particles are + specified in the structure/topology HDF5 input file, not in the + configuration file. If no charges (or peptide backbone dipoles) are + present, the electrostatic forces will not be calculated even if this + keyword is set to :code:`"PIC_Spectral"`. + dielectric_const : float, optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. When + using helical propensity dihedrals, this keyword must be specified—even + if electrostatics are not included with the :code:`coulombtype` + keyword. + dielectric_type: list[float], optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. The list assigns + relative dielectric values to each bead type, and an anisotropic + dielectric function is obtained from a weighted average. + + + See also + -------- + hymd.input_parser.Bond : + Two-particle bond type dataclass. + hymd.input_parser.Angle : + Three-particle bond type dataclass. + hymd.input_parser.Dihedral : + Four-particle bond type dataclass. + """ + + gas_constant: ClassVar[float] = 0.0083144621 # kJ mol-1 K-1 + coulomb_constant: ClassVar[float] = 138.935458 # kJ nm mol-1 e-2 + + n_steps: int + time_step: float + mesh_size: Union[Union[List[int], np.ndarray], int] + sigma: float + kappa: float + + dtype: np.dtype = None + box_size: Union[List[float], np.ndarray] = None + n_print: int = None + tau: float = None + start_temperature: Union[float, bool] = None + target_temperature: Union[float, bool] = None + mass: float = None + hamiltonian: str = None + domain_decomposition: Union[int, bool] = None + integrator: str = None + respa_inner: int = 1 + file_name: str = "<config file path unknown>" + name: str = None + tags: List[str] = field(default_factory=list) + bonds: List[Bond] = field(default_factory=list) + angle_bonds: List[Angle] = field(default_factory=list) + dihedrals: List[Dihedral] = field(default_factory=list) + chi: List[Chi] = field(default_factory=list) + n_particles: int = None + max_molecule_size: int = None + n_flush: int = None + thermostat_work: float = 0.0 + thermostat_coupling_groups: List[List[str]] = field(default_factory=list) + initial_energy: float = None + cancel_com_momentum: Union[int, bool] = False + coulombtype: str = None + convergence_type: str = None + pol_mixing: float = None + dielectric_const: float = None + conv_crit: float = None + dielectric_type: List[Dielectric_type] = field(default_factory=list) + self_energy: float = None + type_charges: Union[List[float], np.ndarray] = None + + # For NPT runs + rho0: float = None + a: float = None + pressure: bool = False + barostat: str = None + barostat_type: str = None + tau_p: float = None + target_pressure: List[Target_pressure] = field(default_factory=list) + n_b: int = None + m: List[float] = field(default_factory=list) + + def __str__(self): + target_pressure_str = "\ttarget_pressure:\n" + "".join( + "\t\tP_L: " + + f"{self.target_pressure.P_L}\n" + + "\t\tP_N: " + + f"{self.target_pressure.P_N}\n" + ) + bonds_str = "\tbonds:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " f"{k.equilibrium}, {k.strength}\n") + for k in self.bonds + ] + ) + angle_str = "\tangle_bonds:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3}: " + + f"{k.equilibrium}, {k.strength}\n" + ) + for k in self.angle_bonds + ] + ) + dihedrals_str = "\tdihedrals:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: " + # This might need to be fixed/made prettier, probably + # there's an easier way + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ).join( + map( + str, + [ + [round(num, 3) for num in c_in] + if isinstance(c_in, list) + else c_in + for c_in in k.coeffs + ], + ) + ) + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ) + + f"dih_type = {k.dih_type}\n" + ) + for k in self.dihedrals + ] + ) + chi_str = "\tchi:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " + f"{k.interaction_energy}\n") + for k in self.chi + ] + ) + + """ If dielectric wanted as dictionary + dielectric_type_str = "\tdielectric_type:\n" + "".join( + [ + (f"\t\t{k.atom_1}: " + f"{k.dielectric_value}\n") + for k in self.dielectric_type + ] + ) + + """ + + thermostat_coupling_groups_str = "" + if any(self.thermostat_coupling_groups): + thermostat_coupling_groups_str = ( + "\tthermostat_coupling_groups:\n" + + "".join( + [ + "\t\t" + ", ".join([f"{n}" for n in ng]) + "\n" + for ng in self.thermostat_coupling_groups + ] + ) + ) + + ret_str = f'\n\n\tConfig: {self.file_name}\n\t{50 * "-"}\n' + for k, v in self.__dict__.items(): + if k not in ( + "target_pressure", + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "thermostat_coupling_groups", + ): + ret_str += f"\t{k}: {v}\n" + ret_str += ( + target_pressure_str + + bonds_str + + angle_str + + dihedrals_str + + chi_str + + thermostat_coupling_groups_str + ) + return ret_str
+ + +
[docs]def read_config_toml(file_path): + with open(file_path, "r") as in_file: + file_content = in_file.read() + return file_content
+ +
[docs]def parse_config_toml(toml_content, file_path=None, comm=MPI.COMM_WORLD): + config_dict = {} + + # read toml to a dictionary + toml_content = tomli.loads(toml_content) + + # Defaults = None + for n in ( + "box_size", + "n_print", + "tau", + "start_temperature", + "target_temperature", + "mass", + "hamiltonian", + "domain_decomposition", + "integrator", + "name", + "n_particles", + "max_molecule_size", + "coulombtype", + "convergence_type", + "dielectric_const", + "pol_mixing", + "conv_crit", + "dielectric_type", + "n_b", + "box_size", + "n_flush", + "self_energy", + "dtype", + ): + config_dict[n] = None + + # Defaults = [] + + for n in ( + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "tags", + "m", + "dielectric_type", + "target_pressure", + "type_charges", + ): + config_dict[n] = [] + + # Defaults: bool + config_dict["pressure"] = False + + # Flatten the .toml dictionary, ignoring the top level [tag] directives (if + # any). + for k, v in toml_content.items(): + if isinstance(v, dict): + if k == "nn": # Don't parse diff-hymd optimization options + continue + for nested_k, nested_v in v.items(): + config_dict[nested_k] = nested_v + else: + config_dict[k] = v + for k, v in config_dict.items(): + if k == "bonds": + config_dict["bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["bonds"][i] = Bond( + atom_1=b[0], + atom_2=b[1], + equilibrium=b[2], + strength=b[3], + ) + if k == "angle_bonds": + config_dict["angle_bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["angle_bonds"][i] = Angle( + atom_1=b[0], + atom_2=b[1], + atom_3=b[2], + equilibrium=b[3], + strength=b[4], + ) + if k == "dihedrals": + config_dict["dihedrals"] = [None] * len(v) + for i, b in enumerate(v): + try: + dih_type = int(b[2][0]) + except IndexError: + Logger.rank0.log( + logging.WARNING, "Dihedral type not provided, defaulting to 0." + ) + dih_type = 0 + + # Probably it's better to move this in check_dihedrals? + wrong_len = len(b[1]) not in (1, 2) + wrong_type_1 = len(b[1]) == 1 and not isinstance(b[1][0], float) + wrong_type_2 = len(b[1]) == 2 and not isinstance(b[1][0], list) + if wrong_len or wrong_type_1 or wrong_type_2: + err_str = ( + "The coefficients specified for the dihedral type " + "(0) do not match the correct structure. Either " + "use [lambda] or [[cn_prop], [dn_prop]], or select" + " the correct dihedral type." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise RuntimeError(err_str) + + # FIXME: this is messy af, I don't like it + if dih_type == 0 and isinstance(b[1][0], (float, int)): + coeff = propensity_potential_coeffs(b[1][0]) + elif dih_type == 1 and len(b[1]) == 3: + coeff = np.array( + propensity_potential_coeffs(b[1][0][0]).tolist() + + b[1][1:] + ) + elif dih_type == 2: + coeff = np.array(b[1]) + else: + coeff = np.insert(np.array(b[1]), 2, np.zeros((2, 5)), axis=0) + + config_dict["dihedrals"][i] = Dihedral( + atom_1=b[0][0], + atom_2=b[0][1], + atom_3=b[0][2], + atom_4=b[0][3], + coeffs=coeff, + dih_type=dih_type, + ) + if k == "chi": + config_dict["chi"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0], c[1]]) + config_dict["chi"][i] = Chi( + atom_1=c_[0], atom_2=c_[1], interaction_energy=c[2] + ) + + """ + if k == "dielectric_type": + config_dict["dielectric_type"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0][0]]) + config_dict["dielectric_type"][i] = Dielectric_type( + atom_1=c_[0], dielectric_value=c[1][0] + ) + """ + if k == "target_pressure": + if len(v) == 2: + config_dict["target_pressure"] = Target_pressure( + P_L=v[0], + P_N=v[1], # check condition # V array (still read as array?) + ) + elif len(v) == 1: + config_dict["target_pressure"] = Target_pressure(P_L=v[0], P_N=None) + else: + config_dict["target_pressure"] = Target_pressure(P_L=None, P_N=None) + + if file_path is not None: + config_dict["file_name"] = file_path + + for n in ( + "n_steps", "time_step", "mesh_size", "sigma", "kappa" + ): + if n not in config_dict: + err_str = ( + f"No {n} specified in config file {file_path}. Unable to start" + f" simulation." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return Config(**config_dict)
+ + +
[docs]def check_n_particles(config, indices, comm=MPI.COMM_WORLD): + n_particles = comm.allreduce(len(indices), MPI.SUM) + if config.n_particles is None: + config = copy.deepcopy(config) + config.n_particles = n_particles + info_str = ( + f"No n_particles found in toml file {config.file_name}, defaulting" + f" to indices.shape ({n_particles})" + ) + Logger.rank0.log(logging.INFO, info_str) + return config + + if n_particles != config.n_particles: + warn_str = ( + f"n_particles in {config.file_name} ({config.n_particles}) does " + "not match the shape of the indices array in the .HDF5 file " + f"({n_particles}). Defaulting to using indices.shape " + f"({n_particles})" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.n_particles = n_particles + return config
+ + +
[docs]def check_max_molecule_size(config, comm=MPI.COMM_WORLD): + if config.max_molecule_size is None: + info_str = ( + f"No max_molecule_size found in toml file {config.file_name}, " + f"defaulting to 201" + ) + Logger.rank0.log(logging.INFO, info_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + + if config.max_molecule_size < 1: + warn_str = ( + f"max_molecule_size in {config.file_name} must be a positive " + f"integer, not {config.max_molecule_size}, defaulting to 201" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + return config
+ + +def _find_unique_names(config, names, comm=MPI.COMM_WORLD): + unique_names = np.unique(names) + receive_buffer = comm.gather(unique_names, root=0) + + gathered_unique_names = None + if comm.Get_rank() == 0: + gathered_unique_names = np.unique(np.concatenate(receive_buffer)) + unique_names = comm.bcast(gathered_unique_names, root=0) + unique_names = sorted([n.decode("UTF-8") for n in unique_names]) + config.unique_names = unique_names + config.n_types = len(unique_names) + return config + + +def _setup_type_to_name_map(config, names, types, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + name_to_type_ = {} + for n, t in zip(names, types): + n = n.decode("utf-8") + if n not in name_to_type_: + name_to_type_[n] = t + receive_buffer = comm.gather(name_to_type_, root=0) + gathered_dict = None + if comm.Get_rank() == 0: + gathered_dict = {} + for d in receive_buffer: + for k, v in d.items(): + if k not in gathered_dict: + gathered_dict[k] = v + else: + assert v == gathered_dict[k] + name_to_type_map = comm.bcast(gathered_dict, root=0) + config.name_to_type_map = name_to_type_map + config.type_to_name_map = {v: k for k, v in name_to_type_map.items()} + return config + + +
[docs]def check_bonds(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for b in config.bonds: + if b.atom_1 not in unique_names or b.atom_2 not in unique_names: + missing_str = "" + if b.atom_1 not in unique_names: + if b.atom_2 not in unique_names: + if b.atom_1 == b.atom_2: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"neither {b.atom_1}, {b.atom_2} atoms" + else: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"no {b.atom_2} atoms" + + warn_str = ( + f"Bond type {b.atom_1}--{b.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_angles(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for a in config.angle_bonds: + if ( + a.atom_1 not in unique_names + or a.atom_2 not in unique_names + or a.atom_3 not in unique_names + ): + missing = [ + a.atom_1 not in unique_names, + a.atom_2 not in unique_names, + a.atom_3 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([a.atom_1, a.atom_2, a.atom_3]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Angle bond type {a.atom_1}--{a.atom_2}--{a.atom_3} " + f"specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_dihedrals(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for d in config.dihedrals: + if ( + d.atom_1 not in unique_names + or d.atom_2 not in unique_names + or d.atom_3 not in unique_names + or d.atom_4 not in unique_names + ): + missing = [ + d.atom_1 not in unique_names, + d.atom_2 not in unique_names, + d.atom_3 not in unique_names, + d.atom_4 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([d.atom_1, d.atom_2, d.atom_3, d.atom_4]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Dihedral type {d.atom_1}--{d.atom_2}--{d.atom_3}--{d.atom_4}" + f" specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_chi(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for c in config.chi: + if c.atom_1 not in unique_names or c.atom_2 not in unique_names: + missing_str = "" + if c.atom_1 not in unique_names: + if c.atom_2 not in unique_names: + if c.atom_1 == c.atom_2: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"neither {c.atom_1}, {c.atom_2} atoms" + else: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"no {c.atom_2} atoms" + + warn_str = ( + f"Chi interaction {c.atom_1}--{c.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + for i, n in enumerate(unique_names): + for m in unique_names[i + 1 :]: + found = False + for c in config.chi: + if (c.atom_1 == n and c.atom_2 == m) or ( + c.atom_1 == m and c.atom_2 == n + ): + found = True + if not found: + config.chi.append(Chi(atom_1=n, atom_2=m, interaction_energy=0.0)) + warn_str = ( + f"Atom types {n} and {m} found in the " + f"system, but no chi interaction {n}--{m} " + f"specified in {config.file_name}. Defaulting to " + f"chi[{n}, {m}] = 0" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_box_size(config, input_box, comm=MPI.COMM_WORLD): + if config.box_size is not None: + config.box_size = np.array(config.box_size, dtype=np.float32) + if input_box.all() and not np.allclose(config.box_size, input_box, atol=0.009): + err_str = ( + f"Box size specified in {config.file_name}: " + f"{config.box_size} does not match input box:" + f"{input_box}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + else: + if input_box.all(): + config.box_size = input_box + else: + err_str = f"No box information found" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + for b in config.box_size: + if b <= 0.0: + err_str = ( + f"Invalid box size specified in {config.file_name}: " + f"{config.box_size}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return config
+ + +
[docs]def check_integrator(config, comm=MPI.COMM_WORLD): + if config.integrator.lower() not in ("velocity-verlet", "respa"): + err_str = ( + f"Invalid integrator specified in {config.file_name}: " + f'{config.integrator}. Available options "velocity-verlet" or ' + f'"respa".' + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + if config.integrator.lower() == "respa": + if isinstance(config.respa_inner, float): + warn_str = ( + f"Number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner} specified " + f"as float, using {int(config.respa_inner)}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = int(config.respa_inner) + elif not isinstance(config.respa_inner, int): + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + + if config.respa_inner <= 0: + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + if config.integrator.lower() == "velocity-verlet" and config.respa_inner != 1: + warn_str = ( + f"Integrator type Velocity-Verlet specified in {config.file_name} " + f"and inner rRESPA time steps set to {config.respa_inner}. " + f"Using respa_inner = 1" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = 1 + + return config
+ + +
[docs]def check_hamiltonian(config, comm=MPI.COMM_WORLD): + valid_hamiltonians = ["defaultnochi", "defaultwithchi", "squaredphi"] + + if config.hamiltonian is None: + if len(config.chi) == 0: + warn_str = ( + f"No hamiltonian form and no chi interactions specified in " + f"{config.file_name}, defaulting to DefaultNoChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultNoChi" + else: + warn_str = ( + f"No hamiltonian form specified in {config.file_name}, but " + f"chi interactions are specified, defaulting to " + f"DefaultWithChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultWithChi" + elif config.hamiltonian.lower() not in valid_hamiltonians: + err_str = ( + f"The specified Hamiltonian {config.hamiltonian} was not " + f"recognized as a valid Hamiltonian." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise NotImplementedError(err_str) + + return config
+ + +
[docs]def check_n_flush(config, comm=MPI.COMM_WORLD): + if config.n_print: + if config.n_flush is None: + config.n_flush = 10000 // config.n_print + return config
+ + +
[docs]def check_n_print(config, comm=MPI.COMM_WORLD): + if ( + not isinstance(config.n_print, int) + and not isinstance(config.n_print, float) + and config.n_print is not None + ): + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if config.n_print is None or config.n_print <= 0: + config.n_print = False + elif not isinstance(config.n_print, int): + if isinstance(config.n_print, float): + warn_str = ( + f"n_print is a float ({config.n_print}), not int, using " + f"{int(round(config.n_print))}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + config.n_print = int(round(config.n_print)) + else: + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + return config
+ + +
[docs]def check_tau(config, comm=MPI.COMM_WORLD): + if config.tau is None and config.target_temperature is not None: + warn_str = "target temp specified but no tau, defaulting 0.7" + config.tau = 0.7 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_start_and_target_temperature(config, comm=MPI.COMM_WORLD): + """Validate provided starting and target thermostat temperatures + + Assesses the provided temperature target and ensures it is a non-negative + floating point number or :code:`False`. Ensures the starting temperature is + a non-negative floating point number or :code:`False`. + + If the value for either is :code:`None`, the returned configuration object + has the values defaulted to :code:`False` in each case. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ------- + validated_config : Config + Configuration object with validated :code:`target_temperature` and + :code:`start_temperature`. + """ + for t in ("start_temperature", "target_temperature"): + if getattr(config, t) is not None: + try: + if getattr(config, t) < 0: + warn_str = ( + f"{t} set to negative value ({getattr(config, t)}), " + f"defaulting to False" + ) + setattr(config, t, False) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + except TypeError as e: + err_str = ( + f"Could not interpret {t} = {repr(getattr(config, t))} as " + f"a number." + ) + raise TypeError(err_str) from e + + if config.start_temperature is None: + config.start_temperature = False + if config.target_temperature is None: + config.target_temperature = False + return config
+ + +
[docs]def check_mass(config, comm=MPI.COMM_WORLD): + if config.mass is None: + info_str = "no mass specified, defaulting to 72.0" + config.mass = 72.0 + Logger.rank0.log(logging.INFO, info_str) + elif not isinstance(config.mass, int) and not isinstance(config.mass, float): + err_str = ( + f"specified mass is invalid type {config.mass}, " f"({type(config.mass)})" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + elif config.mass < 0: + err_str = f"invalid mass specified, {config.mass}" + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + else: + config.mass = float(config.mass) + + return config
+ + +
[docs]def check_domain_decomposition(config, comm=MPI.COMM_WORLD): + dd = config.domain_decomposition + if dd is None or dd is False: + config.domain_decomposition = False + return config + + if isinstance(dd, int): + if dd < 0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + elif isinstance(dd, float): + if dd < 0.0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + else: + warn_str = ( + f"domain_decomposition ({config.domain_decomposition}) is not " + f"an integer, using {int(round(dd))}" + ) + config.domain_decomposition = int(round(dd)) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + else: + err_str = ( + f"invalid value for domain_decomposition " + f"({config.domain_decomposition}) use an integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + return config
+ + +
[docs]def check_name(config, comm=MPI.COMM_WORLD): + if config.name is None: + root_current_time = "" + if comm.Get_rank() == 0: + root_current_time = datetime.datetime.now().strftime("%m/%d/%Y, %H:%M:%S") + current_time = comm.bcast(root_current_time, root=0) + + if config.name is None: + config.name = "sim" + current_time + else: + config.name = str(config.name) + return config
+ + +
[docs]def check_NPT_conditions(config, comm=MPI.COMM_WORLD): + """ + Check validity of barostat_type, barostat, + a, rho0, target_pressure, tau_p + """ + if config.barostat is None: + if ( + config.tau_p is not None + or (config.target_pressure.P_L and config.target_pressure.P_N) is not None + ): + err_str = ( + "barostat not specified but config.tau_p " + "or config.target_pressure specified, cannot start simulation {config.barostat}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.a: + warn_str = "a specified but no barostat," "setting a to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.rho0: + warn_str = ( + "rho0 specified but no barostat," "setting rho0 to average density" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + if config.barostat is not None: + if not config.barostat_type: + config.barostat_type = "berendsen" + warn_str = "barostat_type not specified," "setting to berendsen" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.barostat != "isotropic" and config.barostat != "semiisotropic": + err_str = "barostat option not recognised. Valid options: isotropic, semiisotropic" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.target_pressure.P_L is None: + config.target_pressure.P_L = 1.0 # bar + config.target_pressure.P_N = None + if config.barostat == "semiisotropic": + config.target_pressure.P_N = 1.0 # bar + warn_str = ( + "barostat specified but no target_pressure, defaulting to 1.0 bar" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.tau_p is None: + if config.tau <= 0.1: + config.tau_p = config.tau * 10.0 + else: + config.tau_p = 1.0 + warn_str = "barostat specified but no tau_p, defaulting to " + str( + config.tau_p + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if not config.a: + err_str = "a not specified; cannot start simulation {config.a}" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if not config.rho0: + warn_str = "rho0 not specified;" "setting rho0 to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + return config
+ + +
[docs]def check_thermostat_coupling_groups(config, comm=MPI.COMM_WORLD): + if any(config.thermostat_coupling_groups): + found = [0 for _ in config.unique_names] + unique_names = [n for n in config.unique_names] + for i, group in enumerate(config.thermostat_coupling_groups): + for species in group: + try: + ind = unique_names.index(species) + found[ind] += 1 + except ValueError as e: + err_str = ( + f"Particle species {species} specified in thermostat " + f"coupling group {i}, but no {species} particles were " + "found in the system." + ) + raise ValueError(err_str) from e + if any([True if f > 1 else False for f in found]): + for i, f in enumerate(found): + if f > 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} specified in multiple " + "thermostat coupling groups; " + f"{config.thermostat_coupling_groups}." + ) + raise ValueError(err_str) + if not all([True if f == 1 else False for f in found]): + for i, f in enumerate(found): + if f != 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} not specified in any " + f"thermostat coupling group, but {species} particles " + "were found in the system" + ) + raise ValueError(err_str) + return config
+ + +
[docs]def check_m(config, comm=MPI.COMM_WORLD): + if config.m == []: + config.m = [1.0 for t in range(config.n_types)] + return config
+ + +
[docs]def check_n_b(config, comm=MPI.COMM_WORLD): + if config.n_b is None: + warn_str = f"config.n_b not specified." "Defaulting to 1" + config.n_b = 1 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_cancel_com_momentum(config, comm=MPI.COMM_WORLD): + if isinstance(config.cancel_com_momentum, int): + if config.cancel_com_momentum == 0 or config.cancel_com_momentum < 0: + config.cancel_com_momentum = False + elif not isinstance(config.cancel_com_momentum, bool): + err_str = ( + f"Could not interpret {config.cancel_com_momentum} as an integer " + f"or boolean." + ) + raise ValueError(err_str) + return config
+ + +
[docs]def sort_dielectric_by_type_id(config, charges, types): + """ + Creates a list of length N CG-particles, sorted after the charges from + the input HDF5 file. Used in file_io.py + """ + dielectric_val = np.zeros(config.n_types) + for j in range(config.n_types): + name = config.dielectric_type[j][0][0] + type_id = config.name_to_type_map[name] + dielectric_val[type_id] = config.dielectric_type[j][1][0] + config.dielectric_type = dielectric_val.copy() + + N = len(charges) + len_list = np.zeros(config.n_types) + dielectric_by_types = np.zeros(N) + for i in range(N): + dielectric_by_types[i] = dielectric_val[types[i]] + # print("types ", types) + # print("diel val", dielectric_by_types) + # print("charges", charges) + # print(config.name_to_type_map) + return dielectric_by_types # by types with each particle id
+ + +
[docs]def check_charges_types_list(config, types, charges, comm=MPI.COMM_WORLD): + """ + Creates a list of charge values of length types. + Charges are sorted according to type ID. Used in field.py. + # TODO: this is messy, we should fix it + """ + if charges is None: + config.type_charges = [0.0] * config.n_types + return config + + check_val = -100.0 # some random value that will never be encountered + charges_list = np.full(config.n_types, check_val) # gatherv cant handle None + rank = comm.Get_rank() + # print(charges_list) + for t_ in range(config.n_types): + if t_ in types: + charges_list[t_] = charges[types == t_][0] + + nprocs = int(comm.Get_size()) + recv_charges = None + if rank == 0: + recv_charges = np.full( + config.n_types * nprocs, check_val + ) # gatherv cant handle None + comm.Gather(charges_list, recv_charges, root=0) + + ## make a charges list + if rank == 0: + config_charges = np.zeros(config.n_types) + test_config = np.full(config.n_types, check_val) + for j in range(nprocs): + for i in range(config.n_types): + if recv_charges[i + j * config.n_types] != check_val: + config_charges[i] = recv_charges[i + j * config.n_types] + if np.any([test_config, config_charges]): + continue + else: + break + + # print(config_charges) + # print(config.name_to_type_map) + # print(charges[types == 0][0],charges[types == 1][0],charges[types == 2][0],charges[types == 3][0], + # charges[types == 4][0]) + else: + config_charges = np.zeros(config.n_types) + + comm.Bcast(config_charges, root=0) + # print("config_charges", config_charges , "rank", rank) + # print(recv_charges) + # rank = comm.Get_rank() + # print(all_charges) + config.type_charges = config_charges + return config
+ + +
[docs]def check_dielectric(config, comm=MPI.COMM_WORLD): + """ + Error handling for electrostatics. + Unit testing of toml/tomli input. + """ + err_str_const = "Dielectric constant not given." + if config.coulombtype == "PIC_Spectral": + assert config.dielectric_const != None, err_str_const + + err_str = "Dielectric list is empty." + if config.coulombtype == "PIC_Spectral_GPE": + assert len(config.dielectric_type) != 0, err_str + # default values + if config.pol_mixing is None: + config.pol_mixing = 0.6 + if config.conv_crit is None: + config.conv_crit = 1e-6 + return config
+ + +
[docs]def check_charges(config, charges, comm=MPI.COMM_WORLD): + """Check if charges across ranks sum to zero. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of floats with charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + """ + total_charge = comm.allreduce(np.sum(charges), MPI.SUM) + + if not np.isclose(total_charge, 0.0): + warn_str = ( + f"Charges in the input file do not sum to zero. " + f"Total charge is {total_charge}." + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + # if charges are ok, compute self energy + if config.coulombtype == "PIC_Spectral": + from .field import compute_self_energy_q + + config.self_energy = compute_self_energy_q(config, charges, comm=comm) + + return config
+ + +
[docs]def check_config( + config, indices, names, types, charges, input_box, comm=MPI.COMM_WORLD +): + """Performs various checks on the specfied config to ensure consistency + + Parameters + ---------- + config : Config + Configuration object. + indices : (N,) numpy.ndarray + Array of integer indices for :code:`N` particles. + names : (N,) numpy.ndarray + Array of string names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of integer type indices for :code:`N` particles. + charges : (N,) numpy.ndarray + Array of floats charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + + Returns + ------- + config : Config + Validated configuration object. + """ + config = _find_unique_names(config, names, comm=comm) + if types is not None: + config = _setup_type_to_name_map(config, names, types, comm=comm) + config = check_box_size(config, input_box, comm=comm) + config = check_integrator(config, comm=comm) + config = check_max_molecule_size(config, comm=comm) + config = check_tau(config, comm=comm) + config = check_start_and_target_temperature(config, comm=comm) + config = check_mass(config, comm=comm) + config = check_domain_decomposition(config, comm=comm) + config = check_name(config, comm=comm) + config = check_n_particles(config, indices, comm=comm) + config = check_chi(config, names, comm=comm) + config = check_bonds(config, names, comm=comm) + config = check_angles(config, names, comm=comm) + config = check_dihedrals(config, names, comm=comm) + config = check_hamiltonian(config, comm=comm) + config = check_NPT_conditions(config, comm=comm) + config = check_n_b(config, comm=comm) + config = check_m(config, comm=comm) + config = check_thermostat_coupling_groups(config, comm=comm) + config = check_cancel_com_momentum(config, comm=comm) + config = check_dielectric(config, comm=comm) + config = check_n_print(config, comm=comm) + config = check_n_flush(config, comm=comm) + config = check_charges_types_list(config, types, charges, comm=comm) + if charges is not None: + config = check_charges(config, charges, comm=comm) + + return config
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/_modules/hymd/integrator.html b/v1.0.4/_modules/hymd/integrator.html new file mode 100644 index 00000000..43597289 --- /dev/null +++ b/v1.0.4/_modules/hymd/integrator.html @@ -0,0 +1,346 @@ + + + + + + hymd.integrator — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.integrator

+"""Integrates equations of motion.
+
+Implements the Velocity Verlet integrator. The *reversible reference system
+propagator algorithm* (rRESPA) integrator uses the Velocity Verlet functions
+inside the MD loop in the main module.
+"""
+
+
+
[docs]def integrate_velocity(velocities, accelerations, time_step): + """Velocity update step of the Velocity Verlet integration algorithm. + + Computes the velocity update step of the Velocity Verlet algorithm. The + :code:`velocities` argument is **not** changed in place. + + Parameters + ---------- + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + accelerations : (N, D) numpy.ndarray + Array of accelerations of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step + + .. math:: \\mathbf{v}_{\\text{new}} = \\mathbf{v} + \\frac{\\Delta t}{2m} + \\mathbf{f} + + before the positions are moved a full step using the updated half-step + velocities. + + See Also + -------- + integrate_position : The position update step of the Velocity Verlet + algorithm. + """ + return velocities + 0.5 * time_step * accelerations
+ + +
[docs]def integrate_position(positions, velocities, time_step): + """Position update step of the Velocity Verlet integration algorithm. + + Computes the position update step of the Velocity Verlet algorithm. The + :code:`positions` argument is **not** changed in place. + + Parameters + ---------- + positions : (N, D) numpy.ndarray + Array of positions of :code:`N` particles in :code:`D` dimensions. + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step, then the positions are updated a full step using the updated + velocities + + .. math:: \\mathbf{x}_{\\text{new}} = \\mathbf{x} + \\Delta t \\mathbf{v} + + See Also + -------- + integrate_velocity : The velocity update step of the Velocity Verlet + algorithm. + """ + return positions + time_step * velocities
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/_modules/hymd/logger.html b/v1.0.4/_modules/hymd/logger.html new file mode 100644 index 00000000..f5555d65 --- /dev/null +++ b/v1.0.4/_modules/hymd/logger.html @@ -0,0 +1,535 @@ + + + + + + hymd.logger — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.logger

+"""Handles event logging for simulation information, warnings, and errors.
+"""
+import sys
+import os
+import logging
+from mpi4py import MPI
+from .version import __version__
+
+
+
[docs]class MPIFilterRoot(logging.Filter): + """Log output Filter wrapper class for the root MPI rank log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + if self.comm.Get_rank() == 0: + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True + else: + return False
+ + +
[docs]class MPIFilterAll(logging.Filter): + """Log output Filter wrapper class for the all-MPI-ranks log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True
+ + +class MPIFilterStdout(logging.Filter): + """Log output Filter wrapper class for filtering STDOUT log""" + + def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.funcName = "replica 0 " + record.funcName + if MPI.COMM_WORLD.Get_rank() == 0: + record.rank = MPI.COMM_WORLD.Get_rank() + record.size = MPI.COMM_WORLD.Get_size() + return True + else: + return False + + +
[docs]class Logger: + """Log output handler class + + Notes + ----- + This wraps the default python library :code:`logging`, see + `docs.python.org/3/library/logging.html`_. + + .. _`docs.python.org/3/library/logging.html`: + https://docs.python.org/3/library/logging.html + + Attributes + ---------- + level : int + Determines the verbosity level of the log, corresponding to + logging.level. Numerical values :code:`50` (:code:`logging.CRITICAL`), + :code:`40` (:code:`logging.ERROR`), :code:`30` + (:code:`logging.WARNING`), :code:`20` (:code:`logging.INFO`), + :code:`10` (:code:`logging.DEBUG`), and :code:`0` + (:code:`logging.UNSET`) are supported values. Any log event message + less severe than the specified level is ignored. All other event + messages are emitted. + log_file : str + Path to output log file. + format : str + Prepended dump string for each log event. Specifies the log event + level, the module emitting the event, the code line, the enclosing + function name, and the MPI rank writing the message. + date_format : str + Prepends the date before all log event messages. + formatter : logging.Formatter + Formatter handling the prepending of the information in `format` and + `date_format` to each log event message. Used by default for all + loggers. + rank0 : logging.Logger + Default logger object for the root MPI rank. + all_ranks : logging.Logger + Default logger object for messages being emitted from all MPI ranks + simultaneously. + """ + + level = None + log_file = None + format = " %(levelname)-8s [%(filename)s:%(lineno)d] <%(funcName)s> {rank %(rank)d/%(size)d} %(message)s" # noqa: E501 + date_format = "%(asctime)s" + formatter = logging.Formatter(fmt=date_format + format) + rank0 = logging.getLogger("HyMD.rank_0") + all_ranks = logging.getLogger("HyMD.all_ranks") + +
[docs] @classmethod + def setup(cls, default_level=logging.INFO, log_file=None, verbose=False, comm=MPI.COMM_WORLD): + """Sets up the logger object. + + If a :code:`log_file` path is provided, log event messages are output + to it. Otherwise, the logging messages are emitted to stdout. + + Parameters + ---------- + default_level : int, optional + Default verbosity level of the logger. Unless specified, it is + :code:`10` (:code:`logging.INFO`). + log_file : str, optional + Path to output log file. If `None` or not priovided, no log file is + used and all logging is done to stdout. + verbose : bool, optional + Increases the logging level to :code:`30` (:code:`logging.WARNING`) + if True, otherwise leaves the logging level unchanged. + """ + cls.level = default_level + cls.log_file = log_file + + log_to_stdout = False + if verbose: + log_to_stdout = True + + level = default_level + if not verbose: + level = logging.WARNING + cls.rank0.setLevel(level) + cls.all_ranks.setLevel(level) + + root_filter = MPIFilterRoot(comm) + all_filter = MPIFilterAll(comm) + cls.rank0.addFilter(root_filter) + cls.all_ranks.addFilter(all_filter) + + if (not log_file) and (not log_to_stdout): + return + if log_file: + cls.log_file_handler = logging.FileHandler(log_file) + cls.log_file_handler.setLevel(level) + cls.log_file_handler.setFormatter(cls.formatter) + + cls.rank0.addHandler(cls.log_file_handler) + cls.all_ranks.addHandler(cls.log_file_handler) + if log_to_stdout: + cls.log_to_stdout = True + cls.stdout_handler = logging.StreamHandler() + cls.stdout_handler.setLevel(level) + cls.stdout_handler.setStream(sys.stdout) + cls.stdout_handler.setFormatter(cls.formatter) + cls.stdout_handler.addFilter(MPIFilterStdout()) + + cls.rank0.addHandler(cls.stdout_handler) + cls.all_ranks.addHandler(cls.stdout_handler)
+ + +def format_timedelta(timedelta): + days = timedelta.days + hours, rem = divmod(timedelta.seconds, 3600) + minutes, seconds = divmod(rem, 60) + microseconds = timedelta.microseconds + ret_str = "" + if days != 0: + ret_str += f"{days} days " + ret_str += f"{hours:02d}:{minutes:02d}:{seconds:02d}.{microseconds:06d}" + return ret_str + + +def get_version(): + # Check if we are in a git repo and grab the commit hash and the branch if + # we are, append it to the version number in the output specification. + try: + import git + + try: + repo_dir = os.path.abspath( + os.path.join(os.path.dirname(__file__), os.pardir) + ) + repo = git.Repo(repo_dir) + commit = str(repo.head.commit)[:7] + branch = repo.active_branch + version = f"{__version__} [{branch} branch commit {commit}]" + except git.exc.InvalidGitRepositoryError: + version = f"{__version__}" + except ModuleNotFoundError: + version = f"{__version__}" + + return version + + +def print_header(): + banner = r""" + __ __ ____ __ _______ + / / / /_ __/ / /__ _________ _____ ______ / |/ / __ \ + / /_/ / / / / / / _ \/ ___/ __ `/ __ `/ ___/ / /|_/ / / / / + / __ / /_/ / / / __/ / / /_/ / /_/ (__ ) / / / / /_/ / + /_/ /_/\__, /_/_/\___/_/ \__,_/\__,_/____/ /_/ /_/_____/ + /____/ + """ + + refs_set = """ + + [1] Ledum, M.; Sen, S.; Li, X.; Carrer, M.; Feng Y.; Cascella, M.; Bore, S. L. + HylleraasMD: A Domain Decomposition-Based Hybrid Particle-Field Software for Multi-Scale Simulations of Soft Matter. + J. Chem. Theory Comput. 2023. + + [2] Ledum, M.; Carrer, M.; Sen, S.; Li, X.; Cascella, M.; Bore, S. L. + HyMD: Massively parallel hybrid particle-field molecular dynamics in Python. + J. Open Source Softw. 8(84), 4149, 2023. + + [3] Sen, S.; Ledum, M.; Bore, S. L.; Cascella, M. + Soft Matter under Pressure: Pushing Particle–Field Molecular Dynamics to the Isobaric Ensemble. + J Chem Inf Model 2023, 63(7), 1549-9596. + + [4] Bore, S. L.; Cascella, M. + Hamiltonian and alias-free hybrid particle–field molecular dynamics. + J. Chem. Phys. 2020, 153, 094106. + + [5] Pippig, M. PFFT: An extension of FFTW to massively parallel architectures. + SIAM J. Sci. Comput. 2013, 35, C213–C236. + +""" + + version = f"Version {get_version()}" + header = banner + header += version.center(56) + "\n\n" + #header += " Please read and cite the references below:" + header += " PLEASE READ AND CITE THE REFERENCES BELOW:" + header += refs_set + + return header +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/_modules/hymd/thermostat.html b/v1.0.4/_modules/hymd/thermostat.html new file mode 100644 index 00000000..a889237b --- /dev/null +++ b/v1.0.4/_modules/hymd/thermostat.html @@ -0,0 +1,492 @@ + + + + + + hymd.thermostat — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.thermostat

+"""Scales or otherwise modifies the particle velocities during simulation to
+simulate coupling to an external heat bath with temperature T₀.
+"""
+import numpy as np
+import logging
+from mpi4py import MPI
+from typing import Callable
+from .logger import Logger
+from .input_parser import Config
+
+
+def cancel_com_momentum(velocities, config, comm=MPI.COMM_WORLD):
+    com_velocity = comm.allreduce(np.sum(velocities[...], axis=0), MPI.SUM)
+    velocities[...] = velocities[...] - com_velocity / config.n_particles
+    return velocities
+
+
+def generate_initial_velocities(velocities, config, prng, comm=MPI.COMM_WORLD):
+    kT_start = config.gas_constant * config.start_temperature
+    n_particles_ = velocities.shape[0]
+    velocities[...] = prng.normal(
+        loc=0, scale=kT_start / config.mass, size=(n_particles_, 3)
+    )
+    velocities = cancel_com_momentum(velocities, config, comm=comm)
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    start_kinetic_energy_target = (
+        1.5 * config.gas_constant * config.n_particles * config.start_temperature
+    )
+    factor = np.sqrt(1.5 * config.n_particles * kT_start / kinetic_energy)
+    velocities[...] = velocities[...] * factor
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    Logger.rank0.log(
+        logging.INFO,
+        (
+            f"Initialized {config.n_particles} velocities, target kinetic "
+            f"energy: {start_kinetic_energy_target}, actual kinetic energy "
+            f"generated: {kinetic_energy}"
+        ),
+    )
+    return velocities
+
+
+
[docs]def _random_gaussian(prng: np.random.Generator) -> float: + """Draw a single random number from the standard normal distribution + Generate a number from the Gaussian distribution centered at zero with unit + standard deviation, :math:`N(0, 1)`. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + + Returns + ------- + float + A random number drawn from :math:`N(0, 1)`. + """ + return prng.normal()
+ + +
[docs]def _random_chi_squared(prng: np.random.Generator, M: int) -> float: + """Draw the sum of :code:`M` squared normally distributed values + + The value is generated by the Gamma distribution, in lieu of generating + :code:`M` Gaussian distributed numbers and summing their squares. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + M : int + Number of standard normally distributed numbers in the sum. + + Returns + ------- + float + The sum of :code:`M` squared normally distributed values centered at + zero with unit standard deviation. + + Notes + ----- + The sum of the squares of k independent standard normal random variables is + distributed according to a :math:`\\chi^2` distribution. + + .. math:: + + \\chi^2_1 + \\chi_2^2 + \\chi_3^2 + \\dots + \\chi_M^2 + \\sim + \\sigma^2\\chi^2(k) + + This is a special case of the :math:`\\Gamma` distribution, + :math:`\\Gamma(k/2, 2)`, and may be generated by + + .. math:: + + \\chi^2(k) \\sim 2 \\Gamma(k/2, 2) + + References + ---------- + Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of + Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. + J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246. + """ + return prng.chisquare(M)
+ + +
[docs]def csvr_thermostat( + velocity: np.ndarray, + names: np.ndarray, + config: Config, + prng: np.random.Generator, + comm: MPI.Intracomm = MPI.COMM_WORLD, + random_gaussian: Callable[[np.random.Generator], float] = _random_gaussian, + random_chi_squared: Callable[ + [np.random.Generator, int, float], float + ] = _random_chi_squared, + remove_center_of_mass_momentum: bool = True, +) -> np.ndarray: + """Canonical sampling through velocity rescaling thermostat + + Implements the CSVR thermostat. Rescales the system kinetic energy by a + stochastically chosen factor to keep the temperature constant. Requires + communcation of the kinetic energies calculated locally for each MPI rank. + The random numbers sampled through :code:`random_gaussian` and + :code:`random_chi_squared` are broadcast from the root rank to the other + ranks to ensure the scaling is performed with the same stochasticity for + all particles in the full system. + + The velocities are cleaned of center of mass momentum before the thermostat + is applied, and the center of mass momentum is subsequently reapplied. This + is performed for each thermostat coupling group, i.e. the center of mass + momenta of each *group* is separately removed and reapplied after + thermostatting. + + The implementation here is based on the derivation presented in the 2008 + Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper. + + Parameters + ---------- + velocity : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + names : (N,) numpy.ndarray + Array of particle names. + config : Config + Configuration dataclass containing simulation metadata and parameters. + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + random_gaussian : callable, optional + Function for generating standard normally distributed numbers. + random_chi_squared : callable, optional + Function for generating :math:`\\chi^2`-distributed numbers + remove_center_of_mass_momentum : bool, optional + If True, the center of mass of each coupling group is removed before + the thermostat is applied. The center of mass momenta are added back + after the kinetic energy rescaling is complete. + + See Also + -------- + _random_gaussian : + Used to sample Gaussian-distributed numbers. + _random_chi_squared : + Used to sample :math:`\\chi^2`-distributed numbers. + hymd.input_parser.Config : + Configuration dataclass handler. + + References + ---------- + G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). + G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008). + """ + if not any(config.thermostat_coupling_groups): + config.thermostat_coupling_groups = [config.unique_names.copy()] + for i, group in enumerate(config.thermostat_coupling_groups): + ind = np.where( + np.logical_or.reduce(list(names == np.string_(t) for t in group)) + ) + group_n_particles = comm.allreduce(len(ind[0]), MPI.SUM) + + # Clean velocities of center of mass momentum + if remove_center_of_mass_momentum and group_n_particles > 1: + com_velocity = comm.allreduce(np.sum(velocity[ind], axis=0)) + velocity_clean = velocity[ind] - com_velocity / group_n_particles + K = comm.allreduce(0.5 * config.mass * np.sum(velocity_clean[...] ** 2)) + else: + K = comm.allreduce(0.5 * config.mass * np.sum(velocity[...] ** 2)) + K_target = ( + 1.5 * config.gas_constant * group_n_particles * config.target_temperature + ) + N_f = 3 * group_n_particles + c = np.exp(-(config.time_step * config.respa_inner) / config.tau) + + # Random numbers are identical across ranks because all ranks have + # the same prng after the initialization of the velocities + R = random_gaussian(prng) + SNf = random_chi_squared(prng, N_f - 1) + + alpha2 = ( + c + + (1 - c) * (SNf + R**2) * K_target / (N_f * K) + + 2 * R * np.sqrt(c * (1 - c) * K_target / (N_f * K)) + ) + dK = K * (alpha2 - 1) + alpha = np.sqrt(alpha2) + + if remove_center_of_mass_momentum and group_n_particles > 1: + # Assign velocities and reapply the previously removed center + # of mass momentum removed + velocity_clean *= alpha + velocity[ind] = velocity_clean + com_velocity / group_n_particles + else: + velocity *= alpha + config.thermostat_work += dK
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/_modules/index.html b/v1.0.4/_modules/index.html new file mode 100644 index 00000000..7693e06f --- /dev/null +++ b/v1.0.4/_modules/index.html @@ -0,0 +1,280 @@ + + + + + + Overview: module code — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+ +
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/v1.0.4/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css new file mode 100644 index 00000000..1b057df2 --- /dev/null +++ b/v1.0.4/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css @@ -0,0 +1 @@ +.badge{border-radius:.25rem;display:inline-block;font-size:75%;font-weight:700;line-height:1;padding:.25em .4em;text-align:center;vertical-align:baseline;white-space:nowrap}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{border-radius:10rem;padding-left:.6em;padding-right:.6em}.badge-primary{background-color:#007bff;color:#fff}.badge-primary[href]:focus,.badge-primary[href]:hover{background-color:#0062cc;color:#fff;text-decoration:none}.badge-secondary{background-color:#6c757d;color:#fff}.badge-secondary[href]:focus,.badge-secondary[href]:hover{background-color:#545b62;color:#fff;text-decoration:none}.badge-success{background-color:#28a745;color:#fff}.badge-success[href]:focus,.badge-success[href]:hover{background-color:#1e7e34;color:#fff;text-decoration:none}.badge-info{background-color:#17a2b8;color:#fff}.badge-info[href]:focus,.badge-info[href]:hover{background-color:#117a8b;color:#fff;text-decoration:none}.badge-warning{background-color:#ffc107;color:#212529}.badge-warning[href]:focus,.badge-warning[href]:hover{background-color:#d39e00;color:#212529;text-decoration:none}.badge-danger{background-color:#dc3545;color:#fff}.badge-danger[href]:focus,.badge-danger[href]:hover{background-color:#bd2130;color:#fff;text-decoration:none}.badge-light{background-color:#f8f9fa;color:#212529}.badge-light[href]:focus,.badge-light[href]:hover{background-color:#dae0e5;color:#212529;text-decoration:none}.badge-dark{background-color:#343a40;color:#fff}.badge-dark[href]:focus,.badge-dark[href]:hover{background-color:#1d2124;color:#fff;text-decoration:none}.border-0{border:0 !important}.border-top-0{border-top:0 !important}.border-right-0{border-right:0 !important}.border-bottom-0{border-bottom:0 !important}.border-left-0{border-left:0 !important}.p-0{padding:0 !important}.pt-0,.py-0{padding-top:0 !important}.pr-0,.px-0{padding-right:0 !important}.pb-0,.py-0{padding-bottom:0 !important}.pl-0,.px-0{padding-left:0 !important}.p-1{padding:.25rem !important}.pt-1,.py-1{padding-top:.25rem !important}.pr-1,.px-1{padding-right:.25rem !important}.pb-1,.py-1{padding-bottom:.25rem !important}.pl-1,.px-1{padding-left:.25rem !important}.p-2{padding:.5rem !important}.pt-2,.py-2{padding-top:.5rem !important}.pr-2,.px-2{padding-right:.5rem !important}.pb-2,.py-2{padding-bottom:.5rem !important}.pl-2,.px-2{padding-left:.5rem !important}.p-3{padding:1rem !important}.pt-3,.py-3{padding-top:1rem !important}.pr-3,.px-3{padding-right:1rem !important}.pb-3,.py-3{padding-bottom:1rem !important}.pl-3,.px-3{padding-left:1rem !important}.p-4{padding:1.5rem !important}.pt-4,.py-4{padding-top:1.5rem !important}.pr-4,.px-4{padding-right:1.5rem !important}.pb-4,.py-4{padding-bottom:1.5rem !important}.pl-4,.px-4{padding-left:1.5rem !important}.p-5{padding:3rem !important}.pt-5,.py-5{padding-top:3rem !important}.pr-5,.px-5{padding-right:3rem !important}.pb-5,.py-5{padding-bottom:3rem !important}.pl-5,.px-5{padding-left:3rem !important}.m-0{margin:0 !important}.mt-0,.my-0{margin-top:0 !important}.mr-0,.mx-0{margin-right:0 !important}.mb-0,.my-0{margin-bottom:0 !important}.ml-0,.mx-0{margin-left:0 !important}.m-1{margin:.25rem !important}.mt-1,.my-1{margin-top:.25rem !important}.mr-1,.mx-1{margin-right:.25rem !important}.mb-1,.my-1{margin-bottom:.25rem !important}.ml-1,.mx-1{margin-left:.25rem !important}.m-2{margin:.5rem !important}.mt-2,.my-2{margin-top:.5rem !important}.mr-2,.mx-2{margin-right:.5rem !important}.mb-2,.my-2{margin-bottom:.5rem !important}.ml-2,.mx-2{margin-left:.5rem !important}.m-3{margin:1rem !important}.mt-3,.my-3{margin-top:1rem !important}.mr-3,.mx-3{margin-right:1rem !important}.mb-3,.my-3{margin-bottom:1rem !important}.ml-3,.mx-3{margin-left:1rem !important}.m-4{margin:1.5rem !important}.mt-4,.my-4{margin-top:1.5rem !important}.mr-4,.mx-4{margin-right:1.5rem !important}.mb-4,.my-4{margin-bottom:1.5rem !important}.ml-4,.mx-4{margin-left:1.5rem !important}.m-5{margin:3rem !important}.mt-5,.my-5{margin-top:3rem !important}.mr-5,.mx-5{margin-right:3rem !important}.mb-5,.my-5{margin-bottom:3rem !important}.ml-5,.mx-5{margin-left:3rem !important}.btn{background-color:transparent;border:1px solid transparent;border-radius:.25rem;color:#212529;cursor:pointer;display:inline-block;font-size:1rem;font-weight:400;line-height:1.5;padding:.375rem .75rem;text-align:center;transition:color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none;vertical-align:middle}.btn:hover{color:#212529;text-decoration:none}.btn:visited{color:#212529}.btn.focus,.btn:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.25);outline:0}.btn.disabled,.btn:disabled{opacity:.65}@media (prefers-reduced-motion: reduce){.btn{transition:none}}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary:visited{color:#fff}.btn-primary:hover{background-color:#0069d9;border-color:#0062cc;color:#fff}.btn-primary.focus,.btn-primary:focus{background-color:#0069d9;border-color:#0062cc;box-shadow:0 0 0 .2rem rgba(0,123,255,0.5);color:#fff}.btn-primary.disabled,.btn-primary:disabled{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary.active:not(:disabled):not(.disabled),.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{background-color:#0062cc;border-color:#005cbf;color:#fff}.btn-primary.active:not(:disabled):not(.disabled):focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-secondary{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary:visited{color:#fff}.btn-secondary:hover{background-color:#5a6268;border-color:#545b62;color:#fff}.btn-secondary.focus,.btn-secondary:focus{background-color:#5a6268;border-color:#545b62;box-shadow:0 0 0 .2rem rgba(108,117,125,0.5);color:#fff}.btn-secondary.disabled,.btn-secondary:disabled{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled),.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{background-color:#545b62;border-color:#4e555b;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled):focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-success{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success:visited{color:#fff}.btn-success:hover{background-color:#218838;border-color:#1e7e34;color:#fff}.btn-success.focus,.btn-success:focus{background-color:#218838;border-color:#1e7e34;box-shadow:0 0 0 .2rem rgba(40,167,69,0.5);color:#fff}.btn-success.disabled,.btn-success:disabled{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success.active:not(:disabled):not(.disabled),.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{background-color:#1e7e34;border-color:#1c7430;color:#fff}.btn-success.active:not(:disabled):not(.disabled):focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-info{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info:visited{color:#fff}.btn-info:hover{background-color:#138496;border-color:#117a8b;color:#fff}.btn-info.focus,.btn-info:focus{background-color:#138496;border-color:#117a8b;box-shadow:0 0 0 .2rem rgba(23,162,184,0.5);color:#fff}.btn-info.disabled,.btn-info:disabled{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info.active:not(:disabled):not(.disabled),.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{background-color:#117a8b;border-color:#10707f;color:#fff}.btn-info.active:not(:disabled):not(.disabled):focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-warning{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning:visited{color:#212529}.btn-warning:hover{background-color:#e0a800;border-color:#d39e00;color:#212529}.btn-warning.focus,.btn-warning:focus{background-color:#e0a800;border-color:#d39e00;box-shadow:0 0 0 .2rem rgba(255,193,7,0.5);color:#212529}.btn-warning.disabled,.btn-warning:disabled{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning.active:not(:disabled):not(.disabled),.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{background-color:#d39e00;border-color:#c69500;color:#212529}.btn-warning.active:not(:disabled):not(.disabled):focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-danger{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger:visited{color:#fff}.btn-danger:hover{background-color:#c82333;border-color:#bd2130;color:#fff}.btn-danger.focus,.btn-danger:focus{background-color:#c82333;border-color:#bd2130;box-shadow:0 0 0 .2rem rgba(220,53,69,0.5);color:#fff}.btn-danger.disabled,.btn-danger:disabled{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger.active:not(:disabled):not(.disabled),.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{background-color:#bd2130;border-color:#b21f2d;color:#fff}.btn-danger.active:not(:disabled):not(.disabled):focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-light{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light:visited{color:#212529}.btn-light:hover{background-color:#e2e6ea;border-color:#dae0e5;color:#212529}.btn-light.focus,.btn-light:focus{background-color:#e2e6ea;border-color:#dae0e5;box-shadow:0 0 0 .2rem rgba(248,249,250,0.5);color:#212529}.btn-light.disabled,.btn-light:disabled{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light.active:not(:disabled):not(.disabled),.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{background-color:#dae0e5;border-color:#d3d9df;color:#212529}.btn-light.active:not(:disabled):not(.disabled):focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-dark{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark:visited{color:#fff}.btn-dark:hover{background-color:#23272b;border-color:#1d2124;color:#fff}.btn-dark.focus,.btn-dark:focus{background-color:#23272b;border-color:#1d2124;box-shadow:0 0 0 .2rem rgba(52,58,64,0.5);color:#fff}.btn-dark.disabled,.btn-dark:disabled{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark.active:not(:disabled):not(.disabled),.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{background-color:#1d2124;border-color:#171a1d;color:#fff}.btn-dark.active:not(:disabled):not(.disabled):focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-primary{border-color:#007bff;color:#007bff}.btn-outline-primary:visited{color:#007bff}.btn-outline-primary:hover{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{background-color:transparent;color:#007bff}.btn-outline-primary.active:not(:disabled):not(.disabled),.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.active:not(:disabled):not(.disabled):focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-secondary{border-color:#6c757d;color:#6c757d}.btn-outline-secondary:visited{color:#6c757d}.btn-outline-secondary:hover{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{background-color:transparent;color:#6c757d}.btn-outline-secondary.active:not(:disabled):not(.disabled),.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.active:not(:disabled):not(.disabled):focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-success{border-color:#28a745;color:#28a745}.btn-outline-success:visited{color:#28a745}.btn-outline-success:hover{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{background-color:transparent;color:#28a745}.btn-outline-success.active:not(:disabled):not(.disabled),.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.active:not(:disabled):not(.disabled):focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-info{border-color:#17a2b8;color:#17a2b8}.btn-outline-info:visited{color:#17a2b8}.btn-outline-info:hover{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{background-color:transparent;color:#17a2b8}.btn-outline-info.active:not(:disabled):not(.disabled),.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.active:not(:disabled):not(.disabled):focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-warning{border-color:#ffc107;color:#ffc107}.btn-outline-warning:visited{color:#ffc107}.btn-outline-warning:hover{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{background-color:transparent;color:#ffc107}.btn-outline-warning.active:not(:disabled):not(.disabled),.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.active:not(:disabled):not(.disabled):focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-danger{border-color:#dc3545;color:#dc3545}.btn-outline-danger:visited{color:#dc3545}.btn-outline-danger:hover{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{background-color:transparent;color:#dc3545}.btn-outline-danger.active:not(:disabled):not(.disabled),.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.active:not(:disabled):not(.disabled):focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-light{border-color:#f8f9fa;color:#f8f9fa}.btn-outline-light:visited{color:#f8f9fa}.btn-outline-light:hover{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{background-color:transparent;color:#f8f9fa}.btn-outline-light.active:not(:disabled):not(.disabled),.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.active:not(:disabled):not(.disabled):focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-dark{border-color:#343a40;color:#343a40}.btn-outline-dark:visited{color:#343a40}.btn-outline-dark:hover{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{background-color:transparent;color:#343a40}.btn-outline-dark.active:not(:disabled):not(.disabled),.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.active:not(:disabled):not(.disabled):focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-link{color:#007bff;font-weight:400;text-decoration:none}.btn-link:hover{color:#0056b3;text-decoration:underline}.btn-link.focus,.btn-link:focus{box-shadow:none;text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{border-radius:.3rem;font-size:1.25rem;line-height:1.5;padding:.5rem 1rem}.btn-group-sm>.btn,.btn-sm{border-radius:.2rem;font-size:.875rem;line-height:1.5;padding:.25rem .5rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input.btn-block[type=button],input.btn-block[type=reset],input.btn-block[type=submit]{width:100%}.stretched-link::after{background-color:rgba(0,0,0,0);bottom:0;content:'';left:0;pointer-events:auto;position:absolute;right:0;top:0;z-index:1}.text-wrap{white-space:normal !important}.card{background-clip:border-box;background-color:#fff;border:1px solid rgba(0,0,0,0.125);border-radius:.25rem;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;min-width:0;position:relative;word-wrap:break-word}.card>hr{margin-left:0;margin-right:0}.card>.list-group:first-child .list-group-item:first-child{border-top-left-radius:.25rem;border-top-right-radius:.25rem}.card>.list-group:last-child .list-group-item:last-child{border-bottom-left-radius:.25rem;border-bottom-right-radius:.25rem}.card-body{-ms-flex:1 1 auto;flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-bottom:0;margin-top:-.375rem}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{background-color:rgba(0,0,0,0.03);border-bottom:1px solid rgba(0,0,0,0.125);margin-bottom:0;padding:.75rem 1.25rem}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-header+.list-group .list-group-item:first-child{border-top:0}.card-footer{background-color:rgba(0,0,0,0.03);border-top:1px solid rgba(0,0,0,0.125);padding:.75rem 1.25rem}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{border-bottom:0;margin-bottom:-.75rem;margin-left:-.625rem;margin-right:-.625rem}.card-header-pills{margin-left:-.625rem;margin-right:-.625rem}.card-img-overlay{bottom:0;left:0;padding:1.25rem;position:absolute;right:0;top:0}.card-img,.card-img-bottom,.card-img-top{-ms-flex-negative:0;flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-left-radius:calc(.25rem - 1px);border-bottom-right-radius:calc(.25rem - 1px)}.w-100{width:100% !important}.shadow{box-shadow:0 0.5rem 1rem rgba(0,0,0,0.15) !important}.bg-primary{background-color:#007bff !important}button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc !important}a.bg-primary:focus,a.bg-primary:hover{background-color:#0062cc !important}a.text-primary:focus,a.text-primary:hover{color:#121416 !important}.bg-secondary{background-color:#6c757d !important}button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62 !important}a.bg-secondary:focus,a.bg-secondary:hover{background-color:#545b62 !important}a.text-secondary:focus,a.text-secondary:hover{color:#121416 !important}.bg-success{background-color:#28a745 !important}button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34 !important}a.bg-success:focus,a.bg-success:hover{background-color:#1e7e34 !important}a.text-success:focus,a.text-success:hover{color:#121416 !important}.bg-info{background-color:#17a2b8 !important}button.bg-info:focus,button.bg-info:hover{background-color:#117a8b !important}a.bg-info:focus,a.bg-info:hover{background-color:#117a8b !important}a.text-info:focus,a.text-info:hover{color:#121416 !important}.bg-warning{background-color:#ffc107 !important}button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00 !important}a.bg-warning:focus,a.bg-warning:hover{background-color:#d39e00 !important}a.text-warning:focus,a.text-warning:hover{color:#121416 !important}.bg-danger{background-color:#dc3545 !important}button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130 !important}a.bg-danger:focus,a.bg-danger:hover{background-color:#bd2130 !important}a.text-danger:focus,a.text-danger:hover{color:#121416 !important}.bg-light{background-color:#f8f9fa !important}button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5 !important}a.bg-light:focus,a.bg-light:hover{background-color:#dae0e5 !important}a.text-light:focus,a.text-light:hover{color:#121416 !important}.bg-dark{background-color:#343a40 !important}button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124 !important}a.bg-dark:focus,a.bg-dark:hover{background-color:#1d2124 !important}a.text-dark:focus,a.text-dark:hover{color:#121416 !important}.bg-white{background-color:#fff !important}button.bg-white:focus,button.bg-white:hover{background-color:#e6e6e6 !important}a.bg-white:focus,a.bg-white:hover{background-color:#e6e6e6 !important}a.text-white:focus,a.text-white:hover{color:#121416 !important}.text-primary{color:#007bff !important}.text-secondary{color:#6c757d !important}.text-success{color:#28a745 !important}.text-info{color:#17a2b8 !important}.text-warning{color:#ffc107 !important}.text-danger{color:#dc3545 !important}.text-light{color:#f8f9fa !important}.text-dark{color:#343a40 !important}.text-white{color:#fff !important}.text-body{color:#212529 !important}.text-muted{color:#6c757d !important}.text-black-50{color:rgba(0,0,0,0.5) !important}.text-white-50{color:rgba(255,255,255,0.5) !important}.bg-transparent{background-color:transparent !important}.text-justify{text-align:justify !important}.text-left{text-align:left !important}.text-right{text-align:right !important}.text-center{text-align:center !important}.font-weight-light{font-weight:300 !important}.font-weight-lighter{font-weight:lighter !important}.font-weight-normal{font-weight:400 !important}.font-weight-bold{font-weight:700 !important}.font-weight-bolder{font-weight:bolder !important}.font-italic{font-style:italic !important}.container{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container{max-width:540px}}@media (min-width: 768px){.container{max-width:720px}}@media (min-width: 992px){.container{max-width:960px}}@media (min-width: 1200px){.container{max-width:1140px}}.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container,.container-sm{max-width:540px}}@media (min-width: 768px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width: 992px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width: 1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1140px}}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;margin-right:-15px}.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{padding-left:15px;padding-right:15px;position:relative;width:100%}@media (min-width: 576px){.col-sm{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-sm-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-sm-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-sm-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-sm-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-sm-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 768px){.col-md{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-md-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-md-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-md-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-md-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-md-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 992px){.col-lg{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-lg-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-lg-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-lg-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-lg-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-lg-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 1200px){.col-xl{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-xl-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-xl-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-xl-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-xl-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-xl-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}.d-flex{display:-ms-flexbox !important;display:flex !important}.sphinx-bs,.sphinx-bs *{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sphinx-bs p{margin-top:0} diff --git a/v1.0.4/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/v1.0.4/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css new file mode 100644 index 00000000..fc14abc8 --- /dev/null +++ b/v1.0.4/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css @@ -0,0 +1 @@ +details.dropdown .summary-title{padding-right:3em !important;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none}details.dropdown:hover{cursor:pointer}details.dropdown .summary-content{cursor:default}details.dropdown summary{list-style:none;padding:1em}details.dropdown summary .octicon.no-title{vertical-align:middle}details.dropdown[open] summary .octicon.no-title{visibility:hidden}details.dropdown summary::-webkit-details-marker{display:none}details.dropdown summary:focus{outline:none}details.dropdown summary:hover .summary-up svg,details.dropdown summary:hover .summary-down svg{opacity:1}details.dropdown .summary-up svg,details.dropdown .summary-down svg{display:block;opacity:.6}details.dropdown .summary-up,details.dropdown .summary-down{pointer-events:none;position:absolute;right:1em;top:.75em}details.dropdown[open] .summary-down{visibility:hidden}details.dropdown:not([open]) .summary-up{visibility:hidden}details.dropdown.fade-in[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out;animation:panels-fade-in .5s ease-in-out}details.dropdown.fade-in-slide-down[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out}@keyframes panels-fade-in{0%{opacity:0}100%{opacity:1}}@keyframes panels-slide-down{0%{transform:translate(0, -10px)}100%{transform:translate(0, 0)}}.octicon{display:inline-block;fill:currentColor;vertical-align:text-top}.tabbed-content{box-shadow:0 -.0625rem var(--tabs-color-overline),0 .0625rem var(--tabs-color-underline);display:none;order:99;padding-bottom:.75rem;padding-top:.75rem;width:100%}.tabbed-content>:first-child{margin-top:0 !important}.tabbed-content>:last-child{margin-bottom:0 !important}.tabbed-content>.tabbed-set{margin:0}.tabbed-set{border-radius:.125rem;display:flex;flex-wrap:wrap;margin:1em 0;position:relative}.tabbed-set>input{opacity:0;position:absolute}.tabbed-set>input:checked+label{border-color:var(--tabs-color-label-active);color:var(--tabs-color-label-active)}.tabbed-set>input:checked+label+.tabbed-content{display:block}.tabbed-set>input:focus+label{outline-style:auto}.tabbed-set>input:not(.focus-visible)+label{outline:none;-webkit-tap-highlight-color:transparent}.tabbed-set>label{border-bottom:.125rem solid transparent;color:var(--tabs-color-label-inactive);cursor:pointer;font-size:var(--tabs-size-label);font-weight:700;padding:1em 1.25em .5em;transition:color 250ms;width:auto;z-index:1}html .tabbed-set>label:hover{color:var(--tabs-color-label-active)} diff --git a/v1.0.4/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css b/v1.0.4/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css new file mode 100644 index 00000000..adc61662 --- /dev/null +++ b/v1.0.4/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css @@ -0,0 +1,7 @@ +:root { +--tabs-color-label-active: hsla(231, 99%, 66%, 1); +--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); +--tabs-color-overline: rgb(207, 236, 238); +--tabs-color-underline: rgb(207, 236, 238); +--tabs-size-label: 1rem; +} \ No newline at end of file diff --git a/v1.0.4/_sources/doc_pages/api.rst.txt b/v1.0.4/_sources/doc_pages/api.rst.txt new file mode 100644 index 00000000..c9f8837b --- /dev/null +++ b/v1.0.4/_sources/doc_pages/api.rst.txt @@ -0,0 +1,90 @@ +.. _api-label: + + +API reference +============= + +Integrator +---------- + +.. automodule:: hymd.integrator + :members: + + +Thermostat +---------- + +.. automodule:: hymd.thermostat + :members: csvr_thermostat, _random_chi_squared, _random_gaussian + :undoc-members: + + +Hamiltonian +----------- + +.. autoclass:: hymd.hamiltonian.Hamiltonian + :members: + + .. automethod:: __init__ + + .. automethod:: _setup + +.. autoclass:: hymd.hamiltonian.SquaredPhi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultNoChi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultWithChi + :members: + + .. automethod:: __init__ + + +Force +----- + +.. automodule:: hymd.force + :members: + :undoc-members: + + +Logger +------ + +.. autoclass:: hymd.logger.Logger + :members: + +.. autoclass:: hymd.logger.MPIFilterRoot + :members: + +.. autoclass:: hymd.logger.MPIFilterAll + :members: + + +Input parser +------------ + +.. automodule:: hymd.input_parser + :members: + :undoc-members: propensity_potential_coeffs + + +Field +----- + +.. automodule:: hymd.field + :members: + + +File input/output +----------------- + +.. automodule:: hymd.file_io + :members: diff --git a/v1.0.4/_sources/doc_pages/benchmarks.rst.txt b/v1.0.4/_sources/doc_pages/benchmarks.rst.txt new file mode 100644 index 00000000..06377a85 --- /dev/null +++ b/v1.0.4/_sources/doc_pages/benchmarks.rst.txt @@ -0,0 +1,93 @@ +.. _benchmarks-label: + +Benchmarks +########## +Homopolymer melt test systems of :math:`30^2`, :math:`40^2`, and :math:`50^2` +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively. + +Bonded forces +^^^^^^^^^^^^^ +Legend label denotes the number of particles in the system. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) + time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 + ], dtype=np.float64) + nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 + ], dtype=np.float64,) + time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, + ], dtype=np.float64) + nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 + ], dtype=np.float64) + time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, + ], dtype=np.float64) + plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" + ) + plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" + ) + plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" + ) + plt.xlabel("CPUs", fontsize=15) + plt.ylabel("Time per step, us", fontsize=15) + plt.legend(fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.show() + + +Particle--field forces +^^^^^^^^^^^^^^^^^^^^^^ +Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + + mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] + mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + + mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + + mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + + mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] + mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + + mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + + mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + + plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") + plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") + plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") + plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") + plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") + plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") + plt.xlabel("CPUs", fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.ylabel("Time per step, s", fontsize=15) + plt.legend(loc="upper left", fontsize=15) + plt.show() diff --git a/v1.0.4/_sources/doc_pages/command_line.rst.txt b/v1.0.4/_sources/doc_pages/command_line.rst.txt new file mode 100644 index 00000000..5233710f --- /dev/null +++ b/v1.0.4/_sources/doc_pages/command_line.rst.txt @@ -0,0 +1,120 @@ +.. _commandline-label: + +Command line arguments +###################### +Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle--field interactions. + + +Required arguments +================== +:configuration file: + :code:`type` positional + + Specifies the :code:`.toml` format configuration file containing simulation details. See :ref:`config-label` for details. + +:structure and topology file: + :code:`type` positional + + Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See :ref:`topology-label` for details. + +Optional arguments +================== +:code:`-v --verbose` + :code:`type` optional + + Number of following arguments: :code:`0` or :code:`1` + + Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying :code:`-v` or :code:`--verbose` with no additional specification. This increases verbosity level by :code:`1`. Alternatively, it maye be specified by :code:`--verbose V` with :code:`V` being :code:`0`, :code:`1`, or :code:`2`. + +:code:`--profile` + :code:`type` optional + + Number of following arguments: :code:`0` + + Enables code profiling using :code:`cProfile`. This will output one profiling file per MPI rank invoked in the simulation. + +:code:`--double-precision` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision internally in HyMD (including in the FFTs). + +:code:`--double-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision in the output trajectory from HyMD. + +:code:`--velocity-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that velocities should be output to the HyMD trajectory. + +:code:`--force-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that forces should be output to the HyMD trajectory. + +:code:`--disable-mpio` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult. + +:code:`--logfile` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the path of a plain text log file in which stdout is mirrored during simulation runs. + +:code:`--seed` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the random seed used in the :code:`numpy` random library to generate velocities, thermostatting, etc. + +:code:`--disable-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any two-particle bonds present in the system. + +:code:`--disable-angle-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any three-particle bonds present in the system. + +:code:`--disable-dihedrals` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any four-particle bonds present in the system. + +:code:`--disable-dipole` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any topological reconstruction of peptide backbone dipoles present in the system. + +:code:`--disable-field` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any particle--field interactions present in the system. diff --git a/v1.0.4/_sources/doc_pages/config_file.rst.txt b/v1.0.4/_sources/doc_pages/config_file.rst.txt new file mode 100644 index 00000000..40ee0479 --- /dev/null +++ b/v1.0.4/_sources/doc_pages/config_file.rst.txt @@ -0,0 +1,194 @@ +.. _config-label: + +Configuration file +################## +The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order. + +The configuration file is a `toml`_ format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs. + +.. _`toml`: + https://github.com/toml-lang/toml + +.. role:: required + +Configuration file keywords +--------------------------- + +The following constitutes every possible keyword specification in HyMD +configuration files: + +Metadata keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying metadata for the H5MD output trajectory. + +:name: + :code:`string` [**optional**, default: :code:`None`] + + Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file. + + +:tags: + :code:`array` [:code:`string`] [**optional**, default: :code:`None`] + + Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file. + + +Particle keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying properties of particles and molecules in the +system. + +:n_particles: + :code:`integer` [**optional**, default: :code:`None`] + + Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules. + +:mass: + :code:`float` [**optional**, default: :code:`72.0`] {units: :math:`\text{u}=\text{g}\,\text{mol}^{-1}`} + + Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal. + +:max_molecule_size: + :code:`integer` [**optional**, default: :code:`201`] + + Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code **will** crash if there are molecules larger than :code:`max_molecule_size` in the topology/structure input file. + + +Simulation keywords +^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying simulation parameters. + +:n_steps: + :code:`integer` [:required:`required`] + + Total number of integration steps to perform for this simulation. + +:n_print: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of *number of time steps*). + +:n_flush: + :code:`integer` [**optional**, default: :code:`None`] + + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of *number of* :code:`n_print`, i.e. :code:`n_print = 13`, :code:`n_flush = 3` would result in the trajectory/energy being written to disk every :code:`13 x 3 = 39` *simulation steps*) + +:time_step: + :code:`float` [:required:`required`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time step per integration step. If the rRESPA multiple time step integrator is used (:code:`integrator = "respa"`), this specifies the **inner** time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is :code:`respa_inner` times the :code:`time_step` , and the total simulation time is :code:`n_steps` times :code:`time_step` times :code:`respa_inner` . + +:box_size: + :code:`array` [:code:`float`] [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable. + +:integrator: + :code:`string` [:required:`required`] (options: :code:`velocity-verlet` or :code:`respa`) + + Specifies the time integrator used in the simulation. If :code:`respa`, the *reversible reference system propagator algorithm (rRESPA)* :cite:`tuckerman1992reversible` integrator is used, with :code:`respa_inner` number of inner (intramolecular force) time steps. If :code:`velocity-verlet`, a normal Velocity Verlet integrator is used. If :code:`respa` and :code:`respa_inner = 1`, the rRESPA integrator is equivalent to the Velocity Verlet. + +:respa_inner: + :code:`integer` [**optional**, default: :code:`1`] + + The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces. + +:domain_decomposition: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Specifies the interval (in time steps) of *domain decomposition exchange*, involving all MPI ranks sending and receiving particles according to the particles' positions in the integration box and the MPI ranks' assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If :code:`True`, the decomposition is performed once (before starting the simulation). If :code:`False`, no decomposition is performed. + +:cancel_com_momentum: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + If :code:`True`, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every :code:`remove_com_momentum` time steps. If :code:`False`, the linear momentum is never removed. + +:start_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at :code:`start_temperature` Kelvin prior to starting the simulation. If :code:`False`, the velocities are not changed before starting the simulation. + +:target_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Couple the system to a heat bath at :code:`target_temperature` Kelvin by applying a *Canonical sampling through velocity rescaling* :cite:`Bussi2007JCP` thermostat with coupling strength :code:`tau`. If :code:`False`, no temperature control is applied. + +:tau: + :code:`float` [**optional**, default: :code:`0.7`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the CSVR thermostat coupling. In the limit of :code:`tau → ∞`, the Hamiltonian dynamics are preserved and no temperature coupling takes place. + +:thermostat_coupling_groups: + :code:`array` [:code:`array` [:code:`string`]] [**optional**, default: :code:`[]`] + + Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and :code:`"C"` type particles, :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would thermalise types :code:`"A"` and :code:`"B"` together and couple :code:`"C"` type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. :code:`target_temperature` Kelvin). +:hamiltonian: + :code:`string` [**optional**, default: :code:`"DefaultNohChi"`] (options: :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`) + + Specifies the interaction energy functional :math:`W[\tilde\phi]` for use with the particle-field interactions. See :ref:`functionals-label` for details. + + +Field keywords +^^^^^^^^^^^^^^ +Configuration keywords specifying field parameters. + +:mesh_size: + :code:`array` [:code:`integer`] or :code:`integer` [:required:`required`] + + Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is :code:`box_size / mesh_size`. + +:kappa: + :code:`float` [:required:`required`] {units: :math:`\text{kJ}^{-1}\text{mol}`} + + Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional :math:`W[\tilde\phi]`. See :ref:`functionals-label` for more details. + +:sigma: + :code:`float` [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See :ref:`filtering-label` for more details. + +:chi: + :code:`array` [:code:`array` [:code:`string`, :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}`} + + Array of :math:`\tilde\chi_\text{AB}`-parameters indicating the strength of the repulsive or attractive interaction between particles of type :code:`"A"` and the number density due to particles of type :code:`"B"`, and vice versa. Example: :code:`chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ]` would specify a repulsive :code:`"A"`--:code:`"B"` type interaction, and a weakly attractive :code:`"C"`--:code:`"D"` interaction. Self-interaction :math:`\tilde\chi`-terms are always zero. See :ref:`functionals-label` for more details. + + +Bond keywords +^^^^^^^^^^^^^ +Configuration keywords specifying bonds and bonds parameters. + +:bonds: + :code:`array` [:code:`array` [2 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{nm}=10^{-9}~\text{m}` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: :code:`bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ]` indicates a :code:`"A"`--:code:`"A"` bond of equilibrium length :code:`0.47` :math:`\text{nm}` with a bond strength of :code:`980.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding bond between :code:`"A"` and :code:`"B"` type particles with equilibrium length :code:`0.31` :math:`\text{nm}` and a strength of :code:`1250.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify stretching bonds. + +:angle_bonds: + :code:`array` [:code:`array` [3 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`{}^\circ` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: :code:`bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ]` indicates a :code:`"A"`--:code:`"A"`--:code:`"A"` angular bond that tries to keep the bond linear at :code:`180` degrees with a bending strength of :code:`55.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding angle bond between :code:`"A"`--:code:`"B"`--:code:`"B"` prefering the angle at :code:`120` degrees and a strength of :code:`25.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify angular bonds. + +:dihedrals: + :code:`array` [:code:`array` [4 :code:`string`, :code:`integer`, :code:`COSINE SERIES` ]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`} + + Specifies four-particle torsional potentials by cosine series. See :ref:`bonds-label` for details about how to specify dihedrals. + + + +Electrostatic keywords +^^^^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying electrostatics and electrostatic parameters. + +:coulombtype: + :code:`string` [**optional**, default: :code:`None`] (options: :code:`PIC_Spectral`) + + Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the :code:`dielectric_const` keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, *not* in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to `PIC_Spectral`. + +:dielectric_const: + :code:`float` [**optional**, default: :code:`None`] + + Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified---even if electrostatics are not included with the :code:`coulombtype` keyword. diff --git a/v1.0.4/_sources/doc_pages/constants_and_units.rst.txt b/v1.0.4/_sources/doc_pages/constants_and_units.rst.txt new file mode 100644 index 00000000..ee429829 --- /dev/null +++ b/v1.0.4/_sources/doc_pages/constants_and_units.rst.txt @@ -0,0 +1,80 @@ +.. _units-label: + +Constants and Units +################### + +HyMD uses the following units and constants internally and in all input and +output: + +.. list-table:: **Units** + :widths: 30 10 75 + :header-rows: 1 + + * - Quantity + - Symbol + - Unit + * - length + - :math:`r` + - :math:`\text{nm}=10^{-9}~\text{m}` + * - time + - :math:`t` + - :math:`\text{ps}=10^{-12}~\text{s}` + * - charge + - :math:`q` + - :math:`e=1.602176634 \cdot 10^{-19}~\text{C}` + * - mass + - :math:`m` + - :math:`\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}` + * - temperature + - :math:`\text{T}` + - :math:`\text{K}` + * - energy + - :math:`E` + - :math:`\text{kJ}\,\text{mol}^{-1}` + * - velocity + - :math:`v` + - :math:`\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}` + * - momentum + - :math:`P` + - :math:`\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}` + * - force + - :math:`\mathbf{F}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}` + * - pressure + - :math:`p` + - :math:`\text{bar}=100~\text{kPa}` + * - electric potential + - :math:`\Psi` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}` + * - electric field + - :math:`\mathbf{E}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}` + * - compressibility + - :math:`\kappa` + - :math:`\text{mol}\,\text{kJ}^{-1}` + * - field-interaction + - :math:`\tilde\chi` + - :math:`\text{kJ}\,\text{mol}^{-1}` + +.. list-table:: **Constants** + :widths: 30 10 75 + :header-rows: 1 + + * - Constant + - Symbol + - Value + * - gas constant + - :math:`R` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Boltzmann’s constant + - :math:`k_\text{B}` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Avogadro's constant + - :math:`N_\text{A}` + - :math:`6.02214076 \cdot 10^23~\text{mol}^{-1}` + * - Vacuum permittivity + - :math:`\varepsilon_0` + - :math:`8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2` + * - Coulomb constant + - :math:`k_\text{e}` + - :math:`138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}` diff --git a/v1.0.4/_sources/doc_pages/electrostatics.rst.txt b/v1.0.4/_sources/doc_pages/electrostatics.rst.txt new file mode 100644 index 00000000..7e11c09d --- /dev/null +++ b/v1.0.4/_sources/doc_pages/electrostatics.rst.txt @@ -0,0 +1,48 @@ +.. _electrostatics-label: + +Electrostatic interactions +########################## +In the filtered Hamiltonian hPF formalism :cite:`bore2020hamiltonian` the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle--mesh Ewald. + +The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered + +.. math:: + + \tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i), + +with :math:`q_i` being the charge of particle :math:`i` and :math:`H` is the +filtering function (see :ref:`filtering-label`). The value of the charge grid at +vertex :math:`(i,j,k)` is found by + +.. math:: + + \tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)] + +and the electrostatic potential :math:`\Psi_{ijk}` + +.. math:: + + \Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right], + +where :math:`k_\text{e}` is the Coulomb constant :math:`1/4\pi\varepsilon_0`. +The *electric field* is obtained by differentiation of the electrostatic +potential in Fourier space, + +.. math:: + + \mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)] + +from which the forces are interpolated back to the particle positions. + +Specifying electrostatics +^^^^^^^^^^^^^^^^^^^^^^^^^ +In HyMD, electrostatics are specified by the :code:`coulombtype` and +:code:`dielectric_const` keywords in the configuration file (see +:ref:`config-label`) and the :code:`/charge` dataset in the HDF5 format +structure/topology input file (see :ref:`topology-label`). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions. diff --git a/v1.0.4/_sources/doc_pages/examples.rst.txt b/v1.0.4/_sources/doc_pages/examples.rst.txt new file mode 100644 index 00000000..9f9c3655 --- /dev/null +++ b/v1.0.4/_sources/doc_pages/examples.rst.txt @@ -0,0 +1,621 @@ +.. _examples-label: + +Examples +######## +The following examples are ordered in *more or less* order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the `HyMD-tutorial`_ github repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Ideal gas +========= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true + :align: right + :width: 200 + +The simplest possible system is one with no interactions at all---intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like: + + +.. code-block:: toml + :caption: **ideal_gas.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = false # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + +A simple input structure/topology file :code:`ideal_gas.HDF5` is available in +the `HyMD-tutorial/ideal_gas`_ github repository (along with the code to +generate it). Run the (very) short simulation by + +.. code:: bash + + python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field \ + --velocity-output \ + --force-output + +with the :code:`--disable-field` argument to completely turn off all +particle--field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook `ideal_gas.ipynb`_ for details. + + +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas +.. _ideal_gas.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.ipynb + + +Ideal chains +============ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true + :align: right + :width: 200 + +The simplest available interaction is the harmonic two-particle bond (see +:ref:`bonds-label`), + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2. + +Extending the configuration file from the ideal gas case, we need to add a +:code:`bonds` specification. Note that the :code:`[bonds]` meta specifier is not +necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **ideal_chain.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + +A simple input structure/topology file :code:`ideal_chain.HDF5` with a few +coiled up ideal chain polymers is available in the +`HyMD-tutorial/ideal_chain`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field + +we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +`ideal_chain.ipynb`_. + + +.. _HyMD-tutorial/ideal_chain: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_chain +.. _ideal_chain.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/ideal_chain.ipynb + + +Stiff rods +========== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true + :align: right + :width: 200 + +Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the :code:`i--j--k` angle :math:`\theta` (see +:ref:`bonds-label`), + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2. + +Extending the configuration file from the ideal chain case, we need to add a +:code:`angle_bonds` specification. Note that the :code:`[bonds]` meta specifier +is not necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **rods.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + + angle_bonds = [ + ["A", "A", "A", 180.0, 100.0], # (i, j, k, equilibrium angle, strength) + ] + + +A simple input structure/topology file :code:`rods.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook `rods.ipynb`_. + + +.. _HyMD-tutorial/rods: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/rods +.. _rods.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.ipynb + + + +Helixes +======= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true + :align: right + :width: 200 + +Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle :math:`\phi` between the +:code:`i--j--k` plane and the :code:`j--k--l` plane (see :ref:`bonds-label`), + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n). + +The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a :code:`dihedrals` keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the :code:`dielectric_const` +keyword even though we are not including electrostatic forces in the current +simulation. Note that the :code:`[bonds]` meta specifier is not necessary, but +may be used to help organise the input file. + +.. code-block:: toml + :caption: **helixes.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + dielectric_const = 15.0 + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.31, 10000.0], # (i name, j name, equilibrium length, strength) + ] + + dihedrals = [ + [ + ["A", "A", "A", "A"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0] + ], + ] + +A simple input structure/topology file :code:`helixes.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook `helixes.ipynb`_. + + +.. _HyMD-tutorial/helixes: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/helixes +.. _helixes.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.ipynb + + +Phase separation +================ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true + :align: right + :width: 200 + +The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types :code:`A` and :code:`B`. Using the Hamiltonian + +.. math:: + + \mathcal{H}=H_0+W + +with :math:`\tilde\chi`--dependent interactions defined by (specified in the +configuration file by :code:`hamiltonian = DefaultWithChi`): + +.. math:: + + W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2. + + +.. code-block:: toml + :caption: **phase_separation.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + + [field] + mesh_size = [20, 20, 20] # FFT grid size + sigma = 1.0 # filtering length scale in nm + kappa = 0.05 # compressibility in mol/kJ + chi = [ + ['A', 'B', 5.0], # (name i, name j, strength) + ] + +A simple input structure/topology file :code:`phase_separation.HDF5` containing +an equal number of :code:`A` type and :code:`B` type particles is available in +the `HyMD-tutorial/phase_separation`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd phase_separation.toml phase_separation.HDF5 + +we may examine the resulting trajectory. In the case of a low interaction +strength :math:`\tilde\chi` of :code:`5.0` (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to :code:`40.0` (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +`phase_separation.ipynb`_. + + +.. _HyMD-tutorial/phase_separation: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/phase_separation +.. _phase_separation.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/phase_separation.ipynb + + +Diblock copolymers +================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true + :align: right + :width: 200 + +Having introduced particle--field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive :math:`\tilde\chi`--interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the :code:`integrator = "respa"` keyword. Putting the pieces together, the +configuration file may look like the following: + +.. code-block:: toml + :caption: **copolymer.toml** + + [simulation] + integrator = "respa" + respa_inner = 15 + n_steps = 2000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [10.0, 10.0, 10.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [50, 50, 50] # FFT grid size + sigma = 0.5 # filtering length scale in nm + chi = [ + ["A", "B", 30.0], # (i, j, strength) + ] + + [bonds] + bonds = [ + ["A", "A", 0.25, 1500.0], # (i, j, equilibrium length, strength) + ["A", "B", 0.25, 1500.0], + ["B", "B", 0.25, 1500.0], + ] + angle_bonds = [ + ["A", "A", "A", 180.0, 25.0], # (i, j, k, equilibrium angle, strength) + ["B", "B", "B", 180.0, 25.0], + ] + +A simple input structure/topology file :code:`copolymer.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/copolymer`_ github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten :code:`A` followed by ten :code:`B` type particles. +Running the simulation with + +.. code:: bash + + python3 -m hymd copolymer.toml copolymer.HDF5 + +the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +`copolymer.ipynb`_. + + +.. _HyMD-tutorial/copolymer: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/copolymer +.. _copolymer.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer.ipynb + + +Lipid bilayer self-assembly +=========================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true + :align: right + :width: 300 + +Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field--particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the :code:`thermostat_coupling_groups` keyword. With parameters +optimised in :cite:`ledum2020automated`, the configuration file looks like: + + +.. code-block:: toml + :caption: **lipid_self_assembly.toml** + + [simulation] + integrator = "respa" + respa_inner = 25 + n_steps = 3000 + n_print = 200 + n_flush = 1 + time_step = 0.01 + box_size = [9.96924, 9.96924, 10.03970] + start_temperature = 323 + target_temperature = 323 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.05 + domain_decomposition = 10001 + cancel_com_momentum = true + max_molecule_size = 15 + thermostat_coupling_groups = [ + ["N", "P", "G", "C"], + ["W"], + ] + + [field] + mesh_size = [25, 25, 25] + sigma = 1.0 + chi = [ + ["C", "W", 42.24], + ["G", "C", 10.47], + ["N", "W", -3.77], + ["G", "W", 4.53], + ["N", "P", -9.34], + ["P", "G", 8.04], + ["N", "G", 1.97], + ["P", "C", 14.72], + ["P", "W", -1.51], + ["N", "C", 13.56], + ] + + [bonds] + bonds = [ + ["N", "P", 0.47, 1250.0], + ["P", "G", 0.47, 1250.0], + ["G", "G", 0.37, 1250.0], + ["G", "C", 0.47, 1250.0], + ["C", "C", 0.47, 1250.0], + ] + angle_bonds = [ + ["P", "G", "G", 120.0, 25.0], + ["P", "G", "C", 180.0, 25.0], + ["G", "C", "C", 180.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +A randomly mixed input structure/topology file +:code:`lipid_self_assembly.HDF5` with a few hundred lipids in a roughy +:code:`10 x 10 x 10nm` box is available in the +`HyMD-tutorial/lipid_self_assembly`_ github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation + +.. code:: bash + + python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5 + +we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook `lipid_self_assembly.ipynb`_. + + +.. _HyMD-tutorial/lipid_self_assembly: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/lipid_self_assembly +.. _lipid_self_assembly.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/lipid_self_assembly.ipynb + + +Peptide in lipid bilayer +======================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true + :align: right + :width: 300 + +Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer. + + +The `configuration file`_ is available in the `HyMD-tutorial/peptide`_ github +repository (omitted here for brevity). + +A pre-equilibrated input structure/topology file :code:`peptide.HDF5` with a +few hundred lipids in a roughy :code:`20 x 20 x 20nm` box is available in the +`HyMD-tutorial/peptide`_ github repository. Running the simulation + +.. code:: bash + + python3 -m hymd peptide.toml peptide.HDF5 + +we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook `peptide.ipynb`_. + + +.. _HyMD-tutorial/peptide: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/peptide +.. _configuration file: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.toml +.. _peptide.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.ipynb + + +SDS +=== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true + :align: right + :width: 300 + +The last part we introduce is explicit electrostatic interactions through +particle--mesh Ewald. Enabling the electrostatic calculations is done via the +:code:`coulombtype` keyword. :code:`"PIC_Spectral"` is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the :code:`dielectric_const` keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge. + + + +.. code-block:: toml + :caption: **sds.toml** + + [simulation] + integrator = "respa" + respa_inner = 10 + n_steps = 3000 + n_print = 1500 + n_flush = + time_step = 0.01 + box_size = [8.3, 8.3, 8.3] + start_temperature = 298 + target_temperature = 298 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.1 + domain_decomposition = 10000 + cancel_com_momentum = true + max_molecule_size = 5 + thermostat_coupling_groups = [ + ["S", "C"], + ["W", "Na"], + ] + dielectric_const = 45.0 # dielectric constant for the simulation medium + coulombtype = "PIC_Spectral" # particle in cloud, spectral method + + [field] + mesh_size = [64, 64, 64] + sigma = 0.5 + chi = [ + ["S", "C", 13.50], + ["S", "Na", 0.00], + ["S", "W", -3.60], + ["C", "Na", 13.50], + ["C", "W", 33.75], + ["W", "Na", 0.00], + ] + + [bonds] + bonds = [ + ["S", "C", 0.50, 1250.0], + ["C", "C", 0.50, 1250.0], + ] + angle_bonds = [ + ["S", "C", "C", 170.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +An input structure/topology file :code:`sds.HDF5` with a couple thousand +randomly dispersed SDS chains is available in the `HyMD-tutorial/sds`_ github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a :code:`/charge` dataset. +Running the simulation with + +.. code:: bash + + python3 -m hymd sds.toml sds.HDF5 + +we observe the aggregation of the SDS into micellular structures---first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook `sds.ipynb`_. + + +.. _HyMD-tutorial/sds: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/sds +.. _sds.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/sds.ipynb diff --git a/v1.0.4/_sources/doc_pages/filtering.rst.txt b/v1.0.4/_sources/doc_pages/filtering.rst.txt new file mode 100644 index 00000000..02af68c6 --- /dev/null +++ b/v1.0.4/_sources/doc_pages/filtering.rst.txt @@ -0,0 +1,30 @@ +.. _filtering-label: + +Filtering +######### +The default grid-independent filter function used in HyMD is a Gaussian + +.. math:: + + H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] + +with reciprocal space representation + +.. math:: + + \hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +The coarse-graining parameter :math:`\sigma` determines a length scale of +particle extent and is given as configuration file input by + +.. code:: toml + + sigma = 0.75 + + +Implementing new filters +^^^^^^^^^^^^^^^^^^^^^^^^ +Implementing new filter functions is straightforward by hijacking +the :code:`setup` method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional. diff --git a/v1.0.4/_sources/doc_pages/installation.rst.txt b/v1.0.4/_sources/doc_pages/installation.rst.txt new file mode 100644 index 00000000..773eb2f4 --- /dev/null +++ b/v1.0.4/_sources/doc_pages/installation.rst.txt @@ -0,0 +1,162 @@ +.. _installation-label: + +Installation +############ +HyMD may be installed using :code:`pip` by + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + + +Dependencies +============ +HyMD **requires** a working MPI compiler and HDF5. On an Ubuntu system, this +may be installed via + +.. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y libhdf5-openmpi-dev python3-mpi4py + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-cache-dir --no-binary=h5py h5py + +It is **highly recommended** to have MPI-enabled HDF5 and h5py. A +non-MPI-enabled h5py may be installed by simply + +.. code-block:: bash + + sudo apt-get update -y + sudo apt-get install libhdf5-serial-dev + python3 -m pip --upgrade install h5py + +A non-MPI-enabled HDF5 library with corresponding :code:`h5py` will work +(mostly), but is inconvenient and slow. Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +:code:`--disable-mpio` argument to HyMD, see :ref:`commandline-label`. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial. + +Install in docker +================= +A docker image with build essentials setup is available at `dockerhub`_ with tag +:code:`mortele/hymd`, + +.. code-block:: bash + + docker pull mortele/hymd:latest + docker run -it mortele/hymd + /app$ python3 -m pip install hymd + + # Grab example input files + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5 + + # Run simulation + /app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose + +.. _dockerhub: + https://hub.docker.com/repository/docker/mortele/hymd + + +Run interactively in Google Colaboratory +======================================== +A `Google Colaboratory`_ jupyter notebook is setup `here`_ with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Common issues +============= + +Numpy errors while importing the Fortran force kernels +------------------------------------------------------ + +.. code-block:: python + + RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd + + Traceback (most recent call last): + + (...) + + File "/..../HyMD/hymd/__init__.py", line 2, in + from .main import main # noqa: F401 + File "/..../HyMD/hymd/main.py", line 10, in + from .configure_runtime import configure_runtime + File "/..../hymd/configure_runtime.py", line 12, in + from .input_parser import read_config_toml, parse_config_toml + File "/..../HyMD/hymd/input_parser.py", line 12, in + from .force import Bond, Angle, Dihedral, Chi + File "/..../HyMD/hymd/force.py", line 8, in + from force_kernels import ( # noqa: F401 + ImportError: numpy.core.multiarray failed to import + +can normally be fixed by updating numpy versions, + +.. code-block:: bash + + python3 -m pip install -U numpy + + +Error building pfft-python due to missing curl/wget +--------------------------------------------------- + +.. code-block:: python + + Building wheel for pfft-python (setup.py) ... error + ERROR: Command errored out with exit status 1: + command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_ + cwd: /tmp/pip-install-fr6nt9m4/pfft-python/ + Complete output (56 lines): + running bdist_wheel + running build + running build_py + + (...) + + curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found + wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found + Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + Please check curl or wget + You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ + Traceback (most recent call last): + File "", line 1, in + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in + setup( + File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup + return distutils.core.setup(**attrs) + File "/usr/lib/python3.8/distutils/core.py", line 148, in setup + + (...) + + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions + build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:])) + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft + raise ValueError("could not build fftw; check MPICC?") + ValueError: could not build fftw; check MPICC? + ---------------------------------------- + ERROR: Failed building wheel for pfft-python + Running setup.py clean for pfft-python + Failed to build pfft-python + +can be fixed by installing either `curl`_ or `wget`_ + +.. code-block:: bash + + apt-get install -y curl wget + + +.. _`curl`: + https://curl.se/ + +.. _`wget`: + https://www.gnu.org/software/wget/ diff --git a/v1.0.4/_sources/doc_pages/interaction_energy_functionals.rst.txt b/v1.0.4/_sources/doc_pages/interaction_energy_functionals.rst.txt new file mode 100644 index 00000000..f33c004e --- /dev/null +++ b/v1.0.4/_sources/doc_pages/interaction_energy_functionals.rst.txt @@ -0,0 +1,98 @@ +.. _functionals-label: + +Interaction energy functionals +############################## +A few interaction energy functionals :math:`W` are defined in HyMD through +the :code:`Hamiltonian` class and associated subclasses. + +:math:`\chi`--interaction and :math:`\kappa`--incompressibility +=============================================================== +The most common hPF energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultWithChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where :math:`\tilde\chi_{\text{A}-\text{B}}` is the interaction energy between +overlapping densities of particle types :math:`\text{A}` and :math:`\text{B}`. +The incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\tilde\chi` +and :math:`\kappa` in the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + chi = [ + ["A", "B", 15.85], + ["B", "C", -5.70], + ... + ] + +Only :math:`\kappa`--incompressibility +====================================== +The only :math:`\kappa` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultNoChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where the incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Only :math:`\phi^2` +=================== +The :math:`\phi^2` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "SquaredPhi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2, + +where the :math:`\phi` squared term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Implementing new interaction energy forms +========================================= +Implementing new interaction energy functions is straightforward by subclassing +:code:`Hamiltonian` and applying :code:`sympy` differentiation to the symbolic +field objects. The :code:`sympy.lamdify` function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields. diff --git a/v1.0.4/_sources/doc_pages/intramolecular_bonds.rst.txt b/v1.0.4/_sources/doc_pages/intramolecular_bonds.rst.txt new file mode 100644 index 00000000..820e81bc --- /dev/null +++ b/v1.0.4/_sources/doc_pages/intramolecular_bonds.rst.txt @@ -0,0 +1,142 @@ +.. _bonds-label: + +Intramolecular bonds +#################### + +Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see :ref:`config-label`. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +:ref:`benchmarks-label`), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable. + +All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]). + + +Two-particle bonds +^^^^^^^^^^^^^^^^^^ +Stretching bonds in HyMD are implemented as harmonic spring potentials, + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2, + +where :math:`r=|\mathbf{r}|` is the inter-particle distance, :math:`k` is a +constant of dimension energy (units :math:`\text{kJ}\,\text{mol}^{-1}`), and +:math:`r_0` is the equilibrum length of the bond (units: :math:`\text{nm}`). The +force is calculated as + +.. math:: + + F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r}, + +where :math:`\mathbf{r}` is the vector pointing *from* :math:`i` *to* :math:`j`. + +In the configuration file, two-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_two_particle_example.toml + + [bonds] + bonds = [ + ["A", "A", 0.47, 1250.0], + ["A", "B", 0.37, 940.0], + ["B", "C", 0.50, 1010.0], + ["C", "A", 0.42, 550.0], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Three-particle bonds +^^^^^^^^^^^^^^^^^^^^ +Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle--particle--particle angle :math:`\theta`, + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2, + +where :math:`k` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}`), and :math:`\theta_0` is the equilibrum +angle of the bond (units: :math:`{}^\circ`). Defining the particles with labels +:math:`a`, :math:`b`, and :math:`c`, let :math:`\mathbf{r}_a` denote the vector +pointing from :math:`b` to :math:`a`, and correspondingly let +:math:`\mathbf{r}_c` point from :math:`b` to :math:`c`. The +:math:`a`--:math:`b`--:math:`c` may be computed through the law of Cosines, + +.. math:: + + \theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right] + +Then the force acting on :math:`a` and :math:`c` is + +.. math:: + + \mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a}, + + \mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c}, + +and + +.. math:: + + \mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c + +In the configuration file, three-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_three_particle_example.toml + + [bonds] + angle_bonds = [ + ["A", "A", "A", 180.0, 90.0], + ["A", "B", "A", 120.0, 55.0], + ["B", "C", "C", 30.0, 10.0], + ["C", "A", "B", 110.0, 25.5], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Four-particle bonds +^^^^^^^^^^^^^^^^^^^ +Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle :math:`\phi` between the +:math:`a`--:math:`b`--:math:`c` and :math:`b`--:math:`c`--:math:`d` planes, for +a dihedral bond quartet :math:`a`, :math:`b`, :math:`c`, and :math:`d`. The +potential takes the form + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n), + +where :math:`c_n` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`), and :math:`\phi_n` are +specified phase angles in the cosine series. + +In the configuration file, four-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_four_particle_example.toml + + [bonds] + dihedrals = [ + ["A", "B", "C", "D"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0], + ] diff --git a/v1.0.4/_sources/doc_pages/overview.rst.txt b/v1.0.4/_sources/doc_pages/overview.rst.txt new file mode 100644 index 00000000..0e4d6b65 --- /dev/null +++ b/v1.0.4/_sources/doc_pages/overview.rst.txt @@ -0,0 +1,166 @@ +.. _overview-label: + +================================ + Usage overview for HylleraasMD +================================ + +HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a `toml`_ format configuration file, along with a topology and structure +file specifying the input system in HDF5 format. + +.. _`toml`: + https://github.com/toml-lang/toml + +**Configuration file** + +The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a :code:`[5, 5, 5]` nm simulation box at 300 K may look like +the following: + +.. code-block:: toml + :caption: **config_simple_1.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "SquaredPhi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [30, 30, 30] # FFT grid size + sigma = 0.5 # filtering length scale in nm + +Note that for the version 1.0 release of HyMD, the :code:`[particles]`, +:code:`[simulation]`, and :code:`[field]` groups are optional specifiers for +structuring the configuration file. + +For a full specification of every recognised configuration keyword in HyMD, +please refer to :ref:`config-label`. + +**Topology and structure file** + +The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +:code:`N` particles may look like the following: + +.. code-block:: bash + :caption: **example_structure.HDF5** + + group / + # root group + + dataset /coordinates + # float32, shape (T, N, D,) + # Time steps of N rows of D dimensional coordinate data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /velocities + # float32, shape (T, N, D,) OPTIONAL + # Time steps of N rows of D dimensional velocity data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /bonds + # int32, shape (N, B,) OPTIONAL + # Each row i contains indices of the particles bonds from/to i + # B denotes the maximum bonds per particle + + dataset /indices + # int32, shape (N,) + # Index of each particle, 0--(N-1) + + dataset /molecules + # int32, shape (N,) + # Index of molecule each particle belongs to + # Used to construct bond network locally on MPI ranks + + dataset /names + # str10, shape (N,) + # Fixed size string array containing particle type names + + dataset /types + # int32, shape (N,) OPTIONAL + # Mapping of particle names to type indices + + +For a full specification of the topology and structure input file, see +:ref:`topology-label`. + +**Command line arguments** + +A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the :code:`config_simple_1.toml` and :code:`example_structure.HDF5` +files may look like the following: + +.. code-block:: bash + + mpirun -n ${MPI_NUM_RANKS} python3 -m hymd \ # HyMD executable + config_simple_1.toml \ # configuration file + example_structure.HDF5 \ # structure file + --logfile=log_out.txt \ # set logfile path + --seed 123456 \ # set random seed + --verbose 2 \ # set logging verbosity + --velocity-output # enable velocity in trajectory output + +For a full specification of all command line arguments, see +:ref:`commandline-label`. + +**More examples** + +For more thorough rundown and concrete usage examples, see +:ref:`examples-label`. + +Running parallel simulations +============================ +Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the **only** difference being how the python3 interpreter is +invoked. Prepending :code:`mpirun -n ${NPROCS}` to the usual +:code:`python3 -m hymd` runs the simulation with :code:`${NPROCS}` MPI ranks. + +Inputting + +.. code:: bash + + mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field + +sets up an example simulation of the `HyMD-tutorial/ideal_gas`_ system. For +more details about this system in particular, or other example simulations, see +the `HyMD-tutorial`_ repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas + + +Running tests +============= +Run serial code tests by + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd + cd hymd/ + python3 -m pip install pytest pytest-mpi + python3 -m pytest + +There is a small convenience script in :code:`hymd/` for running the MPI-enabled +tests, + +.. code-block:: bash + + chmod +x pytest-mpi + ./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no diff --git a/v1.0.4/_sources/doc_pages/theory.rst.txt b/v1.0.4/_sources/doc_pages/theory.rst.txt new file mode 100644 index 00000000..95d7842c --- /dev/null +++ b/v1.0.4/_sources/doc_pages/theory.rst.txt @@ -0,0 +1,114 @@ +.. _theory-label: + +Theory +###### +Hybrid particle--field simulations switch out the ordinary particle--particle +`Lennard-Jones`_ interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle--field densities are +defined as + +.. math:: + + \phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i), + +where :math:`\mathbf{r}` is a spatial coordinate, :math:`P` is a window function +used to distribute particle number densities onto a computational grid, and +:math:`\mathbf{r}_i` is the position of particle :math:`i` (of total :math:`N`). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of :math:`N` particles in :math:`M` molecules is + +.. math:: + + \mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})] + +with :math:`H_0` being a standard intramolecular Hamiltonian form (see +:ref:`bonds-label`) including kinetic terms, while :math:`W` is a density +dependent *interaction energy functional*. + +In the Hamiltonian hPF-MD formalism :cite:`bore2020hamiltonian`, the density +field is filtered using a grid-independent filtering function :math:`H`, + +.. math:: + + \tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}). + +The filter smooths the density, ensuring that :math:`\tilde\phi` and +:math:`W[\tilde\phi([\phi])]` both converge as the grid size is reduced. + +External potential +================== +The external potential acting on a particle is defined as the functional +derivative of :math:`W` with respect to :math:`\phi`. In the filtered formalism, +the potential takes the form + +.. math:: + + V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ + &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})}, + +under the assumption of a *local* form of the interaction energy functional, +:math:`W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]`. Note +that + +.. math:: + + \frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}). + +Force interpolation +=================== +The forces on particle :math:`i` are obtained by differentiation of the external +potential, + +.. math:: + + \mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i). + + +Reciprocal space calculations +============================= +The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density :math:`\phi_{ijk}` with CIC, we apply the filtering +and obtain the discrete version of the external potential by + +.. math:: + + \tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big] + +and + +.. math:: + + V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +The forces are obtained by differentiation of :math:`V` in Fourier space as + +.. math:: + + \nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +Filter +====== +By default, the filter used in HyMD is a simple Gaussian of the form + +.. math:: + + H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ + \hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +For more details about the filtering, see :ref:`filtering-label`. + +Hamiltonian form +================ +The default form of the interaction energy functional in HyMD is + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2. + +See :ref:`functionals-label` for details. + + +.. _`Lennard-Jones`: + https://en.wikipedia.org/wiki/Lennard-Jones_potential diff --git a/v1.0.4/_sources/doc_pages/topology_input.rst.txt b/v1.0.4/_sources/doc_pages/topology_input.rst.txt new file mode 100644 index 00000000..adabe129 --- /dev/null +++ b/v1.0.4/_sources/doc_pages/topology_input.rst.txt @@ -0,0 +1,77 @@ +.. _topology-label: + +============================ +Topology and structure file +============================ +The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root :code:`/` group. + +The `HyMD-tutorial`_ has multiple examples of structure files for various levels +of complexity. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Required datasets +================= +:/coordinates: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/indices: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/names: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`string` (:code:`length` between :code:`1` and :code:`16`)] + + The shape represents one particle name per :code:`N` particles. The datatype may be a string of length :code:`=<16`. + + + +Optional datasets +================= +:/velocities: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/types: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle type index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/molecules: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one molecule index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/bonds: + :code:`array` shape [:code:`N`, :code:`B`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents :code:`B` bond specifications (indices of different particles) per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/charge: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents one particle charge per :code:`N` particles. The data type may be either four or eight byte reals. diff --git a/v1.0.4/_sources/index.rst.txt b/v1.0.4/_sources/index.rst.txt new file mode 100644 index 00000000..ff4059ba --- /dev/null +++ b/v1.0.4/_sources/index.rst.txt @@ -0,0 +1,168 @@ +.. hymd documentation master file, created by + sphinx-quickstart on Thu Dec 16 13:31:43 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +############################### +HylleraasMD documentation +############################### + +:Release: + |release| +:Date: + |today| + +**HylleraasMD** (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems. + +HyMD can run canonical hPF-MD simulations :cite:`Milano2009JCP`, or filtered +density Hamiltonian hPF (HhPF-MD) simulations :cite:`bore2020hamiltonian`, with +or without explicit PME electrostatic interactions :cite:`kolli2018JCTC`. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +:cite:`Cascella2008,bore2018hybrid`. Martini +style elastic networks (ElNeDyn) :cite:`periole2009combining` are also +supported. + +HyMD uses the pmesh (`github.com/rainwoodman/pmesh`_) library for particle-mesh +operations, with the PPFT :cite:`pippig2013pfft` backend for FFTs through the +pfft-python bindings (`github.com/rainwoodman/pfft-python`_). File IO is done +via HDF5 formats to allow MPI parallel reads. + +User Guide +========== +The HylleraasMD :doc:`User Guide ` provides comprehensive information on how to run +simulations. Selected :doc:`Examples ` are available to guide new users. + +.. _`github.com/rainwoodman/pmesh`: + https://github.com/rainwoodman/pmesh +.. _`github.com/rainwoodman/pfft-python`: + https://github.com/rainwoodman/pfft-python + +Installing HyMD +=============== +The easiest approach is to install using pip_: + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + +For more information and **required dependencies**, see +:ref:`installation-label`. + +.. _pip: + http://www.pip-installer.org/en/latest/index.html + + +Run in Google colab +------------------- +Run HyMD interactively in `Google Colaboratory`_ jupyter notebook `here`_. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Source Code +=========== +**Source code** is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the `GNU Lesser General Public +License v3.0`_. Obtain the source code with `git`_: + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git + +.. _GNU Lesser General Public License v3.0: + https://www.gnu.org/licenses/lgpl-3.0.html +.. _git: + https://git-scm.com/ + + +Development +=========== +HyMD is developed and maintained by researchers at the `Hylleraas Centre for +Quantum Molecular Sciences`_ at the `University of Oslo`_. + +|pic1| |pic2| + +.. _`Hylleraas Centre for Quantum Molecular Sciences`: + https://www.mn.uio.no/hylleraas/english/ +.. _`University of Oslo`: + https://www.uio.no/ + +.. |pic1| image:: img/hylleraas_centre_logo_black.png + :target: img/hylleraas_centre_logo_black.png + :width: 250 px + +.. |pic2| image:: img/uio_full_logo_eng_pos.png + :target: img/uio_full_logo_eng_pos.png + :width: 325 px + + + +References +========== +.. bibliography:: + :all: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. Contents +.. ======== + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Getting started + + ./doc_pages/installation + ./doc_pages/overview + ./doc_pages/config_file + ./doc_pages/topology_input + ./doc_pages/command_line + ./doc_pages/constants_and_units + + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Examples + + ./doc_pages/examples + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Theory + + ./doc_pages/theory + ./doc_pages/intramolecular_bonds + ./doc_pages/electrostatics + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Developer documentation + + ./doc_pages/interaction_energy_functionals + ./doc_pages/filtering + ./doc_pages/benchmarks + ./doc_pages/api diff --git a/v1.0.4/_static/basic.css b/v1.0.4/_static/basic.css new file mode 100644 index 00000000..be19270e --- /dev/null +++ b/v1.0.4/_static/basic.css @@ -0,0 +1,856 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/v1.0.4/_static/css/badge_only.css b/v1.0.4/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/v1.0.4/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/v1.0.4/_static/css/fonts/Roboto-Slab-Bold.woff b/v1.0.4/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/v1.0.4/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/v1.0.4/_static/css/fonts/Roboto-Slab-Bold.woff2 b/v1.0.4/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/v1.0.4/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/v1.0.4/_static/css/fonts/Roboto-Slab-Regular.woff b/v1.0.4/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/v1.0.4/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/v1.0.4/_static/css/fonts/Roboto-Slab-Regular.woff2 b/v1.0.4/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/v1.0.4/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/v1.0.4/_static/css/fonts/fontawesome-webfont.eot b/v1.0.4/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/v1.0.4/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/v1.0.4/_static/css/fonts/fontawesome-webfont.svg b/v1.0.4/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/v1.0.4/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v1.0.4/_static/css/fonts/fontawesome-webfont.ttf b/v1.0.4/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/v1.0.4/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/v1.0.4/_static/css/fonts/fontawesome-webfont.woff b/v1.0.4/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/v1.0.4/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/v1.0.4/_static/css/fonts/fontawesome-webfont.woff2 b/v1.0.4/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/v1.0.4/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/v1.0.4/_static/css/fonts/lato-bold-italic.woff b/v1.0.4/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/v1.0.4/_static/css/fonts/lato-bold-italic.woff differ diff --git a/v1.0.4/_static/css/fonts/lato-bold-italic.woff2 b/v1.0.4/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/v1.0.4/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/v1.0.4/_static/css/fonts/lato-bold.woff b/v1.0.4/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/v1.0.4/_static/css/fonts/lato-bold.woff differ diff --git a/v1.0.4/_static/css/fonts/lato-bold.woff2 b/v1.0.4/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/v1.0.4/_static/css/fonts/lato-bold.woff2 differ diff --git a/v1.0.4/_static/css/fonts/lato-normal-italic.woff b/v1.0.4/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/v1.0.4/_static/css/fonts/lato-normal-italic.woff differ diff --git a/v1.0.4/_static/css/fonts/lato-normal-italic.woff2 b/v1.0.4/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/v1.0.4/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/v1.0.4/_static/css/fonts/lato-normal.woff b/v1.0.4/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/v1.0.4/_static/css/fonts/lato-normal.woff differ diff --git a/v1.0.4/_static/css/fonts/lato-normal.woff2 b/v1.0.4/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/v1.0.4/_static/css/fonts/lato-normal.woff2 differ diff --git a/v1.0.4/_static/css/theme.css b/v1.0.4/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/v1.0.4/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/v1.0.4/_static/custom.css b/v1.0.4/_static/custom.css new file mode 100644 index 00000000..b20d6282 --- /dev/null +++ b/v1.0.4/_static/custom.css @@ -0,0 +1,91 @@ + +body{ + background: #FFFFFF !important; +} + +.wy-menu-vertical header, .wy-menu-vertical p.caption{ + color: #4EA0AF!important; +} +.wy-menu-vertical li.current{ + background-color: #f4f4f4!important; +} +.wy-menu-vertical li.toctree-l2.current>a{ + background-color: #ebebeb!important; +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{ + background-color: #e3e3e3!important; +} + +.rst-content .sidebar{ + background-color: #fff!important; + border-radius: 6px; + -moz-border-radius: 6px; + -webkit-border-radius: 6px; +} + +h1 > a, h2 > a, h3 > a, h4 > a, h5 > a, h6 > a { + color: #17d9ff; +} + +h1, h2, h3, h4, h5, h6 { + color: black; + font-weight: normal; + padding: 0; +} + +h1, h2, h3 { + margin-top: 30px; + margin-bottom: 20px; +} + +h1 { + color: white; + padding: 20px 20px 20px 45px; + margin: 20px 0 35px -45px; + background: linear-gradient(to left, #fff, #2b38ff)!important; + + width: calc(100% + 90px); + border-bottom: 3px solid #000; +} + +h2 { + padding: .2em 0; + border-bottom: 1px solid #ddd; +} + +h3 { + margin-top: 35px; +} + +h4 { + margin-top: 30px; +} + +h5 { + margin-top: 25px; +} + +.wy-nav-content{ + max-width: none!important; +} + +.wy-side-nav-search{ + background: #2b38ff!important; +} + +.wy-side-nav-search input[type=text]{ + border-color:#4DA0B0!important; +} + +.wy-side-nav-search input[type=text]{ + border-radius: 4px!important; +} + +#caption-api { + background: red !important; +} + +#caption-text-api { + text-color: blue !important; +} diff --git a/v1.0.4/_static/doctools.js b/v1.0.4/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/v1.0.4/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/v1.0.4/_static/documentation_options.js b/v1.0.4/_static/documentation_options.js new file mode 100644 index 00000000..0f3c4808 --- /dev/null +++ b/v1.0.4/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '1.0.4', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/v1.0.4/_static/file.png b/v1.0.4/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/v1.0.4/_static/file.png differ diff --git a/v1.0.4/_static/hymd_icon_white.png b/v1.0.4/_static/hymd_icon_white.png new file mode 100644 index 00000000..d0396a17 Binary files /dev/null and b/v1.0.4/_static/hymd_icon_white.png differ diff --git a/v1.0.4/_static/hymd_logl_white_text_abbr.png b/v1.0.4/_static/hymd_logl_white_text_abbr.png new file mode 100644 index 00000000..8c0e50c8 Binary files /dev/null and b/v1.0.4/_static/hymd_logl_white_text_abbr.png differ diff --git a/v1.0.4/_static/jquery-3.5.1.js b/v1.0.4/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/v1.0.4/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. API reference

+
+

4.1. Integrator

+

Integrates equations of motion.

+

Implements the Velocity Verlet integrator. The reversible reference system +propagator algorithm (rRESPA) integrator uses the Velocity Verlet functions +inside the MD loop in the main module.

+
+
+hymd.integrator.integrate_position(positions, velocities, time_step)[source]
+

Position update step of the Velocity Verlet integration algorithm.

+

Computes the position update step of the Velocity Verlet algorithm. The +positions argument is not changed in place.

+
+
Parameters:
+
+
positions(N, D) numpy.ndarray

Array of positions of N particles in D dimensions.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_velocity

The velocity update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step, then the positions are updated a full step using the updated +velocities

+
+\[\mathbf{x}_{\text{new}} = \mathbf{x} + \Delta t \mathbf{v}\]
+
+ +
+
+hymd.integrator.integrate_velocity(velocities, accelerations, time_step)[source]
+

Velocity update step of the Velocity Verlet integration algorithm.

+

Computes the velocity update step of the Velocity Verlet algorithm. The +velocities argument is not changed in place.

+
+
Parameters:
+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
accelerations(N, D) numpy.ndarray

Array of accelerations of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_position

The position update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step

+
+\[\mathbf{v}_{\text{new}} = \mathbf{v} + \frac{\Delta t}{2m} +\mathbf{f}\]
+

before the positions are moved a full step using the updated half-step +velocities.

+
+ +
+
+

4.2. Thermostat

+

Scales or otherwise modifies the particle velocities during simulation to +simulate coupling to an external heat bath with temperature T₀.

+
+
+hymd.thermostat._random_chi_squared(prng: numpy.random._generator.Generator, M: int)float[source]
+

Draw the sum of M squared normally distributed values

+

The value is generated by the Gamma distribution, in lieu of generating +M Gaussian distributed numbers and summing their squares.

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
Mint

Number of standard normally distributed numbers in the sum.

+
+
+
+
Returns:
+
+
float

The sum of M squared normally distributed values centered at +zero with unit standard deviation.

+
+
+
+
+

Notes

+

The sum of the squares of k independent standard normal random variables is +distributed according to a \(\chi^2\) distribution.

+
+\[\chi^2_1 + \chi_2^2 + \chi_3^2 + \dots + \chi_M^2 +\sim +\sigma^2\chi^2(k)\]
+

This is a special case of the \(\Gamma\) distribution, +\(\Gamma(k/2, 2)\), and may be generated by

+
+\[\chi^2(k) \sim 2 \Gamma(k/2, 2)\]
+

References

+

Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of +Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. +J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246.

+
+ +
+
+hymd.thermostat._random_gaussian(prng: numpy.random._generator.Generator)float[source]
+

Draw a single random number from the standard normal distribution +Generate a number from the Gaussian distribution centered at zero with unit +standard deviation, \(N(0, 1)\).

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
+
+
Returns:
+
+
float

A random number drawn from \(N(0, 1)\).

+
+
+
+
+
+ +
+
+hymd.thermostat.csvr_thermostat(velocity: numpy.ndarray, names: numpy.ndarray, config: hymd.input_parser.Config, prng: numpy.random._generator.Generator, comm: mpi4py.MPI.Intracomm = <mpi4py.MPI.Intracomm object>, random_gaussian: Callable[[numpy.random._generator.Generator], float] = <function _random_gaussian>, random_chi_squared: Callable[[numpy.random._generator.Generator, int, float], float] = <function _random_chi_squared>, remove_center_of_mass_momentum: bool = True)numpy.ndarray[source]
+

Canonical sampling through velocity rescaling thermostat

+

Implements the CSVR thermostat. Rescales the system kinetic energy by a +stochastically chosen factor to keep the temperature constant. Requires +communcation of the kinetic energies calculated locally for each MPI rank. +The random numbers sampled through random_gaussian and +random_chi_squared are broadcast from the root rank to the other +ranks to ensure the scaling is performed with the same stochasticity for +all particles in the full system.

+

The velocities are cleaned of center of mass momentum before the thermostat +is applied, and the center of mass momentum is subsequently reapplied. This +is performed for each thermostat coupling group, i.e. the center of mass +momenta of each group is separately removed and reapplied after +thermostatting.

+

The implementation here is based on the derivation presented in the 2008 +Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper.

+
+
Parameters:
+
+
velocity(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
names(N,) numpy.ndarray

Array of particle names.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
random_gaussiancallable, optional

Function for generating standard normally distributed numbers.

+
+
random_chi_squaredcallable, optional

Function for generating \(\chi^2\)-distributed numbers

+
+
remove_center_of_mass_momentumbool, optional

If True, the center of mass of each coupling group is removed before +the thermostat is applied. The center of mass momenta are added back +after the kinetic energy rescaling is complete.

+
+
+
+
+
+

See also

+
+
_random_gaussian

Used to sample Gaussian-distributed numbers.

+
+
_random_chi_squared

Used to sample \(\chi^2\)-distributed numbers.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +

References

+

G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). +G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008).

+
+ +
+
+

4.3. Hamiltonian

+
+
+class hymd.hamiltonian.Hamiltonian(config)[source]
+

Interaction energy functional superclass

+
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+_setup()[source]
+

Superclass setup

+

Sets up the grid-independent filtering function H, and the +SymPy logic for symbolically differentiating interaction energy +functionals in Hamiltonian subclasses.

+
+ +
+ +
+
+class hymd.hamiltonian.SquaredPhi(config)[source]
+

Simple squared density interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + \sum_k \tilde\phi_k + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(rho_0\) is the +average density of the fully homogenous system. Expressing the species +densities in terms of fluctuations from the average,

+
+\[\mathrm{d}\tilde\phi_k = \rho_0 - \tilde\phi_k,\]
+

it is evident that this interaction energy functional is a slight change of +the DefaultNoChi Hamiltonian, as the expanded interaction energy +density becomes

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + 6\rho_0\left[ + \sum_k \mathrm{d}\tilde\phi_k + \right] + + + 9\rho_0^2 + + + \sum_k \mathrm{d}\tilde\phi_k^2 + + + \prod_{k\not=l} + \mathrm{d}\tilde\phi_k \mathrm{d}\tilde\phi_l + \right),\]
+

identical to DefaultNoChi apart from a constant energy shift +\(9\rho_0^2`(which does not impact dynamics) and the +:math:\)rho_0`–\(\mathrm{d}\tilde\phi_k\) cross-terms. These +cross-terms constitute contributions to the energy linear in +\(\mathrm{d}\tilde\phi_k\) absent in DefaultNoChi, which has +only quadratic terms present.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultNoChi(config)[source]
+

Incompressibility-only interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a +\right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. The SquaredPhi Hamiltonian implements a similar +functional with an additional linear term component depending on

+
+\[\mathmr{d}\tilde\phi_k = \tilde\phi_k - \rho_0\]
+

and not \(\mathrm{d}\tilde\phi_k^2\). No explicit inter-species +interaction is present apart from the indirect interaction through the +incompressibility.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultWithChi(config, unique_names, type_to_name_map)[source]
+

Incompressibility and \(\chi\)-interactions energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = + \frac{1}{2\rho_0} + \sum_{k,l}\chi_{kl} \tilde\phi_k \tilde\phi_l + + + \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. \(\chi_{ij}\) is the Flory-Huggins-like +inter-species mixing energy.

+
+
+__init__(config, unique_names, type_to_name_map)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup(unique_names, type_to_name_map)[source]
+

Setup the interaction energy potential and the external potential

+
+
Parameters:
+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+ +
+ +
+
+

4.4. Force

+

Calculates intramolecular forces between bonded particles in molecules

+
+
+class hymd.force.Angle(atom_1: str, atom_2: str, equilibrium: float, strength: float, atom_3: str)[source]
+

Dataclass representing a single three-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any three-particle bond between particles of specific types A, +B, and C (where A, B, and C may be +different or the same). Harmonic angular three-particle bonds in HyMD take +the form

+
+\[V_3(\mathbf{r}_1, \mathbf{r}_2, \mathbf{r}_3) = + \frac{1}{2}k + \left( + \cos^{-1} + \left[ + \frac{ + (\mathbf{r}_1-\mathbf{r}_2) + \cdot + (\mathbf{r}_3-\mathbf{r}_2) + } + { + \vert\mathbf{r}_1-\mathbf{r}_2\vert + \vert\mathbf{r}_3-\mathbf{r}_2\vert + } + \right] - \theta_0 + \right)^2\]
+
+

See also

+
+
Bond

Two-particle bond type dataclass

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
equilibriumfloat

Equilibrium angle at which the energy associated with the +three-particle angular bond vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient.

+
+
+
+
+
+
+atom_3: str
+
+ +
+ +
+
+class hymd.force.Bond(atom_1: str, atom_2: str, equilibrium: float, strength: float)[source]
+

Dataclass representing a single two-particle bond type

+

A bond type is a bond strength and equilibrium distance associated with +any bond between particles of specific types A and B +(where A and B may be the same or different). Harmonic +two-particle bonds in HyMD take the form

+
+\[V_2(\mathbf{r}_1, \mathbf{r}_2) = + \frac{1}{2}k + \left( + \vert \mathbf{r}_1 - \mathbf{r}_2 \vert - r_0 + \right)^2,\]
+

where \(k\) is the bond strength (spring constant) and \(r_0\) is +the equilibrium bond length (at which the energy is zero).

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
equilibriumfloat

Equilibrium distance at which the energy associated with the bond +vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient (spring constant).

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+equilibrium: float
+
+ +
+
+strength: float
+
+ +
+ +
+
+class hymd.force.Chi(atom_1: str, atom_2: str, interaction_energy: float)[source]
+

Dataclass representing a single \(\chi\) mixing interaction type

+

An interaction mixing energy type is a mixing energy associated with +density overlap between species of types A and B +(specified as inputs atom_1 and atom_2). A positive mixing +energy promotes phase separation, a negative mixing energy promotes mixing. +The interaction energy density (provided the DefaultWithChi +Hamiltonian is used) takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} + \sum_{k,l}\chi_{k,l} \tilde\phi_k\tilde\phi_l,\]
+

where \(\chi_{k,l}\) denotes the mixing energy between species +\(k\) and \(l\), with \(\kappa\) being the incompressibility. +The value of the interaction mixing energy parameter may be extracted from +Flory-Huggins theory.

+
+

See also

+
+
hymd.hamiltonian.DefaultWithChi

Interaction energy functional using \(\chi\)-interactions.

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
interaction_energyfloat

Interaction mixing energy.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+interaction_energy: float
+
+ +
+ +
+
+class hymd.force.Dielectric_type(atom_1: str, dielectric_value: float)[source]
+
+
+atom_1: str
+
+ +
+
+dielectric_value: float
+
+ +
+ +
+
+class hymd.force.Dihedral(atom_1: str, atom_2: str, atom_3: str, atom_4: str, coeffs: numpy.ndarray, dih_type: int)[source]
+

Dataclass representing a single four-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any four-particle torsional bond between particles of specific types +A, B, C, and D (where A, B, +C, and D may be different or the same). Dihedral +four-particle bonds in HyMD take different forms depending on the +dih_type parameter.

+

In the following, let \(\phi\) denote the angle between the planes +spanned by the relative positions of atoms A-B-C +and B-C-D. If dih_type = 0, then

+
+\[V_4(\phi) = \sum_n c_n + \left( + 1 + \cos\left[ + n\phi - d_n + \right] + \right),\]
+

where \(c_n\) are energy coefficients and \(d_n\) are propensity +phases. By default, the cosine sum is truncated at five terms. If +coeffs provides only a single float, this is used as the coiling +propensity parameter \(\lambda\). In this case, \(c_n\) and +\(d_n\) are automatically set to values which promote alpha helical +(\(\lambda=-1\)), beta sheet (\(\lambda=1\)), or a mixed +(\(1>\lambda>-1\)) structure (using values provided by Bore et al. +(2018)). In this case, the full potential takes the form

+
+\[V_4(\phi;\lambda) = + \frac{1}{2}(1-\lambda) V_{\text{prop},\alpha}(\phi) + + + \frac{1}{2}(1+\lambda) V_{\text{prop},\beta}(\phi) + + + (1-\vert\lambda\vert) V_{\text{prop}, \text{coil}}(\phi),\]
+

with each of the \(V_{\mathrm{prop}, X}\) being fixed cosine series +potentials with pre-set \(c_n\) -s and \(d_n\) -s.

+

If dih_type = 1, then a combined bending torsional (CBT) potential +is employed,

+
+\[V_4(\phi,\gamma;\lambda) = + V_4(\phi;\lambda) + + + \frac{1}{2}K(\phi)(\gamma - \gamma_0)^2,\]
+

where \(V_4(\phi;\lambda)\) specifies the potential as given by the +coiling propensity parameter above, \(K(\phi)\) is a separate cosine +series potential acting as the angular three-particle bond strength, and +\(\gamma_0\) is the three-particle bond equilibrium angle. In this +case, the coeffs parameter must specify both a \(\lambda\) +value, in additon to the energy and phases dictating the \(K(\phi)\) +potential.

+

References

+

Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018.

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
atom_4str

Type name of particle 4.

+
+
coeffslist[list[float]] or list[float] or numpy.ndarray

Dihedral coefficients defining the series expansion of the dihedral +energy.

+
+
dih_typeint

Specifies the type of dihedral used; If 0, then coeffs +must contain either two lists of five energy coefficients +\(c_n\) and five propensity phases \(d_n\) or a single +floating point number defining the \(\lambda\) coiling propensity +parameter. If 1, the combined bending-torsional potential is +used, and coeffs must specify \(\lambda\) and two lists +containing energy coefficients and propensity phases for the +\(V_\text{prop}\) propensity potential, defined in terms of cosine +series.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+atom_3: str
+
+ +
+
+atom_4: str
+
+ +
+
+coeffs: numpy.ndarray
+
+ +
+
+dih_type: int
+
+ +
+ +
+
+hymd.force.compute_angle_forces__plain(f_angles, r, bonds_3, box_size)[source]
+

Computes forces resulting from angular interactions

+
+

Deprecated since version 1.0.0: compute_angle_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_bond_forces__plain(f_bonds, r, bonds_2, box_size)[source]
+

Computes forces resulting from bonded interactions

+
+

Deprecated since version 1.0.0: compute_bond_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size)[source]
+

Computes forces resulting from dihedral interactions

+
+

Deprecated since version 1.0.0: compute_dihedral_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.dipole_forces_redistribution(f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb)[source]
+

Redistribute electrostatic forces calculated from topologically +reconstructed ghost dipole point charges to the backcone atoms of the protein.

+
+ +
+
+hymd.force.find_all_paths(G, u, n)[source]
+

Helper function that recursively finds all paths of given lenght ‘n + 1’ inside a network ‘G’. +Adapted from https://stackoverflow.com/a/28103735.

+
+ +
+
+hymd.force.prepare_bonds(molecules, names, bonds, indices, config, topol=None)[source]
+

Rearrange the bond information for usage in compiled Fortran kernels

+

Restructures the lists resulting from the execution of +prepare_bonds_old into numpy arrays suitable for calls to optimized +Fortran code calculating bonded forces and energiesself.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2_atom_1(B,) numpy.ndarray

Local index of particle 1 for each of B constructed +two-particle bonds.

+
+
bonds_2_atom_2(B,) numpy.ndarray

Local index of particle 2 for each of B constructed +two-particle bonds.

+
+
bonds_2_equilibrium(B,) numpy.ndarray

Equilibrium distance for each of B constructed two-particle +bonds.

+
+
bonds_2_strength(B,) numpy.ndarray

Bond strength for each of B constructed two-particle +bonds.

+
+
bonds_3_atom_1(A,) numpy.ndarray

Local index of particle 1 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_2(A,) numpy.ndarray

Local index of particle 2 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_3(A,) numpy.ndarray

Local index of particle 3 for each of A constructed +three-particle bonds.

+
+
bonds_3_equilibrium(A,) numpy.ndarray

Equilibrium angle for each of A constructed three-particle +bonds.

+
+
bonds_3_strength(A,) numpy.ndarray

Bond strength for each of A constructed three-particle +bonds.

+
+
bonds_4_atom_1(D,) numpy.ndarray

Local index of particle 1 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_2(D,) numpy.ndarray

Local index of particle 2 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_3(D,) numpy.ndarray

Local index of particle 3 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_4(D,) numpy.ndarray

Local index of particle 4 for each of D constructed +four-particle bonds.

+
+
bonds_4_coeff(D,) numpy.ndarray

Cosine series coefficients for each of D constructed +four-particle bonds.

+
+
bonds_4_type(D,) numpy.ndarray

Dihedral type for each of D constructed four-particle +bonds.

+
+
bonds_4_last(D,) numpy.ndarray

Flags indicating if dih_type is 1 for each of D +constructed four-particle bonds.

+
+
+
+
+
+

See also

+
+
prepare_bonds_old

Used internally to reconstruct the bonded interactions types from the connectivity information in the structure/topology input file and the bonded types specified in the configuration file.

+
+
+ +
+ +
+
+hymd.force.prepare_bonds_old(molecules, names, bonds, indices, config)[source]
+

Find bonded interactions from connectivity and bond types information

+
+

Deprecated since version 1.0.0: prepare_bonds_old was replaced by prepare_bonds for +use with compiled Fortran kernels prior to 1.0.0 release.

+
+

Prepares the necessary equilibrium and bond strength information needed by +the intramolecular interaction functions. This is performed locally on each +MPI rank, as the domain decomposition ensures that for all molecules all +consituent particles are always contained on the same MPI rankself.

+

This function traverses the bond connectivity information provided in the +structure/topology input file and indentifies any two-, three-, or +four-particle potential bonds. For each connected chain of two, three, or +four particles, a matching to bond types is attempted. If the corresponding +names match, a bond object is initialized.

+

In order to investigate the connectivity, a graph is created using +networkx functionality.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2list

List of lists containing local particle indices, equilibrium +distance, and bond strength coefficient for each reconstructed +two-particle bond.

+
+
bonds_3

List of lists containing local particle indices, equilibrium angle, +and bond strength coefficient for each reconstructed three-particle +bond.

+
+
bonds_4

List of lists containing local particle indices, dihedral type index, +and dihedral coefficients for each reconstructed four-particle +torsional bond.

+
+
bb_indexlist

List indicating the dihedral type of each four-particle bond in +bonds_4.

+
+
+
+
+
+

See also

+
+
Bond

Two-particle bond type dataclass.

+
+
Angle

Three-particle angular bond type dataclass.

+
+
Dihedral

Four-particle torsional bond type dataclass.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+hymd.force.prepare_index_based_bonds(molecules, topol)[source]
+
+ +
+
+hymd.force.propensity_potential_coeffs(x: float)[source]
+
+ +
+
+

4.5. Logger

+
+
+class hymd.logger.Logger[source]
+

Log output handler class

+

Notes

+

This wraps the default python library logging, see +docs.python.org/3/library/logging.html.

+
+
Attributes:
+
+
levelint

Determines the verbosity level of the log, corresponding to +logging.level. Numerical values 50 (logging.CRITICAL), +40 (logging.ERROR), 30 +(logging.WARNING), 20 (logging.INFO), +10 (logging.DEBUG), and 0 +(logging.UNSET) are supported values. Any log event message +less severe than the specified level is ignored. All other event +messages are emitted.

+
+
log_filestr

Path to output log file.

+
+
formatstr

Prepended dump string for each log event. Specifies the log event +level, the module emitting the event, the code line, the enclosing +function name, and the MPI rank writing the message.

+
+
date_formatstr

Prepends the date before all log event messages.

+
+
formatterlogging.Formatter

Formatter handling the prepending of the information in format and +date_format to each log event message. Used by default for all +loggers.

+
+
rank0logging.Logger

Default logger object for the root MPI rank.

+
+
all_rankslogging.Logger

Default logger object for messages being emitted from all MPI ranks +simultaneously.

+
+
+
+
+
+
+classmethod setup(default_level=20, log_file=None, verbose=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Sets up the logger object.

+

If a log_file path is provided, log event messages are output +to it. Otherwise, the logging messages are emitted to stdout.

+
+
Parameters:
+
+
default_levelint, optional

Default verbosity level of the logger. Unless specified, it is +10 (logging.INFO).

+
+
log_filestr, optional

Path to output log file. If None or not priovided, no log file is +used and all logging is done to stdout.

+
+
verbosebool, optional

Increases the logging level to 30 (logging.WARNING) +if True, otherwise leaves the logging level unchanged.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterRoot(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the root MPI rank log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterAll(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the all-MPI-ranks log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+

4.6. Input parser

+

Parses and handles the configuration information provided for the simulation

+
+
+class hymd.input_parser.Config(n_steps: int, time_step: float, mesh_size: Union[List[int], numpy.ndarray, int], sigma: float, kappa: float, dtype: Optional[numpy.dtype] = None, box_size: Optional[Union[List[float], numpy.ndarray]] = None, n_print: Optional[int] = None, tau: Optional[float] = None, start_temperature: Optional[Union[float, bool]] = None, target_temperature: Optional[Union[float, bool]] = None, mass: Optional[float] = None, hamiltonian: Optional[str] = None, domain_decomposition: Optional[Union[int, bool]] = None, integrator: Optional[str] = None, respa_inner: int = 1, file_name: str = '<config file path unknown>', name: Optional[str] = None, tags: List[str] = <factory>, bonds: List[hymd.force.Bond] = <factory>, angle_bonds: List[hymd.force.Angle] = <factory>, dihedrals: List[hymd.force.Dihedral] = <factory>, chi: List[hymd.force.Chi] = <factory>, n_particles: Optional[int] = None, max_molecule_size: Optional[int] = None, n_flush: Optional[int] = None, thermostat_work: float = 0.0, thermostat_coupling_groups: List[List[str]] = <factory>, initial_energy: Optional[float] = None, cancel_com_momentum: Union[int, bool] = False, coulombtype: Optional[str] = None, convergence_type: Optional[str] = None, pol_mixing: Optional[float] = None, dielectric_const: Optional[float] = None, conv_crit: Optional[float] = None, dielectric_type: List[hymd.force.Dielectric_type] = <factory>, self_energy: Optional[float] = None, type_charges: Optional[Union[List[float], numpy.ndarray]] = None, rho0: Optional[float] = None, a: Optional[float] = None, pressure: bool = False, barostat: Optional[str] = None, barostat_type: Optional[str] = None, tau_p: Optional[float] = None, target_pressure: List[hymd.barostat.Target_pressure] = <factory>, n_b: Optional[int] = None, m: List[float] = <factory>)[source]
+

Configuration object

+

Handles and verifies the simulation configuration specified in the +configuration file.

+
+

See also

+
+
hymd.input_parser.Bond

Two-particle bond type dataclass.

+
+
hymd.input_parser.Angle

Three-particle bond type dataclass.

+
+
hymd.input_parser.Dihedral

Four-particle bond type dataclass.

+
+
+ +
+
Attributes:
+
+
gas_constantfloat

Constant value of the gas constant, R (equivalently the Boltzmann +constant) in the units used internally in HyMD.

+
+
coulomb_constantfloat

Constant value of the Coulomb constant which converts electric field +values to forces and electric potential values to energies in the units +used internally in HyMD.

+
+
n_steps: int

Number of time steps in the simulation.

+
+
time_step: float

Outer time step used in the simulation. If the rRESPA intergrator is +used, the inner time step (the time step used in the integration of +intramolecular bending, stretching, and torsional forces) is +time_step / respa_inner.

+
+
box_sizelist[float] or (D,) numpy.ndarray

Simulation box size of simulation in D dimensions in units of +nanometers.

+
+
mesh_sizelist[int] or int or numpy.ndarray

Number of grid points used for the discrete density grid.

+
+
sigmafloat

Filter width representing the effective coarse-graining level of the +particles in the simulation.

+
+
kappafloat

Compressibility parameter used in the relaxed incompressibility term in +the interaction energy functional.

+
+
n_printint, optional

Frequency of trajectory/energy output to the H5MD trajectory/energy +output file (in units of number of time steps).

+
+
taufloat, optional

The time scale of the CSVR thermostat coupling.

+
+
start_temperaturefloat, optional

Generate starting temperature by assigning all particle velocities +randomly according to the Maxwell-Boltzmann distribution at +start_temperature Kelvin prior to starting the simulation.

+
+
target_temperaturefloat, optional

Couple the system to a heat bath at target_temperature Kelvin.

+
+
massfloat, optional

Mass of the particles in the simulation.

+
+
hamiltonianstr, optional

Specifies the interaction energy functional \(W[\tilde\phi]\) +for use with the particle-field interactions. Options: +SquaredPhi, DefaultNohChi, or DefaultWithChi.

+
+
domain_decompositionint, optional

Specifies the interval (in time steps) of domain decomposition +exchange, involving all MPI ranks sending and receiving particles +according to the particles’ positions in the integration box and the +MPI ranks’ assigned domain.

+
+
integratorstr, optional

Specifies the time integrator used in the simulation. Options: +velocity-verlet or respa.

+
+
respa_innerint, optional

The number of inner time steps in the rRESPA integrator. This denotes +the number of intramolecular force calculations (stretching, bending, +torsional) are performed between each impulse applied from the field +forces.

+
+
file_namestr, optional

File path of the parsed configuration file.

+
+
namestr, optional

Name for the simulation.

+
+
tagslist[str], optional

Tags for the simulation.

+
+
bondslist[Bond], optional

Specifies harmonic stretching potentials between particles in the +same molecule.

+
+
angle_bondslist[Angle], optional

Specifies harmonic angular bending potentials between particles in the +same molecule.

+
+
dihedralslist[Dihedral], optional

Specifies four-particle torsional potentials by cosine series.

+
+
chilist[Chi], optional

Specifies \(\chi\)-interaction parameters between particle +species.

+
+
n_particlesint, optional

Specifies the total number of particles in the input. Optional keyword +for validation, ensuring the input HDF5 topology has the correct number +of particles and molecules.

+
+
max_molecule_sizeint, optional

Maximum size of any single molecule in the system. Used to speed up +distribution of particles onto MPI ranks in a parallel fashion.

+
+
n_flushint, optional

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be +written to disk (in units of number of n_print).

+
+
thermostat_workfloat

Work performed by the thermostat on the system.

+
+
thermostat_coupling_groupslist[str], optional

Specifies individual groups coupling independently to the CSVR +thermostat. E.g. in a system containing "A", "B", and +"C" type particles, +thermostat_coupling_groups = [["A", "B"], ["C"],] would +thermalise types "A" and "B" together and couple +"C" type particles to a different thermostat (all individual +thermostats are at the same temperature, i.e. target_temperature +Kelvin).

+
+
initial_energyfloat

Value of the total energy prior to the start of the simulation.

+
+
cancel_com_momentumint, optional

If True, the total linear momentum of the center of mass is +removed before starting the simulation. If an integer is specifed, the +total linear momentum of the center of mass is removed every +remove_com_momentum time steps. If False, the linear +momentum is never removed.

+
+
coulombtypestr, optional

Specifies the type of electrostatic Coulomb interactions in the system. +The strength of the electrostatic forces is modulated by the relative +dielectric constant of the simulation medium, specified with the +dielectric_const keyword. Charges for individual particles are +specified in the structure/topology HDF5 input file, not in the +configuration file. If no charges (or peptide backbone dipoles) are +present, the electrostatic forces will not be calculated even if this +keyword is set to "PIC_Spectral".

+
+
dielectric_constfloat, optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. When +using helical propensity dihedrals, this keyword must be specified—even +if electrostatics are not included with the coulombtype +keyword.

+
+
dielectric_type: list[float], optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. The list assigns +relative dielectric values to each bead type, and an anisotropic +dielectric function is obtained from a weighted average.

+
+
+
+
+
+
+a: float = None
+
+ +
+
+angle_bonds: List[hymd.force.Angle]
+
+ +
+
+barostat: str = None
+
+ +
+
+barostat_type: str = None
+
+ +
+
+bonds: List[hymd.force.Bond]
+
+ +
+
+box_size: Union[List[float], numpy.ndarray] = None
+
+ +
+
+cancel_com_momentum: Union[int, bool] = False
+
+ +
+
+chi: List[hymd.force.Chi]
+
+ +
+
+conv_crit: float = None
+
+ +
+
+convergence_type: str = None
+
+ +
+
+coulomb_constant: ClassVar[float] = 138.935458
+
+ +
+
+coulombtype: str = None
+
+ +
+
+dielectric_const: float = None
+
+ +
+
+dielectric_type: List[hymd.force.Dielectric_type]
+
+ +
+
+dihedrals: List[hymd.force.Dihedral]
+
+ +
+
+domain_decomposition: Union[int, bool] = None
+
+ +
+
+dtype: numpy.dtype = None
+
+ +
+
+file_name: str = '<config file path unknown>'
+
+ +
+
+gas_constant: ClassVar[float] = 0.0083144621
+
+ +
+
+hamiltonian: str = None
+
+ +
+
+initial_energy: float = None
+
+ +
+
+integrator: str = None
+
+ +
+
+kappa: float
+
+ +
+
+m: List[float]
+
+ +
+
+mass: float = None
+
+ +
+
+max_molecule_size: int = None
+
+ +
+
+mesh_size: Union[List[int], numpy.ndarray, int]
+
+ +
+
+n_b: int = None
+
+ +
+
+n_flush: int = None
+
+ +
+
+n_particles: int = None
+
+ +
+
+n_print: int = None
+
+ +
+
+n_steps: int
+
+ +
+
+name: str = None
+
+ +
+
+pol_mixing: float = None
+
+ +
+
+pressure: bool = False
+
+ +
+
+respa_inner: int = 1
+
+ +
+
+rho0: float = None
+
+ +
+
+self_energy: float = None
+
+ +
+
+sigma: float
+
+ +
+
+start_temperature: Union[float, bool] = None
+
+ +
+
+tags: List[str]
+
+ +
+
+target_pressure: List[hymd.barostat.Target_pressure]
+
+ +
+
+target_temperature: Union[float, bool] = None
+
+ +
+
+tau: float = None
+
+ +
+
+tau_p: float = None
+
+ +
+
+thermostat_coupling_groups: List[List[str]]
+
+ +
+
+thermostat_work: float = 0.0
+
+ +
+
+time_step: float
+
+ +
+
+type_charges: Union[List[float], numpy.ndarray] = None
+
+ +
+ +
+
+hymd.input_parser.check_NPT_conditions(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check validity of barostat_type, barostat, +a, rho0, target_pressure, tau_p

+
+ +
+
+hymd.input_parser.check_angles(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_bonds(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_box_size(config, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_cancel_com_momentum(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_charges(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if charges across ranks sum to zero.

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of floats with charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_charges_types_list(config, types, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates a list of charge values of length types. +Charges are sorted according to type ID. Used in field.py. +# TODO: this is messy, we should fix it

+
+ +
+
+hymd.input_parser.check_chi(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_config(config, indices, names, types, charges, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs various checks on the specfied config to ensure consistency

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
indices(N,) numpy.ndarray

Array of integer indices for N particles.

+
+
names(N,) numpy.ndarray

Array of string names for N particles.

+
+
types(N,) numpy.ndarray

Array of integer type indices for N particles.

+
+
charges(N,) numpy.ndarray

Array of floats charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
Returns:
+
+
configConfig

Validated configuration object.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_dielectric(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Error handling for electrostatics. +Unit testing of toml/tomli input.

+
+ +
+
+hymd.input_parser.check_dihedrals(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_domain_decomposition(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_hamiltonian(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_integrator(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_m(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_mass(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_max_molecule_size(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_b(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_flush(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_particles(config, indices, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_print(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_name(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_start_and_target_temperature(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Validate provided starting and target thermostat temperatures

+

Assesses the provided temperature target and ensures it is a non-negative +floating point number or False. Ensures the starting temperature is +a non-negative floating point number or False.

+

If the value for either is None, the returned configuration object +has the values defaulted to False in each case.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
validated_configConfig

Configuration object with validated target_temperature and +start_temperature.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_tau(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_thermostat_coupling_groups(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.parse_config_toml(toml_content, file_path=None, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.read_config_toml(file_path)[source]
+
+ +
+
+hymd.input_parser.sort_dielectric_by_type_id(config, charges, types)[source]
+

Creates a list of length N CG-particles, sorted after the charges from +the input HDF5 file. Used in file_io.py

+
+ +
+
+

4.7. Field

+

Forces and energies from the discretized particle-field grid interactions

+
+
+hymd.field.compute_field_and_kinetic_energy(phi, phi_q, psi, velocity, hamiltonian, positions, types, v_ext, config, layouts, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the particle-field and kinetic energy contributions

+

Calculates the kinetic energy through

+
+\[E_k = \sum_j \frac{1}{2}m_j\mathbf{v}_j\cdot\mathbf{v}_j,\]
+

and the particle-field energy by

+
+\[E_\text{field} = \int\mathrm{d}\mathbf{r}\, + w[\tilde\phi],\]
+

where \(w\) is the interaction energy functional density.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
velocity(N,D) numpy.ndarray

Array of velocities for N particles in D dimensions. +Local for each MPI rank.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Local for each MPI rank–the full computational grid is +represented by the collective fields of all MPI ranks.

+
+
configConfig

Configuration object.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field

Computes the up-to-date external potential for use in calculating the particle-field energy.

+
+
+ +
+ +
+
+hymd.field.compute_field_energy_q_GPE(config, phi_eps, field_q_energy, dot_elec, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the electrostatic energy after electrosatic forces is +calculated.

+

From the definition of the elecrostatic potential \(\Psi\), the energy +is

+
+
+
W = frac{1}{2}intmathrm{d}mathbf{r},

epsilon(mathbf{r})} left(mathbf{E}cdot mathbf{E}right),

+
+
+
+

where \(\epsilon(\mathbf{r})}\) is the anisotropic, spatially dependent, +relative dielectric of the simulation medium.

+
+
Parameters:
+
+
confighymd.input_parser.Config

Configuration object.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
field_q_energyfloat

Total elecrostatic energy.

+
+
dot_elecpmesh.pm.RealField

Pmesh RealField object for storing \(|\mathbf{E(r)}|^{2}\) +on the computational grid. Local for each MPI rank – the full computational +grid is represented by the collective fields of all MPI ranks.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field_force_q_GPE

Compute the electrosatic force from an anisotropic dielectric general Poisson equation.

+
+
+ +
+ +
+
+hymd.field.compute_field_force(layouts, r, force_mesh, force, types, n_types)[source]
+

Interpolate particle-field forces from the grid onto particle positions

+

Backmaps the forces calculated on the grid to particle positions using the +window function \(P\) (by default cloud-in-cell [CIC]). In the +following, let \(\mathbf{F}_j\) denote the force acting on the +particle with index \(j\) and position \(\mathbf{r}_j\). The +interpolated force is

+
+\[\mathbf{F}_j = -\sum_k\nabla V_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(V_{j_k}\) is the discretized external potential at grid vertex +\(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid vertex +with index \(j_k\), and \(h^3\) is the volume of each grid voxel. +The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
r(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
force(N,D) numpy.ndarray

Array of forces for N particles in D dimensions. Local +for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
n_typesint

Number of different unique types present in the simulation system. +n_types is global, i.e. the same for all MPI ranks even if some +ranks contain zero particles of certain types.

+
+
+
+
+
+ +
+
+hymd.field.compute_self_energy_q(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the self energy for the interaction due to the Ewald scheme +used to compute the electrostatics. The energy is stored in config.

+

The self interaction energy is given by:

+
+\[U_{self} = \sqrt{\frac{1}{2\pi\sigma^2}} \sum_{i=1}^{N} q_i^2\]
+

where \(q_i\) are the charges and \(\sigma\) is the half-width +of the Gaussian filter.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
Returns:
+
+
field_q_self_energyfloat

Electrostatic self energy.

+
+
+
+
+
+ +
+
+hymd.field.domain_decomposition(positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs domain decomposition

+

Rearranges the MPI rank memory layout into one that better mimics the PFFT +pencil grid 2D decomposition. As molecules are always required to be fully +contained on a single MPI rank, a perfect decomposition is not always +possible. The best decomposition which leaves the center of mass of all +molecules in their respective correct domains is used, with possible +overlap into neighbouring domains if the spatial extent of any molecule +crosses domain boundaries.

+
+
Parameters:
+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
*args

Variable length argument list containing arrays to include in the +domain decomposition.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
bonds(N,M) numpy.ndarray, optional

Array of M bonds originating from each of N particles.

+
+
verboseint, optional

Specify the logging event verbosity of this function.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
Domain decomposedcode:positions and any array specified in
+
:code:`*args`, in addition tocode:bonds and molecules if these
+
arrays were provided as input.
+
+
+
+
+ +
+
+hymd.field.initialize_pm(pmesh, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates the necessary pmesh objects for pfft operations.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pmobject ‘pmesh.pm.ParticleMesh’
+
field_listlist[pmesh.pm.RealField], (multiple)

Essential list of pmesh objects required for MD

+
+
list_coulomblist[pmesh.pm.RealField], (multiple)

Additional list of pmesh objects required for electrostatics.

+
+
+
+
+
+ +
+
+hymd.field.update_field(phi, phi_laplacian, phi_transfer, layouts, force_mesh, hamiltonian, pm, positions, types, config, v_ext, phi_fourier, v_ext_fourier, m, compute_potential=False)[source]
+

Calculate the particle-field potential and force density

+

If compute_potential is True, the energy may subsequently +be computed by calling compute_field_and_kinetic_energy.

+

Computes the particle-field external potential \(V_\text{ext}\) from +particle number densities through the smoothed density field, +\(\phi(\mathbf{r})\). With \(P\) being the cloud-in-cell (CIC) +window function, the density and filtered densities are computed as

+
+\[\phi(\mathbf{r}) = \sum_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\phi(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +external potential is computed in reciprocal space as

+
+\[V_\text{ext} = \mathrm{FFT}^{-1}\left[ + \mathrm{FFT} + \left( + \frac{\partial w}{\partial \tilde\phi} + \right) + \mathrm{FFT}(H) +\right],\]
+

where \(w\) is the interaction energy functional. Differentiating +\(V_\text{ext}\) is done by simply applying \(i\mathbf{k}\) in +Fourier space, and the resulting forces are back-transformed to direct +space and interpolated to particle positions by

+
+\[\mathbf{F}_j = -\sum_{j_k} \nabla V_{j_k} + P(\mathbf{r}_{j_k} - \mathbf{r}_j)h^3,\]
+

where \(j_k\) are the neighbouring vertices of particle \(j\) at +position \(\mathbf{r}_j\), and \(h^3\) is the volume of each grid +voxel.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Pre-allocated, but empty; any values +in this field are discarded. Changed in-place. Local for each MPI +rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
configConfig

Configuration object.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Pre-allocated, but empty; any values in this field are +discarded Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
phi_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computational grid is represented by the collective fields of all +MPI ranks.

+
+
v_ext_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplesField objects containing discretized +particle-field external potential values in reciprocal space on the +computational grid; D+1 fields in D dimensions for each +particle type. D copies are made after calculation for later +use in force calculation, because the force transfer function +application differentiates the field in-place, ruining the contents +for differentiation in the remaining D-1 spatial directions. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
m: list[float], (M,)

pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. +Defaults to 1.0 for all particle types.

+
+
compute_potentialbool, optional

If True, a D+1-th copy of the Fourier transformed +external potential field is made to be used later in particle-field +energy calculation. If False, only D copies are made.

+
+
+
+
+
+

See also

+
+
compute_field_and_kinetic_energy

Compute the particle-field energy after the external potential is calculated.

+
+
+ +
+ +
+
+hymd.field.update_field_force_q(charges, phi_q, phi_q_fourier, psi, psi_fourier, elec_field_fourier, elec_field, elec_forces, layout_q, hamiltonian, pm, positions, config)[source]
+

Calculate the electrostatic particle-field forces on the grid

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential is computed in reciprocal space as

+
+\[\Phi = \mathrm{FFT}^{-1}\left[ + \frac{4\pi k_e}{\varepsilon \vert\mathbf{k}\vert^2} + \mathrm{FFT}(\rho)\mathrm{FFT}(H) +\right],\]
+

with the electric field

+
+\[\mathbf{E} = \mathrm{FFT}^{-1}\left[ + -i\mathbf{k}\,\mathrm{FFT}(\Psi) +\right].\]
+

In the following, let \(\mathbf{F}_j\) denote the electrostatic force +acting on the particle with index \(j\) and position +\(\mathbf{r}_j\). The interpolated electrostatic force is

+
+\[\mathbf{F}_j = \sum_k q_j\mathbf{E}_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(\mathbf{E}_{j_k}\) is the discretized electric field at grid +vertex \(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid +vertex with index \(j_k\), and \(h^3\) is the volume of each grid +voxel. The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty; any values in this field +are discarded. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
elec_field_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +electric field values in reciprocal space on the computational grid. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
+
+
+
+ +
+
+hymd.field.update_field_force_q_GPE(conv_fun, phi, types, charges, phi_q, phi_q_fourier, phi_eps, phi_eps_fourier, phi_eta, phi_eta_fourier, phi_pol_prev, phi_pol, elec_field, elec_forces, elec_field_contrib, psi, Vbar_elec, Vbar_elec_fourier, force_mesh_elec, force_mesh_elec_fourier, hamiltonian, layout_q, layouts, pm, positions, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Calculate the electrostatic particle-field forces on the grid, arising from +a general Poisson equation, i.e. anisotropic permittivity/dielectric. +The function is called when tomli input config.coulombtype = “PIC_Spectral_GPE.”

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential for a variable dielectric does not have an +analytical expression, and is computed in reciprocal through an iterative +method.

+

The GPE states that

+
+\[\nabla \cdot \left(\epsilon(\mathbf{r}) +\nabla{\mathbf{\psi(r)}}\right) = -\rho({\mathbf{r}}).\]
+

where \(\epsilon(\mathbf{r})\) is the relative dielectric function.

+
+
Parameters:
+
+
conv_funConvergence function.

Returns a scalar. Depends on MPI allreduce for similar convergence +across MPI ranks.

+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_eps_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_etapmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +gradients of the relative dielectric values on the computational grid. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank–the +full computational grid is represented by the collective fields of all MPI ranks.

+
+
phi_eta_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated discretized +Fourier transformed gradient relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_pol_prevpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charge values on the computational grid. Parameter in +the iterative method.Pre-allocated,but empty. Changedin-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_polpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charges on the computational grid. Parameter in the iterative +method, updating the next quess in solving for the electrostatic potential. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank– +the full computational grid is represented by the collective fields of +all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all +MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
elec_field_contribpmesh.pm.RealField

Pmesh RealField object for storing +\(|\mathbf{E(r)}|^2/\phi_{0}\) on the computational grid. +Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
psipmesh.pm.RealField

Pmesh RealField object for storing electrostatic potential +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
Vbar_elecmesh.pm.RealField

Pmesh RealField object for storing functional derivatives of +:math:`|w({ phi })_{elec}`on the computational grid. +Pre-allocated, but empty. Changed in-place. Local for each MPI rank– +the full computational grid is represented by the collective fields of

+
+

all MPI ranks.

+
+
+
Vbar_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated functional +derivatives of \(\|w(\{ \phi \})_{elec}\) in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
force_mesh_elecpmesh.pm.RealField

Pmesh RealField object for storing electrostatic force values +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
force_mesh_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated electrostatic +force values in reciprocal space on the computational grid. Local for +each MPI rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
layouts: list[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
comm: mpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
compute_field_energy_q_GPE

Compute the electrostatic energy after electrosatic force is calculated for a variable (anisotropic) dielectric general Poisson equation.

+
+
+ +
+ +
+
+

4.8. File input/output

+

Handle file input/output in parllel HDF5 fashion

+
+
+class hymd.file_io.OutDataset(dest_directory, config, double_out=False, disable_mpio=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

HDF5 dataset handler for file output

+
+
+close_file(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Closes the HDF5 output file

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+
+flush()[source]
+

Flushes output buffers, forcing file writes

+
+ +
+
+is_open(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if HDF5 output file is open

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+ +
+
+hymd.file_io.distribute_input(in_file, rank, size, n_particles, max_molecule_size=201, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Assign global arrays onto MPI ranks, attempting load balancing

+

Distributes approximately equal numbers of particles (workload) onto each +independent MPI rank, while respecting the requirement that any molecule +must be fully contained on a single MPI rank only (no splitting molecules +across multiple CPUs).

+
+
Parameters:
+
+
in_fileh5py.File

HDF5 input file object.

+
+
rankint

Local rank number for this MPI rank.

+
+
sizeint

Global size of the MPI communicator (number of total CPUs).

+
+
n_particlesint

Total number of particles.

+
+
max_molecule_sizeint, optional

Maximum size of any molecule present in the system. Used to initially +guess where the MPI rank boundaries (start/end indices) in the global +arrays should be placed. If molecules of size +>max_molecule_size exist in the simulation system, HyMD +might work as expected. Or it might fail spectacularly.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
rank_range

Starting and ending indices in the global arrays for each MPI rank.

+
+
+
+
+
+ +
+
+hymd.file_io.setup_time_dependent_element(name, parent_group, n_frames, shape, dtype, units=None)[source]
+

Helper function for setting up time-dependent HDF5 group datasets

+

All output groups must adhere to the H5MD standard, meaning a structure of

+
+
┗━ group particle group (e.g. all) or observables group
+
+
┗━ group time-dependent data
+
+
┣━ dataset step shape=(n_frames,)
+
┣━ dataset time shape=(n_frames,)
+
┗━ dataset value shape=(n_frames, *)
+
+
+
+

is necessary.

+

References

+
+
H5MD specification :

https://www.nongnu.org/h5md/h5md.html

+
+
+
+ +
+
+hymd.file_io.store_data(h5md, step, frame, indices, positions, velocities, forces, box_size, temperature, pressure, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, field_energy, field_q_energy, plumed_bias, time_step, config, velocity_out=False, force_out=False, charge_out=False, plumed_out=False, dump_per_particle=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Writes time-step data to HDF5 output file

+

Handles all quantities which change during simulation, as opposed to +static quanitities (see store_static).

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
stepint

Step number.

+
+
frameint

Output frame number (step // n_print).

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
positions(N,) numpy.ndarray

Array of positions for N particles in D dimensions.

+
+
velocities(N,) numpy.ndarray

Array of velocities for N particles in D dimensions.

+
+
forces(N,) numpy.ndarray

Array of forces for N particles in D dimensions.

+
+
box_size(D,) numpy.ndarray

Array containing the simulation box size.

+
+
temperaturefloat

Calculated instantaneous temperature.

+
+
kinetic_energyfloat

Calculated instantaneous kinetic energy.

+
+
bond2_energyfloat

Calculated instantaneous harmonic two-particle bond energy.

+
+
bond3_energyfloat

Calculated instantaneous harmonic angular three-particle bond energy.

+
+
bond4_energyfloat

Calculated instantaneous dihedral four-particle torsion energy.

+
+
field_energyfloat

Calculated instantaneous particle-field energy.

+
+
field_q_energyfloat

Calculated instantaneous electrostatic energy.

+
+
plumed_biasfloat

PLUMED instantaneous bias energy.

+
+
time_stepfloat

Value of the time step.

+
+
configConfig

Configuration object.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charge_outbool, optional

If True, electrostatic energies are written to the output +HDF5 file.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to the output HDF5 file.

+
+
dump_per_particlebool, optional

If True, all quantities are written per particle.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
store_static

Outputs all static time-independent quantities to the HDF5 output file

+
+
+ +
+ +
+
+hymd.file_io.store_static(h5md, rank_range, names, types, indices, config, bonds_2_atom1, bonds_2_atom2, molecules=None, velocity_out=False, force_out=False, charges=False, dielectrics=False, plumed_out=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Outputs all static time-independent quantities to the HDF5 output file

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
rank_rangelist[int]

Start and end indices for global arrays for each MPI rank.

+
+
names(N,) numpy.ndarray

Array of names for N particles.

+
+
types(N,) numpy.ndarray

Array of type indices for N particles.

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
configConfig

Configuration object.

+
+
bonds_2_atom1(B,) numpy.ndarray

Array of indices of the first particle for B total +two-particle bonds.

+
+
bonds_2_atom2(B,) numpy.ndarray

Array of indices of the second particle for B total +two-particle bonds.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles.

+
+
dielectrics(N,) numpy.ndarray

Array of particle relative dielectric values for N particles.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to output HDF5 file.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
prepare_bonds

Constructs two-, three-, and four-particle bonds from toplogy input file and bond configuration information.

+
+
distribute_input

Distributes input arrays onto MPI ranks, attempting load balancing.

+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/doc_pages/benchmarks.html b/v1.0.4/doc_pages/benchmarks.html new file mode 100644 index 00000000..f9f26a78 --- /dev/null +++ b/v1.0.4/doc_pages/benchmarks.html @@ -0,0 +1,300 @@ + + + + + + + 3. Benchmarks — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Benchmarks

+

Homopolymer melt test systems of \(30^2\), \(40^2\), and \(50^2\) +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively.

+
+

3.1. Bonded forces

+

Legend label denotes the number of particles in the system.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-1.png +
+
+
+

3.2. Particle–field forces

+

Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-2.png +
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/doc_pages/command_line.html b/v1.0.4/doc_pages/command_line.html new file mode 100644 index 00000000..8f481086 --- /dev/null +++ b/v1.0.4/doc_pages/command_line.html @@ -0,0 +1,357 @@ + + + + + + + 5. Command line arguments — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. Command line arguments

+

Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle–field interactions.

+
+

5.1. Required arguments

+
+
configuration file:
+

type positional

+

Specifies the .toml format configuration file containing simulation details. See Configuration file for details.

+
+
structure and topology file:
+

type positional

+

Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See Topology and structure file for details.

+
+
+
+
+

5.2. Optional arguments

+
+
-v  --verbose

type optional

+

Number of following arguments: 0 or 1

+

Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying -v or --verbose with no additional specification. This increases verbosity level by 1. Alternatively, it maye be specified by --verbose V with V being 0, 1, or 2.

+
+
--profile

type optional

+

Number of following arguments: 0

+

Enables code profiling using cProfile. This will output one profiling file per MPI rank invoked in the simulation.

+
+
--double-precision

type optional

+

Number of following arguments: 0

+

Specify usage of double precision internally in HyMD (including in the FFTs).

+
+
--double-output

type optional

+

Number of following arguments: 0

+

Specify usage of double precision in the output trajectory from HyMD.

+
+
--velocity-output

type optional

+

Number of following arguments: 0

+

Specify that velocities should be output to the HyMD trajectory.

+
+
--force-output

type optional

+

Number of following arguments: 0

+

Specify that forces should be output to the HyMD trajectory.

+
+
--disable-mpio

type optional

+

Number of following arguments: 0

+

Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult.

+
+
--logfile

type optional

+

Number of following arguments: 1

+

Specifies the path of a plain text log file in which stdout is mirrored during simulation runs.

+
+
--seed

type optional

+

Number of following arguments: 1

+

Specifies the random seed used in the numpy random library to generate velocities, thermostatting, etc.

+
+
--disable-bonds

type optional

+

Number of following arguments: 0

+

Disable any two-particle bonds present in the system.

+
+
--disable-angle-bonds

type optional

+

Number of following arguments: 0

+

Disable any three-particle bonds present in the system.

+
+
--disable-dihedrals

type optional

+

Number of following arguments: 0

+

Disable any four-particle bonds present in the system.

+
+
--disable-dipole

type optional

+

Number of following arguments: 0

+

Disable any topological reconstruction of peptide backbone dipoles present in the system.

+
+
--disable-field

type optional

+

Number of following arguments: 0

+

Disable any particle–field interactions present in the system.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/doc_pages/config_file.html b/v1.0.4/doc_pages/config_file.html new file mode 100644 index 00000000..d0008fe6 --- /dev/null +++ b/v1.0.4/doc_pages/config_file.html @@ -0,0 +1,444 @@ + + + + + + + 3. Configuration file — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Configuration file

+

The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order.

+

The configuration file is a toml format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs.

+
+

3.1. Configuration file keywords

+

The following constitutes every possible keyword specification in HyMD +configuration files:

+
+

3.1.1. Metadata keywords

+

Configuration keywords specifying metadata for the H5MD output trajectory.

+
+
name:
+

string [optional, default: None]

+

Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file.

+
+
tags:
+

array [string] [optional, default: None]

+

Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file.

+
+
+
+
+

3.1.2. Particle keywords

+

Configuration keywords specifying properties of particles and molecules in the +system.

+
+
n_particles:
+

integer [optional, default: None]

+

Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules.

+
+
mass:
+

float [optional, default: 72.0] {units: \(\text{u}=\text{g}\,\text{mol}^{-1}\)}

+

Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal.

+
+
max_molecule_size:
+

integer [optional, default: 201]

+

Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code will crash if there are molecules larger than max_molecule_size in the topology/structure input file.

+
+
+
+
+

3.1.3. Simulation keywords

+

Configuration keywords specifying simulation parameters.

+
+
n_steps:
+

integer [required]

+

Total number of integration steps to perform for this simulation.

+
+
n_print:
+

integer or boolean [optional, default: False]

+

Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of number of time steps).

+
+
n_flush:
+

integer [optional, default: None]

+

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of number of n_print, i.e. n_print = 13, n_flush = 3 would result in the trajectory/energy being written to disk every 13 x 3 = 39 simulation steps)

+
+
time_step:
+

float [required] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time step per integration step. If the rRESPA multiple time step integrator is used (integrator = "respa"), this specifies the inner time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is respa_inner times the time_step , and the total simulation time is n_steps times time_step times respa_inner .

+
+
box_size:
+

array [float] [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable.

+
+
integrator:
+

string [required] (options: velocity-verlet or respa)

+

Specifies the time integrator used in the simulation. If respa, the reversible reference system propagator algorithm (rRESPA) [Tuckerman et al., 1992] integrator is used, with respa_inner number of inner (intramolecular force) time steps. If velocity-verlet, a normal Velocity Verlet integrator is used. If respa and respa_inner = 1, the rRESPA integrator is equivalent to the Velocity Verlet.

+
+
respa_inner:
+

integer [optional, default: 1]

+

The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces.

+
+
domain_decomposition:
+

integer or boolean [optional, default: False]

+

Specifies the interval (in time steps) of domain decomposition exchange, involving all MPI ranks sending and receiving particles according to the particles’ positions in the integration box and the MPI ranks’ assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If True, the decomposition is performed once (before starting the simulation). If False, no decomposition is performed.

+
+
cancel_com_momentum:
+

integer or boolean [optional, default: False]

+

If True, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every remove_com_momentum time steps. If False, the linear momentum is never removed.

+
+
start_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at start_temperature Kelvin prior to starting the simulation. If False, the velocities are not changed before starting the simulation.

+
+
target_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Couple the system to a heat bath at target_temperature Kelvin by applying a Canonical sampling through velocity rescaling [Bussi et al., 2007] thermostat with coupling strength tau. If False, no temperature control is applied.

+
+
tau:
+

float [optional, default: 0.7] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the CSVR thermostat coupling. In the limit of tau , the Hamiltonian dynamics are preserved and no temperature coupling takes place.

+
+
thermostat_coupling_groups:
+

array [array [string]] [optional, default: []]

+

Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing "A", "B", and "C" type particles, thermostat_coupling_groups = [["A", "B"], ["C"],] would thermalise types "A" and "B" together and couple "C" type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. target_temperature Kelvin).

+
+
hamiltonian:
+

string [optional, default: "DefaultNohChi"] (options: SquaredPhi, DefaultNohChi, or DefaultWithChi)

+

Specifies the interaction energy functional \(W[\tilde\phi]\) for use with the particle-field interactions. See Interaction energy functionals for details.

+
+
+
+
+

3.1.4. Field keywords

+

Configuration keywords specifying field parameters.

+
+
mesh_size:
+

array [integer] or integer [required]

+

Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is box_size / mesh_size.

+
+
kappa:
+

float [required] {units: \(\text{kJ}^{-1}\text{mol}\)}

+

Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional \(W[\tilde\phi]\). See Interaction energy functionals for more details.

+
+
sigma:
+

float [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See Filtering for more details.

+
+
chi:
+

array [array [string, float]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\)}

+

Array of \(\tilde\chi_\text{AB}\)-parameters indicating the strength of the repulsive or attractive interaction between particles of type "A" and the number density due to particles of type "B", and vice versa. Example: chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ] would specify a repulsive "A""B" type interaction, and a weakly attractive "C""D" interaction. Self-interaction \(\tilde\chi\)-terms are always zero. See Interaction energy functionals for more details.

+
+
+
+
+

3.1.5. Bond keywords

+

Configuration keywords specifying bonds and bonds parameters.

+
+
bonds:
+

array [array [2 string, 2 float]] [optional, default: []] {units: \(\text{nm}=10^{-9}~\text{m}\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+

Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ] indicates a "A""A" bond of equilibrium length 0.47 \(\text{nm}\) with a bond strength of 980.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding bond between "A" and "B" type particles with equilibrium length 0.31 \(\text{nm}\) and a strength of 1250.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify stretching bonds.

+
+
angle_bonds:
+

array [array [3 string, 2 float]] [optional, default: []] {units: \({}^\circ\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+
+

Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ] indicates a "A""A""A" angular bond that tries to keep the bond linear at 180 degrees with a bending strength of 55.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding angle bond between "A""B""B" prefering the angle at 120 degrees and a strength of 25.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify angular bonds.

+
+
+
dihedrals:
+

array [array [4 string, integer, COSINE SERIES ]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)}

+

Specifies four-particle torsional potentials by cosine series. See Intramolecular bonds for details about how to specify dihedrals.

+
+
+
+
+

3.1.6. Electrostatic keywords

+

Configuration keywords specifying electrostatics and electrostatic parameters.

+
+
coulombtype:
+

string [optional, default: None] (options: PIC_Spectral)

+

Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the dielectric_const keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, not in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to PIC_Spectral.

+
+
dielectric_const:
+

float [optional, default: None]

+

Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified—even if electrostatics are not included with the coulombtype keyword.

+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/doc_pages/constants_and_units.html b/v1.0.4/doc_pages/constants_and_units.html new file mode 100644 index 00000000..6e7bf41b --- /dev/null +++ b/v1.0.4/doc_pages/constants_and_units.html @@ -0,0 +1,391 @@ + + + + + + + 6. Constants and Units — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

6. Constants and Units

+

HyMD uses the following units and constants internally and in all input and +output:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Units

Quantity

Symbol

Unit

length

\(r\)

\(\text{nm}=10^{-9}~\text{m}\)

time

\(t\)

\(\text{ps}=10^{-12}~\text{s}\)

charge

\(q\)

\(e=1.602176634 \cdot 10^{-19}~\text{C}\)

mass

\(m\)

\(\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}\)

temperature

\(\text{T}\)

\(\text{K}\)

energy

\(E\)

\(\text{kJ}\,\text{mol}^{-1}\)

velocity

\(v\)

\(\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}\)

momentum

\(P\)

\(\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}\)

force

\(\mathbf{F}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}\)

pressure

\(p\)

\(\text{bar}=100~\text{kPa}\)

electric potential

\(\Psi\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}\)

electric field

\(\mathbf{E}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}\)

compressibility

\(\kappa\)

\(\text{mol}\,\text{kJ}^{-1}\)

field-interaction

\(\tilde\chi\)

\(\text{kJ}\,\text{mol}^{-1}\)

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants

Constant

Symbol

Value

gas constant

\(R\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Boltzmann’s constant

\(k_\text{B}\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Avogadro’s constant

\(N_\text{A}\)

\(6.02214076 \cdot 10^23~\text{mol}^{-1}\)

Vacuum permittivity

\(\varepsilon_0\)

\(8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2\)

Coulomb constant

\(k_\text{e}\)

\(138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}\)

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/doc_pages/electrostatics.html b/v1.0.4/doc_pages/electrostatics.html new file mode 100644 index 00000000..80da2a73 --- /dev/null +++ b/v1.0.4/doc_pages/electrostatics.html @@ -0,0 +1,312 @@ + + + + + + + 3. Electrostatic interactions — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Electrostatic interactions

+

In the filtered Hamiltonian hPF formalism [Bore and Cascella, 2020] the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle–mesh Ewald.

+

The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered

+
+\[\tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i),\]
+

with \(q_i\) being the charge of particle \(i\) and \(H\) is the +filtering function (see Filtering). The value of the charge grid at +vertex \((i,j,k)\) is found by

+
+\[\tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)]\]
+

and the electrostatic potential \(\Psi_{ijk}\)

+
+\[\Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right],\]
+

where \(k_\text{e}\) is the Coulomb constant \(1/4\pi\varepsilon_0\). +The electric field is obtained by differentiation of the electrostatic +potential in Fourier space,

+
+\[\mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)]\]
+

from which the forces are interpolated back to the particle positions.

+
+

3.1. Specifying electrostatics

+

In HyMD, electrostatics are specified by the coulombtype and +dielectric_const keywords in the configuration file (see +Configuration file) and the /charge dataset in the HDF5 format +structure/topology input file (see Topology and structure file). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/doc_pages/examples.html b/v1.0.4/doc_pages/examples.html new file mode 100644 index 00000000..0aea0bea --- /dev/null +++ b/v1.0.4/doc_pages/examples.html @@ -0,0 +1,760 @@ + + + + + + + 1. Examples — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Examples

+

The following examples are ordered in more or less order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the HyMD-tutorial github repository.

+
+

1.1. Ideal gas

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true +

The simplest possible system is one with no interactions at all—intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like:

+
+
ideal_gas.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = false         # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+
+
+

A simple input structure/topology file ideal_gas.HDF5 is available in +the HyMD-tutorial/ideal_gas github repository (along with the code to +generate it). Run the (very) short simulation by

+
python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field   \
+                                              --velocity-output \
+                                              --force-output
+
+
+

with the --disable-field argument to completely turn off all +particle–field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook ideal_gas.ipynb for details.

+
+
+

1.2. Ideal chains

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true +

The simplest available interaction is the harmonic two-particle bond (see +Intramolecular bonds),

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2.\]
+

Extending the configuration file from the ideal gas case, we need to add a +bonds specification. Note that the [bonds] meta specifier is not +necessary, but may be used to help organise the input file.

+
+
ideal_chain.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+
+
+

A simple input structure/topology file ideal_chain.HDF5 with a few +coiled up ideal chain polymers is available in the +HyMD-tutorial/ideal_chain github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field
+
+
+

we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +ideal_chain.ipynb.

+
+
+

1.3. Stiff rods

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true +

Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the i--j--k angle \(\theta\) (see +Intramolecular bonds),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2.\]
+

Extending the configuration file from the ideal chain case, we need to add a +angle_bonds specification. Note that the [bonds] meta specifier +is not necessary, but may be used to help organise the input file.

+
+
rods.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+angle_bonds = [
+  ["A", "A", "A", 180.0, 100.0],   # (i, j, k, equilibrium angle, strength)
+]
+
+
+
+

A simple input structure/topology file rods.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook rods.ipynb.

+
+
+

1.4. Helixes

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true +

Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle \(\phi\) between the +i--j--k plane and the j--k--l plane (see Intramolecular bonds),

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n).\]
+

The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a dihedrals keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the dielectric_const +keyword even though we are not including electrostatic forces in the current +simulation. Note that the [bonds] meta specifier is not necessary, but +may be used to help organise the input file.

+
+
helixes.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+dielectric_const = 15.0
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.31, 10000.0],       # (i name, j name, equilibrium length, strength)
+]
+
+dihedrals = [
+  [
+    ["A", "A", "A", "A"],
+    [
+      [-1],
+      [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+      [0.08, 0.46, 1.65, -0.96, 0.38],
+    ],
+    [1.0]
+  ],
+]
+
+
+
+

A simple input structure/topology file helixes.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook helixes.ipynb.

+
+
+

1.5. Phase separation

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true +

The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types A and B. Using the Hamiltonian

+
+\[\mathcal{H}=H_0+W\]
+

with \(\tilde\chi\)–dependent interactions defined by (specified in the +configuration file by hamiltonian = DefaultWithChi):

+
+\[W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2.\]
+
+
phase_separation.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+
+[field]
+mesh_size = [20, 20, 20]           # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+kappa = 0.05                       # compressibility in mol/kJ
+chi = [
+  ['A', 'B', 5.0],                 # (name i, name j, strength)
+]
+
+
+
+

A simple input structure/topology file phase_separation.HDF5 containing +an equal number of A type and B type particles is available in +the HyMD-tutorial/phase_separation github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd phase_separation.toml phase_separation.HDF5
+
+
+

we may examine the resulting trajectory. In the case of a low interaction +strength \(\tilde\chi\) of 5.0 (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to 40.0 (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +phase_separation.ipynb.

+
+
+

1.6. Diblock copolymers

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true +

Having introduced particle–field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive \(\tilde\chi\)–interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the integrator = "respa" keyword. Putting the pieces together, the +configuration file may look like the following:

+
+
copolymer.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 15
+n_steps = 2000                     # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [10.0, 10.0, 10.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [50, 50, 50]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+chi = [
+  ["A", "B", 30.0],                # (i, j, strength)
+]
+
+[bonds]
+bonds = [
+  ["A", "A", 0.25, 1500.0],        # (i, j, equilibrium length, strength)
+  ["A", "B", 0.25, 1500.0],
+  ["B", "B", 0.25, 1500.0],
+]
+angle_bonds = [
+  ["A", "A", "A", 180.0, 25.0],    # (i, j, k, equilibrium angle, strength)
+  ["B", "B", "B", 180.0, 25.0],
+]
+
+
+
+

A simple input structure/topology file copolymer.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/copolymer github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten A followed by ten B type particles. +Running the simulation with

+
python3 -m hymd copolymer.toml copolymer.HDF5
+
+
+

the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +copolymer.ipynb.

+
+
+

1.7. Lipid bilayer self-assembly

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true +

Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field–particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the thermostat_coupling_groups keyword. With parameters +optimised in [Ledum et al., 2020], the configuration file looks like:

+
+
lipid_self_assembly.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 25
+n_steps = 3000
+n_print = 200
+n_flush = 1
+time_step = 0.01
+box_size = [9.96924, 9.96924, 10.03970]
+start_temperature = 323
+target_temperature = 323
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.05
+domain_decomposition = 10001
+cancel_com_momentum = true
+max_molecule_size = 15
+thermostat_coupling_groups = [
+  ["N", "P", "G", "C"],
+  ["W"],
+]
+
+[field]
+mesh_size = [25, 25, 25]
+sigma = 1.0
+chi = [
+  ["C", "W", 42.24],
+  ["G", "C", 10.47],
+  ["N", "W", -3.77],
+  ["G", "W", 4.53],
+  ["N", "P", -9.34],
+  ["P", "G", 8.04],
+  ["N", "G", 1.97],
+  ["P", "C", 14.72],
+  ["P", "W", -1.51],
+  ["N", "C", 13.56],
+]
+
+[bonds]
+bonds = [
+  ["N", "P", 0.47, 1250.0],
+  ["P", "G", 0.47, 1250.0],
+  ["G", "G", 0.37, 1250.0],
+  ["G", "C", 0.47, 1250.0],
+  ["C", "C", 0.47, 1250.0],
+]
+angle_bonds = [
+  ["P", "G", "G", 120.0, 25.0],
+  ["P", "G", "C", 180.0, 25.0],
+  ["G", "C", "C", 180.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

A randomly mixed input structure/topology file +lipid_self_assembly.HDF5 with a few hundred lipids in a roughy +10 x 10 x 10nm box is available in the +HyMD-tutorial/lipid_self_assembly github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation

+
python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5
+
+
+

we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook lipid_self_assembly.ipynb.

+
+
+

1.8. Peptide in lipid bilayer

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true +

Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer.

+

The configuration file is available in the HyMD-tutorial/peptide github +repository (omitted here for brevity).

+

A pre-equilibrated input structure/topology file peptide.HDF5 with a +few hundred lipids in a roughy 20 x 20 x 20nm box is available in the +HyMD-tutorial/peptide github repository. Running the simulation

+
python3 -m hymd peptide.toml peptide.HDF5
+
+
+

we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook peptide.ipynb.

+
+
+

1.9. SDS

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true +

The last part we introduce is explicit electrostatic interactions through +particle–mesh Ewald. Enabling the electrostatic calculations is done via the +coulombtype keyword. "PIC_Spectral" is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the dielectric_const keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge.

+
+
sds.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 10
+n_steps = 3000
+n_print = 1500
+n_flush =
+time_step = 0.01
+box_size = [8.3, 8.3, 8.3]
+start_temperature = 298
+target_temperature = 298
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.1
+domain_decomposition = 10000
+cancel_com_momentum = true
+max_molecule_size = 5
+thermostat_coupling_groups = [
+  ["S", "C"],
+  ["W", "Na"],
+]
+dielectric_const = 45.0              # dielectric constant for the simulation medium
+coulombtype = "PIC_Spectral"         # particle in cloud, spectral method
+
+[field]
+mesh_size = [64, 64, 64]
+sigma = 0.5
+chi = [
+  ["S", "C",  13.50],
+  ["S", "Na",  0.00],
+  ["S", "W",  -3.60],
+  ["C", "Na", 13.50],
+  ["C", "W",  33.75],
+  ["W", "Na",  0.00],
+]
+
+[bonds]
+bonds = [
+  ["S",   "C",   0.50, 1250.0],
+  ["C",   "C",   0.50, 1250.0],
+]
+angle_bonds = [
+  ["S", "C", "C", 170.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

An input structure/topology file sds.HDF5 with a couple thousand +randomly dispersed SDS chains is available in the HyMD-tutorial/sds github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a /charge dataset. +Running the simulation with

+
python3 -m hymd sds.toml sds.HDF5
+
+
+

we observe the aggregation of the SDS into micellular structures—first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook sds.ipynb.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/doc_pages/filtering.html b/v1.0.4/doc_pages/filtering.html new file mode 100644 index 00000000..0d3a43ae --- /dev/null +++ b/v1.0.4/doc_pages/filtering.html @@ -0,0 +1,299 @@ + + + + + + + 2. Filtering — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Filtering

+

The default grid-independent filter function used in HyMD is a Gaussian

+
+\[H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right]\]
+

with reciprocal space representation

+
+\[\hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right].\]
+

The coarse-graining parameter \(\sigma\) determines a length scale of +particle extent and is given as configuration file input by

+
sigma = 0.75
+
+
+
+

2.1. Implementing new filters

+

Implementing new filter functions is straightforward by hijacking +the setup method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/doc_pages/installation.html b/v1.0.4/doc_pages/installation.html new file mode 100644 index 00000000..a5a32fc3 --- /dev/null +++ b/v1.0.4/doc_pages/installation.html @@ -0,0 +1,407 @@ + + + + + + + 1. Installation — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Installation

+

HyMD may be installed using pip by

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+
+

1.1. Dependencies

+

HyMD requires a working MPI compiler and HDF5. On an Ubuntu system, this +may be installed via

+
sudo apt-get update -y
+sudo apt-get install -y libhdf5-openmpi-dev python3-mpi4py
+CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-cache-dir --no-binary=h5py h5py
+
+
+

It is highly recommended to have MPI-enabled HDF5 and h5py. A +non-MPI-enabled h5py may be installed by simply

+
sudo apt-get update -y
+sudo apt-get install libhdf5-serial-dev
+python3 -m pip --upgrade install h5py
+
+
+

A non-MPI-enabled HDF5 library with corresponding h5py will work +(mostly), but is inconvenient and slow. Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +--disable-mpio argument to HyMD, see Command line arguments. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial.

+
+
+

1.2. Install in docker

+

A docker image with build essentials setup is available at dockerhub with tag +mortele/hymd,

+
docker pull mortele/hymd:latest
+docker run -it mortele/hymd
+/app$ python3 -m pip install hymd
+
+# Grab example input files
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5
+
+# Run simulation
+/app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose
+
+
+
+
+

1.3. Run interactively in Google Colaboratory

+

A Google Colaboratory jupyter notebook is setup here with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons.

+
+
+

1.4. Common issues

+
+

1.4.1. Numpy errors while importing the Fortran force kernels

+
RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd
+
+Traceback (most recent call last):
+
+  (...)
+
+File "/..../HyMD/hymd/__init__.py", line 2, in <module>
+  from .main import main  # noqa: F401
+File "/..../HyMD/hymd/main.py", line 10, in <module>
+  from .configure_runtime import configure_runtime
+File "/..../hymd/configure_runtime.py", line 12, in <module>
+  from .input_parser import read_config_toml, parse_config_toml
+File "/..../HyMD/hymd/input_parser.py", line 12, in <module>
+  from .force import Bond, Angle, Dihedral, Chi
+File "/..../HyMD/hymd/force.py", line 8, in <module>
+  from force_kernels import (  # noqa: F401
+ImportError: numpy.core.multiarray failed to import
+
+
+

can normally be fixed by updating numpy versions,

+
python3 -m pip install -U numpy
+
+
+
+
+

1.4.2. Error building pfft-python due to missing curl/wget

+
Building wheel for pfft-python (setup.py) ... error
+ERROR: Command errored out with exit status 1:
+command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_
+cwd: /tmp/pip-install-fr6nt9m4/pfft-python/
+Complete output (56 lines):
+running bdist_wheel
+running build
+running build_py
+
+  (...)
+
+curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found
+wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found
+Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+Please check curl or wget
+You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/
+Traceback (most recent call last):
+  File "<string>", line 1, in <module>
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in <module>
+    setup(
+  File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup
+    return distutils.core.setup(**attrs)
+  File "/usr/lib/python3.8/distutils/core.py", line 148, in setup
+
+  (...)
+
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions
+    build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:]))
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft
+    raise ValueError("could not build fftw; check MPICC?")
+ValueError: could not build fftw; check MPICC?
+----------------------------------------
+ERROR: Failed building wheel for pfft-python
+Running setup.py clean for pfft-python
+Failed to build pfft-python
+
+
+

can be fixed by installing either curl or wget

+
apt-get install -y curl wget
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/doc_pages/interaction_energy_functionals.html b/v1.0.4/doc_pages/interaction_energy_functionals.html new file mode 100644 index 00000000..0cb8513c --- /dev/null +++ b/v1.0.4/doc_pages/interaction_energy_functionals.html @@ -0,0 +1,352 @@ + + + + + + + 1. Interaction energy functionals — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Interaction energy functionals

+

A few interaction energy functionals \(W\) are defined in HyMD through +the Hamiltonian class and associated subclasses.

+
+

1.1. \(\chi\)–interaction and \(\kappa\)–incompressibility

+

The most common hPF energy functional is specified by

+
hamiltonian = "DefaultWithChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where \(\tilde\chi_{\text{A}-\text{B}}\) is the interaction energy between +overlapping densities of particle types \(\text{A}\) and \(\text{B}\). +The incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\tilde\chi\) +and \(\kappa\) in the configuration file (see Configuration file)

+
kappa = 0.05
+chi = [
+   ["A", "B", 15.85],
+   ["B", "C", -5.70],
+   ...
+]
+
+
+
+
+

1.2. Only \(\kappa\)–incompressibility

+

The only \(\kappa\) interactions energy functional is specified by

+
hamiltonian = "DefaultNoChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where the incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.3. Only \(\phi^2\)

+

The \(\phi^2\) interactions energy functional is specified by

+
hamiltonian = "SquaredPhi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2,\]
+

where the \(\phi\) squared term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.4. Implementing new interaction energy forms

+

Implementing new interaction energy functions is straightforward by subclassing +Hamiltonian and applying sympy differentiation to the symbolic +field objects. The sympy.lamdify function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/doc_pages/intramolecular_bonds.html b/v1.0.4/doc_pages/intramolecular_bonds.html new file mode 100644 index 00000000..0000ff2f --- /dev/null +++ b/v1.0.4/doc_pages/intramolecular_bonds.html @@ -0,0 +1,392 @@ + + + + + + + 2. Intramolecular bonds — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Intramolecular bonds

+

Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see Configuration file. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +Benchmarks), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable.

+

All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]).

+
+

2.1. Two-particle bonds

+

Stretching bonds in HyMD are implemented as harmonic spring potentials,

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2,\]
+

where \(r=|\mathbf{r}|\) is the inter-particle distance, \(k\) is a +constant of dimension energy (units \(\text{kJ}\,\text{mol}^{-1}\)), and +\(r_0\) is the equilibrum length of the bond (units: \(\text{nm}\)). The +force is calculated as

+
+\[F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r},\]
+

where \(\mathbf{r}\) is the vector pointing from \(i\) to \(j\).

+

In the configuration file, two-particle bonds are specified per particle type:

+
+
configuration_two_particle_example.toml
+
[bonds]
+bonds = [
+   ["A", "A", 0.47, 1250.0],
+   ["A", "B", 0.37,  940.0],
+   ["B", "C", 0.50, 1010.0],
+   ["C", "A", 0.42,  550.0],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.2. Three-particle bonds

+

Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle–particle–particle angle \(\theta\),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2,\]
+

where \(k\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\)), and \(\theta_0\) is the equilibrum +angle of the bond (units: \({}^\circ\)). Defining the particles with labels +\(a\), \(b\), and \(c\), let \(\mathbf{r}_a\) denote the vector +pointing from \(b\) to \(a\), and correspondingly let +\(\mathbf{r}_c\) point from \(b\) to \(c\). The +\(a\)\(b\)\(c\) may be computed through the law of Cosines,

+
+\[\theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right]\]
+

Then the force acting on \(a\) and \(c\) is

+
+\[ \begin{align}\begin{aligned}\mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a},\\\mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c},\end{aligned}\end{align} \]
+

and

+
+\[\mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c\]
+

In the configuration file, three-particle bonds are specified per particle type:

+
+
configuration_three_particle_example.toml
+
[bonds]
+angle_bonds = [
+   ["A", "A", "A", 180.0, 90.0],
+   ["A", "B", "A", 120.0, 55.0],
+   ["B", "C", "C",  30.0, 10.0],
+   ["C", "A", "B", 110.0, 25.5],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.3. Four-particle bonds

+

Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle \(\phi\) between the +\(a\)\(b\)\(c\) and \(b\)\(c\)\(d\) planes, for +a dihedral bond quartet \(a\), \(b\), \(c\), and \(d\). The +potential takes the form

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n),\]
+

where \(c_n\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)), and \(\phi_n\) are +specified phase angles in the cosine series.

+

In the configuration file, four-particle bonds are specified per particle type:

+
+
configuration_four_particle_example.toml
+
[bonds]
+dihedrals = [
+   ["A", "B", "C", "D"],
+   [
+     [-1],
+     [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+     [0.08, 0.46, 1.65, -0.96, 0.38],
+   ],
+   [1.0],
+]
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/doc_pages/overview.html b/v1.0.4/doc_pages/overview.html new file mode 100644 index 00000000..c1566fdb --- /dev/null +++ b/v1.0.4/doc_pages/overview.html @@ -0,0 +1,413 @@ + + + + + + + 2. Usage overview for HylleraasMD — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Usage overview for HylleraasMD

+

HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a toml format configuration file, along with a topology and structure +file specifying the input system in HDF5 format.

+

Configuration file

+

The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a [5, 5, 5] nm simulation box at 300 K may look like +the following:

+
+
config_simple_1.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "SquaredPhi"         # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [30, 30, 30]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+
+
+
+

Note that for the version 1.0 release of HyMD, the [particles], +[simulation], and [field] groups are optional specifiers for +structuring the configuration file.

+

For a full specification of every recognised configuration keyword in HyMD, +please refer to Configuration file.

+

Topology and structure file

+

The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +N particles may look like the following:

+
+
example_structure.HDF5
+
group   /
+   # root group
+
+dataset /coordinates
+   # float32, shape (T, N, D,)
+   # Time steps of N rows of D dimensional coordinate data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /velocities
+   # float32, shape (T, N, D,) OPTIONAL
+   # Time steps of N rows of D dimensional velocity data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /bonds
+   # int32,   shape (N, B,)    OPTIONAL
+   # Each row i contains indices of the particles bonds from/to i
+   # B denotes the maximum bonds per particle
+
+dataset /indices
+   # int32,   shape (N,)
+   # Index of each particle, 0--(N-1)
+
+dataset /molecules
+   # int32,   shape (N,)
+   # Index of molecule each particle belongs to
+   # Used to construct bond network locally on MPI ranks
+
+dataset /names
+   # str10,   shape (N,)
+   # Fixed size string array containing particle type names
+
+dataset /types
+   # int32,   shape (N,)       OPTIONAL
+   # Mapping of particle names to type indices
+
+
+
+

For a full specification of the topology and structure input file, see +Topology and structure file.

+

Command line arguments

+

A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the config_simple_1.toml and example_structure.HDF5 +files may look like the following:

+
mpirun -n ${MPI_NUM_RANKS} python3 -m hymd         \  # HyMD executable
+                           config_simple_1.toml    \  # configuration file
+                           example_structure.HDF5  \  # structure file
+                           --logfile=log_out.txt   \  # set logfile path
+                           --seed 123456           \  # set random seed
+                           --verbose 2             \  # set logging verbosity
+                           --velocity-output          # enable velocity in trajectory output
+
+
+

For a full specification of all command line arguments, see +Command line arguments.

+

More examples

+

For more thorough rundown and concrete usage examples, see +Examples.

+
+

2.1. Running parallel simulations

+

Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the only difference being how the python3 interpreter is +invoked. Prepending mpirun -n ${NPROCS} to the usual +python3 -m hymd runs the simulation with ${NPROCS} MPI ranks.

+

Inputting

+
mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field
+
+
+

sets up an example simulation of the HyMD-tutorial/ideal_gas system. For +more details about this system in particular, or other example simulations, see +the HyMD-tutorial repository.

+
+
+

2.2. Running tests

+

Run serial code tests by

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd
+cd hymd/
+python3 -m pip install pytest pytest-mpi
+python3 -m pytest
+
+
+

There is a small convenience script in hymd/ for running the MPI-enabled +tests,

+
chmod +x pytest-mpi
+./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/doc_pages/theory.html b/v1.0.4/doc_pages/theory.html new file mode 100644 index 00000000..feca03c5 --- /dev/null +++ b/v1.0.4/doc_pages/theory.html @@ -0,0 +1,355 @@ + + + + + + + 1. Theory — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Theory

+

Hybrid particle–field simulations switch out the ordinary particle–particle +Lennard-Jones interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle–field densities are +defined as

+
+\[\phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i),\]
+

where \(\mathbf{r}\) is a spatial coordinate, \(P\) is a window function +used to distribute particle number densities onto a computational grid, and +\(\mathbf{r}_i\) is the position of particle \(i\) (of total \(N\)). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of \(N\) particles in \(M\) molecules is

+
+\[\mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})]\]
+

with \(H_0\) being a standard intramolecular Hamiltonian form (see +Intramolecular bonds) including kinetic terms, while \(W\) is a density +dependent interaction energy functional.

+

In the Hamiltonian hPF-MD formalism [Bore and Cascella, 2020], the density +field is filtered using a grid-independent filtering function \(H\),

+
+\[\tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}).\]
+

The filter smooths the density, ensuring that \(\tilde\phi\) and +\(W[\tilde\phi([\phi])]\) both converge as the grid size is reduced.

+
+

1.1. External potential

+

The external potential acting on a particle is defined as the functional +derivative of \(W\) with respect to \(\phi\). In the filtered formalism, +the potential takes the form

+
+\[\begin{split}V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ +&= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})},\end{split}\]
+

under the assumption of a local form of the interaction energy functional, +\(W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]\). Note +that

+
+\[\frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}).\]
+
+
+

1.2. Force interpolation

+

The forces on particle \(i\) are obtained by differentiation of the external +potential,

+
+\[\mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i).\]
+
+
+

1.3. Reciprocal space calculations

+

The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density \(\phi_{ijk}\) with CIC, we apply the filtering +and obtain the discrete version of the external potential by

+
+\[\tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big]\]
+

and

+
+\[V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+

The forces are obtained by differentiation of \(V\) in Fourier space as

+
+\[\nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+
+
+

1.4. Filter

+

By default, the filter used in HyMD is a simple Gaussian of the form

+
+\[\begin{split}H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ +\hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right].\end{split}\]
+

For more details about the filtering, see Filtering.

+
+
+

1.5. Hamiltonian form

+

The default form of the interaction energy functional in HyMD is

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2.\]
+

See Interaction energy functionals for details.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/doc_pages/topology_input.html b/v1.0.4/doc_pages/topology_input.html new file mode 100644 index 00000000..59e0d4ef --- /dev/null +++ b/v1.0.4/doc_pages/topology_input.html @@ -0,0 +1,336 @@ + + + + + + + 4. Topology and structure file — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Topology and structure file

+

The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root / group.

+

The HyMD-tutorial has multiple examples of structure files for various levels +of complexity.

+
+

4.1. Required datasets

+
+
/coordinates:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/indices:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/names:
+

array shape [N,]

+

datatype [string (length between 1 and 16)]

+

The shape represents one particle name per N particles. The datatype may be a string of length =<16.

+
+
+
+
+

4.2. Optional datasets

+
+
/velocities:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/types:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle type index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/molecules:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one molecule index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/bonds:
+

array shape [N, B,]

+

datatype [int32 or int64]

+

The shape represents B bond specifications (indices of different particles) per N particles. The data type may be either 32 or 64 bit integers.

+
+
/charge:
+

array shape [N,]

+

datatype [float32 or float64]

+

The shape represents one particle charge per N particles. The data type may be either four or eight byte reals.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/genindex.html b/v1.0.4/genindex.html new file mode 100644 index 00000000..805464b9 --- /dev/null +++ b/v1.0.4/genindex.html @@ -0,0 +1,814 @@ + + + + + + Index — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + +
+ +

F

+ + + +
+ +

G

+ + +
+ +

H

+ + + +
    +
  • + hymd.input_parser + +
  • +
  • + hymd.integrator + +
  • +
  • + hymd.thermostat + +
  • +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/index.html b/v1.0.4/index.html new file mode 100644 index 00000000..c703583a --- /dev/null +++ b/v1.0.4/index.html @@ -0,0 +1,400 @@ + + + + + + + HylleraasMD documentation — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

HylleraasMD documentation

+
+
Release:
+

1.0.4

+
+
Date:
+

Jan 10, 2022

+
+
+

HylleraasMD (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems.

+

HyMD can run canonical hPF-MD simulations [Milano and Kawakatsu, 2009], or filtered +density Hamiltonian hPF (HhPF-MD) simulations [Bore and Cascella, 2020], with +or without explicit PME electrostatic interactions [Kolli et al., 2018]. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +[Bore et al., 2018, Cascella et al., 2008]. Martini +style elastic networks (ElNeDyn) [Periole et al., 2009] are also +supported.

+

HyMD uses the pmesh (github.com/rainwoodman/pmesh) library for particle-mesh +operations, with the PPFT [Pippig, 2013] backend for FFTs through the +pfft-python bindings (github.com/rainwoodman/pfft-python). File IO is done +via HDF5 formats to allow MPI parallel reads.

+
+

User Guide

+

The HylleraasMD User Guide provides comprehensive information on how to run +simulations. Selected Examples are available to guide new users.

+
+
+

Installing HyMD

+

The easiest approach is to install using pip:

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+

For more information and required dependencies, see +Installation.

+
+

Run in Google colab

+

Run HyMD interactively in Google Colaboratory jupyter notebook here.

+
+
+
+

Source Code

+

Source code is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the GNU Lesser General Public +License v3.0. Obtain the source code with git:

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git
+
+
+
+
+

Development

+

HyMD is developed and maintained by researchers at the Hylleraas Centre for +Quantum Molecular Sciences at the University of Oslo.

+

pic1 pic2

+
+
+

References

+
+
+[BC20] +

Sigbjørn Løland Bore and Michele Cascella. Hamiltonian and alias-free hybrid particle–field molecular dynamics. J. Chem. Phys., 153(9):094106, 2020. doi:10.1063/5.0020733.

+
+
+[BMC18] +

Sigbjørn Løland Bore, Giuseppe Milano, and Michele Cascella. Hybrid particle-field model for conformational dynamics of peptide chains. J. Chem. Theory Comput., 14(2):1120–1130, 2018. doi:10.1021/acs.jctc.7b01160.

+
+
+[BDP07] +

Giovanni Bussi, Davide Donadio, and Michele Parrinello. Canonical sampling through velocity rescaling. J. Chem. Phys., 126(1):014101, 2007. doi:10.1063/1.2408420.

+
+
+[CNCDP08] +

Michele Cascella, Marilisa A. Neri, Paolo Carloni, and Matteo Dal Peraro. Topologically based multipolar reconstruction of electrostatic interactions in multiscale simulations of proteins. J. Chem. Theory Comput., 4(8):1378–1385, 2008. doi:10.1021/ct800122x.

+
+
+[KDNB+18] +

Hima Bindu Kolli, Antonio De Nicola, Sigbjørn Løland Bore, Ken Schäfer, Gregor Diezemann, Jürgen Gauss, Toshihiro Kawakatsu, Zhong-Yuan Lu, You-Liang Zhu, Giuseppe Milano, and Michele Cascella. Hybrid particle-field molecular dynamics simulations of charged amphiphiles in an aqueous environment. J. Chem. Theory Comput., 14(9):4928–4937, 2018. doi:10.26434/chemrxiv.6264644.v1.

+
+
+[LBC20] +

Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Automated determination of hybrid particle-field parameters by machine learning. Mol. Phys., 118(19-20):e1785571, 2020. doi:10.1080/00268976.2020.1785571.

+
+
+[MK09] +

Giuseppe Milano and Toshihiro Kawakatsu. Hybrid particle-field molecular dynamics simulations for dense polymer systems. J. Chem. Phys., 130(21):214106, 2009. doi:10.1063/1.3142103.

+
+
+[PCMC09] +

Xavier Periole, Marco Cavalli, Siewert-Jan Marrink, and Marco A Ceruso. Combining an elastic network with a coarse-grained molecular force field: structure, dynamics, and intermolecular recognition. Journal of chemical theory and computation, 5(9):2531–2543, 2009. doi:10.1021/ct9002114.

+
+
+[Pip13] +

Michael Pippig. Pfft: an extension of fftw to massively parallel architectures. SIAM J. Sci. Comput., 35(3):C213–C236, 2013. doi:10.1137/120885887.

+
+
+[TBM92] +

MBBJM Tuckerman, Bruce J Berne, and Glenn J Martyna. Reversible multiple time scale molecular dynamics. J. Chem. Phys., 97(3):1990–2001, 1992. doi:10.1063/1.463137.

+
+
+
+
+
+

Indices and tables

+ +
+
+
+
+
+
+
+
+
+ + + +
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+ + + + + +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/objects.inv b/v1.0.4/objects.inv new file mode 100644 index 00000000..1313dbfd Binary files /dev/null and b/v1.0.4/objects.inv differ diff --git a/v1.0.4/py-modindex.html b/v1.0.4/py-modindex.html new file mode 100644 index 00000000..a71996f4 --- /dev/null +++ b/v1.0.4/py-modindex.html @@ -0,0 +1,322 @@ + + + + + + Python Module Index — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ h +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ h
+ hymd +
    + hymd.field +
    + hymd.file_io +
    + hymd.force +
    + hymd.input_parser +
    + hymd.integrator +
    + hymd.thermostat +
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.4/search.html b/v1.0.4/search.html new file mode 100644 index 00000000..97de9723 --- /dev/null +++ b/v1.0.4/search.html @@ -0,0 +1,292 @@ + + + + + + Search — hymd 1.0.4 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.4 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v1.0.4/searchindex.js b/v1.0.4/searchindex.js new file mode 100644 index 00000000..524f18c6 --- /dev/null +++ b/v1.0.4/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["doc_pages/api","doc_pages/benchmarks","doc_pages/command_line","doc_pages/config_file","doc_pages/constants_and_units","doc_pages/electrostatics","doc_pages/examples","doc_pages/filtering","doc_pages/installation","doc_pages/interaction_energy_functionals","doc_pages/intramolecular_bonds","doc_pages/overview","doc_pages/theory","doc_pages/topology_input","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,"sphinxcontrib.bibtex":9,sphinx:56},filenames:["doc_pages/api.rst","doc_pages/benchmarks.rst","doc_pages/command_line.rst","doc_pages/config_file.rst","doc_pages/constants_and_units.rst","doc_pages/electrostatics.rst","doc_pages/examples.rst","doc_pages/filtering.rst","doc_pages/installation.rst","doc_pages/interaction_energy_functionals.rst","doc_pages/intramolecular_bonds.rst","doc_pages/overview.rst","doc_pages/theory.rst","doc_pages/topology_input.rst","index.rst"],objects:{"hymd.field":{compute_field_and_kinetic_energy:[0,1,1,""],compute_field_energy_q_GPE:[0,1,1,""],compute_field_force:[0,1,1,""],compute_self_energy_q:[0,1,1,""],domain_decomposition:[0,1,1,""],initialize_pm:[0,1,1,""],update_field:[0,1,1,""],update_field_force_q:[0,1,1,""],update_field_force_q_GPE:[0,1,1,""]},"hymd.file_io":{OutDataset:[0,2,1,""],distribute_input:[0,1,1,""],setup_time_dependent_element:[0,1,1,""],store_data:[0,1,1,""],store_static:[0,1,1,""]},"hymd.file_io.OutDataset":{close_file:[0,3,1,""],flush:[0,3,1,""],is_open:[0,3,1,""]},"hymd.force":{Angle:[0,2,1,""],Bond:[0,2,1,""],Chi:[0,2,1,""],Dielectric_type:[0,2,1,""],Dihedral:[0,2,1,""],compute_angle_forces__plain:[0,1,1,""],compute_bond_forces__plain:[0,1,1,""],compute_dihedral_forces__plain:[0,1,1,""],dipole_forces_redistribution:[0,1,1,""],find_all_paths:[0,1,1,""],prepare_bonds:[0,1,1,""],prepare_bonds_old:[0,1,1,""],prepare_index_based_bonds:[0,1,1,""],propensity_potential_coeffs:[0,1,1,""]},"hymd.force.Angle":{atom_3:[0,4,1,""]},"hymd.force.Bond":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],equilibrium:[0,4,1,""],strength:[0,4,1,""]},"hymd.force.Chi":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],interaction_energy:[0,4,1,""]},"hymd.force.Dielectric_type":{atom_1:[0,4,1,""],dielectric_value:[0,4,1,""]},"hymd.force.Dihedral":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],atom_3:[0,4,1,""],atom_4:[0,4,1,""],coeffs:[0,4,1,""],dih_type:[0,4,1,""]},"hymd.hamiltonian":{DefaultNoChi:[0,2,1,""],DefaultWithChi:[0,2,1,""],Hamiltonian:[0,2,1,""],SquaredPhi:[0,2,1,""]},"hymd.hamiltonian.DefaultNoChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.DefaultWithChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.Hamiltonian":{__init__:[0,3,1,""],_setup:[0,3,1,""]},"hymd.hamiltonian.SquaredPhi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.input_parser":{Config:[0,2,1,""],check_NPT_conditions:[0,1,1,""],check_angles:[0,1,1,""],check_bonds:[0,1,1,""],check_box_size:[0,1,1,""],check_cancel_com_momentum:[0,1,1,""],check_charges:[0,1,1,""],check_charges_types_list:[0,1,1,""],check_chi:[0,1,1,""],check_config:[0,1,1,""],check_dielectric:[0,1,1,""],check_dihedrals:[0,1,1,""],check_domain_decomposition:[0,1,1,""],check_hamiltonian:[0,1,1,""],check_integrator:[0,1,1,""],check_m:[0,1,1,""],check_mass:[0,1,1,""],check_max_molecule_size:[0,1,1,""],check_n_b:[0,1,1,""],check_n_flush:[0,1,1,""],check_n_particles:[0,1,1,""],check_n_print:[0,1,1,""],check_name:[0,1,1,""],check_start_and_target_temperature:[0,1,1,""],check_tau:[0,1,1,""],check_thermostat_coupling_groups:[0,1,1,""],parse_config_toml:[0,1,1,""],read_config_toml:[0,1,1,""],sort_dielectric_by_type_id:[0,1,1,""]},"hymd.input_parser.Config":{a:[0,4,1,""],angle_bonds:[0,4,1,""],barostat:[0,4,1,""],barostat_type:[0,4,1,""],bonds:[0,4,1,""],box_size:[0,4,1,""],cancel_com_momentum:[0,4,1,""],chi:[0,4,1,""],conv_crit:[0,4,1,""],convergence_type:[0,4,1,""],coulomb_constant:[0,4,1,""],coulombtype:[0,4,1,""],dielectric_const:[0,4,1,""],dielectric_type:[0,4,1,""],dihedrals:[0,4,1,""],domain_decomposition:[0,4,1,""],dtype:[0,4,1,""],file_name:[0,4,1,""],gas_constant:[0,4,1,""],hamiltonian:[0,4,1,""],initial_energy:[0,4,1,""],integrator:[0,4,1,""],kappa:[0,4,1,""],m:[0,4,1,""],mass:[0,4,1,""],max_molecule_size:[0,4,1,""],mesh_size:[0,4,1,""],n_b:[0,4,1,""],n_flush:[0,4,1,""],n_particles:[0,4,1,""],n_print:[0,4,1,""],n_steps:[0,4,1,""],name:[0,4,1,""],pol_mixing:[0,4,1,""],pressure:[0,4,1,""],respa_inner:[0,4,1,""],rho0:[0,4,1,""],self_energy:[0,4,1,""],sigma:[0,4,1,""],start_temperature:[0,4,1,""],tags:[0,4,1,""],target_pressure:[0,4,1,""],target_temperature:[0,4,1,""],tau:[0,4,1,""],tau_p:[0,4,1,""],thermostat_coupling_groups:[0,4,1,""],thermostat_work:[0,4,1,""],time_step:[0,4,1,""],type_charges:[0,4,1,""]},"hymd.integrator":{integrate_position:[0,1,1,""],integrate_velocity:[0,1,1,""]},"hymd.logger":{Logger:[0,2,1,""],MPIFilterAll:[0,2,1,""],MPIFilterRoot:[0,2,1,""]},"hymd.logger.Logger":{setup:[0,3,1,""]},"hymd.logger.MPIFilterAll":{filter:[0,3,1,""]},"hymd.logger.MPIFilterRoot":{filter:[0,3,1,""]},"hymd.thermostat":{_random_chi_squared:[0,1,1,""],_random_gaussian:[0,1,1,""],csvr_thermostat:[0,1,1,""]},hymd:{field:[0,0,0,"-"],file_io:[0,0,0,"-"],force:[0,0,0,"-"],input_parser:[0,0,0,"-"],integrator:[0,0,0,"-"],thermostat:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0020733":14,"00268976":14,"0083144621":0,"01036426965":4,"014101":[0,14],"02214076":4,"03642696562":4,"03970":6,"08790868":[6,10],"094106":14,"0xd":8,"0xe":8,"100":[4,6,11],"1000":6,"10000":6,"10001":6,"1010":10,"1021":14,"1063":14,"1080":14,"10nm":6,"110":10,"1120":[0,14],"1130":[0,14],"1137":14,"118":14,"120":[3,6,10],"120885887":14,"120ff":0,"123456":11,"1250":[3,6,10],"126":[0,14],"130":14,"1378":14,"138":[0,4],"1385":14,"144":8,"148":8,"1500":6,"153":14,"170":6,"1785571":14,"179":0,"180":[3,6,10],"1974":0,"1981":0,"1990":14,"1992":[3,14],"200":[6,10],"2000":6,"2001":14,"2007":[0,3,14],"2008":[0,14],"2009":14,"201":[0,3],"2013":14,"2018":[0,14],"2020":[5,6,12,14],"2022":14,"20nm":6,"214106":14,"223":0,"224":1,"2408420":14,"2408724":[6,10],"246":0,"251":[6,10],"2531":14,"2543":14,"26434":14,"28103735":0,"298":6,"2_1":0,"2don2d":8,"2nd":0,"300":[6,11],"3000":6,"3142103":14,"3144621":4,"323":6,"449":[6,10],"463137":14,"48626121":[6,10],"4928":14,"4937":14,"533":1,"544":[6,10],"550":10,"59427866":[6,10],"602176634":4,"610":[6,10],"6264644":14,"66053906660":4,"7b01160":14,"85418781281":4,"935458":[0,4],"940":10,"96924":6,"980":3,"9918564":[6,10],"boolean":3,"byte":13,"case":[0,3,6,10],"class":[0,9],"default":[0,3,7,11,12,13],"float":[0,3],"function":[0,3,5,6,7,11,12],"int":[0,5,6,9,12],"long":[5,6],"new":[0,10,13,14],"public":14,"return":[0,8],"short":[6,11],"sigbj\u00e3":14,"static":0,"switch":12,"true":[0,3,6],"while":[0,12],Adding:6,For:[0,11,12,14],The:[0,3,5,6,7,9,10,11,12,13,14],Then:10,There:11,These:0,Used:[0,3,11],Using:[6,9],With:[0,6],__file__:8,__init__:[0,8],_gener:0,_random_chi_squar:0,_random_gaussian:0,_setup:0,about:[3,11,12],abov:[0,6],absent:0,acceler:0,accompani:6,accord:[0,3],accur:14,acid:6,across:[0,3],acs:14,act:[0,10,12],adapt:0,add:[5,6],added:0,adding:6,addison:0,addit:[0,2,5,11],addition:14,additon:0,adher:0,affect:0,affili:[0,2],after:[0,10,12],against:8,aggreg:6,ahren:0,alanin:6,algorithm:[0,3,12],alia:14,all:[0,2,3,4,6,8,10,11,14],all_nam:0,all_rank:0,alloc:0,allow:[11,14],allreduc:0,along:[6,11],alpha3:8,alpha:0,also:[6,8,14],altern:2,alwai:[0,3],amino:6,amphiphil:14,analyt:0,angl:[0,2,3,6,8,10],angle_bond:[0,3,6,10],angular:[0,3,6,10],ani:[0,2,3],anisotrop:0,antonio:14,apart:0,api:8,app:8,appli:[0,3,7,9,12],applic:0,approach:14,approxim:0,apt:8,aqueou:14,architectur:14,arg:0,argument:[0,6,8,11],argv:8,aris:0,around:10,arrai:[0,3,11,13],arriv:6,art:0,aspect:3,assess:0,assign:[0,3,10],associ:[0,9],assum:3,assumpt:12,atom:0,atom_1:0,atom_2:0,atom_3:0,atom_4:0,attach:13,attempt:0,attr:8,attract:3,attribut:0,autom:14,automat:[0,7,9],avail:[6,8,14],averag:[0,9],avogadro:4,back:[0,5],backbon:[0,2,3,14],backcon:0,backend:14,backmap:0,balanc:0,ballist:6,bar:4,barostat:0,barostat_typ:0,base:[0,14],bath:[0,3],bb_index:0,bc20:14,bdist_wheel:8,bdp07:14,bead:0,becaus:0,becom:0,befor:[0,3,6],being:[0,2,3,5,10,11,12],belong:11,below:6,benchmark:10,bend:[0,3,10,14],bern:14,besid:2,best:0,beta:0,better:0,between:[0,3,5,6,9,10,12,13],bia:0,big:12,bin:8,binari:8,bind:14,bindu:14,bio:14,bit:[0,13],blueprint:0,bmc18:14,boltzmann:[0,3,4],bond2_energi:0,bond3_energi:0,bond4_energi:0,bond:[0,2,6,8,11,12,13],bonds_2:0,bonds_2_atom1:0,bonds_2_atom2:0,bonds_2_atom_1:0,bonds_2_atom_2:0,bonds_2_equilibrium:0,bonds_2_strength:0,bonds_3:0,bonds_3_atom_1:0,bonds_3_atom_2:0,bonds_3_atom_3:0,bonds_3_equilibrium:0,bonds_3_strength:0,bonds_4:0,bonds_4_atom_1:0,bonds_4_atom_2:0,bonds_4_atom_3:0,bonds_4_atom_4:0,bonds_4_coeff:0,bonds_4_last:0,bonds_4_typ:0,bool:0,bore:[0,5,12,14],both:[0,12],boundari:[0,3],box:[0,3,6,11],box_siz:[0,3,6,11],breviti:6,broadcast:0,browser:8,bruce:14,buffer:[0,3],build_extens:8,build_pfft:8,build_pi:8,built:8,bussi:[0,3,14],c213:14,c236:14,c_n:[0,6,10],cach:8,calcul:[0,3,6,10],calibr:0,call:[0,8],callabl:0,can:[6,8,14],cancel_com_momentum:[0,3,6],canon:[0,3,14],capabl:2,captur:11,carloni:14,carri:6,cascella:[5,8,11,12,14],caval:14,cbt:0,cdot10:4,cdot:[0,4,10],cell:[0,12],center:[0,3],centr:14,certain:[0,2],ceruso:14,chain:[0,14],chang:[0,3],changedin:0,charg:[0,3,4,5,6,13,14],charge_out:0,check:[0,8],check_angl:0,check_bond:0,check_box_s:0,check_cancel_com_momentum:0,check_charg:0,check_charges_types_list:0,check_chi:0,check_config:0,check_dielectr:0,check_dihedr:0,check_domain_decomposit:0,check_hamiltonian:0,check_integr:0,check_m:0,check_mass:0,check_max_molecule_s:0,check_n_b:0,check_n_flush:0,check_n_particl:0,check_n_print:0,check_nam:0,check_npt_condit:0,check_start_and_target_temperatur:0,check_tau:0,check_thermostat_coupling_group:0,chem:[0,14],chemic:14,chemrxiv:14,chi:[0,3,4,6,8],chi_2:0,chi_3:0,chi_:[0,3,6,9,12],chi_m:0,chmod:11,chosen:0,cic:[0,5,12],circ:[3,10],circumv:12,classmethod:0,classvar:0,clean:[0,8],clone:[11,14],close:[0,8],close_fil:0,closest:0,cloud:[0,6,12],cncdp08:14,coars:[0,3,7,14],code:[0,1,2,3,6,8,11],coeff:0,coeffici:0,coil:[0,6],colab:8,colaboratori:14,collect:[0,13],com:[0,8,11,14],combin:[0,6,14],comm:0,comm_world:0,command:[8,11],common:9,commuic:0,commun:[0,3,10],communc:0,compar:6,compat:2,compil:[0,8],compiler_so:8,complesfield:0,complet:[0,6,8],complex:[6,13],complexfield:0,compon:0,comprehens:14,compress:[0,3,4,6,9,11],comput:[0,5,10,12,14],compute_angle_forces__plain:0,compute_bond_forces__plain:0,compute_dihedral_forces__plain:0,compute_field_and_kinetic_energi:0,compute_field_energy_q_gp:0,compute_field_forc:0,compute_potenti:0,compute_self_energy_q:0,concret:11,condit:6,config:0,config_simple_1:11,configur:[0,2,5,6,7,9,10,11],configuration_four_particle_exampl:10,configuration_three_particle_exampl:10,configuration_two_particle_exampl:10,configure_runtim:8,conform:[6,13,14],connect:0,conserv:1,consid:6,consist:[0,6],consit:6,consitu:0,constant:[0,3,5,6,10],constitut:[0,2,3],construct:[0,10,11],constructor:0,contain:[0,1,2,3,6,11],content:[0,6],contribut:0,control:3,conv_crit:0,conv_fun:0,conveni:11,converg:[0,12],convergence_typ:0,convert:0,coordin:[11,12,13],copi:0,core:8,correct:[0,3],correspond:[0,3,8],correspondingli:10,cos:[0,6,10],cosin:[0,3,6,10],cost:[3,10],could:8,coulomb:[0,3,4,5],coulomb_const:0,coulombtyp:[0,3,5,6],counter:6,coupl:[0,3,6,11],cprofil:2,cpu:[0,10],crash:3,creat:[0,9],critic:[0,6],cross:0,csvr:[0,3],csvr_thermostat:0,ct800122x:14,ct9002114:14,current:6,cwd:8,cython:[8,14],d_n:0,dal:14,data:[0,6,11,13],dataclass:0,dataset:[0,5,6,11],datatyp:13,date:[0,14],date_format:0,david:14,debug:[0,2],decompos:0,decomposit:[0,3,10],default_level:0,defaultnochi:[0,6,9],defaultnohchi:[0,3],defaultwithchi:[0,3,6,9],defin:[0,6,9,10,12],definit:0,degre:3,delta:[0,12],denot:[0,1,3,9,10,11],dens:14,densiti:[0,3,5,9,12,14],depend:[0,6,10,12,14],deprec:0,deriv:[0,12],design:6,dest_directori:0,detail:[2,3,6,11,12],determin:[0,2,7,14],dev:8,develop:6,deviat:[0,3],dict:0,dictat:0,dictionari:0,dielectr:[0,3,6],dielectric_const:[0,3,5,6],dielectric_typ:0,dielectric_valu:0,dieter:0,diezemann:14,differ:[0,3,6,11,13],differenti:[0,5,7,9,12],difficult:2,dih_typ:0,dihedr:[0,2,3,5,6,8,10,14],dimens:[0,10,11,13],dimension:11,dipol:[0,2,3,5,6,14],dipole_forces_redistribut:0,dir:8,direct:[0,3],directori:11,disabl:[2,6,8,11],disable_mpio:0,discard:0,discret:[0,12],discretis:12,disk:[0,3],dispers:6,dist:8,distanc:[0,3,10],distinct:0,distribut:[0,3,5,6,12],distribute_input:0,distutil:8,doc:0,dockerhub:8,dodecyl:6,doe:[0,10],doi:14,domain:[0,3,10],domain_decomposit:[0,3,6],donadio:[0,14],done:[0,6,14],dopc:6,dot:0,dot_elec:0,doubl:2,double_out:0,download:8,dppc:6,draw:0,drawn:0,driver:11,dtype:0,due:[0,3],dump:0,dump_per_particl:0,dure:[0,2,3,10,11],dynam:[0,3,11,12,14],e1785571:14,e_k:0,each:[0,3,6,10,11],easiest:14,effect:[0,3],effici:10,eight:13,either:[0,3,8,13],elast:14,elec:0,elec_field:0,elec_field_contrib:0,elec_field_fouri:0,elec_forc:0,elecrostat:0,electr:[0,4,5],electrosat:0,electrostat:[0,6,14],elnedyn:14,elucid:6,embed:6,emit:0,emploi:0,empti:0,enabl:[2,6,8,11],enclos:0,end:0,energi:[0,1,3,4,6,7,10,11,12],energiesself:0,ensur:[0,3,6,12],entri:3,environ:14,epsilon:0,equal:[0,3,6],equat:0,equilibr:6,equilibrium:[0,3,6],equilibrum:10,equival:[0,3],error:0,essenti:[0,1,8],etc:[2,3],even:[0,3,6,8],event:0,everi:[0,3,6,10,11],evid:0,ewald:[0,5,6],examin:6,exampl:[3,8,11,13,14],example_structur:11,except:10,exchang:[0,3],exec:8,execut:[0,8,11],exist:0,exit:8,exp:[7,12],expand:0,expans:0,expect:0,expens:[3,12],explicit:[0,6,10,14],express:0,ext:0,extend:6,extens:14,extent:[0,7],extern:0,extract:0,f401:8,f_angl:0,f_bond:0,f_dihedr:0,f_dipol:0,f_on_bead:0,factor:0,factori:0,fail:[0,8],fals:[0,3,6],fashion:[0,3],fast:12,fer:14,few:[6,9,10,11],fft:[0,1,2,3,5,6,11,12,14],fftw3:8,fftw:[8,14],field:[2,4,5,6,9,11,12,14],field_energi:0,field_list:0,field_q_energi:0,field_q_self_energi:0,file:[2,5,6,7,8,9,10,11,14],file_io:0,file_nam:0,file_path:0,filter:[0,3,5,6,11,14],find:0,find_all_path:0,first:[0,3,6,11],five:0,fix:[0,8,11],flag:[0,13],flat:11,float32:[11,13],float64:13,flori:0,fluctuat:0,flush:[0,3],follow:[0,2,3,4,6,11],forc:[2,3,4,5,6,10,14],force_kernel:8,force_mesh:0,force_mesh_elec:0,force_mesh_elec_fouri:0,force_out:0,forego:2,form:[0,5,10],formal:[5,12],format:[0,2,3,5,11,13,14],formatt:0,fortran:[0,10],forward:0,found:[5,8],four:[0,2,3,6,13],fourier:[0,5,12],fr6nt9m4:8,frac:[0,5,6,7,9,10,12],frame:[0,11,13],free:14,frequenc:[0,3],from:[0,2,3,5,6,8,9,10,11,14],full:[0,9,11],fulli:[0,6,8],fundament:11,gamma:0,gamma_0:0,gas:[0,4],gas_const:0,gather:0,gauss:14,gaussian:[0,3,7,12],gener:[0,2,3,6,14],get:8,getattr:8,ghost:0,giovanni:14,git:[11,14],github:[6,8,11,14],githubusercont:8,giusepp:14,given:[0,3,6,7],glenn:14,global:0,gnu:14,govern:9,gpe:0,grab:8,gradient:0,grain:[0,3,7,14],graph:0,gregor:14,grid:[0,1,3,5,6,7,11,12],group:[0,3,6,8,11,13,14],guess:0,gyrat:6,h5md:[0,3],h5py:[0,2,8],h_0:[6,12],half:0,hamiltonian:[3,5,6,7,9,11,14],handl:0,handler:0,happen:10,harmon:[0,3,6,10],has:[0,3,13],hat:[7,12],have:[0,6,8],hdf5:[0,2,3,5,6,8,11,13,14],hdf5_mpi:8,head:6,heat:[0,3],helic:[0,3,5,6],help:6,helper:0,here:[0,6,8,14],hhpf:14,highli:[8,10,11],hijack:7,hima:14,hire:1,homogen:0,homopolym:1,homopolypeptid:6,how:[3,11,14],howev:6,hpf:[3,5,9,11,12,14],html:0,http:[0,8,11,14],huggin:0,hundr:[6,10],hybrid:[11,12,14],hylleraa:14,hymd:[0,2,3,4,5,6,7,8,9,10,11,12,13],ideal:10,ideal_chain:[6,8],ideal_ga:[6,11],ident:0,ignor:0,ijk:[5,12],imag:8,impact:0,implement:[0,10],importerror:8,impuls:[0,3],in_fil:0,includ:[0,2,3,6,12,14],incompress:[0,3],inconveni:8,increas:[0,2,6],indentifi:0,independ:[0,3,7,12],index:[0,11,13,14],indic:[0,2,3,10,11,13],indirect:0,individu:[0,3,6],induc:5,infer:10,info:0,inform:[0,10,14],ingredi:6,initi:0,initial_energi:0,initialis:11,initialize_pm:0,inner:[0,3],input:[2,3,4,5,6,7,8,11,13],input_box:0,input_pars:[0,8],insid:[0,3,6],instal:[2,11],install_pfft:8,instantan:0,int32:[11,13],int64:13,integ:[0,3,6,13],integr:[3,6,11],integrate_posit:0,integrate_veloc:0,intend:8,inter:[0,10],interact:[0,2,3,4,6,7,11,12,14],interaction_energi:0,interfac:0,intergr:0,intermediari:0,intermolecular:[6,14],intern:[0,2,4,10],interpol:[0,5],interpret:11,interv:[0,3],intmathrm:0,intracomm:0,intramolecular:[0,3,6,12,14],intrins:5,introduc:6,investig:0,invok:[2,11],involv:[0,3,10],ion:6,ipynb:6,is_open:0,iter:0,j_k:0,jan:14,jctc:14,join:8,jone:12,journal:14,jupyt:[6,8,14],k_e:0,kappa:[0,3,4,6,11,12],kawakatsu:14,kdnb:14,keep:[0,3],kelvin:[0,3,6,11],ken:14,kernel:[0,10],keyword:[0,5,6,11],kinet:[0,12],kinetic_energi:0,knuth:0,kolli:14,kpa:4,label:[1,10],lambda:0,lamdifi:9,land:14,laplacian:0,larg:[8,11],larger:3,last:[6,8,11,13],last_bb:0,later:[0,6],latest:8,law:10,layout:0,layout_q:0,lbc20:14,learn:14,leav:0,ledum:[6,14],left:[0,5,6,7,9,10,12],legend:1,lenght:0,length:[0,3,4,6,7,10,11,13],lennard:12,less:[0,6],lesser:14,let:[0,10],level:[0,2,3,13],liang:14,lib:8,libhdf5:8,librari:[0,2,8,14],licens:14,lieu:0,like:[0,6,11],limit:3,line:[0,8,11],linear:[0,3],lipid_self_assembl:6,list:0,list_coulomb:0,load:0,local:[0,10,11,12],log:[0,2,11],log_fil:0,log_out:11,logfil:[2,11],logger:2,logic:0,logrecord:0,look:[6,11],loop:0,lost:3,low:6,m_j:0,machin:[2,14],made:0,mai:[0,2,3,6,8,10,11,13],main:[0,8,11],maintain:14,make:6,manner:6,manual:8,map:[0,11],marco:14,marilisa:14,marrink:14,martini:[6,14],martyna:14,mass:[0,3,4,13],massiv:14,match:0,math:0,mathbf:[0,4,5,6,9,10,12],mathcal:[6,12],mathmr:0,mathrm:[0,5,6,9,10,12],matteo:14,matter:[6,10,14],max_molecule_s:[0,3,6],maximum:[0,3,10,11],maxwel:[0,3],may:2,mbbjm:14,mean:[0,2,3],measur:10,medium:[0,3,6],melt:1,membran:6,memori:0,mesh:[0,1,3,5,6,14],mesh_siz:[0,3,6,11],messag:0,messi:0,meta:6,metadata:0,method:[0,1,6,7],mh_0:12,micellular:6,michael:14,michel:14,might:0,milano:14,mimic:0,minim:6,minuscul:10,mirror:2,mix:[0,6],mk09:14,model:[6,14],modifi:0,modul:[0,3,8,14],mol:[3,4,6,10,11,14],molecul:[0,3,11,12,13],molecular:[2,11,12,14],momenta:[0,11],momentum:[0,3,4],monoatom:6,more:[2,3,6,11,12,14],mortel:8,morten:14,most:[8,9,11,12],mostli:[2,8],motion:[0,6],move:0,mpi4pi:[0,8,14],mpi:[0,2,3,8,10,11,14],mpi_num_rank:11,mpicc:8,mpifilteral:0,mpifilterroot:0,mpio:[2,8],mpirun:11,multiarrai:8,multipl:[0,3,6,11,13,14],multipolar:14,multiscal:14,must:[0,3],n_b:0,n_flush:[0,3,6],n_frame:0,n_particl:[0,3],n_print:[0,3,6,11],n_step:[0,3,6,11],n_type:0,nabla:[0,12],name:[0,2,3,6,10,11,13],nanomet:[0,1],nanosecond:6,ndarrai:0,ne5et1y_:8,necessari:[0,6],necessit:[8,9],need:[0,6],neg:[0,6],neighbour:0,neri:14,network:[0,10,11,13,14],networkx:0,neutralis:6,never:[0,3],nevertheless:3,next:[0,6],nicola:14,non:[0,2,6,8],none:[0,3],nongnu:0,noqa:8,normal:[0,2,3,8,12],notabl:11,note:[0,6,8,11,12],notebook:[6,8,14],now:6,nproc:11,npt:0,nq_i:5,number:[0,1,2,3,6,11,12,13],numer:0,numpi:[0,2,9,14],nvt:0,object:[0,9],oblat:6,observ:[0,6],obtain:[0,5,12,14],obviou:8,off:6,omit:6,onc:[3,10],one:[0,2,3,6,13],onli:[0,6,10,11],onto:[0,3,5,12],open:[0,8],openmpi:8,oper:[0,3,12,14],oppos:0,optim:[0,10],optimis:[6,10],option:[0,3,6,11],order:[0,3,6,10,11],ordinari:[5,12],org:0,organis:6,origin:0,oslo:14,other:[0,11],otherwis:0,out:[8,12],outdataset:0,outer:0,output:[2,3,4,6,8,11],outsid:3,over:0,overlap:[0,9],packag:[8,11,14],page:14,paint:0,paolo:14,paper:0,parallel:[0,2,3,8,14],paramet:[0,3,6,7,9,14],parent_group:0,parllel:0,parrinello:[0,14],pars:[0,3],parse_config_toml:[0,8],part:[5,6,12],partial:0,particl:[0,2,5,6,7,9,11,12,13,14],particlemesh:0,particular:11,path:[0,2,11],pcmc09:14,pdf:1,pencil:0,peptid:[0,2,3,5,14],per:[0,2,3,10,11,13],peraro:14,perfect:0,perform:[0,3,10,11,12],periol:14,perman:[10,14],permitt:[0,4],pfft:[0,14],pfft_build_dir:8,phase:[0,10],phase_separ:6,phi:[0,3,6,10,12],phi_0:[6,9,12],phi_:[0,6,9,12],phi_ep:0,phi_eps_fouri:0,phi_eta:0,phi_eta_fouri:0,phi_fouri:0,phi_k:0,phi_l:0,phi_laplacian:0,phi_n:[6,10],phi_pol:0,phi_pol_prev:0,phi_q:0,phi_q_fouri:0,phi_transf:0,phospholipid:6,phy:[0,14],pic_spectr:[0,3,6],pic_spectral_gp:0,piec:6,pip13:14,pip:[8,11,14],pippig:14,place:[0,3],plain:2,plane:[0,6,10],pleas:[8,11],plume:0,plumed_bia:0,plumed_out:0,pme:14,pmesh:[0,14],png:1,point:[0,1,10,13],poisson:0,pol_mix:0,polar:0,polym:[6,14],posit:[0,2,3,5,6,11,12],possibl:[0,3,6,14],potenti:[0,3,4,5,7,10,14],ppft:14,practic:10,pre:[0,6],precis:[1,2],prefer:3,prepar:0,prepare_bond:0,prepare_bonds_old:0,prepare_index_based_bond:0,prepend:[0,11],present:[0,2,3,6],preserv:3,pressur:[0,4],pretti:8,previou:0,previous:6,prior:[0,3],priovid:0,prng:0,prod_:0,profil:2,program:[0,11],project:5,promot:0,prop:0,propag:[0,3],propens:[0,3,5,6],propensity_potential_coeff:0,properti:3,protein:[0,14],provid:[0,2,3,11,13,14],psi:[0,4,5],psi_:5,psi_fouri:0,pull:8,put:6,pytest:11,python3:[6,8,11,14],python:[0,11,14],q_i:[0,5],q_j:0,quadrat:0,quanit:0,quantiti:[0,4],quantum:14,quartet:10,quess:0,r_0:[0,6,10],r_a:10,r_c:10,rad:[3,10],radial:6,radii:6,radiu:6,rainwoodman:[8,14],rais:[6,8],random:[0,2,11],random_chi_squar:0,random_gaussian:0,randomli:[0,3,6],rang:5,rank0:0,rank:[0,2,3,10,11],rank_rang:0,rankself:0,rare:10,raw:8,read:[0,8,11,14],read_config_toml:[0,8],readout:0,real:13,realfield:0,realist:6,reappli:0,rearrang:0,reason:8,receiv:[0,3],recent:8,reciproc:[0,7],recognis:11,recognit:14,recommend:8,reconstruct:[0,2,5,6,10,14],record:0,recreat:14,recurs:0,redistribut:0,reduc:[3,12],refer:[3,11],regim:6,regul:[0,3],rel:[0,3,6,10],relax:[0,3],releas:[0,6,8,11,14],remain:[0,6],remov:[0,3],remove_center_of_mass_momentum:0,remove_com_momentum:[0,3],replac:[0,8],repositori:[6,11],repres:[0,3,13],represent:7,repuls:3,requir:[0,3,8,10,11,14],rescal:[0,3,14],research:14,respa:[0,3,6],respa_inn:[0,3,6],respect:[0,1,12],restructur:0,result:[0,3,6,9],revers:[0,3,14],rgen:14,rho0:0,rho:[0,5],rho_0:0,rho_:5,right:[0,5,6,7,9,10,12],rightarrow:10,root:[0,11,13],roughi:6,row:11,rrespa:[0,3,6],ruin:0,run:[0,2,3,6,10],rundown:11,runtimeerror:8,same:[0,3,6],sampl:[0,3,14],scalar:0,scale:[0,3,6,7,8,10,11,14],sch:14,scheme:[0,6],sci:14,scienc:14,script:11,sds:6,search:14,second:[0,11],see:[0,2,3,5,6,8,9,10,11,12,14],seed:[2,11],select:[11,14],self:[0,3,8],self_energi:0,seminumer:0,send:[0,3],separ:0,seri:[0,3,6,10],serial:[8,11],serialis:3,set:[0,3,11],setup:[0,6,7,8,13],setup_time_dependent_el:0,setuptool:8,sever:0,shape:[0,6,11,13],sheet:0,shift:0,should:[0,2,10],shown:6,siam:14,siewert:14,sigbj:14,sigma:[0,3,6,7,11,12],sim:0,similar:0,simpl:[0,6,11,12],simplest:6,simpli:[0,8],simul:[0,2,6,8,10,12,13,14],simultan:0,sinc:0,singl:[0,3,6],size:[0,3,6,11,12],slight:0,slow:8,slowli:12,small:[3,11],smear:5,smooth:[0,12],sodium:6,soft:[6,14],solv:0,solvent:6,some:[0,3],sort:0,sort_dielectric_by_type_id:0,sourc:[0,1],space:[0,3,5,7],span:0,spatial:[0,3,11,12],specfi:0,speci:0,special:0,specif:[0,2,3,6,9,10,11,13],specifi:[0,2,3,6,9,10,11,13],spectacularli:0,spectral:6,speed:[0,3],spheric:6,spheroid:6,split:0,spontan:6,spring:[0,10],sqrt:[0,7,12],squar:[0,9],squaredphi:[0,3,9,11],stabil:6,stabl:6,stackoverflow:0,standard:[0,3,12,14],start:[0,3,6,10,13],start_temperatur:[0,3,6],state:0,statu:8,stdout:[0,2],step:[0,3,6,10,11],stiff:3,stochast:0,store:0,store_data:0,store_stat:0,str10:11,str:0,straightforward:[7,9],stream:0,strength:[0,3,6,11],stretch:[0,3,10,14],string:[0,3,8,11,13],structur:[0,2,3,5,6,11,14],style:14,sub:6,subclass:[0,9],subsequ:[0,5,6,10],sudo:8,suitabl:0,sulfat:6,sum:0,sum_:[0,5,9,12],sum_i:0,sum_j:0,sum_k:0,sum_n:[0,6,10],summari:11,superclass:[0,7],support:[0,6,14],swap:10,symbol:[0,4,9],sympi:[0,9],sys:8,system:[0,1,2,3,6,8,9,11,12,14],tag:[0,3,8],take:[0,3,5,9,10,11,12],taken:0,tar:8,target:0,target_pressur:0,target_temperatur:[0,3,6,11],tau:[0,3,6,11],tau_p:0,tbm92:14,temperatur:[0,3,4,6,11],ten:6,term:[0,3,6,9,12],test:[0,1],text:[0,2,3,4,5,6,9,10,12],than:[0,3],theori:[0,14],thermalis:[0,3],thermostat:[2,3,6,11],thermostat_coupling_group:[0,3,6],thermostat_work:0,theta:[6,10],theta_0:[0,6,10],thi:[0,2,3,6,8,9,10,11,12],thorough:11,though:6,thousand:[6,10],three:[0,2,3,6],through:[0,3,6,7,9,10,14],tild:[0,3,4,5,6,9,12],time:[0,3,4,6,10,11,14],time_step:[0,3,6,11],tmp:8,todo:0,togeth:[0,3,6],token:8,toml:[0,2,3,6,8,10,11],toml_cont:0,tomli:0,too:3,toplog:0,topol:0,topolog:[0,2,3,5,6,11,14],torsion:[0,3,10,14],toshihiro:14,total:[0,3,6,11,12],traceback:8,trajectori:[0,2,3,6,11],trans_matric:0,transfer:[0,10],transform:[0,9,12],travers:0,tri:3,truncat:0,tuckerman:[3,14],turn:6,tutori:[6,8,11,13],two:[0,2,3,6],txt:11,type:[0,2,3,5,6,9,10,11,13],type_arrai:0,type_charg:0,type_to_name_map:0,ubuntu:8,uio:[8,11,14],unchang:0,under:[6,12,14],union:0,uniqu:0,unique_nam:0,unit:[0,3,10],univers:14,unknown:0,unless:[0,3],unset:0,unstabl:3,until:6,updat:[0,8],update_field:0,update_field_force_q:0,update_field_force_q_gp:0,upgrad:[8,14],usag:[0,2],use:[0,3,5,6,8],used:[0,1,2,3,6,7,9,11,12,13],uses:[0,4,12,14],using:[0,2,3,8,12,14],usr:8,usual:11,v_2:[0,6,10],v_3:[0,6,10],v_4:[0,6,10],v_ext:0,v_ext_fouri:0,vacuum:4,valid:[0,3],validated_config:0,valu:[0,3,4,5,6,10],valueerror:8,vanish:0,varepsilon:0,varepsilon_0:[4,5],vari:12,variabl:0,variant:6,variou:[0,13],vbar_elec:0,vbar_elec_fouri:0,vector:10,vectoris:9,veloc:[0,2,3,4,6,11,13,14],velocity_out:0,velocti:0,verbos:[0,2,8,11],veri:[6,10],verifi:0,verlet:[0,3,6,11],versa:3,version:[0,6,8,11,12],vert:0,vertex:[0,5],vertic:0,via:[6,8,14],vice:3,vol:0,volum:0,voxel:0,wai:[8,12],warn:0,weakli:3,weight:0,well:6,were:0,weslei:0,wheel:8,when:[0,3,10],where:[0,5,9,10,12],which:[0,2,3,5,6,9,10,11],width:[0,3],window:[0,5,12],without:[0,8,14],work:[0,8],workload:0,would:[0,3],wrap:0,wrapper:0,write:[0,3],written:[0,3],www:0,xavier:14,yield:6,you:[8,10,14],yuan:14,zero:[0,3],zhong:14,zhu:14},titles:["4. API reference","3. Benchmarks","5. Command line arguments","3. Configuration file","6. Constants and Units","3. Electrostatic interactions","1. Examples","2. Filtering","1. Installation","1. Interaction energy functionals","2. Intramolecular bonds","2. Usage overview for HylleraasMD","1. Theory","4. Topology and structure file","HylleraasMD documentation"],titleterms:{"function":9,"import":8,"new":[7,9],"while":8,SDS:6,api:0,argument:2,assembl:6,benchmark:1,bilay:6,bond:[1,3,10],build:8,calcul:12,chain:6,chi:9,code:14,colab:14,colaboratori:8,command:2,common:8,configur:3,constant:4,copolym:6,curl:8,dataset:13,depend:8,develop:14,diblock:6,docker:8,document:14,due:8,electrostat:[3,5],energi:9,error:8,exampl:6,extern:12,field:[0,1,3],file:[0,3,13],filter:[7,12],forc:[0,1,8,12],form:[9,12],fortran:8,four:10,gas:6,googl:[8,14],guid:14,hamiltonian:[0,12],helix:6,hylleraasmd:[11,14],hymd:14,ideal:6,implement:[7,9],incompress:9,indic:14,input:0,instal:[8,14],integr:0,interact:[5,8,9],interpol:12,intramolecular:10,issu:8,kappa:9,kernel:8,keyword:3,line:2,lipid:6,logger:0,metadata:3,miss:8,numpi:8,onli:9,option:[2,13],output:0,overview:11,parallel:11,parser:0,particl:[1,3,10],peptid:6,pfft:8,phase:6,phi:9,potenti:12,python:8,reciproc:12,refer:[0,14],requir:[2,13],rod:6,run:[8,11,14],self:6,separ:6,simul:[3,11],sourc:14,space:12,specifi:5,stiff:6,structur:13,tabl:14,test:11,theori:12,thermostat:0,three:10,topolog:13,two:10,unit:4,usag:11,user:14,wget:8}}) \ No newline at end of file diff --git a/v1.0.5/.buildinfo b/v1.0.5/.buildinfo new file mode 100644 index 00000000..0ffe075c --- /dev/null +++ b/v1.0.5/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: def04b08b6da079d06e38f6700d8ffd1 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v1.0.5/.doctrees/doc_pages/api.doctree b/v1.0.5/.doctrees/doc_pages/api.doctree new file mode 100644 index 00000000..78971ca6 Binary files /dev/null and b/v1.0.5/.doctrees/doc_pages/api.doctree differ diff --git a/v1.0.5/.doctrees/doc_pages/benchmarks.doctree b/v1.0.5/.doctrees/doc_pages/benchmarks.doctree new file mode 100644 index 00000000..7fff913b Binary files /dev/null and b/v1.0.5/.doctrees/doc_pages/benchmarks.doctree differ diff --git a/v1.0.5/.doctrees/doc_pages/command_line.doctree b/v1.0.5/.doctrees/doc_pages/command_line.doctree new file mode 100644 index 00000000..b2c44b56 Binary files /dev/null and b/v1.0.5/.doctrees/doc_pages/command_line.doctree differ diff --git a/v1.0.5/.doctrees/doc_pages/config_file.doctree b/v1.0.5/.doctrees/doc_pages/config_file.doctree new file mode 100644 index 00000000..ba9e3407 Binary files /dev/null and b/v1.0.5/.doctrees/doc_pages/config_file.doctree differ diff --git a/v1.0.5/.doctrees/doc_pages/constants_and_units.doctree b/v1.0.5/.doctrees/doc_pages/constants_and_units.doctree new file mode 100644 index 00000000..c1819621 Binary files /dev/null and b/v1.0.5/.doctrees/doc_pages/constants_and_units.doctree differ diff --git a/v1.0.5/.doctrees/doc_pages/electrostatics.doctree b/v1.0.5/.doctrees/doc_pages/electrostatics.doctree new file mode 100644 index 00000000..759374a6 Binary files /dev/null and b/v1.0.5/.doctrees/doc_pages/electrostatics.doctree differ diff --git a/v1.0.5/.doctrees/doc_pages/examples.doctree b/v1.0.5/.doctrees/doc_pages/examples.doctree new file mode 100644 index 00000000..ef9f0cdc Binary files /dev/null and b/v1.0.5/.doctrees/doc_pages/examples.doctree differ diff --git a/v1.0.5/.doctrees/doc_pages/filtering.doctree b/v1.0.5/.doctrees/doc_pages/filtering.doctree new file mode 100644 index 00000000..140dcc9e Binary files /dev/null and b/v1.0.5/.doctrees/doc_pages/filtering.doctree differ diff --git a/v1.0.5/.doctrees/doc_pages/installation.doctree b/v1.0.5/.doctrees/doc_pages/installation.doctree new file mode 100644 index 00000000..17e4e145 Binary files /dev/null and b/v1.0.5/.doctrees/doc_pages/installation.doctree differ diff --git a/v1.0.5/.doctrees/doc_pages/interaction_energy_functionals.doctree b/v1.0.5/.doctrees/doc_pages/interaction_energy_functionals.doctree new file mode 100644 index 00000000..64ed0fd3 Binary files /dev/null and b/v1.0.5/.doctrees/doc_pages/interaction_energy_functionals.doctree differ diff --git a/v1.0.5/.doctrees/doc_pages/intramolecular_bonds.doctree b/v1.0.5/.doctrees/doc_pages/intramolecular_bonds.doctree new file mode 100644 index 00000000..e0c1fc58 Binary files /dev/null and b/v1.0.5/.doctrees/doc_pages/intramolecular_bonds.doctree differ diff --git a/v1.0.5/.doctrees/doc_pages/overview.doctree b/v1.0.5/.doctrees/doc_pages/overview.doctree new file mode 100644 index 00000000..a79b19b0 Binary files /dev/null and b/v1.0.5/.doctrees/doc_pages/overview.doctree differ diff --git a/v1.0.5/.doctrees/doc_pages/theory.doctree b/v1.0.5/.doctrees/doc_pages/theory.doctree new file mode 100644 index 00000000..d96eb543 Binary files /dev/null and b/v1.0.5/.doctrees/doc_pages/theory.doctree differ diff --git a/v1.0.5/.doctrees/doc_pages/topology_input.doctree b/v1.0.5/.doctrees/doc_pages/topology_input.doctree new file mode 100644 index 00000000..d3ca85b6 Binary files /dev/null and b/v1.0.5/.doctrees/doc_pages/topology_input.doctree differ diff --git a/v1.0.5/.doctrees/environment.pickle b/v1.0.5/.doctrees/environment.pickle new file mode 100644 index 00000000..9f2d1e23 Binary files /dev/null and b/v1.0.5/.doctrees/environment.pickle differ diff --git a/v1.0.5/.doctrees/index.doctree b/v1.0.5/.doctrees/index.doctree new file mode 100644 index 00000000..36bcd83a Binary files /dev/null and b/v1.0.5/.doctrees/index.doctree differ diff --git a/v1.0.5/_downloads/09b79678bd0abd76af18e6a0fbe0c7a2/benchmarks-1.py b/v1.0.5/_downloads/09b79678bd0abd76af18e6a0fbe0c7a2/benchmarks-1.py new file mode 100644 index 00000000..deb4348f --- /dev/null +++ b/v1.0.5/_downloads/09b79678bd0abd76af18e6a0fbe0c7a2/benchmarks-1.py @@ -0,0 +1,38 @@ +import numpy as np +import matplotlib.pyplot as plt +nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) +time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 +], dtype=np.float64) +nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 +], dtype=np.float64,) +time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, +], dtype=np.float64) +nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 +], dtype=np.float64) +time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, +], dtype=np.float64) +plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" +) +plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" +) +plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" +) +plt.xlabel("CPUs", fontsize=15) +plt.ylabel("Time per step, us", fontsize=15) +plt.legend(fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.show() \ No newline at end of file diff --git a/v1.0.5/_downloads/3ef8738004a88e9b7b534907cdf229a6/benchmarks-2.py b/v1.0.5/_downloads/3ef8738004a88e9b7b534907cdf229a6/benchmarks-2.py new file mode 100644 index 00000000..fd287cbc --- /dev/null +++ b/v1.0.5/_downloads/3ef8738004a88e9b7b534907cdf229a6/benchmarks-2.py @@ -0,0 +1,33 @@ +import numpy as np +import matplotlib.pyplot as plt + +mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] +mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + +mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + +mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + +mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] +mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + +mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + +mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + +plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") +plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") +plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") +plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") +plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") +plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") +plt.xlabel("CPUs", fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.ylabel("Time per step, s", fontsize=15) +plt.legend(loc="upper left", fontsize=15) +plt.show() \ No newline at end of file diff --git a/v1.0.5/_downloads/873f0a4fde7554561a7e1e3addf8a052/benchmarks-1.png b/v1.0.5/_downloads/873f0a4fde7554561a7e1e3addf8a052/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.5/_downloads/873f0a4fde7554561a7e1e3addf8a052/benchmarks-1.png differ diff --git a/v1.0.5/_downloads/9b9041668276692b2cfa480f605d3c23/benchmarks-2.pdf b/v1.0.5/_downloads/9b9041668276692b2cfa480f605d3c23/benchmarks-2.pdf new file mode 100644 index 00000000..7487967c Binary files /dev/null and b/v1.0.5/_downloads/9b9041668276692b2cfa480f605d3c23/benchmarks-2.pdf differ diff --git a/v1.0.5/_downloads/ac0f23543e3d1c6497d0c44bd5ccb239/benchmarks-1.hires.png b/v1.0.5/_downloads/ac0f23543e3d1c6497d0c44bd5ccb239/benchmarks-1.hires.png new file mode 100644 index 00000000..173b39f3 Binary files /dev/null and b/v1.0.5/_downloads/ac0f23543e3d1c6497d0c44bd5ccb239/benchmarks-1.hires.png differ diff --git a/v1.0.5/_downloads/b8e700e0b716600bf7b90413175e3233/benchmarks-2.png b/v1.0.5/_downloads/b8e700e0b716600bf7b90413175e3233/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v1.0.5/_downloads/b8e700e0b716600bf7b90413175e3233/benchmarks-2.png differ diff --git a/v1.0.5/_downloads/ea846cf4e3cdd23f34227a1ebcc1569f/benchmarks-2.hires.png b/v1.0.5/_downloads/ea846cf4e3cdd23f34227a1ebcc1569f/benchmarks-2.hires.png new file mode 100644 index 00000000..82806426 Binary files /dev/null and b/v1.0.5/_downloads/ea846cf4e3cdd23f34227a1ebcc1569f/benchmarks-2.hires.png differ diff --git a/v1.0.5/_downloads/ec18da5ca840f2f2c6cb29470190acab/benchmarks-1.pdf b/v1.0.5/_downloads/ec18da5ca840f2f2c6cb29470190acab/benchmarks-1.pdf new file mode 100644 index 00000000..c5c9d4c8 Binary files /dev/null and b/v1.0.5/_downloads/ec18da5ca840f2f2c6cb29470190acab/benchmarks-1.pdf differ diff --git a/v1.0.5/_images/benchmarks-1.png b/v1.0.5/_images/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.5/_images/benchmarks-1.png differ diff --git a/v1.0.5/_images/benchmarks-2.png b/v1.0.5/_images/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v1.0.5/_images/benchmarks-2.png differ diff --git a/v1.0.5/_images/hylleraas_centre_logo_black.png b/v1.0.5/_images/hylleraas_centre_logo_black.png new file mode 100644 index 00000000..40826396 Binary files /dev/null and b/v1.0.5/_images/hylleraas_centre_logo_black.png differ diff --git a/v1.0.5/_images/uio_full_logo_eng_pos.png b/v1.0.5/_images/uio_full_logo_eng_pos.png new file mode 100644 index 00000000..6c603139 Binary files /dev/null and b/v1.0.5/_images/uio_full_logo_eng_pos.png differ diff --git a/v1.0.5/_modules/hymd/field.html b/v1.0.5/_modules/hymd/field.html new file mode 100644 index 00000000..3e541a9c --- /dev/null +++ b/v1.0.5/_modules/hymd/field.html @@ -0,0 +1,1451 @@ + + + + + + hymd.field — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.field

+"""Forces and energies from the discretized particle-field grid interactions
+"""
+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import warnings
+
+
+
[docs]def initialize_pm(pmesh, config, comm=MPI.COMM_WORLD): + """ + Creates the necessary pmesh objects for pfft operations. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + config : Config + Configuration dataclass containing simulation metadata and parameters. + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm : object 'pmesh.pm.ParticleMesh' + field_list : list[pmesh.pm.RealField], (multiple) + Essential list of pmesh objects required for MD + list_coulomb : list[pmesh.pm.RealField], (multiple) + Additional list of pmesh objects required for electrostatics. + """ + + if config.dtype == np.float64: + pmeshtype = "f8" + else: + pmeshtype = "f4" + # Ignore numpy numpy.VisibleDeprecationWarning: Creating an ndarray from + # ragged nested sequences until it is fixed in pmesh + with warnings.catch_warnings(): + warnings.filterwarnings( + action="ignore", + category=np.VisibleDeprecationWarning, + message=r"Creating an ndarray from ragged nested sequences", + ) + # The first argument of ParticleMesh has to be a tuple + pm = pmesh.ParticleMesh( + config.mesh_size, BoxSize=config.box_size, dtype=pmeshtype, comm=comm + ) + phi = [pm.create("real", value=0.0) for _ in range(config.n_types)] + phi_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] # noqa: E501 + force_on_grid = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + v_ext_fourier = [pm.create("complex", value=0.0) for _ in range(4)] + v_ext = [pm.create("real", value=0.0) for _ in range(config.n_types)] + + phi_transfer = [pm.create("complex", value=0.0) for _ in range(3)] + + phi_laplacian = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + + # Initialize charge density fields + coulomb_list = [] + elec_common_list = [None, None, None, None] + _SPACE_DIM = config.box_size.size + + if config.coulombtype == "PIC_Spectral_GPE" or config.coulombtype == "PIC_Spectral": + phi_q = pm.create("real", value=0.0) + phi_q_fourier = pm.create("complex", value=0.0) + psi = pm.create("real", value=0.0) + elec_field = [pm.create("real", value=0.0) for _ in range(_SPACE_DIM)] + + elec_common_list = [phi_q, phi_q_fourier, psi, elec_field] + + if config.coulombtype == "PIC_Spectral": + elec_field_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] # for force calculation + psi_fourier = pm.create("complex", value=0.0) + + coulomb_list = [ + elec_field_fourier, + psi_fourier, + ] + + if ( + config.coulombtype == "PIC_Spectral_GPE" + ): ## initializing the density mesh #dielectric_flag + phi_eps = pm.create( + "real", value=0.0 + ) ## real contrib of the epsilon dielectric painted to grid + phi_eps_fourier = pm.create("complex", value=0.0) # complex contrib of phi eps + phi_eta = [ + pm.create("real", value=0.0) for _ in range(_SPACE_DIM) + ] ## real contrib of factor in polarization charge density + phi_eta_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] ## fourier of factor in polarization charge density + phi_pol = pm.create( + "real", value=0.0 + ) ## real contrib of the polarization charge + phi_pol_prev = pm.create("real", value=0.0) + elec_dot = pm.create("real", value=0.0) + elec_field_contrib = pm.create( + "real", value=0.0 + ) # needed for pol energies later + + # External potential and force meshes + Vbar_elec = [pm.create("real", value=0.0) for _ in range(config.n_types)] + Vbar_elec_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] + force_mesh_elec = [ + [pm.create("real", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + force_mesh_elec_fourier = [ + [pm.create("complex", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + + coulomb_list = [ + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol, + phi_pol_prev, + elec_dot, + elec_field_contrib, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + ] + + field_list = [ + phi, + phi_fourier, + force_on_grid, + v_ext_fourier, + v_ext, + phi_transfer, + phi_laplacian, + ] + + return (pm, field_list, elec_common_list, coulomb_list)
+ + +
[docs]def compute_field_force(layouts, r, force_mesh, force, types, n_types): + """Interpolate particle-field forces from the grid onto particle positions + + Backmaps the forces calculated on the grid to particle positions using the + window function :math:`P` (by default cloud-in-cell [CIC]). In the + following, let :math:`\\mathbf{F}_j` denote the force acting on the + particle with index :math:`j` and position :math:`\\mathbf{r}_j`. The + interpolated force is + + .. math:: + + \\mathbf{F}_j = -\\sum_k\\nabla V_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`V_{j_k}` is the discretized external potential at grid vertex + :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid vertex + with index :math:`j_k`, and :math:`h^3` is the volume of each grid voxel. + The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + r : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + force : (N,D) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. Local + for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + n_types : int + Number of different unique types present in the simulation system. + :code:`n_types` is global, i.e. the same for all MPI ranks even if some + ranks contain zero particles of certain types. + """ + for t in range(n_types): + ind = types == t + for d in range(3): + force[ind, d] = force_mesh[t][d].readout(r[ind], layout=layouts[t])
+ + +
[docs]def compute_self_energy_q(config, charges, comm=MPI.COMM_WORLD): + """Compute the self energy for the interaction due to the Ewald scheme + used to compute the electrostatics. The energy is stored in :code:`config`. + + The self interaction energy is given by: + + .. math:: + + U_{self} = \\sqrt{\\frac{1}{2\\pi\\sigma^2}} \\sum_{i=1}^{N} q_i^2 + + where :math:`q_i` are the charges and :math:`\\sigma` is the half-width + of the Gaussian filter. + + Parameters + ---------- + config : Config + Configuration object. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + comm : mpi4py.Comm + MPI communicator to use for rank communication. + + Returns + ------- + field_q_self_energy : float + Electrostatic self energy. + """ + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + prefac = elec_conversion_factor * np.sqrt( + 1.0 / (2.0 * np.pi * config.sigma * config.sigma) + ) + _squared_charges = charges * charges + squared_charges_sum = comm.allreduce(np.sum(_squared_charges)) + return prefac * squared_charges_sum
+ + +
[docs]def update_field_force_q( + charges, + phi_q, + phi_q_fourier, + psi, + psi_fourier, + elec_field_fourier, + elec_field, + elec_forces, + layout_q, + hamiltonian, + pm, + positions, + config, +): + """Calculate the electrostatic particle-field forces on the grid + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential is computed in reciprocal space as + + .. math:: + + \\Phi = \\mathrm{FFT}^{-1}\\left[ + \\frac{4\\pi k_e}{\\varepsilon \\vert\\mathbf{k}\\vert^2} + \\mathrm{FFT}(\\rho)\\mathrm{FFT}(H) + \\right], + + with the electric field + + .. math:: + + \\mathbf{E} = \\mathrm{FFT}^{-1}\\left[ + -i\\mathbf{k}\\,\\mathrm{FFT}(\\Psi) + \\right]. + + In the following, let :math:`\\mathbf{F}_j` denote the electrostatic force + acting on the particle with index :math:`j` and position + :math:`\\mathbf{r}_j`. The interpolated electrostatic force is + + .. math:: + + \\mathbf{F}_j = \\sum_k q_j\\mathbf{E}_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`\\mathbf{E}_{j_k}` is the discretized electric field at grid + vertex :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid + vertex with index :math:`j_k`, and :math:`h^3` is the volume of each grid + voxel. The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty; any values in this field + are discarded. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + elec_field_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + electric field values in reciprocal space on the computational grid. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + n_dimensions = config.box_size.size + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + # charges to grid + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) + phi_q /= volume_per_cell + # print("phi_q", np.sum(phi_q)) + phi_q.r2c(out=phi_q_fourier) + + # smear charges with filter + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + + # solve Poisson equation in Fourier space to get electrostatic potential + def poisson_transfer_function(k, v): + return 4.0 * np.pi * elec_conversion_factor * v / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(poisson_transfer_function, out=psi_fourier) + # print("psi_fourier", np.sum(psi_fourier)) + psi_fourier.c2r(out=psi) + # print("phi_q * psi update_field", np.sum(phi_q * psi)) + + # exit() + + # compute electric field directly from smeared charged densities in Fourier + for _d in np.arange(n_dimensions): + + def poisson_transfer_function(k, v, d=_d): + return ( + -1j + * k[d] + * 4.0 + * np.pi + * elec_conversion_factor + * v + / k.normp(p=2, zeromode=1) + ) + + phi_q_fourier.apply(poisson_transfer_function, out=elec_field_fourier[_d]) + elec_field_fourier[_d].c2r(out=elec_field[_d]) + + # get electrostatic force from electric field + for _d in np.arange(n_dimensions): + elec_forces[:, _d] = charges * ( + elec_field[_d].readout(positions, layout=layout_q) + )
+ + +def comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, +): + for t in range(config.n_types): + np.copyto(phi_transfer[0].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[1].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[2].value, phi_fourier[t].value, casting="no", where=True) + + # Evaluate laplacian of phi in fourier space + for d in range(3): + + def laplacian_transfer(k, v, d=d): + return -k[d] ** 2 * v + + phi_transfer[d].apply(laplacian_transfer, out=Ellipsis) + phi_transfer[d].c2r(out=phi_laplacian[t][d]) + + +
[docs]def update_field( + phi, + phi_laplacian, + phi_transfer, + layouts, + force_mesh, + hamiltonian, + pm, + positions, + types, + config, + v_ext, + phi_fourier, + v_ext_fourier, + m, + compute_potential=False, +): + """Calculate the particle-field potential and force density + + If :code:`compute_potential` is :code:`True`, the energy may subsequently + be computed by calling :code:`compute_field_and_kinetic_energy`. + + Computes the particle-field external potential :math:`V_\\text{ext}` from + particle number densities through the smoothed density field, + :math:`\\phi(\\mathbf{r})`. With :math:`P` being the cloud-in-cell (CIC) + window function, the density and filtered densities are computed as + + .. math:: + + \\phi(\\mathbf{r}) = \\sum_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\phi(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\phi(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + external potential is computed in reciprocal space as + + .. math:: + + V_\\text{ext} = \\mathrm{FFT}^{-1}\\left[ + \\mathrm{FFT} + \\left( + \\frac{\\partial w}{\\partial \\tilde\\phi} + \\right) + \\mathrm{FFT}(H) + \\right], + + where :math:`w` is the interaction energy functional. Differentiating + :math:`V_\\text{ext}` is done by simply applying :math:`i\\mathbf{k}` in + Fourier space, and the resulting forces are back-transformed to direct + space and interpolated to particle positions by + + .. math:: + + \\mathbf{F}_j = -\\sum_{j_k} \\nabla V_{j_k} + P(\\mathbf{r}_{j_k} - \\mathbf{r}_j)h^3, + + where :math:`j_k` are the neighbouring vertices of particle :math:`j` at + position :math:`\\mathbf{r}_j`, and :math:`h^3` is the volume of each grid + voxel. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Pre-allocated, but empty; any values + in this field are discarded. Changed in-place. Local for each MPI + rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + config : Config + Configuration object. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Pre-allocated, but empty; any values in this field are + discarded Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + phi_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computational grid is represented by the collective fields of all + MPI ranks. + v_ext_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplesField` objects containing discretized + particle-field external potential values in reciprocal space on the + computational grid; :code:`D+1` fields in D dimensions for each + particle type. :code:`D` copies are made after calculation for later + use in force calculation, because the `force transfer function` + application differentiates the field in-place, ruining the contents + for differentiation in the remaining :code:`D-1` spatial directions. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + m: list[float], (M,) + pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. + Defaults to 1.0 for all particle types. + compute_potential : bool, optional + If :code:`True`, a :code:`D+1`-th copy of the Fourier transformed + external potential field is made to be used later in particle-field + energy calculation. If :code:`False`, only :code:`D` copies are made. + + See also + -------- + compute_field_and_kinetic_energy : + Compute the particle-field energy after the external potential is + calculated. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + for t in range(config.n_types): + pm.paint(positions[types == t], mass=m[t], layout=layouts[t], out=phi[t]) + phi[t] /= volume_per_cell + phi[t].r2c(out=phi_fourier[t]) + phi_fourier[t].apply(hamiltonian.H, out=Ellipsis) + phi_fourier[t].c2r(out=phi[t]) + + # External potential + for t in range(config.n_types): + v = hamiltonian.v_ext[t](phi) + + v.r2c(out=v_ext_fourier[0]) + v_ext_fourier[0].apply(hamiltonian.H, out=Ellipsis) + np.copyto( + v_ext_fourier[1].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + np.copyto( + v_ext_fourier[2].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + if compute_potential: + np.copyto( + v_ext_fourier[3].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + + # Differentiate the external potential in fourier space + for d in range(3): + + def force_transfer_function(k, v, d=d): + return -k[d] * 1j * v + + v_ext_fourier[d].apply(force_transfer_function, out=Ellipsis) + v_ext_fourier[d].c2r(out=force_mesh[t][d]) + + if compute_potential: + v_ext_fourier[3].c2r(out=v_ext[t])
+ + +
[docs]def compute_field_and_kinetic_energy( + phi, + phi_q, + psi, + velocity, + hamiltonian, + positions, + types, + v_ext, + config, + layouts, + comm=MPI.COMM_WORLD, +): + """Compute the particle-field and kinetic energy contributions + + Calculates the kinetic energy through + + .. math:: + + E_k = \\sum_j \\frac{1}{2}m_j\\mathbf{v}_j\\cdot\\mathbf{v}_j, + + and the particle-field energy by + + .. math:: + + E_\\text{field} = \\int\\mathrm{d}\\mathbf{r}\\, + w[\\tilde\\phi], + + where :math:`w` is the interaction energy functional `density`. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + velocity : (N,D) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Local for each MPI rank--the full computational grid is + represented by the collective fields of all MPI ranks. + config : Config + Configuration object. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field : + Computes the up-to-date external potential for use in calculating the + particle-field energy. + """ + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + field_energy = w_0.csum() # w to W + + kinetic_energy = comm.allreduce(0.5 * config.mass * np.sum(velocity**2)) + + if config.coulombtype == "PIC_Spectral": + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + field_q_energy = w_elec.csum() + else: + field_q_energy = 0.0 + + return field_energy, kinetic_energy, field_q_energy
+ + +
[docs]def compute_field_energy_q_GPE( + config, + phi_eps, + field_q_energy, + dot_elec, + comm=MPI.COMM_WORLD, +): + """ + Compute the electrostatic energy after electrosatic forces is + calculated. + + From the definition of the elecrostatic potential :math:`\\Psi`, the energy + is + + W = \\frac{1}{2}\\int\\mathrm{d}\\mathbf{r}\\, + \\epsilon(\\mathbf{r})} \\left(\\mathbf{E}\\cdot \\mathbf{E}\\right), + + where :math:`\\epsilon(\\mathbf{r})}` is the anisotropic, spatially dependent, + relative dielectric of the simulation medium. + + Parameters + ---------- + config : hymd.input_parser.Config + Configuration object. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + field_q_energy : float + Total elecrostatic energy. + dot_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing :math:`|\\mathbf{E(r)}|^{2}` + on the computational grid. Local for each MPI rank -- the full computational + grid is represented by the collective fields of all MPI ranks. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field_force_q_GPE: + Compute the electrosatic force from an anisotropic dielectric general + Poisson equation. + """ + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + # ^ due to integration on local cell before allreduce + + eps_0 = 1.0 / (config.coulomb_constant * 4 * np.pi) + field_q_energy = ( + volume_per_cell * (0.5 * eps_0) * comm.allreduce(np.sum(phi_eps * dot_elec)) + ) + + return field_q_energy
+ + +
[docs]def update_field_force_q_GPE( + conv_fun, + phi, + types, + charges, + phi_q, + phi_q_fourier, + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol_prev, + phi_pol, + elec_field, + elec_forces, + elec_field_contrib, + psi, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + hamiltonian, + layout_q, + layouts, + pm, + positions, + config, + comm=MPI.COMM_WORLD, +): + """ + Calculate the electrostatic particle-field forces on the grid, arising from + a general Poisson equation, i.e. anisotropic permittivity/dielectric. + The function is called when tomli input config.coulombtype = "PIC_Spectral_GPE." + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential for a variable dielectric does not have an + analytical expression, and is computed in reciprocal through an iterative + method. + + The GPE states that + + .. math:: + + \\nabla \\cdot \\left(\\epsilon(\\mathbf{r}) + \\nabla{\\mathbf{\\psi(r)}}\\right) = -\\rho({\\mathbf{r}}). + + where :math:`\\epsilon(\\mathbf{r})` is the relative dielectric function. + + Parameters + ---------- + conv_fun : Convergence function. + Returns a scalar. Depends on MPI allreduce for similar convergence + across MPI ranks. + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_eta : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + gradients of the relative dielectric values on the computational grid. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank--the + full computational grid is represented by the collective fields of all MPI ranks. + phi_eta_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated discretized + Fourier transformed gradient relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol_prev : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charge values on the computational grid. Parameter in + the iterative method.Pre-allocated,but empty. Changedin-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charges on the computational grid. Parameter in the iterative + method, updating the next quess in solving for the electrostatic potential. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all + MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + elec_field_contrib : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing + :math:`|\\mathbf{E(r)}|^2/\\phi_{0}` on the computational grid. + Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + psi : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic potential + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + Vbar_elec : mesh.pm.RealField + Pmesh :code:`RealField` object for storing functional derivatives of + :math:`\\|w(\\{ \\phi \\})_{elec}`on the computational grid. + Pre-allocated, but empty. Changed in-place. Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + Vbar_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated functional + derivatives of :math:`\\|w(\\{ \\phi \\})_{elec}` in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + force_mesh_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic force values + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + force_mesh_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated electrostatic + force values in reciprocal space on the computational grid. Local for + each MPI rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + layouts: list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + comm: mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + compute_field_energy_q_GPE: + Compute the electrostatic energy after electrosatic force is + calculated for a variable (anisotropic) dielectric general Poisson equation. + """ + + ## basic setup + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + ## old protocol in gen_qe_hpf_use_self + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) ## + ## scale and fft + ## old protocol in gen_qe_hpf_use_self + phi_q /= volume_per_cell + phi_q.r2c(out=phi_q_fourier) + + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + ## ^------ use the same gaussian as the \kai interaciton + phi_q_fourier.c2r(out=phi_q) ## this phi_q is after applying the smearing function + + denom_phi_tot = pm.create("real", value=0.0) + num_types = pm.create("real", value=0.0) + ### ^ ----- Calculate the relative dielectric (permittivity) to field + ### ------- from a mean contribution of particle number densities + + for t_ in range(config.n_types): + num_types = num_types + (config.dielectric_type[t_]) * phi[t_] + denom_phi_tot = denom_phi_tot + phi[t_] + + np.divide(num_types, denom_phi_tot, where=np.abs(denom_phi_tot > 1e-6), out=phi_eps) + + phi_eps.r2c(out=phi_eps_fourier) # FFT dielectric + + # phi_q_eps = (phi_q/phi_eps) + np.divide(phi_q, phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_q) + + _SPACE_DIM = 3 + ##^--------- constants needed throughout the calculations + + ### method for finding the gradient (fourier space), using the spatial dimension of k + for _d in np.arange(_SPACE_DIM): + + def gradient_transfer_function(k, x, d=_d): + return 1j * k[d] * x + + phi_eps_fourier.apply(gradient_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=phi_eta[_d]) + np.divide(phi_eta[_d], phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_eta[_d]) + + ### iterative GPE solver ### + ### ---------------------------------------------- + max_iter = 100 + i = 0 + delta = 1.0 + # phi_pol_prev = pm.create("real", value = 0.0) + ### ^------ set to zero before each iterative procedure or soft start + conv_criteria = config.conv_crit # conv. criteria (default 1e-6) + w = config.pol_mixing # polarization mixing param (default 0.6) + while i < max_iter and delta > conv_criteria: + (phi_q + phi_pol_prev).r2c(out=phi_q_fourier) + for _d in np.arange(_SPACE_DIM): + + def iterate_apply_k_vec(k, additive_terms, d=_d): + return additive_terms * (-1j * k[d]) / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(iterate_apply_k_vec, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + + phi_pol = -( + phi_eta[0] * elec_field[0] + + phi_eta[1] * elec_field[1] + + phi_eta[2] * elec_field[2] + ) + ### ^-- Following a negative sign convention (-ik) of the FT, a neg sign is + ### --- mathematically correct by the definition of the GPE (double - -> +) + phi_pol = w * phi_pol + (1.0 - w) * phi_pol_prev + diff = np.abs(phi_pol - phi_pol_prev) + delta = conv_fun(comm, diff) # decided from toml input + phi_pol_prev = phi_pol.copy() + i = i + 1 + # print("Stopping after iteration {:d} with stop crit {:.2e}, delta {:.2e}".format(i,conv_criteria,delta)) + + # compute_potential = True + def k_norm_divide(k, potential): + return potential / k.normp(p=2, zeromode=1) + + ## > Electrostatic potential + eps0_inv = config.coulomb_constant * 4 * np.pi + ## ^ the 1/(4pi eps0)*4*pi = 1/eps0 + ((eps0_inv) * (phi_q + phi_pol)).r2c(out=phi_q_fourier) + phi_q_fourier.apply(k_norm_divide, out=phi_q_fourier) + phi_q_fourier.c2r(out=psi) + ### ^ electrostatic potential for the GPE + + for _d in np.arange(_SPACE_DIM): + + def field_transfer_function(k, x, d=_d): + return ( + -1j * k[d] * x + ) ## negative sign relation, due to E = - nabla psi relation + + phi_q_fourier.apply(field_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + ## ^-------- Method: Obtaining the electric field from electrostatic potential + ## Assuming the electric field is conserved. + ## Assumption holds if no magnetic flux (magnetic induced fields) + + ############## Obtain forces ############## + elec_dot = ( + elec_field[0] * elec_field[0] + + elec_field[1] * elec_field[1] + + elec_field[2] * elec_field[2] + ) + # needed for energy calculations + + np.divide( + elec_dot, + denom_phi_tot, + where=np.abs(denom_phi_tot > 1e-6), + out=elec_field_contrib, + ) + + eps0_inv = config.coulomb_constant * 4 * np.pi + + for t_ in range(config.n_types): + Vbar_elec[t_] = ( + config.type_charges[t_] * psi + - (0.5 / eps0_inv) + * (config.dielectric_type[t_] - phi_eps) + * elec_field_contrib + ) + + # Obtain Vext,k + for t_ in range(config.n_types): + Vbar_elec[t_].r2c(out=Vbar_elec_fourier[t_]) + Vbar_elec_fourier[t_].apply(hamiltonian.H, out=Vbar_elec_fourier[t_]) + + # force terms + # F = - grad Vext + for t_ in range(config.n_types): + for _d in np.arange(_SPACE_DIM): + + def force_transfer_function(k, x, d=_d): + return -1j * k[_d] * x ## negative gradient + + Vbar_elec_fourier[t_].apply( + force_transfer_function, out=force_mesh_elec_fourier[t_][_d] + ) + force_mesh_elec_fourier[t_][_d].c2r(out=force_mesh_elec[t_][_d]) + elec_forces[types == t_, _d] = force_mesh_elec[t_][_d].readout( + positions[types == t_], layout=layouts[t_] + ) + + return Vbar_elec, phi_eps, elec_dot
+ + +
[docs]def domain_decomposition( + positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=MPI.COMM_WORLD +): + """Performs domain decomposition + + Rearranges the MPI rank memory layout into one that better mimics the PFFT + pencil grid 2D decomposition. As molecules are always required to be fully + contained on a single MPI rank, a perfect decomposition is not always + possible. The best decomposition which leaves the center of mass of all + molecules in their respective correct domains is used, with possible + overlap into neighbouring domains if the spatial extent of any molecule + crosses domain boundaries. + + Parameters + ---------- + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + *args + Variable length argument list containing arrays to include in the + domain decomposition. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + bonds : (N,M) numpy.ndarray, optional + Array of :code:`M` bonds originating from each of :code:`N` particles. + verbose : int, optional + Specify the logging event verbosity of this function. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + Domain decomposed :code:`positions` and any array specified in + :code:`*args`, in addition to :code:`bonds` and :code:`molecules` if these + arrays were provided as input. + """ + if molecules is not None: + if not topol: + assert bonds is not None, "bonds must be provided with molecules" + unique_molecules = np.sort(np.unique(molecules)) + molecules_com = np.empty_like(positions) + for m in unique_molecules: + ind = molecules == m + r = positions[ind, :][0, :] + molecules_com[ind, :] = r + layout = pm.decompose(molecules_com, smoothing=0) + if not topol: + args = (*args, bonds, molecules) + else: + args = (*args, molecules) + else: + layout = pm.decompose(positions, smoothing=0) + if verbose > 1: + Logger.rank0.log( + logging.INFO, + "DOMAIN_DECOMP: Total number of particles to be exchanged = %d", + np.sum(layout.get_exchange_cost()), + ) + return layout.exchange(positions, *args)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/_modules/hymd/file_io.html b/v1.0.5/_modules/hymd/file_io.html new file mode 100644 index 00000000..d925e2d2 --- /dev/null +++ b/v1.0.5/_modules/hymd/file_io.html @@ -0,0 +1,1147 @@ + + + + + + hymd.file_io — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.file_io

+"""Handle file input/output in parllel HDF5 fashion
+"""
+import numpy as np
+import h5py
+import os
+import logging
+import getpass
+from mpi4py import MPI
+from .logger import Logger, get_version
+
+
+
[docs]class OutDataset: + """HDF5 dataset handler for file output""" + + def __init__( + self, + dest_directory, + config, + double_out=False, + disable_mpio=False, + comm=MPI.COMM_WORLD, + ): + """Constructor + + Parameters + ---------- + dest_directory : str + Ouput directory for saving data. + config : Config + Configuration object. + double_out : bool, optional + If :code:`True`, the output HDF5 objects are written in eight byte + floating point representation. Otherwise, four byte single + precision is used. + disable_mpio : bool, optional + If :code:`True`, disables parallel MPI-enabled HDF5 file output. + This is a compatibility option used if HDF5 is not compiled with + MPI support. This makes everything much harder by splitting all + output in one file per MPI rank, and having an MPI-enabled HDF5 + library is **highly recommended**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + """ + self.disable_mpio = disable_mpio + self.config = config + if double_out: + self.float_dtype = "float64" + else: + self.float_dtype = "float32" + + if disable_mpio: + self.file = h5py.File( + os.path.join( + dest_directory, f"sim.hdf5-{comm.rank:6d}-of-{comm.size:6d}" + ), + "w", + ) + else: + self.file = h5py.File( + os.path.join(dest_directory, "sim.H5"), "w", driver="mpio", comm=comm + ) + +
[docs] def is_open(self, comm=MPI.COMM_WORLD): + """Check if HDF5 output file is open + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + return self.file.__bool__()
+ +
[docs] def close_file(self, comm=MPI.COMM_WORLD): + """Closes the HDF5 output file + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + self.file.close()
+ +
[docs] def flush(self): + """Flushes output buffers, forcing file writes""" + self.file.flush()
+ + +
[docs]def setup_time_dependent_element( + name, parent_group, n_frames, shape, dtype, units=None +): + """Helper function for setting up time-dependent HDF5 group datasets + + All output groups must adhere to the H5MD standard, meaning a structure of + + + | ┗━ **group** particle group (e.g. :code:`all`) or :code:`observables` group + | ┗━ **group** time-dependent data + | ┣━ **dataset** :code:`step` :code:`shape=(n_frames,)` + | ┣━ **dataset** :code:`time` :code:`shape=(n_frames,)` + | ┗━ **dataset** :code:`value` :code:`shape=(n_frames, *)` + + is necessary. + + References + ---------- + H5MD specification : + https://www.nongnu.org/h5md/h5md.html + """ # noqa: E501 + group = parent_group.create_group(name) + step = group.create_dataset("step", (n_frames,), "int32") + time = group.create_dataset("time", (n_frames,), "float32") + value = group.create_dataset("value", (n_frames, *shape), dtype) + + if units is not None: + value.attrs["unit"] = units + time.attrs["unit"] = "ps" + return group, step, time, value
+ + +
[docs]def store_static( + h5md, + rank_range, + names, + types, + indices, + config, + bonds_2_atom1, + bonds_2_atom2, + molecules=None, + velocity_out=False, + force_out=False, + charges=False, + dielectrics=False, + plumed_out=False, + comm=MPI.COMM_WORLD, +): + """Outputs all static time-independent quantities to the HDF5 output file + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + rank_range : list[int] + Start and end indices for global arrays for each MPI rank. + names : (N,) numpy.ndarray + Array of names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of type indices for :code:`N` particles. + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + config : Config + Configuration object. + bonds_2_atom1 : (B,) numpy.ndarray + Array of indices of the first particle for :code:`B` total + two-particle bonds. + bonds_2_atom2 : (B,) numpy.ndarray + Array of indices of the second particle for :code:`B` total + two-particle bonds. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. + dielectrics : (N,) numpy.ndarray + Array of particle relative dielectric values for :code:`N` particles. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to output HDF5 file. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + prepare_bonds : + Constructs two-, three-, and four-particle bonds from toplogy input + file and bond configuration information. + distribute_input : + Distributes input arrays onto MPI ranks, attempting load balancing. + """ + dtype = h5md.float_dtype + + h5md_group = h5md.file.create_group("/h5md") + h5md.h5md_group = h5md_group + h5md.observables = h5md.file.create_group("/observables") + h5md.connectivity = h5md.file.create_group("/connectivity") + h5md.parameters = h5md.file.create_group("/parameters") + + h5md_group.attrs["version"] = np.array([1, 1], dtype=int) + author_group = h5md_group.create_group("author") + author_group.attrs["name"] = np.string_(getpass.getuser()) + creator_group = h5md_group.create_group("creator") + creator_group.attrs["name"] = np.string_("Hylleraas MD") + + # Get HyMD version + creator_group.attrs["version"] = np.string_(get_version()) + + h5md.particles_group = h5md.file.create_group("/particles") + h5md.all_particles = h5md.particles_group.create_group("all") + mass = h5md.all_particles.create_dataset("mass", (config.n_particles,), dtype) + mass[...] = config.mass + + if charges is not False: + charge = h5md.all_particles.create_dataset( + "charge", (config.n_particles,), dtype="float32" + ) + charge[indices] = charges + if dielectrics is not False: + dielectric = h5md.all_particles.create_dataset( + "dielectric", (config.n_particles,), dtype="float32" + ) + dielectric[indices] = dielectrics + + box = h5md.all_particles.create_group("box") + box.attrs["dimension"] = 3 + box.attrs["boundary"] = np.array( + [np.string_(s) for s in 3 * ["periodic"]], dtype="S8" + ) + + n_frames = config.n_steps // config.n_print + if np.mod(config.n_steps - 1, config.n_print) != 0: + n_frames += 1 + if np.mod(config.n_steps, config.n_print) == 1: + n_frames += 1 + if n_frames == config.n_steps: + n_frames += 1 + + species = h5md.all_particles.create_dataset( + "species", + (config.n_particles,), + dtype="i", + ) + + ( + _, + h5md.positions_step, + h5md.positions_time, + h5md.positions, + ) = setup_time_dependent_element( + "position", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm", + ) + if velocity_out: + ( + _, + h5md.velocities_step, + h5md.velocities_time, + h5md.velocities, + ) = setup_time_dependent_element( + "velocity", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm ps-1", + ) + if force_out: + ( + _, + h5md.forces_step, + h5md.forces_time, + h5md.forces, + ) = setup_time_dependent_element( + "force", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="kJ mol-1 nm-1", + ) + ( + _, + h5md.total_energy_step, + h5md.total_energy_time, + h5md.total_energy, + ) = setup_time_dependent_element( + "total_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.kinetc_energy_step, + h5md.kinetc_energy_time, + h5md.kinetc_energy, + ) = setup_time_dependent_element( + "kinetic_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.potential_energy_step, + h5md.potential_energy_time, + h5md.potential_energy, + ) = setup_time_dependent_element( + "potential_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.bond_energy_step, + h5md.bond_energy_time, + h5md.bond_energy, + ) = setup_time_dependent_element( + "bond_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.angle_energy_step, + h5md.angle_energy_time, + h5md.angle_energy, + ) = setup_time_dependent_element( + "angle_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.dihedral_energy_step, + h5md.dihedral_energy_time, + h5md.dihedral_energy, + ) = setup_time_dependent_element( + "dihedral_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.field_energy_step, + h5md.field_energy_time, + h5md.field_energy, + ) = setup_time_dependent_element( + "field_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + if charges is not False: + ( + _, + h5md.field_q_energy_step, + h5md.field_q_energy_time, + h5md.field_q_energy, + ) = setup_time_dependent_element( + "field_q_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) # <-------- xinmeng + if plumed_out is not False: + ( + _, + h5md.plumed_bias_step, + h5md.plumed_bias_time, + h5md.plumed_bias, + ) = setup_time_dependent_element( + "plumed_bias", h5md.observables, n_frames, (1,), dtype, units="kJ mol-1" # noqa: E501 + ) + ( + _, + h5md.total_momentum_step, + h5md.total_momentum_time, + h5md.total_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "total_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm g ps-1 mol-1", + ) + ( + _, + h5md.angular_momentum_step, + h5md.angular_momentum_time, + h5md.angular_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "angular_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm+2 g ps-1 mol-1", + ) + ( + _, + h5md.torque_step, + h5md.torque_time, + h5md.torque, + ) = setup_time_dependent_element( # noqa: E501 + "torque", + h5md.observables, + n_frames, + (3,), + dtype, + units="kJ nm+2 mol-1", + ) + ( + _, + h5md.temperature_step, + h5md.temperature_time, + h5md.temperature, + ) = setup_time_dependent_element( + "temperature", h5md.observables, n_frames, (3,), dtype, units="K" + ) + ( + _, + h5md.thermostat_work_step, + h5md.thermostat_work_time, + h5md.thermostat_work, + ) = setup_time_dependent_element( + "thermostat_work", + h5md.observables, + n_frames, + (1,), + "float32", + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.pressure_step, + h5md.pressure_time, + h5md.pressure, + ) = setup_time_dependent_element( + "pressure", h5md.observables, n_frames, (18,), "float32", units="Bar" + ) + (_, h5md.box_step, h5md.box_time, h5md.box_value,) = setup_time_dependent_element( + "edges", box, n_frames, (3, 3), "float32", units="nm" + ) + + ind_sort = np.argsort(indices) + for i in ind_sort: + species[indices[i]] = config.name_to_type_map[names[i].decode("utf-8")] + + h5md.parameters.attrs["config.toml"] = np.string_(str(config)) + vmd_group = h5md.parameters.create_group("vmd_structure") + index_of_species = vmd_group.create_dataset( + "indexOfSpecies", (config.n_types,), "i" + ) + index_of_species[:] = np.array(list(range(config.n_types))) + + # VMD-h5mdplugin maximum name/type name length is 16 characters (for + # whatever reason [VMD internals?]). + name_dataset = vmd_group.create_dataset("name", (config.n_types,), "S16") + type_dataset = vmd_group.create_dataset("type", (config.n_types,), "S16") + if molecules is not None: + resid_dataset = vmd_group.create_dataset( + "resid", + (config.n_particles,), + "i", + ) + + # Change this + for i, n in config.type_to_name_map.items(): + name_dataset[i] = np.string_(n[:16]) + if n == "W": + type_dataset[i] = np.string_("solvent") + else: + type_dataset[i] = np.string_("membrane") + + total_bonds = comm.allreduce(len(bonds_2_atom1), MPI.SUM) + n_bonds_local = len(bonds_2_atom1) + + receive_buffer = comm.gather(n_bonds_local, root=0) + n_bonds_global = None + if comm.Get_rank() == 0: + n_bonds_global = receive_buffer + n_bonds_global = np.array(comm.bcast(n_bonds_global, root=0)) + rank_bond_start = np.sum(n_bonds_global[: comm.Get_rank()]) + + bonds_from = vmd_group.create_dataset("bond_from", (total_bonds,), "i") + bonds_to = vmd_group.create_dataset("bond_to", (total_bonds,), "i") + for i in range(n_bonds_local): + a = bonds_2_atom1[i] + b = bonds_2_atom2[i] + bonds_from[rank_bond_start + i] = indices[a] + 1 + bonds_to[rank_bond_start + i] = indices[b] + 1 + + if molecules is not None: + resid_dataset[indices[ind_sort]] = molecules
+ + +# store data old vs +""" +h5md, step, frame, indices, positions, velocities, forces, box_size, +temperature, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, +field_energy, field_q_energy, time_step, config, velocity_out=False, +force_out=False, charge_out=False, dump_per_particle=False, +""" + + +
[docs]def store_data( + h5md, + step, + frame, + indices, + positions, + velocities, + forces, + box_size, + temperature, + pressure, + kinetic_energy, + bond2_energy, + bond3_energy, + bond4_energy, + field_energy, + field_q_energy, + plumed_bias, + time_step, + config, + velocity_out=False, + force_out=False, + charge_out=False, + plumed_out=False, + dump_per_particle=False, + comm=MPI.COMM_WORLD, +): + """Writes time-step data to HDF5 output file + + Handles all quantities which change during simulation, as opposed to + static quanitities (see :code:`store_static`). + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + step : int + Step number. + frame : int + Output frame number (:code:`step // n_print`). + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + positions : (N,) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + velocities : (N,) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + forces : (N,) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. + box_size : (D,) numpy.ndarray + Array containing the simulation box size. + temperature : float + Calculated instantaneous temperature. + kinetic_energy : float + Calculated instantaneous kinetic energy. + bond2_energy : float + Calculated instantaneous harmonic two-particle bond energy. + bond3_energy : float + Calculated instantaneous harmonic angular three-particle bond energy. + bond4_energy : float + Calculated instantaneous dihedral four-particle torsion energy. + field_energy : float + Calculated instantaneous particle-field energy. + field_q_energy : float + Calculated instantaneous electrostatic energy. + plumed_bias : float + PLUMED instantaneous bias energy. + time_step : float + Value of the time step. + config : Config + Configuration object. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charge_out : bool, optional + If :code:`True`, electrostatic energies are written to the output + HDF5 file. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to the output HDF5 file. + dump_per_particle : bool, optional + If :code:`True`, all quantities are written **per particle**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + store_static : + Outputs all static time-independent quantities to the HDF5 output file + """ + for dset in ( + h5md.positions_step, + h5md.total_energy_step, + h5md.potential_energy_step, + h5md.kinetc_energy_step, + h5md.bond_energy_step, + h5md.angle_energy_step, + h5md.dihedral_energy_step, + h5md.field_energy_step, + h5md.total_momentum_step, + h5md.angular_momentum_step, + h5md.torque_step, + h5md.temperature_step, + h5md.pressure_step, + h5md.box_step, + h5md.thermostat_work_step, + ): + dset[frame] = step + + for dset in ( + h5md.positions_time, + h5md.total_energy_time, + h5md.potential_energy_time, + h5md.kinetc_energy_time, + h5md.bond_energy_time, + h5md.angle_energy_time, + h5md.dihedral_energy_time, + h5md.field_energy_time, + h5md.total_momentum_time, + h5md.angular_momentum_time, + h5md.torque_time, + h5md.temperature_time, + h5md.pressure_time, + h5md.box_time, + h5md.thermostat_work_time, + ): + dset[frame] = step * time_step + + if velocity_out: + h5md.velocities_step[frame] = step + h5md.velocities_time[frame] = step * time_step + if force_out: + h5md.forces_step[frame] = step + h5md.forces_time[frame] = step * time_step + if charge_out: + h5md.field_q_energy_step[frame] = step + h5md.field_q_energy_time[frame] = step * time_step + if plumed_out: + h5md.plumed_bias_step[frame] = step + h5md.plumed_bias_time[frame] = step * time_step + + ind_sort = np.argsort(indices) + h5md.positions[frame, indices[ind_sort]] = positions[ind_sort] + + if velocity_out: + h5md.velocities[frame, indices[ind_sort]] = velocities[ind_sort] + if force_out: + h5md.forces[frame, indices[ind_sort]] = forces[ind_sort] + if charge_out: + h5md.field_q_energy[frame] = field_q_energy + if plumed_out: + h5md.plumed_bias[frame] = plumed_bias + + potential_energy = ( + bond2_energy + bond3_energy + bond4_energy + field_energy + field_q_energy + ) + + total_momentum = config.mass * comm.allreduce(np.sum(velocities, axis=0), MPI.SUM) + angular_momentum = config.mass * comm.allreduce( + np.sum(np.cross(positions, velocities), axis=0), MPI.SUM + ) + torque = config.mass * comm.allreduce( + np.sum(np.cross(positions, forces), axis=0), MPI.SUM + ) + h5md.total_energy[frame] = kinetic_energy + potential_energy + h5md.potential_energy[frame] = potential_energy + h5md.kinetc_energy[frame] = kinetic_energy + h5md.bond_energy[frame] = bond2_energy + h5md.angle_energy[frame] = bond3_energy + h5md.dihedral_energy[frame] = bond4_energy + h5md.field_energy[frame] = field_energy + h5md.total_momentum[frame, :] = total_momentum + h5md.angular_momentum[frame, :] = angular_momentum + h5md.torque[frame, :] = torque + h5md.temperature[frame] = temperature + h5md.pressure[frame] = pressure + for d in range(3): + h5md.box_value[frame, d, d] = box_size[d] + h5md.thermostat_work[frame] = config.thermostat_work + + fmt_ = [ + "step", + "time", + "temp", + "tot E", + "kin E", + "pot E", + "field E", + "elec E", + "bond E", + "ang E", + "dih E", + "bias E", + "Px", + "Py", + "Pz", + "ΔH" if config.target_temperature else "ΔE", + ] + fmt_ = np.array(fmt_) + + # create mask to show only energies != 0 + en_array = np.array([ + field_energy, + field_q_energy, + bond2_energy, + bond3_energy, + bond4_energy, + plumed_bias, + ]) + mask = np.full_like(fmt_, True, dtype=bool) + mask[range(6,12)] = en_array != 0. + + header_ = fmt_[mask].shape[0] * "{:>13}" + if config.initial_energy is None: + fmt_[-1] = "" + + divide_by = 1.0 + if dump_per_particle: + for i in range(3, 9): + fmt_[i] = fmt_[i][:-2] + "E/N" + fmt_[-1] += "/N" + divide_by = config.n_particles + total_energy = kinetic_energy + potential_energy + if config.initial_energy is not None: + if config.target_temperature: + H_tilde = total_energy - config.initial_energy - config.thermostat_work + else: + H_tilde = total_energy - config.initial_energy + else: + H_tilde = 0.0 + + header = header_.format(*fmt_[mask]) + data_fmt = f'{"{:13}"}{(fmt_[mask].shape[0]-1) * "{:13.5g}" }' + all_data = [ + step, + time_step * step, + temperature, + total_energy / divide_by, + kinetic_energy / divide_by, + potential_energy / divide_by, + field_energy / divide_by, + field_q_energy / divide_by, + bond2_energy / divide_by, + bond3_energy / divide_by, + bond4_energy / divide_by, + plumed_bias / divide_by, + total_momentum[0] / divide_by, + total_momentum[1] / divide_by, + total_momentum[2] / divide_by, + H_tilde / divide_by, + ] + data = data_fmt.format(*[val for i, val in enumerate(all_data) if mask[i]]) + Logger.rank0.log(logging.INFO, ("\n" + header + "\n" + data))
+ + +
[docs]def distribute_input( + in_file, rank, size, n_particles, max_molecule_size=201, comm=MPI.COMM_WORLD +): + """Assign global arrays onto MPI ranks, attempting load balancing + + Distributes approximately equal numbers of particles (workload) onto each + independent MPI rank, while respecting the requirement that any molecule + must be fully contained on a single MPI rank only (no splitting molecules + across multiple CPUs). + + Parameters + ---------- + in_file : h5py.File + HDF5 input file object. + rank : int + Local rank number for this MPI rank. + size : int + Global size of the MPI communicator (number of total CPUs). + n_particles : int + Total number of particles. + max_molecule_size : int, optional + Maximum size of any molecule present in the system. Used to initially + guess where the MPI rank boundaries (start/end indices) in the global + arrays should be placed. If molecules of size + :code:`>max_molecule_size` exist in the simulation system, HyMD + **might** work as expected. Or it might fail spectacularly. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + rank_range : + Starting and ending indices in the global arrays for each MPI rank. + """ + if n_particles is None: + n_particles = len(in_file["indices"]) + np_per_MPI = n_particles // size + + molecules_flag = False + if "molecules" in in_file: + molecules_flag = True + + if not molecules_flag: + if rank == size - 1: + np_cum_mpi = [rank * np_per_MPI, n_particles] + else: + np_cum_mpi = [rank * np_per_MPI, (rank + 1) * np_per_MPI] + p_mpi_range = list(range(np_cum_mpi[0], np_cum_mpi[1])) + return p_mpi_range, molecules_flag + + # To avoid splitting molecules across multiple different ranks, we need + # to read in some extra indices before/after the expected break points + # and iterate until we find a molecule break. + # + # Implicitly assuming no molecule is bigger than + # min(max_molecule_size, n_particles // n_MPI_ranks) atoms. + max_molecule_size += 2 + grab_extra = max_molecule_size if np_per_MPI > max_molecule_size else np_per_MPI + if rank == 0: + mpi_range_start = 0 + if size == 1: + mpi_range_end = n_particles + else: + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + elif rank == size - 1: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = n_particles + else: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + + molecules = in_file["molecules"][mpi_range_start:mpi_range_end] + indices = in_file["indices"][mpi_range_start:mpi_range_end] + molecule_end_indices = np.nonzero(np.diff(molecules))[0] + + p_mpi_range = [None, None] + if rank == 0: + p_mpi_range[0] = 0 + if size == 1: + p_mpi_range[1] = n_particles + else: + p_mpi_range[1] = indices[ + molecule_end_indices[molecule_end_indices >= np_per_MPI][0] + 1 + ] + elif rank == size - 1: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = n_particles + else: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = ( + indices[molecule_end_indices[molecule_end_indices > np_per_MPI][0]] + + 1 # noqa: E501 + ) + return list(range(p_mpi_range[0], p_mpi_range[1])), molecules_flag
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/_modules/hymd/force.html b/v1.0.5/_modules/hymd/force.html new file mode 100644 index 00000000..dd13f850 --- /dev/null +++ b/v1.0.5/_modules/hymd/force.html @@ -0,0 +1,1150 @@ + + + + + + hymd.force — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.force

+"""Calculates intramolecular forces between bonded particles in molecules
+"""
+import numpy as np
+import networkx as nx
+from dataclasses import dataclass
+
+# Imported here so we can call from force import compute_bond_forces__fortran
+from force_kernels import cbf as compute_bond_forces__fortran  # noqa: F401
+from force_kernels import (  # noqa: F401
+    caf as compute_angle_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cdf as compute_dihedral_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cbf_d as compute_bond_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    caf_d as compute_angle_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    cdf_d as compute_dihedral_forces__fortran__double,
+)
+
+
+
[docs]@dataclass # might not be needed +class Dielectric_type: + atom_1: str + dielectric_value: float
+ + +
[docs]@dataclass +class Bond: + """Dataclass representing a single two-particle bond type + + A `bond type` is a bond strength and equilibrium distance associated with + any bond between particles of specific types :code:`A` and :code:`B` + (where :code:`A` and :code:`B` may be the same or different). Harmonic + two-particle bonds in HyMD take the form + + .. math:: + + V_2(\\mathbf{r}_1, \\mathbf{r}_2) = + \\frac{1}{2}k + \\left( + \\vert \\mathbf{r}_1 - \\mathbf{r}_2 \\vert - r_0 + \\right)^2, + + where :math:`k` is the bond strength (spring constant) and :math:`r_0` is + the equilibrium bond length (at which the energy is zero). + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + equilibrium : float + Equilibrium distance at which the energy associated with the bond + vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient (spring constant). + """ + + atom_1: str + atom_2: str + equilibrium: float + strength: float
+ + +
[docs]@dataclass +class Angle(Bond): + """Dataclass representing a single three-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any three-particle bond between particles of specific types :code:`A`, + :code:`B`, and :code:`C` (where :code:`A`, :code:`B`, and :code:`C` may be + different or the same). Harmonic angular three-particle bonds in HyMD take + the form + + .. math:: + + V_3(\\mathbf{r}_1, \\mathbf{r}_2, \\mathbf{r}_3) = + \\frac{1}{2}k + \\left( + \\cos^{-1} + \\left[ + \\frac{ + (\\mathbf{r}_1-\\mathbf{r}_2) + \\cdot + (\\mathbf{r}_3-\\mathbf{r}_2) + } + { + \\vert\\mathbf{r}_1-\\mathbf{r}_2\\vert + \\vert\\mathbf{r}_3-\\mathbf{r}_2\\vert + } + \\right] - \\theta_0 + \\right)^2 + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + equilibrium : float + Equilibrium angle at which the energy associated with the + three-particle angular bond vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient. + + See also + -------- + Bond : + Two-particle bond type dataclass + """ + + atom_3: str
+ + +
[docs]@dataclass +class Dihedral: + """Dataclass representing a single four-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any four-particle torsional bond between particles of specific types + :code:`A`, :code:`B`, :code:`C`, and :code:`D` (where :code:`A`, :code:`B`, + :code:`C`, and :code:`D` may be different or the same). Dihedral + four-particle bonds in HyMD take different forms depending on the + :code:`dih_type` parameter. + + In the following, let :math:`\\phi` denote the angle between the planes + spanned by the relative positions of atoms :code:`A`-:code:`B`-:code:`C` + and :code:`B`-:code:`C`-:code:`D`. If :code:`dih_type = 0`, then + + .. math:: + + V_4(\\phi) = \\sum_n c_n + \\left( + 1 + \\cos\\left[ + n\\phi - d_n + \\right] + \\right), + + where :math:`c_n` are energy coefficients and :math:`d_n` are propensity + phases. By default, the cosine sum is truncated at five terms. If + :code:`coeffs` provides only a single float, this is used as the coiling + propensity parameter :math:`\\lambda`. In this case, :math:`c_n` and + :math:`d_n` are automatically set to values which promote alpha helical + (:math:`\\lambda=-1`), beta sheet (:math:`\\lambda=1`), or a mixed + (:math:`1>\\lambda>-1`) structure (using values provided by Bore et al. + (2018)). In this case, the full potential takes the form + + .. math:: + + V_4(\\phi;\\lambda) = + \\frac{1}{2}(1-\\lambda) V_{\\text{prop},\\alpha}(\\phi) + + + \\frac{1}{2}(1+\\lambda) V_{\\text{prop},\\beta}(\\phi) + + + (1-\\vert\\lambda\\vert) V_{\\text{prop}, \\text{coil}}(\\phi), + + with each of the :math:`V_{\\mathrm{prop}, X}` being fixed cosine series + potentials with pre-set :math:`c_n` -s and :math:`d_n` -s. + + If :code:`dih_type = 1`, then a combined bending torsional (CBT) potential + is employed, + + .. math:: + + V_4(\\phi,\\gamma;\\lambda) = + V_4(\\phi;\\lambda) + + + \\frac{1}{2}K(\\phi)(\\gamma - \\gamma_0)^2, + + where :math:`V_4(\\phi;\\lambda)` specifies the potential as given by the + coiling propensity parameter above, :math:`K(\\phi)` is a separate cosine + series potential acting as the angular three-particle bond strength, and + :math:`\\gamma_0` is the three-particle bond equilibrium angle. In this + case, the :code:`coeffs` parameter must specify *both* a :math:`\\lambda` + value, in additon to the energy and phases dictating the :math:`K(\\phi)` + potential. + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + atom_4 : str + Type name of particle 4. + coeffs : list[list[float]] or list[float] or numpy.ndarray + Dihedral coefficients defining the series expansion of the dihedral + energy. + dih_type : int + Specifies the type of dihedral used; If :code:`0`, then :code:`coeffs` + must contain **either** two lists of five energy coefficients + :math:`c_n` and five propensity phases :math:`d_n` **or** a single + floating point number defining the :math:`\\lambda` coiling propensity + parameter. If :code:`1`, the combined bending-torsional potential is + used, and :code:`coeffs` must specify :math:`\\lambda` *and* two lists + containing energy coefficients and propensity phases for the + :math:`V_\\text{prop}` propensity potential, defined in terms of cosine + series. + + References + ---------- + Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018. + """ + + atom_1: str + atom_2: str + atom_3: str + atom_4: str + coeffs: np.ndarray + dih_type: int
+ + +
[docs]@dataclass +class Chi: + """Dataclass representing a single :math:`\\chi` mixing interaction type + + An `interaction mixing energy type` is a mixing energy associated with + density overlap between species of types :code:`A` and :code:`B` + (specified as inputs :code:`atom_1` and :code:`atom_2`). A positive mixing + energy promotes phase separation, a negative mixing energy promotes mixing. + The interaction energy density (provided the :code:`DefaultWithChi` + Hamiltonian is used) takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} + \\sum_{k,l}\\chi_{k,l} \\tilde\\phi_k\\tilde\\phi_l, + + where :math:`\\chi_{k,l}` denotes the mixing energy between species + :math:`k` and :math:`l`, with :math:`\\kappa` being the incompressibility. + The value of the interaction mixing energy parameter may be extracted from + `Flory-Huggins theory`_. + + .. _`Flory-Huggins theory`: + https://en.wikipedia.org/wiki/Flory%E2%80%93Huggins_solution_theory + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + interaction_energy : float + Interaction mixing energy. + + See also + -------- + hymd.hamiltonian.DefaultWithChi : + Interaction energy functional using :math:`\\chi`-interactions. + """ + + atom_1: str + atom_2: str + interaction_energy: float
+ + +
[docs]def find_all_paths(G, u, n): + """Helper function that recursively finds all paths of given lenght 'n + 1' inside a network 'G'. + Adapted from https://stackoverflow.com/a/28103735.""" + if n == 0: + return [[u]] + paths = [] + for neighbor in G.neighbors(u): + for path in find_all_paths(G, neighbor, n - 1): + if u not in path: + paths.append([u] + path) + return paths
+ + +
[docs]def propensity_potential_coeffs(x: float): + alpha_coeffs = np.array( + [ + [7.406, -5.298, -2.570, 1.336, 0.739], + [-0.28632126, 1.2099146, 1.18122138, 0.49075168, 0.98495911], + ] + ) + beta_coeffs = np.array( + [ + [3.770, 5.929, -4.151, -0.846, 0.190], + [-0.2300693, -0.0583289, 0.99342396, 1.03237971, 2.90160988], + ] + ) + coil_coeffs = np.array( + [ + [1.416, -0.739, 0.990, -0.397, 0.136], + [1.3495933, 0.45649087, 2.30441057, -0.12274901, -0.26179939], + ] + ) + + zero_add = np.zeros((2, 5)) + if np.isclose(x, -1): + return np.concatenate((alpha_coeffs, zero_add)) + elif np.isclose(x, 0): + return np.concatenate((coil_coeffs, zero_add)) + elif np.isclose(x, 1): + return np.concatenate((beta_coeffs, zero_add)) + + abs_x = np.abs(x) + if abs_x > 1: + err_str = ( + f"The provided value of lambda = {x} is out of lambda definition range, " + f"[-1.0, 1.0]." + ) + Logger.rank0.log(logging.ERROR, err_str) + else: + coil_coeffs[0] *= 1 - abs_x + if x < 0: + alpha_coeffs[0] *= 0.5 * (abs_x - x) + return np.concatenate((alpha_coeffs, coil_coeffs)) + else: + beta_coeffs[0] *= 0.5 * (abs_x + x) + return np.concatenate((beta_coeffs, coil_coeffs))
+ + +
[docs]def prepare_bonds_old(molecules, names, bonds, indices, config): + """Find bonded interactions from connectivity and bond types information + + .. deprecated:: 1.0.0 + :code:`prepare_bonds_old` was replaced by :code:`prepare_bonds` for + use with compiled Fortran kernels prior to 1.0.0 release. + + Prepares the necessary equilibrium and bond strength information needed by + the intramolecular interaction functions. This is performed locally on each + MPI rank, as the domain decomposition ensures that for all molecules *all* + consituent particles are always contained on *the same* MPI rankself. + + This function traverses the bond connectivity information provided in the + structure/topology input file and indentifies any two-, three-, or + four-particle potential bonds. For each connected chain of two, three, or + four particles, a matching to bond types is attempted. If the corresponding + names match, a bond object is initialized. + + In order to investigate the connectivity, a graph is created using + networkx functionality. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2 : list + List of lists containing *local* particle indices, equilibrium + distance, and bond strength coefficient for each reconstructed + two-particle bond. + bonds_3 : + List of lists containing *local* particle indices, equilibrium angle, + and bond strength coefficient for each reconstructed three-particle + bond. + bonds_4 : + List of lists containing *local* particle indices, dihedral type index, + and dihedral coefficients for each reconstructed four-particle + torsional bond. + bb_index : list + List indicating the dihedral type of each four-particle bond in + :code:`bonds_4`. + + See also + -------- + Bond : + Two-particle bond type dataclass. + Angle : + Three-particle angular bond type dataclass. + Dihedral : + Four-particle torsional bond type dataclass. + hymd.input_parser.Config + Configuration dataclass handler. + """ + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + bb_index = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + bb_dihedral = 0 + bond_graph = nx.Graph() + + for local_index, global_index in enumerate(indices): + if molecules[local_index] != mol: + continue + + bond_graph.add_node( + global_index, + name=names[local_index].decode("UTF-8"), + local_index=local_index, + ) + for bond in [b for b in bonds[local_index] if b != -1]: + bond_graph.add_edge(global_index, bond) + + connectivity = nx.all_pairs_shortest_path(bond_graph) + for c in connectivity: + i = c[0] + connected = c[1] + for j, path in connected.items(): + if len(path) == 2 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for b in config.bonds: + match_forward = name_i == b.atom_1 and name_j == b.atom_2 + match_backward = name_i == b.atom_2 and name_j == b.atom_1 + if match_forward or match_backward: + bonds_2.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[j]["local_index"], + b.equilibrium, + b.strength, + ] + ) + + if len(path) == 3 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_mid = bond_graph.nodes()[path[1]]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for a in config.angle_bonds: + match_forward = ( + name_i == a.atom_1 + and name_mid == a.atom_2 + and name_j == a.atom_3 + ) + match_backward = ( + name_i == a.atom_3 + and name_mid == a.atom_2 + and name_j == a.atom_1 + ) + if match_forward or match_backward: + bonds_3.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[path[1]]["local_index"], + bond_graph.nodes()[j]["local_index"], + np.radians(a.equilibrium), + a.strength, + ] + ) + + all_paths_len_four = find_all_paths(bond_graph, i, 3) + for p in all_paths_len_four: + name_i = bond_graph.nodes()[i]["name"] + name_mid_1 = bond_graph.nodes()[p[1]]["name"] + name_mid_2 = bond_graph.nodes()[p[2]]["name"] + name_j = bond_graph.nodes()[p[3]]["name"] + + for a in config.dihedrals: + match_forward = ( + name_i == a.atom_1 + and name_mid_1 == a.atom_2 + and name_mid_2 == a.atom_3 + and name_j == a.atom_4 + ) + if ( + match_forward + and [ + bond_graph.nodes()[p[3]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[i]["local_index"], + a.coeffs, + a.dih_type, + ] + not in bonds_4 + ): + bonds_4.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[3]]["local_index"], + a.coeffs, + a.dih_type, + ] + ) + if a.dih_type == 1: + bb_dihedral = len(bonds_4) + + if bb_dihedral: + bb_index.append(bb_dihedral - 1) + + return bonds_2, bonds_3, bonds_4, bb_index
+ + +
[docs]def prepare_index_based_bonds(molecules, topol): + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + resid = mol + 1 + top_summary = topol["system"]["molecules"] + resname = None + test_mol_number = 0 + for molname in top_summary: + test_mol_number += molname[1] + if resid <= test_mol_number: + resname = molname[0] + break + + if resname is None: + break + + if "bonds" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for bond in topol[resname]["bonds"]: + index_i = bond[0] - 1 + first_id + index_j = bond[1] - 1 + first_id + # bond[2] is the bond type, inherited by the itp format. Not used + equilibrium = bond[3] + strength = bond[4] + bonds_2.append([index_i, index_j, equilibrium, strength]) + + if "angles" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["angles"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + # angle[3] is the angle type, inherited by the itp format. Not used + equilibrium = np.radians(angle[4]) + strength = angle[5] + bonds_3.append([index_i, index_j, index_k, equilibrium, strength]) + + if "dihedrals" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["dihedrals"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + index_l = angle[3] - 1 + first_id + dih_type = angle[4] + coeff = angle[5] + if dih_type == 0 and isinstance(coeff[0], (float, int)): + coeff = propensity_potential_coeffs(coeff[0]) + elif dih_type == 1 and len(coeff) == 3: + coeff = np.array( + propensity_potential_coeffs(coeff[0][0]).tolist() + + coeff[1:] + ) + elif dih_type == 2: + coeff = np.array(coeff) + else: + coeff = np.insert(np.array(coeff), 2, np.zeros((2, 5)), axis=0) + bonds_4.append([index_i, index_j, index_k, index_l, coeff, dih_type, 0]) + return bonds_2, bonds_3, bonds_4
+ + +
[docs]def prepare_bonds(molecules, names, bonds, indices, config, topol=None): + """Rearrange the bond information for usage in compiled Fortran kernels + + Restructures the lists resulting from the execution of + :code:`prepare_bonds_old` into numpy arrays suitable for calls to optimized + Fortran code calculating bonded forces and energiesself. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2_atom_1 : (B,) numpy.ndarray + Local index of particle 1 for each of :code:`B` constructed + two-particle bonds. + bonds_2_atom_2 : (B,) numpy.ndarray + Local index of particle 2 for each of :code:`B` constructed + two-particle bonds. + bonds_2_equilibrium : (B,) numpy.ndarray + Equilibrium distance for each of :code:`B` constructed two-particle + bonds. + bonds_2_strength : (B,) numpy.ndarray + Bond strength for each of :code:`B` constructed two-particle + bonds. + bonds_3_atom_1 : (A,) numpy.ndarray + Local index of particle 1 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_2 : (A,) numpy.ndarray + Local index of particle 2 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_3 : (A,) numpy.ndarray + Local index of particle 3 for each of :code:`A` constructed + three-particle bonds. + bonds_3_equilibrium : (A,) numpy.ndarray + Equilibrium angle for each of :code:`A` constructed three-particle + bonds. + bonds_3_strength : (A,) numpy.ndarray + Bond strength for each of :code:`A` constructed three-particle + bonds. + bonds_4_atom_1 : (D,) numpy.ndarray + Local index of particle 1 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_2 : (D,) numpy.ndarray + Local index of particle 2 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_3 : (D,) numpy.ndarray + Local index of particle 3 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_4 : (D,) numpy.ndarray + Local index of particle 4 for each of :code:`D` constructed + four-particle bonds. + bonds_4_coeff : (D,) numpy.ndarray + Cosine series coefficients for each of :code:`D` constructed + four-particle bonds. + bonds_4_type : (D,) numpy.ndarray + Dihedral type for each of :code:`D` constructed four-particle + bonds. + bonds_4_last : (D,) numpy.ndarray + Flags indicating if :code:`dih_type` is :code:`1` for each of :code:`D` + constructed four-particle bonds. + + See also + -------- + prepare_bonds_old : + Used internally to reconstruct the bonded interactions types from the + connectivity information in the structure/topology input file and the + bonded types specified in the configuration file. + """ + if topol is not None: + bonds_2, bonds_3, bonds_4 = prepare_index_based_bonds( + molecules, topol + ) + else: + bonds_2, bonds_3, bonds_4, bb_index = prepare_bonds_old( + molecules, names, bonds, indices, config + ) + + # Bonds + bonds_2_atom1 = np.empty(len(bonds_2), dtype=int) + bonds_2_atom2 = np.empty(len(bonds_2), dtype=int) + bonds_2_equilibrium = np.empty(len(bonds_2), dtype=np.float64) + bonds_2_strength = np.empty(len(bonds_2), dtype=np.float64) + for i, b in enumerate(bonds_2): + bonds_2_atom1[i] = b[0] + bonds_2_atom2[i] = b[1] + bonds_2_equilibrium[i] = b[2] + bonds_2_strength[i] = b[3] + + # Angles + bonds_3_atom1 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom2 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom3 = np.empty(len(bonds_3), dtype=int) + bonds_3_equilibrium = np.empty(len(bonds_3), dtype=np.float64) + bonds_3_strength = np.empty(len(bonds_3), dtype=np.float64) + for i, b in enumerate(bonds_3): + bonds_3_atom1[i] = b[0] + bonds_3_atom2[i] = b[1] + bonds_3_atom3[i] = b[2] + bonds_3_equilibrium[i] = b[3] + bonds_3_strength[i] = b[4] + # Dihedrals + bonds_4_atom1 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom2 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom3 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom4 = np.empty(len(bonds_4), dtype=int) + number_of_coeff = 6 + len_of_coeff = 5 + bonds_4_coeff = np.empty( + (len(bonds_4), number_of_coeff, len_of_coeff), dtype=np.float64 + ) + bonds_4_type = np.empty(len(bonds_4), dtype=int) + bonds_4_last = np.zeros(len(bonds_4), dtype=int) + for i, b in enumerate(bonds_4): + bonds_4_atom1[i] = b[0] + bonds_4_atom2[i] = b[1] + bonds_4_atom3[i] = b[2] + bonds_4_atom4[i] = b[3] + bonds_4_coeff[i] = np.resize(b[4], (number_of_coeff, len_of_coeff)) + bonds_4_type[i] = b[5] + if topol is not None: + bonds_4_last[i] = b[6] + if topol is None: + bonds_4_last[bb_index] = 1 + + return ( + bonds_2_atom1, + bonds_2_atom2, + bonds_2_equilibrium, + bonds_2_strength, + bonds_3_atom1, + bonds_3_atom2, + bonds_3_atom3, + bonds_3_equilibrium, + bonds_3_strength, # noqa: E501 + bonds_4_atom1, + bonds_4_atom2, + bonds_4_atom3, + bonds_4_atom4, + bonds_4_coeff, + bonds_4_type, + bonds_4_last, # noqa: E501 + )
+ + +
[docs]def compute_bond_forces__plain(f_bonds, r, bonds_2, box_size): + """Computes forces resulting from bonded interactions + + .. deprecated:: 1.0.0 + :code:`compute_bond_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_bonds.fill(0.0) + energy = 0.0 + + for i, j, r0, k in bonds_2: + ri = r[i, :] + rj = r[j, :] + rij = rj - ri + + # Apply periodic boundary conditions to the distance rij + for dim in range(len(rij)): + rij[dim] -= box_size[dim] * np.around(rij[dim] / box_size[dim]) + dr = np.linalg.norm(rij) + df = -k * (dr - r0) + f_bond_vector = df * rij / dr + f_bonds[i, :] -= f_bond_vector + f_bonds[j, :] += f_bond_vector + + energy += 0.5 * k * (dr - r0) ** 2 + return energy
+ + +
[docs]def compute_angle_forces__plain(f_angles, r, bonds_3, box_size): + """Computes forces resulting from angular interactions + + .. deprecated:: 1.0.0 + :code:`compute_angle_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_angles.fill(0.0) + energy = 0.0 + + for a, b, c, theta0, k in bonds_3: + ra = r[a, :] - r[b, :] + rc = r[c, :] - r[b, :] + + for dim in range(len(ra)): + ra[dim] -= box_size[dim] * np.around(ra[dim] / box_size[dim]) + rc[dim] -= box_size[dim] * np.around(rc[dim] / box_size[dim]) + + xra = 1.0 / np.sqrt(np.dot(ra, ra)) + xrc = 1.0 / np.sqrt(np.dot(rc, rc)) + ea = ra * xra + ec = rc * xrc + + cosphi = np.dot(ea, ec) + theta = np.arccos(cosphi) + xsinph = 1.0 / np.sqrt(1.0 - cosphi**2) + + d = theta - theta0 + f = -k * d + + xrasin = xra * xsinph * f + xrcsin = xrc * xsinph * f + + fa = (ea * cosphi - ec) * xrasin + fc = (ec * cosphi - ea) * xrcsin + + f_angles[a, :] += fa + f_angles[c, :] += fc + f_angles[b, :] -= fa + fc + # f_angles[b, :] += -(fa + fc) + + energy -= 0.5 * f * d + + return energy
+ + +
[docs]def compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size): + """Computes forces resulting from dihedral interactions + + .. deprecated:: 1.0.0 + :code:`compute_dihedral_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_dihedrals.fill(0.0) + energy = 0.0 + + for a, b, c, d, coeffs, phase in bonds_4: + f = r[a, :] - r[b, :] + g = r[b, :] - r[c, :] + h = r[d, :] - r[c, :] + + for dim in range(3): + f -= box_size[dim] * np.around(f[dim] / box_size[dim]) + g -= box_size[dim] * np.around(g[dim] / box_size[dim]) + h -= box_size[dim] * np.around(h[dim] / box_size[dim]) + + v = np.cross(f, g) + w = np.cross(h, g) + vv = np.dot(v, v) + ww = np.dot(w, w) + gn = np.linalg.norm(g) + + cosphi = np.dot(v, w) + sinphi = np.dot(np.cross(v, w), g) / gn + phi = np.arctan2(sinphi, cosphi) + + fg = np.dot(f, g) + hg = np.dot(h, g) + sc = v * fg / (vv * gn) - w * hg / (ww * gn) + + df = 0 + + for m in range(len(coeffs[0])): + energy += coeffs[0][m] * (1 + np.cos(m * phi - coeffs[1][m])) + df += m * coeffs[0][m] * np.sin(m * phi - coeffs[1][m]) + + force_on_a = df * gn * v / vv + force_on_d = df * gn * w / ww + + f_dihedrals[a, :] -= force_on_a + f_dihedrals[b, :] += df * sc + force_on_a + f_dihedrals[c, :] -= df * sc + force_on_d + f_dihedrals[d, :] += force_on_d + return energy
+ + +
[docs]def dipole_forces_redistribution( + f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb +): + """Redistribute electrostatic forces calculated from topologically + reconstructed ghost dipole point charges to the backcone atoms of the protein. + """ + f_on_bead.fill(0.0) + for i, j, k, l, fd, matrix, dih_type, is_last in zip( + a, b, c, d, f_dipoles, trans_matrices, type_array, last_bb + ): + if dih_type == 1: + sum_force = fd[0] + fd[1] + diff_force = fd[0] - fd[1] + f_on_bead[i] += matrix[0] @ diff_force # Atom A + f_on_bead[j] += matrix[1] @ diff_force + 0.5 * sum_force # Atom B + f_on_bead[k] += matrix[2] @ diff_force + 0.5 * sum_force # Atom C + + if is_last == 1: + sum_force = fd[2] + fd[3] + diff_force = fd[2] - fd[3] + f_on_bead[j] += matrix[3] @ diff_force + f_on_bead[k] += matrix[4] @ diff_force + 0.5 * sum_force + f_on_bead[l] += matrix[5] @ diff_force + 0.5 * sum_force
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/_modules/hymd/hamiltonian.html b/v1.0.5/_modules/hymd/hamiltonian.html new file mode 100644 index 00000000..4a72bf40 --- /dev/null +++ b/v1.0.5/_modules/hymd/hamiltonian.html @@ -0,0 +1,785 @@ + + + + + + hymd.hamiltonian — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.hamiltonian

+"""Interaction energy functionals.
+
+Implements field--particle interaction energy functionals depending on the
+field configuration. Extending HyMD with a new Hamiltonian is done by
+subclassing the :code:`Hamiltonian` superclass with logic intialized in the
+constructor.
+
+The grid-independent filtering function is defined in the :code:`Hamiltonian`
+superclass constructor. Hijack :code:`self.H` in a subclass to change the
+filter.
+"""
+import numpy as np
+import sympy
+
+
+
[docs]class Hamiltonian: + """Interaction energy functional superclass""" + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + self.config = config + self._setup()
+ +
[docs] def _setup(self): + """Superclass setup + + Sets up the grid-independent filtering function :code:`H`, and the + SymPy logic for symbolically differentiating interaction energy + functionals in Hamiltonian subclasses. + """ + if not hasattr(self.config, "simulation_volume"): + self.config.simulation_volume = np.prod(np.asarray(self.config.box_size)) + if not self.config.barostat: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.config.a = self.config.rho0 + if not self.config.rho0: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.phi = sympy.var("phi:%d" % (self.config.n_types)) + k = sympy.var("k:%d" % (3)) + + # electrostatics variables + self.psi = sympy.var("psi") + self.phi_q = sympy.var("phi_q") + if not self.config.self_energy: + self.config.self_energy = 0.0 + + def fourier_space_window_function(k): + return sympy.functions.elementary.exponential.exp( + -0.5 + * self.config.sigma**2 + * (k0**2 + k1**2 + k2**2) # noqa: F821, E501 + ) + + self.window_function_lambda = sympy.lambdify( + [k], fourier_space_window_function(k) + ) + + def H(k, v): + return v * self.window_function_lambda(k) + + self.H = H
+ + +
[docs]class SquaredPhi(Hamiltonian): + """Simple squared density interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + \\sum_k \\tilde\\phi_k + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`rho_0` is the + average density of the fully homogenous system. Expressing the species + densities in terms of fluctuations from the average, + + .. math:: + + \\mathrm{d}\\tilde\\phi_k = \\rho_0 - \\tilde\\phi_k, + + it is evident that this interaction energy functional is a slight change of + the :code:`DefaultNoChi` Hamiltonian, as the expanded interaction energy + density becomes + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + 6\\rho_0\\left[ + \\sum_k \\mathrm{d}\\tilde\\phi_k + \\right] + + + 9\\rho_0^2 + + + \\sum_k \\mathrm{d}\\tilde\\phi_k^2 + + + \\prod_{k\\not=l} + \\mathrm{d}\\tilde\\phi_k \\mathrm{d}\\tilde\\phi_l + \\right), + + identical to :code:`DefaultNoChi` apart from a constant energy shift + :math:`9\\rho_0^2`(which does not impact dynamics) and the + :math:`\\rho_0`--:math:`\\mathrm{d}\\tilde\\phi_k` cross-terms. These + cross-terms constitute contributions to the energy linear in + :math:`\\mathrm{d}\\tilde\\phi_k` absent in :code:`DefaultNoChi`, which has + only quadratic terms present. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(SquaredPhi, self).__init__(config) + super(SquaredPhi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0): + return 0.5 / (kappa * rho0) * (sum(phi)) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + ): + V_incompressibility = 1 / (kappa * rho0) * sum(phi) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultNoChi(Hamiltonian): + """Incompressibility-only interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. The :code:`SquaredPhi` Hamiltonian implements a similar + functional with an additional linear term component depending on + + .. math:: + + \\mathmr{d}\\tilde\\phi_k = \\tilde\\phi_k - \\rho_0 + + and not :math:`\\mathrm{d}\\tilde\\phi_k^2`. No explicit inter-species + interaction is present apart from the indirect interaction through the + incompressibility. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + hymd.input_parser.Config : + Configuration dataclass handler. + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultNoChi, self).__init__(config) + super(DefaultNoChi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0, a=self.config.a): + return 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultWithChi(Hamiltonian): + """Incompressibility and :math:`\\chi`-interactions energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = + \\frac{1}{2\\rho_0} + \\sum_{k,l}\\chi_{kl} \\tilde\\phi_k \\tilde\\phi_l + + + \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. :math:`\\chi_{ij}` is the Flory-Huggins-like + inter-species mixing energy. + """ + +
[docs] def __init__(self, config, unique_names, type_to_name_map): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultWithChi, self).__init__(config) + super(DefaultWithChi, self)._setup() + self.setup(unique_names, type_to_name_map)
+ +
[docs] def setup(self, unique_names, type_to_name_map): + """Setup the interaction energy potential and the external potential + + Parameters + ---------- + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + """ + self.type_to_name_map = type_to_name_map + self.chi_type_dictionary = { + tuple(sorted([c.atom_1, c.atom_2])): c.interaction_energy + for c in self.config.chi + } + self.phi_laplacian = [ + sympy.var("phi_laplacian%d(0:%d)" % (t, 3)) + for t in range(self.config.n_types) + ] + + def w( + phi, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + interaction = 0.0 + for i in range(self.config.n_types): + for j in range(i + 1, self.config.n_types): + ni = type_to_name_map[i] + nj = type_to_name_map[j] + names = sorted([ni, nj]) + c = chi_type_dictionary[tuple(names)] + + interaction += c * phi[i] * phi[j] / rho0 + incompressibility = 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + return incompressibility + interaction + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + t, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + + V_interaction = 0.0 + nk = type_to_name_map[t] + for i in range(self.config.n_types): + ni = type_to_name_map[i] + names = sorted([nk, ni]) + if ni != nk: + c = chi_type_dictionary[tuple(names)] + else: + c = 0.0 + # uncomment to count diagonal chi terms: + # c = chi_type_dictionary[tuple(names)] + V_interaction += c * phi[i] / rho0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[t])) + for t in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +def get_hamiltonian(config): + """Return appropriate Hamiltonian object based on the + config.hamiltonian string. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ---------- + hamiltonian : Hamiltonian + Hamiltonian object. + """ + if config.hamiltonian.lower() == "defaultnochi": + hamiltonian = DefaultNoChi(config) + elif config.hamiltonian.lower() == "defaultwithchi": + hamiltonian = DefaultWithChi( + config, config.unique_names, config.type_to_name_map + ) + elif config.hamiltonian.lower() == "squaredphi": + hamiltonian = SquaredPhi(config) + + return hamiltonian +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/_modules/hymd/input_parser.html b/v1.0.5/_modules/hymd/input_parser.html new file mode 100644 index 00000000..948dbd19 --- /dev/null +++ b/v1.0.5/_modules/hymd/input_parser.html @@ -0,0 +1,1623 @@ + + + + + + hymd.input_parser — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.input_parser

+"""Parses and handles the configuration information provided for the simulation
+"""
+import copy
+import tomli
+import datetime
+import logging
+import warnings
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass, field
+from typing import List, Union, ClassVar
+from .force import Bond, Angle, Dihedral, Chi, Dielectric_type, propensity_potential_coeffs
+from .barostat import Target_pressure
+from .logger import Logger
+
+
+
[docs]@dataclass +class Config: + """Configuration object + + Handles and verifies the simulation configuration specified in the + configuration file. + + Attributes + ---------- + gas_constant : float + Constant value of the gas constant, R (equivalently the Boltzmann + constant) in the units used internally in HyMD. + coulomb_constant : float + Constant value of the Coulomb constant which converts electric field + values to forces and electric potential values to energies in the units + used internally in HyMD. + n_steps: int + Number of time steps in the simulation. + time_step: float + *Outer* time step used in the simulation. If the rRESPA intergrator is + used, the *inner* time step (the time step used in the integration of + intramolecular bending, stretching, and torsional forces) is + :code:`time_step / respa_inner`. + box_size : list[float] or (D,) numpy.ndarray + Simulation box size of simulation in :code:`D` dimensions in units of + nanometers. + mesh_size : list[int] or int or numpy.ndarray + Number of grid points used for the discrete density grid. + sigma : float + Filter width representing the effective coarse-graining level of the + particles in the simulation. + kappa : float + Compressibility parameter used in the relaxed incompressibility term in + the interaction energy functional. + n_print : int, optional + Frequency of trajectory/energy output to the H5MD trajectory/energy + output file (in units of number of time steps). + tau : float, optional + The time scale of the CSVR thermostat coupling. + start_temperature : float, optional + Generate starting temperature by assigning all particle velocities + randomly according to the Maxwell-Boltzmann distribution at + :code:`start_temperature` Kelvin prior to starting the simulation. + target_temperature : float, optional + Couple the system to a heat bath at :code:`target_temperature` Kelvin. + mass : float, optional + Mass of the particles in the simulation. + hamiltonian : str, optional + Specifies the interaction energy functional :math:`W[\\tilde\\phi]` + for use with the particle-field interactions. Options: + :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`. + domain_decomposition : int, optional + Specifies the interval (in time steps) of domain decomposition + exchange, involving all MPI ranks sending and receiving particles + according to the particles’ positions in the integration box and the + MPI ranks’ assigned domain. + integrator : str, optional + Specifies the time integrator used in the simulation. Options: + :code:`velocity-verlet` or :code:`respa`. + respa_inner : int, optional + The number of inner time steps in the rRESPA integrator. This denotes + the number of intramolecular force calculations (stretching, bending, + torsional) are performed between each impulse applied from the field + forces. + file_name : str, optional + File path of the parsed configuration file. + name : str, optional + Name for the simulation. + tags : list[str], optional + Tags for the simulation. + bonds : list[Bond], optional + Specifies harmonic stretching potentials between particles in the + same molecule. + angle_bonds : list[Angle], optional + Specifies harmonic angular bending potentials between particles in the + same molecule. + dihedrals : list[Dihedral], optional + Specifies four-particle torsional potentials by cosine series. + chi : list[Chi], optional + Specifies :math:`\\chi`-interaction parameters between particle + species. + n_particles : int, optional + Specifies the total number of particles in the input. Optional keyword + for validation, ensuring the input HDF5 topology has the correct number + of particles and molecules. + max_molecule_size : int, optional + Maximum size of any single molecule in the system. Used to speed up + distribution of particles onto MPI ranks in a parallel fashion. + n_flush : int, optional + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be + written to disk (in units of number of :code:`n_print`). + thermostat_work : float + Work performed by the thermostat on the system. + thermostat_coupling_groups : list[str], optional + Specifies individual groups coupling independently to the CSVR + thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and + :code:`"C"` type particles, + :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would + thermalise types :code:`"A"` and :code:`"B"` together and couple + :code:`"C"` type particles to a different thermostat (all individual + thermostats are at the same temperature, i.e. target_temperature + Kelvin). + initial_energy : float + Value of the total energy prior to the start of the simulation. + cancel_com_momentum : int, optional + If :code:`True`, the total linear momentum of the center of mass is + removed before starting the simulation. If an integer is specifed, the + total linear momentum of the center of mass is removed every + :code:`remove_com_momentum` time steps. If :code:`False`, the linear + momentum is never removed. + coulombtype : str, optional + Specifies the type of electrostatic Coulomb interactions in the system. + The strength of the electrostatic forces is modulated by the relative + dielectric constant of the simulation medium, specified with the + :code:`dielectric_const` keyword. Charges for individual particles are + specified in the structure/topology HDF5 input file, not in the + configuration file. If no charges (or peptide backbone dipoles) are + present, the electrostatic forces will not be calculated even if this + keyword is set to :code:`"PIC_Spectral"`. + dielectric_const : float, optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. When + using helical propensity dihedrals, this keyword must be specified—even + if electrostatics are not included with the :code:`coulombtype` + keyword. + dielectric_type: list[float], optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. The list assigns + relative dielectric values to each bead type, and an anisotropic + dielectric function is obtained from a weighted average. + + + See also + -------- + hymd.input_parser.Bond : + Two-particle bond type dataclass. + hymd.input_parser.Angle : + Three-particle bond type dataclass. + hymd.input_parser.Dihedral : + Four-particle bond type dataclass. + """ + + gas_constant: ClassVar[float] = 0.0083144621 # kJ mol-1 K-1 + coulomb_constant: ClassVar[float] = 138.935458 # kJ nm mol-1 e-2 + + n_steps: int + time_step: float + mesh_size: Union[Union[List[int], np.ndarray], int] + sigma: float + kappa: float + + dtype: np.dtype = None + box_size: Union[List[float], np.ndarray] = None + n_print: int = None + tau: float = None + start_temperature: Union[float, bool] = None + target_temperature: Union[float, bool] = None + mass: float = None + hamiltonian: str = None + domain_decomposition: Union[int, bool] = None + integrator: str = None + respa_inner: int = 1 + file_name: str = "<config file path unknown>" + name: str = None + tags: List[str] = field(default_factory=list) + bonds: List[Bond] = field(default_factory=list) + angle_bonds: List[Angle] = field(default_factory=list) + dihedrals: List[Dihedral] = field(default_factory=list) + chi: List[Chi] = field(default_factory=list) + n_particles: int = None + max_molecule_size: int = None + n_flush: int = None + thermostat_work: float = 0.0 + thermostat_coupling_groups: List[List[str]] = field(default_factory=list) + initial_energy: float = None + cancel_com_momentum: Union[int, bool] = False + coulombtype: str = None + convergence_type: str = None + pol_mixing: float = None + dielectric_const: float = None + conv_crit: float = None + dielectric_type: List[Dielectric_type] = field(default_factory=list) + self_energy: float = None + type_charges: Union[List[float], np.ndarray] = None + + # For NPT runs + rho0: float = None + a: float = None + pressure: bool = False + barostat: str = None + barostat_type: str = None + tau_p: float = None + target_pressure: List[Target_pressure] = field(default_factory=list) + n_b: int = None + m: List[float] = field(default_factory=list) + + def __str__(self): + target_pressure_str = "\ttarget_pressure:\n" + "".join( + "\t\tP_L: " + + f"{self.target_pressure.P_L}\n" + + "\t\tP_N: " + + f"{self.target_pressure.P_N}\n" + ) + bonds_str = "\tbonds:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " f"{k.equilibrium}, {k.strength}\n") + for k in self.bonds + ] + ) + angle_str = "\tangle_bonds:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3}: " + + f"{k.equilibrium}, {k.strength}\n" + ) + for k in self.angle_bonds + ] + ) + dihedrals_str = "\tdihedrals:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: " + # This might need to be fixed/made prettier, probably + # there's an easier way + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ).join( + map( + str, + [ + [round(num, 3) for num in c_in] + if isinstance(c_in, list) + else c_in + for c_in in k.coeffs + ], + ) + ) + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ) + + f"dih_type = {k.dih_type}\n" + ) + for k in self.dihedrals + ] + ) + chi_str = "\tchi:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " + f"{k.interaction_energy}\n") + for k in self.chi + ] + ) + + """ If dielectric wanted as dictionary + dielectric_type_str = "\tdielectric_type:\n" + "".join( + [ + (f"\t\t{k.atom_1}: " + f"{k.dielectric_value}\n") + for k in self.dielectric_type + ] + ) + + """ + + thermostat_coupling_groups_str = "" + if any(self.thermostat_coupling_groups): + thermostat_coupling_groups_str = ( + "\tthermostat_coupling_groups:\n" + + "".join( + [ + "\t\t" + ", ".join([f"{n}" for n in ng]) + "\n" + for ng in self.thermostat_coupling_groups + ] + ) + ) + + ret_str = f'\n\n\tConfig: {self.file_name}\n\t{50 * "-"}\n' + for k, v in self.__dict__.items(): + if k not in ( + "target_pressure", + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "thermostat_coupling_groups", + ): + ret_str += f"\t{k}: {v}\n" + ret_str += ( + target_pressure_str + + bonds_str + + angle_str + + dihedrals_str + + chi_str + + thermostat_coupling_groups_str + ) + return ret_str
+ + +
[docs]def read_config_toml(file_path): + with open(file_path, "r") as in_file: + file_content = in_file.read() + return file_content
+ +
[docs]def parse_config_toml(toml_content, file_path=None, comm=MPI.COMM_WORLD): + config_dict = {} + + # read toml to a dictionary + toml_content = tomli.loads(toml_content) + + # Defaults = None + for n in ( + "box_size", + "n_print", + "tau", + "start_temperature", + "target_temperature", + "mass", + "hamiltonian", + "domain_decomposition", + "integrator", + "name", + "n_particles", + "max_molecule_size", + "coulombtype", + "convergence_type", + "dielectric_const", + "pol_mixing", + "conv_crit", + "dielectric_type", + "n_b", + "box_size", + "n_flush", + "self_energy", + "dtype", + ): + config_dict[n] = None + + # Defaults = [] + + for n in ( + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "tags", + "m", + "dielectric_type", + "target_pressure", + "type_charges", + ): + config_dict[n] = [] + + # Defaults: bool + config_dict["pressure"] = False + + # Flatten the .toml dictionary, ignoring the top level [tag] directives (if + # any). + for k, v in toml_content.items(): + if isinstance(v, dict): + if k == "nn": # Don't parse diff-hymd optimization options + continue + for nested_k, nested_v in v.items(): + config_dict[nested_k] = nested_v + else: + config_dict[k] = v + for k, v in config_dict.items(): + if k == "bonds": + config_dict["bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["bonds"][i] = Bond( + atom_1=b[0], + atom_2=b[1], + equilibrium=b[2], + strength=b[3], + ) + if k == "angle_bonds": + config_dict["angle_bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["angle_bonds"][i] = Angle( + atom_1=b[0], + atom_2=b[1], + atom_3=b[2], + equilibrium=b[3], + strength=b[4], + ) + if k == "dihedrals": + config_dict["dihedrals"] = [None] * len(v) + for i, b in enumerate(v): + try: + dih_type = int(b[2][0]) + except IndexError: + Logger.rank0.log( + logging.WARNING, "Dihedral type not provided, defaulting to 0." + ) + dih_type = 0 + + # Probably it's better to move this in check_dihedrals? + wrong_len = len(b[1]) not in (1, 2) + wrong_type_1 = len(b[1]) == 1 and not isinstance(b[1][0], float) + wrong_type_2 = len(b[1]) == 2 and not isinstance(b[1][0], list) + if wrong_len or wrong_type_1 or wrong_type_2: + err_str = ( + "The coefficients specified for the dihedral type " + "(0) do not match the correct structure. Either " + "use [lambda] or [[cn_prop], [dn_prop]], or select" + " the correct dihedral type." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise RuntimeError(err_str) + + # FIXME: this is messy af, I don't like it + if dih_type == 0 and isinstance(b[1][0], (float, int)): + coeff = propensity_potential_coeffs(b[1][0]) + elif dih_type == 1 and len(b[1]) == 3: + coeff = np.array( + propensity_potential_coeffs(b[1][0][0]).tolist() + + b[1][1:] + ) + elif dih_type == 2: + coeff = np.array(b[1]) + else: + coeff = np.insert(np.array(b[1]), 2, np.zeros((2, 5)), axis=0) + + config_dict["dihedrals"][i] = Dihedral( + atom_1=b[0][0], + atom_2=b[0][1], + atom_3=b[0][2], + atom_4=b[0][3], + coeffs=coeff, + dih_type=dih_type, + ) + if k == "chi": + config_dict["chi"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0], c[1]]) + config_dict["chi"][i] = Chi( + atom_1=c_[0], atom_2=c_[1], interaction_energy=c[2] + ) + + """ + if k == "dielectric_type": + config_dict["dielectric_type"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0][0]]) + config_dict["dielectric_type"][i] = Dielectric_type( + atom_1=c_[0], dielectric_value=c[1][0] + ) + """ + if k == "target_pressure": + if len(v) == 2: + config_dict["target_pressure"] = Target_pressure( + P_L=v[0], + P_N=v[1], # check condition # V array (still read as array?) + ) + elif len(v) == 1: + config_dict["target_pressure"] = Target_pressure(P_L=v[0], P_N=None) + else: + config_dict["target_pressure"] = Target_pressure(P_L=None, P_N=None) + + if file_path is not None: + config_dict["file_name"] = file_path + + for n in ( + "n_steps", "time_step", "mesh_size", "sigma", "kappa" + ): + if n not in config_dict: + err_str = ( + f"No {n} specified in config file {file_path}. Unable to start" + f" simulation." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return Config(**config_dict)
+ + +
[docs]def check_n_particles(config, indices, comm=MPI.COMM_WORLD): + n_particles = comm.allreduce(len(indices), MPI.SUM) + if config.n_particles is None: + config = copy.deepcopy(config) + config.n_particles = n_particles + info_str = ( + f"No n_particles found in toml file {config.file_name}, defaulting" + f" to indices.shape ({n_particles})" + ) + Logger.rank0.log(logging.INFO, info_str) + return config + + if n_particles != config.n_particles: + warn_str = ( + f"n_particles in {config.file_name} ({config.n_particles}) does " + "not match the shape of the indices array in the .HDF5 file " + f"({n_particles}). Defaulting to using indices.shape " + f"({n_particles})" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.n_particles = n_particles + return config
+ + +
[docs]def check_max_molecule_size(config, comm=MPI.COMM_WORLD): + if config.max_molecule_size is None: + info_str = ( + f"No max_molecule_size found in toml file {config.file_name}, " + f"defaulting to 201" + ) + Logger.rank0.log(logging.INFO, info_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + + if config.max_molecule_size < 1: + warn_str = ( + f"max_molecule_size in {config.file_name} must be a positive " + f"integer, not {config.max_molecule_size}, defaulting to 201" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + return config
+ + +def _find_unique_names(config, names, comm=MPI.COMM_WORLD): + unique_names = np.unique(names) + receive_buffer = comm.gather(unique_names, root=0) + + gathered_unique_names = None + if comm.Get_rank() == 0: + gathered_unique_names = np.unique(np.concatenate(receive_buffer)) + unique_names = comm.bcast(gathered_unique_names, root=0) + unique_names = sorted([n.decode("UTF-8") for n in unique_names]) + config.unique_names = unique_names + config.n_types = len(unique_names) + return config + + +def _setup_type_to_name_map(config, names, types, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + name_to_type_ = {} + for n, t in zip(names, types): + n = n.decode("utf-8") + if n not in name_to_type_: + name_to_type_[n] = t + receive_buffer = comm.gather(name_to_type_, root=0) + gathered_dict = None + if comm.Get_rank() == 0: + gathered_dict = {} + for d in receive_buffer: + for k, v in d.items(): + if k not in gathered_dict: + gathered_dict[k] = v + else: + assert v == gathered_dict[k] + name_to_type_map = comm.bcast(gathered_dict, root=0) + config.name_to_type_map = name_to_type_map + config.type_to_name_map = {v: k for k, v in name_to_type_map.items()} + return config + + +
[docs]def check_bonds(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for b in config.bonds: + if b.atom_1 not in unique_names or b.atom_2 not in unique_names: + missing_str = "" + if b.atom_1 not in unique_names: + if b.atom_2 not in unique_names: + if b.atom_1 == b.atom_2: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"neither {b.atom_1}, {b.atom_2} atoms" + else: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"no {b.atom_2} atoms" + + warn_str = ( + f"Bond type {b.atom_1}--{b.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_angles(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for a in config.angle_bonds: + if ( + a.atom_1 not in unique_names + or a.atom_2 not in unique_names + or a.atom_3 not in unique_names + ): + missing = [ + a.atom_1 not in unique_names, + a.atom_2 not in unique_names, + a.atom_3 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([a.atom_1, a.atom_2, a.atom_3]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Angle bond type {a.atom_1}--{a.atom_2}--{a.atom_3} " + f"specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_dihedrals(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for d in config.dihedrals: + if ( + d.atom_1 not in unique_names + or d.atom_2 not in unique_names + or d.atom_3 not in unique_names + or d.atom_4 not in unique_names + ): + missing = [ + d.atom_1 not in unique_names, + d.atom_2 not in unique_names, + d.atom_3 not in unique_names, + d.atom_4 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([d.atom_1, d.atom_2, d.atom_3, d.atom_4]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Dihedral type {d.atom_1}--{d.atom_2}--{d.atom_3}--{d.atom_4}" + f" specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_chi(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for c in config.chi: + if c.atom_1 not in unique_names or c.atom_2 not in unique_names: + missing_str = "" + if c.atom_1 not in unique_names: + if c.atom_2 not in unique_names: + if c.atom_1 == c.atom_2: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"neither {c.atom_1}, {c.atom_2} atoms" + else: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"no {c.atom_2} atoms" + + warn_str = ( + f"Chi interaction {c.atom_1}--{c.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + for i, n in enumerate(unique_names): + for m in unique_names[i + 1 :]: + found = False + for c in config.chi: + if (c.atom_1 == n and c.atom_2 == m) or ( + c.atom_1 == m and c.atom_2 == n + ): + found = True + if not found: + config.chi.append(Chi(atom_1=n, atom_2=m, interaction_energy=0.0)) + warn_str = ( + f"Atom types {n} and {m} found in the " + f"system, but no chi interaction {n}--{m} " + f"specified in {config.file_name}. Defaulting to " + f"chi[{n}, {m}] = 0" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_box_size(config, input_box, comm=MPI.COMM_WORLD): + if config.box_size is not None: + config.box_size = np.array(config.box_size, dtype=np.float32) + if input_box.all() and not np.allclose(config.box_size, input_box, atol=0.009): + err_str = ( + f"Box size specified in {config.file_name}: " + f"{config.box_size} does not match input box:" + f"{input_box}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + else: + if input_box.all(): + config.box_size = input_box + else: + err_str = f"No box information found" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + for b in config.box_size: + if b <= 0.0: + err_str = ( + f"Invalid box size specified in {config.file_name}: " + f"{config.box_size}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return config
+ + +
[docs]def check_integrator(config, comm=MPI.COMM_WORLD): + if config.integrator.lower() not in ("velocity-verlet", "respa"): + err_str = ( + f"Invalid integrator specified in {config.file_name}: " + f'{config.integrator}. Available options "velocity-verlet" or ' + f'"respa".' + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + if config.integrator.lower() == "respa": + if isinstance(config.respa_inner, float): + warn_str = ( + f"Number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner} specified " + f"as float, using {int(config.respa_inner)}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = int(config.respa_inner) + elif not isinstance(config.respa_inner, int): + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + + if config.respa_inner <= 0: + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + if config.integrator.lower() == "velocity-verlet" and config.respa_inner != 1: + warn_str = ( + f"Integrator type Velocity-Verlet specified in {config.file_name} " + f"and inner rRESPA time steps set to {config.respa_inner}. " + f"Using respa_inner = 1" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = 1 + + return config
+ + +
[docs]def check_hamiltonian(config, comm=MPI.COMM_WORLD): + valid_hamiltonians = ["defaultnochi", "defaultwithchi", "squaredphi"] + + if config.hamiltonian is None: + if len(config.chi) == 0: + warn_str = ( + f"No hamiltonian form and no chi interactions specified in " + f"{config.file_name}, defaulting to DefaultNoChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultNoChi" + else: + warn_str = ( + f"No hamiltonian form specified in {config.file_name}, but " + f"chi interactions are specified, defaulting to " + f"DefaultWithChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultWithChi" + elif config.hamiltonian.lower() not in valid_hamiltonians: + err_str = ( + f"The specified Hamiltonian {config.hamiltonian} was not " + f"recognized as a valid Hamiltonian." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise NotImplementedError(err_str) + + return config
+ + +
[docs]def check_n_flush(config, comm=MPI.COMM_WORLD): + if config.n_print: + if config.n_flush is None: + config.n_flush = 10000 // config.n_print + return config
+ + +
[docs]def check_n_print(config, comm=MPI.COMM_WORLD): + if ( + not isinstance(config.n_print, int) + and not isinstance(config.n_print, float) + and config.n_print is not None + ): + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if config.n_print is None or config.n_print <= 0: + config.n_print = False + elif not isinstance(config.n_print, int): + if isinstance(config.n_print, float): + warn_str = ( + f"n_print is a float ({config.n_print}), not int, using " + f"{int(round(config.n_print))}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + config.n_print = int(round(config.n_print)) + else: + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + return config
+ + +
[docs]def check_tau(config, comm=MPI.COMM_WORLD): + if config.tau is None and config.target_temperature is not None: + warn_str = "target temp specified but no tau, defaulting 0.7" + config.tau = 0.7 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_start_and_target_temperature(config, comm=MPI.COMM_WORLD): + """Validate provided starting and target thermostat temperatures + + Assesses the provided temperature target and ensures it is a non-negative + floating point number or :code:`False`. Ensures the starting temperature is + a non-negative floating point number or :code:`False`. + + If the value for either is :code:`None`, the returned configuration object + has the values defaulted to :code:`False` in each case. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ------- + validated_config : Config + Configuration object with validated :code:`target_temperature` and + :code:`start_temperature`. + """ + for t in ("start_temperature", "target_temperature"): + if getattr(config, t) is not None: + try: + if getattr(config, t) < 0: + warn_str = ( + f"{t} set to negative value ({getattr(config, t)}), " + f"defaulting to False" + ) + setattr(config, t, False) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + except TypeError as e: + err_str = ( + f"Could not interpret {t} = {repr(getattr(config, t))} as " + f"a number." + ) + raise TypeError(err_str) from e + + if config.start_temperature is None: + config.start_temperature = False + if config.target_temperature is None: + config.target_temperature = False + return config
+ + +
[docs]def check_mass(config, comm=MPI.COMM_WORLD): + if config.mass is None: + info_str = "no mass specified, defaulting to 72.0" + config.mass = 72.0 + Logger.rank0.log(logging.INFO, info_str) + elif not isinstance(config.mass, int) and not isinstance(config.mass, float): + err_str = ( + f"specified mass is invalid type {config.mass}, " f"({type(config.mass)})" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + elif config.mass < 0: + err_str = f"invalid mass specified, {config.mass}" + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + else: + config.mass = float(config.mass) + + return config
+ + +
[docs]def check_domain_decomposition(config, comm=MPI.COMM_WORLD): + dd = config.domain_decomposition + if dd is None or dd is False: + config.domain_decomposition = False + return config + + if isinstance(dd, int): + if dd < 0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + elif isinstance(dd, float): + if dd < 0.0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + else: + warn_str = ( + f"domain_decomposition ({config.domain_decomposition}) is not " + f"an integer, using {int(round(dd))}" + ) + config.domain_decomposition = int(round(dd)) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + else: + err_str = ( + f"invalid value for domain_decomposition " + f"({config.domain_decomposition}) use an integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + return config
+ + +
[docs]def check_name(config, comm=MPI.COMM_WORLD): + if config.name is None: + root_current_time = "" + if comm.Get_rank() == 0: + root_current_time = datetime.datetime.now().strftime("%m/%d/%Y, %H:%M:%S") + current_time = comm.bcast(root_current_time, root=0) + + if config.name is None: + config.name = "sim" + current_time + else: + config.name = str(config.name) + return config
+ + +
[docs]def check_NPT_conditions(config, comm=MPI.COMM_WORLD): + """ + Check validity of barostat_type, barostat, + a, rho0, target_pressure, tau_p + """ + if config.barostat is None: + if ( + config.tau_p is not None + or (config.target_pressure.P_L and config.target_pressure.P_N) is not None + ): + err_str = ( + "barostat not specified but config.tau_p " + "or config.target_pressure specified, cannot start simulation {config.barostat}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.a: + warn_str = "a specified but no barostat," "setting a to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.rho0: + warn_str = ( + "rho0 specified but no barostat," "setting rho0 to average density" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + if config.barostat is not None: + if not config.barostat_type: + config.barostat_type = "berendsen" + warn_str = "barostat_type not specified," "setting to berendsen" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.barostat != "isotropic" and config.barostat != "semiisotropic": + err_str = "barostat option not recognised. Valid options: isotropic, semiisotropic" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.target_pressure.P_L is None: + config.target_pressure.P_L = 1.0 # bar + config.target_pressure.P_N = None + if config.barostat == "semiisotropic": + config.target_pressure.P_N = 1.0 # bar + warn_str = ( + "barostat specified but no target_pressure, defaulting to 1.0 bar" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.tau_p is None: + if config.tau <= 0.1: + config.tau_p = config.tau * 10.0 + else: + config.tau_p = 1.0 + warn_str = "barostat specified but no tau_p, defaulting to " + str( + config.tau_p + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if not config.a: + err_str = "a not specified; cannot start simulation {config.a}" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if not config.rho0: + warn_str = "rho0 not specified;" "setting rho0 to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + return config
+ + +
[docs]def check_thermostat_coupling_groups(config, comm=MPI.COMM_WORLD): + if any(config.thermostat_coupling_groups): + found = [0 for _ in config.unique_names] + unique_names = [n for n in config.unique_names] + for i, group in enumerate(config.thermostat_coupling_groups): + for species in group: + try: + ind = unique_names.index(species) + found[ind] += 1 + except ValueError as e: + err_str = ( + f"Particle species {species} specified in thermostat " + f"coupling group {i}, but no {species} particles were " + "found in the system." + ) + raise ValueError(err_str) from e + if any([True if f > 1 else False for f in found]): + for i, f in enumerate(found): + if f > 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} specified in multiple " + "thermostat coupling groups; " + f"{config.thermostat_coupling_groups}." + ) + raise ValueError(err_str) + if not all([True if f == 1 else False for f in found]): + for i, f in enumerate(found): + if f != 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} not specified in any " + f"thermostat coupling group, but {species} particles " + "were found in the system" + ) + raise ValueError(err_str) + return config
+ + +
[docs]def check_m(config, comm=MPI.COMM_WORLD): + if config.m == []: + config.m = [1.0 for t in range(config.n_types)] + return config
+ + +
[docs]def check_n_b(config, comm=MPI.COMM_WORLD): + if config.n_b is None: + warn_str = f"config.n_b not specified." "Defaulting to 1" + config.n_b = 1 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_cancel_com_momentum(config, comm=MPI.COMM_WORLD): + if isinstance(config.cancel_com_momentum, int): + if config.cancel_com_momentum == 0 or config.cancel_com_momentum < 0: + config.cancel_com_momentum = False + elif not isinstance(config.cancel_com_momentum, bool): + err_str = ( + f"Could not interpret {config.cancel_com_momentum} as an integer " + f"or boolean." + ) + raise ValueError(err_str) + return config
+ + +
[docs]def sort_dielectric_by_type_id(config, charges, types): + """ + Creates a list of length N CG-particles, sorted after the charges from + the input HDF5 file. Used in file_io.py + """ + dielectric_val = np.zeros(config.n_types) + for j in range(config.n_types): + name = config.dielectric_type[j][0][0] + type_id = config.name_to_type_map[name] + dielectric_val[type_id] = config.dielectric_type[j][1][0] + config.dielectric_type = dielectric_val.copy() + + N = len(charges) + len_list = np.zeros(config.n_types) + dielectric_by_types = np.zeros(N) + for i in range(N): + dielectric_by_types[i] = dielectric_val[types[i]] + # print("types ", types) + # print("diel val", dielectric_by_types) + # print("charges", charges) + # print(config.name_to_type_map) + return dielectric_by_types # by types with each particle id
+ + +
[docs]def check_charges_types_list(config, types, charges, comm=MPI.COMM_WORLD): + """ + Creates a list of charge values of length types. + Charges are sorted according to type ID. Used in field.py. + # TODO: this is messy, we should fix it + """ + if charges is None: + config.type_charges = [0.0] * config.n_types + return config + + check_val = -100.0 # some random value that will never be encountered + charges_list = np.full(config.n_types, check_val) # gatherv cant handle None + rank = comm.Get_rank() + # print(charges_list) + for t_ in range(config.n_types): + if t_ in types: + charges_list[t_] = charges[types == t_][0] + + nprocs = int(comm.Get_size()) + recv_charges = None + if rank == 0: + recv_charges = np.full( + config.n_types * nprocs, check_val + ) # gatherv cant handle None + comm.Gather(charges_list, recv_charges, root=0) + + ## make a charges list + if rank == 0: + config_charges = np.zeros(config.n_types) + test_config = np.full(config.n_types, check_val) + for j in range(nprocs): + for i in range(config.n_types): + if recv_charges[i + j * config.n_types] != check_val: + config_charges[i] = recv_charges[i + j * config.n_types] + if np.any([test_config, config_charges]): + continue + else: + break + + # print(config_charges) + # print(config.name_to_type_map) + # print(charges[types == 0][0],charges[types == 1][0],charges[types == 2][0],charges[types == 3][0], + # charges[types == 4][0]) + else: + config_charges = np.zeros(config.n_types) + + comm.Bcast(config_charges, root=0) + # print("config_charges", config_charges , "rank", rank) + # print(recv_charges) + # rank = comm.Get_rank() + # print(all_charges) + config.type_charges = config_charges + return config
+ + +
[docs]def check_dielectric(config, comm=MPI.COMM_WORLD): + """ + Error handling for electrostatics. + Unit testing of toml/tomli input. + """ + err_str_const = "Dielectric constant not given." + if config.coulombtype == "PIC_Spectral": + assert config.dielectric_const != None, err_str_const + + err_str = "Dielectric list is empty." + if config.coulombtype == "PIC_Spectral_GPE": + assert len(config.dielectric_type) != 0, err_str + # default values + if config.pol_mixing is None: + config.pol_mixing = 0.6 + if config.conv_crit is None: + config.conv_crit = 1e-6 + return config
+ + +
[docs]def check_charges(config, charges, comm=MPI.COMM_WORLD): + """Check if charges across ranks sum to zero. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of floats with charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + """ + total_charge = comm.allreduce(np.sum(charges), MPI.SUM) + + if not np.isclose(total_charge, 0.0): + warn_str = ( + f"Charges in the input file do not sum to zero. " + f"Total charge is {total_charge}." + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + # if charges are ok, compute self energy + if config.coulombtype == "PIC_Spectral": + from .field import compute_self_energy_q + + config.self_energy = compute_self_energy_q(config, charges, comm=comm) + + return config
+ + +
[docs]def check_config( + config, indices, names, types, charges, input_box, comm=MPI.COMM_WORLD +): + """Performs various checks on the specfied config to ensure consistency + + Parameters + ---------- + config : Config + Configuration object. + indices : (N,) numpy.ndarray + Array of integer indices for :code:`N` particles. + names : (N,) numpy.ndarray + Array of string names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of integer type indices for :code:`N` particles. + charges : (N,) numpy.ndarray + Array of floats charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + + Returns + ------- + config : Config + Validated configuration object. + """ + config = _find_unique_names(config, names, comm=comm) + if types is not None: + config = _setup_type_to_name_map(config, names, types, comm=comm) + config = check_box_size(config, input_box, comm=comm) + config = check_integrator(config, comm=comm) + config = check_max_molecule_size(config, comm=comm) + config = check_tau(config, comm=comm) + config = check_start_and_target_temperature(config, comm=comm) + config = check_mass(config, comm=comm) + config = check_domain_decomposition(config, comm=comm) + config = check_name(config, comm=comm) + config = check_n_particles(config, indices, comm=comm) + config = check_chi(config, names, comm=comm) + config = check_bonds(config, names, comm=comm) + config = check_angles(config, names, comm=comm) + config = check_dihedrals(config, names, comm=comm) + config = check_hamiltonian(config, comm=comm) + config = check_NPT_conditions(config, comm=comm) + config = check_n_b(config, comm=comm) + config = check_m(config, comm=comm) + config = check_thermostat_coupling_groups(config, comm=comm) + config = check_cancel_com_momentum(config, comm=comm) + config = check_dielectric(config, comm=comm) + config = check_n_print(config, comm=comm) + config = check_n_flush(config, comm=comm) + config = check_charges_types_list(config, types, charges, comm=comm) + if charges is not None: + config = check_charges(config, charges, comm=comm) + + return config
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/_modules/hymd/integrator.html b/v1.0.5/_modules/hymd/integrator.html new file mode 100644 index 00000000..309dc1dd --- /dev/null +++ b/v1.0.5/_modules/hymd/integrator.html @@ -0,0 +1,346 @@ + + + + + + hymd.integrator — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.integrator

+"""Integrates equations of motion.
+
+Implements the Velocity Verlet integrator. The *reversible reference system
+propagator algorithm* (rRESPA) integrator uses the Velocity Verlet functions
+inside the MD loop in the main module.
+"""
+
+
+
[docs]def integrate_velocity(velocities, accelerations, time_step): + """Velocity update step of the Velocity Verlet integration algorithm. + + Computes the velocity update step of the Velocity Verlet algorithm. The + :code:`velocities` argument is **not** changed in place. + + Parameters + ---------- + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + accelerations : (N, D) numpy.ndarray + Array of accelerations of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step + + .. math:: \\mathbf{v}_{\\text{new}} = \\mathbf{v} + \\frac{\\Delta t}{2m} + \\mathbf{f} + + before the positions are moved a full step using the updated half-step + velocities. + + See Also + -------- + integrate_position : The position update step of the Velocity Verlet + algorithm. + """ + return velocities + 0.5 * time_step * accelerations
+ + +
[docs]def integrate_position(positions, velocities, time_step): + """Position update step of the Velocity Verlet integration algorithm. + + Computes the position update step of the Velocity Verlet algorithm. The + :code:`positions` argument is **not** changed in place. + + Parameters + ---------- + positions : (N, D) numpy.ndarray + Array of positions of :code:`N` particles in :code:`D` dimensions. + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step, then the positions are updated a full step using the updated + velocities + + .. math:: \\mathbf{x}_{\\text{new}} = \\mathbf{x} + \\Delta t \\mathbf{v} + + See Also + -------- + integrate_velocity : The velocity update step of the Velocity Verlet + algorithm. + """ + return positions + time_step * velocities
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/_modules/hymd/logger.html b/v1.0.5/_modules/hymd/logger.html new file mode 100644 index 00000000..bee8f0c0 --- /dev/null +++ b/v1.0.5/_modules/hymd/logger.html @@ -0,0 +1,535 @@ + + + + + + hymd.logger — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.logger

+"""Handles event logging for simulation information, warnings, and errors.
+"""
+import sys
+import os
+import logging
+from mpi4py import MPI
+from .version import __version__
+
+
+
[docs]class MPIFilterRoot(logging.Filter): + """Log output Filter wrapper class for the root MPI rank log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + if self.comm.Get_rank() == 0: + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True + else: + return False
+ + +
[docs]class MPIFilterAll(logging.Filter): + """Log output Filter wrapper class for the all-MPI-ranks log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True
+ + +class MPIFilterStdout(logging.Filter): + """Log output Filter wrapper class for filtering STDOUT log""" + + def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.funcName = "replica 0 " + record.funcName + if MPI.COMM_WORLD.Get_rank() == 0: + record.rank = MPI.COMM_WORLD.Get_rank() + record.size = MPI.COMM_WORLD.Get_size() + return True + else: + return False + + +
[docs]class Logger: + """Log output handler class + + Notes + ----- + This wraps the default python library :code:`logging`, see + `docs.python.org/3/library/logging.html`_. + + .. _`docs.python.org/3/library/logging.html`: + https://docs.python.org/3/library/logging.html + + Attributes + ---------- + level : int + Determines the verbosity level of the log, corresponding to + logging.level. Numerical values :code:`50` (:code:`logging.CRITICAL`), + :code:`40` (:code:`logging.ERROR`), :code:`30` + (:code:`logging.WARNING`), :code:`20` (:code:`logging.INFO`), + :code:`10` (:code:`logging.DEBUG`), and :code:`0` + (:code:`logging.UNSET`) are supported values. Any log event message + less severe than the specified level is ignored. All other event + messages are emitted. + log_file : str + Path to output log file. + format : str + Prepended dump string for each log event. Specifies the log event + level, the module emitting the event, the code line, the enclosing + function name, and the MPI rank writing the message. + date_format : str + Prepends the date before all log event messages. + formatter : logging.Formatter + Formatter handling the prepending of the information in `format` and + `date_format` to each log event message. Used by default for all + loggers. + rank0 : logging.Logger + Default logger object for the root MPI rank. + all_ranks : logging.Logger + Default logger object for messages being emitted from all MPI ranks + simultaneously. + """ + + level = None + log_file = None + format = " %(levelname)-8s [%(filename)s:%(lineno)d] <%(funcName)s> {rank %(rank)d/%(size)d} %(message)s" # noqa: E501 + date_format = "%(asctime)s" + formatter = logging.Formatter(fmt=date_format + format) + rank0 = logging.getLogger("HyMD.rank_0") + all_ranks = logging.getLogger("HyMD.all_ranks") + +
[docs] @classmethod + def setup(cls, default_level=logging.INFO, log_file=None, verbose=False, comm=MPI.COMM_WORLD): + """Sets up the logger object. + + If a :code:`log_file` path is provided, log event messages are output + to it. Otherwise, the logging messages are emitted to stdout. + + Parameters + ---------- + default_level : int, optional + Default verbosity level of the logger. Unless specified, it is + :code:`10` (:code:`logging.INFO`). + log_file : str, optional + Path to output log file. If `None` or not priovided, no log file is + used and all logging is done to stdout. + verbose : bool, optional + Increases the logging level to :code:`30` (:code:`logging.WARNING`) + if True, otherwise leaves the logging level unchanged. + """ + cls.level = default_level + cls.log_file = log_file + + log_to_stdout = False + if verbose: + log_to_stdout = True + + level = default_level + if not verbose: + level = logging.WARNING + cls.rank0.setLevel(level) + cls.all_ranks.setLevel(level) + + root_filter = MPIFilterRoot(comm) + all_filter = MPIFilterAll(comm) + cls.rank0.addFilter(root_filter) + cls.all_ranks.addFilter(all_filter) + + if (not log_file) and (not log_to_stdout): + return + if log_file: + cls.log_file_handler = logging.FileHandler(log_file) + cls.log_file_handler.setLevel(level) + cls.log_file_handler.setFormatter(cls.formatter) + + cls.rank0.addHandler(cls.log_file_handler) + cls.all_ranks.addHandler(cls.log_file_handler) + if log_to_stdout: + cls.log_to_stdout = True + cls.stdout_handler = logging.StreamHandler() + cls.stdout_handler.setLevel(level) + cls.stdout_handler.setStream(sys.stdout) + cls.stdout_handler.setFormatter(cls.formatter) + cls.stdout_handler.addFilter(MPIFilterStdout()) + + cls.rank0.addHandler(cls.stdout_handler) + cls.all_ranks.addHandler(cls.stdout_handler)
+ + +def format_timedelta(timedelta): + days = timedelta.days + hours, rem = divmod(timedelta.seconds, 3600) + minutes, seconds = divmod(rem, 60) + microseconds = timedelta.microseconds + ret_str = "" + if days != 0: + ret_str += f"{days} days " + ret_str += f"{hours:02d}:{minutes:02d}:{seconds:02d}.{microseconds:06d}" + return ret_str + + +def get_version(): + # Check if we are in a git repo and grab the commit hash and the branch if + # we are, append it to the version number in the output specification. + try: + import git + + try: + repo_dir = os.path.abspath( + os.path.join(os.path.dirname(__file__), os.pardir) + ) + repo = git.Repo(repo_dir) + commit = str(repo.head.commit)[:7] + branch = repo.active_branch + version = f"{__version__} [{branch} branch commit {commit}]" + except git.exc.InvalidGitRepositoryError: + version = f"{__version__}" + except ModuleNotFoundError: + version = f"{__version__}" + + return version + + +def print_header(): + banner = r""" + __ __ ____ __ _______ + / / / /_ __/ / /__ _________ _____ ______ / |/ / __ \ + / /_/ / / / / / / _ \/ ___/ __ `/ __ `/ ___/ / /|_/ / / / / + / __ / /_/ / / / __/ / / /_/ / /_/ (__ ) / / / / /_/ / + /_/ /_/\__, /_/_/\___/_/ \__,_/\__,_/____/ /_/ /_/_____/ + /____/ + """ + + refs_set = """ + + [1] Ledum, M.; Sen, S.; Li, X.; Carrer, M.; Feng Y.; Cascella, M.; Bore, S. L. + HylleraasMD: A Domain Decomposition-Based Hybrid Particle-Field Software for Multi-Scale Simulations of Soft Matter. + J. Chem. Theory Comput. 2023. + + [2] Ledum, M.; Carrer, M.; Sen, S.; Li, X.; Cascella, M.; Bore, S. L. + HyMD: Massively parallel hybrid particle-field molecular dynamics in Python. + J. Open Source Softw. 8(84), 4149, 2023. + + [3] Sen, S.; Ledum, M.; Bore, S. L.; Cascella, M. + Soft Matter under Pressure: Pushing Particle–Field Molecular Dynamics to the Isobaric Ensemble. + J Chem Inf Model 2023, 63(7), 1549-9596. + + [4] Bore, S. L.; Cascella, M. + Hamiltonian and alias-free hybrid particle–field molecular dynamics. + J. Chem. Phys. 2020, 153, 094106. + + [5] Pippig, M. PFFT: An extension of FFTW to massively parallel architectures. + SIAM J. Sci. Comput. 2013, 35, C213–C236. + +""" + + version = f"Version {get_version()}" + header = banner + header += version.center(56) + "\n\n" + #header += " Please read and cite the references below:" + header += " PLEASE READ AND CITE THE REFERENCES BELOW:" + header += refs_set + + return header +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/_modules/hymd/thermostat.html b/v1.0.5/_modules/hymd/thermostat.html new file mode 100644 index 00000000..7436f851 --- /dev/null +++ b/v1.0.5/_modules/hymd/thermostat.html @@ -0,0 +1,492 @@ + + + + + + hymd.thermostat — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.thermostat

+"""Scales or otherwise modifies the particle velocities during simulation to
+simulate coupling to an external heat bath with temperature T₀.
+"""
+import numpy as np
+import logging
+from mpi4py import MPI
+from typing import Callable
+from .logger import Logger
+from .input_parser import Config
+
+
+def cancel_com_momentum(velocities, config, comm=MPI.COMM_WORLD):
+    com_velocity = comm.allreduce(np.sum(velocities[...], axis=0), MPI.SUM)
+    velocities[...] = velocities[...] - com_velocity / config.n_particles
+    return velocities
+
+
+def generate_initial_velocities(velocities, config, prng, comm=MPI.COMM_WORLD):
+    kT_start = config.gas_constant * config.start_temperature
+    n_particles_ = velocities.shape[0]
+    velocities[...] = prng.normal(
+        loc=0, scale=kT_start / config.mass, size=(n_particles_, 3)
+    )
+    velocities = cancel_com_momentum(velocities, config, comm=comm)
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    start_kinetic_energy_target = (
+        1.5 * config.gas_constant * config.n_particles * config.start_temperature
+    )
+    factor = np.sqrt(1.5 * config.n_particles * kT_start / kinetic_energy)
+    velocities[...] = velocities[...] * factor
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    Logger.rank0.log(
+        logging.INFO,
+        (
+            f"Initialized {config.n_particles} velocities, target kinetic "
+            f"energy: {start_kinetic_energy_target}, actual kinetic energy "
+            f"generated: {kinetic_energy}"
+        ),
+    )
+    return velocities
+
+
+
[docs]def _random_gaussian(prng: np.random.Generator) -> float: + """Draw a single random number from the standard normal distribution + Generate a number from the Gaussian distribution centered at zero with unit + standard deviation, :math:`N(0, 1)`. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + + Returns + ------- + float + A random number drawn from :math:`N(0, 1)`. + """ + return prng.normal()
+ + +
[docs]def _random_chi_squared(prng: np.random.Generator, M: int) -> float: + """Draw the sum of :code:`M` squared normally distributed values + + The value is generated by the Gamma distribution, in lieu of generating + :code:`M` Gaussian distributed numbers and summing their squares. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + M : int + Number of standard normally distributed numbers in the sum. + + Returns + ------- + float + The sum of :code:`M` squared normally distributed values centered at + zero with unit standard deviation. + + Notes + ----- + The sum of the squares of k independent standard normal random variables is + distributed according to a :math:`\\chi^2` distribution. + + .. math:: + + \\chi^2_1 + \\chi_2^2 + \\chi_3^2 + \\dots + \\chi_M^2 + \\sim + \\sigma^2\\chi^2(k) + + This is a special case of the :math:`\\Gamma` distribution, + :math:`\\Gamma(k/2, 2)`, and may be generated by + + .. math:: + + \\chi^2(k) \\sim 2 \\Gamma(k/2, 2) + + References + ---------- + Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of + Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. + J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246. + """ + return prng.chisquare(M)
+ + +
[docs]def csvr_thermostat( + velocity: np.ndarray, + names: np.ndarray, + config: Config, + prng: np.random.Generator, + comm: MPI.Intracomm = MPI.COMM_WORLD, + random_gaussian: Callable[[np.random.Generator], float] = _random_gaussian, + random_chi_squared: Callable[ + [np.random.Generator, int, float], float + ] = _random_chi_squared, + remove_center_of_mass_momentum: bool = True, +) -> np.ndarray: + """Canonical sampling through velocity rescaling thermostat + + Implements the CSVR thermostat. Rescales the system kinetic energy by a + stochastically chosen factor to keep the temperature constant. Requires + communcation of the kinetic energies calculated locally for each MPI rank. + The random numbers sampled through :code:`random_gaussian` and + :code:`random_chi_squared` are broadcast from the root rank to the other + ranks to ensure the scaling is performed with the same stochasticity for + all particles in the full system. + + The velocities are cleaned of center of mass momentum before the thermostat + is applied, and the center of mass momentum is subsequently reapplied. This + is performed for each thermostat coupling group, i.e. the center of mass + momenta of each *group* is separately removed and reapplied after + thermostatting. + + The implementation here is based on the derivation presented in the 2008 + Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper. + + Parameters + ---------- + velocity : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + names : (N,) numpy.ndarray + Array of particle names. + config : Config + Configuration dataclass containing simulation metadata and parameters. + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + random_gaussian : callable, optional + Function for generating standard normally distributed numbers. + random_chi_squared : callable, optional + Function for generating :math:`\\chi^2`-distributed numbers + remove_center_of_mass_momentum : bool, optional + If True, the center of mass of each coupling group is removed before + the thermostat is applied. The center of mass momenta are added back + after the kinetic energy rescaling is complete. + + See Also + -------- + _random_gaussian : + Used to sample Gaussian-distributed numbers. + _random_chi_squared : + Used to sample :math:`\\chi^2`-distributed numbers. + hymd.input_parser.Config : + Configuration dataclass handler. + + References + ---------- + G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). + G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008). + """ + if not any(config.thermostat_coupling_groups): + config.thermostat_coupling_groups = [config.unique_names.copy()] + for i, group in enumerate(config.thermostat_coupling_groups): + ind = np.where( + np.logical_or.reduce(list(names == np.string_(t) for t in group)) + ) + group_n_particles = comm.allreduce(len(ind[0]), MPI.SUM) + + # Clean velocities of center of mass momentum + if remove_center_of_mass_momentum and group_n_particles > 1: + com_velocity = comm.allreduce(np.sum(velocity[ind], axis=0)) + velocity_clean = velocity[ind] - com_velocity / group_n_particles + K = comm.allreduce(0.5 * config.mass * np.sum(velocity_clean[...] ** 2)) + else: + K = comm.allreduce(0.5 * config.mass * np.sum(velocity[...] ** 2)) + K_target = ( + 1.5 * config.gas_constant * group_n_particles * config.target_temperature + ) + N_f = 3 * group_n_particles + c = np.exp(-(config.time_step * config.respa_inner) / config.tau) + + # Random numbers are identical across ranks because all ranks have + # the same prng after the initialization of the velocities + R = random_gaussian(prng) + SNf = random_chi_squared(prng, N_f - 1) + + alpha2 = ( + c + + (1 - c) * (SNf + R**2) * K_target / (N_f * K) + + 2 * R * np.sqrt(c * (1 - c) * K_target / (N_f * K)) + ) + dK = K * (alpha2 - 1) + alpha = np.sqrt(alpha2) + + if remove_center_of_mass_momentum and group_n_particles > 1: + # Assign velocities and reapply the previously removed center + # of mass momentum removed + velocity_clean *= alpha + velocity[ind] = velocity_clean + com_velocity / group_n_particles + else: + velocity *= alpha + config.thermostat_work += dK
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/_modules/index.html b/v1.0.5/_modules/index.html new file mode 100644 index 00000000..a772112b --- /dev/null +++ b/v1.0.5/_modules/index.html @@ -0,0 +1,280 @@ + + + + + + Overview: module code — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+ +
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/v1.0.5/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css new file mode 100644 index 00000000..1b057df2 --- /dev/null +++ b/v1.0.5/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css @@ -0,0 +1 @@ +.badge{border-radius:.25rem;display:inline-block;font-size:75%;font-weight:700;line-height:1;padding:.25em .4em;text-align:center;vertical-align:baseline;white-space:nowrap}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{border-radius:10rem;padding-left:.6em;padding-right:.6em}.badge-primary{background-color:#007bff;color:#fff}.badge-primary[href]:focus,.badge-primary[href]:hover{background-color:#0062cc;color:#fff;text-decoration:none}.badge-secondary{background-color:#6c757d;color:#fff}.badge-secondary[href]:focus,.badge-secondary[href]:hover{background-color:#545b62;color:#fff;text-decoration:none}.badge-success{background-color:#28a745;color:#fff}.badge-success[href]:focus,.badge-success[href]:hover{background-color:#1e7e34;color:#fff;text-decoration:none}.badge-info{background-color:#17a2b8;color:#fff}.badge-info[href]:focus,.badge-info[href]:hover{background-color:#117a8b;color:#fff;text-decoration:none}.badge-warning{background-color:#ffc107;color:#212529}.badge-warning[href]:focus,.badge-warning[href]:hover{background-color:#d39e00;color:#212529;text-decoration:none}.badge-danger{background-color:#dc3545;color:#fff}.badge-danger[href]:focus,.badge-danger[href]:hover{background-color:#bd2130;color:#fff;text-decoration:none}.badge-light{background-color:#f8f9fa;color:#212529}.badge-light[href]:focus,.badge-light[href]:hover{background-color:#dae0e5;color:#212529;text-decoration:none}.badge-dark{background-color:#343a40;color:#fff}.badge-dark[href]:focus,.badge-dark[href]:hover{background-color:#1d2124;color:#fff;text-decoration:none}.border-0{border:0 !important}.border-top-0{border-top:0 !important}.border-right-0{border-right:0 !important}.border-bottom-0{border-bottom:0 !important}.border-left-0{border-left:0 !important}.p-0{padding:0 !important}.pt-0,.py-0{padding-top:0 !important}.pr-0,.px-0{padding-right:0 !important}.pb-0,.py-0{padding-bottom:0 !important}.pl-0,.px-0{padding-left:0 !important}.p-1{padding:.25rem !important}.pt-1,.py-1{padding-top:.25rem !important}.pr-1,.px-1{padding-right:.25rem !important}.pb-1,.py-1{padding-bottom:.25rem !important}.pl-1,.px-1{padding-left:.25rem !important}.p-2{padding:.5rem !important}.pt-2,.py-2{padding-top:.5rem !important}.pr-2,.px-2{padding-right:.5rem !important}.pb-2,.py-2{padding-bottom:.5rem !important}.pl-2,.px-2{padding-left:.5rem !important}.p-3{padding:1rem !important}.pt-3,.py-3{padding-top:1rem !important}.pr-3,.px-3{padding-right:1rem !important}.pb-3,.py-3{padding-bottom:1rem !important}.pl-3,.px-3{padding-left:1rem !important}.p-4{padding:1.5rem !important}.pt-4,.py-4{padding-top:1.5rem !important}.pr-4,.px-4{padding-right:1.5rem !important}.pb-4,.py-4{padding-bottom:1.5rem !important}.pl-4,.px-4{padding-left:1.5rem !important}.p-5{padding:3rem !important}.pt-5,.py-5{padding-top:3rem !important}.pr-5,.px-5{padding-right:3rem !important}.pb-5,.py-5{padding-bottom:3rem !important}.pl-5,.px-5{padding-left:3rem !important}.m-0{margin:0 !important}.mt-0,.my-0{margin-top:0 !important}.mr-0,.mx-0{margin-right:0 !important}.mb-0,.my-0{margin-bottom:0 !important}.ml-0,.mx-0{margin-left:0 !important}.m-1{margin:.25rem !important}.mt-1,.my-1{margin-top:.25rem !important}.mr-1,.mx-1{margin-right:.25rem !important}.mb-1,.my-1{margin-bottom:.25rem !important}.ml-1,.mx-1{margin-left:.25rem !important}.m-2{margin:.5rem !important}.mt-2,.my-2{margin-top:.5rem !important}.mr-2,.mx-2{margin-right:.5rem !important}.mb-2,.my-2{margin-bottom:.5rem !important}.ml-2,.mx-2{margin-left:.5rem !important}.m-3{margin:1rem !important}.mt-3,.my-3{margin-top:1rem !important}.mr-3,.mx-3{margin-right:1rem !important}.mb-3,.my-3{margin-bottom:1rem !important}.ml-3,.mx-3{margin-left:1rem !important}.m-4{margin:1.5rem !important}.mt-4,.my-4{margin-top:1.5rem !important}.mr-4,.mx-4{margin-right:1.5rem !important}.mb-4,.my-4{margin-bottom:1.5rem !important}.ml-4,.mx-4{margin-left:1.5rem !important}.m-5{margin:3rem !important}.mt-5,.my-5{margin-top:3rem !important}.mr-5,.mx-5{margin-right:3rem !important}.mb-5,.my-5{margin-bottom:3rem !important}.ml-5,.mx-5{margin-left:3rem !important}.btn{background-color:transparent;border:1px solid transparent;border-radius:.25rem;color:#212529;cursor:pointer;display:inline-block;font-size:1rem;font-weight:400;line-height:1.5;padding:.375rem .75rem;text-align:center;transition:color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none;vertical-align:middle}.btn:hover{color:#212529;text-decoration:none}.btn:visited{color:#212529}.btn.focus,.btn:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.25);outline:0}.btn.disabled,.btn:disabled{opacity:.65}@media (prefers-reduced-motion: reduce){.btn{transition:none}}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary:visited{color:#fff}.btn-primary:hover{background-color:#0069d9;border-color:#0062cc;color:#fff}.btn-primary.focus,.btn-primary:focus{background-color:#0069d9;border-color:#0062cc;box-shadow:0 0 0 .2rem rgba(0,123,255,0.5);color:#fff}.btn-primary.disabled,.btn-primary:disabled{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary.active:not(:disabled):not(.disabled),.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{background-color:#0062cc;border-color:#005cbf;color:#fff}.btn-primary.active:not(:disabled):not(.disabled):focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-secondary{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary:visited{color:#fff}.btn-secondary:hover{background-color:#5a6268;border-color:#545b62;color:#fff}.btn-secondary.focus,.btn-secondary:focus{background-color:#5a6268;border-color:#545b62;box-shadow:0 0 0 .2rem rgba(108,117,125,0.5);color:#fff}.btn-secondary.disabled,.btn-secondary:disabled{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled),.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{background-color:#545b62;border-color:#4e555b;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled):focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-success{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success:visited{color:#fff}.btn-success:hover{background-color:#218838;border-color:#1e7e34;color:#fff}.btn-success.focus,.btn-success:focus{background-color:#218838;border-color:#1e7e34;box-shadow:0 0 0 .2rem rgba(40,167,69,0.5);color:#fff}.btn-success.disabled,.btn-success:disabled{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success.active:not(:disabled):not(.disabled),.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{background-color:#1e7e34;border-color:#1c7430;color:#fff}.btn-success.active:not(:disabled):not(.disabled):focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-info{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info:visited{color:#fff}.btn-info:hover{background-color:#138496;border-color:#117a8b;color:#fff}.btn-info.focus,.btn-info:focus{background-color:#138496;border-color:#117a8b;box-shadow:0 0 0 .2rem rgba(23,162,184,0.5);color:#fff}.btn-info.disabled,.btn-info:disabled{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info.active:not(:disabled):not(.disabled),.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{background-color:#117a8b;border-color:#10707f;color:#fff}.btn-info.active:not(:disabled):not(.disabled):focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-warning{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning:visited{color:#212529}.btn-warning:hover{background-color:#e0a800;border-color:#d39e00;color:#212529}.btn-warning.focus,.btn-warning:focus{background-color:#e0a800;border-color:#d39e00;box-shadow:0 0 0 .2rem rgba(255,193,7,0.5);color:#212529}.btn-warning.disabled,.btn-warning:disabled{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning.active:not(:disabled):not(.disabled),.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{background-color:#d39e00;border-color:#c69500;color:#212529}.btn-warning.active:not(:disabled):not(.disabled):focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-danger{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger:visited{color:#fff}.btn-danger:hover{background-color:#c82333;border-color:#bd2130;color:#fff}.btn-danger.focus,.btn-danger:focus{background-color:#c82333;border-color:#bd2130;box-shadow:0 0 0 .2rem rgba(220,53,69,0.5);color:#fff}.btn-danger.disabled,.btn-danger:disabled{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger.active:not(:disabled):not(.disabled),.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{background-color:#bd2130;border-color:#b21f2d;color:#fff}.btn-danger.active:not(:disabled):not(.disabled):focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-light{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light:visited{color:#212529}.btn-light:hover{background-color:#e2e6ea;border-color:#dae0e5;color:#212529}.btn-light.focus,.btn-light:focus{background-color:#e2e6ea;border-color:#dae0e5;box-shadow:0 0 0 .2rem rgba(248,249,250,0.5);color:#212529}.btn-light.disabled,.btn-light:disabled{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light.active:not(:disabled):not(.disabled),.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{background-color:#dae0e5;border-color:#d3d9df;color:#212529}.btn-light.active:not(:disabled):not(.disabled):focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-dark{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark:visited{color:#fff}.btn-dark:hover{background-color:#23272b;border-color:#1d2124;color:#fff}.btn-dark.focus,.btn-dark:focus{background-color:#23272b;border-color:#1d2124;box-shadow:0 0 0 .2rem rgba(52,58,64,0.5);color:#fff}.btn-dark.disabled,.btn-dark:disabled{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark.active:not(:disabled):not(.disabled),.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{background-color:#1d2124;border-color:#171a1d;color:#fff}.btn-dark.active:not(:disabled):not(.disabled):focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-primary{border-color:#007bff;color:#007bff}.btn-outline-primary:visited{color:#007bff}.btn-outline-primary:hover{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{background-color:transparent;color:#007bff}.btn-outline-primary.active:not(:disabled):not(.disabled),.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.active:not(:disabled):not(.disabled):focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-secondary{border-color:#6c757d;color:#6c757d}.btn-outline-secondary:visited{color:#6c757d}.btn-outline-secondary:hover{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{background-color:transparent;color:#6c757d}.btn-outline-secondary.active:not(:disabled):not(.disabled),.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.active:not(:disabled):not(.disabled):focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-success{border-color:#28a745;color:#28a745}.btn-outline-success:visited{color:#28a745}.btn-outline-success:hover{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{background-color:transparent;color:#28a745}.btn-outline-success.active:not(:disabled):not(.disabled),.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.active:not(:disabled):not(.disabled):focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-info{border-color:#17a2b8;color:#17a2b8}.btn-outline-info:visited{color:#17a2b8}.btn-outline-info:hover{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{background-color:transparent;color:#17a2b8}.btn-outline-info.active:not(:disabled):not(.disabled),.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.active:not(:disabled):not(.disabled):focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-warning{border-color:#ffc107;color:#ffc107}.btn-outline-warning:visited{color:#ffc107}.btn-outline-warning:hover{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{background-color:transparent;color:#ffc107}.btn-outline-warning.active:not(:disabled):not(.disabled),.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.active:not(:disabled):not(.disabled):focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-danger{border-color:#dc3545;color:#dc3545}.btn-outline-danger:visited{color:#dc3545}.btn-outline-danger:hover{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{background-color:transparent;color:#dc3545}.btn-outline-danger.active:not(:disabled):not(.disabled),.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.active:not(:disabled):not(.disabled):focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-light{border-color:#f8f9fa;color:#f8f9fa}.btn-outline-light:visited{color:#f8f9fa}.btn-outline-light:hover{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{background-color:transparent;color:#f8f9fa}.btn-outline-light.active:not(:disabled):not(.disabled),.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.active:not(:disabled):not(.disabled):focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-dark{border-color:#343a40;color:#343a40}.btn-outline-dark:visited{color:#343a40}.btn-outline-dark:hover{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{background-color:transparent;color:#343a40}.btn-outline-dark.active:not(:disabled):not(.disabled),.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.active:not(:disabled):not(.disabled):focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-link{color:#007bff;font-weight:400;text-decoration:none}.btn-link:hover{color:#0056b3;text-decoration:underline}.btn-link.focus,.btn-link:focus{box-shadow:none;text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{border-radius:.3rem;font-size:1.25rem;line-height:1.5;padding:.5rem 1rem}.btn-group-sm>.btn,.btn-sm{border-radius:.2rem;font-size:.875rem;line-height:1.5;padding:.25rem .5rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input.btn-block[type=button],input.btn-block[type=reset],input.btn-block[type=submit]{width:100%}.stretched-link::after{background-color:rgba(0,0,0,0);bottom:0;content:'';left:0;pointer-events:auto;position:absolute;right:0;top:0;z-index:1}.text-wrap{white-space:normal !important}.card{background-clip:border-box;background-color:#fff;border:1px solid rgba(0,0,0,0.125);border-radius:.25rem;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;min-width:0;position:relative;word-wrap:break-word}.card>hr{margin-left:0;margin-right:0}.card>.list-group:first-child .list-group-item:first-child{border-top-left-radius:.25rem;border-top-right-radius:.25rem}.card>.list-group:last-child .list-group-item:last-child{border-bottom-left-radius:.25rem;border-bottom-right-radius:.25rem}.card-body{-ms-flex:1 1 auto;flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-bottom:0;margin-top:-.375rem}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{background-color:rgba(0,0,0,0.03);border-bottom:1px solid rgba(0,0,0,0.125);margin-bottom:0;padding:.75rem 1.25rem}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-header+.list-group .list-group-item:first-child{border-top:0}.card-footer{background-color:rgba(0,0,0,0.03);border-top:1px solid rgba(0,0,0,0.125);padding:.75rem 1.25rem}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{border-bottom:0;margin-bottom:-.75rem;margin-left:-.625rem;margin-right:-.625rem}.card-header-pills{margin-left:-.625rem;margin-right:-.625rem}.card-img-overlay{bottom:0;left:0;padding:1.25rem;position:absolute;right:0;top:0}.card-img,.card-img-bottom,.card-img-top{-ms-flex-negative:0;flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-left-radius:calc(.25rem - 1px);border-bottom-right-radius:calc(.25rem - 1px)}.w-100{width:100% !important}.shadow{box-shadow:0 0.5rem 1rem rgba(0,0,0,0.15) !important}.bg-primary{background-color:#007bff !important}button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc !important}a.bg-primary:focus,a.bg-primary:hover{background-color:#0062cc !important}a.text-primary:focus,a.text-primary:hover{color:#121416 !important}.bg-secondary{background-color:#6c757d !important}button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62 !important}a.bg-secondary:focus,a.bg-secondary:hover{background-color:#545b62 !important}a.text-secondary:focus,a.text-secondary:hover{color:#121416 !important}.bg-success{background-color:#28a745 !important}button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34 !important}a.bg-success:focus,a.bg-success:hover{background-color:#1e7e34 !important}a.text-success:focus,a.text-success:hover{color:#121416 !important}.bg-info{background-color:#17a2b8 !important}button.bg-info:focus,button.bg-info:hover{background-color:#117a8b !important}a.bg-info:focus,a.bg-info:hover{background-color:#117a8b !important}a.text-info:focus,a.text-info:hover{color:#121416 !important}.bg-warning{background-color:#ffc107 !important}button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00 !important}a.bg-warning:focus,a.bg-warning:hover{background-color:#d39e00 !important}a.text-warning:focus,a.text-warning:hover{color:#121416 !important}.bg-danger{background-color:#dc3545 !important}button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130 !important}a.bg-danger:focus,a.bg-danger:hover{background-color:#bd2130 !important}a.text-danger:focus,a.text-danger:hover{color:#121416 !important}.bg-light{background-color:#f8f9fa !important}button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5 !important}a.bg-light:focus,a.bg-light:hover{background-color:#dae0e5 !important}a.text-light:focus,a.text-light:hover{color:#121416 !important}.bg-dark{background-color:#343a40 !important}button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124 !important}a.bg-dark:focus,a.bg-dark:hover{background-color:#1d2124 !important}a.text-dark:focus,a.text-dark:hover{color:#121416 !important}.bg-white{background-color:#fff !important}button.bg-white:focus,button.bg-white:hover{background-color:#e6e6e6 !important}a.bg-white:focus,a.bg-white:hover{background-color:#e6e6e6 !important}a.text-white:focus,a.text-white:hover{color:#121416 !important}.text-primary{color:#007bff !important}.text-secondary{color:#6c757d !important}.text-success{color:#28a745 !important}.text-info{color:#17a2b8 !important}.text-warning{color:#ffc107 !important}.text-danger{color:#dc3545 !important}.text-light{color:#f8f9fa !important}.text-dark{color:#343a40 !important}.text-white{color:#fff !important}.text-body{color:#212529 !important}.text-muted{color:#6c757d !important}.text-black-50{color:rgba(0,0,0,0.5) !important}.text-white-50{color:rgba(255,255,255,0.5) !important}.bg-transparent{background-color:transparent !important}.text-justify{text-align:justify !important}.text-left{text-align:left !important}.text-right{text-align:right !important}.text-center{text-align:center !important}.font-weight-light{font-weight:300 !important}.font-weight-lighter{font-weight:lighter !important}.font-weight-normal{font-weight:400 !important}.font-weight-bold{font-weight:700 !important}.font-weight-bolder{font-weight:bolder !important}.font-italic{font-style:italic !important}.container{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container{max-width:540px}}@media (min-width: 768px){.container{max-width:720px}}@media (min-width: 992px){.container{max-width:960px}}@media (min-width: 1200px){.container{max-width:1140px}}.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container,.container-sm{max-width:540px}}@media (min-width: 768px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width: 992px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width: 1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1140px}}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;margin-right:-15px}.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{padding-left:15px;padding-right:15px;position:relative;width:100%}@media (min-width: 576px){.col-sm{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-sm-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-sm-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-sm-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-sm-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-sm-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 768px){.col-md{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-md-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-md-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-md-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-md-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-md-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 992px){.col-lg{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-lg-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-lg-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-lg-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-lg-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-lg-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 1200px){.col-xl{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-xl-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-xl-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-xl-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-xl-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-xl-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}.d-flex{display:-ms-flexbox !important;display:flex !important}.sphinx-bs,.sphinx-bs *{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sphinx-bs p{margin-top:0} diff --git a/v1.0.5/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/v1.0.5/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css new file mode 100644 index 00000000..fc14abc8 --- /dev/null +++ b/v1.0.5/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css @@ -0,0 +1 @@ +details.dropdown .summary-title{padding-right:3em !important;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none}details.dropdown:hover{cursor:pointer}details.dropdown .summary-content{cursor:default}details.dropdown summary{list-style:none;padding:1em}details.dropdown summary .octicon.no-title{vertical-align:middle}details.dropdown[open] summary .octicon.no-title{visibility:hidden}details.dropdown summary::-webkit-details-marker{display:none}details.dropdown summary:focus{outline:none}details.dropdown summary:hover .summary-up svg,details.dropdown summary:hover .summary-down svg{opacity:1}details.dropdown .summary-up svg,details.dropdown .summary-down svg{display:block;opacity:.6}details.dropdown .summary-up,details.dropdown .summary-down{pointer-events:none;position:absolute;right:1em;top:.75em}details.dropdown[open] .summary-down{visibility:hidden}details.dropdown:not([open]) .summary-up{visibility:hidden}details.dropdown.fade-in[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out;animation:panels-fade-in .5s ease-in-out}details.dropdown.fade-in-slide-down[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out}@keyframes panels-fade-in{0%{opacity:0}100%{opacity:1}}@keyframes panels-slide-down{0%{transform:translate(0, -10px)}100%{transform:translate(0, 0)}}.octicon{display:inline-block;fill:currentColor;vertical-align:text-top}.tabbed-content{box-shadow:0 -.0625rem var(--tabs-color-overline),0 .0625rem var(--tabs-color-underline);display:none;order:99;padding-bottom:.75rem;padding-top:.75rem;width:100%}.tabbed-content>:first-child{margin-top:0 !important}.tabbed-content>:last-child{margin-bottom:0 !important}.tabbed-content>.tabbed-set{margin:0}.tabbed-set{border-radius:.125rem;display:flex;flex-wrap:wrap;margin:1em 0;position:relative}.tabbed-set>input{opacity:0;position:absolute}.tabbed-set>input:checked+label{border-color:var(--tabs-color-label-active);color:var(--tabs-color-label-active)}.tabbed-set>input:checked+label+.tabbed-content{display:block}.tabbed-set>input:focus+label{outline-style:auto}.tabbed-set>input:not(.focus-visible)+label{outline:none;-webkit-tap-highlight-color:transparent}.tabbed-set>label{border-bottom:.125rem solid transparent;color:var(--tabs-color-label-inactive);cursor:pointer;font-size:var(--tabs-size-label);font-weight:700;padding:1em 1.25em .5em;transition:color 250ms;width:auto;z-index:1}html .tabbed-set>label:hover{color:var(--tabs-color-label-active)} diff --git a/v1.0.5/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css b/v1.0.5/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css new file mode 100644 index 00000000..adc61662 --- /dev/null +++ b/v1.0.5/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css @@ -0,0 +1,7 @@ +:root { +--tabs-color-label-active: hsla(231, 99%, 66%, 1); +--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); +--tabs-color-overline: rgb(207, 236, 238); +--tabs-color-underline: rgb(207, 236, 238); +--tabs-size-label: 1rem; +} \ No newline at end of file diff --git a/v1.0.5/_sources/doc_pages/api.rst.txt b/v1.0.5/_sources/doc_pages/api.rst.txt new file mode 100644 index 00000000..c9f8837b --- /dev/null +++ b/v1.0.5/_sources/doc_pages/api.rst.txt @@ -0,0 +1,90 @@ +.. _api-label: + + +API reference +============= + +Integrator +---------- + +.. automodule:: hymd.integrator + :members: + + +Thermostat +---------- + +.. automodule:: hymd.thermostat + :members: csvr_thermostat, _random_chi_squared, _random_gaussian + :undoc-members: + + +Hamiltonian +----------- + +.. autoclass:: hymd.hamiltonian.Hamiltonian + :members: + + .. automethod:: __init__ + + .. automethod:: _setup + +.. autoclass:: hymd.hamiltonian.SquaredPhi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultNoChi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultWithChi + :members: + + .. automethod:: __init__ + + +Force +----- + +.. automodule:: hymd.force + :members: + :undoc-members: + + +Logger +------ + +.. autoclass:: hymd.logger.Logger + :members: + +.. autoclass:: hymd.logger.MPIFilterRoot + :members: + +.. autoclass:: hymd.logger.MPIFilterAll + :members: + + +Input parser +------------ + +.. automodule:: hymd.input_parser + :members: + :undoc-members: propensity_potential_coeffs + + +Field +----- + +.. automodule:: hymd.field + :members: + + +File input/output +----------------- + +.. automodule:: hymd.file_io + :members: diff --git a/v1.0.5/_sources/doc_pages/benchmarks.rst.txt b/v1.0.5/_sources/doc_pages/benchmarks.rst.txt new file mode 100644 index 00000000..06377a85 --- /dev/null +++ b/v1.0.5/_sources/doc_pages/benchmarks.rst.txt @@ -0,0 +1,93 @@ +.. _benchmarks-label: + +Benchmarks +########## +Homopolymer melt test systems of :math:`30^2`, :math:`40^2`, and :math:`50^2` +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively. + +Bonded forces +^^^^^^^^^^^^^ +Legend label denotes the number of particles in the system. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) + time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 + ], dtype=np.float64) + nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 + ], dtype=np.float64,) + time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, + ], dtype=np.float64) + nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 + ], dtype=np.float64) + time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, + ], dtype=np.float64) + plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" + ) + plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" + ) + plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" + ) + plt.xlabel("CPUs", fontsize=15) + plt.ylabel("Time per step, us", fontsize=15) + plt.legend(fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.show() + + +Particle--field forces +^^^^^^^^^^^^^^^^^^^^^^ +Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + + mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] + mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + + mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + + mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + + mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] + mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + + mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + + mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + + plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") + plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") + plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") + plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") + plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") + plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") + plt.xlabel("CPUs", fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.ylabel("Time per step, s", fontsize=15) + plt.legend(loc="upper left", fontsize=15) + plt.show() diff --git a/v1.0.5/_sources/doc_pages/command_line.rst.txt b/v1.0.5/_sources/doc_pages/command_line.rst.txt new file mode 100644 index 00000000..5233710f --- /dev/null +++ b/v1.0.5/_sources/doc_pages/command_line.rst.txt @@ -0,0 +1,120 @@ +.. _commandline-label: + +Command line arguments +###################### +Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle--field interactions. + + +Required arguments +================== +:configuration file: + :code:`type` positional + + Specifies the :code:`.toml` format configuration file containing simulation details. See :ref:`config-label` for details. + +:structure and topology file: + :code:`type` positional + + Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See :ref:`topology-label` for details. + +Optional arguments +================== +:code:`-v --verbose` + :code:`type` optional + + Number of following arguments: :code:`0` or :code:`1` + + Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying :code:`-v` or :code:`--verbose` with no additional specification. This increases verbosity level by :code:`1`. Alternatively, it maye be specified by :code:`--verbose V` with :code:`V` being :code:`0`, :code:`1`, or :code:`2`. + +:code:`--profile` + :code:`type` optional + + Number of following arguments: :code:`0` + + Enables code profiling using :code:`cProfile`. This will output one profiling file per MPI rank invoked in the simulation. + +:code:`--double-precision` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision internally in HyMD (including in the FFTs). + +:code:`--double-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision in the output trajectory from HyMD. + +:code:`--velocity-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that velocities should be output to the HyMD trajectory. + +:code:`--force-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that forces should be output to the HyMD trajectory. + +:code:`--disable-mpio` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult. + +:code:`--logfile` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the path of a plain text log file in which stdout is mirrored during simulation runs. + +:code:`--seed` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the random seed used in the :code:`numpy` random library to generate velocities, thermostatting, etc. + +:code:`--disable-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any two-particle bonds present in the system. + +:code:`--disable-angle-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any three-particle bonds present in the system. + +:code:`--disable-dihedrals` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any four-particle bonds present in the system. + +:code:`--disable-dipole` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any topological reconstruction of peptide backbone dipoles present in the system. + +:code:`--disable-field` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any particle--field interactions present in the system. diff --git a/v1.0.5/_sources/doc_pages/config_file.rst.txt b/v1.0.5/_sources/doc_pages/config_file.rst.txt new file mode 100644 index 00000000..40ee0479 --- /dev/null +++ b/v1.0.5/_sources/doc_pages/config_file.rst.txt @@ -0,0 +1,194 @@ +.. _config-label: + +Configuration file +################## +The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order. + +The configuration file is a `toml`_ format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs. + +.. _`toml`: + https://github.com/toml-lang/toml + +.. role:: required + +Configuration file keywords +--------------------------- + +The following constitutes every possible keyword specification in HyMD +configuration files: + +Metadata keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying metadata for the H5MD output trajectory. + +:name: + :code:`string` [**optional**, default: :code:`None`] + + Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file. + + +:tags: + :code:`array` [:code:`string`] [**optional**, default: :code:`None`] + + Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file. + + +Particle keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying properties of particles and molecules in the +system. + +:n_particles: + :code:`integer` [**optional**, default: :code:`None`] + + Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules. + +:mass: + :code:`float` [**optional**, default: :code:`72.0`] {units: :math:`\text{u}=\text{g}\,\text{mol}^{-1}`} + + Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal. + +:max_molecule_size: + :code:`integer` [**optional**, default: :code:`201`] + + Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code **will** crash if there are molecules larger than :code:`max_molecule_size` in the topology/structure input file. + + +Simulation keywords +^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying simulation parameters. + +:n_steps: + :code:`integer` [:required:`required`] + + Total number of integration steps to perform for this simulation. + +:n_print: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of *number of time steps*). + +:n_flush: + :code:`integer` [**optional**, default: :code:`None`] + + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of *number of* :code:`n_print`, i.e. :code:`n_print = 13`, :code:`n_flush = 3` would result in the trajectory/energy being written to disk every :code:`13 x 3 = 39` *simulation steps*) + +:time_step: + :code:`float` [:required:`required`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time step per integration step. If the rRESPA multiple time step integrator is used (:code:`integrator = "respa"`), this specifies the **inner** time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is :code:`respa_inner` times the :code:`time_step` , and the total simulation time is :code:`n_steps` times :code:`time_step` times :code:`respa_inner` . + +:box_size: + :code:`array` [:code:`float`] [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable. + +:integrator: + :code:`string` [:required:`required`] (options: :code:`velocity-verlet` or :code:`respa`) + + Specifies the time integrator used in the simulation. If :code:`respa`, the *reversible reference system propagator algorithm (rRESPA)* :cite:`tuckerman1992reversible` integrator is used, with :code:`respa_inner` number of inner (intramolecular force) time steps. If :code:`velocity-verlet`, a normal Velocity Verlet integrator is used. If :code:`respa` and :code:`respa_inner = 1`, the rRESPA integrator is equivalent to the Velocity Verlet. + +:respa_inner: + :code:`integer` [**optional**, default: :code:`1`] + + The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces. + +:domain_decomposition: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Specifies the interval (in time steps) of *domain decomposition exchange*, involving all MPI ranks sending and receiving particles according to the particles' positions in the integration box and the MPI ranks' assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If :code:`True`, the decomposition is performed once (before starting the simulation). If :code:`False`, no decomposition is performed. + +:cancel_com_momentum: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + If :code:`True`, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every :code:`remove_com_momentum` time steps. If :code:`False`, the linear momentum is never removed. + +:start_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at :code:`start_temperature` Kelvin prior to starting the simulation. If :code:`False`, the velocities are not changed before starting the simulation. + +:target_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Couple the system to a heat bath at :code:`target_temperature` Kelvin by applying a *Canonical sampling through velocity rescaling* :cite:`Bussi2007JCP` thermostat with coupling strength :code:`tau`. If :code:`False`, no temperature control is applied. + +:tau: + :code:`float` [**optional**, default: :code:`0.7`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the CSVR thermostat coupling. In the limit of :code:`tau → ∞`, the Hamiltonian dynamics are preserved and no temperature coupling takes place. + +:thermostat_coupling_groups: + :code:`array` [:code:`array` [:code:`string`]] [**optional**, default: :code:`[]`] + + Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and :code:`"C"` type particles, :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would thermalise types :code:`"A"` and :code:`"B"` together and couple :code:`"C"` type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. :code:`target_temperature` Kelvin). +:hamiltonian: + :code:`string` [**optional**, default: :code:`"DefaultNohChi"`] (options: :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`) + + Specifies the interaction energy functional :math:`W[\tilde\phi]` for use with the particle-field interactions. See :ref:`functionals-label` for details. + + +Field keywords +^^^^^^^^^^^^^^ +Configuration keywords specifying field parameters. + +:mesh_size: + :code:`array` [:code:`integer`] or :code:`integer` [:required:`required`] + + Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is :code:`box_size / mesh_size`. + +:kappa: + :code:`float` [:required:`required`] {units: :math:`\text{kJ}^{-1}\text{mol}`} + + Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional :math:`W[\tilde\phi]`. See :ref:`functionals-label` for more details. + +:sigma: + :code:`float` [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See :ref:`filtering-label` for more details. + +:chi: + :code:`array` [:code:`array` [:code:`string`, :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}`} + + Array of :math:`\tilde\chi_\text{AB}`-parameters indicating the strength of the repulsive or attractive interaction between particles of type :code:`"A"` and the number density due to particles of type :code:`"B"`, and vice versa. Example: :code:`chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ]` would specify a repulsive :code:`"A"`--:code:`"B"` type interaction, and a weakly attractive :code:`"C"`--:code:`"D"` interaction. Self-interaction :math:`\tilde\chi`-terms are always zero. See :ref:`functionals-label` for more details. + + +Bond keywords +^^^^^^^^^^^^^ +Configuration keywords specifying bonds and bonds parameters. + +:bonds: + :code:`array` [:code:`array` [2 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{nm}=10^{-9}~\text{m}` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: :code:`bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ]` indicates a :code:`"A"`--:code:`"A"` bond of equilibrium length :code:`0.47` :math:`\text{nm}` with a bond strength of :code:`980.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding bond between :code:`"A"` and :code:`"B"` type particles with equilibrium length :code:`0.31` :math:`\text{nm}` and a strength of :code:`1250.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify stretching bonds. + +:angle_bonds: + :code:`array` [:code:`array` [3 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`{}^\circ` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: :code:`bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ]` indicates a :code:`"A"`--:code:`"A"`--:code:`"A"` angular bond that tries to keep the bond linear at :code:`180` degrees with a bending strength of :code:`55.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding angle bond between :code:`"A"`--:code:`"B"`--:code:`"B"` prefering the angle at :code:`120` degrees and a strength of :code:`25.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify angular bonds. + +:dihedrals: + :code:`array` [:code:`array` [4 :code:`string`, :code:`integer`, :code:`COSINE SERIES` ]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`} + + Specifies four-particle torsional potentials by cosine series. See :ref:`bonds-label` for details about how to specify dihedrals. + + + +Electrostatic keywords +^^^^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying electrostatics and electrostatic parameters. + +:coulombtype: + :code:`string` [**optional**, default: :code:`None`] (options: :code:`PIC_Spectral`) + + Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the :code:`dielectric_const` keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, *not* in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to `PIC_Spectral`. + +:dielectric_const: + :code:`float` [**optional**, default: :code:`None`] + + Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified---even if electrostatics are not included with the :code:`coulombtype` keyword. diff --git a/v1.0.5/_sources/doc_pages/constants_and_units.rst.txt b/v1.0.5/_sources/doc_pages/constants_and_units.rst.txt new file mode 100644 index 00000000..ee429829 --- /dev/null +++ b/v1.0.5/_sources/doc_pages/constants_and_units.rst.txt @@ -0,0 +1,80 @@ +.. _units-label: + +Constants and Units +################### + +HyMD uses the following units and constants internally and in all input and +output: + +.. list-table:: **Units** + :widths: 30 10 75 + :header-rows: 1 + + * - Quantity + - Symbol + - Unit + * - length + - :math:`r` + - :math:`\text{nm}=10^{-9}~\text{m}` + * - time + - :math:`t` + - :math:`\text{ps}=10^{-12}~\text{s}` + * - charge + - :math:`q` + - :math:`e=1.602176634 \cdot 10^{-19}~\text{C}` + * - mass + - :math:`m` + - :math:`\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}` + * - temperature + - :math:`\text{T}` + - :math:`\text{K}` + * - energy + - :math:`E` + - :math:`\text{kJ}\,\text{mol}^{-1}` + * - velocity + - :math:`v` + - :math:`\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}` + * - momentum + - :math:`P` + - :math:`\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}` + * - force + - :math:`\mathbf{F}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}` + * - pressure + - :math:`p` + - :math:`\text{bar}=100~\text{kPa}` + * - electric potential + - :math:`\Psi` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}` + * - electric field + - :math:`\mathbf{E}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}` + * - compressibility + - :math:`\kappa` + - :math:`\text{mol}\,\text{kJ}^{-1}` + * - field-interaction + - :math:`\tilde\chi` + - :math:`\text{kJ}\,\text{mol}^{-1}` + +.. list-table:: **Constants** + :widths: 30 10 75 + :header-rows: 1 + + * - Constant + - Symbol + - Value + * - gas constant + - :math:`R` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Boltzmann’s constant + - :math:`k_\text{B}` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Avogadro's constant + - :math:`N_\text{A}` + - :math:`6.02214076 \cdot 10^23~\text{mol}^{-1}` + * - Vacuum permittivity + - :math:`\varepsilon_0` + - :math:`8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2` + * - Coulomb constant + - :math:`k_\text{e}` + - :math:`138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}` diff --git a/v1.0.5/_sources/doc_pages/electrostatics.rst.txt b/v1.0.5/_sources/doc_pages/electrostatics.rst.txt new file mode 100644 index 00000000..7e11c09d --- /dev/null +++ b/v1.0.5/_sources/doc_pages/electrostatics.rst.txt @@ -0,0 +1,48 @@ +.. _electrostatics-label: + +Electrostatic interactions +########################## +In the filtered Hamiltonian hPF formalism :cite:`bore2020hamiltonian` the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle--mesh Ewald. + +The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered + +.. math:: + + \tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i), + +with :math:`q_i` being the charge of particle :math:`i` and :math:`H` is the +filtering function (see :ref:`filtering-label`). The value of the charge grid at +vertex :math:`(i,j,k)` is found by + +.. math:: + + \tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)] + +and the electrostatic potential :math:`\Psi_{ijk}` + +.. math:: + + \Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right], + +where :math:`k_\text{e}` is the Coulomb constant :math:`1/4\pi\varepsilon_0`. +The *electric field* is obtained by differentiation of the electrostatic +potential in Fourier space, + +.. math:: + + \mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)] + +from which the forces are interpolated back to the particle positions. + +Specifying electrostatics +^^^^^^^^^^^^^^^^^^^^^^^^^ +In HyMD, electrostatics are specified by the :code:`coulombtype` and +:code:`dielectric_const` keywords in the configuration file (see +:ref:`config-label`) and the :code:`/charge` dataset in the HDF5 format +structure/topology input file (see :ref:`topology-label`). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions. diff --git a/v1.0.5/_sources/doc_pages/examples.rst.txt b/v1.0.5/_sources/doc_pages/examples.rst.txt new file mode 100644 index 00000000..9f9c3655 --- /dev/null +++ b/v1.0.5/_sources/doc_pages/examples.rst.txt @@ -0,0 +1,621 @@ +.. _examples-label: + +Examples +######## +The following examples are ordered in *more or less* order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the `HyMD-tutorial`_ github repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Ideal gas +========= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true + :align: right + :width: 200 + +The simplest possible system is one with no interactions at all---intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like: + + +.. code-block:: toml + :caption: **ideal_gas.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = false # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + +A simple input structure/topology file :code:`ideal_gas.HDF5` is available in +the `HyMD-tutorial/ideal_gas`_ github repository (along with the code to +generate it). Run the (very) short simulation by + +.. code:: bash + + python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field \ + --velocity-output \ + --force-output + +with the :code:`--disable-field` argument to completely turn off all +particle--field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook `ideal_gas.ipynb`_ for details. + + +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas +.. _ideal_gas.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.ipynb + + +Ideal chains +============ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true + :align: right + :width: 200 + +The simplest available interaction is the harmonic two-particle bond (see +:ref:`bonds-label`), + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2. + +Extending the configuration file from the ideal gas case, we need to add a +:code:`bonds` specification. Note that the :code:`[bonds]` meta specifier is not +necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **ideal_chain.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + +A simple input structure/topology file :code:`ideal_chain.HDF5` with a few +coiled up ideal chain polymers is available in the +`HyMD-tutorial/ideal_chain`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field + +we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +`ideal_chain.ipynb`_. + + +.. _HyMD-tutorial/ideal_chain: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_chain +.. _ideal_chain.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/ideal_chain.ipynb + + +Stiff rods +========== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true + :align: right + :width: 200 + +Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the :code:`i--j--k` angle :math:`\theta` (see +:ref:`bonds-label`), + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2. + +Extending the configuration file from the ideal chain case, we need to add a +:code:`angle_bonds` specification. Note that the :code:`[bonds]` meta specifier +is not necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **rods.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + + angle_bonds = [ + ["A", "A", "A", 180.0, 100.0], # (i, j, k, equilibrium angle, strength) + ] + + +A simple input structure/topology file :code:`rods.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook `rods.ipynb`_. + + +.. _HyMD-tutorial/rods: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/rods +.. _rods.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.ipynb + + + +Helixes +======= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true + :align: right + :width: 200 + +Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle :math:`\phi` between the +:code:`i--j--k` plane and the :code:`j--k--l` plane (see :ref:`bonds-label`), + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n). + +The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a :code:`dihedrals` keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the :code:`dielectric_const` +keyword even though we are not including electrostatic forces in the current +simulation. Note that the :code:`[bonds]` meta specifier is not necessary, but +may be used to help organise the input file. + +.. code-block:: toml + :caption: **helixes.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + dielectric_const = 15.0 + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.31, 10000.0], # (i name, j name, equilibrium length, strength) + ] + + dihedrals = [ + [ + ["A", "A", "A", "A"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0] + ], + ] + +A simple input structure/topology file :code:`helixes.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook `helixes.ipynb`_. + + +.. _HyMD-tutorial/helixes: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/helixes +.. _helixes.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.ipynb + + +Phase separation +================ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true + :align: right + :width: 200 + +The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types :code:`A` and :code:`B`. Using the Hamiltonian + +.. math:: + + \mathcal{H}=H_0+W + +with :math:`\tilde\chi`--dependent interactions defined by (specified in the +configuration file by :code:`hamiltonian = DefaultWithChi`): + +.. math:: + + W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2. + + +.. code-block:: toml + :caption: **phase_separation.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + + [field] + mesh_size = [20, 20, 20] # FFT grid size + sigma = 1.0 # filtering length scale in nm + kappa = 0.05 # compressibility in mol/kJ + chi = [ + ['A', 'B', 5.0], # (name i, name j, strength) + ] + +A simple input structure/topology file :code:`phase_separation.HDF5` containing +an equal number of :code:`A` type and :code:`B` type particles is available in +the `HyMD-tutorial/phase_separation`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd phase_separation.toml phase_separation.HDF5 + +we may examine the resulting trajectory. In the case of a low interaction +strength :math:`\tilde\chi` of :code:`5.0` (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to :code:`40.0` (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +`phase_separation.ipynb`_. + + +.. _HyMD-tutorial/phase_separation: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/phase_separation +.. _phase_separation.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/phase_separation.ipynb + + +Diblock copolymers +================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true + :align: right + :width: 200 + +Having introduced particle--field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive :math:`\tilde\chi`--interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the :code:`integrator = "respa"` keyword. Putting the pieces together, the +configuration file may look like the following: + +.. code-block:: toml + :caption: **copolymer.toml** + + [simulation] + integrator = "respa" + respa_inner = 15 + n_steps = 2000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [10.0, 10.0, 10.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [50, 50, 50] # FFT grid size + sigma = 0.5 # filtering length scale in nm + chi = [ + ["A", "B", 30.0], # (i, j, strength) + ] + + [bonds] + bonds = [ + ["A", "A", 0.25, 1500.0], # (i, j, equilibrium length, strength) + ["A", "B", 0.25, 1500.0], + ["B", "B", 0.25, 1500.0], + ] + angle_bonds = [ + ["A", "A", "A", 180.0, 25.0], # (i, j, k, equilibrium angle, strength) + ["B", "B", "B", 180.0, 25.0], + ] + +A simple input structure/topology file :code:`copolymer.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/copolymer`_ github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten :code:`A` followed by ten :code:`B` type particles. +Running the simulation with + +.. code:: bash + + python3 -m hymd copolymer.toml copolymer.HDF5 + +the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +`copolymer.ipynb`_. + + +.. _HyMD-tutorial/copolymer: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/copolymer +.. _copolymer.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer.ipynb + + +Lipid bilayer self-assembly +=========================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true + :align: right + :width: 300 + +Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field--particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the :code:`thermostat_coupling_groups` keyword. With parameters +optimised in :cite:`ledum2020automated`, the configuration file looks like: + + +.. code-block:: toml + :caption: **lipid_self_assembly.toml** + + [simulation] + integrator = "respa" + respa_inner = 25 + n_steps = 3000 + n_print = 200 + n_flush = 1 + time_step = 0.01 + box_size = [9.96924, 9.96924, 10.03970] + start_temperature = 323 + target_temperature = 323 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.05 + domain_decomposition = 10001 + cancel_com_momentum = true + max_molecule_size = 15 + thermostat_coupling_groups = [ + ["N", "P", "G", "C"], + ["W"], + ] + + [field] + mesh_size = [25, 25, 25] + sigma = 1.0 + chi = [ + ["C", "W", 42.24], + ["G", "C", 10.47], + ["N", "W", -3.77], + ["G", "W", 4.53], + ["N", "P", -9.34], + ["P", "G", 8.04], + ["N", "G", 1.97], + ["P", "C", 14.72], + ["P", "W", -1.51], + ["N", "C", 13.56], + ] + + [bonds] + bonds = [ + ["N", "P", 0.47, 1250.0], + ["P", "G", 0.47, 1250.0], + ["G", "G", 0.37, 1250.0], + ["G", "C", 0.47, 1250.0], + ["C", "C", 0.47, 1250.0], + ] + angle_bonds = [ + ["P", "G", "G", 120.0, 25.0], + ["P", "G", "C", 180.0, 25.0], + ["G", "C", "C", 180.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +A randomly mixed input structure/topology file +:code:`lipid_self_assembly.HDF5` with a few hundred lipids in a roughy +:code:`10 x 10 x 10nm` box is available in the +`HyMD-tutorial/lipid_self_assembly`_ github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation + +.. code:: bash + + python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5 + +we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook `lipid_self_assembly.ipynb`_. + + +.. _HyMD-tutorial/lipid_self_assembly: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/lipid_self_assembly +.. _lipid_self_assembly.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/lipid_self_assembly.ipynb + + +Peptide in lipid bilayer +======================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true + :align: right + :width: 300 + +Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer. + + +The `configuration file`_ is available in the `HyMD-tutorial/peptide`_ github +repository (omitted here for brevity). + +A pre-equilibrated input structure/topology file :code:`peptide.HDF5` with a +few hundred lipids in a roughy :code:`20 x 20 x 20nm` box is available in the +`HyMD-tutorial/peptide`_ github repository. Running the simulation + +.. code:: bash + + python3 -m hymd peptide.toml peptide.HDF5 + +we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook `peptide.ipynb`_. + + +.. _HyMD-tutorial/peptide: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/peptide +.. _configuration file: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.toml +.. _peptide.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.ipynb + + +SDS +=== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true + :align: right + :width: 300 + +The last part we introduce is explicit electrostatic interactions through +particle--mesh Ewald. Enabling the electrostatic calculations is done via the +:code:`coulombtype` keyword. :code:`"PIC_Spectral"` is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the :code:`dielectric_const` keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge. + + + +.. code-block:: toml + :caption: **sds.toml** + + [simulation] + integrator = "respa" + respa_inner = 10 + n_steps = 3000 + n_print = 1500 + n_flush = + time_step = 0.01 + box_size = [8.3, 8.3, 8.3] + start_temperature = 298 + target_temperature = 298 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.1 + domain_decomposition = 10000 + cancel_com_momentum = true + max_molecule_size = 5 + thermostat_coupling_groups = [ + ["S", "C"], + ["W", "Na"], + ] + dielectric_const = 45.0 # dielectric constant for the simulation medium + coulombtype = "PIC_Spectral" # particle in cloud, spectral method + + [field] + mesh_size = [64, 64, 64] + sigma = 0.5 + chi = [ + ["S", "C", 13.50], + ["S", "Na", 0.00], + ["S", "W", -3.60], + ["C", "Na", 13.50], + ["C", "W", 33.75], + ["W", "Na", 0.00], + ] + + [bonds] + bonds = [ + ["S", "C", 0.50, 1250.0], + ["C", "C", 0.50, 1250.0], + ] + angle_bonds = [ + ["S", "C", "C", 170.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +An input structure/topology file :code:`sds.HDF5` with a couple thousand +randomly dispersed SDS chains is available in the `HyMD-tutorial/sds`_ github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a :code:`/charge` dataset. +Running the simulation with + +.. code:: bash + + python3 -m hymd sds.toml sds.HDF5 + +we observe the aggregation of the SDS into micellular structures---first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook `sds.ipynb`_. + + +.. _HyMD-tutorial/sds: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/sds +.. _sds.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/sds.ipynb diff --git a/v1.0.5/_sources/doc_pages/filtering.rst.txt b/v1.0.5/_sources/doc_pages/filtering.rst.txt new file mode 100644 index 00000000..02af68c6 --- /dev/null +++ b/v1.0.5/_sources/doc_pages/filtering.rst.txt @@ -0,0 +1,30 @@ +.. _filtering-label: + +Filtering +######### +The default grid-independent filter function used in HyMD is a Gaussian + +.. math:: + + H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] + +with reciprocal space representation + +.. math:: + + \hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +The coarse-graining parameter :math:`\sigma` determines a length scale of +particle extent and is given as configuration file input by + +.. code:: toml + + sigma = 0.75 + + +Implementing new filters +^^^^^^^^^^^^^^^^^^^^^^^^ +Implementing new filter functions is straightforward by hijacking +the :code:`setup` method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional. diff --git a/v1.0.5/_sources/doc_pages/installation.rst.txt b/v1.0.5/_sources/doc_pages/installation.rst.txt new file mode 100644 index 00000000..773eb2f4 --- /dev/null +++ b/v1.0.5/_sources/doc_pages/installation.rst.txt @@ -0,0 +1,162 @@ +.. _installation-label: + +Installation +############ +HyMD may be installed using :code:`pip` by + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + + +Dependencies +============ +HyMD **requires** a working MPI compiler and HDF5. On an Ubuntu system, this +may be installed via + +.. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y libhdf5-openmpi-dev python3-mpi4py + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-cache-dir --no-binary=h5py h5py + +It is **highly recommended** to have MPI-enabled HDF5 and h5py. A +non-MPI-enabled h5py may be installed by simply + +.. code-block:: bash + + sudo apt-get update -y + sudo apt-get install libhdf5-serial-dev + python3 -m pip --upgrade install h5py + +A non-MPI-enabled HDF5 library with corresponding :code:`h5py` will work +(mostly), but is inconvenient and slow. Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +:code:`--disable-mpio` argument to HyMD, see :ref:`commandline-label`. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial. + +Install in docker +================= +A docker image with build essentials setup is available at `dockerhub`_ with tag +:code:`mortele/hymd`, + +.. code-block:: bash + + docker pull mortele/hymd:latest + docker run -it mortele/hymd + /app$ python3 -m pip install hymd + + # Grab example input files + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5 + + # Run simulation + /app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose + +.. _dockerhub: + https://hub.docker.com/repository/docker/mortele/hymd + + +Run interactively in Google Colaboratory +======================================== +A `Google Colaboratory`_ jupyter notebook is setup `here`_ with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Common issues +============= + +Numpy errors while importing the Fortran force kernels +------------------------------------------------------ + +.. code-block:: python + + RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd + + Traceback (most recent call last): + + (...) + + File "/..../HyMD/hymd/__init__.py", line 2, in + from .main import main # noqa: F401 + File "/..../HyMD/hymd/main.py", line 10, in + from .configure_runtime import configure_runtime + File "/..../hymd/configure_runtime.py", line 12, in + from .input_parser import read_config_toml, parse_config_toml + File "/..../HyMD/hymd/input_parser.py", line 12, in + from .force import Bond, Angle, Dihedral, Chi + File "/..../HyMD/hymd/force.py", line 8, in + from force_kernels import ( # noqa: F401 + ImportError: numpy.core.multiarray failed to import + +can normally be fixed by updating numpy versions, + +.. code-block:: bash + + python3 -m pip install -U numpy + + +Error building pfft-python due to missing curl/wget +--------------------------------------------------- + +.. code-block:: python + + Building wheel for pfft-python (setup.py) ... error + ERROR: Command errored out with exit status 1: + command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_ + cwd: /tmp/pip-install-fr6nt9m4/pfft-python/ + Complete output (56 lines): + running bdist_wheel + running build + running build_py + + (...) + + curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found + wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found + Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + Please check curl or wget + You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ + Traceback (most recent call last): + File "", line 1, in + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in + setup( + File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup + return distutils.core.setup(**attrs) + File "/usr/lib/python3.8/distutils/core.py", line 148, in setup + + (...) + + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions + build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:])) + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft + raise ValueError("could not build fftw; check MPICC?") + ValueError: could not build fftw; check MPICC? + ---------------------------------------- + ERROR: Failed building wheel for pfft-python + Running setup.py clean for pfft-python + Failed to build pfft-python + +can be fixed by installing either `curl`_ or `wget`_ + +.. code-block:: bash + + apt-get install -y curl wget + + +.. _`curl`: + https://curl.se/ + +.. _`wget`: + https://www.gnu.org/software/wget/ diff --git a/v1.0.5/_sources/doc_pages/interaction_energy_functionals.rst.txt b/v1.0.5/_sources/doc_pages/interaction_energy_functionals.rst.txt new file mode 100644 index 00000000..f33c004e --- /dev/null +++ b/v1.0.5/_sources/doc_pages/interaction_energy_functionals.rst.txt @@ -0,0 +1,98 @@ +.. _functionals-label: + +Interaction energy functionals +############################## +A few interaction energy functionals :math:`W` are defined in HyMD through +the :code:`Hamiltonian` class and associated subclasses. + +:math:`\chi`--interaction and :math:`\kappa`--incompressibility +=============================================================== +The most common hPF energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultWithChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where :math:`\tilde\chi_{\text{A}-\text{B}}` is the interaction energy between +overlapping densities of particle types :math:`\text{A}` and :math:`\text{B}`. +The incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\tilde\chi` +and :math:`\kappa` in the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + chi = [ + ["A", "B", 15.85], + ["B", "C", -5.70], + ... + ] + +Only :math:`\kappa`--incompressibility +====================================== +The only :math:`\kappa` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultNoChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where the incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Only :math:`\phi^2` +=================== +The :math:`\phi^2` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "SquaredPhi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2, + +where the :math:`\phi` squared term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Implementing new interaction energy forms +========================================= +Implementing new interaction energy functions is straightforward by subclassing +:code:`Hamiltonian` and applying :code:`sympy` differentiation to the symbolic +field objects. The :code:`sympy.lamdify` function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields. diff --git a/v1.0.5/_sources/doc_pages/intramolecular_bonds.rst.txt b/v1.0.5/_sources/doc_pages/intramolecular_bonds.rst.txt new file mode 100644 index 00000000..820e81bc --- /dev/null +++ b/v1.0.5/_sources/doc_pages/intramolecular_bonds.rst.txt @@ -0,0 +1,142 @@ +.. _bonds-label: + +Intramolecular bonds +#################### + +Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see :ref:`config-label`. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +:ref:`benchmarks-label`), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable. + +All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]). + + +Two-particle bonds +^^^^^^^^^^^^^^^^^^ +Stretching bonds in HyMD are implemented as harmonic spring potentials, + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2, + +where :math:`r=|\mathbf{r}|` is the inter-particle distance, :math:`k` is a +constant of dimension energy (units :math:`\text{kJ}\,\text{mol}^{-1}`), and +:math:`r_0` is the equilibrum length of the bond (units: :math:`\text{nm}`). The +force is calculated as + +.. math:: + + F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r}, + +where :math:`\mathbf{r}` is the vector pointing *from* :math:`i` *to* :math:`j`. + +In the configuration file, two-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_two_particle_example.toml + + [bonds] + bonds = [ + ["A", "A", 0.47, 1250.0], + ["A", "B", 0.37, 940.0], + ["B", "C", 0.50, 1010.0], + ["C", "A", 0.42, 550.0], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Three-particle bonds +^^^^^^^^^^^^^^^^^^^^ +Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle--particle--particle angle :math:`\theta`, + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2, + +where :math:`k` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}`), and :math:`\theta_0` is the equilibrum +angle of the bond (units: :math:`{}^\circ`). Defining the particles with labels +:math:`a`, :math:`b`, and :math:`c`, let :math:`\mathbf{r}_a` denote the vector +pointing from :math:`b` to :math:`a`, and correspondingly let +:math:`\mathbf{r}_c` point from :math:`b` to :math:`c`. The +:math:`a`--:math:`b`--:math:`c` may be computed through the law of Cosines, + +.. math:: + + \theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right] + +Then the force acting on :math:`a` and :math:`c` is + +.. math:: + + \mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a}, + + \mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c}, + +and + +.. math:: + + \mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c + +In the configuration file, three-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_three_particle_example.toml + + [bonds] + angle_bonds = [ + ["A", "A", "A", 180.0, 90.0], + ["A", "B", "A", 120.0, 55.0], + ["B", "C", "C", 30.0, 10.0], + ["C", "A", "B", 110.0, 25.5], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Four-particle bonds +^^^^^^^^^^^^^^^^^^^ +Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle :math:`\phi` between the +:math:`a`--:math:`b`--:math:`c` and :math:`b`--:math:`c`--:math:`d` planes, for +a dihedral bond quartet :math:`a`, :math:`b`, :math:`c`, and :math:`d`. The +potential takes the form + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n), + +where :math:`c_n` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`), and :math:`\phi_n` are +specified phase angles in the cosine series. + +In the configuration file, four-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_four_particle_example.toml + + [bonds] + dihedrals = [ + ["A", "B", "C", "D"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0], + ] diff --git a/v1.0.5/_sources/doc_pages/overview.rst.txt b/v1.0.5/_sources/doc_pages/overview.rst.txt new file mode 100644 index 00000000..0e4d6b65 --- /dev/null +++ b/v1.0.5/_sources/doc_pages/overview.rst.txt @@ -0,0 +1,166 @@ +.. _overview-label: + +================================ + Usage overview for HylleraasMD +================================ + +HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a `toml`_ format configuration file, along with a topology and structure +file specifying the input system in HDF5 format. + +.. _`toml`: + https://github.com/toml-lang/toml + +**Configuration file** + +The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a :code:`[5, 5, 5]` nm simulation box at 300 K may look like +the following: + +.. code-block:: toml + :caption: **config_simple_1.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "SquaredPhi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [30, 30, 30] # FFT grid size + sigma = 0.5 # filtering length scale in nm + +Note that for the version 1.0 release of HyMD, the :code:`[particles]`, +:code:`[simulation]`, and :code:`[field]` groups are optional specifiers for +structuring the configuration file. + +For a full specification of every recognised configuration keyword in HyMD, +please refer to :ref:`config-label`. + +**Topology and structure file** + +The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +:code:`N` particles may look like the following: + +.. code-block:: bash + :caption: **example_structure.HDF5** + + group / + # root group + + dataset /coordinates + # float32, shape (T, N, D,) + # Time steps of N rows of D dimensional coordinate data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /velocities + # float32, shape (T, N, D,) OPTIONAL + # Time steps of N rows of D dimensional velocity data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /bonds + # int32, shape (N, B,) OPTIONAL + # Each row i contains indices of the particles bonds from/to i + # B denotes the maximum bonds per particle + + dataset /indices + # int32, shape (N,) + # Index of each particle, 0--(N-1) + + dataset /molecules + # int32, shape (N,) + # Index of molecule each particle belongs to + # Used to construct bond network locally on MPI ranks + + dataset /names + # str10, shape (N,) + # Fixed size string array containing particle type names + + dataset /types + # int32, shape (N,) OPTIONAL + # Mapping of particle names to type indices + + +For a full specification of the topology and structure input file, see +:ref:`topology-label`. + +**Command line arguments** + +A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the :code:`config_simple_1.toml` and :code:`example_structure.HDF5` +files may look like the following: + +.. code-block:: bash + + mpirun -n ${MPI_NUM_RANKS} python3 -m hymd \ # HyMD executable + config_simple_1.toml \ # configuration file + example_structure.HDF5 \ # structure file + --logfile=log_out.txt \ # set logfile path + --seed 123456 \ # set random seed + --verbose 2 \ # set logging verbosity + --velocity-output # enable velocity in trajectory output + +For a full specification of all command line arguments, see +:ref:`commandline-label`. + +**More examples** + +For more thorough rundown and concrete usage examples, see +:ref:`examples-label`. + +Running parallel simulations +============================ +Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the **only** difference being how the python3 interpreter is +invoked. Prepending :code:`mpirun -n ${NPROCS}` to the usual +:code:`python3 -m hymd` runs the simulation with :code:`${NPROCS}` MPI ranks. + +Inputting + +.. code:: bash + + mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field + +sets up an example simulation of the `HyMD-tutorial/ideal_gas`_ system. For +more details about this system in particular, or other example simulations, see +the `HyMD-tutorial`_ repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas + + +Running tests +============= +Run serial code tests by + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd + cd hymd/ + python3 -m pip install pytest pytest-mpi + python3 -m pytest + +There is a small convenience script in :code:`hymd/` for running the MPI-enabled +tests, + +.. code-block:: bash + + chmod +x pytest-mpi + ./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no diff --git a/v1.0.5/_sources/doc_pages/theory.rst.txt b/v1.0.5/_sources/doc_pages/theory.rst.txt new file mode 100644 index 00000000..95d7842c --- /dev/null +++ b/v1.0.5/_sources/doc_pages/theory.rst.txt @@ -0,0 +1,114 @@ +.. _theory-label: + +Theory +###### +Hybrid particle--field simulations switch out the ordinary particle--particle +`Lennard-Jones`_ interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle--field densities are +defined as + +.. math:: + + \phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i), + +where :math:`\mathbf{r}` is a spatial coordinate, :math:`P` is a window function +used to distribute particle number densities onto a computational grid, and +:math:`\mathbf{r}_i` is the position of particle :math:`i` (of total :math:`N`). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of :math:`N` particles in :math:`M` molecules is + +.. math:: + + \mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})] + +with :math:`H_0` being a standard intramolecular Hamiltonian form (see +:ref:`bonds-label`) including kinetic terms, while :math:`W` is a density +dependent *interaction energy functional*. + +In the Hamiltonian hPF-MD formalism :cite:`bore2020hamiltonian`, the density +field is filtered using a grid-independent filtering function :math:`H`, + +.. math:: + + \tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}). + +The filter smooths the density, ensuring that :math:`\tilde\phi` and +:math:`W[\tilde\phi([\phi])]` both converge as the grid size is reduced. + +External potential +================== +The external potential acting on a particle is defined as the functional +derivative of :math:`W` with respect to :math:`\phi`. In the filtered formalism, +the potential takes the form + +.. math:: + + V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ + &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})}, + +under the assumption of a *local* form of the interaction energy functional, +:math:`W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]`. Note +that + +.. math:: + + \frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}). + +Force interpolation +=================== +The forces on particle :math:`i` are obtained by differentiation of the external +potential, + +.. math:: + + \mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i). + + +Reciprocal space calculations +============================= +The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density :math:`\phi_{ijk}` with CIC, we apply the filtering +and obtain the discrete version of the external potential by + +.. math:: + + \tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big] + +and + +.. math:: + + V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +The forces are obtained by differentiation of :math:`V` in Fourier space as + +.. math:: + + \nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +Filter +====== +By default, the filter used in HyMD is a simple Gaussian of the form + +.. math:: + + H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ + \hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +For more details about the filtering, see :ref:`filtering-label`. + +Hamiltonian form +================ +The default form of the interaction energy functional in HyMD is + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2. + +See :ref:`functionals-label` for details. + + +.. _`Lennard-Jones`: + https://en.wikipedia.org/wiki/Lennard-Jones_potential diff --git a/v1.0.5/_sources/doc_pages/topology_input.rst.txt b/v1.0.5/_sources/doc_pages/topology_input.rst.txt new file mode 100644 index 00000000..adabe129 --- /dev/null +++ b/v1.0.5/_sources/doc_pages/topology_input.rst.txt @@ -0,0 +1,77 @@ +.. _topology-label: + +============================ +Topology and structure file +============================ +The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root :code:`/` group. + +The `HyMD-tutorial`_ has multiple examples of structure files for various levels +of complexity. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Required datasets +================= +:/coordinates: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/indices: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/names: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`string` (:code:`length` between :code:`1` and :code:`16`)] + + The shape represents one particle name per :code:`N` particles. The datatype may be a string of length :code:`=<16`. + + + +Optional datasets +================= +:/velocities: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/types: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle type index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/molecules: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one molecule index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/bonds: + :code:`array` shape [:code:`N`, :code:`B`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents :code:`B` bond specifications (indices of different particles) per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/charge: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents one particle charge per :code:`N` particles. The data type may be either four or eight byte reals. diff --git a/v1.0.5/_sources/index.rst.txt b/v1.0.5/_sources/index.rst.txt new file mode 100644 index 00000000..ff4059ba --- /dev/null +++ b/v1.0.5/_sources/index.rst.txt @@ -0,0 +1,168 @@ +.. hymd documentation master file, created by + sphinx-quickstart on Thu Dec 16 13:31:43 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +############################### +HylleraasMD documentation +############################### + +:Release: + |release| +:Date: + |today| + +**HylleraasMD** (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems. + +HyMD can run canonical hPF-MD simulations :cite:`Milano2009JCP`, or filtered +density Hamiltonian hPF (HhPF-MD) simulations :cite:`bore2020hamiltonian`, with +or without explicit PME electrostatic interactions :cite:`kolli2018JCTC`. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +:cite:`Cascella2008,bore2018hybrid`. Martini +style elastic networks (ElNeDyn) :cite:`periole2009combining` are also +supported. + +HyMD uses the pmesh (`github.com/rainwoodman/pmesh`_) library for particle-mesh +operations, with the PPFT :cite:`pippig2013pfft` backend for FFTs through the +pfft-python bindings (`github.com/rainwoodman/pfft-python`_). File IO is done +via HDF5 formats to allow MPI parallel reads. + +User Guide +========== +The HylleraasMD :doc:`User Guide ` provides comprehensive information on how to run +simulations. Selected :doc:`Examples ` are available to guide new users. + +.. _`github.com/rainwoodman/pmesh`: + https://github.com/rainwoodman/pmesh +.. _`github.com/rainwoodman/pfft-python`: + https://github.com/rainwoodman/pfft-python + +Installing HyMD +=============== +The easiest approach is to install using pip_: + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + +For more information and **required dependencies**, see +:ref:`installation-label`. + +.. _pip: + http://www.pip-installer.org/en/latest/index.html + + +Run in Google colab +------------------- +Run HyMD interactively in `Google Colaboratory`_ jupyter notebook `here`_. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Source Code +=========== +**Source code** is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the `GNU Lesser General Public +License v3.0`_. Obtain the source code with `git`_: + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git + +.. _GNU Lesser General Public License v3.0: + https://www.gnu.org/licenses/lgpl-3.0.html +.. _git: + https://git-scm.com/ + + +Development +=========== +HyMD is developed and maintained by researchers at the `Hylleraas Centre for +Quantum Molecular Sciences`_ at the `University of Oslo`_. + +|pic1| |pic2| + +.. _`Hylleraas Centre for Quantum Molecular Sciences`: + https://www.mn.uio.no/hylleraas/english/ +.. _`University of Oslo`: + https://www.uio.no/ + +.. |pic1| image:: img/hylleraas_centre_logo_black.png + :target: img/hylleraas_centre_logo_black.png + :width: 250 px + +.. |pic2| image:: img/uio_full_logo_eng_pos.png + :target: img/uio_full_logo_eng_pos.png + :width: 325 px + + + +References +========== +.. bibliography:: + :all: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. Contents +.. ======== + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Getting started + + ./doc_pages/installation + ./doc_pages/overview + ./doc_pages/config_file + ./doc_pages/topology_input + ./doc_pages/command_line + ./doc_pages/constants_and_units + + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Examples + + ./doc_pages/examples + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Theory + + ./doc_pages/theory + ./doc_pages/intramolecular_bonds + ./doc_pages/electrostatics + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Developer documentation + + ./doc_pages/interaction_energy_functionals + ./doc_pages/filtering + ./doc_pages/benchmarks + ./doc_pages/api diff --git a/v1.0.5/_static/basic.css b/v1.0.5/_static/basic.css new file mode 100644 index 00000000..be19270e --- /dev/null +++ b/v1.0.5/_static/basic.css @@ -0,0 +1,856 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/v1.0.5/_static/css/badge_only.css b/v1.0.5/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/v1.0.5/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/v1.0.5/_static/css/fonts/Roboto-Slab-Bold.woff b/v1.0.5/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/v1.0.5/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/v1.0.5/_static/css/fonts/Roboto-Slab-Bold.woff2 b/v1.0.5/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/v1.0.5/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/v1.0.5/_static/css/fonts/Roboto-Slab-Regular.woff b/v1.0.5/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/v1.0.5/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/v1.0.5/_static/css/fonts/Roboto-Slab-Regular.woff2 b/v1.0.5/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/v1.0.5/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/v1.0.5/_static/css/fonts/fontawesome-webfont.eot b/v1.0.5/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/v1.0.5/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/v1.0.5/_static/css/fonts/fontawesome-webfont.svg b/v1.0.5/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/v1.0.5/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v1.0.5/_static/css/fonts/fontawesome-webfont.ttf b/v1.0.5/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/v1.0.5/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/v1.0.5/_static/css/fonts/fontawesome-webfont.woff b/v1.0.5/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/v1.0.5/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/v1.0.5/_static/css/fonts/fontawesome-webfont.woff2 b/v1.0.5/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/v1.0.5/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/v1.0.5/_static/css/fonts/lato-bold-italic.woff b/v1.0.5/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/v1.0.5/_static/css/fonts/lato-bold-italic.woff differ diff --git a/v1.0.5/_static/css/fonts/lato-bold-italic.woff2 b/v1.0.5/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/v1.0.5/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/v1.0.5/_static/css/fonts/lato-bold.woff b/v1.0.5/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/v1.0.5/_static/css/fonts/lato-bold.woff differ diff --git a/v1.0.5/_static/css/fonts/lato-bold.woff2 b/v1.0.5/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/v1.0.5/_static/css/fonts/lato-bold.woff2 differ diff --git a/v1.0.5/_static/css/fonts/lato-normal-italic.woff b/v1.0.5/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/v1.0.5/_static/css/fonts/lato-normal-italic.woff differ diff --git a/v1.0.5/_static/css/fonts/lato-normal-italic.woff2 b/v1.0.5/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/v1.0.5/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/v1.0.5/_static/css/fonts/lato-normal.woff b/v1.0.5/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/v1.0.5/_static/css/fonts/lato-normal.woff differ diff --git a/v1.0.5/_static/css/fonts/lato-normal.woff2 b/v1.0.5/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/v1.0.5/_static/css/fonts/lato-normal.woff2 differ diff --git a/v1.0.5/_static/css/theme.css b/v1.0.5/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/v1.0.5/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/v1.0.5/_static/custom.css b/v1.0.5/_static/custom.css new file mode 100644 index 00000000..b20d6282 --- /dev/null +++ b/v1.0.5/_static/custom.css @@ -0,0 +1,91 @@ + +body{ + background: #FFFFFF !important; +} + +.wy-menu-vertical header, .wy-menu-vertical p.caption{ + color: #4EA0AF!important; +} +.wy-menu-vertical li.current{ + background-color: #f4f4f4!important; +} +.wy-menu-vertical li.toctree-l2.current>a{ + background-color: #ebebeb!important; +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{ + background-color: #e3e3e3!important; +} + +.rst-content .sidebar{ + background-color: #fff!important; + border-radius: 6px; + -moz-border-radius: 6px; + -webkit-border-radius: 6px; +} + +h1 > a, h2 > a, h3 > a, h4 > a, h5 > a, h6 > a { + color: #17d9ff; +} + +h1, h2, h3, h4, h5, h6 { + color: black; + font-weight: normal; + padding: 0; +} + +h1, h2, h3 { + margin-top: 30px; + margin-bottom: 20px; +} + +h1 { + color: white; + padding: 20px 20px 20px 45px; + margin: 20px 0 35px -45px; + background: linear-gradient(to left, #fff, #2b38ff)!important; + + width: calc(100% + 90px); + border-bottom: 3px solid #000; +} + +h2 { + padding: .2em 0; + border-bottom: 1px solid #ddd; +} + +h3 { + margin-top: 35px; +} + +h4 { + margin-top: 30px; +} + +h5 { + margin-top: 25px; +} + +.wy-nav-content{ + max-width: none!important; +} + +.wy-side-nav-search{ + background: #2b38ff!important; +} + +.wy-side-nav-search input[type=text]{ + border-color:#4DA0B0!important; +} + +.wy-side-nav-search input[type=text]{ + border-radius: 4px!important; +} + +#caption-api { + background: red !important; +} + +#caption-text-api { + text-color: blue !important; +} diff --git a/v1.0.5/_static/doctools.js b/v1.0.5/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/v1.0.5/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/v1.0.5/_static/documentation_options.js b/v1.0.5/_static/documentation_options.js new file mode 100644 index 00000000..8314691c --- /dev/null +++ b/v1.0.5/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '1.0.5', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/v1.0.5/_static/file.png b/v1.0.5/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/v1.0.5/_static/file.png differ diff --git a/v1.0.5/_static/hymd_icon_white.png b/v1.0.5/_static/hymd_icon_white.png new file mode 100644 index 00000000..d0396a17 Binary files /dev/null and b/v1.0.5/_static/hymd_icon_white.png differ diff --git a/v1.0.5/_static/hymd_logl_white_text_abbr.png b/v1.0.5/_static/hymd_logl_white_text_abbr.png new file mode 100644 index 00000000..8c0e50c8 Binary files /dev/null and b/v1.0.5/_static/hymd_logl_white_text_abbr.png differ diff --git a/v1.0.5/_static/jquery-3.5.1.js b/v1.0.5/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/v1.0.5/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. API reference

+
+

4.1. Integrator

+

Integrates equations of motion.

+

Implements the Velocity Verlet integrator. The reversible reference system +propagator algorithm (rRESPA) integrator uses the Velocity Verlet functions +inside the MD loop in the main module.

+
+
+hymd.integrator.integrate_position(positions, velocities, time_step)[source]
+

Position update step of the Velocity Verlet integration algorithm.

+

Computes the position update step of the Velocity Verlet algorithm. The +positions argument is not changed in place.

+
+
Parameters:
+
+
positions(N, D) numpy.ndarray

Array of positions of N particles in D dimensions.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_velocity

The velocity update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step, then the positions are updated a full step using the updated +velocities

+
+\[\mathbf{x}_{\text{new}} = \mathbf{x} + \Delta t \mathbf{v}\]
+
+ +
+
+hymd.integrator.integrate_velocity(velocities, accelerations, time_step)[source]
+

Velocity update step of the Velocity Verlet integration algorithm.

+

Computes the velocity update step of the Velocity Verlet algorithm. The +velocities argument is not changed in place.

+
+
Parameters:
+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
accelerations(N, D) numpy.ndarray

Array of accelerations of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_position

The position update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step

+
+\[\mathbf{v}_{\text{new}} = \mathbf{v} + \frac{\Delta t}{2m} +\mathbf{f}\]
+

before the positions are moved a full step using the updated half-step +velocities.

+
+ +
+
+

4.2. Thermostat

+

Scales or otherwise modifies the particle velocities during simulation to +simulate coupling to an external heat bath with temperature T₀.

+
+
+hymd.thermostat._random_chi_squared(prng: numpy.random._generator.Generator, M: int)float[source]
+

Draw the sum of M squared normally distributed values

+

The value is generated by the Gamma distribution, in lieu of generating +M Gaussian distributed numbers and summing their squares.

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
Mint

Number of standard normally distributed numbers in the sum.

+
+
+
+
Returns:
+
+
float

The sum of M squared normally distributed values centered at +zero with unit standard deviation.

+
+
+
+
+

Notes

+

The sum of the squares of k independent standard normal random variables is +distributed according to a \(\chi^2\) distribution.

+
+\[\chi^2_1 + \chi_2^2 + \chi_3^2 + \dots + \chi_M^2 +\sim +\sigma^2\chi^2(k)\]
+

This is a special case of the \(\Gamma\) distribution, +\(\Gamma(k/2, 2)\), and may be generated by

+
+\[\chi^2(k) \sim 2 \Gamma(k/2, 2)\]
+

References

+

Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of +Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. +J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246.

+
+ +
+
+hymd.thermostat._random_gaussian(prng: numpy.random._generator.Generator)float[source]
+

Draw a single random number from the standard normal distribution +Generate a number from the Gaussian distribution centered at zero with unit +standard deviation, \(N(0, 1)\).

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
+
+
Returns:
+
+
float

A random number drawn from \(N(0, 1)\).

+
+
+
+
+
+ +
+
+hymd.thermostat.csvr_thermostat(velocity: numpy.ndarray, names: numpy.ndarray, config: hymd.input_parser.Config, prng: numpy.random._generator.Generator, comm: mpi4py.MPI.Intracomm = <mpi4py.MPI.Intracomm object>, random_gaussian: Callable[[numpy.random._generator.Generator], float] = <function _random_gaussian>, random_chi_squared: Callable[[numpy.random._generator.Generator, int, float], float] = <function _random_chi_squared>, remove_center_of_mass_momentum: bool = True)numpy.ndarray[source]
+

Canonical sampling through velocity rescaling thermostat

+

Implements the CSVR thermostat. Rescales the system kinetic energy by a +stochastically chosen factor to keep the temperature constant. Requires +communcation of the kinetic energies calculated locally for each MPI rank. +The random numbers sampled through random_gaussian and +random_chi_squared are broadcast from the root rank to the other +ranks to ensure the scaling is performed with the same stochasticity for +all particles in the full system.

+

The velocities are cleaned of center of mass momentum before the thermostat +is applied, and the center of mass momentum is subsequently reapplied. This +is performed for each thermostat coupling group, i.e. the center of mass +momenta of each group is separately removed and reapplied after +thermostatting.

+

The implementation here is based on the derivation presented in the 2008 +Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper.

+
+
Parameters:
+
+
velocity(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
names(N,) numpy.ndarray

Array of particle names.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
random_gaussiancallable, optional

Function for generating standard normally distributed numbers.

+
+
random_chi_squaredcallable, optional

Function for generating \(\chi^2\)-distributed numbers

+
+
remove_center_of_mass_momentumbool, optional

If True, the center of mass of each coupling group is removed before +the thermostat is applied. The center of mass momenta are added back +after the kinetic energy rescaling is complete.

+
+
+
+
+
+

See also

+
+
_random_gaussian

Used to sample Gaussian-distributed numbers.

+
+
_random_chi_squared

Used to sample \(\chi^2\)-distributed numbers.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +

References

+

G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). +G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008).

+
+ +
+
+

4.3. Hamiltonian

+
+
+class hymd.hamiltonian.Hamiltonian(config)[source]
+

Interaction energy functional superclass

+
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+_setup()[source]
+

Superclass setup

+

Sets up the grid-independent filtering function H, and the +SymPy logic for symbolically differentiating interaction energy +functionals in Hamiltonian subclasses.

+
+ +
+ +
+
+class hymd.hamiltonian.SquaredPhi(config)[source]
+

Simple squared density interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + \sum_k \tilde\phi_k + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(rho_0\) is the +average density of the fully homogenous system. Expressing the species +densities in terms of fluctuations from the average,

+
+\[\mathrm{d}\tilde\phi_k = \rho_0 - \tilde\phi_k,\]
+

it is evident that this interaction energy functional is a slight change of +the DefaultNoChi Hamiltonian, as the expanded interaction energy +density becomes

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + 6\rho_0\left[ + \sum_k \mathrm{d}\tilde\phi_k + \right] + + + 9\rho_0^2 + + + \sum_k \mathrm{d}\tilde\phi_k^2 + + + \prod_{k\not=l} + \mathrm{d}\tilde\phi_k \mathrm{d}\tilde\phi_l + \right),\]
+

identical to DefaultNoChi apart from a constant energy shift +\(9\rho_0^2`(which does not impact dynamics) and the +:math:\)rho_0`–\(\mathrm{d}\tilde\phi_k\) cross-terms. These +cross-terms constitute contributions to the energy linear in +\(\mathrm{d}\tilde\phi_k\) absent in DefaultNoChi, which has +only quadratic terms present.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultNoChi(config)[source]
+

Incompressibility-only interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a +\right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. The SquaredPhi Hamiltonian implements a similar +functional with an additional linear term component depending on

+
+\[\mathmr{d}\tilde\phi_k = \tilde\phi_k - \rho_0\]
+

and not \(\mathrm{d}\tilde\phi_k^2\). No explicit inter-species +interaction is present apart from the indirect interaction through the +incompressibility.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultWithChi(config, unique_names, type_to_name_map)[source]
+

Incompressibility and \(\chi\)-interactions energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = + \frac{1}{2\rho_0} + \sum_{k,l}\chi_{kl} \tilde\phi_k \tilde\phi_l + + + \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. \(\chi_{ij}\) is the Flory-Huggins-like +inter-species mixing energy.

+
+
+__init__(config, unique_names, type_to_name_map)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup(unique_names, type_to_name_map)[source]
+

Setup the interaction energy potential and the external potential

+
+
Parameters:
+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+ +
+ +
+
+

4.4. Force

+

Calculates intramolecular forces between bonded particles in molecules

+
+
+class hymd.force.Angle(atom_1: str, atom_2: str, equilibrium: float, strength: float, atom_3: str)[source]
+

Dataclass representing a single three-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any three-particle bond between particles of specific types A, +B, and C (where A, B, and C may be +different or the same). Harmonic angular three-particle bonds in HyMD take +the form

+
+\[V_3(\mathbf{r}_1, \mathbf{r}_2, \mathbf{r}_3) = + \frac{1}{2}k + \left( + \cos^{-1} + \left[ + \frac{ + (\mathbf{r}_1-\mathbf{r}_2) + \cdot + (\mathbf{r}_3-\mathbf{r}_2) + } + { + \vert\mathbf{r}_1-\mathbf{r}_2\vert + \vert\mathbf{r}_3-\mathbf{r}_2\vert + } + \right] - \theta_0 + \right)^2\]
+
+

See also

+
+
Bond

Two-particle bond type dataclass

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
equilibriumfloat

Equilibrium angle at which the energy associated with the +three-particle angular bond vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient.

+
+
+
+
+
+
+atom_3: str
+
+ +
+ +
+
+class hymd.force.Bond(atom_1: str, atom_2: str, equilibrium: float, strength: float)[source]
+

Dataclass representing a single two-particle bond type

+

A bond type is a bond strength and equilibrium distance associated with +any bond between particles of specific types A and B +(where A and B may be the same or different). Harmonic +two-particle bonds in HyMD take the form

+
+\[V_2(\mathbf{r}_1, \mathbf{r}_2) = + \frac{1}{2}k + \left( + \vert \mathbf{r}_1 - \mathbf{r}_2 \vert - r_0 + \right)^2,\]
+

where \(k\) is the bond strength (spring constant) and \(r_0\) is +the equilibrium bond length (at which the energy is zero).

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
equilibriumfloat

Equilibrium distance at which the energy associated with the bond +vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient (spring constant).

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+equilibrium: float
+
+ +
+
+strength: float
+
+ +
+ +
+
+class hymd.force.Chi(atom_1: str, atom_2: str, interaction_energy: float)[source]
+

Dataclass representing a single \(\chi\) mixing interaction type

+

An interaction mixing energy type is a mixing energy associated with +density overlap between species of types A and B +(specified as inputs atom_1 and atom_2). A positive mixing +energy promotes phase separation, a negative mixing energy promotes mixing. +The interaction energy density (provided the DefaultWithChi +Hamiltonian is used) takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} + \sum_{k,l}\chi_{k,l} \tilde\phi_k\tilde\phi_l,\]
+

where \(\chi_{k,l}\) denotes the mixing energy between species +\(k\) and \(l\), with \(\kappa\) being the incompressibility. +The value of the interaction mixing energy parameter may be extracted from +Flory-Huggins theory.

+
+

See also

+
+
hymd.hamiltonian.DefaultWithChi

Interaction energy functional using \(\chi\)-interactions.

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
interaction_energyfloat

Interaction mixing energy.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+interaction_energy: float
+
+ +
+ +
+
+class hymd.force.Dielectric_type(atom_1: str, dielectric_value: float)[source]
+
+
+atom_1: str
+
+ +
+
+dielectric_value: float
+
+ +
+ +
+
+class hymd.force.Dihedral(atom_1: str, atom_2: str, atom_3: str, atom_4: str, coeffs: numpy.ndarray, dih_type: int)[source]
+

Dataclass representing a single four-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any four-particle torsional bond between particles of specific types +A, B, C, and D (where A, B, +C, and D may be different or the same). Dihedral +four-particle bonds in HyMD take different forms depending on the +dih_type parameter.

+

In the following, let \(\phi\) denote the angle between the planes +spanned by the relative positions of atoms A-B-C +and B-C-D. If dih_type = 0, then

+
+\[V_4(\phi) = \sum_n c_n + \left( + 1 + \cos\left[ + n\phi - d_n + \right] + \right),\]
+

where \(c_n\) are energy coefficients and \(d_n\) are propensity +phases. By default, the cosine sum is truncated at five terms. If +coeffs provides only a single float, this is used as the coiling +propensity parameter \(\lambda\). In this case, \(c_n\) and +\(d_n\) are automatically set to values which promote alpha helical +(\(\lambda=-1\)), beta sheet (\(\lambda=1\)), or a mixed +(\(1>\lambda>-1\)) structure (using values provided by Bore et al. +(2018)). In this case, the full potential takes the form

+
+\[V_4(\phi;\lambda) = + \frac{1}{2}(1-\lambda) V_{\text{prop},\alpha}(\phi) + + + \frac{1}{2}(1+\lambda) V_{\text{prop},\beta}(\phi) + + + (1-\vert\lambda\vert) V_{\text{prop}, \text{coil}}(\phi),\]
+

with each of the \(V_{\mathrm{prop}, X}\) being fixed cosine series +potentials with pre-set \(c_n\) -s and \(d_n\) -s.

+

If dih_type = 1, then a combined bending torsional (CBT) potential +is employed,

+
+\[V_4(\phi,\gamma;\lambda) = + V_4(\phi;\lambda) + + + \frac{1}{2}K(\phi)(\gamma - \gamma_0)^2,\]
+

where \(V_4(\phi;\lambda)\) specifies the potential as given by the +coiling propensity parameter above, \(K(\phi)\) is a separate cosine +series potential acting as the angular three-particle bond strength, and +\(\gamma_0\) is the three-particle bond equilibrium angle. In this +case, the coeffs parameter must specify both a \(\lambda\) +value, in additon to the energy and phases dictating the \(K(\phi)\) +potential.

+

References

+

Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018.

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
atom_4str

Type name of particle 4.

+
+
coeffslist[list[float]] or list[float] or numpy.ndarray

Dihedral coefficients defining the series expansion of the dihedral +energy.

+
+
dih_typeint

Specifies the type of dihedral used; If 0, then coeffs +must contain either two lists of five energy coefficients +\(c_n\) and five propensity phases \(d_n\) or a single +floating point number defining the \(\lambda\) coiling propensity +parameter. If 1, the combined bending-torsional potential is +used, and coeffs must specify \(\lambda\) and two lists +containing energy coefficients and propensity phases for the +\(V_\text{prop}\) propensity potential, defined in terms of cosine +series.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+atom_3: str
+
+ +
+
+atom_4: str
+
+ +
+
+coeffs: numpy.ndarray
+
+ +
+
+dih_type: int
+
+ +
+ +
+
+hymd.force.compute_angle_forces__plain(f_angles, r, bonds_3, box_size)[source]
+

Computes forces resulting from angular interactions

+
+

Deprecated since version 1.0.0: compute_angle_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_bond_forces__plain(f_bonds, r, bonds_2, box_size)[source]
+

Computes forces resulting from bonded interactions

+
+

Deprecated since version 1.0.0: compute_bond_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size)[source]
+

Computes forces resulting from dihedral interactions

+
+

Deprecated since version 1.0.0: compute_dihedral_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.dipole_forces_redistribution(f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb)[source]
+

Redistribute electrostatic forces calculated from topologically +reconstructed ghost dipole point charges to the backcone atoms of the protein.

+
+ +
+
+hymd.force.find_all_paths(G, u, n)[source]
+

Helper function that recursively finds all paths of given lenght ‘n + 1’ inside a network ‘G’. +Adapted from https://stackoverflow.com/a/28103735.

+
+ +
+
+hymd.force.prepare_bonds(molecules, names, bonds, indices, config, topol=None)[source]
+

Rearrange the bond information for usage in compiled Fortran kernels

+

Restructures the lists resulting from the execution of +prepare_bonds_old into numpy arrays suitable for calls to optimized +Fortran code calculating bonded forces and energiesself.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2_atom_1(B,) numpy.ndarray

Local index of particle 1 for each of B constructed +two-particle bonds.

+
+
bonds_2_atom_2(B,) numpy.ndarray

Local index of particle 2 for each of B constructed +two-particle bonds.

+
+
bonds_2_equilibrium(B,) numpy.ndarray

Equilibrium distance for each of B constructed two-particle +bonds.

+
+
bonds_2_strength(B,) numpy.ndarray

Bond strength for each of B constructed two-particle +bonds.

+
+
bonds_3_atom_1(A,) numpy.ndarray

Local index of particle 1 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_2(A,) numpy.ndarray

Local index of particle 2 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_3(A,) numpy.ndarray

Local index of particle 3 for each of A constructed +three-particle bonds.

+
+
bonds_3_equilibrium(A,) numpy.ndarray

Equilibrium angle for each of A constructed three-particle +bonds.

+
+
bonds_3_strength(A,) numpy.ndarray

Bond strength for each of A constructed three-particle +bonds.

+
+
bonds_4_atom_1(D,) numpy.ndarray

Local index of particle 1 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_2(D,) numpy.ndarray

Local index of particle 2 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_3(D,) numpy.ndarray

Local index of particle 3 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_4(D,) numpy.ndarray

Local index of particle 4 for each of D constructed +four-particle bonds.

+
+
bonds_4_coeff(D,) numpy.ndarray

Cosine series coefficients for each of D constructed +four-particle bonds.

+
+
bonds_4_type(D,) numpy.ndarray

Dihedral type for each of D constructed four-particle +bonds.

+
+
bonds_4_last(D,) numpy.ndarray

Flags indicating if dih_type is 1 for each of D +constructed four-particle bonds.

+
+
+
+
+
+

See also

+
+
prepare_bonds_old

Used internally to reconstruct the bonded interactions types from the connectivity information in the structure/topology input file and the bonded types specified in the configuration file.

+
+
+ +
+ +
+
+hymd.force.prepare_bonds_old(molecules, names, bonds, indices, config)[source]
+

Find bonded interactions from connectivity and bond types information

+
+

Deprecated since version 1.0.0: prepare_bonds_old was replaced by prepare_bonds for +use with compiled Fortran kernels prior to 1.0.0 release.

+
+

Prepares the necessary equilibrium and bond strength information needed by +the intramolecular interaction functions. This is performed locally on each +MPI rank, as the domain decomposition ensures that for all molecules all +consituent particles are always contained on the same MPI rankself.

+

This function traverses the bond connectivity information provided in the +structure/topology input file and indentifies any two-, three-, or +four-particle potential bonds. For each connected chain of two, three, or +four particles, a matching to bond types is attempted. If the corresponding +names match, a bond object is initialized.

+

In order to investigate the connectivity, a graph is created using +networkx functionality.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2list

List of lists containing local particle indices, equilibrium +distance, and bond strength coefficient for each reconstructed +two-particle bond.

+
+
bonds_3

List of lists containing local particle indices, equilibrium angle, +and bond strength coefficient for each reconstructed three-particle +bond.

+
+
bonds_4

List of lists containing local particle indices, dihedral type index, +and dihedral coefficients for each reconstructed four-particle +torsional bond.

+
+
bb_indexlist

List indicating the dihedral type of each four-particle bond in +bonds_4.

+
+
+
+
+
+

See also

+
+
Bond

Two-particle bond type dataclass.

+
+
Angle

Three-particle angular bond type dataclass.

+
+
Dihedral

Four-particle torsional bond type dataclass.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+hymd.force.prepare_index_based_bonds(molecules, topol)[source]
+
+ +
+
+hymd.force.propensity_potential_coeffs(x: float)[source]
+
+ +
+
+

4.5. Logger

+
+
+class hymd.logger.Logger[source]
+

Log output handler class

+

Notes

+

This wraps the default python library logging, see +docs.python.org/3/library/logging.html.

+
+
Attributes:
+
+
levelint

Determines the verbosity level of the log, corresponding to +logging.level. Numerical values 50 (logging.CRITICAL), +40 (logging.ERROR), 30 +(logging.WARNING), 20 (logging.INFO), +10 (logging.DEBUG), and 0 +(logging.UNSET) are supported values. Any log event message +less severe than the specified level is ignored. All other event +messages are emitted.

+
+
log_filestr

Path to output log file.

+
+
formatstr

Prepended dump string for each log event. Specifies the log event +level, the module emitting the event, the code line, the enclosing +function name, and the MPI rank writing the message.

+
+
date_formatstr

Prepends the date before all log event messages.

+
+
formatterlogging.Formatter

Formatter handling the prepending of the information in format and +date_format to each log event message. Used by default for all +loggers.

+
+
rank0logging.Logger

Default logger object for the root MPI rank.

+
+
all_rankslogging.Logger

Default logger object for messages being emitted from all MPI ranks +simultaneously.

+
+
+
+
+
+
+classmethod setup(default_level=20, log_file=None, verbose=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Sets up the logger object.

+

If a log_file path is provided, log event messages are output +to it. Otherwise, the logging messages are emitted to stdout.

+
+
Parameters:
+
+
default_levelint, optional

Default verbosity level of the logger. Unless specified, it is +10 (logging.INFO).

+
+
log_filestr, optional

Path to output log file. If None or not priovided, no log file is +used and all logging is done to stdout.

+
+
verbosebool, optional

Increases the logging level to 30 (logging.WARNING) +if True, otherwise leaves the logging level unchanged.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterRoot(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the root MPI rank log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterAll(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the all-MPI-ranks log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+

4.6. Input parser

+

Parses and handles the configuration information provided for the simulation

+
+
+class hymd.input_parser.Config(n_steps: int, time_step: float, mesh_size: Union[List[int], numpy.ndarray, int], sigma: float, kappa: float, dtype: Optional[numpy.dtype] = None, box_size: Optional[Union[List[float], numpy.ndarray]] = None, n_print: Optional[int] = None, tau: Optional[float] = None, start_temperature: Optional[Union[float, bool]] = None, target_temperature: Optional[Union[float, bool]] = None, mass: Optional[float] = None, hamiltonian: Optional[str] = None, domain_decomposition: Optional[Union[int, bool]] = None, integrator: Optional[str] = None, respa_inner: int = 1, file_name: str = '<config file path unknown>', name: Optional[str] = None, tags: List[str] = <factory>, bonds: List[hymd.force.Bond] = <factory>, angle_bonds: List[hymd.force.Angle] = <factory>, dihedrals: List[hymd.force.Dihedral] = <factory>, chi: List[hymd.force.Chi] = <factory>, n_particles: Optional[int] = None, max_molecule_size: Optional[int] = None, n_flush: Optional[int] = None, thermostat_work: float = 0.0, thermostat_coupling_groups: List[List[str]] = <factory>, initial_energy: Optional[float] = None, cancel_com_momentum: Union[int, bool] = False, coulombtype: Optional[str] = None, convergence_type: Optional[str] = None, pol_mixing: Optional[float] = None, dielectric_const: Optional[float] = None, conv_crit: Optional[float] = None, dielectric_type: List[hymd.force.Dielectric_type] = <factory>, self_energy: Optional[float] = None, type_charges: Optional[Union[List[float], numpy.ndarray]] = None, rho0: Optional[float] = None, a: Optional[float] = None, pressure: bool = False, barostat: Optional[str] = None, barostat_type: Optional[str] = None, tau_p: Optional[float] = None, target_pressure: List[hymd.barostat.Target_pressure] = <factory>, n_b: Optional[int] = None, m: List[float] = <factory>)[source]
+

Configuration object

+

Handles and verifies the simulation configuration specified in the +configuration file.

+
+

See also

+
+
hymd.input_parser.Bond

Two-particle bond type dataclass.

+
+
hymd.input_parser.Angle

Three-particle bond type dataclass.

+
+
hymd.input_parser.Dihedral

Four-particle bond type dataclass.

+
+
+ +
+
Attributes:
+
+
gas_constantfloat

Constant value of the gas constant, R (equivalently the Boltzmann +constant) in the units used internally in HyMD.

+
+
coulomb_constantfloat

Constant value of the Coulomb constant which converts electric field +values to forces and electric potential values to energies in the units +used internally in HyMD.

+
+
n_steps: int

Number of time steps in the simulation.

+
+
time_step: float

Outer time step used in the simulation. If the rRESPA intergrator is +used, the inner time step (the time step used in the integration of +intramolecular bending, stretching, and torsional forces) is +time_step / respa_inner.

+
+
box_sizelist[float] or (D,) numpy.ndarray

Simulation box size of simulation in D dimensions in units of +nanometers.

+
+
mesh_sizelist[int] or int or numpy.ndarray

Number of grid points used for the discrete density grid.

+
+
sigmafloat

Filter width representing the effective coarse-graining level of the +particles in the simulation.

+
+
kappafloat

Compressibility parameter used in the relaxed incompressibility term in +the interaction energy functional.

+
+
n_printint, optional

Frequency of trajectory/energy output to the H5MD trajectory/energy +output file (in units of number of time steps).

+
+
taufloat, optional

The time scale of the CSVR thermostat coupling.

+
+
start_temperaturefloat, optional

Generate starting temperature by assigning all particle velocities +randomly according to the Maxwell-Boltzmann distribution at +start_temperature Kelvin prior to starting the simulation.

+
+
target_temperaturefloat, optional

Couple the system to a heat bath at target_temperature Kelvin.

+
+
massfloat, optional

Mass of the particles in the simulation.

+
+
hamiltonianstr, optional

Specifies the interaction energy functional \(W[\tilde\phi]\) +for use with the particle-field interactions. Options: +SquaredPhi, DefaultNohChi, or DefaultWithChi.

+
+
domain_decompositionint, optional

Specifies the interval (in time steps) of domain decomposition +exchange, involving all MPI ranks sending and receiving particles +according to the particles’ positions in the integration box and the +MPI ranks’ assigned domain.

+
+
integratorstr, optional

Specifies the time integrator used in the simulation. Options: +velocity-verlet or respa.

+
+
respa_innerint, optional

The number of inner time steps in the rRESPA integrator. This denotes +the number of intramolecular force calculations (stretching, bending, +torsional) are performed between each impulse applied from the field +forces.

+
+
file_namestr, optional

File path of the parsed configuration file.

+
+
namestr, optional

Name for the simulation.

+
+
tagslist[str], optional

Tags for the simulation.

+
+
bondslist[Bond], optional

Specifies harmonic stretching potentials between particles in the +same molecule.

+
+
angle_bondslist[Angle], optional

Specifies harmonic angular bending potentials between particles in the +same molecule.

+
+
dihedralslist[Dihedral], optional

Specifies four-particle torsional potentials by cosine series.

+
+
chilist[Chi], optional

Specifies \(\chi\)-interaction parameters between particle +species.

+
+
n_particlesint, optional

Specifies the total number of particles in the input. Optional keyword +for validation, ensuring the input HDF5 topology has the correct number +of particles and molecules.

+
+
max_molecule_sizeint, optional

Maximum size of any single molecule in the system. Used to speed up +distribution of particles onto MPI ranks in a parallel fashion.

+
+
n_flushint, optional

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be +written to disk (in units of number of n_print).

+
+
thermostat_workfloat

Work performed by the thermostat on the system.

+
+
thermostat_coupling_groupslist[str], optional

Specifies individual groups coupling independently to the CSVR +thermostat. E.g. in a system containing "A", "B", and +"C" type particles, +thermostat_coupling_groups = [["A", "B"], ["C"],] would +thermalise types "A" and "B" together and couple +"C" type particles to a different thermostat (all individual +thermostats are at the same temperature, i.e. target_temperature +Kelvin).

+
+
initial_energyfloat

Value of the total energy prior to the start of the simulation.

+
+
cancel_com_momentumint, optional

If True, the total linear momentum of the center of mass is +removed before starting the simulation. If an integer is specifed, the +total linear momentum of the center of mass is removed every +remove_com_momentum time steps. If False, the linear +momentum is never removed.

+
+
coulombtypestr, optional

Specifies the type of electrostatic Coulomb interactions in the system. +The strength of the electrostatic forces is modulated by the relative +dielectric constant of the simulation medium, specified with the +dielectric_const keyword. Charges for individual particles are +specified in the structure/topology HDF5 input file, not in the +configuration file. If no charges (or peptide backbone dipoles) are +present, the electrostatic forces will not be calculated even if this +keyword is set to "PIC_Spectral".

+
+
dielectric_constfloat, optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. When +using helical propensity dihedrals, this keyword must be specified—even +if electrostatics are not included with the coulombtype +keyword.

+
+
dielectric_type: list[float], optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. The list assigns +relative dielectric values to each bead type, and an anisotropic +dielectric function is obtained from a weighted average.

+
+
+
+
+
+
+a: float = None
+
+ +
+
+angle_bonds: List[hymd.force.Angle]
+
+ +
+
+barostat: str = None
+
+ +
+
+barostat_type: str = None
+
+ +
+
+bonds: List[hymd.force.Bond]
+
+ +
+
+box_size: Union[List[float], numpy.ndarray] = None
+
+ +
+
+cancel_com_momentum: Union[int, bool] = False
+
+ +
+
+chi: List[hymd.force.Chi]
+
+ +
+
+conv_crit: float = None
+
+ +
+
+convergence_type: str = None
+
+ +
+
+coulomb_constant: ClassVar[float] = 138.935458
+
+ +
+
+coulombtype: str = None
+
+ +
+
+dielectric_const: float = None
+
+ +
+
+dielectric_type: List[hymd.force.Dielectric_type]
+
+ +
+
+dihedrals: List[hymd.force.Dihedral]
+
+ +
+
+domain_decomposition: Union[int, bool] = None
+
+ +
+
+dtype: numpy.dtype = None
+
+ +
+
+file_name: str = '<config file path unknown>'
+
+ +
+
+gas_constant: ClassVar[float] = 0.0083144621
+
+ +
+
+hamiltonian: str = None
+
+ +
+
+initial_energy: float = None
+
+ +
+
+integrator: str = None
+
+ +
+
+kappa: float
+
+ +
+
+m: List[float]
+
+ +
+
+mass: float = None
+
+ +
+
+max_molecule_size: int = None
+
+ +
+
+mesh_size: Union[List[int], numpy.ndarray, int]
+
+ +
+
+n_b: int = None
+
+ +
+
+n_flush: int = None
+
+ +
+
+n_particles: int = None
+
+ +
+
+n_print: int = None
+
+ +
+
+n_steps: int
+
+ +
+
+name: str = None
+
+ +
+
+pol_mixing: float = None
+
+ +
+
+pressure: bool = False
+
+ +
+
+respa_inner: int = 1
+
+ +
+
+rho0: float = None
+
+ +
+
+self_energy: float = None
+
+ +
+
+sigma: float
+
+ +
+
+start_temperature: Union[float, bool] = None
+
+ +
+
+tags: List[str]
+
+ +
+
+target_pressure: List[hymd.barostat.Target_pressure]
+
+ +
+
+target_temperature: Union[float, bool] = None
+
+ +
+
+tau: float = None
+
+ +
+
+tau_p: float = None
+
+ +
+
+thermostat_coupling_groups: List[List[str]]
+
+ +
+
+thermostat_work: float = 0.0
+
+ +
+
+time_step: float
+
+ +
+
+type_charges: Union[List[float], numpy.ndarray] = None
+
+ +
+ +
+
+hymd.input_parser.check_NPT_conditions(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check validity of barostat_type, barostat, +a, rho0, target_pressure, tau_p

+
+ +
+
+hymd.input_parser.check_angles(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_bonds(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_box_size(config, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_cancel_com_momentum(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_charges(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if charges across ranks sum to zero.

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of floats with charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_charges_types_list(config, types, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates a list of charge values of length types. +Charges are sorted according to type ID. Used in field.py. +# TODO: this is messy, we should fix it

+
+ +
+
+hymd.input_parser.check_chi(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_config(config, indices, names, types, charges, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs various checks on the specfied config to ensure consistency

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
indices(N,) numpy.ndarray

Array of integer indices for N particles.

+
+
names(N,) numpy.ndarray

Array of string names for N particles.

+
+
types(N,) numpy.ndarray

Array of integer type indices for N particles.

+
+
charges(N,) numpy.ndarray

Array of floats charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
Returns:
+
+
configConfig

Validated configuration object.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_dielectric(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Error handling for electrostatics. +Unit testing of toml/tomli input.

+
+ +
+
+hymd.input_parser.check_dihedrals(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_domain_decomposition(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_hamiltonian(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_integrator(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_m(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_mass(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_max_molecule_size(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_b(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_flush(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_particles(config, indices, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_print(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_name(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_start_and_target_temperature(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Validate provided starting and target thermostat temperatures

+

Assesses the provided temperature target and ensures it is a non-negative +floating point number or False. Ensures the starting temperature is +a non-negative floating point number or False.

+

If the value for either is None, the returned configuration object +has the values defaulted to False in each case.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
validated_configConfig

Configuration object with validated target_temperature and +start_temperature.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_tau(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_thermostat_coupling_groups(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.parse_config_toml(toml_content, file_path=None, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.read_config_toml(file_path)[source]
+
+ +
+
+hymd.input_parser.sort_dielectric_by_type_id(config, charges, types)[source]
+

Creates a list of length N CG-particles, sorted after the charges from +the input HDF5 file. Used in file_io.py

+
+ +
+
+

4.7. Field

+

Forces and energies from the discretized particle-field grid interactions

+
+
+hymd.field.compute_field_and_kinetic_energy(phi, phi_q, psi, velocity, hamiltonian, positions, types, v_ext, config, layouts, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the particle-field and kinetic energy contributions

+

Calculates the kinetic energy through

+
+\[E_k = \sum_j \frac{1}{2}m_j\mathbf{v}_j\cdot\mathbf{v}_j,\]
+

and the particle-field energy by

+
+\[E_\text{field} = \int\mathrm{d}\mathbf{r}\, + w[\tilde\phi],\]
+

where \(w\) is the interaction energy functional density.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
velocity(N,D) numpy.ndarray

Array of velocities for N particles in D dimensions. +Local for each MPI rank.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Local for each MPI rank–the full computational grid is +represented by the collective fields of all MPI ranks.

+
+
configConfig

Configuration object.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field

Computes the up-to-date external potential for use in calculating the particle-field energy.

+
+
+ +
+ +
+
+hymd.field.compute_field_energy_q_GPE(config, phi_eps, field_q_energy, dot_elec, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the electrostatic energy after electrosatic forces is +calculated.

+

From the definition of the elecrostatic potential \(\Psi\), the energy +is

+
+
+
W = frac{1}{2}intmathrm{d}mathbf{r},

epsilon(mathbf{r})} left(mathbf{E}cdot mathbf{E}right),

+
+
+
+

where \(\epsilon(\mathbf{r})}\) is the anisotropic, spatially dependent, +relative dielectric of the simulation medium.

+
+
Parameters:
+
+
confighymd.input_parser.Config

Configuration object.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
field_q_energyfloat

Total elecrostatic energy.

+
+
dot_elecpmesh.pm.RealField

Pmesh RealField object for storing \(|\mathbf{E(r)}|^{2}\) +on the computational grid. Local for each MPI rank – the full computational +grid is represented by the collective fields of all MPI ranks.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field_force_q_GPE

Compute the electrosatic force from an anisotropic dielectric general Poisson equation.

+
+
+ +
+ +
+
+hymd.field.compute_field_force(layouts, r, force_mesh, force, types, n_types)[source]
+

Interpolate particle-field forces from the grid onto particle positions

+

Backmaps the forces calculated on the grid to particle positions using the +window function \(P\) (by default cloud-in-cell [CIC]). In the +following, let \(\mathbf{F}_j\) denote the force acting on the +particle with index \(j\) and position \(\mathbf{r}_j\). The +interpolated force is

+
+\[\mathbf{F}_j = -\sum_k\nabla V_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(V_{j_k}\) is the discretized external potential at grid vertex +\(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid vertex +with index \(j_k\), and \(h^3\) is the volume of each grid voxel. +The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
r(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
force(N,D) numpy.ndarray

Array of forces for N particles in D dimensions. Local +for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
n_typesint

Number of different unique types present in the simulation system. +n_types is global, i.e. the same for all MPI ranks even if some +ranks contain zero particles of certain types.

+
+
+
+
+
+ +
+
+hymd.field.compute_self_energy_q(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the self energy for the interaction due to the Ewald scheme +used to compute the electrostatics. The energy is stored in config.

+

The self interaction energy is given by:

+
+\[U_{self} = \sqrt{\frac{1}{2\pi\sigma^2}} \sum_{i=1}^{N} q_i^2\]
+

where \(q_i\) are the charges and \(\sigma\) is the half-width +of the Gaussian filter.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
Returns:
+
+
field_q_self_energyfloat

Electrostatic self energy.

+
+
+
+
+
+ +
+
+hymd.field.domain_decomposition(positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs domain decomposition

+

Rearranges the MPI rank memory layout into one that better mimics the PFFT +pencil grid 2D decomposition. As molecules are always required to be fully +contained on a single MPI rank, a perfect decomposition is not always +possible. The best decomposition which leaves the center of mass of all +molecules in their respective correct domains is used, with possible +overlap into neighbouring domains if the spatial extent of any molecule +crosses domain boundaries.

+
+
Parameters:
+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
*args

Variable length argument list containing arrays to include in the +domain decomposition.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
bonds(N,M) numpy.ndarray, optional

Array of M bonds originating from each of N particles.

+
+
verboseint, optional

Specify the logging event verbosity of this function.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
Domain decomposedcode:positions and any array specified in
+
:code:`*args`, in addition tocode:bonds and molecules if these
+
arrays were provided as input.
+
+
+
+
+ +
+
+hymd.field.initialize_pm(pmesh, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates the necessary pmesh objects for pfft operations.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pmobject ‘pmesh.pm.ParticleMesh’
+
field_listlist[pmesh.pm.RealField], (multiple)

Essential list of pmesh objects required for MD

+
+
list_coulomblist[pmesh.pm.RealField], (multiple)

Additional list of pmesh objects required for electrostatics.

+
+
+
+
+
+ +
+
+hymd.field.update_field(phi, phi_laplacian, phi_transfer, layouts, force_mesh, hamiltonian, pm, positions, types, config, v_ext, phi_fourier, v_ext_fourier, m, compute_potential=False)[source]
+

Calculate the particle-field potential and force density

+

If compute_potential is True, the energy may subsequently +be computed by calling compute_field_and_kinetic_energy.

+

Computes the particle-field external potential \(V_\text{ext}\) from +particle number densities through the smoothed density field, +\(\phi(\mathbf{r})\). With \(P\) being the cloud-in-cell (CIC) +window function, the density and filtered densities are computed as

+
+\[\phi(\mathbf{r}) = \sum_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\phi(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +external potential is computed in reciprocal space as

+
+\[V_\text{ext} = \mathrm{FFT}^{-1}\left[ + \mathrm{FFT} + \left( + \frac{\partial w}{\partial \tilde\phi} + \right) + \mathrm{FFT}(H) +\right],\]
+

where \(w\) is the interaction energy functional. Differentiating +\(V_\text{ext}\) is done by simply applying \(i\mathbf{k}\) in +Fourier space, and the resulting forces are back-transformed to direct +space and interpolated to particle positions by

+
+\[\mathbf{F}_j = -\sum_{j_k} \nabla V_{j_k} + P(\mathbf{r}_{j_k} - \mathbf{r}_j)h^3,\]
+

where \(j_k\) are the neighbouring vertices of particle \(j\) at +position \(\mathbf{r}_j\), and \(h^3\) is the volume of each grid +voxel.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Pre-allocated, but empty; any values +in this field are discarded. Changed in-place. Local for each MPI +rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
configConfig

Configuration object.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Pre-allocated, but empty; any values in this field are +discarded Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
phi_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computational grid is represented by the collective fields of all +MPI ranks.

+
+
v_ext_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplesField objects containing discretized +particle-field external potential values in reciprocal space on the +computational grid; D+1 fields in D dimensions for each +particle type. D copies are made after calculation for later +use in force calculation, because the force transfer function +application differentiates the field in-place, ruining the contents +for differentiation in the remaining D-1 spatial directions. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
m: list[float], (M,)

pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. +Defaults to 1.0 for all particle types.

+
+
compute_potentialbool, optional

If True, a D+1-th copy of the Fourier transformed +external potential field is made to be used later in particle-field +energy calculation. If False, only D copies are made.

+
+
+
+
+
+

See also

+
+
compute_field_and_kinetic_energy

Compute the particle-field energy after the external potential is calculated.

+
+
+ +
+ +
+
+hymd.field.update_field_force_q(charges, phi_q, phi_q_fourier, psi, psi_fourier, elec_field_fourier, elec_field, elec_forces, layout_q, hamiltonian, pm, positions, config)[source]
+

Calculate the electrostatic particle-field forces on the grid

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential is computed in reciprocal space as

+
+\[\Phi = \mathrm{FFT}^{-1}\left[ + \frac{4\pi k_e}{\varepsilon \vert\mathbf{k}\vert^2} + \mathrm{FFT}(\rho)\mathrm{FFT}(H) +\right],\]
+

with the electric field

+
+\[\mathbf{E} = \mathrm{FFT}^{-1}\left[ + -i\mathbf{k}\,\mathrm{FFT}(\Psi) +\right].\]
+

In the following, let \(\mathbf{F}_j\) denote the electrostatic force +acting on the particle with index \(j\) and position +\(\mathbf{r}_j\). The interpolated electrostatic force is

+
+\[\mathbf{F}_j = \sum_k q_j\mathbf{E}_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(\mathbf{E}_{j_k}\) is the discretized electric field at grid +vertex \(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid +vertex with index \(j_k\), and \(h^3\) is the volume of each grid +voxel. The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty; any values in this field +are discarded. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
elec_field_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +electric field values in reciprocal space on the computational grid. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
+
+
+
+ +
+
+hymd.field.update_field_force_q_GPE(conv_fun, phi, types, charges, phi_q, phi_q_fourier, phi_eps, phi_eps_fourier, phi_eta, phi_eta_fourier, phi_pol_prev, phi_pol, elec_field, elec_forces, elec_field_contrib, psi, Vbar_elec, Vbar_elec_fourier, force_mesh_elec, force_mesh_elec_fourier, hamiltonian, layout_q, layouts, pm, positions, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Calculate the electrostatic particle-field forces on the grid, arising from +a general Poisson equation, i.e. anisotropic permittivity/dielectric. +The function is called when tomli input config.coulombtype = “PIC_Spectral_GPE.”

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential for a variable dielectric does not have an +analytical expression, and is computed in reciprocal through an iterative +method.

+

The GPE states that

+
+\[\nabla \cdot \left(\epsilon(\mathbf{r}) +\nabla{\mathbf{\psi(r)}}\right) = -\rho({\mathbf{r}}).\]
+

where \(\epsilon(\mathbf{r})\) is the relative dielectric function.

+
+
Parameters:
+
+
conv_funConvergence function.

Returns a scalar. Depends on MPI allreduce for similar convergence +across MPI ranks.

+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_eps_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_etapmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +gradients of the relative dielectric values on the computational grid. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank–the +full computational grid is represented by the collective fields of all MPI ranks.

+
+
phi_eta_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated discretized +Fourier transformed gradient relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_pol_prevpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charge values on the computational grid. Parameter in +the iterative method.Pre-allocated,but empty. Changedin-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_polpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charges on the computational grid. Parameter in the iterative +method, updating the next quess in solving for the electrostatic potential. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank– +the full computational grid is represented by the collective fields of +all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all +MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
elec_field_contribpmesh.pm.RealField

Pmesh RealField object for storing +\(|\mathbf{E(r)}|^2/\phi_{0}\) on the computational grid. +Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
psipmesh.pm.RealField

Pmesh RealField object for storing electrostatic potential +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
Vbar_elecmesh.pm.RealField

Pmesh RealField object for storing functional derivatives of +:math:`|w({ phi })_{elec}`on the computational grid. +Pre-allocated, but empty. Changed in-place. Local for each MPI rank– +the full computational grid is represented by the collective fields of

+
+

all MPI ranks.

+
+
+
Vbar_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated functional +derivatives of \(\|w(\{ \phi \})_{elec}\) in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
force_mesh_elecpmesh.pm.RealField

Pmesh RealField object for storing electrostatic force values +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
force_mesh_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated electrostatic +force values in reciprocal space on the computational grid. Local for +each MPI rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
layouts: list[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
comm: mpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
compute_field_energy_q_GPE

Compute the electrostatic energy after electrosatic force is calculated for a variable (anisotropic) dielectric general Poisson equation.

+
+
+ +
+ +
+
+

4.8. File input/output

+

Handle file input/output in parllel HDF5 fashion

+
+
+class hymd.file_io.OutDataset(dest_directory, config, double_out=False, disable_mpio=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

HDF5 dataset handler for file output

+
+
+close_file(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Closes the HDF5 output file

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+
+flush()[source]
+

Flushes output buffers, forcing file writes

+
+ +
+
+is_open(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if HDF5 output file is open

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+ +
+
+hymd.file_io.distribute_input(in_file, rank, size, n_particles, max_molecule_size=201, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Assign global arrays onto MPI ranks, attempting load balancing

+

Distributes approximately equal numbers of particles (workload) onto each +independent MPI rank, while respecting the requirement that any molecule +must be fully contained on a single MPI rank only (no splitting molecules +across multiple CPUs).

+
+
Parameters:
+
+
in_fileh5py.File

HDF5 input file object.

+
+
rankint

Local rank number for this MPI rank.

+
+
sizeint

Global size of the MPI communicator (number of total CPUs).

+
+
n_particlesint

Total number of particles.

+
+
max_molecule_sizeint, optional

Maximum size of any molecule present in the system. Used to initially +guess where the MPI rank boundaries (start/end indices) in the global +arrays should be placed. If molecules of size +>max_molecule_size exist in the simulation system, HyMD +might work as expected. Or it might fail spectacularly.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
rank_range

Starting and ending indices in the global arrays for each MPI rank.

+
+
+
+
+
+ +
+
+hymd.file_io.setup_time_dependent_element(name, parent_group, n_frames, shape, dtype, units=None)[source]
+

Helper function for setting up time-dependent HDF5 group datasets

+

All output groups must adhere to the H5MD standard, meaning a structure of

+
+
┗━ group particle group (e.g. all) or observables group
+
+
┗━ group time-dependent data
+
+
┣━ dataset step shape=(n_frames,)
+
┣━ dataset time shape=(n_frames,)
+
┗━ dataset value shape=(n_frames, *)
+
+
+
+

is necessary.

+

References

+
+
H5MD specification :

https://www.nongnu.org/h5md/h5md.html

+
+
+
+ +
+
+hymd.file_io.store_data(h5md, step, frame, indices, positions, velocities, forces, box_size, temperature, pressure, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, field_energy, field_q_energy, plumed_bias, time_step, config, velocity_out=False, force_out=False, charge_out=False, plumed_out=False, dump_per_particle=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Writes time-step data to HDF5 output file

+

Handles all quantities which change during simulation, as opposed to +static quanitities (see store_static).

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
stepint

Step number.

+
+
frameint

Output frame number (step // n_print).

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
positions(N,) numpy.ndarray

Array of positions for N particles in D dimensions.

+
+
velocities(N,) numpy.ndarray

Array of velocities for N particles in D dimensions.

+
+
forces(N,) numpy.ndarray

Array of forces for N particles in D dimensions.

+
+
box_size(D,) numpy.ndarray

Array containing the simulation box size.

+
+
temperaturefloat

Calculated instantaneous temperature.

+
+
kinetic_energyfloat

Calculated instantaneous kinetic energy.

+
+
bond2_energyfloat

Calculated instantaneous harmonic two-particle bond energy.

+
+
bond3_energyfloat

Calculated instantaneous harmonic angular three-particle bond energy.

+
+
bond4_energyfloat

Calculated instantaneous dihedral four-particle torsion energy.

+
+
field_energyfloat

Calculated instantaneous particle-field energy.

+
+
field_q_energyfloat

Calculated instantaneous electrostatic energy.

+
+
plumed_biasfloat

PLUMED instantaneous bias energy.

+
+
time_stepfloat

Value of the time step.

+
+
configConfig

Configuration object.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charge_outbool, optional

If True, electrostatic energies are written to the output +HDF5 file.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to the output HDF5 file.

+
+
dump_per_particlebool, optional

If True, all quantities are written per particle.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
store_static

Outputs all static time-independent quantities to the HDF5 output file

+
+
+ +
+ +
+
+hymd.file_io.store_static(h5md, rank_range, names, types, indices, config, bonds_2_atom1, bonds_2_atom2, molecules=None, velocity_out=False, force_out=False, charges=False, dielectrics=False, plumed_out=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Outputs all static time-independent quantities to the HDF5 output file

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
rank_rangelist[int]

Start and end indices for global arrays for each MPI rank.

+
+
names(N,) numpy.ndarray

Array of names for N particles.

+
+
types(N,) numpy.ndarray

Array of type indices for N particles.

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
configConfig

Configuration object.

+
+
bonds_2_atom1(B,) numpy.ndarray

Array of indices of the first particle for B total +two-particle bonds.

+
+
bonds_2_atom2(B,) numpy.ndarray

Array of indices of the second particle for B total +two-particle bonds.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles.

+
+
dielectrics(N,) numpy.ndarray

Array of particle relative dielectric values for N particles.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to output HDF5 file.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
prepare_bonds

Constructs two-, three-, and four-particle bonds from toplogy input file and bond configuration information.

+
+
distribute_input

Distributes input arrays onto MPI ranks, attempting load balancing.

+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/doc_pages/benchmarks.html b/v1.0.5/doc_pages/benchmarks.html new file mode 100644 index 00000000..d89f0cdb --- /dev/null +++ b/v1.0.5/doc_pages/benchmarks.html @@ -0,0 +1,300 @@ + + + + + + + 3. Benchmarks — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Benchmarks

+

Homopolymer melt test systems of \(30^2\), \(40^2\), and \(50^2\) +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively.

+
+

3.1. Bonded forces

+

Legend label denotes the number of particles in the system.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-1.png +
+
+
+

3.2. Particle–field forces

+

Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-2.png +
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/doc_pages/command_line.html b/v1.0.5/doc_pages/command_line.html new file mode 100644 index 00000000..419c45ec --- /dev/null +++ b/v1.0.5/doc_pages/command_line.html @@ -0,0 +1,357 @@ + + + + + + + 5. Command line arguments — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. Command line arguments

+

Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle–field interactions.

+
+

5.1. Required arguments

+
+
configuration file:
+

type positional

+

Specifies the .toml format configuration file containing simulation details. See Configuration file for details.

+
+
structure and topology file:
+

type positional

+

Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See Topology and structure file for details.

+
+
+
+
+

5.2. Optional arguments

+
+
-v  --verbose

type optional

+

Number of following arguments: 0 or 1

+

Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying -v or --verbose with no additional specification. This increases verbosity level by 1. Alternatively, it maye be specified by --verbose V with V being 0, 1, or 2.

+
+
--profile

type optional

+

Number of following arguments: 0

+

Enables code profiling using cProfile. This will output one profiling file per MPI rank invoked in the simulation.

+
+
--double-precision

type optional

+

Number of following arguments: 0

+

Specify usage of double precision internally in HyMD (including in the FFTs).

+
+
--double-output

type optional

+

Number of following arguments: 0

+

Specify usage of double precision in the output trajectory from HyMD.

+
+
--velocity-output

type optional

+

Number of following arguments: 0

+

Specify that velocities should be output to the HyMD trajectory.

+
+
--force-output

type optional

+

Number of following arguments: 0

+

Specify that forces should be output to the HyMD trajectory.

+
+
--disable-mpio

type optional

+

Number of following arguments: 0

+

Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult.

+
+
--logfile

type optional

+

Number of following arguments: 1

+

Specifies the path of a plain text log file in which stdout is mirrored during simulation runs.

+
+
--seed

type optional

+

Number of following arguments: 1

+

Specifies the random seed used in the numpy random library to generate velocities, thermostatting, etc.

+
+
--disable-bonds

type optional

+

Number of following arguments: 0

+

Disable any two-particle bonds present in the system.

+
+
--disable-angle-bonds

type optional

+

Number of following arguments: 0

+

Disable any three-particle bonds present in the system.

+
+
--disable-dihedrals

type optional

+

Number of following arguments: 0

+

Disable any four-particle bonds present in the system.

+
+
--disable-dipole

type optional

+

Number of following arguments: 0

+

Disable any topological reconstruction of peptide backbone dipoles present in the system.

+
+
--disable-field

type optional

+

Number of following arguments: 0

+

Disable any particle–field interactions present in the system.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/doc_pages/config_file.html b/v1.0.5/doc_pages/config_file.html new file mode 100644 index 00000000..d2ba8308 --- /dev/null +++ b/v1.0.5/doc_pages/config_file.html @@ -0,0 +1,444 @@ + + + + + + + 3. Configuration file — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Configuration file

+

The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order.

+

The configuration file is a toml format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs.

+
+

3.1. Configuration file keywords

+

The following constitutes every possible keyword specification in HyMD +configuration files:

+
+

3.1.1. Metadata keywords

+

Configuration keywords specifying metadata for the H5MD output trajectory.

+
+
name:
+

string [optional, default: None]

+

Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file.

+
+
tags:
+

array [string] [optional, default: None]

+

Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file.

+
+
+
+
+

3.1.2. Particle keywords

+

Configuration keywords specifying properties of particles and molecules in the +system.

+
+
n_particles:
+

integer [optional, default: None]

+

Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules.

+
+
mass:
+

float [optional, default: 72.0] {units: \(\text{u}=\text{g}\,\text{mol}^{-1}\)}

+

Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal.

+
+
max_molecule_size:
+

integer [optional, default: 201]

+

Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code will crash if there are molecules larger than max_molecule_size in the topology/structure input file.

+
+
+
+
+

3.1.3. Simulation keywords

+

Configuration keywords specifying simulation parameters.

+
+
n_steps:
+

integer [required]

+

Total number of integration steps to perform for this simulation.

+
+
n_print:
+

integer or boolean [optional, default: False]

+

Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of number of time steps).

+
+
n_flush:
+

integer [optional, default: None]

+

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of number of n_print, i.e. n_print = 13, n_flush = 3 would result in the trajectory/energy being written to disk every 13 x 3 = 39 simulation steps)

+
+
time_step:
+

float [required] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time step per integration step. If the rRESPA multiple time step integrator is used (integrator = "respa"), this specifies the inner time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is respa_inner times the time_step , and the total simulation time is n_steps times time_step times respa_inner .

+
+
box_size:
+

array [float] [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable.

+
+
integrator:
+

string [required] (options: velocity-verlet or respa)

+

Specifies the time integrator used in the simulation. If respa, the reversible reference system propagator algorithm (rRESPA) [Tuckerman et al., 1992] integrator is used, with respa_inner number of inner (intramolecular force) time steps. If velocity-verlet, a normal Velocity Verlet integrator is used. If respa and respa_inner = 1, the rRESPA integrator is equivalent to the Velocity Verlet.

+
+
respa_inner:
+

integer [optional, default: 1]

+

The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces.

+
+
domain_decomposition:
+

integer or boolean [optional, default: False]

+

Specifies the interval (in time steps) of domain decomposition exchange, involving all MPI ranks sending and receiving particles according to the particles’ positions in the integration box and the MPI ranks’ assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If True, the decomposition is performed once (before starting the simulation). If False, no decomposition is performed.

+
+
cancel_com_momentum:
+

integer or boolean [optional, default: False]

+

If True, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every remove_com_momentum time steps. If False, the linear momentum is never removed.

+
+
start_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at start_temperature Kelvin prior to starting the simulation. If False, the velocities are not changed before starting the simulation.

+
+
target_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Couple the system to a heat bath at target_temperature Kelvin by applying a Canonical sampling through velocity rescaling [Bussi et al., 2007] thermostat with coupling strength tau. If False, no temperature control is applied.

+
+
tau:
+

float [optional, default: 0.7] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the CSVR thermostat coupling. In the limit of tau , the Hamiltonian dynamics are preserved and no temperature coupling takes place.

+
+
thermostat_coupling_groups:
+

array [array [string]] [optional, default: []]

+

Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing "A", "B", and "C" type particles, thermostat_coupling_groups = [["A", "B"], ["C"],] would thermalise types "A" and "B" together and couple "C" type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. target_temperature Kelvin).

+
+
hamiltonian:
+

string [optional, default: "DefaultNohChi"] (options: SquaredPhi, DefaultNohChi, or DefaultWithChi)

+

Specifies the interaction energy functional \(W[\tilde\phi]\) for use with the particle-field interactions. See Interaction energy functionals for details.

+
+
+
+
+

3.1.4. Field keywords

+

Configuration keywords specifying field parameters.

+
+
mesh_size:
+

array [integer] or integer [required]

+

Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is box_size / mesh_size.

+
+
kappa:
+

float [required] {units: \(\text{kJ}^{-1}\text{mol}\)}

+

Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional \(W[\tilde\phi]\). See Interaction energy functionals for more details.

+
+
sigma:
+

float [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See Filtering for more details.

+
+
chi:
+

array [array [string, float]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\)}

+

Array of \(\tilde\chi_\text{AB}\)-parameters indicating the strength of the repulsive or attractive interaction between particles of type "A" and the number density due to particles of type "B", and vice versa. Example: chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ] would specify a repulsive "A""B" type interaction, and a weakly attractive "C""D" interaction. Self-interaction \(\tilde\chi\)-terms are always zero. See Interaction energy functionals for more details.

+
+
+
+
+

3.1.5. Bond keywords

+

Configuration keywords specifying bonds and bonds parameters.

+
+
bonds:
+

array [array [2 string, 2 float]] [optional, default: []] {units: \(\text{nm}=10^{-9}~\text{m}\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+

Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ] indicates a "A""A" bond of equilibrium length 0.47 \(\text{nm}\) with a bond strength of 980.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding bond between "A" and "B" type particles with equilibrium length 0.31 \(\text{nm}\) and a strength of 1250.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify stretching bonds.

+
+
angle_bonds:
+

array [array [3 string, 2 float]] [optional, default: []] {units: \({}^\circ\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+
+

Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ] indicates a "A""A""A" angular bond that tries to keep the bond linear at 180 degrees with a bending strength of 55.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding angle bond between "A""B""B" prefering the angle at 120 degrees and a strength of 25.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify angular bonds.

+
+
+
dihedrals:
+

array [array [4 string, integer, COSINE SERIES ]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)}

+

Specifies four-particle torsional potentials by cosine series. See Intramolecular bonds for details about how to specify dihedrals.

+
+
+
+
+

3.1.6. Electrostatic keywords

+

Configuration keywords specifying electrostatics and electrostatic parameters.

+
+
coulombtype:
+

string [optional, default: None] (options: PIC_Spectral)

+

Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the dielectric_const keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, not in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to PIC_Spectral.

+
+
dielectric_const:
+

float [optional, default: None]

+

Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified—even if electrostatics are not included with the coulombtype keyword.

+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/doc_pages/constants_and_units.html b/v1.0.5/doc_pages/constants_and_units.html new file mode 100644 index 00000000..d3c3786f --- /dev/null +++ b/v1.0.5/doc_pages/constants_and_units.html @@ -0,0 +1,391 @@ + + + + + + + 6. Constants and Units — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

6. Constants and Units

+

HyMD uses the following units and constants internally and in all input and +output:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Units

Quantity

Symbol

Unit

length

\(r\)

\(\text{nm}=10^{-9}~\text{m}\)

time

\(t\)

\(\text{ps}=10^{-12}~\text{s}\)

charge

\(q\)

\(e=1.602176634 \cdot 10^{-19}~\text{C}\)

mass

\(m\)

\(\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}\)

temperature

\(\text{T}\)

\(\text{K}\)

energy

\(E\)

\(\text{kJ}\,\text{mol}^{-1}\)

velocity

\(v\)

\(\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}\)

momentum

\(P\)

\(\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}\)

force

\(\mathbf{F}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}\)

pressure

\(p\)

\(\text{bar}=100~\text{kPa}\)

electric potential

\(\Psi\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}\)

electric field

\(\mathbf{E}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}\)

compressibility

\(\kappa\)

\(\text{mol}\,\text{kJ}^{-1}\)

field-interaction

\(\tilde\chi\)

\(\text{kJ}\,\text{mol}^{-1}\)

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants

Constant

Symbol

Value

gas constant

\(R\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Boltzmann’s constant

\(k_\text{B}\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Avogadro’s constant

\(N_\text{A}\)

\(6.02214076 \cdot 10^23~\text{mol}^{-1}\)

Vacuum permittivity

\(\varepsilon_0\)

\(8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2\)

Coulomb constant

\(k_\text{e}\)

\(138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}\)

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/doc_pages/electrostatics.html b/v1.0.5/doc_pages/electrostatics.html new file mode 100644 index 00000000..70eb8efc --- /dev/null +++ b/v1.0.5/doc_pages/electrostatics.html @@ -0,0 +1,312 @@ + + + + + + + 3. Electrostatic interactions — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Electrostatic interactions

+

In the filtered Hamiltonian hPF formalism [Bore and Cascella, 2020] the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle–mesh Ewald.

+

The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered

+
+\[\tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i),\]
+

with \(q_i\) being the charge of particle \(i\) and \(H\) is the +filtering function (see Filtering). The value of the charge grid at +vertex \((i,j,k)\) is found by

+
+\[\tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)]\]
+

and the electrostatic potential \(\Psi_{ijk}\)

+
+\[\Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right],\]
+

where \(k_\text{e}\) is the Coulomb constant \(1/4\pi\varepsilon_0\). +The electric field is obtained by differentiation of the electrostatic +potential in Fourier space,

+
+\[\mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)]\]
+

from which the forces are interpolated back to the particle positions.

+
+

3.1. Specifying electrostatics

+

In HyMD, electrostatics are specified by the coulombtype and +dielectric_const keywords in the configuration file (see +Configuration file) and the /charge dataset in the HDF5 format +structure/topology input file (see Topology and structure file). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/doc_pages/examples.html b/v1.0.5/doc_pages/examples.html new file mode 100644 index 00000000..f5c62575 --- /dev/null +++ b/v1.0.5/doc_pages/examples.html @@ -0,0 +1,760 @@ + + + + + + + 1. Examples — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Examples

+

The following examples are ordered in more or less order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the HyMD-tutorial github repository.

+
+

1.1. Ideal gas

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true +

The simplest possible system is one with no interactions at all—intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like:

+
+
ideal_gas.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = false         # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+
+
+

A simple input structure/topology file ideal_gas.HDF5 is available in +the HyMD-tutorial/ideal_gas github repository (along with the code to +generate it). Run the (very) short simulation by

+
python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field   \
+                                              --velocity-output \
+                                              --force-output
+
+
+

with the --disable-field argument to completely turn off all +particle–field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook ideal_gas.ipynb for details.

+
+
+

1.2. Ideal chains

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true +

The simplest available interaction is the harmonic two-particle bond (see +Intramolecular bonds),

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2.\]
+

Extending the configuration file from the ideal gas case, we need to add a +bonds specification. Note that the [bonds] meta specifier is not +necessary, but may be used to help organise the input file.

+
+
ideal_chain.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+
+
+

A simple input structure/topology file ideal_chain.HDF5 with a few +coiled up ideal chain polymers is available in the +HyMD-tutorial/ideal_chain github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field
+
+
+

we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +ideal_chain.ipynb.

+
+
+

1.3. Stiff rods

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true +

Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the i--j--k angle \(\theta\) (see +Intramolecular bonds),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2.\]
+

Extending the configuration file from the ideal chain case, we need to add a +angle_bonds specification. Note that the [bonds] meta specifier +is not necessary, but may be used to help organise the input file.

+
+
rods.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+angle_bonds = [
+  ["A", "A", "A", 180.0, 100.0],   # (i, j, k, equilibrium angle, strength)
+]
+
+
+
+

A simple input structure/topology file rods.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook rods.ipynb.

+
+
+

1.4. Helixes

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true +

Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle \(\phi\) between the +i--j--k plane and the j--k--l plane (see Intramolecular bonds),

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n).\]
+

The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a dihedrals keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the dielectric_const +keyword even though we are not including electrostatic forces in the current +simulation. Note that the [bonds] meta specifier is not necessary, but +may be used to help organise the input file.

+
+
helixes.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+dielectric_const = 15.0
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.31, 10000.0],       # (i name, j name, equilibrium length, strength)
+]
+
+dihedrals = [
+  [
+    ["A", "A", "A", "A"],
+    [
+      [-1],
+      [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+      [0.08, 0.46, 1.65, -0.96, 0.38],
+    ],
+    [1.0]
+  ],
+]
+
+
+
+

A simple input structure/topology file helixes.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook helixes.ipynb.

+
+
+

1.5. Phase separation

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true +

The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types A and B. Using the Hamiltonian

+
+\[\mathcal{H}=H_0+W\]
+

with \(\tilde\chi\)–dependent interactions defined by (specified in the +configuration file by hamiltonian = DefaultWithChi):

+
+\[W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2.\]
+
+
phase_separation.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+
+[field]
+mesh_size = [20, 20, 20]           # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+kappa = 0.05                       # compressibility in mol/kJ
+chi = [
+  ['A', 'B', 5.0],                 # (name i, name j, strength)
+]
+
+
+
+

A simple input structure/topology file phase_separation.HDF5 containing +an equal number of A type and B type particles is available in +the HyMD-tutorial/phase_separation github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd phase_separation.toml phase_separation.HDF5
+
+
+

we may examine the resulting trajectory. In the case of a low interaction +strength \(\tilde\chi\) of 5.0 (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to 40.0 (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +phase_separation.ipynb.

+
+
+

1.6. Diblock copolymers

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true +

Having introduced particle–field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive \(\tilde\chi\)–interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the integrator = "respa" keyword. Putting the pieces together, the +configuration file may look like the following:

+
+
copolymer.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 15
+n_steps = 2000                     # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [10.0, 10.0, 10.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [50, 50, 50]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+chi = [
+  ["A", "B", 30.0],                # (i, j, strength)
+]
+
+[bonds]
+bonds = [
+  ["A", "A", 0.25, 1500.0],        # (i, j, equilibrium length, strength)
+  ["A", "B", 0.25, 1500.0],
+  ["B", "B", 0.25, 1500.0],
+]
+angle_bonds = [
+  ["A", "A", "A", 180.0, 25.0],    # (i, j, k, equilibrium angle, strength)
+  ["B", "B", "B", 180.0, 25.0],
+]
+
+
+
+

A simple input structure/topology file copolymer.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/copolymer github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten A followed by ten B type particles. +Running the simulation with

+
python3 -m hymd copolymer.toml copolymer.HDF5
+
+
+

the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +copolymer.ipynb.

+
+
+

1.7. Lipid bilayer self-assembly

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true +

Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field–particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the thermostat_coupling_groups keyword. With parameters +optimised in [Ledum et al., 2020], the configuration file looks like:

+
+
lipid_self_assembly.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 25
+n_steps = 3000
+n_print = 200
+n_flush = 1
+time_step = 0.01
+box_size = [9.96924, 9.96924, 10.03970]
+start_temperature = 323
+target_temperature = 323
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.05
+domain_decomposition = 10001
+cancel_com_momentum = true
+max_molecule_size = 15
+thermostat_coupling_groups = [
+  ["N", "P", "G", "C"],
+  ["W"],
+]
+
+[field]
+mesh_size = [25, 25, 25]
+sigma = 1.0
+chi = [
+  ["C", "W", 42.24],
+  ["G", "C", 10.47],
+  ["N", "W", -3.77],
+  ["G", "W", 4.53],
+  ["N", "P", -9.34],
+  ["P", "G", 8.04],
+  ["N", "G", 1.97],
+  ["P", "C", 14.72],
+  ["P", "W", -1.51],
+  ["N", "C", 13.56],
+]
+
+[bonds]
+bonds = [
+  ["N", "P", 0.47, 1250.0],
+  ["P", "G", 0.47, 1250.0],
+  ["G", "G", 0.37, 1250.0],
+  ["G", "C", 0.47, 1250.0],
+  ["C", "C", 0.47, 1250.0],
+]
+angle_bonds = [
+  ["P", "G", "G", 120.0, 25.0],
+  ["P", "G", "C", 180.0, 25.0],
+  ["G", "C", "C", 180.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

A randomly mixed input structure/topology file +lipid_self_assembly.HDF5 with a few hundred lipids in a roughy +10 x 10 x 10nm box is available in the +HyMD-tutorial/lipid_self_assembly github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation

+
python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5
+
+
+

we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook lipid_self_assembly.ipynb.

+
+
+

1.8. Peptide in lipid bilayer

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true +

Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer.

+

The configuration file is available in the HyMD-tutorial/peptide github +repository (omitted here for brevity).

+

A pre-equilibrated input structure/topology file peptide.HDF5 with a +few hundred lipids in a roughy 20 x 20 x 20nm box is available in the +HyMD-tutorial/peptide github repository. Running the simulation

+
python3 -m hymd peptide.toml peptide.HDF5
+
+
+

we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook peptide.ipynb.

+
+
+

1.9. SDS

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true +

The last part we introduce is explicit electrostatic interactions through +particle–mesh Ewald. Enabling the electrostatic calculations is done via the +coulombtype keyword. "PIC_Spectral" is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the dielectric_const keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge.

+
+
sds.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 10
+n_steps = 3000
+n_print = 1500
+n_flush =
+time_step = 0.01
+box_size = [8.3, 8.3, 8.3]
+start_temperature = 298
+target_temperature = 298
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.1
+domain_decomposition = 10000
+cancel_com_momentum = true
+max_molecule_size = 5
+thermostat_coupling_groups = [
+  ["S", "C"],
+  ["W", "Na"],
+]
+dielectric_const = 45.0              # dielectric constant for the simulation medium
+coulombtype = "PIC_Spectral"         # particle in cloud, spectral method
+
+[field]
+mesh_size = [64, 64, 64]
+sigma = 0.5
+chi = [
+  ["S", "C",  13.50],
+  ["S", "Na",  0.00],
+  ["S", "W",  -3.60],
+  ["C", "Na", 13.50],
+  ["C", "W",  33.75],
+  ["W", "Na",  0.00],
+]
+
+[bonds]
+bonds = [
+  ["S",   "C",   0.50, 1250.0],
+  ["C",   "C",   0.50, 1250.0],
+]
+angle_bonds = [
+  ["S", "C", "C", 170.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

An input structure/topology file sds.HDF5 with a couple thousand +randomly dispersed SDS chains is available in the HyMD-tutorial/sds github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a /charge dataset. +Running the simulation with

+
python3 -m hymd sds.toml sds.HDF5
+
+
+

we observe the aggregation of the SDS into micellular structures—first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook sds.ipynb.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/doc_pages/filtering.html b/v1.0.5/doc_pages/filtering.html new file mode 100644 index 00000000..b826e3c2 --- /dev/null +++ b/v1.0.5/doc_pages/filtering.html @@ -0,0 +1,299 @@ + + + + + + + 2. Filtering — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Filtering

+

The default grid-independent filter function used in HyMD is a Gaussian

+
+\[H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right]\]
+

with reciprocal space representation

+
+\[\hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right].\]
+

The coarse-graining parameter \(\sigma\) determines a length scale of +particle extent and is given as configuration file input by

+
sigma = 0.75
+
+
+
+

2.1. Implementing new filters

+

Implementing new filter functions is straightforward by hijacking +the setup method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/doc_pages/installation.html b/v1.0.5/doc_pages/installation.html new file mode 100644 index 00000000..05b6a6e0 --- /dev/null +++ b/v1.0.5/doc_pages/installation.html @@ -0,0 +1,407 @@ + + + + + + + 1. Installation — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Installation

+

HyMD may be installed using pip by

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+
+

1.1. Dependencies

+

HyMD requires a working MPI compiler and HDF5. On an Ubuntu system, this +may be installed via

+
sudo apt-get update -y
+sudo apt-get install -y libhdf5-openmpi-dev python3-mpi4py
+CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-cache-dir --no-binary=h5py h5py
+
+
+

It is highly recommended to have MPI-enabled HDF5 and h5py. A +non-MPI-enabled h5py may be installed by simply

+
sudo apt-get update -y
+sudo apt-get install libhdf5-serial-dev
+python3 -m pip --upgrade install h5py
+
+
+

A non-MPI-enabled HDF5 library with corresponding h5py will work +(mostly), but is inconvenient and slow. Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +--disable-mpio argument to HyMD, see Command line arguments. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial.

+
+
+

1.2. Install in docker

+

A docker image with build essentials setup is available at dockerhub with tag +mortele/hymd,

+
docker pull mortele/hymd:latest
+docker run -it mortele/hymd
+/app$ python3 -m pip install hymd
+
+# Grab example input files
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5
+
+# Run simulation
+/app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose
+
+
+
+
+

1.3. Run interactively in Google Colaboratory

+

A Google Colaboratory jupyter notebook is setup here with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons.

+
+
+

1.4. Common issues

+
+

1.4.1. Numpy errors while importing the Fortran force kernels

+
RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd
+
+Traceback (most recent call last):
+
+  (...)
+
+File "/..../HyMD/hymd/__init__.py", line 2, in <module>
+  from .main import main  # noqa: F401
+File "/..../HyMD/hymd/main.py", line 10, in <module>
+  from .configure_runtime import configure_runtime
+File "/..../hymd/configure_runtime.py", line 12, in <module>
+  from .input_parser import read_config_toml, parse_config_toml
+File "/..../HyMD/hymd/input_parser.py", line 12, in <module>
+  from .force import Bond, Angle, Dihedral, Chi
+File "/..../HyMD/hymd/force.py", line 8, in <module>
+  from force_kernels import (  # noqa: F401
+ImportError: numpy.core.multiarray failed to import
+
+
+

can normally be fixed by updating numpy versions,

+
python3 -m pip install -U numpy
+
+
+
+
+

1.4.2. Error building pfft-python due to missing curl/wget

+
Building wheel for pfft-python (setup.py) ... error
+ERROR: Command errored out with exit status 1:
+command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_
+cwd: /tmp/pip-install-fr6nt9m4/pfft-python/
+Complete output (56 lines):
+running bdist_wheel
+running build
+running build_py
+
+  (...)
+
+curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found
+wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found
+Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+Please check curl or wget
+You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/
+Traceback (most recent call last):
+  File "<string>", line 1, in <module>
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in <module>
+    setup(
+  File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup
+    return distutils.core.setup(**attrs)
+  File "/usr/lib/python3.8/distutils/core.py", line 148, in setup
+
+  (...)
+
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions
+    build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:]))
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft
+    raise ValueError("could not build fftw; check MPICC?")
+ValueError: could not build fftw; check MPICC?
+----------------------------------------
+ERROR: Failed building wheel for pfft-python
+Running setup.py clean for pfft-python
+Failed to build pfft-python
+
+
+

can be fixed by installing either curl or wget

+
apt-get install -y curl wget
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/doc_pages/interaction_energy_functionals.html b/v1.0.5/doc_pages/interaction_energy_functionals.html new file mode 100644 index 00000000..e4144fca --- /dev/null +++ b/v1.0.5/doc_pages/interaction_energy_functionals.html @@ -0,0 +1,352 @@ + + + + + + + 1. Interaction energy functionals — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Interaction energy functionals

+

A few interaction energy functionals \(W\) are defined in HyMD through +the Hamiltonian class and associated subclasses.

+
+

1.1. \(\chi\)–interaction and \(\kappa\)–incompressibility

+

The most common hPF energy functional is specified by

+
hamiltonian = "DefaultWithChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where \(\tilde\chi_{\text{A}-\text{B}}\) is the interaction energy between +overlapping densities of particle types \(\text{A}\) and \(\text{B}\). +The incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\tilde\chi\) +and \(\kappa\) in the configuration file (see Configuration file)

+
kappa = 0.05
+chi = [
+   ["A", "B", 15.85],
+   ["B", "C", -5.70],
+   ...
+]
+
+
+
+
+

1.2. Only \(\kappa\)–incompressibility

+

The only \(\kappa\) interactions energy functional is specified by

+
hamiltonian = "DefaultNoChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where the incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.3. Only \(\phi^2\)

+

The \(\phi^2\) interactions energy functional is specified by

+
hamiltonian = "SquaredPhi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2,\]
+

where the \(\phi\) squared term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.4. Implementing new interaction energy forms

+

Implementing new interaction energy functions is straightforward by subclassing +Hamiltonian and applying sympy differentiation to the symbolic +field objects. The sympy.lamdify function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/doc_pages/intramolecular_bonds.html b/v1.0.5/doc_pages/intramolecular_bonds.html new file mode 100644 index 00000000..1c62666a --- /dev/null +++ b/v1.0.5/doc_pages/intramolecular_bonds.html @@ -0,0 +1,392 @@ + + + + + + + 2. Intramolecular bonds — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Intramolecular bonds

+

Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see Configuration file. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +Benchmarks), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable.

+

All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]).

+
+

2.1. Two-particle bonds

+

Stretching bonds in HyMD are implemented as harmonic spring potentials,

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2,\]
+

where \(r=|\mathbf{r}|\) is the inter-particle distance, \(k\) is a +constant of dimension energy (units \(\text{kJ}\,\text{mol}^{-1}\)), and +\(r_0\) is the equilibrum length of the bond (units: \(\text{nm}\)). The +force is calculated as

+
+\[F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r},\]
+

where \(\mathbf{r}\) is the vector pointing from \(i\) to \(j\).

+

In the configuration file, two-particle bonds are specified per particle type:

+
+
configuration_two_particle_example.toml
+
[bonds]
+bonds = [
+   ["A", "A", 0.47, 1250.0],
+   ["A", "B", 0.37,  940.0],
+   ["B", "C", 0.50, 1010.0],
+   ["C", "A", 0.42,  550.0],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.2. Three-particle bonds

+

Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle–particle–particle angle \(\theta\),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2,\]
+

where \(k\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\)), and \(\theta_0\) is the equilibrum +angle of the bond (units: \({}^\circ\)). Defining the particles with labels +\(a\), \(b\), and \(c\), let \(\mathbf{r}_a\) denote the vector +pointing from \(b\) to \(a\), and correspondingly let +\(\mathbf{r}_c\) point from \(b\) to \(c\). The +\(a\)\(b\)\(c\) may be computed through the law of Cosines,

+
+\[\theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right]\]
+

Then the force acting on \(a\) and \(c\) is

+
+\[ \begin{align}\begin{aligned}\mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a},\\\mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c},\end{aligned}\end{align} \]
+

and

+
+\[\mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c\]
+

In the configuration file, three-particle bonds are specified per particle type:

+
+
configuration_three_particle_example.toml
+
[bonds]
+angle_bonds = [
+   ["A", "A", "A", 180.0, 90.0],
+   ["A", "B", "A", 120.0, 55.0],
+   ["B", "C", "C",  30.0, 10.0],
+   ["C", "A", "B", 110.0, 25.5],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.3. Four-particle bonds

+

Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle \(\phi\) between the +\(a\)\(b\)\(c\) and \(b\)\(c\)\(d\) planes, for +a dihedral bond quartet \(a\), \(b\), \(c\), and \(d\). The +potential takes the form

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n),\]
+

where \(c_n\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)), and \(\phi_n\) are +specified phase angles in the cosine series.

+

In the configuration file, four-particle bonds are specified per particle type:

+
+
configuration_four_particle_example.toml
+
[bonds]
+dihedrals = [
+   ["A", "B", "C", "D"],
+   [
+     [-1],
+     [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+     [0.08, 0.46, 1.65, -0.96, 0.38],
+   ],
+   [1.0],
+]
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/doc_pages/overview.html b/v1.0.5/doc_pages/overview.html new file mode 100644 index 00000000..c3f1a3e9 --- /dev/null +++ b/v1.0.5/doc_pages/overview.html @@ -0,0 +1,413 @@ + + + + + + + 2. Usage overview for HylleraasMD — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Usage overview for HylleraasMD

+

HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a toml format configuration file, along with a topology and structure +file specifying the input system in HDF5 format.

+

Configuration file

+

The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a [5, 5, 5] nm simulation box at 300 K may look like +the following:

+
+
config_simple_1.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "SquaredPhi"         # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [30, 30, 30]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+
+
+
+

Note that for the version 1.0 release of HyMD, the [particles], +[simulation], and [field] groups are optional specifiers for +structuring the configuration file.

+

For a full specification of every recognised configuration keyword in HyMD, +please refer to Configuration file.

+

Topology and structure file

+

The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +N particles may look like the following:

+
+
example_structure.HDF5
+
group   /
+   # root group
+
+dataset /coordinates
+   # float32, shape (T, N, D,)
+   # Time steps of N rows of D dimensional coordinate data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /velocities
+   # float32, shape (T, N, D,) OPTIONAL
+   # Time steps of N rows of D dimensional velocity data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /bonds
+   # int32,   shape (N, B,)    OPTIONAL
+   # Each row i contains indices of the particles bonds from/to i
+   # B denotes the maximum bonds per particle
+
+dataset /indices
+   # int32,   shape (N,)
+   # Index of each particle, 0--(N-1)
+
+dataset /molecules
+   # int32,   shape (N,)
+   # Index of molecule each particle belongs to
+   # Used to construct bond network locally on MPI ranks
+
+dataset /names
+   # str10,   shape (N,)
+   # Fixed size string array containing particle type names
+
+dataset /types
+   # int32,   shape (N,)       OPTIONAL
+   # Mapping of particle names to type indices
+
+
+
+

For a full specification of the topology and structure input file, see +Topology and structure file.

+

Command line arguments

+

A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the config_simple_1.toml and example_structure.HDF5 +files may look like the following:

+
mpirun -n ${MPI_NUM_RANKS} python3 -m hymd         \  # HyMD executable
+                           config_simple_1.toml    \  # configuration file
+                           example_structure.HDF5  \  # structure file
+                           --logfile=log_out.txt   \  # set logfile path
+                           --seed 123456           \  # set random seed
+                           --verbose 2             \  # set logging verbosity
+                           --velocity-output          # enable velocity in trajectory output
+
+
+

For a full specification of all command line arguments, see +Command line arguments.

+

More examples

+

For more thorough rundown and concrete usage examples, see +Examples.

+
+

2.1. Running parallel simulations

+

Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the only difference being how the python3 interpreter is +invoked. Prepending mpirun -n ${NPROCS} to the usual +python3 -m hymd runs the simulation with ${NPROCS} MPI ranks.

+

Inputting

+
mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field
+
+
+

sets up an example simulation of the HyMD-tutorial/ideal_gas system. For +more details about this system in particular, or other example simulations, see +the HyMD-tutorial repository.

+
+
+

2.2. Running tests

+

Run serial code tests by

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd
+cd hymd/
+python3 -m pip install pytest pytest-mpi
+python3 -m pytest
+
+
+

There is a small convenience script in hymd/ for running the MPI-enabled +tests,

+
chmod +x pytest-mpi
+./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/doc_pages/theory.html b/v1.0.5/doc_pages/theory.html new file mode 100644 index 00000000..6d8d4e1a --- /dev/null +++ b/v1.0.5/doc_pages/theory.html @@ -0,0 +1,355 @@ + + + + + + + 1. Theory — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Theory

+

Hybrid particle–field simulations switch out the ordinary particle–particle +Lennard-Jones interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle–field densities are +defined as

+
+\[\phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i),\]
+

where \(\mathbf{r}\) is a spatial coordinate, \(P\) is a window function +used to distribute particle number densities onto a computational grid, and +\(\mathbf{r}_i\) is the position of particle \(i\) (of total \(N\)). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of \(N\) particles in \(M\) molecules is

+
+\[\mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})]\]
+

with \(H_0\) being a standard intramolecular Hamiltonian form (see +Intramolecular bonds) including kinetic terms, while \(W\) is a density +dependent interaction energy functional.

+

In the Hamiltonian hPF-MD formalism [Bore and Cascella, 2020], the density +field is filtered using a grid-independent filtering function \(H\),

+
+\[\tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}).\]
+

The filter smooths the density, ensuring that \(\tilde\phi\) and +\(W[\tilde\phi([\phi])]\) both converge as the grid size is reduced.

+
+

1.1. External potential

+

The external potential acting on a particle is defined as the functional +derivative of \(W\) with respect to \(\phi\). In the filtered formalism, +the potential takes the form

+
+\[\begin{split}V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ +&= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})},\end{split}\]
+

under the assumption of a local form of the interaction energy functional, +\(W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]\). Note +that

+
+\[\frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}).\]
+
+
+

1.2. Force interpolation

+

The forces on particle \(i\) are obtained by differentiation of the external +potential,

+
+\[\mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i).\]
+
+
+

1.3. Reciprocal space calculations

+

The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density \(\phi_{ijk}\) with CIC, we apply the filtering +and obtain the discrete version of the external potential by

+
+\[\tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big]\]
+

and

+
+\[V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+

The forces are obtained by differentiation of \(V\) in Fourier space as

+
+\[\nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+
+
+

1.4. Filter

+

By default, the filter used in HyMD is a simple Gaussian of the form

+
+\[\begin{split}H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ +\hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right].\end{split}\]
+

For more details about the filtering, see Filtering.

+
+
+

1.5. Hamiltonian form

+

The default form of the interaction energy functional in HyMD is

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2.\]
+

See Interaction energy functionals for details.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/doc_pages/topology_input.html b/v1.0.5/doc_pages/topology_input.html new file mode 100644 index 00000000..8dc6db01 --- /dev/null +++ b/v1.0.5/doc_pages/topology_input.html @@ -0,0 +1,336 @@ + + + + + + + 4. Topology and structure file — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Topology and structure file

+

The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root / group.

+

The HyMD-tutorial has multiple examples of structure files for various levels +of complexity.

+
+

4.1. Required datasets

+
+
/coordinates:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/indices:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/names:
+

array shape [N,]

+

datatype [string (length between 1 and 16)]

+

The shape represents one particle name per N particles. The datatype may be a string of length =<16.

+
+
+
+
+

4.2. Optional datasets

+
+
/velocities:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/types:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle type index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/molecules:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one molecule index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/bonds:
+

array shape [N, B,]

+

datatype [int32 or int64]

+

The shape represents B bond specifications (indices of different particles) per N particles. The data type may be either 32 or 64 bit integers.

+
+
/charge:
+

array shape [N,]

+

datatype [float32 or float64]

+

The shape represents one particle charge per N particles. The data type may be either four or eight byte reals.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/genindex.html b/v1.0.5/genindex.html new file mode 100644 index 00000000..50962e07 --- /dev/null +++ b/v1.0.5/genindex.html @@ -0,0 +1,814 @@ + + + + + + Index — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + +
+ +

F

+ + + +
+ +

G

+ + +
+ +

H

+ + + +
    +
  • + hymd.input_parser + +
  • +
  • + hymd.integrator + +
  • +
  • + hymd.thermostat + +
  • +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/index.html b/v1.0.5/index.html new file mode 100644 index 00000000..a761ec71 --- /dev/null +++ b/v1.0.5/index.html @@ -0,0 +1,400 @@ + + + + + + + HylleraasMD documentation — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

HylleraasMD documentation

+
+
Release:
+

1.0.5

+
+
Date:
+

Feb 02, 2022

+
+
+

HylleraasMD (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems.

+

HyMD can run canonical hPF-MD simulations [Milano and Kawakatsu, 2009], or filtered +density Hamiltonian hPF (HhPF-MD) simulations [Bore and Cascella, 2020], with +or without explicit PME electrostatic interactions [Kolli et al., 2018]. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +[Bore et al., 2018, Cascella et al., 2008]. Martini +style elastic networks (ElNeDyn) [Periole et al., 2009] are also +supported.

+

HyMD uses the pmesh (github.com/rainwoodman/pmesh) library for particle-mesh +operations, with the PPFT [Pippig, 2013] backend for FFTs through the +pfft-python bindings (github.com/rainwoodman/pfft-python). File IO is done +via HDF5 formats to allow MPI parallel reads.

+
+

User Guide

+

The HylleraasMD User Guide provides comprehensive information on how to run +simulations. Selected Examples are available to guide new users.

+
+
+

Installing HyMD

+

The easiest approach is to install using pip:

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+

For more information and required dependencies, see +Installation.

+
+

Run in Google colab

+

Run HyMD interactively in Google Colaboratory jupyter notebook here.

+
+
+
+

Source Code

+

Source code is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the GNU Lesser General Public +License v3.0. Obtain the source code with git:

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git
+
+
+
+
+

Development

+

HyMD is developed and maintained by researchers at the Hylleraas Centre for +Quantum Molecular Sciences at the University of Oslo.

+

pic1 pic2

+
+
+

References

+
+
+[BC20] +

Sigbjørn Løland Bore and Michele Cascella. Hamiltonian and alias-free hybrid particle–field molecular dynamics. J. Chem. Phys., 153(9):094106, 2020. doi:10.1063/5.0020733.

+
+
+[BMC18] +

Sigbjørn Løland Bore, Giuseppe Milano, and Michele Cascella. Hybrid particle-field model for conformational dynamics of peptide chains. J. Chem. Theory Comput., 14(2):1120–1130, 2018. doi:10.1021/acs.jctc.7b01160.

+
+
+[BDP07] +

Giovanni Bussi, Davide Donadio, and Michele Parrinello. Canonical sampling through velocity rescaling. J. Chem. Phys., 126(1):014101, 2007. doi:10.1063/1.2408420.

+
+
+[CNCDP08] +

Michele Cascella, Marilisa A. Neri, Paolo Carloni, and Matteo Dal Peraro. Topologically based multipolar reconstruction of electrostatic interactions in multiscale simulations of proteins. J. Chem. Theory Comput., 4(8):1378–1385, 2008. doi:10.1021/ct800122x.

+
+
+[KDNB+18] +

Hima Bindu Kolli, Antonio De Nicola, Sigbjørn Løland Bore, Ken Schäfer, Gregor Diezemann, Jürgen Gauss, Toshihiro Kawakatsu, Zhong-Yuan Lu, You-Liang Zhu, Giuseppe Milano, and Michele Cascella. Hybrid particle-field molecular dynamics simulations of charged amphiphiles in an aqueous environment. J. Chem. Theory Comput., 14(9):4928–4937, 2018. doi:10.26434/chemrxiv.6264644.v1.

+
+
+[LBC20] +

Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Automated determination of hybrid particle-field parameters by machine learning. Mol. Phys., 118(19-20):e1785571, 2020. doi:10.1080/00268976.2020.1785571.

+
+
+[MK09] +

Giuseppe Milano and Toshihiro Kawakatsu. Hybrid particle-field molecular dynamics simulations for dense polymer systems. J. Chem. Phys., 130(21):214106, 2009. doi:10.1063/1.3142103.

+
+
+[PCMC09] +

Xavier Periole, Marco Cavalli, Siewert-Jan Marrink, and Marco A Ceruso. Combining an elastic network with a coarse-grained molecular force field: structure, dynamics, and intermolecular recognition. Journal of chemical theory and computation, 5(9):2531–2543, 2009. doi:10.1021/ct9002114.

+
+
+[Pip13] +

Michael Pippig. Pfft: an extension of fftw to massively parallel architectures. SIAM J. Sci. Comput., 35(3):C213–C236, 2013. doi:10.1137/120885887.

+
+
+[TBM92] +

MBBJM Tuckerman, Bruce J Berne, and Glenn J Martyna. Reversible multiple time scale molecular dynamics. J. Chem. Phys., 97(3):1990–2001, 1992. doi:10.1063/1.463137.

+
+
+
+
+
+

Indices and tables

+ +
+
+
+
+
+
+
+
+
+ + + +
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+ + + + + +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/objects.inv b/v1.0.5/objects.inv new file mode 100644 index 00000000..07e26012 Binary files /dev/null and b/v1.0.5/objects.inv differ diff --git a/v1.0.5/py-modindex.html b/v1.0.5/py-modindex.html new file mode 100644 index 00000000..a52a762a --- /dev/null +++ b/v1.0.5/py-modindex.html @@ -0,0 +1,322 @@ + + + + + + Python Module Index — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ h +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ h
+ hymd +
    + hymd.field +
    + hymd.file_io +
    + hymd.force +
    + hymd.input_parser +
    + hymd.integrator +
    + hymd.thermostat +
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.5/search.html b/v1.0.5/search.html new file mode 100644 index 00000000..c9cfa578 --- /dev/null +++ b/v1.0.5/search.html @@ -0,0 +1,292 @@ + + + + + + Search — hymd 1.0.5 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.5 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v1.0.5/searchindex.js b/v1.0.5/searchindex.js new file mode 100644 index 00000000..e12e8977 --- /dev/null +++ b/v1.0.5/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["doc_pages/api","doc_pages/benchmarks","doc_pages/command_line","doc_pages/config_file","doc_pages/constants_and_units","doc_pages/electrostatics","doc_pages/examples","doc_pages/filtering","doc_pages/installation","doc_pages/interaction_energy_functionals","doc_pages/intramolecular_bonds","doc_pages/overview","doc_pages/theory","doc_pages/topology_input","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,"sphinxcontrib.bibtex":9,sphinx:56},filenames:["doc_pages/api.rst","doc_pages/benchmarks.rst","doc_pages/command_line.rst","doc_pages/config_file.rst","doc_pages/constants_and_units.rst","doc_pages/electrostatics.rst","doc_pages/examples.rst","doc_pages/filtering.rst","doc_pages/installation.rst","doc_pages/interaction_energy_functionals.rst","doc_pages/intramolecular_bonds.rst","doc_pages/overview.rst","doc_pages/theory.rst","doc_pages/topology_input.rst","index.rst"],objects:{"hymd.field":{compute_field_and_kinetic_energy:[0,1,1,""],compute_field_energy_q_GPE:[0,1,1,""],compute_field_force:[0,1,1,""],compute_self_energy_q:[0,1,1,""],domain_decomposition:[0,1,1,""],initialize_pm:[0,1,1,""],update_field:[0,1,1,""],update_field_force_q:[0,1,1,""],update_field_force_q_GPE:[0,1,1,""]},"hymd.file_io":{OutDataset:[0,2,1,""],distribute_input:[0,1,1,""],setup_time_dependent_element:[0,1,1,""],store_data:[0,1,1,""],store_static:[0,1,1,""]},"hymd.file_io.OutDataset":{close_file:[0,3,1,""],flush:[0,3,1,""],is_open:[0,3,1,""]},"hymd.force":{Angle:[0,2,1,""],Bond:[0,2,1,""],Chi:[0,2,1,""],Dielectric_type:[0,2,1,""],Dihedral:[0,2,1,""],compute_angle_forces__plain:[0,1,1,""],compute_bond_forces__plain:[0,1,1,""],compute_dihedral_forces__plain:[0,1,1,""],dipole_forces_redistribution:[0,1,1,""],find_all_paths:[0,1,1,""],prepare_bonds:[0,1,1,""],prepare_bonds_old:[0,1,1,""],prepare_index_based_bonds:[0,1,1,""],propensity_potential_coeffs:[0,1,1,""]},"hymd.force.Angle":{atom_3:[0,4,1,""]},"hymd.force.Bond":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],equilibrium:[0,4,1,""],strength:[0,4,1,""]},"hymd.force.Chi":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],interaction_energy:[0,4,1,""]},"hymd.force.Dielectric_type":{atom_1:[0,4,1,""],dielectric_value:[0,4,1,""]},"hymd.force.Dihedral":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],atom_3:[0,4,1,""],atom_4:[0,4,1,""],coeffs:[0,4,1,""],dih_type:[0,4,1,""]},"hymd.hamiltonian":{DefaultNoChi:[0,2,1,""],DefaultWithChi:[0,2,1,""],Hamiltonian:[0,2,1,""],SquaredPhi:[0,2,1,""]},"hymd.hamiltonian.DefaultNoChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.DefaultWithChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.Hamiltonian":{__init__:[0,3,1,""],_setup:[0,3,1,""]},"hymd.hamiltonian.SquaredPhi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.input_parser":{Config:[0,2,1,""],check_NPT_conditions:[0,1,1,""],check_angles:[0,1,1,""],check_bonds:[0,1,1,""],check_box_size:[0,1,1,""],check_cancel_com_momentum:[0,1,1,""],check_charges:[0,1,1,""],check_charges_types_list:[0,1,1,""],check_chi:[0,1,1,""],check_config:[0,1,1,""],check_dielectric:[0,1,1,""],check_dihedrals:[0,1,1,""],check_domain_decomposition:[0,1,1,""],check_hamiltonian:[0,1,1,""],check_integrator:[0,1,1,""],check_m:[0,1,1,""],check_mass:[0,1,1,""],check_max_molecule_size:[0,1,1,""],check_n_b:[0,1,1,""],check_n_flush:[0,1,1,""],check_n_particles:[0,1,1,""],check_n_print:[0,1,1,""],check_name:[0,1,1,""],check_start_and_target_temperature:[0,1,1,""],check_tau:[0,1,1,""],check_thermostat_coupling_groups:[0,1,1,""],parse_config_toml:[0,1,1,""],read_config_toml:[0,1,1,""],sort_dielectric_by_type_id:[0,1,1,""]},"hymd.input_parser.Config":{a:[0,4,1,""],angle_bonds:[0,4,1,""],barostat:[0,4,1,""],barostat_type:[0,4,1,""],bonds:[0,4,1,""],box_size:[0,4,1,""],cancel_com_momentum:[0,4,1,""],chi:[0,4,1,""],conv_crit:[0,4,1,""],convergence_type:[0,4,1,""],coulomb_constant:[0,4,1,""],coulombtype:[0,4,1,""],dielectric_const:[0,4,1,""],dielectric_type:[0,4,1,""],dihedrals:[0,4,1,""],domain_decomposition:[0,4,1,""],dtype:[0,4,1,""],file_name:[0,4,1,""],gas_constant:[0,4,1,""],hamiltonian:[0,4,1,""],initial_energy:[0,4,1,""],integrator:[0,4,1,""],kappa:[0,4,1,""],m:[0,4,1,""],mass:[0,4,1,""],max_molecule_size:[0,4,1,""],mesh_size:[0,4,1,""],n_b:[0,4,1,""],n_flush:[0,4,1,""],n_particles:[0,4,1,""],n_print:[0,4,1,""],n_steps:[0,4,1,""],name:[0,4,1,""],pol_mixing:[0,4,1,""],pressure:[0,4,1,""],respa_inner:[0,4,1,""],rho0:[0,4,1,""],self_energy:[0,4,1,""],sigma:[0,4,1,""],start_temperature:[0,4,1,""],tags:[0,4,1,""],target_pressure:[0,4,1,""],target_temperature:[0,4,1,""],tau:[0,4,1,""],tau_p:[0,4,1,""],thermostat_coupling_groups:[0,4,1,""],thermostat_work:[0,4,1,""],time_step:[0,4,1,""],type_charges:[0,4,1,""]},"hymd.integrator":{integrate_position:[0,1,1,""],integrate_velocity:[0,1,1,""]},"hymd.logger":{Logger:[0,2,1,""],MPIFilterAll:[0,2,1,""],MPIFilterRoot:[0,2,1,""]},"hymd.logger.Logger":{setup:[0,3,1,""]},"hymd.logger.MPIFilterAll":{filter:[0,3,1,""]},"hymd.logger.MPIFilterRoot":{filter:[0,3,1,""]},"hymd.thermostat":{_random_chi_squared:[0,1,1,""],_random_gaussian:[0,1,1,""],csvr_thermostat:[0,1,1,""]},hymd:{field:[0,0,0,"-"],file_io:[0,0,0,"-"],force:[0,0,0,"-"],input_parser:[0,0,0,"-"],integrator:[0,0,0,"-"],thermostat:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0020733":14,"00268976":14,"0083144621":0,"01036426965":4,"014101":[0,14],"02214076":4,"03642696562":4,"03970":6,"08790868":[6,10],"094106":14,"0xd":8,"0xe":8,"100":[4,6,11],"1000":6,"10000":6,"10001":6,"1010":10,"1021":14,"1063":14,"1080":14,"10nm":6,"110":10,"1120":[0,14],"1130":[0,14],"1137":14,"118":14,"120":[3,6,10],"120885887":14,"120ff":0,"123456":11,"1250":[3,6,10],"126":[0,14],"130":14,"1378":14,"138":[0,4],"1385":14,"144":8,"148":8,"1500":6,"153":14,"170":6,"1785571":14,"179":0,"180":[3,6,10],"1974":0,"1981":0,"1990":14,"1992":[3,14],"200":[6,10],"2000":6,"2001":14,"2007":[0,3,14],"2008":[0,14],"2009":14,"201":[0,3],"2013":14,"2018":[0,14],"2020":[5,6,12,14],"2022":14,"20nm":6,"214106":14,"223":0,"224":1,"2408420":14,"2408724":[6,10],"246":0,"251":[6,10],"2531":14,"2543":14,"26434":14,"28103735":0,"298":6,"2_1":0,"2don2d":8,"2nd":0,"300":[6,11],"3000":6,"3142103":14,"3144621":4,"323":6,"449":[6,10],"463137":14,"48626121":[6,10],"4928":14,"4937":14,"533":1,"544":[6,10],"550":10,"59427866":[6,10],"602176634":4,"610":[6,10],"6264644":14,"66053906660":4,"7b01160":14,"85418781281":4,"935458":[0,4],"940":10,"96924":6,"980":3,"9918564":[6,10],"boolean":3,"byte":13,"case":[0,3,6,10],"class":[0,9],"default":[0,3,7,11,12,13],"float":[0,3],"function":[0,3,5,6,7,11,12],"int":[0,5,6,9,12],"long":[5,6],"new":[0,10,13,14],"public":14,"return":[0,8],"short":[6,11],"sigbj\u00e3":14,"static":0,"switch":12,"true":[0,3,6],"while":[0,12],Adding:6,For:[0,11,12,14],The:[0,3,5,6,7,9,10,11,12,13,14],Then:10,There:11,These:0,Used:[0,3,11],Using:[6,9],With:[0,6],__file__:8,__init__:[0,8],_gener:0,_random_chi_squar:0,_random_gaussian:0,_setup:0,about:[3,11,12],abov:[0,6],absent:0,acceler:0,accompani:6,accord:[0,3],accur:14,acid:6,across:[0,3],acs:14,act:[0,10,12],adapt:0,add:[5,6],added:0,adding:6,addison:0,addit:[0,2,5,11],addition:14,additon:0,adher:0,affect:0,affili:[0,2],after:[0,10,12],against:8,aggreg:6,ahren:0,alanin:6,algorithm:[0,3,12],alia:14,all:[0,2,3,4,6,8,10,11,14],all_nam:0,all_rank:0,alloc:0,allow:[11,14],allreduc:0,along:[6,11],alpha3:8,alpha:0,also:[6,8,14],altern:2,alwai:[0,3],amino:6,amphiphil:14,analyt:0,angl:[0,2,3,6,8,10],angle_bond:[0,3,6,10],angular:[0,3,6,10],ani:[0,2,3],anisotrop:0,antonio:14,apart:0,api:8,app:8,appli:[0,3,7,9,12],applic:0,approach:14,approxim:0,apt:8,aqueou:14,architectur:14,arg:0,argument:[0,6,8,11],argv:8,aris:0,around:10,arrai:[0,3,11,13],arriv:6,art:0,aspect:3,assess:0,assign:[0,3,10],associ:[0,9],assum:3,assumpt:12,atom:0,atom_1:0,atom_2:0,atom_3:0,atom_4:0,attach:13,attempt:0,attr:8,attract:3,attribut:0,autom:14,automat:[0,7,9],avail:[6,8,14],averag:[0,9],avogadro:4,back:[0,5],backbon:[0,2,3,14],backcon:0,backend:14,backmap:0,balanc:0,ballist:6,bar:4,barostat:0,barostat_typ:0,base:[0,14],bath:[0,3],bb_index:0,bc20:14,bdist_wheel:8,bdp07:14,bead:0,becaus:0,becom:0,befor:[0,3,6],being:[0,2,3,5,10,11,12],belong:11,below:6,benchmark:10,bend:[0,3,10,14],bern:14,besid:2,best:0,beta:0,better:0,between:[0,3,5,6,9,10,12,13],bia:0,big:12,bin:8,binari:8,bind:14,bindu:14,bio:14,bit:[0,13],blueprint:0,bmc18:14,boltzmann:[0,3,4],bond2_energi:0,bond3_energi:0,bond4_energi:0,bond:[0,2,6,8,11,12,13],bonds_2:0,bonds_2_atom1:0,bonds_2_atom2:0,bonds_2_atom_1:0,bonds_2_atom_2:0,bonds_2_equilibrium:0,bonds_2_strength:0,bonds_3:0,bonds_3_atom_1:0,bonds_3_atom_2:0,bonds_3_atom_3:0,bonds_3_equilibrium:0,bonds_3_strength:0,bonds_4:0,bonds_4_atom_1:0,bonds_4_atom_2:0,bonds_4_atom_3:0,bonds_4_atom_4:0,bonds_4_coeff:0,bonds_4_last:0,bonds_4_typ:0,bool:0,bore:[0,5,12,14],both:[0,12],boundari:[0,3],box:[0,3,6,11],box_siz:[0,3,6,11],breviti:6,broadcast:0,browser:8,bruce:14,buffer:[0,3],build_extens:8,build_pfft:8,build_pi:8,built:8,bussi:[0,3,14],c213:14,c236:14,c_n:[0,6,10],cach:8,calcul:[0,3,6,10],calibr:0,call:[0,8],callabl:0,can:[6,8,14],cancel_com_momentum:[0,3,6],canon:[0,3,14],capabl:2,captur:11,carloni:14,carri:6,cascella:[5,8,11,12,14],caval:14,cbt:0,cdot10:4,cdot:[0,4,10],cell:[0,12],center:[0,3],centr:14,certain:[0,2],ceruso:14,chain:[0,14],chang:[0,3],changedin:0,charg:[0,3,4,5,6,13,14],charge_out:0,check:[0,8],check_angl:0,check_bond:0,check_box_s:0,check_cancel_com_momentum:0,check_charg:0,check_charges_types_list:0,check_chi:0,check_config:0,check_dielectr:0,check_dihedr:0,check_domain_decomposit:0,check_hamiltonian:0,check_integr:0,check_m:0,check_mass:0,check_max_molecule_s:0,check_n_b:0,check_n_flush:0,check_n_particl:0,check_n_print:0,check_nam:0,check_npt_condit:0,check_start_and_target_temperatur:0,check_tau:0,check_thermostat_coupling_group:0,chem:[0,14],chemic:14,chemrxiv:14,chi:[0,3,4,6,8],chi_2:0,chi_3:0,chi_:[0,3,6,9,12],chi_m:0,chmod:11,chosen:0,cic:[0,5,12],circ:[3,10],circumv:12,classmethod:0,classvar:0,clean:[0,8],clone:[11,14],close:[0,8],close_fil:0,closest:0,cloud:[0,6,12],cncdp08:14,coars:[0,3,7,14],code:[0,1,2,3,6,8,11],coeff:0,coeffici:0,coil:[0,6],colab:8,colaboratori:14,collect:[0,13],com:[0,8,11,14],combin:[0,6,14],comm:0,comm_world:0,command:[8,11],common:9,commuic:0,commun:[0,3,10],communc:0,compar:6,compat:2,compil:[0,8],compiler_so:8,complesfield:0,complet:[0,6,8],complex:[6,13],complexfield:0,compon:0,comprehens:14,compress:[0,3,4,6,9,11],comput:[0,5,10,12,14],compute_angle_forces__plain:0,compute_bond_forces__plain:0,compute_dihedral_forces__plain:0,compute_field_and_kinetic_energi:0,compute_field_energy_q_gp:0,compute_field_forc:0,compute_potenti:0,compute_self_energy_q:0,concret:11,condit:6,config:0,config_simple_1:11,configur:[0,2,5,6,7,9,10,11],configuration_four_particle_exampl:10,configuration_three_particle_exampl:10,configuration_two_particle_exampl:10,configure_runtim:8,conform:[6,13,14],connect:0,conserv:1,consid:6,consist:[0,6],consit:6,consitu:0,constant:[0,3,5,6,10],constitut:[0,2,3],construct:[0,10,11],constructor:0,contain:[0,1,2,3,6,11],content:[0,6],contribut:0,control:3,conv_crit:0,conv_fun:0,conveni:11,converg:[0,12],convergence_typ:0,convert:0,coordin:[11,12,13],copi:0,core:8,correct:[0,3],correspond:[0,3,8],correspondingli:10,cos:[0,6,10],cosin:[0,3,6,10],cost:[3,10],could:8,coulomb:[0,3,4,5],coulomb_const:0,coulombtyp:[0,3,5,6],counter:6,coupl:[0,3,6,11],cprofil:2,cpu:[0,10],crash:3,creat:[0,9],critic:[0,6],cross:0,csvr:[0,3],csvr_thermostat:0,ct800122x:14,ct9002114:14,current:6,cwd:8,cython:[8,14],d_n:0,dal:14,data:[0,6,11,13],dataclass:0,dataset:[0,5,6,11],datatyp:13,date:[0,14],date_format:0,david:14,debug:[0,2],decompos:0,decomposit:[0,3,10],default_level:0,defaultnochi:[0,6,9],defaultnohchi:[0,3],defaultwithchi:[0,3,6,9],defin:[0,6,9,10,12],definit:0,degre:3,delta:[0,12],denot:[0,1,3,9,10,11],dens:14,densiti:[0,3,5,9,12,14],depend:[0,6,10,12,14],deprec:0,deriv:[0,12],design:6,dest_directori:0,detail:[2,3,6,11,12],determin:[0,2,7,14],dev:8,develop:6,deviat:[0,3],dict:0,dictat:0,dictionari:0,dielectr:[0,3,6],dielectric_const:[0,3,5,6],dielectric_typ:0,dielectric_valu:0,dieter:0,diezemann:14,differ:[0,3,6,11,13],differenti:[0,5,7,9,12],difficult:2,dih_typ:0,dihedr:[0,2,3,5,6,8,10,14],dimens:[0,10,11,13],dimension:11,dipol:[0,2,3,5,6,14],dipole_forces_redistribut:0,dir:8,direct:[0,3],directori:11,disabl:[2,6,8,11],disable_mpio:0,discard:0,discret:[0,12],discretis:12,disk:[0,3],dispers:6,dist:8,distanc:[0,3,10],distinct:0,distribut:[0,3,5,6,12],distribute_input:0,distutil:8,doc:0,dockerhub:8,dodecyl:6,doe:[0,10],doi:14,domain:[0,3,10],domain_decomposit:[0,3,6],donadio:[0,14],done:[0,6,14],dopc:6,dot:0,dot_elec:0,doubl:2,double_out:0,download:8,dppc:6,draw:0,drawn:0,driver:11,dtype:0,due:[0,3],dump:0,dump_per_particl:0,dure:[0,2,3,10,11],dynam:[0,3,11,12,14],e1785571:14,e_k:0,each:[0,3,6,10,11],easiest:14,effect:[0,3],effici:10,eight:13,either:[0,3,8,13],elast:14,elec:0,elec_field:0,elec_field_contrib:0,elec_field_fouri:0,elec_forc:0,elecrostat:0,electr:[0,4,5],electrosat:0,electrostat:[0,6,14],elnedyn:14,elucid:6,embed:6,emit:0,emploi:0,empti:0,enabl:[2,6,8,11],enclos:0,end:0,energi:[0,1,3,4,6,7,10,11,12],energiesself:0,ensur:[0,3,6,12],entri:3,environ:14,epsilon:0,equal:[0,3,6],equat:0,equilibr:6,equilibrium:[0,3,6],equilibrum:10,equival:[0,3],error:0,essenti:[0,1,8],etc:[2,3],even:[0,3,6,8],event:0,everi:[0,3,6,10,11],evid:0,ewald:[0,5,6],examin:6,exampl:[3,8,11,13,14],example_structur:11,except:10,exchang:[0,3],exec:8,execut:[0,8,11],exist:0,exit:8,exp:[7,12],expand:0,expans:0,expect:0,expens:[3,12],explicit:[0,6,10,14],express:0,ext:0,extend:6,extens:14,extent:[0,7],extern:0,extract:0,f401:8,f_angl:0,f_bond:0,f_dihedr:0,f_dipol:0,f_on_bead:0,factor:0,factori:0,fail:[0,8],fals:[0,3,6],fashion:[0,3],fast:12,feb:14,fer:14,few:[6,9,10,11],fft:[0,1,2,3,5,6,11,12,14],fftw3:8,fftw:[8,14],field:[2,4,5,6,9,11,12,14],field_energi:0,field_list:0,field_q_energi:0,field_q_self_energi:0,file:[2,5,6,7,8,9,10,11,14],file_io:0,file_nam:0,file_path:0,filter:[0,3,5,6,11,14],find:0,find_all_path:0,first:[0,3,6,11],five:0,fix:[0,8,11],flag:[0,13],flat:11,float32:[11,13],float64:13,flori:0,fluctuat:0,flush:[0,3],follow:[0,2,3,4,6,11],forc:[2,3,4,5,6,10,14],force_kernel:8,force_mesh:0,force_mesh_elec:0,force_mesh_elec_fouri:0,force_out:0,forego:2,form:[0,5,10],formal:[5,12],format:[0,2,3,5,11,13,14],formatt:0,fortran:[0,10],forward:0,found:[5,8],four:[0,2,3,6,13],fourier:[0,5,12],fr6nt9m4:8,frac:[0,5,6,7,9,10,12],frame:[0,11,13],free:14,frequenc:[0,3],from:[0,2,3,5,6,8,9,10,11,14],full:[0,9,11],fulli:[0,6,8],fundament:11,gamma:0,gamma_0:0,gas:[0,4],gas_const:0,gather:0,gauss:14,gaussian:[0,3,7,12],gener:[0,2,3,6,14],get:8,getattr:8,ghost:0,giovanni:14,git:[11,14],github:[6,8,11,14],githubusercont:8,giusepp:14,given:[0,3,6,7],glenn:14,global:0,gnu:14,govern:9,gpe:0,grab:8,gradient:0,grain:[0,3,7,14],graph:0,gregor:14,grid:[0,1,3,5,6,7,11,12],group:[0,3,6,8,11,13,14],guess:0,gyrat:6,h5md:[0,3],h5py:[0,2,8],h_0:[6,12],half:0,hamiltonian:[3,5,6,7,9,11,14],handl:0,handler:0,happen:10,harmon:[0,3,6,10],has:[0,3,13],hat:[7,12],have:[0,6,8],hdf5:[0,2,3,5,6,8,11,13,14],hdf5_mpi:8,head:6,heat:[0,3],helic:[0,3,5,6],help:6,helper:0,here:[0,6,8,14],hhpf:14,highli:[8,10,11],hijack:7,hima:14,hire:1,homogen:0,homopolym:1,homopolypeptid:6,how:[3,11,14],howev:6,hpf:[3,5,9,11,12,14],html:0,http:[0,8,11,14],huggin:0,hundr:[6,10],hybrid:[11,12,14],hylleraa:14,hymd:[0,2,3,4,5,6,7,8,9,10,11,12,13],ideal:10,ideal_chain:[6,8],ideal_ga:[6,11],ident:0,ignor:0,ijk:[5,12],imag:8,impact:0,implement:[0,10],importerror:8,impuls:[0,3],in_fil:0,includ:[0,2,3,6,12,14],incompress:[0,3],inconveni:8,increas:[0,2,6],indentifi:0,independ:[0,3,7,12],index:[0,11,13,14],indic:[0,2,3,10,11,13],indirect:0,individu:[0,3,6],induc:5,infer:10,info:0,inform:[0,10,14],ingredi:6,initi:0,initial_energi:0,initialis:11,initialize_pm:0,inner:[0,3],input:[2,3,4,5,6,7,8,11,13],input_box:0,input_pars:[0,8],insid:[0,3,6],instal:[2,11],install_pfft:8,instantan:0,int32:[11,13],int64:13,integ:[0,3,6,13],integr:[3,6,11],integrate_posit:0,integrate_veloc:0,intend:8,inter:[0,10],interact:[0,2,3,4,6,7,11,12,14],interaction_energi:0,interfac:0,intergr:0,intermediari:0,intermolecular:[6,14],intern:[0,2,4,10],interpol:[0,5],interpret:11,interv:[0,3],intmathrm:0,intracomm:0,intramolecular:[0,3,6,12,14],intrins:5,introduc:6,investig:0,invok:[2,11],involv:[0,3,10],ion:6,ipynb:6,is_open:0,iter:0,j_k:0,jan:14,jctc:14,join:8,jone:12,journal:14,jupyt:[6,8,14],k_e:0,kappa:[0,3,4,6,11,12],kawakatsu:14,kdnb:14,keep:[0,3],kelvin:[0,3,6,11],ken:14,kernel:[0,10],keyword:[0,5,6,11],kinet:[0,12],kinetic_energi:0,knuth:0,kolli:14,kpa:4,label:[1,10],lambda:0,lamdifi:9,land:14,laplacian:0,larg:[8,11],larger:3,last:[6,8,11,13],last_bb:0,later:[0,6],latest:8,law:10,layout:0,layout_q:0,lbc20:14,learn:14,leav:0,ledum:[6,14],left:[0,5,6,7,9,10,12],legend:1,lenght:0,length:[0,3,4,6,7,10,11,13],lennard:12,less:[0,6],lesser:14,let:[0,10],level:[0,2,3,13],liang:14,lib:8,libhdf5:8,librari:[0,2,8,14],licens:14,lieu:0,like:[0,6,11],limit:3,line:[0,8,11],linear:[0,3],lipid_self_assembl:6,list:0,list_coulomb:0,load:0,local:[0,10,11,12],log:[0,2,11],log_fil:0,log_out:11,logfil:[2,11],logger:2,logic:0,logrecord:0,look:[6,11],loop:0,lost:3,low:6,m_j:0,machin:[2,14],made:0,mai:[0,2,3,6,8,10,11,13],main:[0,8,11],maintain:14,make:6,manner:6,manual:8,map:[0,11],marco:14,marilisa:14,marrink:14,martini:[6,14],martyna:14,mass:[0,3,4,13],massiv:14,match:0,math:0,mathbf:[0,4,5,6,9,10,12],mathcal:[6,12],mathmr:0,mathrm:[0,5,6,9,10,12],matteo:14,matter:[6,10,14],max_molecule_s:[0,3,6],maximum:[0,3,10,11],maxwel:[0,3],may:2,mbbjm:14,mean:[0,2,3],measur:10,medium:[0,3,6],melt:1,membran:6,memori:0,mesh:[0,1,3,5,6,14],mesh_siz:[0,3,6,11],messag:0,messi:0,meta:6,metadata:0,method:[0,1,6,7],mh_0:12,micellular:6,michael:14,michel:14,might:0,milano:14,mimic:0,minim:6,minuscul:10,mirror:2,mix:[0,6],mk09:14,model:[6,14],modifi:0,modul:[0,3,8,14],mol:[3,4,6,10,11,14],molecul:[0,3,11,12,13],molecular:[2,11,12,14],momenta:[0,11],momentum:[0,3,4],monoatom:6,more:[2,3,6,11,12,14],mortel:8,morten:14,most:[8,9,11,12],mostli:[2,8],motion:[0,6],move:0,mpi4pi:[0,8,14],mpi:[0,2,3,8,10,11,14],mpi_num_rank:11,mpicc:8,mpifilteral:0,mpifilterroot:0,mpio:[2,8],mpirun:11,multiarrai:8,multipl:[0,3,6,11,13,14],multipolar:14,multiscal:14,must:[0,3],n_b:0,n_flush:[0,3,6],n_frame:0,n_particl:[0,3],n_print:[0,3,6,11],n_step:[0,3,6,11],n_type:0,nabla:[0,12],name:[0,2,3,6,10,11,13],nanomet:[0,1],nanosecond:6,ndarrai:0,ne5et1y_:8,necessari:[0,6],necessit:[8,9],need:[0,6],neg:[0,6],neighbour:0,neri:14,network:[0,10,11,13,14],networkx:0,neutralis:6,never:[0,3],nevertheless:3,next:[0,6],nicola:14,non:[0,2,6,8],none:[0,3],nongnu:0,noqa:8,normal:[0,2,3,8,12],notabl:11,note:[0,6,8,11,12],notebook:[6,8,14],now:6,nproc:11,npt:0,nq_i:5,number:[0,1,2,3,6,11,12,13],numer:0,numpi:[0,2,9,14],nvt:0,object:[0,9],oblat:6,observ:[0,6],obtain:[0,5,12,14],obviou:8,off:6,omit:6,onc:[3,10],one:[0,2,3,6,13],onli:[0,6,10,11],onto:[0,3,5,12],open:[0,8],openmpi:8,oper:[0,3,12,14],oppos:0,optim:[0,10],optimis:[6,10],option:[0,3,6,11],order:[0,3,6,10,11],ordinari:[5,12],org:0,organis:6,origin:0,oslo:14,other:[0,11],otherwis:0,out:[8,12],outdataset:0,outer:0,output:[2,3,4,6,8,11],outsid:3,over:0,overlap:[0,9],packag:[8,11,14],page:14,paint:0,paolo:14,paper:0,parallel:[0,2,3,8,14],paramet:[0,3,6,7,9,14],parent_group:0,parllel:0,parrinello:[0,14],pars:[0,3],parse_config_toml:[0,8],part:[5,6,12],partial:0,particl:[0,2,5,6,7,9,11,12,13,14],particlemesh:0,particular:11,path:[0,2,11],pcmc09:14,pdf:1,pencil:0,peptid:[0,2,3,5,14],per:[0,2,3,10,11,13],peraro:14,perfect:0,perform:[0,3,10,11,12],periol:14,perman:[10,14],permitt:[0,4],pfft:[0,14],pfft_build_dir:8,phase:[0,10],phase_separ:6,phi:[0,3,6,10,12],phi_0:[6,9,12],phi_:[0,6,9,12],phi_ep:0,phi_eps_fouri:0,phi_eta:0,phi_eta_fouri:0,phi_fouri:0,phi_k:0,phi_l:0,phi_laplacian:0,phi_n:[6,10],phi_pol:0,phi_pol_prev:0,phi_q:0,phi_q_fouri:0,phi_transf:0,phospholipid:6,phy:[0,14],pic_spectr:[0,3,6],pic_spectral_gp:0,piec:6,pip13:14,pip:[8,11,14],pippig:14,place:[0,3],plain:2,plane:[0,6,10],pleas:[8,11],plume:0,plumed_bia:0,plumed_out:0,pme:14,pmesh:[0,14],png:1,point:[0,1,10,13],poisson:0,pol_mix:0,polar:0,polym:[6,14],posit:[0,2,3,5,6,11,12],possibl:[0,3,6,14],potenti:[0,3,4,5,7,10,14],ppft:14,practic:10,pre:[0,6],precis:[1,2],prefer:3,prepar:0,prepare_bond:0,prepare_bonds_old:0,prepare_index_based_bond:0,prepend:[0,11],present:[0,2,3,6],preserv:3,pressur:[0,4],pretti:8,previou:0,previous:6,prior:[0,3],priovid:0,prng:0,prod_:0,profil:2,program:[0,11],project:5,promot:0,prop:0,propag:[0,3],propens:[0,3,5,6],propensity_potential_coeff:0,properti:3,protein:[0,14],provid:[0,2,3,11,13,14],psi:[0,4,5],psi_:5,psi_fouri:0,pull:8,put:6,pytest:11,python3:[6,8,11,14],python:[0,11,14],q_i:[0,5],q_j:0,quadrat:0,quanit:0,quantiti:[0,4],quantum:14,quartet:10,quess:0,r_0:[0,6,10],r_a:10,r_c:10,rad:[3,10],radial:6,radii:6,radiu:6,rainwoodman:[8,14],rais:[6,8],random:[0,2,11],random_chi_squar:0,random_gaussian:0,randomli:[0,3,6],rang:5,rank0:0,rank:[0,2,3,10,11],rank_rang:0,rankself:0,rare:10,raw:8,read:[0,8,11,14],read_config_toml:[0,8],readout:0,real:13,realfield:0,realist:6,reappli:0,rearrang:0,reason:8,receiv:[0,3],recent:8,reciproc:[0,7],recognis:11,recognit:14,recommend:8,reconstruct:[0,2,5,6,10,14],record:0,recreat:14,recurs:0,redistribut:0,reduc:[3,12],refer:[3,11],regim:6,regul:[0,3],rel:[0,3,6,10],relax:[0,3],releas:[0,6,8,11,14],remain:[0,6],remov:[0,3],remove_center_of_mass_momentum:0,remove_com_momentum:[0,3],replac:[0,8],repositori:[6,11],repres:[0,3,13],represent:7,repuls:3,requir:[0,3,8,10,11,14],rescal:[0,3,14],research:14,respa:[0,3,6],respa_inn:[0,3,6],respect:[0,1,12],restructur:0,result:[0,3,6,9],revers:[0,3,14],rgen:14,rho0:0,rho:[0,5],rho_0:0,rho_:5,right:[0,5,6,7,9,10,12],rightarrow:10,root:[0,11,13],roughi:6,row:11,rrespa:[0,3,6],ruin:0,run:[0,2,3,6,10],rundown:11,runtimeerror:8,same:[0,3,6],sampl:[0,3,14],scalar:0,scale:[0,3,6,7,8,10,11,14],sch:14,scheme:[0,6],sci:14,scienc:14,script:11,sds:6,search:14,second:[0,11],see:[0,2,3,5,6,8,9,10,11,12,14],seed:[2,11],select:[11,14],self:[0,3,8],self_energi:0,seminumer:0,send:[0,3],separ:0,seri:[0,3,6,10],serial:[8,11],serialis:3,set:[0,3,11],setup:[0,6,7,8,13],setup_time_dependent_el:0,setuptool:8,sever:0,shape:[0,6,11,13],sheet:0,shift:0,should:[0,2,10],shown:6,siam:14,siewert:14,sigbj:14,sigma:[0,3,6,7,11,12],sim:0,similar:0,simpl:[0,6,11,12],simplest:6,simpli:[0,8],simul:[0,2,6,8,10,12,13,14],simultan:0,sinc:0,singl:[0,3,6],size:[0,3,6,11,12],slight:0,slow:8,slowli:12,small:[3,11],smear:5,smooth:[0,12],sodium:6,soft:[6,14],solv:0,solvent:6,some:[0,3],sort:0,sort_dielectric_by_type_id:0,sourc:[0,1],space:[0,3,5,7],span:0,spatial:[0,3,11,12],specfi:0,speci:0,special:0,specif:[0,2,3,6,9,10,11,13],specifi:[0,2,3,6,9,10,11,13],spectacularli:0,spectral:6,speed:[0,3],spheric:6,spheroid:6,split:0,spontan:6,spring:[0,10],sqrt:[0,7,12],squar:[0,9],squaredphi:[0,3,9,11],stabil:6,stabl:6,stackoverflow:0,standard:[0,3,12,14],start:[0,3,6,10,13],start_temperatur:[0,3,6],state:0,statu:8,stdout:[0,2],step:[0,3,6,10,11],stiff:3,stochast:0,store:0,store_data:0,store_stat:0,str10:11,str:0,straightforward:[7,9],stream:0,strength:[0,3,6,11],stretch:[0,3,10,14],string:[0,3,8,11,13],structur:[0,2,3,5,6,11,14],style:14,sub:6,subclass:[0,9],subsequ:[0,5,6,10],sudo:8,suitabl:0,sulfat:6,sum:0,sum_:[0,5,9,12],sum_i:0,sum_j:0,sum_k:0,sum_n:[0,6,10],summari:11,superclass:[0,7],support:[0,6,14],swap:10,symbol:[0,4,9],sympi:[0,9],sys:8,system:[0,1,2,3,6,8,9,11,12,14],tag:[0,3,8],take:[0,3,5,9,10,11,12],taken:0,tar:8,target:0,target_pressur:0,target_temperatur:[0,3,6,11],tau:[0,3,6,11],tau_p:0,tbm92:14,temperatur:[0,3,4,6,11],ten:6,term:[0,3,6,9,12],test:[0,1],text:[0,2,3,4,5,6,9,10,12],than:[0,3],theori:[0,14],thermalis:[0,3],thermostat:[2,3,6,11],thermostat_coupling_group:[0,3,6],thermostat_work:0,theta:[6,10],theta_0:[0,6,10],thi:[0,2,3,6,8,9,10,11,12],thorough:11,though:6,thousand:[6,10],three:[0,2,3,6],through:[0,3,6,7,9,10,14],tild:[0,3,4,5,6,9,12],time:[0,3,4,6,10,11,14],time_step:[0,3,6,11],tmp:8,todo:0,togeth:[0,3,6],token:8,toml:[0,2,3,6,8,10,11],toml_cont:0,tomli:0,too:3,toplog:0,topol:0,topolog:[0,2,3,5,6,11,14],torsion:[0,3,10,14],toshihiro:14,total:[0,3,6,11,12],traceback:8,trajectori:[0,2,3,6,11],trans_matric:0,transfer:[0,10],transform:[0,9,12],travers:0,tri:3,truncat:0,tuckerman:[3,14],turn:6,tutori:[6,8,11,13],two:[0,2,3,6],txt:11,type:[0,2,3,5,6,9,10,11,13],type_arrai:0,type_charg:0,type_to_name_map:0,ubuntu:8,uio:[8,11,14],unchang:0,under:[6,12,14],union:0,uniqu:0,unique_nam:0,unit:[0,3,10],univers:14,unknown:0,unless:[0,3],unset:0,unstabl:3,until:6,updat:[0,8],update_field:0,update_field_force_q:0,update_field_force_q_gp:0,upgrad:[8,14],usag:[0,2],use:[0,3,5,6,8],used:[0,1,2,3,6,7,9,11,12,13],uses:[0,4,12,14],using:[0,2,3,8,12,14],usr:8,usual:11,v_2:[0,6,10],v_3:[0,6,10],v_4:[0,6,10],v_ext:0,v_ext_fouri:0,vacuum:4,valid:[0,3],validated_config:0,valu:[0,3,4,5,6,10],valueerror:8,vanish:0,varepsilon:0,varepsilon_0:[4,5],vari:12,variabl:0,variant:6,variou:[0,13],vbar_elec:0,vbar_elec_fouri:0,vector:10,vectoris:9,veloc:[0,2,3,4,6,11,13,14],velocity_out:0,velocti:0,verbos:[0,2,8,11],veri:[6,10],verifi:0,verlet:[0,3,6,11],versa:3,version:[0,6,8,11,12],vert:0,vertex:[0,5],vertic:0,via:[6,8,14],vice:3,vol:0,volum:0,voxel:0,wai:[8,12],warn:0,weakli:3,weight:0,well:6,were:0,weslei:0,wheel:8,when:[0,3,10],where:[0,5,9,10,12],which:[0,2,3,5,6,9,10,11],width:[0,3],window:[0,5,12],without:[0,8,14],work:[0,8],workload:0,would:[0,3],wrap:0,wrapper:0,write:[0,3],written:[0,3],www:0,xavier:14,yield:6,you:[8,10,14],yuan:14,zero:[0,3],zhong:14,zhu:14},titles:["4. API reference","3. Benchmarks","5. Command line arguments","3. Configuration file","6. Constants and Units","3. Electrostatic interactions","1. Examples","2. Filtering","1. Installation","1. Interaction energy functionals","2. Intramolecular bonds","2. Usage overview for HylleraasMD","1. Theory","4. Topology and structure file","HylleraasMD documentation"],titleterms:{"function":9,"import":8,"new":[7,9],"while":8,SDS:6,api:0,argument:2,assembl:6,benchmark:1,bilay:6,bond:[1,3,10],build:8,calcul:12,chain:6,chi:9,code:14,colab:14,colaboratori:8,command:2,common:8,configur:3,constant:4,copolym:6,curl:8,dataset:13,depend:8,develop:14,diblock:6,docker:8,document:14,due:8,electrostat:[3,5],energi:9,error:8,exampl:6,extern:12,field:[0,1,3],file:[0,3,13],filter:[7,12],forc:[0,1,8,12],form:[9,12],fortran:8,four:10,gas:6,googl:[8,14],guid:14,hamiltonian:[0,12],helix:6,hylleraasmd:[11,14],hymd:14,ideal:6,implement:[7,9],incompress:9,indic:14,input:0,instal:[8,14],integr:0,interact:[5,8,9],interpol:12,intramolecular:10,issu:8,kappa:9,kernel:8,keyword:3,line:2,lipid:6,logger:0,metadata:3,miss:8,numpi:8,onli:9,option:[2,13],output:0,overview:11,parallel:11,parser:0,particl:[1,3,10],peptid:6,pfft:8,phase:6,phi:9,potenti:12,python:8,reciproc:12,refer:[0,14],requir:[2,13],rod:6,run:[8,11,14],self:6,separ:6,simul:[3,11],sourc:14,space:12,specifi:5,stiff:6,structur:13,tabl:14,test:11,theori:12,thermostat:0,three:10,topolog:13,two:10,unit:4,usag:11,user:14,wget:8}}) \ No newline at end of file diff --git a/v1.0.6/.buildinfo b/v1.0.6/.buildinfo new file mode 100644 index 00000000..cb6263c9 --- /dev/null +++ b/v1.0.6/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 6de790b89d0149f111a17661cda7990a +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v1.0.6/.doctrees/doc_pages/api.doctree b/v1.0.6/.doctrees/doc_pages/api.doctree new file mode 100644 index 00000000..183a26fd Binary files /dev/null and b/v1.0.6/.doctrees/doc_pages/api.doctree differ diff --git a/v1.0.6/.doctrees/doc_pages/benchmarks.doctree b/v1.0.6/.doctrees/doc_pages/benchmarks.doctree new file mode 100644 index 00000000..a94dbb62 Binary files /dev/null and b/v1.0.6/.doctrees/doc_pages/benchmarks.doctree differ diff --git a/v1.0.6/.doctrees/doc_pages/command_line.doctree b/v1.0.6/.doctrees/doc_pages/command_line.doctree new file mode 100644 index 00000000..fe10620a Binary files /dev/null and b/v1.0.6/.doctrees/doc_pages/command_line.doctree differ diff --git a/v1.0.6/.doctrees/doc_pages/config_file.doctree b/v1.0.6/.doctrees/doc_pages/config_file.doctree new file mode 100644 index 00000000..b59fe839 Binary files /dev/null and b/v1.0.6/.doctrees/doc_pages/config_file.doctree differ diff --git a/v1.0.6/.doctrees/doc_pages/constants_and_units.doctree b/v1.0.6/.doctrees/doc_pages/constants_and_units.doctree new file mode 100644 index 00000000..6d2a059d Binary files /dev/null and b/v1.0.6/.doctrees/doc_pages/constants_and_units.doctree differ diff --git a/v1.0.6/.doctrees/doc_pages/electrostatics.doctree b/v1.0.6/.doctrees/doc_pages/electrostatics.doctree new file mode 100644 index 00000000..5ca674af Binary files /dev/null and b/v1.0.6/.doctrees/doc_pages/electrostatics.doctree differ diff --git a/v1.0.6/.doctrees/doc_pages/examples.doctree b/v1.0.6/.doctrees/doc_pages/examples.doctree new file mode 100644 index 00000000..1695026e Binary files /dev/null and b/v1.0.6/.doctrees/doc_pages/examples.doctree differ diff --git a/v1.0.6/.doctrees/doc_pages/filtering.doctree b/v1.0.6/.doctrees/doc_pages/filtering.doctree new file mode 100644 index 00000000..be54212a Binary files /dev/null and b/v1.0.6/.doctrees/doc_pages/filtering.doctree differ diff --git a/v1.0.6/.doctrees/doc_pages/installation.doctree b/v1.0.6/.doctrees/doc_pages/installation.doctree new file mode 100644 index 00000000..ab3e77dc Binary files /dev/null and b/v1.0.6/.doctrees/doc_pages/installation.doctree differ diff --git a/v1.0.6/.doctrees/doc_pages/interaction_energy_functionals.doctree b/v1.0.6/.doctrees/doc_pages/interaction_energy_functionals.doctree new file mode 100644 index 00000000..cb19c7f8 Binary files /dev/null and b/v1.0.6/.doctrees/doc_pages/interaction_energy_functionals.doctree differ diff --git a/v1.0.6/.doctrees/doc_pages/intramolecular_bonds.doctree b/v1.0.6/.doctrees/doc_pages/intramolecular_bonds.doctree new file mode 100644 index 00000000..f69e9793 Binary files /dev/null and b/v1.0.6/.doctrees/doc_pages/intramolecular_bonds.doctree differ diff --git a/v1.0.6/.doctrees/doc_pages/overview.doctree b/v1.0.6/.doctrees/doc_pages/overview.doctree new file mode 100644 index 00000000..3250c698 Binary files /dev/null and b/v1.0.6/.doctrees/doc_pages/overview.doctree differ diff --git a/v1.0.6/.doctrees/doc_pages/theory.doctree b/v1.0.6/.doctrees/doc_pages/theory.doctree new file mode 100644 index 00000000..bb41670c Binary files /dev/null and b/v1.0.6/.doctrees/doc_pages/theory.doctree differ diff --git a/v1.0.6/.doctrees/doc_pages/topology_input.doctree b/v1.0.6/.doctrees/doc_pages/topology_input.doctree new file mode 100644 index 00000000..6c50cace Binary files /dev/null and b/v1.0.6/.doctrees/doc_pages/topology_input.doctree differ diff --git a/v1.0.6/.doctrees/environment.pickle b/v1.0.6/.doctrees/environment.pickle new file mode 100644 index 00000000..0b0a9b8a Binary files /dev/null and b/v1.0.6/.doctrees/environment.pickle differ diff --git a/v1.0.6/.doctrees/index.doctree b/v1.0.6/.doctrees/index.doctree new file mode 100644 index 00000000..374b9e3c Binary files /dev/null and b/v1.0.6/.doctrees/index.doctree differ diff --git a/v1.0.6/_downloads/355ac76c39cb7c394e75ef490d049569/benchmarks-2.pdf b/v1.0.6/_downloads/355ac76c39cb7c394e75ef490d049569/benchmarks-2.pdf new file mode 100644 index 00000000..f5d57cf5 Binary files /dev/null and b/v1.0.6/_downloads/355ac76c39cb7c394e75ef490d049569/benchmarks-2.pdf differ diff --git a/v1.0.6/_downloads/6265b0d8abecdb22327433ec6a06da76/benchmarks-2.py b/v1.0.6/_downloads/6265b0d8abecdb22327433ec6a06da76/benchmarks-2.py new file mode 100644 index 00000000..fd287cbc --- /dev/null +++ b/v1.0.6/_downloads/6265b0d8abecdb22327433ec6a06da76/benchmarks-2.py @@ -0,0 +1,33 @@ +import numpy as np +import matplotlib.pyplot as plt + +mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] +mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + +mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + +mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + +mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] +mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + +mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + +mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + +plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") +plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") +plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") +plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") +plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") +plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") +plt.xlabel("CPUs", fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.ylabel("Time per step, s", fontsize=15) +plt.legend(loc="upper left", fontsize=15) +plt.show() \ No newline at end of file diff --git a/v1.0.6/_downloads/864dcf7b76bb3ee06358916ccba514c8/benchmarks-2.hires.png b/v1.0.6/_downloads/864dcf7b76bb3ee06358916ccba514c8/benchmarks-2.hires.png new file mode 100644 index 00000000..82806426 Binary files /dev/null and b/v1.0.6/_downloads/864dcf7b76bb3ee06358916ccba514c8/benchmarks-2.hires.png differ diff --git a/v1.0.6/_downloads/a64690e37658f57827bd5d42c3a50e2e/benchmarks-1.pdf b/v1.0.6/_downloads/a64690e37658f57827bd5d42c3a50e2e/benchmarks-1.pdf new file mode 100644 index 00000000..06a072c7 Binary files /dev/null and b/v1.0.6/_downloads/a64690e37658f57827bd5d42c3a50e2e/benchmarks-1.pdf differ diff --git a/v1.0.6/_downloads/ab8b47df892e2d35a19e1fb209ed00ee/benchmarks-1.py b/v1.0.6/_downloads/ab8b47df892e2d35a19e1fb209ed00ee/benchmarks-1.py new file mode 100644 index 00000000..deb4348f --- /dev/null +++ b/v1.0.6/_downloads/ab8b47df892e2d35a19e1fb209ed00ee/benchmarks-1.py @@ -0,0 +1,38 @@ +import numpy as np +import matplotlib.pyplot as plt +nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) +time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 +], dtype=np.float64) +nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 +], dtype=np.float64,) +time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, +], dtype=np.float64) +nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 +], dtype=np.float64) +time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, +], dtype=np.float64) +plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" +) +plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" +) +plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" +) +plt.xlabel("CPUs", fontsize=15) +plt.ylabel("Time per step, us", fontsize=15) +plt.legend(fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.show() \ No newline at end of file diff --git a/v1.0.6/_downloads/b0d26fc2394760764239e5f0b3a256d8/benchmarks-1.png b/v1.0.6/_downloads/b0d26fc2394760764239e5f0b3a256d8/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.6/_downloads/b0d26fc2394760764239e5f0b3a256d8/benchmarks-1.png differ diff --git a/v1.0.6/_downloads/bea7a628e422ce5370ac7ec3b1cb6c7e/benchmarks-1.hires.png b/v1.0.6/_downloads/bea7a628e422ce5370ac7ec3b1cb6c7e/benchmarks-1.hires.png new file mode 100644 index 00000000..173b39f3 Binary files /dev/null and b/v1.0.6/_downloads/bea7a628e422ce5370ac7ec3b1cb6c7e/benchmarks-1.hires.png differ diff --git a/v1.0.6/_downloads/dd7b5dcc3a0a70d7783446dae0ee7b2f/benchmarks-2.png b/v1.0.6/_downloads/dd7b5dcc3a0a70d7783446dae0ee7b2f/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v1.0.6/_downloads/dd7b5dcc3a0a70d7783446dae0ee7b2f/benchmarks-2.png differ diff --git a/v1.0.6/_images/benchmarks-1.png b/v1.0.6/_images/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.6/_images/benchmarks-1.png differ diff --git a/v1.0.6/_images/benchmarks-2.png b/v1.0.6/_images/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v1.0.6/_images/benchmarks-2.png differ diff --git a/v1.0.6/_images/hylleraas_centre_logo_black.png b/v1.0.6/_images/hylleraas_centre_logo_black.png new file mode 100644 index 00000000..40826396 Binary files /dev/null and b/v1.0.6/_images/hylleraas_centre_logo_black.png differ diff --git a/v1.0.6/_images/uio_full_logo_eng_pos.png b/v1.0.6/_images/uio_full_logo_eng_pos.png new file mode 100644 index 00000000..6c603139 Binary files /dev/null and b/v1.0.6/_images/uio_full_logo_eng_pos.png differ diff --git a/v1.0.6/_modules/hymd/field.html b/v1.0.6/_modules/hymd/field.html new file mode 100644 index 00000000..8837e763 --- /dev/null +++ b/v1.0.6/_modules/hymd/field.html @@ -0,0 +1,1451 @@ + + + + + + hymd.field — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.field

+"""Forces and energies from the discretized particle-field grid interactions
+"""
+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import warnings
+
+
+
[docs]def initialize_pm(pmesh, config, comm=MPI.COMM_WORLD): + """ + Creates the necessary pmesh objects for pfft operations. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + config : Config + Configuration dataclass containing simulation metadata and parameters. + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm : object 'pmesh.pm.ParticleMesh' + field_list : list[pmesh.pm.RealField], (multiple) + Essential list of pmesh objects required for MD + list_coulomb : list[pmesh.pm.RealField], (multiple) + Additional list of pmesh objects required for electrostatics. + """ + + if config.dtype == np.float64: + pmeshtype = "f8" + else: + pmeshtype = "f4" + # Ignore numpy numpy.VisibleDeprecationWarning: Creating an ndarray from + # ragged nested sequences until it is fixed in pmesh + with warnings.catch_warnings(): + warnings.filterwarnings( + action="ignore", + category=np.VisibleDeprecationWarning, + message=r"Creating an ndarray from ragged nested sequences", + ) + # The first argument of ParticleMesh has to be a tuple + pm = pmesh.ParticleMesh( + config.mesh_size, BoxSize=config.box_size, dtype=pmeshtype, comm=comm + ) + phi = [pm.create("real", value=0.0) for _ in range(config.n_types)] + phi_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] # noqa: E501 + force_on_grid = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + v_ext_fourier = [pm.create("complex", value=0.0) for _ in range(4)] + v_ext = [pm.create("real", value=0.0) for _ in range(config.n_types)] + + phi_transfer = [pm.create("complex", value=0.0) for _ in range(3)] + + phi_laplacian = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + + # Initialize charge density fields + coulomb_list = [] + elec_common_list = [None, None, None, None] + _SPACE_DIM = config.box_size.size + + if config.coulombtype == "PIC_Spectral_GPE" or config.coulombtype == "PIC_Spectral": + phi_q = pm.create("real", value=0.0) + phi_q_fourier = pm.create("complex", value=0.0) + psi = pm.create("real", value=0.0) + elec_field = [pm.create("real", value=0.0) for _ in range(_SPACE_DIM)] + + elec_common_list = [phi_q, phi_q_fourier, psi, elec_field] + + if config.coulombtype == "PIC_Spectral": + elec_field_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] # for force calculation + psi_fourier = pm.create("complex", value=0.0) + + coulomb_list = [ + elec_field_fourier, + psi_fourier, + ] + + if ( + config.coulombtype == "PIC_Spectral_GPE" + ): ## initializing the density mesh #dielectric_flag + phi_eps = pm.create( + "real", value=0.0 + ) ## real contrib of the epsilon dielectric painted to grid + phi_eps_fourier = pm.create("complex", value=0.0) # complex contrib of phi eps + phi_eta = [ + pm.create("real", value=0.0) for _ in range(_SPACE_DIM) + ] ## real contrib of factor in polarization charge density + phi_eta_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] ## fourier of factor in polarization charge density + phi_pol = pm.create( + "real", value=0.0 + ) ## real contrib of the polarization charge + phi_pol_prev = pm.create("real", value=0.0) + elec_dot = pm.create("real", value=0.0) + elec_field_contrib = pm.create( + "real", value=0.0 + ) # needed for pol energies later + + # External potential and force meshes + Vbar_elec = [pm.create("real", value=0.0) for _ in range(config.n_types)] + Vbar_elec_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] + force_mesh_elec = [ + [pm.create("real", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + force_mesh_elec_fourier = [ + [pm.create("complex", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + + coulomb_list = [ + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol, + phi_pol_prev, + elec_dot, + elec_field_contrib, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + ] + + field_list = [ + phi, + phi_fourier, + force_on_grid, + v_ext_fourier, + v_ext, + phi_transfer, + phi_laplacian, + ] + + return (pm, field_list, elec_common_list, coulomb_list)
+ + +
[docs]def compute_field_force(layouts, r, force_mesh, force, types, n_types): + """Interpolate particle-field forces from the grid onto particle positions + + Backmaps the forces calculated on the grid to particle positions using the + window function :math:`P` (by default cloud-in-cell [CIC]). In the + following, let :math:`\\mathbf{F}_j` denote the force acting on the + particle with index :math:`j` and position :math:`\\mathbf{r}_j`. The + interpolated force is + + .. math:: + + \\mathbf{F}_j = -\\sum_k\\nabla V_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`V_{j_k}` is the discretized external potential at grid vertex + :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid vertex + with index :math:`j_k`, and :math:`h^3` is the volume of each grid voxel. + The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + r : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + force : (N,D) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. Local + for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + n_types : int + Number of different unique types present in the simulation system. + :code:`n_types` is global, i.e. the same for all MPI ranks even if some + ranks contain zero particles of certain types. + """ + for t in range(n_types): + ind = types == t + for d in range(3): + force[ind, d] = force_mesh[t][d].readout(r[ind], layout=layouts[t])
+ + +
[docs]def compute_self_energy_q(config, charges, comm=MPI.COMM_WORLD): + """Compute the self energy for the interaction due to the Ewald scheme + used to compute the electrostatics. The energy is stored in :code:`config`. + + The self interaction energy is given by: + + .. math:: + + U_{self} = \\sqrt{\\frac{1}{2\\pi\\sigma^2}} \\sum_{i=1}^{N} q_i^2 + + where :math:`q_i` are the charges and :math:`\\sigma` is the half-width + of the Gaussian filter. + + Parameters + ---------- + config : Config + Configuration object. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + comm : mpi4py.Comm + MPI communicator to use for rank communication. + + Returns + ------- + field_q_self_energy : float + Electrostatic self energy. + """ + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + prefac = elec_conversion_factor * np.sqrt( + 1.0 / (2.0 * np.pi * config.sigma * config.sigma) + ) + _squared_charges = charges * charges + squared_charges_sum = comm.allreduce(np.sum(_squared_charges)) + return prefac * squared_charges_sum
+ + +
[docs]def update_field_force_q( + charges, + phi_q, + phi_q_fourier, + psi, + psi_fourier, + elec_field_fourier, + elec_field, + elec_forces, + layout_q, + hamiltonian, + pm, + positions, + config, +): + """Calculate the electrostatic particle-field forces on the grid + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential is computed in reciprocal space as + + .. math:: + + \\Phi = \\mathrm{FFT}^{-1}\\left[ + \\frac{4\\pi k_e}{\\varepsilon \\vert\\mathbf{k}\\vert^2} + \\mathrm{FFT}(\\rho)\\mathrm{FFT}(H) + \\right], + + with the electric field + + .. math:: + + \\mathbf{E} = \\mathrm{FFT}^{-1}\\left[ + -i\\mathbf{k}\\,\\mathrm{FFT}(\\Psi) + \\right]. + + In the following, let :math:`\\mathbf{F}_j` denote the electrostatic force + acting on the particle with index :math:`j` and position + :math:`\\mathbf{r}_j`. The interpolated electrostatic force is + + .. math:: + + \\mathbf{F}_j = \\sum_k q_j\\mathbf{E}_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`\\mathbf{E}_{j_k}` is the discretized electric field at grid + vertex :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid + vertex with index :math:`j_k`, and :math:`h^3` is the volume of each grid + voxel. The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty; any values in this field + are discarded. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + elec_field_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + electric field values in reciprocal space on the computational grid. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + n_dimensions = config.box_size.size + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + # charges to grid + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) + phi_q /= volume_per_cell + # print("phi_q", np.sum(phi_q)) + phi_q.r2c(out=phi_q_fourier) + + # smear charges with filter + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + + # solve Poisson equation in Fourier space to get electrostatic potential + def poisson_transfer_function(k, v): + return 4.0 * np.pi * elec_conversion_factor * v / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(poisson_transfer_function, out=psi_fourier) + # print("psi_fourier", np.sum(psi_fourier)) + psi_fourier.c2r(out=psi) + # print("phi_q * psi update_field", np.sum(phi_q * psi)) + + # exit() + + # compute electric field directly from smeared charged densities in Fourier + for _d in np.arange(n_dimensions): + + def poisson_transfer_function(k, v, d=_d): + return ( + -1j + * k[d] + * 4.0 + * np.pi + * elec_conversion_factor + * v + / k.normp(p=2, zeromode=1) + ) + + phi_q_fourier.apply(poisson_transfer_function, out=elec_field_fourier[_d]) + elec_field_fourier[_d].c2r(out=elec_field[_d]) + + # get electrostatic force from electric field + for _d in np.arange(n_dimensions): + elec_forces[:, _d] = charges * ( + elec_field[_d].readout(positions, layout=layout_q) + )
+ + +def comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, +): + for t in range(config.n_types): + np.copyto(phi_transfer[0].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[1].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[2].value, phi_fourier[t].value, casting="no", where=True) + + # Evaluate laplacian of phi in fourier space + for d in range(3): + + def laplacian_transfer(k, v, d=d): + return -k[d] ** 2 * v + + phi_transfer[d].apply(laplacian_transfer, out=Ellipsis) + phi_transfer[d].c2r(out=phi_laplacian[t][d]) + + +
[docs]def update_field( + phi, + phi_laplacian, + phi_transfer, + layouts, + force_mesh, + hamiltonian, + pm, + positions, + types, + config, + v_ext, + phi_fourier, + v_ext_fourier, + m, + compute_potential=False, +): + """Calculate the particle-field potential and force density + + If :code:`compute_potential` is :code:`True`, the energy may subsequently + be computed by calling :code:`compute_field_and_kinetic_energy`. + + Computes the particle-field external potential :math:`V_\\text{ext}` from + particle number densities through the smoothed density field, + :math:`\\phi(\\mathbf{r})`. With :math:`P` being the cloud-in-cell (CIC) + window function, the density and filtered densities are computed as + + .. math:: + + \\phi(\\mathbf{r}) = \\sum_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\phi(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\phi(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + external potential is computed in reciprocal space as + + .. math:: + + V_\\text{ext} = \\mathrm{FFT}^{-1}\\left[ + \\mathrm{FFT} + \\left( + \\frac{\\partial w}{\\partial \\tilde\\phi} + \\right) + \\mathrm{FFT}(H) + \\right], + + where :math:`w` is the interaction energy functional. Differentiating + :math:`V_\\text{ext}` is done by simply applying :math:`i\\mathbf{k}` in + Fourier space, and the resulting forces are back-transformed to direct + space and interpolated to particle positions by + + .. math:: + + \\mathbf{F}_j = -\\sum_{j_k} \\nabla V_{j_k} + P(\\mathbf{r}_{j_k} - \\mathbf{r}_j)h^3, + + where :math:`j_k` are the neighbouring vertices of particle :math:`j` at + position :math:`\\mathbf{r}_j`, and :math:`h^3` is the volume of each grid + voxel. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Pre-allocated, but empty; any values + in this field are discarded. Changed in-place. Local for each MPI + rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + config : Config + Configuration object. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Pre-allocated, but empty; any values in this field are + discarded Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + phi_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computational grid is represented by the collective fields of all + MPI ranks. + v_ext_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplesField` objects containing discretized + particle-field external potential values in reciprocal space on the + computational grid; :code:`D+1` fields in D dimensions for each + particle type. :code:`D` copies are made after calculation for later + use in force calculation, because the `force transfer function` + application differentiates the field in-place, ruining the contents + for differentiation in the remaining :code:`D-1` spatial directions. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + m: list[float], (M,) + pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. + Defaults to 1.0 for all particle types. + compute_potential : bool, optional + If :code:`True`, a :code:`D+1`-th copy of the Fourier transformed + external potential field is made to be used later in particle-field + energy calculation. If :code:`False`, only :code:`D` copies are made. + + See also + -------- + compute_field_and_kinetic_energy : + Compute the particle-field energy after the external potential is + calculated. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + for t in range(config.n_types): + pm.paint(positions[types == t], mass=m[t], layout=layouts[t], out=phi[t]) + phi[t] /= volume_per_cell + phi[t].r2c(out=phi_fourier[t]) + phi_fourier[t].apply(hamiltonian.H, out=Ellipsis) + phi_fourier[t].c2r(out=phi[t]) + + # External potential + for t in range(config.n_types): + v = hamiltonian.v_ext[t](phi) + + v.r2c(out=v_ext_fourier[0]) + v_ext_fourier[0].apply(hamiltonian.H, out=Ellipsis) + np.copyto( + v_ext_fourier[1].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + np.copyto( + v_ext_fourier[2].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + if compute_potential: + np.copyto( + v_ext_fourier[3].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + + # Differentiate the external potential in fourier space + for d in range(3): + + def force_transfer_function(k, v, d=d): + return -k[d] * 1j * v + + v_ext_fourier[d].apply(force_transfer_function, out=Ellipsis) + v_ext_fourier[d].c2r(out=force_mesh[t][d]) + + if compute_potential: + v_ext_fourier[3].c2r(out=v_ext[t])
+ + +
[docs]def compute_field_and_kinetic_energy( + phi, + phi_q, + psi, + velocity, + hamiltonian, + positions, + types, + v_ext, + config, + layouts, + comm=MPI.COMM_WORLD, +): + """Compute the particle-field and kinetic energy contributions + + Calculates the kinetic energy through + + .. math:: + + E_k = \\sum_j \\frac{1}{2}m_j\\mathbf{v}_j\\cdot\\mathbf{v}_j, + + and the particle-field energy by + + .. math:: + + E_\\text{field} = \\int\\mathrm{d}\\mathbf{r}\\, + w[\\tilde\\phi], + + where :math:`w` is the interaction energy functional `density`. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + velocity : (N,D) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Local for each MPI rank--the full computational grid is + represented by the collective fields of all MPI ranks. + config : Config + Configuration object. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field : + Computes the up-to-date external potential for use in calculating the + particle-field energy. + """ + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + field_energy = w_0.csum() # w to W + + kinetic_energy = comm.allreduce(0.5 * config.mass * np.sum(velocity**2)) + + if config.coulombtype == "PIC_Spectral": + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + field_q_energy = w_elec.csum() + else: + field_q_energy = 0.0 + + return field_energy, kinetic_energy, field_q_energy
+ + +
[docs]def compute_field_energy_q_GPE( + config, + phi_eps, + field_q_energy, + dot_elec, + comm=MPI.COMM_WORLD, +): + """ + Compute the electrostatic energy after electrosatic forces is + calculated. + + From the definition of the elecrostatic potential :math:`\\Psi`, the energy + is + + W = \\frac{1}{2}\\int\\mathrm{d}\\mathbf{r}\\, + \\epsilon(\\mathbf{r})} \\left(\\mathbf{E}\\cdot \\mathbf{E}\\right), + + where :math:`\\epsilon(\\mathbf{r})}` is the anisotropic, spatially dependent, + relative dielectric of the simulation medium. + + Parameters + ---------- + config : hymd.input_parser.Config + Configuration object. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + field_q_energy : float + Total elecrostatic energy. + dot_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing :math:`|\\mathbf{E(r)}|^{2}` + on the computational grid. Local for each MPI rank -- the full computational + grid is represented by the collective fields of all MPI ranks. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field_force_q_GPE: + Compute the electrosatic force from an anisotropic dielectric general + Poisson equation. + """ + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + # ^ due to integration on local cell before allreduce + + eps_0 = 1.0 / (config.coulomb_constant * 4 * np.pi) + field_q_energy = ( + volume_per_cell * (0.5 * eps_0) * comm.allreduce(np.sum(phi_eps * dot_elec)) + ) + + return field_q_energy
+ + +
[docs]def update_field_force_q_GPE( + conv_fun, + phi, + types, + charges, + phi_q, + phi_q_fourier, + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol_prev, + phi_pol, + elec_field, + elec_forces, + elec_field_contrib, + psi, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + hamiltonian, + layout_q, + layouts, + pm, + positions, + config, + comm=MPI.COMM_WORLD, +): + """ + Calculate the electrostatic particle-field forces on the grid, arising from + a general Poisson equation, i.e. anisotropic permittivity/dielectric. + The function is called when tomli input config.coulombtype = "PIC_Spectral_GPE." + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential for a variable dielectric does not have an + analytical expression, and is computed in reciprocal through an iterative + method. + + The GPE states that + + .. math:: + + \\nabla \\cdot \\left(\\epsilon(\\mathbf{r}) + \\nabla{\\mathbf{\\psi(r)}}\\right) = -\\rho({\\mathbf{r}}). + + where :math:`\\epsilon(\\mathbf{r})` is the relative dielectric function. + + Parameters + ---------- + conv_fun : Convergence function. + Returns a scalar. Depends on MPI allreduce for similar convergence + across MPI ranks. + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_eta : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + gradients of the relative dielectric values on the computational grid. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank--the + full computational grid is represented by the collective fields of all MPI ranks. + phi_eta_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated discretized + Fourier transformed gradient relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol_prev : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charge values on the computational grid. Parameter in + the iterative method.Pre-allocated,but empty. Changedin-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charges on the computational grid. Parameter in the iterative + method, updating the next quess in solving for the electrostatic potential. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all + MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + elec_field_contrib : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing + :math:`|\\mathbf{E(r)}|^2/\\phi_{0}` on the computational grid. + Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + psi : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic potential + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + Vbar_elec : mesh.pm.RealField + Pmesh :code:`RealField` object for storing functional derivatives of + :math:`\\|w(\\{ \\phi \\})_{elec}`on the computational grid. + Pre-allocated, but empty. Changed in-place. Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + Vbar_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated functional + derivatives of :math:`\\|w(\\{ \\phi \\})_{elec}` in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + force_mesh_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic force values + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + force_mesh_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated electrostatic + force values in reciprocal space on the computational grid. Local for + each MPI rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + layouts: list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + comm: mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + compute_field_energy_q_GPE: + Compute the electrostatic energy after electrosatic force is + calculated for a variable (anisotropic) dielectric general Poisson equation. + """ + + ## basic setup + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + ## old protocol in gen_qe_hpf_use_self + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) ## + ## scale and fft + ## old protocol in gen_qe_hpf_use_self + phi_q /= volume_per_cell + phi_q.r2c(out=phi_q_fourier) + + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + ## ^------ use the same gaussian as the \kai interaciton + phi_q_fourier.c2r(out=phi_q) ## this phi_q is after applying the smearing function + + denom_phi_tot = pm.create("real", value=0.0) + num_types = pm.create("real", value=0.0) + ### ^ ----- Calculate the relative dielectric (permittivity) to field + ### ------- from a mean contribution of particle number densities + + for t_ in range(config.n_types): + num_types = num_types + (config.dielectric_type[t_]) * phi[t_] + denom_phi_tot = denom_phi_tot + phi[t_] + + np.divide(num_types, denom_phi_tot, where=np.abs(denom_phi_tot > 1e-6), out=phi_eps) + + phi_eps.r2c(out=phi_eps_fourier) # FFT dielectric + + # phi_q_eps = (phi_q/phi_eps) + np.divide(phi_q, phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_q) + + _SPACE_DIM = 3 + ##^--------- constants needed throughout the calculations + + ### method for finding the gradient (fourier space), using the spatial dimension of k + for _d in np.arange(_SPACE_DIM): + + def gradient_transfer_function(k, x, d=_d): + return 1j * k[d] * x + + phi_eps_fourier.apply(gradient_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=phi_eta[_d]) + np.divide(phi_eta[_d], phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_eta[_d]) + + ### iterative GPE solver ### + ### ---------------------------------------------- + max_iter = 100 + i = 0 + delta = 1.0 + # phi_pol_prev = pm.create("real", value = 0.0) + ### ^------ set to zero before each iterative procedure or soft start + conv_criteria = config.conv_crit # conv. criteria (default 1e-6) + w = config.pol_mixing # polarization mixing param (default 0.6) + while i < max_iter and delta > conv_criteria: + (phi_q + phi_pol_prev).r2c(out=phi_q_fourier) + for _d in np.arange(_SPACE_DIM): + + def iterate_apply_k_vec(k, additive_terms, d=_d): + return additive_terms * (-1j * k[d]) / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(iterate_apply_k_vec, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + + phi_pol = -( + phi_eta[0] * elec_field[0] + + phi_eta[1] * elec_field[1] + + phi_eta[2] * elec_field[2] + ) + ### ^-- Following a negative sign convention (-ik) of the FT, a neg sign is + ### --- mathematically correct by the definition of the GPE (double - -> +) + phi_pol = w * phi_pol + (1.0 - w) * phi_pol_prev + diff = np.abs(phi_pol - phi_pol_prev) + delta = conv_fun(comm, diff) # decided from toml input + phi_pol_prev = phi_pol.copy() + i = i + 1 + # print("Stopping after iteration {:d} with stop crit {:.2e}, delta {:.2e}".format(i,conv_criteria,delta)) + + # compute_potential = True + def k_norm_divide(k, potential): + return potential / k.normp(p=2, zeromode=1) + + ## > Electrostatic potential + eps0_inv = config.coulomb_constant * 4 * np.pi + ## ^ the 1/(4pi eps0)*4*pi = 1/eps0 + ((eps0_inv) * (phi_q + phi_pol)).r2c(out=phi_q_fourier) + phi_q_fourier.apply(k_norm_divide, out=phi_q_fourier) + phi_q_fourier.c2r(out=psi) + ### ^ electrostatic potential for the GPE + + for _d in np.arange(_SPACE_DIM): + + def field_transfer_function(k, x, d=_d): + return ( + -1j * k[d] * x + ) ## negative sign relation, due to E = - nabla psi relation + + phi_q_fourier.apply(field_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + ## ^-------- Method: Obtaining the electric field from electrostatic potential + ## Assuming the electric field is conserved. + ## Assumption holds if no magnetic flux (magnetic induced fields) + + ############## Obtain forces ############## + elec_dot = ( + elec_field[0] * elec_field[0] + + elec_field[1] * elec_field[1] + + elec_field[2] * elec_field[2] + ) + # needed for energy calculations + + np.divide( + elec_dot, + denom_phi_tot, + where=np.abs(denom_phi_tot > 1e-6), + out=elec_field_contrib, + ) + + eps0_inv = config.coulomb_constant * 4 * np.pi + + for t_ in range(config.n_types): + Vbar_elec[t_] = ( + config.type_charges[t_] * psi + - (0.5 / eps0_inv) + * (config.dielectric_type[t_] - phi_eps) + * elec_field_contrib + ) + + # Obtain Vext,k + for t_ in range(config.n_types): + Vbar_elec[t_].r2c(out=Vbar_elec_fourier[t_]) + Vbar_elec_fourier[t_].apply(hamiltonian.H, out=Vbar_elec_fourier[t_]) + + # force terms + # F = - grad Vext + for t_ in range(config.n_types): + for _d in np.arange(_SPACE_DIM): + + def force_transfer_function(k, x, d=_d): + return -1j * k[_d] * x ## negative gradient + + Vbar_elec_fourier[t_].apply( + force_transfer_function, out=force_mesh_elec_fourier[t_][_d] + ) + force_mesh_elec_fourier[t_][_d].c2r(out=force_mesh_elec[t_][_d]) + elec_forces[types == t_, _d] = force_mesh_elec[t_][_d].readout( + positions[types == t_], layout=layouts[t_] + ) + + return Vbar_elec, phi_eps, elec_dot
+ + +
[docs]def domain_decomposition( + positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=MPI.COMM_WORLD +): + """Performs domain decomposition + + Rearranges the MPI rank memory layout into one that better mimics the PFFT + pencil grid 2D decomposition. As molecules are always required to be fully + contained on a single MPI rank, a perfect decomposition is not always + possible. The best decomposition which leaves the center of mass of all + molecules in their respective correct domains is used, with possible + overlap into neighbouring domains if the spatial extent of any molecule + crosses domain boundaries. + + Parameters + ---------- + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + *args + Variable length argument list containing arrays to include in the + domain decomposition. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + bonds : (N,M) numpy.ndarray, optional + Array of :code:`M` bonds originating from each of :code:`N` particles. + verbose : int, optional + Specify the logging event verbosity of this function. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + Domain decomposed :code:`positions` and any array specified in + :code:`*args`, in addition to :code:`bonds` and :code:`molecules` if these + arrays were provided as input. + """ + if molecules is not None: + if not topol: + assert bonds is not None, "bonds must be provided with molecules" + unique_molecules = np.sort(np.unique(molecules)) + molecules_com = np.empty_like(positions) + for m in unique_molecules: + ind = molecules == m + r = positions[ind, :][0, :] + molecules_com[ind, :] = r + layout = pm.decompose(molecules_com, smoothing=0) + if not topol: + args = (*args, bonds, molecules) + else: + args = (*args, molecules) + else: + layout = pm.decompose(positions, smoothing=0) + if verbose > 1: + Logger.rank0.log( + logging.INFO, + "DOMAIN_DECOMP: Total number of particles to be exchanged = %d", + np.sum(layout.get_exchange_cost()), + ) + return layout.exchange(positions, *args)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/_modules/hymd/file_io.html b/v1.0.6/_modules/hymd/file_io.html new file mode 100644 index 00000000..c6ccfb17 --- /dev/null +++ b/v1.0.6/_modules/hymd/file_io.html @@ -0,0 +1,1147 @@ + + + + + + hymd.file_io — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.file_io

+"""Handle file input/output in parllel HDF5 fashion
+"""
+import numpy as np
+import h5py
+import os
+import logging
+import getpass
+from mpi4py import MPI
+from .logger import Logger, get_version
+
+
+
[docs]class OutDataset: + """HDF5 dataset handler for file output""" + + def __init__( + self, + dest_directory, + config, + double_out=False, + disable_mpio=False, + comm=MPI.COMM_WORLD, + ): + """Constructor + + Parameters + ---------- + dest_directory : str + Ouput directory for saving data. + config : Config + Configuration object. + double_out : bool, optional + If :code:`True`, the output HDF5 objects are written in eight byte + floating point representation. Otherwise, four byte single + precision is used. + disable_mpio : bool, optional + If :code:`True`, disables parallel MPI-enabled HDF5 file output. + This is a compatibility option used if HDF5 is not compiled with + MPI support. This makes everything much harder by splitting all + output in one file per MPI rank, and having an MPI-enabled HDF5 + library is **highly recommended**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + """ + self.disable_mpio = disable_mpio + self.config = config + if double_out: + self.float_dtype = "float64" + else: + self.float_dtype = "float32" + + if disable_mpio: + self.file = h5py.File( + os.path.join( + dest_directory, f"sim.hdf5-{comm.rank:6d}-of-{comm.size:6d}" + ), + "w", + ) + else: + self.file = h5py.File( + os.path.join(dest_directory, "sim.H5"), "w", driver="mpio", comm=comm + ) + +
[docs] def is_open(self, comm=MPI.COMM_WORLD): + """Check if HDF5 output file is open + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + return self.file.__bool__()
+ +
[docs] def close_file(self, comm=MPI.COMM_WORLD): + """Closes the HDF5 output file + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + self.file.close()
+ +
[docs] def flush(self): + """Flushes output buffers, forcing file writes""" + self.file.flush()
+ + +
[docs]def setup_time_dependent_element( + name, parent_group, n_frames, shape, dtype, units=None +): + """Helper function for setting up time-dependent HDF5 group datasets + + All output groups must adhere to the H5MD standard, meaning a structure of + + + | ┗━ **group** particle group (e.g. :code:`all`) or :code:`observables` group + | ┗━ **group** time-dependent data + | ┣━ **dataset** :code:`step` :code:`shape=(n_frames,)` + | ┣━ **dataset** :code:`time` :code:`shape=(n_frames,)` + | ┗━ **dataset** :code:`value` :code:`shape=(n_frames, *)` + + is necessary. + + References + ---------- + H5MD specification : + https://www.nongnu.org/h5md/h5md.html + """ # noqa: E501 + group = parent_group.create_group(name) + step = group.create_dataset("step", (n_frames,), "int32") + time = group.create_dataset("time", (n_frames,), "float32") + value = group.create_dataset("value", (n_frames, *shape), dtype) + + if units is not None: + value.attrs["unit"] = units + time.attrs["unit"] = "ps" + return group, step, time, value
+ + +
[docs]def store_static( + h5md, + rank_range, + names, + types, + indices, + config, + bonds_2_atom1, + bonds_2_atom2, + molecules=None, + velocity_out=False, + force_out=False, + charges=False, + dielectrics=False, + plumed_out=False, + comm=MPI.COMM_WORLD, +): + """Outputs all static time-independent quantities to the HDF5 output file + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + rank_range : list[int] + Start and end indices for global arrays for each MPI rank. + names : (N,) numpy.ndarray + Array of names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of type indices for :code:`N` particles. + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + config : Config + Configuration object. + bonds_2_atom1 : (B,) numpy.ndarray + Array of indices of the first particle for :code:`B` total + two-particle bonds. + bonds_2_atom2 : (B,) numpy.ndarray + Array of indices of the second particle for :code:`B` total + two-particle bonds. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. + dielectrics : (N,) numpy.ndarray + Array of particle relative dielectric values for :code:`N` particles. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to output HDF5 file. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + prepare_bonds : + Constructs two-, three-, and four-particle bonds from toplogy input + file and bond configuration information. + distribute_input : + Distributes input arrays onto MPI ranks, attempting load balancing. + """ + dtype = h5md.float_dtype + + h5md_group = h5md.file.create_group("/h5md") + h5md.h5md_group = h5md_group + h5md.observables = h5md.file.create_group("/observables") + h5md.connectivity = h5md.file.create_group("/connectivity") + h5md.parameters = h5md.file.create_group("/parameters") + + h5md_group.attrs["version"] = np.array([1, 1], dtype=int) + author_group = h5md_group.create_group("author") + author_group.attrs["name"] = np.string_(getpass.getuser()) + creator_group = h5md_group.create_group("creator") + creator_group.attrs["name"] = np.string_("Hylleraas MD") + + # Get HyMD version + creator_group.attrs["version"] = np.string_(get_version()) + + h5md.particles_group = h5md.file.create_group("/particles") + h5md.all_particles = h5md.particles_group.create_group("all") + mass = h5md.all_particles.create_dataset("mass", (config.n_particles,), dtype) + mass[...] = config.mass + + if charges is not False: + charge = h5md.all_particles.create_dataset( + "charge", (config.n_particles,), dtype="float32" + ) + charge[indices] = charges + if dielectrics is not False: + dielectric = h5md.all_particles.create_dataset( + "dielectric", (config.n_particles,), dtype="float32" + ) + dielectric[indices] = dielectrics + + box = h5md.all_particles.create_group("box") + box.attrs["dimension"] = 3 + box.attrs["boundary"] = np.array( + [np.string_(s) for s in 3 * ["periodic"]], dtype="S8" + ) + + n_frames = config.n_steps // config.n_print + if np.mod(config.n_steps - 1, config.n_print) != 0: + n_frames += 1 + if np.mod(config.n_steps, config.n_print) == 1: + n_frames += 1 + if n_frames == config.n_steps: + n_frames += 1 + + species = h5md.all_particles.create_dataset( + "species", + (config.n_particles,), + dtype="i", + ) + + ( + _, + h5md.positions_step, + h5md.positions_time, + h5md.positions, + ) = setup_time_dependent_element( + "position", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm", + ) + if velocity_out: + ( + _, + h5md.velocities_step, + h5md.velocities_time, + h5md.velocities, + ) = setup_time_dependent_element( + "velocity", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm ps-1", + ) + if force_out: + ( + _, + h5md.forces_step, + h5md.forces_time, + h5md.forces, + ) = setup_time_dependent_element( + "force", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="kJ mol-1 nm-1", + ) + ( + _, + h5md.total_energy_step, + h5md.total_energy_time, + h5md.total_energy, + ) = setup_time_dependent_element( + "total_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.kinetc_energy_step, + h5md.kinetc_energy_time, + h5md.kinetc_energy, + ) = setup_time_dependent_element( + "kinetic_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.potential_energy_step, + h5md.potential_energy_time, + h5md.potential_energy, + ) = setup_time_dependent_element( + "potential_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.bond_energy_step, + h5md.bond_energy_time, + h5md.bond_energy, + ) = setup_time_dependent_element( + "bond_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.angle_energy_step, + h5md.angle_energy_time, + h5md.angle_energy, + ) = setup_time_dependent_element( + "angle_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.dihedral_energy_step, + h5md.dihedral_energy_time, + h5md.dihedral_energy, + ) = setup_time_dependent_element( + "dihedral_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.field_energy_step, + h5md.field_energy_time, + h5md.field_energy, + ) = setup_time_dependent_element( + "field_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + if charges is not False: + ( + _, + h5md.field_q_energy_step, + h5md.field_q_energy_time, + h5md.field_q_energy, + ) = setup_time_dependent_element( + "field_q_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) # <-------- xinmeng + if plumed_out is not False: + ( + _, + h5md.plumed_bias_step, + h5md.plumed_bias_time, + h5md.plumed_bias, + ) = setup_time_dependent_element( + "plumed_bias", h5md.observables, n_frames, (1,), dtype, units="kJ mol-1" # noqa: E501 + ) + ( + _, + h5md.total_momentum_step, + h5md.total_momentum_time, + h5md.total_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "total_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm g ps-1 mol-1", + ) + ( + _, + h5md.angular_momentum_step, + h5md.angular_momentum_time, + h5md.angular_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "angular_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm+2 g ps-1 mol-1", + ) + ( + _, + h5md.torque_step, + h5md.torque_time, + h5md.torque, + ) = setup_time_dependent_element( # noqa: E501 + "torque", + h5md.observables, + n_frames, + (3,), + dtype, + units="kJ nm+2 mol-1", + ) + ( + _, + h5md.temperature_step, + h5md.temperature_time, + h5md.temperature, + ) = setup_time_dependent_element( + "temperature", h5md.observables, n_frames, (3,), dtype, units="K" + ) + ( + _, + h5md.thermostat_work_step, + h5md.thermostat_work_time, + h5md.thermostat_work, + ) = setup_time_dependent_element( + "thermostat_work", + h5md.observables, + n_frames, + (1,), + "float32", + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.pressure_step, + h5md.pressure_time, + h5md.pressure, + ) = setup_time_dependent_element( + "pressure", h5md.observables, n_frames, (18,), "float32", units="Bar" + ) + (_, h5md.box_step, h5md.box_time, h5md.box_value,) = setup_time_dependent_element( + "edges", box, n_frames, (3, 3), "float32", units="nm" + ) + + ind_sort = np.argsort(indices) + for i in ind_sort: + species[indices[i]] = config.name_to_type_map[names[i].decode("utf-8")] + + h5md.parameters.attrs["config.toml"] = np.string_(str(config)) + vmd_group = h5md.parameters.create_group("vmd_structure") + index_of_species = vmd_group.create_dataset( + "indexOfSpecies", (config.n_types,), "i" + ) + index_of_species[:] = np.array(list(range(config.n_types))) + + # VMD-h5mdplugin maximum name/type name length is 16 characters (for + # whatever reason [VMD internals?]). + name_dataset = vmd_group.create_dataset("name", (config.n_types,), "S16") + type_dataset = vmd_group.create_dataset("type", (config.n_types,), "S16") + if molecules is not None: + resid_dataset = vmd_group.create_dataset( + "resid", + (config.n_particles,), + "i", + ) + + # Change this + for i, n in config.type_to_name_map.items(): + name_dataset[i] = np.string_(n[:16]) + if n == "W": + type_dataset[i] = np.string_("solvent") + else: + type_dataset[i] = np.string_("membrane") + + total_bonds = comm.allreduce(len(bonds_2_atom1), MPI.SUM) + n_bonds_local = len(bonds_2_atom1) + + receive_buffer = comm.gather(n_bonds_local, root=0) + n_bonds_global = None + if comm.Get_rank() == 0: + n_bonds_global = receive_buffer + n_bonds_global = np.array(comm.bcast(n_bonds_global, root=0)) + rank_bond_start = np.sum(n_bonds_global[: comm.Get_rank()]) + + bonds_from = vmd_group.create_dataset("bond_from", (total_bonds,), "i") + bonds_to = vmd_group.create_dataset("bond_to", (total_bonds,), "i") + for i in range(n_bonds_local): + a = bonds_2_atom1[i] + b = bonds_2_atom2[i] + bonds_from[rank_bond_start + i] = indices[a] + 1 + bonds_to[rank_bond_start + i] = indices[b] + 1 + + if molecules is not None: + resid_dataset[indices[ind_sort]] = molecules
+ + +# store data old vs +""" +h5md, step, frame, indices, positions, velocities, forces, box_size, +temperature, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, +field_energy, field_q_energy, time_step, config, velocity_out=False, +force_out=False, charge_out=False, dump_per_particle=False, +""" + + +
[docs]def store_data( + h5md, + step, + frame, + indices, + positions, + velocities, + forces, + box_size, + temperature, + pressure, + kinetic_energy, + bond2_energy, + bond3_energy, + bond4_energy, + field_energy, + field_q_energy, + plumed_bias, + time_step, + config, + velocity_out=False, + force_out=False, + charge_out=False, + plumed_out=False, + dump_per_particle=False, + comm=MPI.COMM_WORLD, +): + """Writes time-step data to HDF5 output file + + Handles all quantities which change during simulation, as opposed to + static quanitities (see :code:`store_static`). + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + step : int + Step number. + frame : int + Output frame number (:code:`step // n_print`). + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + positions : (N,) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + velocities : (N,) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + forces : (N,) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. + box_size : (D,) numpy.ndarray + Array containing the simulation box size. + temperature : float + Calculated instantaneous temperature. + kinetic_energy : float + Calculated instantaneous kinetic energy. + bond2_energy : float + Calculated instantaneous harmonic two-particle bond energy. + bond3_energy : float + Calculated instantaneous harmonic angular three-particle bond energy. + bond4_energy : float + Calculated instantaneous dihedral four-particle torsion energy. + field_energy : float + Calculated instantaneous particle-field energy. + field_q_energy : float + Calculated instantaneous electrostatic energy. + plumed_bias : float + PLUMED instantaneous bias energy. + time_step : float + Value of the time step. + config : Config + Configuration object. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charge_out : bool, optional + If :code:`True`, electrostatic energies are written to the output + HDF5 file. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to the output HDF5 file. + dump_per_particle : bool, optional + If :code:`True`, all quantities are written **per particle**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + store_static : + Outputs all static time-independent quantities to the HDF5 output file + """ + for dset in ( + h5md.positions_step, + h5md.total_energy_step, + h5md.potential_energy_step, + h5md.kinetc_energy_step, + h5md.bond_energy_step, + h5md.angle_energy_step, + h5md.dihedral_energy_step, + h5md.field_energy_step, + h5md.total_momentum_step, + h5md.angular_momentum_step, + h5md.torque_step, + h5md.temperature_step, + h5md.pressure_step, + h5md.box_step, + h5md.thermostat_work_step, + ): + dset[frame] = step + + for dset in ( + h5md.positions_time, + h5md.total_energy_time, + h5md.potential_energy_time, + h5md.kinetc_energy_time, + h5md.bond_energy_time, + h5md.angle_energy_time, + h5md.dihedral_energy_time, + h5md.field_energy_time, + h5md.total_momentum_time, + h5md.angular_momentum_time, + h5md.torque_time, + h5md.temperature_time, + h5md.pressure_time, + h5md.box_time, + h5md.thermostat_work_time, + ): + dset[frame] = step * time_step + + if velocity_out: + h5md.velocities_step[frame] = step + h5md.velocities_time[frame] = step * time_step + if force_out: + h5md.forces_step[frame] = step + h5md.forces_time[frame] = step * time_step + if charge_out: + h5md.field_q_energy_step[frame] = step + h5md.field_q_energy_time[frame] = step * time_step + if plumed_out: + h5md.plumed_bias_step[frame] = step + h5md.plumed_bias_time[frame] = step * time_step + + ind_sort = np.argsort(indices) + h5md.positions[frame, indices[ind_sort]] = positions[ind_sort] + + if velocity_out: + h5md.velocities[frame, indices[ind_sort]] = velocities[ind_sort] + if force_out: + h5md.forces[frame, indices[ind_sort]] = forces[ind_sort] + if charge_out: + h5md.field_q_energy[frame] = field_q_energy + if plumed_out: + h5md.plumed_bias[frame] = plumed_bias + + potential_energy = ( + bond2_energy + bond3_energy + bond4_energy + field_energy + field_q_energy + ) + + total_momentum = config.mass * comm.allreduce(np.sum(velocities, axis=0), MPI.SUM) + angular_momentum = config.mass * comm.allreduce( + np.sum(np.cross(positions, velocities), axis=0), MPI.SUM + ) + torque = config.mass * comm.allreduce( + np.sum(np.cross(positions, forces), axis=0), MPI.SUM + ) + h5md.total_energy[frame] = kinetic_energy + potential_energy + h5md.potential_energy[frame] = potential_energy + h5md.kinetc_energy[frame] = kinetic_energy + h5md.bond_energy[frame] = bond2_energy + h5md.angle_energy[frame] = bond3_energy + h5md.dihedral_energy[frame] = bond4_energy + h5md.field_energy[frame] = field_energy + h5md.total_momentum[frame, :] = total_momentum + h5md.angular_momentum[frame, :] = angular_momentum + h5md.torque[frame, :] = torque + h5md.temperature[frame] = temperature + h5md.pressure[frame] = pressure + for d in range(3): + h5md.box_value[frame, d, d] = box_size[d] + h5md.thermostat_work[frame] = config.thermostat_work + + fmt_ = [ + "step", + "time", + "temp", + "tot E", + "kin E", + "pot E", + "field E", + "elec E", + "bond E", + "ang E", + "dih E", + "bias E", + "Px", + "Py", + "Pz", + "ΔH" if config.target_temperature else "ΔE", + ] + fmt_ = np.array(fmt_) + + # create mask to show only energies != 0 + en_array = np.array([ + field_energy, + field_q_energy, + bond2_energy, + bond3_energy, + bond4_energy, + plumed_bias, + ]) + mask = np.full_like(fmt_, True, dtype=bool) + mask[range(6,12)] = en_array != 0. + + header_ = fmt_[mask].shape[0] * "{:>13}" + if config.initial_energy is None: + fmt_[-1] = "" + + divide_by = 1.0 + if dump_per_particle: + for i in range(3, 9): + fmt_[i] = fmt_[i][:-2] + "E/N" + fmt_[-1] += "/N" + divide_by = config.n_particles + total_energy = kinetic_energy + potential_energy + if config.initial_energy is not None: + if config.target_temperature: + H_tilde = total_energy - config.initial_energy - config.thermostat_work + else: + H_tilde = total_energy - config.initial_energy + else: + H_tilde = 0.0 + + header = header_.format(*fmt_[mask]) + data_fmt = f'{"{:13}"}{(fmt_[mask].shape[0]-1) * "{:13.5g}" }' + all_data = [ + step, + time_step * step, + temperature, + total_energy / divide_by, + kinetic_energy / divide_by, + potential_energy / divide_by, + field_energy / divide_by, + field_q_energy / divide_by, + bond2_energy / divide_by, + bond3_energy / divide_by, + bond4_energy / divide_by, + plumed_bias / divide_by, + total_momentum[0] / divide_by, + total_momentum[1] / divide_by, + total_momentum[2] / divide_by, + H_tilde / divide_by, + ] + data = data_fmt.format(*[val for i, val in enumerate(all_data) if mask[i]]) + Logger.rank0.log(logging.INFO, ("\n" + header + "\n" + data))
+ + +
[docs]def distribute_input( + in_file, rank, size, n_particles, max_molecule_size=201, comm=MPI.COMM_WORLD +): + """Assign global arrays onto MPI ranks, attempting load balancing + + Distributes approximately equal numbers of particles (workload) onto each + independent MPI rank, while respecting the requirement that any molecule + must be fully contained on a single MPI rank only (no splitting molecules + across multiple CPUs). + + Parameters + ---------- + in_file : h5py.File + HDF5 input file object. + rank : int + Local rank number for this MPI rank. + size : int + Global size of the MPI communicator (number of total CPUs). + n_particles : int + Total number of particles. + max_molecule_size : int, optional + Maximum size of any molecule present in the system. Used to initially + guess where the MPI rank boundaries (start/end indices) in the global + arrays should be placed. If molecules of size + :code:`>max_molecule_size` exist in the simulation system, HyMD + **might** work as expected. Or it might fail spectacularly. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + rank_range : + Starting and ending indices in the global arrays for each MPI rank. + """ + if n_particles is None: + n_particles = len(in_file["indices"]) + np_per_MPI = n_particles // size + + molecules_flag = False + if "molecules" in in_file: + molecules_flag = True + + if not molecules_flag: + if rank == size - 1: + np_cum_mpi = [rank * np_per_MPI, n_particles] + else: + np_cum_mpi = [rank * np_per_MPI, (rank + 1) * np_per_MPI] + p_mpi_range = list(range(np_cum_mpi[0], np_cum_mpi[1])) + return p_mpi_range, molecules_flag + + # To avoid splitting molecules across multiple different ranks, we need + # to read in some extra indices before/after the expected break points + # and iterate until we find a molecule break. + # + # Implicitly assuming no molecule is bigger than + # min(max_molecule_size, n_particles // n_MPI_ranks) atoms. + max_molecule_size += 2 + grab_extra = max_molecule_size if np_per_MPI > max_molecule_size else np_per_MPI + if rank == 0: + mpi_range_start = 0 + if size == 1: + mpi_range_end = n_particles + else: + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + elif rank == size - 1: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = n_particles + else: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + + molecules = in_file["molecules"][mpi_range_start:mpi_range_end] + indices = in_file["indices"][mpi_range_start:mpi_range_end] + molecule_end_indices = np.nonzero(np.diff(molecules))[0] + + p_mpi_range = [None, None] + if rank == 0: + p_mpi_range[0] = 0 + if size == 1: + p_mpi_range[1] = n_particles + else: + p_mpi_range[1] = indices[ + molecule_end_indices[molecule_end_indices >= np_per_MPI][0] + 1 + ] + elif rank == size - 1: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = n_particles + else: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = ( + indices[molecule_end_indices[molecule_end_indices > np_per_MPI][0]] + + 1 # noqa: E501 + ) + return list(range(p_mpi_range[0], p_mpi_range[1])), molecules_flag
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/_modules/hymd/force.html b/v1.0.6/_modules/hymd/force.html new file mode 100644 index 00000000..45da1999 --- /dev/null +++ b/v1.0.6/_modules/hymd/force.html @@ -0,0 +1,1150 @@ + + + + + + hymd.force — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.force

+"""Calculates intramolecular forces between bonded particles in molecules
+"""
+import numpy as np
+import networkx as nx
+from dataclasses import dataclass
+
+# Imported here so we can call from force import compute_bond_forces__fortran
+from force_kernels import cbf as compute_bond_forces__fortran  # noqa: F401
+from force_kernels import (  # noqa: F401
+    caf as compute_angle_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cdf as compute_dihedral_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cbf_d as compute_bond_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    caf_d as compute_angle_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    cdf_d as compute_dihedral_forces__fortran__double,
+)
+
+
+
[docs]@dataclass # might not be needed +class Dielectric_type: + atom_1: str + dielectric_value: float
+ + +
[docs]@dataclass +class Bond: + """Dataclass representing a single two-particle bond type + + A `bond type` is a bond strength and equilibrium distance associated with + any bond between particles of specific types :code:`A` and :code:`B` + (where :code:`A` and :code:`B` may be the same or different). Harmonic + two-particle bonds in HyMD take the form + + .. math:: + + V_2(\\mathbf{r}_1, \\mathbf{r}_2) = + \\frac{1}{2}k + \\left( + \\vert \\mathbf{r}_1 - \\mathbf{r}_2 \\vert - r_0 + \\right)^2, + + where :math:`k` is the bond strength (spring constant) and :math:`r_0` is + the equilibrium bond length (at which the energy is zero). + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + equilibrium : float + Equilibrium distance at which the energy associated with the bond + vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient (spring constant). + """ + + atom_1: str + atom_2: str + equilibrium: float + strength: float
+ + +
[docs]@dataclass +class Angle(Bond): + """Dataclass representing a single three-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any three-particle bond between particles of specific types :code:`A`, + :code:`B`, and :code:`C` (where :code:`A`, :code:`B`, and :code:`C` may be + different or the same). Harmonic angular three-particle bonds in HyMD take + the form + + .. math:: + + V_3(\\mathbf{r}_1, \\mathbf{r}_2, \\mathbf{r}_3) = + \\frac{1}{2}k + \\left( + \\cos^{-1} + \\left[ + \\frac{ + (\\mathbf{r}_1-\\mathbf{r}_2) + \\cdot + (\\mathbf{r}_3-\\mathbf{r}_2) + } + { + \\vert\\mathbf{r}_1-\\mathbf{r}_2\\vert + \\vert\\mathbf{r}_3-\\mathbf{r}_2\\vert + } + \\right] - \\theta_0 + \\right)^2 + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + equilibrium : float + Equilibrium angle at which the energy associated with the + three-particle angular bond vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient. + + See also + -------- + Bond : + Two-particle bond type dataclass + """ + + atom_3: str
+ + +
[docs]@dataclass +class Dihedral: + """Dataclass representing a single four-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any four-particle torsional bond between particles of specific types + :code:`A`, :code:`B`, :code:`C`, and :code:`D` (where :code:`A`, :code:`B`, + :code:`C`, and :code:`D` may be different or the same). Dihedral + four-particle bonds in HyMD take different forms depending on the + :code:`dih_type` parameter. + + In the following, let :math:`\\phi` denote the angle between the planes + spanned by the relative positions of atoms :code:`A`-:code:`B`-:code:`C` + and :code:`B`-:code:`C`-:code:`D`. If :code:`dih_type = 0`, then + + .. math:: + + V_4(\\phi) = \\sum_n c_n + \\left( + 1 + \\cos\\left[ + n\\phi - d_n + \\right] + \\right), + + where :math:`c_n` are energy coefficients and :math:`d_n` are propensity + phases. By default, the cosine sum is truncated at five terms. If + :code:`coeffs` provides only a single float, this is used as the coiling + propensity parameter :math:`\\lambda`. In this case, :math:`c_n` and + :math:`d_n` are automatically set to values which promote alpha helical + (:math:`\\lambda=-1`), beta sheet (:math:`\\lambda=1`), or a mixed + (:math:`1>\\lambda>-1`) structure (using values provided by Bore et al. + (2018)). In this case, the full potential takes the form + + .. math:: + + V_4(\\phi;\\lambda) = + \\frac{1}{2}(1-\\lambda) V_{\\text{prop},\\alpha}(\\phi) + + + \\frac{1}{2}(1+\\lambda) V_{\\text{prop},\\beta}(\\phi) + + + (1-\\vert\\lambda\\vert) V_{\\text{prop}, \\text{coil}}(\\phi), + + with each of the :math:`V_{\\mathrm{prop}, X}` being fixed cosine series + potentials with pre-set :math:`c_n` -s and :math:`d_n` -s. + + If :code:`dih_type = 1`, then a combined bending torsional (CBT) potential + is employed, + + .. math:: + + V_4(\\phi,\\gamma;\\lambda) = + V_4(\\phi;\\lambda) + + + \\frac{1}{2}K(\\phi)(\\gamma - \\gamma_0)^2, + + where :math:`V_4(\\phi;\\lambda)` specifies the potential as given by the + coiling propensity parameter above, :math:`K(\\phi)` is a separate cosine + series potential acting as the angular three-particle bond strength, and + :math:`\\gamma_0` is the three-particle bond equilibrium angle. In this + case, the :code:`coeffs` parameter must specify *both* a :math:`\\lambda` + value, in additon to the energy and phases dictating the :math:`K(\\phi)` + potential. + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + atom_4 : str + Type name of particle 4. + coeffs : list[list[float]] or list[float] or numpy.ndarray + Dihedral coefficients defining the series expansion of the dihedral + energy. + dih_type : int + Specifies the type of dihedral used; If :code:`0`, then :code:`coeffs` + must contain **either** two lists of five energy coefficients + :math:`c_n` and five propensity phases :math:`d_n` **or** a single + floating point number defining the :math:`\\lambda` coiling propensity + parameter. If :code:`1`, the combined bending-torsional potential is + used, and :code:`coeffs` must specify :math:`\\lambda` *and* two lists + containing energy coefficients and propensity phases for the + :math:`V_\\text{prop}` propensity potential, defined in terms of cosine + series. + + References + ---------- + Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018. + """ + + atom_1: str + atom_2: str + atom_3: str + atom_4: str + coeffs: np.ndarray + dih_type: int
+ + +
[docs]@dataclass +class Chi: + """Dataclass representing a single :math:`\\chi` mixing interaction type + + An `interaction mixing energy type` is a mixing energy associated with + density overlap between species of types :code:`A` and :code:`B` + (specified as inputs :code:`atom_1` and :code:`atom_2`). A positive mixing + energy promotes phase separation, a negative mixing energy promotes mixing. + The interaction energy density (provided the :code:`DefaultWithChi` + Hamiltonian is used) takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} + \\sum_{k,l}\\chi_{k,l} \\tilde\\phi_k\\tilde\\phi_l, + + where :math:`\\chi_{k,l}` denotes the mixing energy between species + :math:`k` and :math:`l`, with :math:`\\kappa` being the incompressibility. + The value of the interaction mixing energy parameter may be extracted from + `Flory-Huggins theory`_. + + .. _`Flory-Huggins theory`: + https://en.wikipedia.org/wiki/Flory%E2%80%93Huggins_solution_theory + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + interaction_energy : float + Interaction mixing energy. + + See also + -------- + hymd.hamiltonian.DefaultWithChi : + Interaction energy functional using :math:`\\chi`-interactions. + """ + + atom_1: str + atom_2: str + interaction_energy: float
+ + +
[docs]def find_all_paths(G, u, n): + """Helper function that recursively finds all paths of given lenght 'n + 1' inside a network 'G'. + Adapted from https://stackoverflow.com/a/28103735.""" + if n == 0: + return [[u]] + paths = [] + for neighbor in G.neighbors(u): + for path in find_all_paths(G, neighbor, n - 1): + if u not in path: + paths.append([u] + path) + return paths
+ + +
[docs]def propensity_potential_coeffs(x: float): + alpha_coeffs = np.array( + [ + [7.406, -5.298, -2.570, 1.336, 0.739], + [-0.28632126, 1.2099146, 1.18122138, 0.49075168, 0.98495911], + ] + ) + beta_coeffs = np.array( + [ + [3.770, 5.929, -4.151, -0.846, 0.190], + [-0.2300693, -0.0583289, 0.99342396, 1.03237971, 2.90160988], + ] + ) + coil_coeffs = np.array( + [ + [1.416, -0.739, 0.990, -0.397, 0.136], + [1.3495933, 0.45649087, 2.30441057, -0.12274901, -0.26179939], + ] + ) + + zero_add = np.zeros((2, 5)) + if np.isclose(x, -1): + return np.concatenate((alpha_coeffs, zero_add)) + elif np.isclose(x, 0): + return np.concatenate((coil_coeffs, zero_add)) + elif np.isclose(x, 1): + return np.concatenate((beta_coeffs, zero_add)) + + abs_x = np.abs(x) + if abs_x > 1: + err_str = ( + f"The provided value of lambda = {x} is out of lambda definition range, " + f"[-1.0, 1.0]." + ) + Logger.rank0.log(logging.ERROR, err_str) + else: + coil_coeffs[0] *= 1 - abs_x + if x < 0: + alpha_coeffs[0] *= 0.5 * (abs_x - x) + return np.concatenate((alpha_coeffs, coil_coeffs)) + else: + beta_coeffs[0] *= 0.5 * (abs_x + x) + return np.concatenate((beta_coeffs, coil_coeffs))
+ + +
[docs]def prepare_bonds_old(molecules, names, bonds, indices, config): + """Find bonded interactions from connectivity and bond types information + + .. deprecated:: 1.0.0 + :code:`prepare_bonds_old` was replaced by :code:`prepare_bonds` for + use with compiled Fortran kernels prior to 1.0.0 release. + + Prepares the necessary equilibrium and bond strength information needed by + the intramolecular interaction functions. This is performed locally on each + MPI rank, as the domain decomposition ensures that for all molecules *all* + consituent particles are always contained on *the same* MPI rankself. + + This function traverses the bond connectivity information provided in the + structure/topology input file and indentifies any two-, three-, or + four-particle potential bonds. For each connected chain of two, three, or + four particles, a matching to bond types is attempted. If the corresponding + names match, a bond object is initialized. + + In order to investigate the connectivity, a graph is created using + networkx functionality. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2 : list + List of lists containing *local* particle indices, equilibrium + distance, and bond strength coefficient for each reconstructed + two-particle bond. + bonds_3 : + List of lists containing *local* particle indices, equilibrium angle, + and bond strength coefficient for each reconstructed three-particle + bond. + bonds_4 : + List of lists containing *local* particle indices, dihedral type index, + and dihedral coefficients for each reconstructed four-particle + torsional bond. + bb_index : list + List indicating the dihedral type of each four-particle bond in + :code:`bonds_4`. + + See also + -------- + Bond : + Two-particle bond type dataclass. + Angle : + Three-particle angular bond type dataclass. + Dihedral : + Four-particle torsional bond type dataclass. + hymd.input_parser.Config + Configuration dataclass handler. + """ + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + bb_index = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + bb_dihedral = 0 + bond_graph = nx.Graph() + + for local_index, global_index in enumerate(indices): + if molecules[local_index] != mol: + continue + + bond_graph.add_node( + global_index, + name=names[local_index].decode("UTF-8"), + local_index=local_index, + ) + for bond in [b for b in bonds[local_index] if b != -1]: + bond_graph.add_edge(global_index, bond) + + connectivity = nx.all_pairs_shortest_path(bond_graph) + for c in connectivity: + i = c[0] + connected = c[1] + for j, path in connected.items(): + if len(path) == 2 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for b in config.bonds: + match_forward = name_i == b.atom_1 and name_j == b.atom_2 + match_backward = name_i == b.atom_2 and name_j == b.atom_1 + if match_forward or match_backward: + bonds_2.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[j]["local_index"], + b.equilibrium, + b.strength, + ] + ) + + if len(path) == 3 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_mid = bond_graph.nodes()[path[1]]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for a in config.angle_bonds: + match_forward = ( + name_i == a.atom_1 + and name_mid == a.atom_2 + and name_j == a.atom_3 + ) + match_backward = ( + name_i == a.atom_3 + and name_mid == a.atom_2 + and name_j == a.atom_1 + ) + if match_forward or match_backward: + bonds_3.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[path[1]]["local_index"], + bond_graph.nodes()[j]["local_index"], + np.radians(a.equilibrium), + a.strength, + ] + ) + + all_paths_len_four = find_all_paths(bond_graph, i, 3) + for p in all_paths_len_four: + name_i = bond_graph.nodes()[i]["name"] + name_mid_1 = bond_graph.nodes()[p[1]]["name"] + name_mid_2 = bond_graph.nodes()[p[2]]["name"] + name_j = bond_graph.nodes()[p[3]]["name"] + + for a in config.dihedrals: + match_forward = ( + name_i == a.atom_1 + and name_mid_1 == a.atom_2 + and name_mid_2 == a.atom_3 + and name_j == a.atom_4 + ) + if ( + match_forward + and [ + bond_graph.nodes()[p[3]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[i]["local_index"], + a.coeffs, + a.dih_type, + ] + not in bonds_4 + ): + bonds_4.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[3]]["local_index"], + a.coeffs, + a.dih_type, + ] + ) + if a.dih_type == 1: + bb_dihedral = len(bonds_4) + + if bb_dihedral: + bb_index.append(bb_dihedral - 1) + + return bonds_2, bonds_3, bonds_4, bb_index
+ + +
[docs]def prepare_index_based_bonds(molecules, topol): + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + resid = mol + 1 + top_summary = topol["system"]["molecules"] + resname = None + test_mol_number = 0 + for molname in top_summary: + test_mol_number += molname[1] + if resid <= test_mol_number: + resname = molname[0] + break + + if resname is None: + break + + if "bonds" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for bond in topol[resname]["bonds"]: + index_i = bond[0] - 1 + first_id + index_j = bond[1] - 1 + first_id + # bond[2] is the bond type, inherited by the itp format. Not used + equilibrium = bond[3] + strength = bond[4] + bonds_2.append([index_i, index_j, equilibrium, strength]) + + if "angles" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["angles"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + # angle[3] is the angle type, inherited by the itp format. Not used + equilibrium = np.radians(angle[4]) + strength = angle[5] + bonds_3.append([index_i, index_j, index_k, equilibrium, strength]) + + if "dihedrals" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["dihedrals"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + index_l = angle[3] - 1 + first_id + dih_type = angle[4] + coeff = angle[5] + if dih_type == 0 and isinstance(coeff[0], (float, int)): + coeff = propensity_potential_coeffs(coeff[0]) + elif dih_type == 1 and len(coeff) == 3: + coeff = np.array( + propensity_potential_coeffs(coeff[0][0]).tolist() + + coeff[1:] + ) + elif dih_type == 2: + coeff = np.array(coeff) + else: + coeff = np.insert(np.array(coeff), 2, np.zeros((2, 5)), axis=0) + bonds_4.append([index_i, index_j, index_k, index_l, coeff, dih_type, 0]) + return bonds_2, bonds_3, bonds_4
+ + +
[docs]def prepare_bonds(molecules, names, bonds, indices, config, topol=None): + """Rearrange the bond information for usage in compiled Fortran kernels + + Restructures the lists resulting from the execution of + :code:`prepare_bonds_old` into numpy arrays suitable for calls to optimized + Fortran code calculating bonded forces and energiesself. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2_atom_1 : (B,) numpy.ndarray + Local index of particle 1 for each of :code:`B` constructed + two-particle bonds. + bonds_2_atom_2 : (B,) numpy.ndarray + Local index of particle 2 for each of :code:`B` constructed + two-particle bonds. + bonds_2_equilibrium : (B,) numpy.ndarray + Equilibrium distance for each of :code:`B` constructed two-particle + bonds. + bonds_2_strength : (B,) numpy.ndarray + Bond strength for each of :code:`B` constructed two-particle + bonds. + bonds_3_atom_1 : (A,) numpy.ndarray + Local index of particle 1 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_2 : (A,) numpy.ndarray + Local index of particle 2 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_3 : (A,) numpy.ndarray + Local index of particle 3 for each of :code:`A` constructed + three-particle bonds. + bonds_3_equilibrium : (A,) numpy.ndarray + Equilibrium angle for each of :code:`A` constructed three-particle + bonds. + bonds_3_strength : (A,) numpy.ndarray + Bond strength for each of :code:`A` constructed three-particle + bonds. + bonds_4_atom_1 : (D,) numpy.ndarray + Local index of particle 1 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_2 : (D,) numpy.ndarray + Local index of particle 2 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_3 : (D,) numpy.ndarray + Local index of particle 3 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_4 : (D,) numpy.ndarray + Local index of particle 4 for each of :code:`D` constructed + four-particle bonds. + bonds_4_coeff : (D,) numpy.ndarray + Cosine series coefficients for each of :code:`D` constructed + four-particle bonds. + bonds_4_type : (D,) numpy.ndarray + Dihedral type for each of :code:`D` constructed four-particle + bonds. + bonds_4_last : (D,) numpy.ndarray + Flags indicating if :code:`dih_type` is :code:`1` for each of :code:`D` + constructed four-particle bonds. + + See also + -------- + prepare_bonds_old : + Used internally to reconstruct the bonded interactions types from the + connectivity information in the structure/topology input file and the + bonded types specified in the configuration file. + """ + if topol is not None: + bonds_2, bonds_3, bonds_4 = prepare_index_based_bonds( + molecules, topol + ) + else: + bonds_2, bonds_3, bonds_4, bb_index = prepare_bonds_old( + molecules, names, bonds, indices, config + ) + + # Bonds + bonds_2_atom1 = np.empty(len(bonds_2), dtype=int) + bonds_2_atom2 = np.empty(len(bonds_2), dtype=int) + bonds_2_equilibrium = np.empty(len(bonds_2), dtype=np.float64) + bonds_2_strength = np.empty(len(bonds_2), dtype=np.float64) + for i, b in enumerate(bonds_2): + bonds_2_atom1[i] = b[0] + bonds_2_atom2[i] = b[1] + bonds_2_equilibrium[i] = b[2] + bonds_2_strength[i] = b[3] + + # Angles + bonds_3_atom1 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom2 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom3 = np.empty(len(bonds_3), dtype=int) + bonds_3_equilibrium = np.empty(len(bonds_3), dtype=np.float64) + bonds_3_strength = np.empty(len(bonds_3), dtype=np.float64) + for i, b in enumerate(bonds_3): + bonds_3_atom1[i] = b[0] + bonds_3_atom2[i] = b[1] + bonds_3_atom3[i] = b[2] + bonds_3_equilibrium[i] = b[3] + bonds_3_strength[i] = b[4] + # Dihedrals + bonds_4_atom1 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom2 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom3 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom4 = np.empty(len(bonds_4), dtype=int) + number_of_coeff = 6 + len_of_coeff = 5 + bonds_4_coeff = np.empty( + (len(bonds_4), number_of_coeff, len_of_coeff), dtype=np.float64 + ) + bonds_4_type = np.empty(len(bonds_4), dtype=int) + bonds_4_last = np.zeros(len(bonds_4), dtype=int) + for i, b in enumerate(bonds_4): + bonds_4_atom1[i] = b[0] + bonds_4_atom2[i] = b[1] + bonds_4_atom3[i] = b[2] + bonds_4_atom4[i] = b[3] + bonds_4_coeff[i] = np.resize(b[4], (number_of_coeff, len_of_coeff)) + bonds_4_type[i] = b[5] + if topol is not None: + bonds_4_last[i] = b[6] + if topol is None: + bonds_4_last[bb_index] = 1 + + return ( + bonds_2_atom1, + bonds_2_atom2, + bonds_2_equilibrium, + bonds_2_strength, + bonds_3_atom1, + bonds_3_atom2, + bonds_3_atom3, + bonds_3_equilibrium, + bonds_3_strength, # noqa: E501 + bonds_4_atom1, + bonds_4_atom2, + bonds_4_atom3, + bonds_4_atom4, + bonds_4_coeff, + bonds_4_type, + bonds_4_last, # noqa: E501 + )
+ + +
[docs]def compute_bond_forces__plain(f_bonds, r, bonds_2, box_size): + """Computes forces resulting from bonded interactions + + .. deprecated:: 1.0.0 + :code:`compute_bond_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_bonds.fill(0.0) + energy = 0.0 + + for i, j, r0, k in bonds_2: + ri = r[i, :] + rj = r[j, :] + rij = rj - ri + + # Apply periodic boundary conditions to the distance rij + for dim in range(len(rij)): + rij[dim] -= box_size[dim] * np.around(rij[dim] / box_size[dim]) + dr = np.linalg.norm(rij) + df = -k * (dr - r0) + f_bond_vector = df * rij / dr + f_bonds[i, :] -= f_bond_vector + f_bonds[j, :] += f_bond_vector + + energy += 0.5 * k * (dr - r0) ** 2 + return energy
+ + +
[docs]def compute_angle_forces__plain(f_angles, r, bonds_3, box_size): + """Computes forces resulting from angular interactions + + .. deprecated:: 1.0.0 + :code:`compute_angle_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_angles.fill(0.0) + energy = 0.0 + + for a, b, c, theta0, k in bonds_3: + ra = r[a, :] - r[b, :] + rc = r[c, :] - r[b, :] + + for dim in range(len(ra)): + ra[dim] -= box_size[dim] * np.around(ra[dim] / box_size[dim]) + rc[dim] -= box_size[dim] * np.around(rc[dim] / box_size[dim]) + + xra = 1.0 / np.sqrt(np.dot(ra, ra)) + xrc = 1.0 / np.sqrt(np.dot(rc, rc)) + ea = ra * xra + ec = rc * xrc + + cosphi = np.dot(ea, ec) + theta = np.arccos(cosphi) + xsinph = 1.0 / np.sqrt(1.0 - cosphi**2) + + d = theta - theta0 + f = -k * d + + xrasin = xra * xsinph * f + xrcsin = xrc * xsinph * f + + fa = (ea * cosphi - ec) * xrasin + fc = (ec * cosphi - ea) * xrcsin + + f_angles[a, :] += fa + f_angles[c, :] += fc + f_angles[b, :] -= fa + fc + # f_angles[b, :] += -(fa + fc) + + energy -= 0.5 * f * d + + return energy
+ + +
[docs]def compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size): + """Computes forces resulting from dihedral interactions + + .. deprecated:: 1.0.0 + :code:`compute_dihedral_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_dihedrals.fill(0.0) + energy = 0.0 + + for a, b, c, d, coeffs, phase in bonds_4: + f = r[a, :] - r[b, :] + g = r[b, :] - r[c, :] + h = r[d, :] - r[c, :] + + for dim in range(3): + f -= box_size[dim] * np.around(f[dim] / box_size[dim]) + g -= box_size[dim] * np.around(g[dim] / box_size[dim]) + h -= box_size[dim] * np.around(h[dim] / box_size[dim]) + + v = np.cross(f, g) + w = np.cross(h, g) + vv = np.dot(v, v) + ww = np.dot(w, w) + gn = np.linalg.norm(g) + + cosphi = np.dot(v, w) + sinphi = np.dot(np.cross(v, w), g) / gn + phi = np.arctan2(sinphi, cosphi) + + fg = np.dot(f, g) + hg = np.dot(h, g) + sc = v * fg / (vv * gn) - w * hg / (ww * gn) + + df = 0 + + for m in range(len(coeffs[0])): + energy += coeffs[0][m] * (1 + np.cos(m * phi - coeffs[1][m])) + df += m * coeffs[0][m] * np.sin(m * phi - coeffs[1][m]) + + force_on_a = df * gn * v / vv + force_on_d = df * gn * w / ww + + f_dihedrals[a, :] -= force_on_a + f_dihedrals[b, :] += df * sc + force_on_a + f_dihedrals[c, :] -= df * sc + force_on_d + f_dihedrals[d, :] += force_on_d + return energy
+ + +
[docs]def dipole_forces_redistribution( + f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb +): + """Redistribute electrostatic forces calculated from topologically + reconstructed ghost dipole point charges to the backcone atoms of the protein. + """ + f_on_bead.fill(0.0) + for i, j, k, l, fd, matrix, dih_type, is_last in zip( + a, b, c, d, f_dipoles, trans_matrices, type_array, last_bb + ): + if dih_type == 1: + sum_force = fd[0] + fd[1] + diff_force = fd[0] - fd[1] + f_on_bead[i] += matrix[0] @ diff_force # Atom A + f_on_bead[j] += matrix[1] @ diff_force + 0.5 * sum_force # Atom B + f_on_bead[k] += matrix[2] @ diff_force + 0.5 * sum_force # Atom C + + if is_last == 1: + sum_force = fd[2] + fd[3] + diff_force = fd[2] - fd[3] + f_on_bead[j] += matrix[3] @ diff_force + f_on_bead[k] += matrix[4] @ diff_force + 0.5 * sum_force + f_on_bead[l] += matrix[5] @ diff_force + 0.5 * sum_force
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/_modules/hymd/hamiltonian.html b/v1.0.6/_modules/hymd/hamiltonian.html new file mode 100644 index 00000000..8949ca0c --- /dev/null +++ b/v1.0.6/_modules/hymd/hamiltonian.html @@ -0,0 +1,785 @@ + + + + + + hymd.hamiltonian — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.hamiltonian

+"""Interaction energy functionals.
+
+Implements field--particle interaction energy functionals depending on the
+field configuration. Extending HyMD with a new Hamiltonian is done by
+subclassing the :code:`Hamiltonian` superclass with logic intialized in the
+constructor.
+
+The grid-independent filtering function is defined in the :code:`Hamiltonian`
+superclass constructor. Hijack :code:`self.H` in a subclass to change the
+filter.
+"""
+import numpy as np
+import sympy
+
+
+
[docs]class Hamiltonian: + """Interaction energy functional superclass""" + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + self.config = config + self._setup()
+ +
[docs] def _setup(self): + """Superclass setup + + Sets up the grid-independent filtering function :code:`H`, and the + SymPy logic for symbolically differentiating interaction energy + functionals in Hamiltonian subclasses. + """ + if not hasattr(self.config, "simulation_volume"): + self.config.simulation_volume = np.prod(np.asarray(self.config.box_size)) + if not self.config.barostat: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.config.a = self.config.rho0 + if not self.config.rho0: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.phi = sympy.var("phi:%d" % (self.config.n_types)) + k = sympy.var("k:%d" % (3)) + + # electrostatics variables + self.psi = sympy.var("psi") + self.phi_q = sympy.var("phi_q") + if not self.config.self_energy: + self.config.self_energy = 0.0 + + def fourier_space_window_function(k): + return sympy.functions.elementary.exponential.exp( + -0.5 + * self.config.sigma**2 + * (k0**2 + k1**2 + k2**2) # noqa: F821, E501 + ) + + self.window_function_lambda = sympy.lambdify( + [k], fourier_space_window_function(k) + ) + + def H(k, v): + return v * self.window_function_lambda(k) + + self.H = H
+ + +
[docs]class SquaredPhi(Hamiltonian): + """Simple squared density interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + \\sum_k \\tilde\\phi_k + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`rho_0` is the + average density of the fully homogenous system. Expressing the species + densities in terms of fluctuations from the average, + + .. math:: + + \\mathrm{d}\\tilde\\phi_k = \\rho_0 - \\tilde\\phi_k, + + it is evident that this interaction energy functional is a slight change of + the :code:`DefaultNoChi` Hamiltonian, as the expanded interaction energy + density becomes + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + 6\\rho_0\\left[ + \\sum_k \\mathrm{d}\\tilde\\phi_k + \\right] + + + 9\\rho_0^2 + + + \\sum_k \\mathrm{d}\\tilde\\phi_k^2 + + + \\prod_{k\\not=l} + \\mathrm{d}\\tilde\\phi_k \\mathrm{d}\\tilde\\phi_l + \\right), + + identical to :code:`DefaultNoChi` apart from a constant energy shift + :math:`9\\rho_0^2`(which does not impact dynamics) and the + :math:`\\rho_0`--:math:`\\mathrm{d}\\tilde\\phi_k` cross-terms. These + cross-terms constitute contributions to the energy linear in + :math:`\\mathrm{d}\\tilde\\phi_k` absent in :code:`DefaultNoChi`, which has + only quadratic terms present. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(SquaredPhi, self).__init__(config) + super(SquaredPhi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0): + return 0.5 / (kappa * rho0) * (sum(phi)) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + ): + V_incompressibility = 1 / (kappa * rho0) * sum(phi) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultNoChi(Hamiltonian): + """Incompressibility-only interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. The :code:`SquaredPhi` Hamiltonian implements a similar + functional with an additional linear term component depending on + + .. math:: + + \\mathmr{d}\\tilde\\phi_k = \\tilde\\phi_k - \\rho_0 + + and not :math:`\\mathrm{d}\\tilde\\phi_k^2`. No explicit inter-species + interaction is present apart from the indirect interaction through the + incompressibility. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + hymd.input_parser.Config : + Configuration dataclass handler. + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultNoChi, self).__init__(config) + super(DefaultNoChi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0, a=self.config.a): + return 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultWithChi(Hamiltonian): + """Incompressibility and :math:`\\chi`-interactions energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = + \\frac{1}{2\\rho_0} + \\sum_{k,l}\\chi_{kl} \\tilde\\phi_k \\tilde\\phi_l + + + \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. :math:`\\chi_{ij}` is the Flory-Huggins-like + inter-species mixing energy. + """ + +
[docs] def __init__(self, config, unique_names, type_to_name_map): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultWithChi, self).__init__(config) + super(DefaultWithChi, self)._setup() + self.setup(unique_names, type_to_name_map)
+ +
[docs] def setup(self, unique_names, type_to_name_map): + """Setup the interaction energy potential and the external potential + + Parameters + ---------- + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + """ + self.type_to_name_map = type_to_name_map + self.chi_type_dictionary = { + tuple(sorted([c.atom_1, c.atom_2])): c.interaction_energy + for c in self.config.chi + } + self.phi_laplacian = [ + sympy.var("phi_laplacian%d(0:%d)" % (t, 3)) + for t in range(self.config.n_types) + ] + + def w( + phi, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + interaction = 0.0 + for i in range(self.config.n_types): + for j in range(i + 1, self.config.n_types): + ni = type_to_name_map[i] + nj = type_to_name_map[j] + names = sorted([ni, nj]) + c = chi_type_dictionary[tuple(names)] + + interaction += c * phi[i] * phi[j] / rho0 + incompressibility = 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + return incompressibility + interaction + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + t, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + + V_interaction = 0.0 + nk = type_to_name_map[t] + for i in range(self.config.n_types): + ni = type_to_name_map[i] + names = sorted([nk, ni]) + if ni != nk: + c = chi_type_dictionary[tuple(names)] + else: + c = 0.0 + # uncomment to count diagonal chi terms: + # c = chi_type_dictionary[tuple(names)] + V_interaction += c * phi[i] / rho0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[t])) + for t in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +def get_hamiltonian(config): + """Return appropriate Hamiltonian object based on the + config.hamiltonian string. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ---------- + hamiltonian : Hamiltonian + Hamiltonian object. + """ + if config.hamiltonian.lower() == "defaultnochi": + hamiltonian = DefaultNoChi(config) + elif config.hamiltonian.lower() == "defaultwithchi": + hamiltonian = DefaultWithChi( + config, config.unique_names, config.type_to_name_map + ) + elif config.hamiltonian.lower() == "squaredphi": + hamiltonian = SquaredPhi(config) + + return hamiltonian +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/_modules/hymd/input_parser.html b/v1.0.6/_modules/hymd/input_parser.html new file mode 100644 index 00000000..4b7abca6 --- /dev/null +++ b/v1.0.6/_modules/hymd/input_parser.html @@ -0,0 +1,1623 @@ + + + + + + hymd.input_parser — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.input_parser

+"""Parses and handles the configuration information provided for the simulation
+"""
+import copy
+import tomli
+import datetime
+import logging
+import warnings
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass, field
+from typing import List, Union, ClassVar
+from .force import Bond, Angle, Dihedral, Chi, Dielectric_type, propensity_potential_coeffs
+from .barostat import Target_pressure
+from .logger import Logger
+
+
+
[docs]@dataclass +class Config: + """Configuration object + + Handles and verifies the simulation configuration specified in the + configuration file. + + Attributes + ---------- + gas_constant : float + Constant value of the gas constant, R (equivalently the Boltzmann + constant) in the units used internally in HyMD. + coulomb_constant : float + Constant value of the Coulomb constant which converts electric field + values to forces and electric potential values to energies in the units + used internally in HyMD. + n_steps: int + Number of time steps in the simulation. + time_step: float + *Outer* time step used in the simulation. If the rRESPA intergrator is + used, the *inner* time step (the time step used in the integration of + intramolecular bending, stretching, and torsional forces) is + :code:`time_step / respa_inner`. + box_size : list[float] or (D,) numpy.ndarray + Simulation box size of simulation in :code:`D` dimensions in units of + nanometers. + mesh_size : list[int] or int or numpy.ndarray + Number of grid points used for the discrete density grid. + sigma : float + Filter width representing the effective coarse-graining level of the + particles in the simulation. + kappa : float + Compressibility parameter used in the relaxed incompressibility term in + the interaction energy functional. + n_print : int, optional + Frequency of trajectory/energy output to the H5MD trajectory/energy + output file (in units of number of time steps). + tau : float, optional + The time scale of the CSVR thermostat coupling. + start_temperature : float, optional + Generate starting temperature by assigning all particle velocities + randomly according to the Maxwell-Boltzmann distribution at + :code:`start_temperature` Kelvin prior to starting the simulation. + target_temperature : float, optional + Couple the system to a heat bath at :code:`target_temperature` Kelvin. + mass : float, optional + Mass of the particles in the simulation. + hamiltonian : str, optional + Specifies the interaction energy functional :math:`W[\\tilde\\phi]` + for use with the particle-field interactions. Options: + :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`. + domain_decomposition : int, optional + Specifies the interval (in time steps) of domain decomposition + exchange, involving all MPI ranks sending and receiving particles + according to the particles’ positions in the integration box and the + MPI ranks’ assigned domain. + integrator : str, optional + Specifies the time integrator used in the simulation. Options: + :code:`velocity-verlet` or :code:`respa`. + respa_inner : int, optional + The number of inner time steps in the rRESPA integrator. This denotes + the number of intramolecular force calculations (stretching, bending, + torsional) are performed between each impulse applied from the field + forces. + file_name : str, optional + File path of the parsed configuration file. + name : str, optional + Name for the simulation. + tags : list[str], optional + Tags for the simulation. + bonds : list[Bond], optional + Specifies harmonic stretching potentials between particles in the + same molecule. + angle_bonds : list[Angle], optional + Specifies harmonic angular bending potentials between particles in the + same molecule. + dihedrals : list[Dihedral], optional + Specifies four-particle torsional potentials by cosine series. + chi : list[Chi], optional + Specifies :math:`\\chi`-interaction parameters between particle + species. + n_particles : int, optional + Specifies the total number of particles in the input. Optional keyword + for validation, ensuring the input HDF5 topology has the correct number + of particles and molecules. + max_molecule_size : int, optional + Maximum size of any single molecule in the system. Used to speed up + distribution of particles onto MPI ranks in a parallel fashion. + n_flush : int, optional + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be + written to disk (in units of number of :code:`n_print`). + thermostat_work : float + Work performed by the thermostat on the system. + thermostat_coupling_groups : list[str], optional + Specifies individual groups coupling independently to the CSVR + thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and + :code:`"C"` type particles, + :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would + thermalise types :code:`"A"` and :code:`"B"` together and couple + :code:`"C"` type particles to a different thermostat (all individual + thermostats are at the same temperature, i.e. target_temperature + Kelvin). + initial_energy : float + Value of the total energy prior to the start of the simulation. + cancel_com_momentum : int, optional + If :code:`True`, the total linear momentum of the center of mass is + removed before starting the simulation. If an integer is specifed, the + total linear momentum of the center of mass is removed every + :code:`remove_com_momentum` time steps. If :code:`False`, the linear + momentum is never removed. + coulombtype : str, optional + Specifies the type of electrostatic Coulomb interactions in the system. + The strength of the electrostatic forces is modulated by the relative + dielectric constant of the simulation medium, specified with the + :code:`dielectric_const` keyword. Charges for individual particles are + specified in the structure/topology HDF5 input file, not in the + configuration file. If no charges (or peptide backbone dipoles) are + present, the electrostatic forces will not be calculated even if this + keyword is set to :code:`"PIC_Spectral"`. + dielectric_const : float, optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. When + using helical propensity dihedrals, this keyword must be specified—even + if electrostatics are not included with the :code:`coulombtype` + keyword. + dielectric_type: list[float], optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. The list assigns + relative dielectric values to each bead type, and an anisotropic + dielectric function is obtained from a weighted average. + + + See also + -------- + hymd.input_parser.Bond : + Two-particle bond type dataclass. + hymd.input_parser.Angle : + Three-particle bond type dataclass. + hymd.input_parser.Dihedral : + Four-particle bond type dataclass. + """ + + gas_constant: ClassVar[float] = 0.0083144621 # kJ mol-1 K-1 + coulomb_constant: ClassVar[float] = 138.935458 # kJ nm mol-1 e-2 + + n_steps: int + time_step: float + mesh_size: Union[Union[List[int], np.ndarray], int] + sigma: float + kappa: float + + dtype: np.dtype = None + box_size: Union[List[float], np.ndarray] = None + n_print: int = None + tau: float = None + start_temperature: Union[float, bool] = None + target_temperature: Union[float, bool] = None + mass: float = None + hamiltonian: str = None + domain_decomposition: Union[int, bool] = None + integrator: str = None + respa_inner: int = 1 + file_name: str = "<config file path unknown>" + name: str = None + tags: List[str] = field(default_factory=list) + bonds: List[Bond] = field(default_factory=list) + angle_bonds: List[Angle] = field(default_factory=list) + dihedrals: List[Dihedral] = field(default_factory=list) + chi: List[Chi] = field(default_factory=list) + n_particles: int = None + max_molecule_size: int = None + n_flush: int = None + thermostat_work: float = 0.0 + thermostat_coupling_groups: List[List[str]] = field(default_factory=list) + initial_energy: float = None + cancel_com_momentum: Union[int, bool] = False + coulombtype: str = None + convergence_type: str = None + pol_mixing: float = None + dielectric_const: float = None + conv_crit: float = None + dielectric_type: List[Dielectric_type] = field(default_factory=list) + self_energy: float = None + type_charges: Union[List[float], np.ndarray] = None + + # For NPT runs + rho0: float = None + a: float = None + pressure: bool = False + barostat: str = None + barostat_type: str = None + tau_p: float = None + target_pressure: List[Target_pressure] = field(default_factory=list) + n_b: int = None + m: List[float] = field(default_factory=list) + + def __str__(self): + target_pressure_str = "\ttarget_pressure:\n" + "".join( + "\t\tP_L: " + + f"{self.target_pressure.P_L}\n" + + "\t\tP_N: " + + f"{self.target_pressure.P_N}\n" + ) + bonds_str = "\tbonds:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " f"{k.equilibrium}, {k.strength}\n") + for k in self.bonds + ] + ) + angle_str = "\tangle_bonds:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3}: " + + f"{k.equilibrium}, {k.strength}\n" + ) + for k in self.angle_bonds + ] + ) + dihedrals_str = "\tdihedrals:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: " + # This might need to be fixed/made prettier, probably + # there's an easier way + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ).join( + map( + str, + [ + [round(num, 3) for num in c_in] + if isinstance(c_in, list) + else c_in + for c_in in k.coeffs + ], + ) + ) + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ) + + f"dih_type = {k.dih_type}\n" + ) + for k in self.dihedrals + ] + ) + chi_str = "\tchi:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " + f"{k.interaction_energy}\n") + for k in self.chi + ] + ) + + """ If dielectric wanted as dictionary + dielectric_type_str = "\tdielectric_type:\n" + "".join( + [ + (f"\t\t{k.atom_1}: " + f"{k.dielectric_value}\n") + for k in self.dielectric_type + ] + ) + + """ + + thermostat_coupling_groups_str = "" + if any(self.thermostat_coupling_groups): + thermostat_coupling_groups_str = ( + "\tthermostat_coupling_groups:\n" + + "".join( + [ + "\t\t" + ", ".join([f"{n}" for n in ng]) + "\n" + for ng in self.thermostat_coupling_groups + ] + ) + ) + + ret_str = f'\n\n\tConfig: {self.file_name}\n\t{50 * "-"}\n' + for k, v in self.__dict__.items(): + if k not in ( + "target_pressure", + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "thermostat_coupling_groups", + ): + ret_str += f"\t{k}: {v}\n" + ret_str += ( + target_pressure_str + + bonds_str + + angle_str + + dihedrals_str + + chi_str + + thermostat_coupling_groups_str + ) + return ret_str
+ + +
[docs]def read_config_toml(file_path): + with open(file_path, "r") as in_file: + file_content = in_file.read() + return file_content
+ +
[docs]def parse_config_toml(toml_content, file_path=None, comm=MPI.COMM_WORLD): + config_dict = {} + + # read toml to a dictionary + toml_content = tomli.loads(toml_content) + + # Defaults = None + for n in ( + "box_size", + "n_print", + "tau", + "start_temperature", + "target_temperature", + "mass", + "hamiltonian", + "domain_decomposition", + "integrator", + "name", + "n_particles", + "max_molecule_size", + "coulombtype", + "convergence_type", + "dielectric_const", + "pol_mixing", + "conv_crit", + "dielectric_type", + "n_b", + "box_size", + "n_flush", + "self_energy", + "dtype", + ): + config_dict[n] = None + + # Defaults = [] + + for n in ( + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "tags", + "m", + "dielectric_type", + "target_pressure", + "type_charges", + ): + config_dict[n] = [] + + # Defaults: bool + config_dict["pressure"] = False + + # Flatten the .toml dictionary, ignoring the top level [tag] directives (if + # any). + for k, v in toml_content.items(): + if isinstance(v, dict): + if k == "nn": # Don't parse diff-hymd optimization options + continue + for nested_k, nested_v in v.items(): + config_dict[nested_k] = nested_v + else: + config_dict[k] = v + for k, v in config_dict.items(): + if k == "bonds": + config_dict["bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["bonds"][i] = Bond( + atom_1=b[0], + atom_2=b[1], + equilibrium=b[2], + strength=b[3], + ) + if k == "angle_bonds": + config_dict["angle_bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["angle_bonds"][i] = Angle( + atom_1=b[0], + atom_2=b[1], + atom_3=b[2], + equilibrium=b[3], + strength=b[4], + ) + if k == "dihedrals": + config_dict["dihedrals"] = [None] * len(v) + for i, b in enumerate(v): + try: + dih_type = int(b[2][0]) + except IndexError: + Logger.rank0.log( + logging.WARNING, "Dihedral type not provided, defaulting to 0." + ) + dih_type = 0 + + # Probably it's better to move this in check_dihedrals? + wrong_len = len(b[1]) not in (1, 2) + wrong_type_1 = len(b[1]) == 1 and not isinstance(b[1][0], float) + wrong_type_2 = len(b[1]) == 2 and not isinstance(b[1][0], list) + if wrong_len or wrong_type_1 or wrong_type_2: + err_str = ( + "The coefficients specified for the dihedral type " + "(0) do not match the correct structure. Either " + "use [lambda] or [[cn_prop], [dn_prop]], or select" + " the correct dihedral type." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise RuntimeError(err_str) + + # FIXME: this is messy af, I don't like it + if dih_type == 0 and isinstance(b[1][0], (float, int)): + coeff = propensity_potential_coeffs(b[1][0]) + elif dih_type == 1 and len(b[1]) == 3: + coeff = np.array( + propensity_potential_coeffs(b[1][0][0]).tolist() + + b[1][1:] + ) + elif dih_type == 2: + coeff = np.array(b[1]) + else: + coeff = np.insert(np.array(b[1]), 2, np.zeros((2, 5)), axis=0) + + config_dict["dihedrals"][i] = Dihedral( + atom_1=b[0][0], + atom_2=b[0][1], + atom_3=b[0][2], + atom_4=b[0][3], + coeffs=coeff, + dih_type=dih_type, + ) + if k == "chi": + config_dict["chi"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0], c[1]]) + config_dict["chi"][i] = Chi( + atom_1=c_[0], atom_2=c_[1], interaction_energy=c[2] + ) + + """ + if k == "dielectric_type": + config_dict["dielectric_type"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0][0]]) + config_dict["dielectric_type"][i] = Dielectric_type( + atom_1=c_[0], dielectric_value=c[1][0] + ) + """ + if k == "target_pressure": + if len(v) == 2: + config_dict["target_pressure"] = Target_pressure( + P_L=v[0], + P_N=v[1], # check condition # V array (still read as array?) + ) + elif len(v) == 1: + config_dict["target_pressure"] = Target_pressure(P_L=v[0], P_N=None) + else: + config_dict["target_pressure"] = Target_pressure(P_L=None, P_N=None) + + if file_path is not None: + config_dict["file_name"] = file_path + + for n in ( + "n_steps", "time_step", "mesh_size", "sigma", "kappa" + ): + if n not in config_dict: + err_str = ( + f"No {n} specified in config file {file_path}. Unable to start" + f" simulation." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return Config(**config_dict)
+ + +
[docs]def check_n_particles(config, indices, comm=MPI.COMM_WORLD): + n_particles = comm.allreduce(len(indices), MPI.SUM) + if config.n_particles is None: + config = copy.deepcopy(config) + config.n_particles = n_particles + info_str = ( + f"No n_particles found in toml file {config.file_name}, defaulting" + f" to indices.shape ({n_particles})" + ) + Logger.rank0.log(logging.INFO, info_str) + return config + + if n_particles != config.n_particles: + warn_str = ( + f"n_particles in {config.file_name} ({config.n_particles}) does " + "not match the shape of the indices array in the .HDF5 file " + f"({n_particles}). Defaulting to using indices.shape " + f"({n_particles})" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.n_particles = n_particles + return config
+ + +
[docs]def check_max_molecule_size(config, comm=MPI.COMM_WORLD): + if config.max_molecule_size is None: + info_str = ( + f"No max_molecule_size found in toml file {config.file_name}, " + f"defaulting to 201" + ) + Logger.rank0.log(logging.INFO, info_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + + if config.max_molecule_size < 1: + warn_str = ( + f"max_molecule_size in {config.file_name} must be a positive " + f"integer, not {config.max_molecule_size}, defaulting to 201" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + return config
+ + +def _find_unique_names(config, names, comm=MPI.COMM_WORLD): + unique_names = np.unique(names) + receive_buffer = comm.gather(unique_names, root=0) + + gathered_unique_names = None + if comm.Get_rank() == 0: + gathered_unique_names = np.unique(np.concatenate(receive_buffer)) + unique_names = comm.bcast(gathered_unique_names, root=0) + unique_names = sorted([n.decode("UTF-8") for n in unique_names]) + config.unique_names = unique_names + config.n_types = len(unique_names) + return config + + +def _setup_type_to_name_map(config, names, types, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + name_to_type_ = {} + for n, t in zip(names, types): + n = n.decode("utf-8") + if n not in name_to_type_: + name_to_type_[n] = t + receive_buffer = comm.gather(name_to_type_, root=0) + gathered_dict = None + if comm.Get_rank() == 0: + gathered_dict = {} + for d in receive_buffer: + for k, v in d.items(): + if k not in gathered_dict: + gathered_dict[k] = v + else: + assert v == gathered_dict[k] + name_to_type_map = comm.bcast(gathered_dict, root=0) + config.name_to_type_map = name_to_type_map + config.type_to_name_map = {v: k for k, v in name_to_type_map.items()} + return config + + +
[docs]def check_bonds(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for b in config.bonds: + if b.atom_1 not in unique_names or b.atom_2 not in unique_names: + missing_str = "" + if b.atom_1 not in unique_names: + if b.atom_2 not in unique_names: + if b.atom_1 == b.atom_2: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"neither {b.atom_1}, {b.atom_2} atoms" + else: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"no {b.atom_2} atoms" + + warn_str = ( + f"Bond type {b.atom_1}--{b.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_angles(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for a in config.angle_bonds: + if ( + a.atom_1 not in unique_names + or a.atom_2 not in unique_names + or a.atom_3 not in unique_names + ): + missing = [ + a.atom_1 not in unique_names, + a.atom_2 not in unique_names, + a.atom_3 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([a.atom_1, a.atom_2, a.atom_3]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Angle bond type {a.atom_1}--{a.atom_2}--{a.atom_3} " + f"specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_dihedrals(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for d in config.dihedrals: + if ( + d.atom_1 not in unique_names + or d.atom_2 not in unique_names + or d.atom_3 not in unique_names + or d.atom_4 not in unique_names + ): + missing = [ + d.atom_1 not in unique_names, + d.atom_2 not in unique_names, + d.atom_3 not in unique_names, + d.atom_4 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([d.atom_1, d.atom_2, d.atom_3, d.atom_4]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Dihedral type {d.atom_1}--{d.atom_2}--{d.atom_3}--{d.atom_4}" + f" specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_chi(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for c in config.chi: + if c.atom_1 not in unique_names or c.atom_2 not in unique_names: + missing_str = "" + if c.atom_1 not in unique_names: + if c.atom_2 not in unique_names: + if c.atom_1 == c.atom_2: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"neither {c.atom_1}, {c.atom_2} atoms" + else: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"no {c.atom_2} atoms" + + warn_str = ( + f"Chi interaction {c.atom_1}--{c.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + for i, n in enumerate(unique_names): + for m in unique_names[i + 1 :]: + found = False + for c in config.chi: + if (c.atom_1 == n and c.atom_2 == m) or ( + c.atom_1 == m and c.atom_2 == n + ): + found = True + if not found: + config.chi.append(Chi(atom_1=n, atom_2=m, interaction_energy=0.0)) + warn_str = ( + f"Atom types {n} and {m} found in the " + f"system, but no chi interaction {n}--{m} " + f"specified in {config.file_name}. Defaulting to " + f"chi[{n}, {m}] = 0" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_box_size(config, input_box, comm=MPI.COMM_WORLD): + if config.box_size is not None: + config.box_size = np.array(config.box_size, dtype=np.float32) + if input_box.all() and not np.allclose(config.box_size, input_box, atol=0.009): + err_str = ( + f"Box size specified in {config.file_name}: " + f"{config.box_size} does not match input box:" + f"{input_box}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + else: + if input_box.all(): + config.box_size = input_box + else: + err_str = f"No box information found" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + for b in config.box_size: + if b <= 0.0: + err_str = ( + f"Invalid box size specified in {config.file_name}: " + f"{config.box_size}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return config
+ + +
[docs]def check_integrator(config, comm=MPI.COMM_WORLD): + if config.integrator.lower() not in ("velocity-verlet", "respa"): + err_str = ( + f"Invalid integrator specified in {config.file_name}: " + f'{config.integrator}. Available options "velocity-verlet" or ' + f'"respa".' + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + if config.integrator.lower() == "respa": + if isinstance(config.respa_inner, float): + warn_str = ( + f"Number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner} specified " + f"as float, using {int(config.respa_inner)}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = int(config.respa_inner) + elif not isinstance(config.respa_inner, int): + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + + if config.respa_inner <= 0: + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + if config.integrator.lower() == "velocity-verlet" and config.respa_inner != 1: + warn_str = ( + f"Integrator type Velocity-Verlet specified in {config.file_name} " + f"and inner rRESPA time steps set to {config.respa_inner}. " + f"Using respa_inner = 1" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = 1 + + return config
+ + +
[docs]def check_hamiltonian(config, comm=MPI.COMM_WORLD): + valid_hamiltonians = ["defaultnochi", "defaultwithchi", "squaredphi"] + + if config.hamiltonian is None: + if len(config.chi) == 0: + warn_str = ( + f"No hamiltonian form and no chi interactions specified in " + f"{config.file_name}, defaulting to DefaultNoChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultNoChi" + else: + warn_str = ( + f"No hamiltonian form specified in {config.file_name}, but " + f"chi interactions are specified, defaulting to " + f"DefaultWithChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultWithChi" + elif config.hamiltonian.lower() not in valid_hamiltonians: + err_str = ( + f"The specified Hamiltonian {config.hamiltonian} was not " + f"recognized as a valid Hamiltonian." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise NotImplementedError(err_str) + + return config
+ + +
[docs]def check_n_flush(config, comm=MPI.COMM_WORLD): + if config.n_print: + if config.n_flush is None: + config.n_flush = 10000 // config.n_print + return config
+ + +
[docs]def check_n_print(config, comm=MPI.COMM_WORLD): + if ( + not isinstance(config.n_print, int) + and not isinstance(config.n_print, float) + and config.n_print is not None + ): + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if config.n_print is None or config.n_print <= 0: + config.n_print = False + elif not isinstance(config.n_print, int): + if isinstance(config.n_print, float): + warn_str = ( + f"n_print is a float ({config.n_print}), not int, using " + f"{int(round(config.n_print))}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + config.n_print = int(round(config.n_print)) + else: + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + return config
+ + +
[docs]def check_tau(config, comm=MPI.COMM_WORLD): + if config.tau is None and config.target_temperature is not None: + warn_str = "target temp specified but no tau, defaulting 0.7" + config.tau = 0.7 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_start_and_target_temperature(config, comm=MPI.COMM_WORLD): + """Validate provided starting and target thermostat temperatures + + Assesses the provided temperature target and ensures it is a non-negative + floating point number or :code:`False`. Ensures the starting temperature is + a non-negative floating point number or :code:`False`. + + If the value for either is :code:`None`, the returned configuration object + has the values defaulted to :code:`False` in each case. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ------- + validated_config : Config + Configuration object with validated :code:`target_temperature` and + :code:`start_temperature`. + """ + for t in ("start_temperature", "target_temperature"): + if getattr(config, t) is not None: + try: + if getattr(config, t) < 0: + warn_str = ( + f"{t} set to negative value ({getattr(config, t)}), " + f"defaulting to False" + ) + setattr(config, t, False) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + except TypeError as e: + err_str = ( + f"Could not interpret {t} = {repr(getattr(config, t))} as " + f"a number." + ) + raise TypeError(err_str) from e + + if config.start_temperature is None: + config.start_temperature = False + if config.target_temperature is None: + config.target_temperature = False + return config
+ + +
[docs]def check_mass(config, comm=MPI.COMM_WORLD): + if config.mass is None: + info_str = "no mass specified, defaulting to 72.0" + config.mass = 72.0 + Logger.rank0.log(logging.INFO, info_str) + elif not isinstance(config.mass, int) and not isinstance(config.mass, float): + err_str = ( + f"specified mass is invalid type {config.mass}, " f"({type(config.mass)})" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + elif config.mass < 0: + err_str = f"invalid mass specified, {config.mass}" + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + else: + config.mass = float(config.mass) + + return config
+ + +
[docs]def check_domain_decomposition(config, comm=MPI.COMM_WORLD): + dd = config.domain_decomposition + if dd is None or dd is False: + config.domain_decomposition = False + return config + + if isinstance(dd, int): + if dd < 0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + elif isinstance(dd, float): + if dd < 0.0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + else: + warn_str = ( + f"domain_decomposition ({config.domain_decomposition}) is not " + f"an integer, using {int(round(dd))}" + ) + config.domain_decomposition = int(round(dd)) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + else: + err_str = ( + f"invalid value for domain_decomposition " + f"({config.domain_decomposition}) use an integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + return config
+ + +
[docs]def check_name(config, comm=MPI.COMM_WORLD): + if config.name is None: + root_current_time = "" + if comm.Get_rank() == 0: + root_current_time = datetime.datetime.now().strftime("%m/%d/%Y, %H:%M:%S") + current_time = comm.bcast(root_current_time, root=0) + + if config.name is None: + config.name = "sim" + current_time + else: + config.name = str(config.name) + return config
+ + +
[docs]def check_NPT_conditions(config, comm=MPI.COMM_WORLD): + """ + Check validity of barostat_type, barostat, + a, rho0, target_pressure, tau_p + """ + if config.barostat is None: + if ( + config.tau_p is not None + or (config.target_pressure.P_L and config.target_pressure.P_N) is not None + ): + err_str = ( + "barostat not specified but config.tau_p " + "or config.target_pressure specified, cannot start simulation {config.barostat}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.a: + warn_str = "a specified but no barostat," "setting a to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.rho0: + warn_str = ( + "rho0 specified but no barostat," "setting rho0 to average density" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + if config.barostat is not None: + if not config.barostat_type: + config.barostat_type = "berendsen" + warn_str = "barostat_type not specified," "setting to berendsen" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.barostat != "isotropic" and config.barostat != "semiisotropic": + err_str = "barostat option not recognised. Valid options: isotropic, semiisotropic" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.target_pressure.P_L is None: + config.target_pressure.P_L = 1.0 # bar + config.target_pressure.P_N = None + if config.barostat == "semiisotropic": + config.target_pressure.P_N = 1.0 # bar + warn_str = ( + "barostat specified but no target_pressure, defaulting to 1.0 bar" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.tau_p is None: + if config.tau <= 0.1: + config.tau_p = config.tau * 10.0 + else: + config.tau_p = 1.0 + warn_str = "barostat specified but no tau_p, defaulting to " + str( + config.tau_p + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if not config.a: + err_str = "a not specified; cannot start simulation {config.a}" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if not config.rho0: + warn_str = "rho0 not specified;" "setting rho0 to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + return config
+ + +
[docs]def check_thermostat_coupling_groups(config, comm=MPI.COMM_WORLD): + if any(config.thermostat_coupling_groups): + found = [0 for _ in config.unique_names] + unique_names = [n for n in config.unique_names] + for i, group in enumerate(config.thermostat_coupling_groups): + for species in group: + try: + ind = unique_names.index(species) + found[ind] += 1 + except ValueError as e: + err_str = ( + f"Particle species {species} specified in thermostat " + f"coupling group {i}, but no {species} particles were " + "found in the system." + ) + raise ValueError(err_str) from e + if any([True if f > 1 else False for f in found]): + for i, f in enumerate(found): + if f > 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} specified in multiple " + "thermostat coupling groups; " + f"{config.thermostat_coupling_groups}." + ) + raise ValueError(err_str) + if not all([True if f == 1 else False for f in found]): + for i, f in enumerate(found): + if f != 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} not specified in any " + f"thermostat coupling group, but {species} particles " + "were found in the system" + ) + raise ValueError(err_str) + return config
+ + +
[docs]def check_m(config, comm=MPI.COMM_WORLD): + if config.m == []: + config.m = [1.0 for t in range(config.n_types)] + return config
+ + +
[docs]def check_n_b(config, comm=MPI.COMM_WORLD): + if config.n_b is None: + warn_str = f"config.n_b not specified." "Defaulting to 1" + config.n_b = 1 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_cancel_com_momentum(config, comm=MPI.COMM_WORLD): + if isinstance(config.cancel_com_momentum, int): + if config.cancel_com_momentum == 0 or config.cancel_com_momentum < 0: + config.cancel_com_momentum = False + elif not isinstance(config.cancel_com_momentum, bool): + err_str = ( + f"Could not interpret {config.cancel_com_momentum} as an integer " + f"or boolean." + ) + raise ValueError(err_str) + return config
+ + +
[docs]def sort_dielectric_by_type_id(config, charges, types): + """ + Creates a list of length N CG-particles, sorted after the charges from + the input HDF5 file. Used in file_io.py + """ + dielectric_val = np.zeros(config.n_types) + for j in range(config.n_types): + name = config.dielectric_type[j][0][0] + type_id = config.name_to_type_map[name] + dielectric_val[type_id] = config.dielectric_type[j][1][0] + config.dielectric_type = dielectric_val.copy() + + N = len(charges) + len_list = np.zeros(config.n_types) + dielectric_by_types = np.zeros(N) + for i in range(N): + dielectric_by_types[i] = dielectric_val[types[i]] + # print("types ", types) + # print("diel val", dielectric_by_types) + # print("charges", charges) + # print(config.name_to_type_map) + return dielectric_by_types # by types with each particle id
+ + +
[docs]def check_charges_types_list(config, types, charges, comm=MPI.COMM_WORLD): + """ + Creates a list of charge values of length types. + Charges are sorted according to type ID. Used in field.py. + # TODO: this is messy, we should fix it + """ + if charges is None: + config.type_charges = [0.0] * config.n_types + return config + + check_val = -100.0 # some random value that will never be encountered + charges_list = np.full(config.n_types, check_val) # gatherv cant handle None + rank = comm.Get_rank() + # print(charges_list) + for t_ in range(config.n_types): + if t_ in types: + charges_list[t_] = charges[types == t_][0] + + nprocs = int(comm.Get_size()) + recv_charges = None + if rank == 0: + recv_charges = np.full( + config.n_types * nprocs, check_val + ) # gatherv cant handle None + comm.Gather(charges_list, recv_charges, root=0) + + ## make a charges list + if rank == 0: + config_charges = np.zeros(config.n_types) + test_config = np.full(config.n_types, check_val) + for j in range(nprocs): + for i in range(config.n_types): + if recv_charges[i + j * config.n_types] != check_val: + config_charges[i] = recv_charges[i + j * config.n_types] + if np.any([test_config, config_charges]): + continue + else: + break + + # print(config_charges) + # print(config.name_to_type_map) + # print(charges[types == 0][0],charges[types == 1][0],charges[types == 2][0],charges[types == 3][0], + # charges[types == 4][0]) + else: + config_charges = np.zeros(config.n_types) + + comm.Bcast(config_charges, root=0) + # print("config_charges", config_charges , "rank", rank) + # print(recv_charges) + # rank = comm.Get_rank() + # print(all_charges) + config.type_charges = config_charges + return config
+ + +
[docs]def check_dielectric(config, comm=MPI.COMM_WORLD): + """ + Error handling for electrostatics. + Unit testing of toml/tomli input. + """ + err_str_const = "Dielectric constant not given." + if config.coulombtype == "PIC_Spectral": + assert config.dielectric_const != None, err_str_const + + err_str = "Dielectric list is empty." + if config.coulombtype == "PIC_Spectral_GPE": + assert len(config.dielectric_type) != 0, err_str + # default values + if config.pol_mixing is None: + config.pol_mixing = 0.6 + if config.conv_crit is None: + config.conv_crit = 1e-6 + return config
+ + +
[docs]def check_charges(config, charges, comm=MPI.COMM_WORLD): + """Check if charges across ranks sum to zero. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of floats with charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + """ + total_charge = comm.allreduce(np.sum(charges), MPI.SUM) + + if not np.isclose(total_charge, 0.0): + warn_str = ( + f"Charges in the input file do not sum to zero. " + f"Total charge is {total_charge}." + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + # if charges are ok, compute self energy + if config.coulombtype == "PIC_Spectral": + from .field import compute_self_energy_q + + config.self_energy = compute_self_energy_q(config, charges, comm=comm) + + return config
+ + +
[docs]def check_config( + config, indices, names, types, charges, input_box, comm=MPI.COMM_WORLD +): + """Performs various checks on the specfied config to ensure consistency + + Parameters + ---------- + config : Config + Configuration object. + indices : (N,) numpy.ndarray + Array of integer indices for :code:`N` particles. + names : (N,) numpy.ndarray + Array of string names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of integer type indices for :code:`N` particles. + charges : (N,) numpy.ndarray + Array of floats charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + + Returns + ------- + config : Config + Validated configuration object. + """ + config = _find_unique_names(config, names, comm=comm) + if types is not None: + config = _setup_type_to_name_map(config, names, types, comm=comm) + config = check_box_size(config, input_box, comm=comm) + config = check_integrator(config, comm=comm) + config = check_max_molecule_size(config, comm=comm) + config = check_tau(config, comm=comm) + config = check_start_and_target_temperature(config, comm=comm) + config = check_mass(config, comm=comm) + config = check_domain_decomposition(config, comm=comm) + config = check_name(config, comm=comm) + config = check_n_particles(config, indices, comm=comm) + config = check_chi(config, names, comm=comm) + config = check_bonds(config, names, comm=comm) + config = check_angles(config, names, comm=comm) + config = check_dihedrals(config, names, comm=comm) + config = check_hamiltonian(config, comm=comm) + config = check_NPT_conditions(config, comm=comm) + config = check_n_b(config, comm=comm) + config = check_m(config, comm=comm) + config = check_thermostat_coupling_groups(config, comm=comm) + config = check_cancel_com_momentum(config, comm=comm) + config = check_dielectric(config, comm=comm) + config = check_n_print(config, comm=comm) + config = check_n_flush(config, comm=comm) + config = check_charges_types_list(config, types, charges, comm=comm) + if charges is not None: + config = check_charges(config, charges, comm=comm) + + return config
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/_modules/hymd/integrator.html b/v1.0.6/_modules/hymd/integrator.html new file mode 100644 index 00000000..fa7dc2e1 --- /dev/null +++ b/v1.0.6/_modules/hymd/integrator.html @@ -0,0 +1,346 @@ + + + + + + hymd.integrator — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.integrator

+"""Integrates equations of motion.
+
+Implements the Velocity Verlet integrator. The *reversible reference system
+propagator algorithm* (rRESPA) integrator uses the Velocity Verlet functions
+inside the MD loop in the main module.
+"""
+
+
+
[docs]def integrate_velocity(velocities, accelerations, time_step): + """Velocity update step of the Velocity Verlet integration algorithm. + + Computes the velocity update step of the Velocity Verlet algorithm. The + :code:`velocities` argument is **not** changed in place. + + Parameters + ---------- + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + accelerations : (N, D) numpy.ndarray + Array of accelerations of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step + + .. math:: \\mathbf{v}_{\\text{new}} = \\mathbf{v} + \\frac{\\Delta t}{2m} + \\mathbf{f} + + before the positions are moved a full step using the updated half-step + velocities. + + See Also + -------- + integrate_position : The position update step of the Velocity Verlet + algorithm. + """ + return velocities + 0.5 * time_step * accelerations
+ + +
[docs]def integrate_position(positions, velocities, time_step): + """Position update step of the Velocity Verlet integration algorithm. + + Computes the position update step of the Velocity Verlet algorithm. The + :code:`positions` argument is **not** changed in place. + + Parameters + ---------- + positions : (N, D) numpy.ndarray + Array of positions of :code:`N` particles in :code:`D` dimensions. + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step, then the positions are updated a full step using the updated + velocities + + .. math:: \\mathbf{x}_{\\text{new}} = \\mathbf{x} + \\Delta t \\mathbf{v} + + See Also + -------- + integrate_velocity : The velocity update step of the Velocity Verlet + algorithm. + """ + return positions + time_step * velocities
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/_modules/hymd/logger.html b/v1.0.6/_modules/hymd/logger.html new file mode 100644 index 00000000..831b82a2 --- /dev/null +++ b/v1.0.6/_modules/hymd/logger.html @@ -0,0 +1,535 @@ + + + + + + hymd.logger — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.logger

+"""Handles event logging for simulation information, warnings, and errors.
+"""
+import sys
+import os
+import logging
+from mpi4py import MPI
+from .version import __version__
+
+
+
[docs]class MPIFilterRoot(logging.Filter): + """Log output Filter wrapper class for the root MPI rank log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + if self.comm.Get_rank() == 0: + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True + else: + return False
+ + +
[docs]class MPIFilterAll(logging.Filter): + """Log output Filter wrapper class for the all-MPI-ranks log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True
+ + +class MPIFilterStdout(logging.Filter): + """Log output Filter wrapper class for filtering STDOUT log""" + + def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.funcName = "replica 0 " + record.funcName + if MPI.COMM_WORLD.Get_rank() == 0: + record.rank = MPI.COMM_WORLD.Get_rank() + record.size = MPI.COMM_WORLD.Get_size() + return True + else: + return False + + +
[docs]class Logger: + """Log output handler class + + Notes + ----- + This wraps the default python library :code:`logging`, see + `docs.python.org/3/library/logging.html`_. + + .. _`docs.python.org/3/library/logging.html`: + https://docs.python.org/3/library/logging.html + + Attributes + ---------- + level : int + Determines the verbosity level of the log, corresponding to + logging.level. Numerical values :code:`50` (:code:`logging.CRITICAL`), + :code:`40` (:code:`logging.ERROR`), :code:`30` + (:code:`logging.WARNING`), :code:`20` (:code:`logging.INFO`), + :code:`10` (:code:`logging.DEBUG`), and :code:`0` + (:code:`logging.UNSET`) are supported values. Any log event message + less severe than the specified level is ignored. All other event + messages are emitted. + log_file : str + Path to output log file. + format : str + Prepended dump string for each log event. Specifies the log event + level, the module emitting the event, the code line, the enclosing + function name, and the MPI rank writing the message. + date_format : str + Prepends the date before all log event messages. + formatter : logging.Formatter + Formatter handling the prepending of the information in `format` and + `date_format` to each log event message. Used by default for all + loggers. + rank0 : logging.Logger + Default logger object for the root MPI rank. + all_ranks : logging.Logger + Default logger object for messages being emitted from all MPI ranks + simultaneously. + """ + + level = None + log_file = None + format = " %(levelname)-8s [%(filename)s:%(lineno)d] <%(funcName)s> {rank %(rank)d/%(size)d} %(message)s" # noqa: E501 + date_format = "%(asctime)s" + formatter = logging.Formatter(fmt=date_format + format) + rank0 = logging.getLogger("HyMD.rank_0") + all_ranks = logging.getLogger("HyMD.all_ranks") + +
[docs] @classmethod + def setup(cls, default_level=logging.INFO, log_file=None, verbose=False, comm=MPI.COMM_WORLD): + """Sets up the logger object. + + If a :code:`log_file` path is provided, log event messages are output + to it. Otherwise, the logging messages are emitted to stdout. + + Parameters + ---------- + default_level : int, optional + Default verbosity level of the logger. Unless specified, it is + :code:`10` (:code:`logging.INFO`). + log_file : str, optional + Path to output log file. If `None` or not priovided, no log file is + used and all logging is done to stdout. + verbose : bool, optional + Increases the logging level to :code:`30` (:code:`logging.WARNING`) + if True, otherwise leaves the logging level unchanged. + """ + cls.level = default_level + cls.log_file = log_file + + log_to_stdout = False + if verbose: + log_to_stdout = True + + level = default_level + if not verbose: + level = logging.WARNING + cls.rank0.setLevel(level) + cls.all_ranks.setLevel(level) + + root_filter = MPIFilterRoot(comm) + all_filter = MPIFilterAll(comm) + cls.rank0.addFilter(root_filter) + cls.all_ranks.addFilter(all_filter) + + if (not log_file) and (not log_to_stdout): + return + if log_file: + cls.log_file_handler = logging.FileHandler(log_file) + cls.log_file_handler.setLevel(level) + cls.log_file_handler.setFormatter(cls.formatter) + + cls.rank0.addHandler(cls.log_file_handler) + cls.all_ranks.addHandler(cls.log_file_handler) + if log_to_stdout: + cls.log_to_stdout = True + cls.stdout_handler = logging.StreamHandler() + cls.stdout_handler.setLevel(level) + cls.stdout_handler.setStream(sys.stdout) + cls.stdout_handler.setFormatter(cls.formatter) + cls.stdout_handler.addFilter(MPIFilterStdout()) + + cls.rank0.addHandler(cls.stdout_handler) + cls.all_ranks.addHandler(cls.stdout_handler)
+ + +def format_timedelta(timedelta): + days = timedelta.days + hours, rem = divmod(timedelta.seconds, 3600) + minutes, seconds = divmod(rem, 60) + microseconds = timedelta.microseconds + ret_str = "" + if days != 0: + ret_str += f"{days} days " + ret_str += f"{hours:02d}:{minutes:02d}:{seconds:02d}.{microseconds:06d}" + return ret_str + + +def get_version(): + # Check if we are in a git repo and grab the commit hash and the branch if + # we are, append it to the version number in the output specification. + try: + import git + + try: + repo_dir = os.path.abspath( + os.path.join(os.path.dirname(__file__), os.pardir) + ) + repo = git.Repo(repo_dir) + commit = str(repo.head.commit)[:7] + branch = repo.active_branch + version = f"{__version__} [{branch} branch commit {commit}]" + except git.exc.InvalidGitRepositoryError: + version = f"{__version__}" + except ModuleNotFoundError: + version = f"{__version__}" + + return version + + +def print_header(): + banner = r""" + __ __ ____ __ _______ + / / / /_ __/ / /__ _________ _____ ______ / |/ / __ \ + / /_/ / / / / / / _ \/ ___/ __ `/ __ `/ ___/ / /|_/ / / / / + / __ / /_/ / / / __/ / / /_/ / /_/ (__ ) / / / / /_/ / + /_/ /_/\__, /_/_/\___/_/ \__,_/\__,_/____/ /_/ /_/_____/ + /____/ + """ + + refs_set = """ + + [1] Ledum, M.; Sen, S.; Li, X.; Carrer, M.; Feng Y.; Cascella, M.; Bore, S. L. + HylleraasMD: A Domain Decomposition-Based Hybrid Particle-Field Software for Multi-Scale Simulations of Soft Matter. + J. Chem. Theory Comput. 2023. + + [2] Ledum, M.; Carrer, M.; Sen, S.; Li, X.; Cascella, M.; Bore, S. L. + HyMD: Massively parallel hybrid particle-field molecular dynamics in Python. + J. Open Source Softw. 8(84), 4149, 2023. + + [3] Sen, S.; Ledum, M.; Bore, S. L.; Cascella, M. + Soft Matter under Pressure: Pushing Particle–Field Molecular Dynamics to the Isobaric Ensemble. + J Chem Inf Model 2023, 63(7), 1549-9596. + + [4] Bore, S. L.; Cascella, M. + Hamiltonian and alias-free hybrid particle–field molecular dynamics. + J. Chem. Phys. 2020, 153, 094106. + + [5] Pippig, M. PFFT: An extension of FFTW to massively parallel architectures. + SIAM J. Sci. Comput. 2013, 35, C213–C236. + +""" + + version = f"Version {get_version()}" + header = banner + header += version.center(56) + "\n\n" + #header += " Please read and cite the references below:" + header += " PLEASE READ AND CITE THE REFERENCES BELOW:" + header += refs_set + + return header +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/_modules/hymd/thermostat.html b/v1.0.6/_modules/hymd/thermostat.html new file mode 100644 index 00000000..bd445c9e --- /dev/null +++ b/v1.0.6/_modules/hymd/thermostat.html @@ -0,0 +1,492 @@ + + + + + + hymd.thermostat — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.thermostat

+"""Scales or otherwise modifies the particle velocities during simulation to
+simulate coupling to an external heat bath with temperature T₀.
+"""
+import numpy as np
+import logging
+from mpi4py import MPI
+from typing import Callable
+from .logger import Logger
+from .input_parser import Config
+
+
+def cancel_com_momentum(velocities, config, comm=MPI.COMM_WORLD):
+    com_velocity = comm.allreduce(np.sum(velocities[...], axis=0), MPI.SUM)
+    velocities[...] = velocities[...] - com_velocity / config.n_particles
+    return velocities
+
+
+def generate_initial_velocities(velocities, config, prng, comm=MPI.COMM_WORLD):
+    kT_start = config.gas_constant * config.start_temperature
+    n_particles_ = velocities.shape[0]
+    velocities[...] = prng.normal(
+        loc=0, scale=kT_start / config.mass, size=(n_particles_, 3)
+    )
+    velocities = cancel_com_momentum(velocities, config, comm=comm)
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    start_kinetic_energy_target = (
+        1.5 * config.gas_constant * config.n_particles * config.start_temperature
+    )
+    factor = np.sqrt(1.5 * config.n_particles * kT_start / kinetic_energy)
+    velocities[...] = velocities[...] * factor
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    Logger.rank0.log(
+        logging.INFO,
+        (
+            f"Initialized {config.n_particles} velocities, target kinetic "
+            f"energy: {start_kinetic_energy_target}, actual kinetic energy "
+            f"generated: {kinetic_energy}"
+        ),
+    )
+    return velocities
+
+
+
[docs]def _random_gaussian(prng: np.random.Generator) -> float: + """Draw a single random number from the standard normal distribution + Generate a number from the Gaussian distribution centered at zero with unit + standard deviation, :math:`N(0, 1)`. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + + Returns + ------- + float + A random number drawn from :math:`N(0, 1)`. + """ + return prng.normal()
+ + +
[docs]def _random_chi_squared(prng: np.random.Generator, M: int) -> float: + """Draw the sum of :code:`M` squared normally distributed values + + The value is generated by the Gamma distribution, in lieu of generating + :code:`M` Gaussian distributed numbers and summing their squares. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + M : int + Number of standard normally distributed numbers in the sum. + + Returns + ------- + float + The sum of :code:`M` squared normally distributed values centered at + zero with unit standard deviation. + + Notes + ----- + The sum of the squares of k independent standard normal random variables is + distributed according to a :math:`\\chi^2` distribution. + + .. math:: + + \\chi^2_1 + \\chi_2^2 + \\chi_3^2 + \\dots + \\chi_M^2 + \\sim + \\sigma^2\\chi^2(k) + + This is a special case of the :math:`\\Gamma` distribution, + :math:`\\Gamma(k/2, 2)`, and may be generated by + + .. math:: + + \\chi^2(k) \\sim 2 \\Gamma(k/2, 2) + + References + ---------- + Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of + Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. + J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246. + """ + return prng.chisquare(M)
+ + +
[docs]def csvr_thermostat( + velocity: np.ndarray, + names: np.ndarray, + config: Config, + prng: np.random.Generator, + comm: MPI.Intracomm = MPI.COMM_WORLD, + random_gaussian: Callable[[np.random.Generator], float] = _random_gaussian, + random_chi_squared: Callable[ + [np.random.Generator, int, float], float + ] = _random_chi_squared, + remove_center_of_mass_momentum: bool = True, +) -> np.ndarray: + """Canonical sampling through velocity rescaling thermostat + + Implements the CSVR thermostat. Rescales the system kinetic energy by a + stochastically chosen factor to keep the temperature constant. Requires + communcation of the kinetic energies calculated locally for each MPI rank. + The random numbers sampled through :code:`random_gaussian` and + :code:`random_chi_squared` are broadcast from the root rank to the other + ranks to ensure the scaling is performed with the same stochasticity for + all particles in the full system. + + The velocities are cleaned of center of mass momentum before the thermostat + is applied, and the center of mass momentum is subsequently reapplied. This + is performed for each thermostat coupling group, i.e. the center of mass + momenta of each *group* is separately removed and reapplied after + thermostatting. + + The implementation here is based on the derivation presented in the 2008 + Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper. + + Parameters + ---------- + velocity : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + names : (N,) numpy.ndarray + Array of particle names. + config : Config + Configuration dataclass containing simulation metadata and parameters. + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + random_gaussian : callable, optional + Function for generating standard normally distributed numbers. + random_chi_squared : callable, optional + Function for generating :math:`\\chi^2`-distributed numbers + remove_center_of_mass_momentum : bool, optional + If True, the center of mass of each coupling group is removed before + the thermostat is applied. The center of mass momenta are added back + after the kinetic energy rescaling is complete. + + See Also + -------- + _random_gaussian : + Used to sample Gaussian-distributed numbers. + _random_chi_squared : + Used to sample :math:`\\chi^2`-distributed numbers. + hymd.input_parser.Config : + Configuration dataclass handler. + + References + ---------- + G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). + G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008). + """ + if not any(config.thermostat_coupling_groups): + config.thermostat_coupling_groups = [config.unique_names.copy()] + for i, group in enumerate(config.thermostat_coupling_groups): + ind = np.where( + np.logical_or.reduce(list(names == np.string_(t) for t in group)) + ) + group_n_particles = comm.allreduce(len(ind[0]), MPI.SUM) + + # Clean velocities of center of mass momentum + if remove_center_of_mass_momentum and group_n_particles > 1: + com_velocity = comm.allreduce(np.sum(velocity[ind], axis=0)) + velocity_clean = velocity[ind] - com_velocity / group_n_particles + K = comm.allreduce(0.5 * config.mass * np.sum(velocity_clean[...] ** 2)) + else: + K = comm.allreduce(0.5 * config.mass * np.sum(velocity[...] ** 2)) + K_target = ( + 1.5 * config.gas_constant * group_n_particles * config.target_temperature + ) + N_f = 3 * group_n_particles + c = np.exp(-(config.time_step * config.respa_inner) / config.tau) + + # Random numbers are identical across ranks because all ranks have + # the same prng after the initialization of the velocities + R = random_gaussian(prng) + SNf = random_chi_squared(prng, N_f - 1) + + alpha2 = ( + c + + (1 - c) * (SNf + R**2) * K_target / (N_f * K) + + 2 * R * np.sqrt(c * (1 - c) * K_target / (N_f * K)) + ) + dK = K * (alpha2 - 1) + alpha = np.sqrt(alpha2) + + if remove_center_of_mass_momentum and group_n_particles > 1: + # Assign velocities and reapply the previously removed center + # of mass momentum removed + velocity_clean *= alpha + velocity[ind] = velocity_clean + com_velocity / group_n_particles + else: + velocity *= alpha + config.thermostat_work += dK
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/_modules/index.html b/v1.0.6/_modules/index.html new file mode 100644 index 00000000..178faf1a --- /dev/null +++ b/v1.0.6/_modules/index.html @@ -0,0 +1,280 @@ + + + + + + Overview: module code — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+ +
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/v1.0.6/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css new file mode 100644 index 00000000..1b057df2 --- /dev/null +++ b/v1.0.6/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css @@ -0,0 +1 @@ +.badge{border-radius:.25rem;display:inline-block;font-size:75%;font-weight:700;line-height:1;padding:.25em .4em;text-align:center;vertical-align:baseline;white-space:nowrap}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{border-radius:10rem;padding-left:.6em;padding-right:.6em}.badge-primary{background-color:#007bff;color:#fff}.badge-primary[href]:focus,.badge-primary[href]:hover{background-color:#0062cc;color:#fff;text-decoration:none}.badge-secondary{background-color:#6c757d;color:#fff}.badge-secondary[href]:focus,.badge-secondary[href]:hover{background-color:#545b62;color:#fff;text-decoration:none}.badge-success{background-color:#28a745;color:#fff}.badge-success[href]:focus,.badge-success[href]:hover{background-color:#1e7e34;color:#fff;text-decoration:none}.badge-info{background-color:#17a2b8;color:#fff}.badge-info[href]:focus,.badge-info[href]:hover{background-color:#117a8b;color:#fff;text-decoration:none}.badge-warning{background-color:#ffc107;color:#212529}.badge-warning[href]:focus,.badge-warning[href]:hover{background-color:#d39e00;color:#212529;text-decoration:none}.badge-danger{background-color:#dc3545;color:#fff}.badge-danger[href]:focus,.badge-danger[href]:hover{background-color:#bd2130;color:#fff;text-decoration:none}.badge-light{background-color:#f8f9fa;color:#212529}.badge-light[href]:focus,.badge-light[href]:hover{background-color:#dae0e5;color:#212529;text-decoration:none}.badge-dark{background-color:#343a40;color:#fff}.badge-dark[href]:focus,.badge-dark[href]:hover{background-color:#1d2124;color:#fff;text-decoration:none}.border-0{border:0 !important}.border-top-0{border-top:0 !important}.border-right-0{border-right:0 !important}.border-bottom-0{border-bottom:0 !important}.border-left-0{border-left:0 !important}.p-0{padding:0 !important}.pt-0,.py-0{padding-top:0 !important}.pr-0,.px-0{padding-right:0 !important}.pb-0,.py-0{padding-bottom:0 !important}.pl-0,.px-0{padding-left:0 !important}.p-1{padding:.25rem !important}.pt-1,.py-1{padding-top:.25rem !important}.pr-1,.px-1{padding-right:.25rem !important}.pb-1,.py-1{padding-bottom:.25rem !important}.pl-1,.px-1{padding-left:.25rem !important}.p-2{padding:.5rem !important}.pt-2,.py-2{padding-top:.5rem !important}.pr-2,.px-2{padding-right:.5rem !important}.pb-2,.py-2{padding-bottom:.5rem !important}.pl-2,.px-2{padding-left:.5rem !important}.p-3{padding:1rem !important}.pt-3,.py-3{padding-top:1rem !important}.pr-3,.px-3{padding-right:1rem !important}.pb-3,.py-3{padding-bottom:1rem !important}.pl-3,.px-3{padding-left:1rem !important}.p-4{padding:1.5rem !important}.pt-4,.py-4{padding-top:1.5rem !important}.pr-4,.px-4{padding-right:1.5rem !important}.pb-4,.py-4{padding-bottom:1.5rem !important}.pl-4,.px-4{padding-left:1.5rem !important}.p-5{padding:3rem !important}.pt-5,.py-5{padding-top:3rem !important}.pr-5,.px-5{padding-right:3rem !important}.pb-5,.py-5{padding-bottom:3rem !important}.pl-5,.px-5{padding-left:3rem !important}.m-0{margin:0 !important}.mt-0,.my-0{margin-top:0 !important}.mr-0,.mx-0{margin-right:0 !important}.mb-0,.my-0{margin-bottom:0 !important}.ml-0,.mx-0{margin-left:0 !important}.m-1{margin:.25rem !important}.mt-1,.my-1{margin-top:.25rem !important}.mr-1,.mx-1{margin-right:.25rem !important}.mb-1,.my-1{margin-bottom:.25rem !important}.ml-1,.mx-1{margin-left:.25rem !important}.m-2{margin:.5rem !important}.mt-2,.my-2{margin-top:.5rem !important}.mr-2,.mx-2{margin-right:.5rem !important}.mb-2,.my-2{margin-bottom:.5rem !important}.ml-2,.mx-2{margin-left:.5rem !important}.m-3{margin:1rem !important}.mt-3,.my-3{margin-top:1rem !important}.mr-3,.mx-3{margin-right:1rem !important}.mb-3,.my-3{margin-bottom:1rem !important}.ml-3,.mx-3{margin-left:1rem !important}.m-4{margin:1.5rem !important}.mt-4,.my-4{margin-top:1.5rem !important}.mr-4,.mx-4{margin-right:1.5rem !important}.mb-4,.my-4{margin-bottom:1.5rem !important}.ml-4,.mx-4{margin-left:1.5rem !important}.m-5{margin:3rem !important}.mt-5,.my-5{margin-top:3rem !important}.mr-5,.mx-5{margin-right:3rem !important}.mb-5,.my-5{margin-bottom:3rem !important}.ml-5,.mx-5{margin-left:3rem !important}.btn{background-color:transparent;border:1px solid transparent;border-radius:.25rem;color:#212529;cursor:pointer;display:inline-block;font-size:1rem;font-weight:400;line-height:1.5;padding:.375rem .75rem;text-align:center;transition:color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none;vertical-align:middle}.btn:hover{color:#212529;text-decoration:none}.btn:visited{color:#212529}.btn.focus,.btn:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.25);outline:0}.btn.disabled,.btn:disabled{opacity:.65}@media (prefers-reduced-motion: reduce){.btn{transition:none}}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary:visited{color:#fff}.btn-primary:hover{background-color:#0069d9;border-color:#0062cc;color:#fff}.btn-primary.focus,.btn-primary:focus{background-color:#0069d9;border-color:#0062cc;box-shadow:0 0 0 .2rem rgba(0,123,255,0.5);color:#fff}.btn-primary.disabled,.btn-primary:disabled{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary.active:not(:disabled):not(.disabled),.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{background-color:#0062cc;border-color:#005cbf;color:#fff}.btn-primary.active:not(:disabled):not(.disabled):focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-secondary{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary:visited{color:#fff}.btn-secondary:hover{background-color:#5a6268;border-color:#545b62;color:#fff}.btn-secondary.focus,.btn-secondary:focus{background-color:#5a6268;border-color:#545b62;box-shadow:0 0 0 .2rem rgba(108,117,125,0.5);color:#fff}.btn-secondary.disabled,.btn-secondary:disabled{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled),.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{background-color:#545b62;border-color:#4e555b;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled):focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-success{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success:visited{color:#fff}.btn-success:hover{background-color:#218838;border-color:#1e7e34;color:#fff}.btn-success.focus,.btn-success:focus{background-color:#218838;border-color:#1e7e34;box-shadow:0 0 0 .2rem rgba(40,167,69,0.5);color:#fff}.btn-success.disabled,.btn-success:disabled{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success.active:not(:disabled):not(.disabled),.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{background-color:#1e7e34;border-color:#1c7430;color:#fff}.btn-success.active:not(:disabled):not(.disabled):focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-info{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info:visited{color:#fff}.btn-info:hover{background-color:#138496;border-color:#117a8b;color:#fff}.btn-info.focus,.btn-info:focus{background-color:#138496;border-color:#117a8b;box-shadow:0 0 0 .2rem rgba(23,162,184,0.5);color:#fff}.btn-info.disabled,.btn-info:disabled{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info.active:not(:disabled):not(.disabled),.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{background-color:#117a8b;border-color:#10707f;color:#fff}.btn-info.active:not(:disabled):not(.disabled):focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-warning{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning:visited{color:#212529}.btn-warning:hover{background-color:#e0a800;border-color:#d39e00;color:#212529}.btn-warning.focus,.btn-warning:focus{background-color:#e0a800;border-color:#d39e00;box-shadow:0 0 0 .2rem rgba(255,193,7,0.5);color:#212529}.btn-warning.disabled,.btn-warning:disabled{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning.active:not(:disabled):not(.disabled),.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{background-color:#d39e00;border-color:#c69500;color:#212529}.btn-warning.active:not(:disabled):not(.disabled):focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-danger{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger:visited{color:#fff}.btn-danger:hover{background-color:#c82333;border-color:#bd2130;color:#fff}.btn-danger.focus,.btn-danger:focus{background-color:#c82333;border-color:#bd2130;box-shadow:0 0 0 .2rem rgba(220,53,69,0.5);color:#fff}.btn-danger.disabled,.btn-danger:disabled{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger.active:not(:disabled):not(.disabled),.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{background-color:#bd2130;border-color:#b21f2d;color:#fff}.btn-danger.active:not(:disabled):not(.disabled):focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-light{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light:visited{color:#212529}.btn-light:hover{background-color:#e2e6ea;border-color:#dae0e5;color:#212529}.btn-light.focus,.btn-light:focus{background-color:#e2e6ea;border-color:#dae0e5;box-shadow:0 0 0 .2rem rgba(248,249,250,0.5);color:#212529}.btn-light.disabled,.btn-light:disabled{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light.active:not(:disabled):not(.disabled),.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{background-color:#dae0e5;border-color:#d3d9df;color:#212529}.btn-light.active:not(:disabled):not(.disabled):focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-dark{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark:visited{color:#fff}.btn-dark:hover{background-color:#23272b;border-color:#1d2124;color:#fff}.btn-dark.focus,.btn-dark:focus{background-color:#23272b;border-color:#1d2124;box-shadow:0 0 0 .2rem rgba(52,58,64,0.5);color:#fff}.btn-dark.disabled,.btn-dark:disabled{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark.active:not(:disabled):not(.disabled),.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{background-color:#1d2124;border-color:#171a1d;color:#fff}.btn-dark.active:not(:disabled):not(.disabled):focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-primary{border-color:#007bff;color:#007bff}.btn-outline-primary:visited{color:#007bff}.btn-outline-primary:hover{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{background-color:transparent;color:#007bff}.btn-outline-primary.active:not(:disabled):not(.disabled),.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.active:not(:disabled):not(.disabled):focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-secondary{border-color:#6c757d;color:#6c757d}.btn-outline-secondary:visited{color:#6c757d}.btn-outline-secondary:hover{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{background-color:transparent;color:#6c757d}.btn-outline-secondary.active:not(:disabled):not(.disabled),.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.active:not(:disabled):not(.disabled):focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-success{border-color:#28a745;color:#28a745}.btn-outline-success:visited{color:#28a745}.btn-outline-success:hover{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{background-color:transparent;color:#28a745}.btn-outline-success.active:not(:disabled):not(.disabled),.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.active:not(:disabled):not(.disabled):focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-info{border-color:#17a2b8;color:#17a2b8}.btn-outline-info:visited{color:#17a2b8}.btn-outline-info:hover{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{background-color:transparent;color:#17a2b8}.btn-outline-info.active:not(:disabled):not(.disabled),.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.active:not(:disabled):not(.disabled):focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-warning{border-color:#ffc107;color:#ffc107}.btn-outline-warning:visited{color:#ffc107}.btn-outline-warning:hover{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{background-color:transparent;color:#ffc107}.btn-outline-warning.active:not(:disabled):not(.disabled),.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.active:not(:disabled):not(.disabled):focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-danger{border-color:#dc3545;color:#dc3545}.btn-outline-danger:visited{color:#dc3545}.btn-outline-danger:hover{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{background-color:transparent;color:#dc3545}.btn-outline-danger.active:not(:disabled):not(.disabled),.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.active:not(:disabled):not(.disabled):focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-light{border-color:#f8f9fa;color:#f8f9fa}.btn-outline-light:visited{color:#f8f9fa}.btn-outline-light:hover{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{background-color:transparent;color:#f8f9fa}.btn-outline-light.active:not(:disabled):not(.disabled),.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.active:not(:disabled):not(.disabled):focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-dark{border-color:#343a40;color:#343a40}.btn-outline-dark:visited{color:#343a40}.btn-outline-dark:hover{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{background-color:transparent;color:#343a40}.btn-outline-dark.active:not(:disabled):not(.disabled),.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.active:not(:disabled):not(.disabled):focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-link{color:#007bff;font-weight:400;text-decoration:none}.btn-link:hover{color:#0056b3;text-decoration:underline}.btn-link.focus,.btn-link:focus{box-shadow:none;text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{border-radius:.3rem;font-size:1.25rem;line-height:1.5;padding:.5rem 1rem}.btn-group-sm>.btn,.btn-sm{border-radius:.2rem;font-size:.875rem;line-height:1.5;padding:.25rem .5rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input.btn-block[type=button],input.btn-block[type=reset],input.btn-block[type=submit]{width:100%}.stretched-link::after{background-color:rgba(0,0,0,0);bottom:0;content:'';left:0;pointer-events:auto;position:absolute;right:0;top:0;z-index:1}.text-wrap{white-space:normal !important}.card{background-clip:border-box;background-color:#fff;border:1px solid rgba(0,0,0,0.125);border-radius:.25rem;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;min-width:0;position:relative;word-wrap:break-word}.card>hr{margin-left:0;margin-right:0}.card>.list-group:first-child .list-group-item:first-child{border-top-left-radius:.25rem;border-top-right-radius:.25rem}.card>.list-group:last-child .list-group-item:last-child{border-bottom-left-radius:.25rem;border-bottom-right-radius:.25rem}.card-body{-ms-flex:1 1 auto;flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-bottom:0;margin-top:-.375rem}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{background-color:rgba(0,0,0,0.03);border-bottom:1px solid rgba(0,0,0,0.125);margin-bottom:0;padding:.75rem 1.25rem}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-header+.list-group .list-group-item:first-child{border-top:0}.card-footer{background-color:rgba(0,0,0,0.03);border-top:1px solid rgba(0,0,0,0.125);padding:.75rem 1.25rem}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{border-bottom:0;margin-bottom:-.75rem;margin-left:-.625rem;margin-right:-.625rem}.card-header-pills{margin-left:-.625rem;margin-right:-.625rem}.card-img-overlay{bottom:0;left:0;padding:1.25rem;position:absolute;right:0;top:0}.card-img,.card-img-bottom,.card-img-top{-ms-flex-negative:0;flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-left-radius:calc(.25rem - 1px);border-bottom-right-radius:calc(.25rem - 1px)}.w-100{width:100% !important}.shadow{box-shadow:0 0.5rem 1rem rgba(0,0,0,0.15) !important}.bg-primary{background-color:#007bff !important}button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc !important}a.bg-primary:focus,a.bg-primary:hover{background-color:#0062cc !important}a.text-primary:focus,a.text-primary:hover{color:#121416 !important}.bg-secondary{background-color:#6c757d !important}button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62 !important}a.bg-secondary:focus,a.bg-secondary:hover{background-color:#545b62 !important}a.text-secondary:focus,a.text-secondary:hover{color:#121416 !important}.bg-success{background-color:#28a745 !important}button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34 !important}a.bg-success:focus,a.bg-success:hover{background-color:#1e7e34 !important}a.text-success:focus,a.text-success:hover{color:#121416 !important}.bg-info{background-color:#17a2b8 !important}button.bg-info:focus,button.bg-info:hover{background-color:#117a8b !important}a.bg-info:focus,a.bg-info:hover{background-color:#117a8b !important}a.text-info:focus,a.text-info:hover{color:#121416 !important}.bg-warning{background-color:#ffc107 !important}button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00 !important}a.bg-warning:focus,a.bg-warning:hover{background-color:#d39e00 !important}a.text-warning:focus,a.text-warning:hover{color:#121416 !important}.bg-danger{background-color:#dc3545 !important}button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130 !important}a.bg-danger:focus,a.bg-danger:hover{background-color:#bd2130 !important}a.text-danger:focus,a.text-danger:hover{color:#121416 !important}.bg-light{background-color:#f8f9fa !important}button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5 !important}a.bg-light:focus,a.bg-light:hover{background-color:#dae0e5 !important}a.text-light:focus,a.text-light:hover{color:#121416 !important}.bg-dark{background-color:#343a40 !important}button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124 !important}a.bg-dark:focus,a.bg-dark:hover{background-color:#1d2124 !important}a.text-dark:focus,a.text-dark:hover{color:#121416 !important}.bg-white{background-color:#fff !important}button.bg-white:focus,button.bg-white:hover{background-color:#e6e6e6 !important}a.bg-white:focus,a.bg-white:hover{background-color:#e6e6e6 !important}a.text-white:focus,a.text-white:hover{color:#121416 !important}.text-primary{color:#007bff !important}.text-secondary{color:#6c757d !important}.text-success{color:#28a745 !important}.text-info{color:#17a2b8 !important}.text-warning{color:#ffc107 !important}.text-danger{color:#dc3545 !important}.text-light{color:#f8f9fa !important}.text-dark{color:#343a40 !important}.text-white{color:#fff !important}.text-body{color:#212529 !important}.text-muted{color:#6c757d !important}.text-black-50{color:rgba(0,0,0,0.5) !important}.text-white-50{color:rgba(255,255,255,0.5) !important}.bg-transparent{background-color:transparent !important}.text-justify{text-align:justify !important}.text-left{text-align:left !important}.text-right{text-align:right !important}.text-center{text-align:center !important}.font-weight-light{font-weight:300 !important}.font-weight-lighter{font-weight:lighter !important}.font-weight-normal{font-weight:400 !important}.font-weight-bold{font-weight:700 !important}.font-weight-bolder{font-weight:bolder !important}.font-italic{font-style:italic !important}.container{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container{max-width:540px}}@media (min-width: 768px){.container{max-width:720px}}@media (min-width: 992px){.container{max-width:960px}}@media (min-width: 1200px){.container{max-width:1140px}}.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container,.container-sm{max-width:540px}}@media (min-width: 768px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width: 992px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width: 1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1140px}}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;margin-right:-15px}.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{padding-left:15px;padding-right:15px;position:relative;width:100%}@media (min-width: 576px){.col-sm{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-sm-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-sm-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-sm-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-sm-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-sm-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 768px){.col-md{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-md-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-md-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-md-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-md-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-md-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 992px){.col-lg{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-lg-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-lg-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-lg-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-lg-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-lg-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 1200px){.col-xl{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-xl-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-xl-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-xl-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-xl-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-xl-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}.d-flex{display:-ms-flexbox !important;display:flex !important}.sphinx-bs,.sphinx-bs *{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sphinx-bs p{margin-top:0} diff --git a/v1.0.6/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/v1.0.6/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css new file mode 100644 index 00000000..fc14abc8 --- /dev/null +++ b/v1.0.6/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css @@ -0,0 +1 @@ +details.dropdown .summary-title{padding-right:3em !important;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none}details.dropdown:hover{cursor:pointer}details.dropdown .summary-content{cursor:default}details.dropdown summary{list-style:none;padding:1em}details.dropdown summary .octicon.no-title{vertical-align:middle}details.dropdown[open] summary .octicon.no-title{visibility:hidden}details.dropdown summary::-webkit-details-marker{display:none}details.dropdown summary:focus{outline:none}details.dropdown summary:hover .summary-up svg,details.dropdown summary:hover .summary-down svg{opacity:1}details.dropdown .summary-up svg,details.dropdown .summary-down svg{display:block;opacity:.6}details.dropdown .summary-up,details.dropdown .summary-down{pointer-events:none;position:absolute;right:1em;top:.75em}details.dropdown[open] .summary-down{visibility:hidden}details.dropdown:not([open]) .summary-up{visibility:hidden}details.dropdown.fade-in[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out;animation:panels-fade-in .5s ease-in-out}details.dropdown.fade-in-slide-down[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out}@keyframes panels-fade-in{0%{opacity:0}100%{opacity:1}}@keyframes panels-slide-down{0%{transform:translate(0, -10px)}100%{transform:translate(0, 0)}}.octicon{display:inline-block;fill:currentColor;vertical-align:text-top}.tabbed-content{box-shadow:0 -.0625rem var(--tabs-color-overline),0 .0625rem var(--tabs-color-underline);display:none;order:99;padding-bottom:.75rem;padding-top:.75rem;width:100%}.tabbed-content>:first-child{margin-top:0 !important}.tabbed-content>:last-child{margin-bottom:0 !important}.tabbed-content>.tabbed-set{margin:0}.tabbed-set{border-radius:.125rem;display:flex;flex-wrap:wrap;margin:1em 0;position:relative}.tabbed-set>input{opacity:0;position:absolute}.tabbed-set>input:checked+label{border-color:var(--tabs-color-label-active);color:var(--tabs-color-label-active)}.tabbed-set>input:checked+label+.tabbed-content{display:block}.tabbed-set>input:focus+label{outline-style:auto}.tabbed-set>input:not(.focus-visible)+label{outline:none;-webkit-tap-highlight-color:transparent}.tabbed-set>label{border-bottom:.125rem solid transparent;color:var(--tabs-color-label-inactive);cursor:pointer;font-size:var(--tabs-size-label);font-weight:700;padding:1em 1.25em .5em;transition:color 250ms;width:auto;z-index:1}html .tabbed-set>label:hover{color:var(--tabs-color-label-active)} diff --git a/v1.0.6/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css b/v1.0.6/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css new file mode 100644 index 00000000..adc61662 --- /dev/null +++ b/v1.0.6/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css @@ -0,0 +1,7 @@ +:root { +--tabs-color-label-active: hsla(231, 99%, 66%, 1); +--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); +--tabs-color-overline: rgb(207, 236, 238); +--tabs-color-underline: rgb(207, 236, 238); +--tabs-size-label: 1rem; +} \ No newline at end of file diff --git a/v1.0.6/_sources/doc_pages/api.rst.txt b/v1.0.6/_sources/doc_pages/api.rst.txt new file mode 100644 index 00000000..c9f8837b --- /dev/null +++ b/v1.0.6/_sources/doc_pages/api.rst.txt @@ -0,0 +1,90 @@ +.. _api-label: + + +API reference +============= + +Integrator +---------- + +.. automodule:: hymd.integrator + :members: + + +Thermostat +---------- + +.. automodule:: hymd.thermostat + :members: csvr_thermostat, _random_chi_squared, _random_gaussian + :undoc-members: + + +Hamiltonian +----------- + +.. autoclass:: hymd.hamiltonian.Hamiltonian + :members: + + .. automethod:: __init__ + + .. automethod:: _setup + +.. autoclass:: hymd.hamiltonian.SquaredPhi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultNoChi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultWithChi + :members: + + .. automethod:: __init__ + + +Force +----- + +.. automodule:: hymd.force + :members: + :undoc-members: + + +Logger +------ + +.. autoclass:: hymd.logger.Logger + :members: + +.. autoclass:: hymd.logger.MPIFilterRoot + :members: + +.. autoclass:: hymd.logger.MPIFilterAll + :members: + + +Input parser +------------ + +.. automodule:: hymd.input_parser + :members: + :undoc-members: propensity_potential_coeffs + + +Field +----- + +.. automodule:: hymd.field + :members: + + +File input/output +----------------- + +.. automodule:: hymd.file_io + :members: diff --git a/v1.0.6/_sources/doc_pages/benchmarks.rst.txt b/v1.0.6/_sources/doc_pages/benchmarks.rst.txt new file mode 100644 index 00000000..06377a85 --- /dev/null +++ b/v1.0.6/_sources/doc_pages/benchmarks.rst.txt @@ -0,0 +1,93 @@ +.. _benchmarks-label: + +Benchmarks +########## +Homopolymer melt test systems of :math:`30^2`, :math:`40^2`, and :math:`50^2` +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively. + +Bonded forces +^^^^^^^^^^^^^ +Legend label denotes the number of particles in the system. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) + time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 + ], dtype=np.float64) + nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 + ], dtype=np.float64,) + time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, + ], dtype=np.float64) + nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 + ], dtype=np.float64) + time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, + ], dtype=np.float64) + plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" + ) + plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" + ) + plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" + ) + plt.xlabel("CPUs", fontsize=15) + plt.ylabel("Time per step, us", fontsize=15) + plt.legend(fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.show() + + +Particle--field forces +^^^^^^^^^^^^^^^^^^^^^^ +Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + + mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] + mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + + mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + + mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + + mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] + mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + + mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + + mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + + plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") + plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") + plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") + plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") + plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") + plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") + plt.xlabel("CPUs", fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.ylabel("Time per step, s", fontsize=15) + plt.legend(loc="upper left", fontsize=15) + plt.show() diff --git a/v1.0.6/_sources/doc_pages/command_line.rst.txt b/v1.0.6/_sources/doc_pages/command_line.rst.txt new file mode 100644 index 00000000..5233710f --- /dev/null +++ b/v1.0.6/_sources/doc_pages/command_line.rst.txt @@ -0,0 +1,120 @@ +.. _commandline-label: + +Command line arguments +###################### +Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle--field interactions. + + +Required arguments +================== +:configuration file: + :code:`type` positional + + Specifies the :code:`.toml` format configuration file containing simulation details. See :ref:`config-label` for details. + +:structure and topology file: + :code:`type` positional + + Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See :ref:`topology-label` for details. + +Optional arguments +================== +:code:`-v --verbose` + :code:`type` optional + + Number of following arguments: :code:`0` or :code:`1` + + Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying :code:`-v` or :code:`--verbose` with no additional specification. This increases verbosity level by :code:`1`. Alternatively, it maye be specified by :code:`--verbose V` with :code:`V` being :code:`0`, :code:`1`, or :code:`2`. + +:code:`--profile` + :code:`type` optional + + Number of following arguments: :code:`0` + + Enables code profiling using :code:`cProfile`. This will output one profiling file per MPI rank invoked in the simulation. + +:code:`--double-precision` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision internally in HyMD (including in the FFTs). + +:code:`--double-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision in the output trajectory from HyMD. + +:code:`--velocity-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that velocities should be output to the HyMD trajectory. + +:code:`--force-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that forces should be output to the HyMD trajectory. + +:code:`--disable-mpio` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult. + +:code:`--logfile` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the path of a plain text log file in which stdout is mirrored during simulation runs. + +:code:`--seed` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the random seed used in the :code:`numpy` random library to generate velocities, thermostatting, etc. + +:code:`--disable-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any two-particle bonds present in the system. + +:code:`--disable-angle-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any three-particle bonds present in the system. + +:code:`--disable-dihedrals` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any four-particle bonds present in the system. + +:code:`--disable-dipole` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any topological reconstruction of peptide backbone dipoles present in the system. + +:code:`--disable-field` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any particle--field interactions present in the system. diff --git a/v1.0.6/_sources/doc_pages/config_file.rst.txt b/v1.0.6/_sources/doc_pages/config_file.rst.txt new file mode 100644 index 00000000..40ee0479 --- /dev/null +++ b/v1.0.6/_sources/doc_pages/config_file.rst.txt @@ -0,0 +1,194 @@ +.. _config-label: + +Configuration file +################## +The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order. + +The configuration file is a `toml`_ format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs. + +.. _`toml`: + https://github.com/toml-lang/toml + +.. role:: required + +Configuration file keywords +--------------------------- + +The following constitutes every possible keyword specification in HyMD +configuration files: + +Metadata keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying metadata for the H5MD output trajectory. + +:name: + :code:`string` [**optional**, default: :code:`None`] + + Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file. + + +:tags: + :code:`array` [:code:`string`] [**optional**, default: :code:`None`] + + Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file. + + +Particle keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying properties of particles and molecules in the +system. + +:n_particles: + :code:`integer` [**optional**, default: :code:`None`] + + Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules. + +:mass: + :code:`float` [**optional**, default: :code:`72.0`] {units: :math:`\text{u}=\text{g}\,\text{mol}^{-1}`} + + Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal. + +:max_molecule_size: + :code:`integer` [**optional**, default: :code:`201`] + + Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code **will** crash if there are molecules larger than :code:`max_molecule_size` in the topology/structure input file. + + +Simulation keywords +^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying simulation parameters. + +:n_steps: + :code:`integer` [:required:`required`] + + Total number of integration steps to perform for this simulation. + +:n_print: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of *number of time steps*). + +:n_flush: + :code:`integer` [**optional**, default: :code:`None`] + + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of *number of* :code:`n_print`, i.e. :code:`n_print = 13`, :code:`n_flush = 3` would result in the trajectory/energy being written to disk every :code:`13 x 3 = 39` *simulation steps*) + +:time_step: + :code:`float` [:required:`required`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time step per integration step. If the rRESPA multiple time step integrator is used (:code:`integrator = "respa"`), this specifies the **inner** time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is :code:`respa_inner` times the :code:`time_step` , and the total simulation time is :code:`n_steps` times :code:`time_step` times :code:`respa_inner` . + +:box_size: + :code:`array` [:code:`float`] [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable. + +:integrator: + :code:`string` [:required:`required`] (options: :code:`velocity-verlet` or :code:`respa`) + + Specifies the time integrator used in the simulation. If :code:`respa`, the *reversible reference system propagator algorithm (rRESPA)* :cite:`tuckerman1992reversible` integrator is used, with :code:`respa_inner` number of inner (intramolecular force) time steps. If :code:`velocity-verlet`, a normal Velocity Verlet integrator is used. If :code:`respa` and :code:`respa_inner = 1`, the rRESPA integrator is equivalent to the Velocity Verlet. + +:respa_inner: + :code:`integer` [**optional**, default: :code:`1`] + + The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces. + +:domain_decomposition: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Specifies the interval (in time steps) of *domain decomposition exchange*, involving all MPI ranks sending and receiving particles according to the particles' positions in the integration box and the MPI ranks' assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If :code:`True`, the decomposition is performed once (before starting the simulation). If :code:`False`, no decomposition is performed. + +:cancel_com_momentum: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + If :code:`True`, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every :code:`remove_com_momentum` time steps. If :code:`False`, the linear momentum is never removed. + +:start_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at :code:`start_temperature` Kelvin prior to starting the simulation. If :code:`False`, the velocities are not changed before starting the simulation. + +:target_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Couple the system to a heat bath at :code:`target_temperature` Kelvin by applying a *Canonical sampling through velocity rescaling* :cite:`Bussi2007JCP` thermostat with coupling strength :code:`tau`. If :code:`False`, no temperature control is applied. + +:tau: + :code:`float` [**optional**, default: :code:`0.7`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the CSVR thermostat coupling. In the limit of :code:`tau → ∞`, the Hamiltonian dynamics are preserved and no temperature coupling takes place. + +:thermostat_coupling_groups: + :code:`array` [:code:`array` [:code:`string`]] [**optional**, default: :code:`[]`] + + Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and :code:`"C"` type particles, :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would thermalise types :code:`"A"` and :code:`"B"` together and couple :code:`"C"` type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. :code:`target_temperature` Kelvin). +:hamiltonian: + :code:`string` [**optional**, default: :code:`"DefaultNohChi"`] (options: :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`) + + Specifies the interaction energy functional :math:`W[\tilde\phi]` for use with the particle-field interactions. See :ref:`functionals-label` for details. + + +Field keywords +^^^^^^^^^^^^^^ +Configuration keywords specifying field parameters. + +:mesh_size: + :code:`array` [:code:`integer`] or :code:`integer` [:required:`required`] + + Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is :code:`box_size / mesh_size`. + +:kappa: + :code:`float` [:required:`required`] {units: :math:`\text{kJ}^{-1}\text{mol}`} + + Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional :math:`W[\tilde\phi]`. See :ref:`functionals-label` for more details. + +:sigma: + :code:`float` [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See :ref:`filtering-label` for more details. + +:chi: + :code:`array` [:code:`array` [:code:`string`, :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}`} + + Array of :math:`\tilde\chi_\text{AB}`-parameters indicating the strength of the repulsive or attractive interaction between particles of type :code:`"A"` and the number density due to particles of type :code:`"B"`, and vice versa. Example: :code:`chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ]` would specify a repulsive :code:`"A"`--:code:`"B"` type interaction, and a weakly attractive :code:`"C"`--:code:`"D"` interaction. Self-interaction :math:`\tilde\chi`-terms are always zero. See :ref:`functionals-label` for more details. + + +Bond keywords +^^^^^^^^^^^^^ +Configuration keywords specifying bonds and bonds parameters. + +:bonds: + :code:`array` [:code:`array` [2 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{nm}=10^{-9}~\text{m}` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: :code:`bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ]` indicates a :code:`"A"`--:code:`"A"` bond of equilibrium length :code:`0.47` :math:`\text{nm}` with a bond strength of :code:`980.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding bond between :code:`"A"` and :code:`"B"` type particles with equilibrium length :code:`0.31` :math:`\text{nm}` and a strength of :code:`1250.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify stretching bonds. + +:angle_bonds: + :code:`array` [:code:`array` [3 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`{}^\circ` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: :code:`bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ]` indicates a :code:`"A"`--:code:`"A"`--:code:`"A"` angular bond that tries to keep the bond linear at :code:`180` degrees with a bending strength of :code:`55.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding angle bond between :code:`"A"`--:code:`"B"`--:code:`"B"` prefering the angle at :code:`120` degrees and a strength of :code:`25.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify angular bonds. + +:dihedrals: + :code:`array` [:code:`array` [4 :code:`string`, :code:`integer`, :code:`COSINE SERIES` ]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`} + + Specifies four-particle torsional potentials by cosine series. See :ref:`bonds-label` for details about how to specify dihedrals. + + + +Electrostatic keywords +^^^^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying electrostatics and electrostatic parameters. + +:coulombtype: + :code:`string` [**optional**, default: :code:`None`] (options: :code:`PIC_Spectral`) + + Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the :code:`dielectric_const` keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, *not* in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to `PIC_Spectral`. + +:dielectric_const: + :code:`float` [**optional**, default: :code:`None`] + + Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified---even if electrostatics are not included with the :code:`coulombtype` keyword. diff --git a/v1.0.6/_sources/doc_pages/constants_and_units.rst.txt b/v1.0.6/_sources/doc_pages/constants_and_units.rst.txt new file mode 100644 index 00000000..ee429829 --- /dev/null +++ b/v1.0.6/_sources/doc_pages/constants_and_units.rst.txt @@ -0,0 +1,80 @@ +.. _units-label: + +Constants and Units +################### + +HyMD uses the following units and constants internally and in all input and +output: + +.. list-table:: **Units** + :widths: 30 10 75 + :header-rows: 1 + + * - Quantity + - Symbol + - Unit + * - length + - :math:`r` + - :math:`\text{nm}=10^{-9}~\text{m}` + * - time + - :math:`t` + - :math:`\text{ps}=10^{-12}~\text{s}` + * - charge + - :math:`q` + - :math:`e=1.602176634 \cdot 10^{-19}~\text{C}` + * - mass + - :math:`m` + - :math:`\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}` + * - temperature + - :math:`\text{T}` + - :math:`\text{K}` + * - energy + - :math:`E` + - :math:`\text{kJ}\,\text{mol}^{-1}` + * - velocity + - :math:`v` + - :math:`\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}` + * - momentum + - :math:`P` + - :math:`\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}` + * - force + - :math:`\mathbf{F}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}` + * - pressure + - :math:`p` + - :math:`\text{bar}=100~\text{kPa}` + * - electric potential + - :math:`\Psi` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}` + * - electric field + - :math:`\mathbf{E}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}` + * - compressibility + - :math:`\kappa` + - :math:`\text{mol}\,\text{kJ}^{-1}` + * - field-interaction + - :math:`\tilde\chi` + - :math:`\text{kJ}\,\text{mol}^{-1}` + +.. list-table:: **Constants** + :widths: 30 10 75 + :header-rows: 1 + + * - Constant + - Symbol + - Value + * - gas constant + - :math:`R` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Boltzmann’s constant + - :math:`k_\text{B}` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Avogadro's constant + - :math:`N_\text{A}` + - :math:`6.02214076 \cdot 10^23~\text{mol}^{-1}` + * - Vacuum permittivity + - :math:`\varepsilon_0` + - :math:`8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2` + * - Coulomb constant + - :math:`k_\text{e}` + - :math:`138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}` diff --git a/v1.0.6/_sources/doc_pages/electrostatics.rst.txt b/v1.0.6/_sources/doc_pages/electrostatics.rst.txt new file mode 100644 index 00000000..7e11c09d --- /dev/null +++ b/v1.0.6/_sources/doc_pages/electrostatics.rst.txt @@ -0,0 +1,48 @@ +.. _electrostatics-label: + +Electrostatic interactions +########################## +In the filtered Hamiltonian hPF formalism :cite:`bore2020hamiltonian` the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle--mesh Ewald. + +The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered + +.. math:: + + \tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i), + +with :math:`q_i` being the charge of particle :math:`i` and :math:`H` is the +filtering function (see :ref:`filtering-label`). The value of the charge grid at +vertex :math:`(i,j,k)` is found by + +.. math:: + + \tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)] + +and the electrostatic potential :math:`\Psi_{ijk}` + +.. math:: + + \Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right], + +where :math:`k_\text{e}` is the Coulomb constant :math:`1/4\pi\varepsilon_0`. +The *electric field* is obtained by differentiation of the electrostatic +potential in Fourier space, + +.. math:: + + \mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)] + +from which the forces are interpolated back to the particle positions. + +Specifying electrostatics +^^^^^^^^^^^^^^^^^^^^^^^^^ +In HyMD, electrostatics are specified by the :code:`coulombtype` and +:code:`dielectric_const` keywords in the configuration file (see +:ref:`config-label`) and the :code:`/charge` dataset in the HDF5 format +structure/topology input file (see :ref:`topology-label`). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions. diff --git a/v1.0.6/_sources/doc_pages/examples.rst.txt b/v1.0.6/_sources/doc_pages/examples.rst.txt new file mode 100644 index 00000000..9f9c3655 --- /dev/null +++ b/v1.0.6/_sources/doc_pages/examples.rst.txt @@ -0,0 +1,621 @@ +.. _examples-label: + +Examples +######## +The following examples are ordered in *more or less* order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the `HyMD-tutorial`_ github repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Ideal gas +========= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true + :align: right + :width: 200 + +The simplest possible system is one with no interactions at all---intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like: + + +.. code-block:: toml + :caption: **ideal_gas.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = false # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + +A simple input structure/topology file :code:`ideal_gas.HDF5` is available in +the `HyMD-tutorial/ideal_gas`_ github repository (along with the code to +generate it). Run the (very) short simulation by + +.. code:: bash + + python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field \ + --velocity-output \ + --force-output + +with the :code:`--disable-field` argument to completely turn off all +particle--field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook `ideal_gas.ipynb`_ for details. + + +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas +.. _ideal_gas.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.ipynb + + +Ideal chains +============ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true + :align: right + :width: 200 + +The simplest available interaction is the harmonic two-particle bond (see +:ref:`bonds-label`), + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2. + +Extending the configuration file from the ideal gas case, we need to add a +:code:`bonds` specification. Note that the :code:`[bonds]` meta specifier is not +necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **ideal_chain.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + +A simple input structure/topology file :code:`ideal_chain.HDF5` with a few +coiled up ideal chain polymers is available in the +`HyMD-tutorial/ideal_chain`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field + +we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +`ideal_chain.ipynb`_. + + +.. _HyMD-tutorial/ideal_chain: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_chain +.. _ideal_chain.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/ideal_chain.ipynb + + +Stiff rods +========== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true + :align: right + :width: 200 + +Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the :code:`i--j--k` angle :math:`\theta` (see +:ref:`bonds-label`), + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2. + +Extending the configuration file from the ideal chain case, we need to add a +:code:`angle_bonds` specification. Note that the :code:`[bonds]` meta specifier +is not necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **rods.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + + angle_bonds = [ + ["A", "A", "A", 180.0, 100.0], # (i, j, k, equilibrium angle, strength) + ] + + +A simple input structure/topology file :code:`rods.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook `rods.ipynb`_. + + +.. _HyMD-tutorial/rods: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/rods +.. _rods.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.ipynb + + + +Helixes +======= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true + :align: right + :width: 200 + +Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle :math:`\phi` between the +:code:`i--j--k` plane and the :code:`j--k--l` plane (see :ref:`bonds-label`), + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n). + +The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a :code:`dihedrals` keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the :code:`dielectric_const` +keyword even though we are not including electrostatic forces in the current +simulation. Note that the :code:`[bonds]` meta specifier is not necessary, but +may be used to help organise the input file. + +.. code-block:: toml + :caption: **helixes.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + dielectric_const = 15.0 + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.31, 10000.0], # (i name, j name, equilibrium length, strength) + ] + + dihedrals = [ + [ + ["A", "A", "A", "A"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0] + ], + ] + +A simple input structure/topology file :code:`helixes.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook `helixes.ipynb`_. + + +.. _HyMD-tutorial/helixes: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/helixes +.. _helixes.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.ipynb + + +Phase separation +================ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true + :align: right + :width: 200 + +The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types :code:`A` and :code:`B`. Using the Hamiltonian + +.. math:: + + \mathcal{H}=H_0+W + +with :math:`\tilde\chi`--dependent interactions defined by (specified in the +configuration file by :code:`hamiltonian = DefaultWithChi`): + +.. math:: + + W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2. + + +.. code-block:: toml + :caption: **phase_separation.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + + [field] + mesh_size = [20, 20, 20] # FFT grid size + sigma = 1.0 # filtering length scale in nm + kappa = 0.05 # compressibility in mol/kJ + chi = [ + ['A', 'B', 5.0], # (name i, name j, strength) + ] + +A simple input structure/topology file :code:`phase_separation.HDF5` containing +an equal number of :code:`A` type and :code:`B` type particles is available in +the `HyMD-tutorial/phase_separation`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd phase_separation.toml phase_separation.HDF5 + +we may examine the resulting trajectory. In the case of a low interaction +strength :math:`\tilde\chi` of :code:`5.0` (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to :code:`40.0` (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +`phase_separation.ipynb`_. + + +.. _HyMD-tutorial/phase_separation: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/phase_separation +.. _phase_separation.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/phase_separation.ipynb + + +Diblock copolymers +================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true + :align: right + :width: 200 + +Having introduced particle--field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive :math:`\tilde\chi`--interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the :code:`integrator = "respa"` keyword. Putting the pieces together, the +configuration file may look like the following: + +.. code-block:: toml + :caption: **copolymer.toml** + + [simulation] + integrator = "respa" + respa_inner = 15 + n_steps = 2000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [10.0, 10.0, 10.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [50, 50, 50] # FFT grid size + sigma = 0.5 # filtering length scale in nm + chi = [ + ["A", "B", 30.0], # (i, j, strength) + ] + + [bonds] + bonds = [ + ["A", "A", 0.25, 1500.0], # (i, j, equilibrium length, strength) + ["A", "B", 0.25, 1500.0], + ["B", "B", 0.25, 1500.0], + ] + angle_bonds = [ + ["A", "A", "A", 180.0, 25.0], # (i, j, k, equilibrium angle, strength) + ["B", "B", "B", 180.0, 25.0], + ] + +A simple input structure/topology file :code:`copolymer.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/copolymer`_ github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten :code:`A` followed by ten :code:`B` type particles. +Running the simulation with + +.. code:: bash + + python3 -m hymd copolymer.toml copolymer.HDF5 + +the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +`copolymer.ipynb`_. + + +.. _HyMD-tutorial/copolymer: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/copolymer +.. _copolymer.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer.ipynb + + +Lipid bilayer self-assembly +=========================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true + :align: right + :width: 300 + +Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field--particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the :code:`thermostat_coupling_groups` keyword. With parameters +optimised in :cite:`ledum2020automated`, the configuration file looks like: + + +.. code-block:: toml + :caption: **lipid_self_assembly.toml** + + [simulation] + integrator = "respa" + respa_inner = 25 + n_steps = 3000 + n_print = 200 + n_flush = 1 + time_step = 0.01 + box_size = [9.96924, 9.96924, 10.03970] + start_temperature = 323 + target_temperature = 323 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.05 + domain_decomposition = 10001 + cancel_com_momentum = true + max_molecule_size = 15 + thermostat_coupling_groups = [ + ["N", "P", "G", "C"], + ["W"], + ] + + [field] + mesh_size = [25, 25, 25] + sigma = 1.0 + chi = [ + ["C", "W", 42.24], + ["G", "C", 10.47], + ["N", "W", -3.77], + ["G", "W", 4.53], + ["N", "P", -9.34], + ["P", "G", 8.04], + ["N", "G", 1.97], + ["P", "C", 14.72], + ["P", "W", -1.51], + ["N", "C", 13.56], + ] + + [bonds] + bonds = [ + ["N", "P", 0.47, 1250.0], + ["P", "G", 0.47, 1250.0], + ["G", "G", 0.37, 1250.0], + ["G", "C", 0.47, 1250.0], + ["C", "C", 0.47, 1250.0], + ] + angle_bonds = [ + ["P", "G", "G", 120.0, 25.0], + ["P", "G", "C", 180.0, 25.0], + ["G", "C", "C", 180.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +A randomly mixed input structure/topology file +:code:`lipid_self_assembly.HDF5` with a few hundred lipids in a roughy +:code:`10 x 10 x 10nm` box is available in the +`HyMD-tutorial/lipid_self_assembly`_ github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation + +.. code:: bash + + python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5 + +we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook `lipid_self_assembly.ipynb`_. + + +.. _HyMD-tutorial/lipid_self_assembly: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/lipid_self_assembly +.. _lipid_self_assembly.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/lipid_self_assembly.ipynb + + +Peptide in lipid bilayer +======================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true + :align: right + :width: 300 + +Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer. + + +The `configuration file`_ is available in the `HyMD-tutorial/peptide`_ github +repository (omitted here for brevity). + +A pre-equilibrated input structure/topology file :code:`peptide.HDF5` with a +few hundred lipids in a roughy :code:`20 x 20 x 20nm` box is available in the +`HyMD-tutorial/peptide`_ github repository. Running the simulation + +.. code:: bash + + python3 -m hymd peptide.toml peptide.HDF5 + +we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook `peptide.ipynb`_. + + +.. _HyMD-tutorial/peptide: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/peptide +.. _configuration file: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.toml +.. _peptide.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.ipynb + + +SDS +=== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true + :align: right + :width: 300 + +The last part we introduce is explicit electrostatic interactions through +particle--mesh Ewald. Enabling the electrostatic calculations is done via the +:code:`coulombtype` keyword. :code:`"PIC_Spectral"` is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the :code:`dielectric_const` keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge. + + + +.. code-block:: toml + :caption: **sds.toml** + + [simulation] + integrator = "respa" + respa_inner = 10 + n_steps = 3000 + n_print = 1500 + n_flush = + time_step = 0.01 + box_size = [8.3, 8.3, 8.3] + start_temperature = 298 + target_temperature = 298 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.1 + domain_decomposition = 10000 + cancel_com_momentum = true + max_molecule_size = 5 + thermostat_coupling_groups = [ + ["S", "C"], + ["W", "Na"], + ] + dielectric_const = 45.0 # dielectric constant for the simulation medium + coulombtype = "PIC_Spectral" # particle in cloud, spectral method + + [field] + mesh_size = [64, 64, 64] + sigma = 0.5 + chi = [ + ["S", "C", 13.50], + ["S", "Na", 0.00], + ["S", "W", -3.60], + ["C", "Na", 13.50], + ["C", "W", 33.75], + ["W", "Na", 0.00], + ] + + [bonds] + bonds = [ + ["S", "C", 0.50, 1250.0], + ["C", "C", 0.50, 1250.0], + ] + angle_bonds = [ + ["S", "C", "C", 170.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +An input structure/topology file :code:`sds.HDF5` with a couple thousand +randomly dispersed SDS chains is available in the `HyMD-tutorial/sds`_ github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a :code:`/charge` dataset. +Running the simulation with + +.. code:: bash + + python3 -m hymd sds.toml sds.HDF5 + +we observe the aggregation of the SDS into micellular structures---first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook `sds.ipynb`_. + + +.. _HyMD-tutorial/sds: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/sds +.. _sds.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/sds.ipynb diff --git a/v1.0.6/_sources/doc_pages/filtering.rst.txt b/v1.0.6/_sources/doc_pages/filtering.rst.txt new file mode 100644 index 00000000..02af68c6 --- /dev/null +++ b/v1.0.6/_sources/doc_pages/filtering.rst.txt @@ -0,0 +1,30 @@ +.. _filtering-label: + +Filtering +######### +The default grid-independent filter function used in HyMD is a Gaussian + +.. math:: + + H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] + +with reciprocal space representation + +.. math:: + + \hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +The coarse-graining parameter :math:`\sigma` determines a length scale of +particle extent and is given as configuration file input by + +.. code:: toml + + sigma = 0.75 + + +Implementing new filters +^^^^^^^^^^^^^^^^^^^^^^^^ +Implementing new filter functions is straightforward by hijacking +the :code:`setup` method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional. diff --git a/v1.0.6/_sources/doc_pages/installation.rst.txt b/v1.0.6/_sources/doc_pages/installation.rst.txt new file mode 100644 index 00000000..773eb2f4 --- /dev/null +++ b/v1.0.6/_sources/doc_pages/installation.rst.txt @@ -0,0 +1,162 @@ +.. _installation-label: + +Installation +############ +HyMD may be installed using :code:`pip` by + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + + +Dependencies +============ +HyMD **requires** a working MPI compiler and HDF5. On an Ubuntu system, this +may be installed via + +.. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y libhdf5-openmpi-dev python3-mpi4py + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-cache-dir --no-binary=h5py h5py + +It is **highly recommended** to have MPI-enabled HDF5 and h5py. A +non-MPI-enabled h5py may be installed by simply + +.. code-block:: bash + + sudo apt-get update -y + sudo apt-get install libhdf5-serial-dev + python3 -m pip --upgrade install h5py + +A non-MPI-enabled HDF5 library with corresponding :code:`h5py` will work +(mostly), but is inconvenient and slow. Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +:code:`--disable-mpio` argument to HyMD, see :ref:`commandline-label`. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial. + +Install in docker +================= +A docker image with build essentials setup is available at `dockerhub`_ with tag +:code:`mortele/hymd`, + +.. code-block:: bash + + docker pull mortele/hymd:latest + docker run -it mortele/hymd + /app$ python3 -m pip install hymd + + # Grab example input files + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5 + + # Run simulation + /app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose + +.. _dockerhub: + https://hub.docker.com/repository/docker/mortele/hymd + + +Run interactively in Google Colaboratory +======================================== +A `Google Colaboratory`_ jupyter notebook is setup `here`_ with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Common issues +============= + +Numpy errors while importing the Fortran force kernels +------------------------------------------------------ + +.. code-block:: python + + RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd + + Traceback (most recent call last): + + (...) + + File "/..../HyMD/hymd/__init__.py", line 2, in + from .main import main # noqa: F401 + File "/..../HyMD/hymd/main.py", line 10, in + from .configure_runtime import configure_runtime + File "/..../hymd/configure_runtime.py", line 12, in + from .input_parser import read_config_toml, parse_config_toml + File "/..../HyMD/hymd/input_parser.py", line 12, in + from .force import Bond, Angle, Dihedral, Chi + File "/..../HyMD/hymd/force.py", line 8, in + from force_kernels import ( # noqa: F401 + ImportError: numpy.core.multiarray failed to import + +can normally be fixed by updating numpy versions, + +.. code-block:: bash + + python3 -m pip install -U numpy + + +Error building pfft-python due to missing curl/wget +--------------------------------------------------- + +.. code-block:: python + + Building wheel for pfft-python (setup.py) ... error + ERROR: Command errored out with exit status 1: + command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_ + cwd: /tmp/pip-install-fr6nt9m4/pfft-python/ + Complete output (56 lines): + running bdist_wheel + running build + running build_py + + (...) + + curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found + wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found + Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + Please check curl or wget + You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ + Traceback (most recent call last): + File "", line 1, in + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in + setup( + File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup + return distutils.core.setup(**attrs) + File "/usr/lib/python3.8/distutils/core.py", line 148, in setup + + (...) + + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions + build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:])) + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft + raise ValueError("could not build fftw; check MPICC?") + ValueError: could not build fftw; check MPICC? + ---------------------------------------- + ERROR: Failed building wheel for pfft-python + Running setup.py clean for pfft-python + Failed to build pfft-python + +can be fixed by installing either `curl`_ or `wget`_ + +.. code-block:: bash + + apt-get install -y curl wget + + +.. _`curl`: + https://curl.se/ + +.. _`wget`: + https://www.gnu.org/software/wget/ diff --git a/v1.0.6/_sources/doc_pages/interaction_energy_functionals.rst.txt b/v1.0.6/_sources/doc_pages/interaction_energy_functionals.rst.txt new file mode 100644 index 00000000..f33c004e --- /dev/null +++ b/v1.0.6/_sources/doc_pages/interaction_energy_functionals.rst.txt @@ -0,0 +1,98 @@ +.. _functionals-label: + +Interaction energy functionals +############################## +A few interaction energy functionals :math:`W` are defined in HyMD through +the :code:`Hamiltonian` class and associated subclasses. + +:math:`\chi`--interaction and :math:`\kappa`--incompressibility +=============================================================== +The most common hPF energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultWithChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where :math:`\tilde\chi_{\text{A}-\text{B}}` is the interaction energy between +overlapping densities of particle types :math:`\text{A}` and :math:`\text{B}`. +The incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\tilde\chi` +and :math:`\kappa` in the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + chi = [ + ["A", "B", 15.85], + ["B", "C", -5.70], + ... + ] + +Only :math:`\kappa`--incompressibility +====================================== +The only :math:`\kappa` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultNoChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where the incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Only :math:`\phi^2` +=================== +The :math:`\phi^2` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "SquaredPhi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2, + +where the :math:`\phi` squared term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Implementing new interaction energy forms +========================================= +Implementing new interaction energy functions is straightforward by subclassing +:code:`Hamiltonian` and applying :code:`sympy` differentiation to the symbolic +field objects. The :code:`sympy.lamdify` function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields. diff --git a/v1.0.6/_sources/doc_pages/intramolecular_bonds.rst.txt b/v1.0.6/_sources/doc_pages/intramolecular_bonds.rst.txt new file mode 100644 index 00000000..820e81bc --- /dev/null +++ b/v1.0.6/_sources/doc_pages/intramolecular_bonds.rst.txt @@ -0,0 +1,142 @@ +.. _bonds-label: + +Intramolecular bonds +#################### + +Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see :ref:`config-label`. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +:ref:`benchmarks-label`), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable. + +All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]). + + +Two-particle bonds +^^^^^^^^^^^^^^^^^^ +Stretching bonds in HyMD are implemented as harmonic spring potentials, + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2, + +where :math:`r=|\mathbf{r}|` is the inter-particle distance, :math:`k` is a +constant of dimension energy (units :math:`\text{kJ}\,\text{mol}^{-1}`), and +:math:`r_0` is the equilibrum length of the bond (units: :math:`\text{nm}`). The +force is calculated as + +.. math:: + + F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r}, + +where :math:`\mathbf{r}` is the vector pointing *from* :math:`i` *to* :math:`j`. + +In the configuration file, two-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_two_particle_example.toml + + [bonds] + bonds = [ + ["A", "A", 0.47, 1250.0], + ["A", "B", 0.37, 940.0], + ["B", "C", 0.50, 1010.0], + ["C", "A", 0.42, 550.0], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Three-particle bonds +^^^^^^^^^^^^^^^^^^^^ +Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle--particle--particle angle :math:`\theta`, + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2, + +where :math:`k` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}`), and :math:`\theta_0` is the equilibrum +angle of the bond (units: :math:`{}^\circ`). Defining the particles with labels +:math:`a`, :math:`b`, and :math:`c`, let :math:`\mathbf{r}_a` denote the vector +pointing from :math:`b` to :math:`a`, and correspondingly let +:math:`\mathbf{r}_c` point from :math:`b` to :math:`c`. The +:math:`a`--:math:`b`--:math:`c` may be computed through the law of Cosines, + +.. math:: + + \theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right] + +Then the force acting on :math:`a` and :math:`c` is + +.. math:: + + \mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a}, + + \mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c}, + +and + +.. math:: + + \mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c + +In the configuration file, three-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_three_particle_example.toml + + [bonds] + angle_bonds = [ + ["A", "A", "A", 180.0, 90.0], + ["A", "B", "A", 120.0, 55.0], + ["B", "C", "C", 30.0, 10.0], + ["C", "A", "B", 110.0, 25.5], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Four-particle bonds +^^^^^^^^^^^^^^^^^^^ +Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle :math:`\phi` between the +:math:`a`--:math:`b`--:math:`c` and :math:`b`--:math:`c`--:math:`d` planes, for +a dihedral bond quartet :math:`a`, :math:`b`, :math:`c`, and :math:`d`. The +potential takes the form + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n), + +where :math:`c_n` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`), and :math:`\phi_n` are +specified phase angles in the cosine series. + +In the configuration file, four-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_four_particle_example.toml + + [bonds] + dihedrals = [ + ["A", "B", "C", "D"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0], + ] diff --git a/v1.0.6/_sources/doc_pages/overview.rst.txt b/v1.0.6/_sources/doc_pages/overview.rst.txt new file mode 100644 index 00000000..0e4d6b65 --- /dev/null +++ b/v1.0.6/_sources/doc_pages/overview.rst.txt @@ -0,0 +1,166 @@ +.. _overview-label: + +================================ + Usage overview for HylleraasMD +================================ + +HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a `toml`_ format configuration file, along with a topology and structure +file specifying the input system in HDF5 format. + +.. _`toml`: + https://github.com/toml-lang/toml + +**Configuration file** + +The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a :code:`[5, 5, 5]` nm simulation box at 300 K may look like +the following: + +.. code-block:: toml + :caption: **config_simple_1.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "SquaredPhi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [30, 30, 30] # FFT grid size + sigma = 0.5 # filtering length scale in nm + +Note that for the version 1.0 release of HyMD, the :code:`[particles]`, +:code:`[simulation]`, and :code:`[field]` groups are optional specifiers for +structuring the configuration file. + +For a full specification of every recognised configuration keyword in HyMD, +please refer to :ref:`config-label`. + +**Topology and structure file** + +The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +:code:`N` particles may look like the following: + +.. code-block:: bash + :caption: **example_structure.HDF5** + + group / + # root group + + dataset /coordinates + # float32, shape (T, N, D,) + # Time steps of N rows of D dimensional coordinate data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /velocities + # float32, shape (T, N, D,) OPTIONAL + # Time steps of N rows of D dimensional velocity data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /bonds + # int32, shape (N, B,) OPTIONAL + # Each row i contains indices of the particles bonds from/to i + # B denotes the maximum bonds per particle + + dataset /indices + # int32, shape (N,) + # Index of each particle, 0--(N-1) + + dataset /molecules + # int32, shape (N,) + # Index of molecule each particle belongs to + # Used to construct bond network locally on MPI ranks + + dataset /names + # str10, shape (N,) + # Fixed size string array containing particle type names + + dataset /types + # int32, shape (N,) OPTIONAL + # Mapping of particle names to type indices + + +For a full specification of the topology and structure input file, see +:ref:`topology-label`. + +**Command line arguments** + +A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the :code:`config_simple_1.toml` and :code:`example_structure.HDF5` +files may look like the following: + +.. code-block:: bash + + mpirun -n ${MPI_NUM_RANKS} python3 -m hymd \ # HyMD executable + config_simple_1.toml \ # configuration file + example_structure.HDF5 \ # structure file + --logfile=log_out.txt \ # set logfile path + --seed 123456 \ # set random seed + --verbose 2 \ # set logging verbosity + --velocity-output # enable velocity in trajectory output + +For a full specification of all command line arguments, see +:ref:`commandline-label`. + +**More examples** + +For more thorough rundown and concrete usage examples, see +:ref:`examples-label`. + +Running parallel simulations +============================ +Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the **only** difference being how the python3 interpreter is +invoked. Prepending :code:`mpirun -n ${NPROCS}` to the usual +:code:`python3 -m hymd` runs the simulation with :code:`${NPROCS}` MPI ranks. + +Inputting + +.. code:: bash + + mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field + +sets up an example simulation of the `HyMD-tutorial/ideal_gas`_ system. For +more details about this system in particular, or other example simulations, see +the `HyMD-tutorial`_ repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas + + +Running tests +============= +Run serial code tests by + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd + cd hymd/ + python3 -m pip install pytest pytest-mpi + python3 -m pytest + +There is a small convenience script in :code:`hymd/` for running the MPI-enabled +tests, + +.. code-block:: bash + + chmod +x pytest-mpi + ./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no diff --git a/v1.0.6/_sources/doc_pages/theory.rst.txt b/v1.0.6/_sources/doc_pages/theory.rst.txt new file mode 100644 index 00000000..95d7842c --- /dev/null +++ b/v1.0.6/_sources/doc_pages/theory.rst.txt @@ -0,0 +1,114 @@ +.. _theory-label: + +Theory +###### +Hybrid particle--field simulations switch out the ordinary particle--particle +`Lennard-Jones`_ interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle--field densities are +defined as + +.. math:: + + \phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i), + +where :math:`\mathbf{r}` is a spatial coordinate, :math:`P` is a window function +used to distribute particle number densities onto a computational grid, and +:math:`\mathbf{r}_i` is the position of particle :math:`i` (of total :math:`N`). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of :math:`N` particles in :math:`M` molecules is + +.. math:: + + \mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})] + +with :math:`H_0` being a standard intramolecular Hamiltonian form (see +:ref:`bonds-label`) including kinetic terms, while :math:`W` is a density +dependent *interaction energy functional*. + +In the Hamiltonian hPF-MD formalism :cite:`bore2020hamiltonian`, the density +field is filtered using a grid-independent filtering function :math:`H`, + +.. math:: + + \tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}). + +The filter smooths the density, ensuring that :math:`\tilde\phi` and +:math:`W[\tilde\phi([\phi])]` both converge as the grid size is reduced. + +External potential +================== +The external potential acting on a particle is defined as the functional +derivative of :math:`W` with respect to :math:`\phi`. In the filtered formalism, +the potential takes the form + +.. math:: + + V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ + &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})}, + +under the assumption of a *local* form of the interaction energy functional, +:math:`W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]`. Note +that + +.. math:: + + \frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}). + +Force interpolation +=================== +The forces on particle :math:`i` are obtained by differentiation of the external +potential, + +.. math:: + + \mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i). + + +Reciprocal space calculations +============================= +The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density :math:`\phi_{ijk}` with CIC, we apply the filtering +and obtain the discrete version of the external potential by + +.. math:: + + \tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big] + +and + +.. math:: + + V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +The forces are obtained by differentiation of :math:`V` in Fourier space as + +.. math:: + + \nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +Filter +====== +By default, the filter used in HyMD is a simple Gaussian of the form + +.. math:: + + H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ + \hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +For more details about the filtering, see :ref:`filtering-label`. + +Hamiltonian form +================ +The default form of the interaction energy functional in HyMD is + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2. + +See :ref:`functionals-label` for details. + + +.. _`Lennard-Jones`: + https://en.wikipedia.org/wiki/Lennard-Jones_potential diff --git a/v1.0.6/_sources/doc_pages/topology_input.rst.txt b/v1.0.6/_sources/doc_pages/topology_input.rst.txt new file mode 100644 index 00000000..adabe129 --- /dev/null +++ b/v1.0.6/_sources/doc_pages/topology_input.rst.txt @@ -0,0 +1,77 @@ +.. _topology-label: + +============================ +Topology and structure file +============================ +The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root :code:`/` group. + +The `HyMD-tutorial`_ has multiple examples of structure files for various levels +of complexity. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Required datasets +================= +:/coordinates: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/indices: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/names: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`string` (:code:`length` between :code:`1` and :code:`16`)] + + The shape represents one particle name per :code:`N` particles. The datatype may be a string of length :code:`=<16`. + + + +Optional datasets +================= +:/velocities: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/types: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle type index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/molecules: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one molecule index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/bonds: + :code:`array` shape [:code:`N`, :code:`B`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents :code:`B` bond specifications (indices of different particles) per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/charge: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents one particle charge per :code:`N` particles. The data type may be either four or eight byte reals. diff --git a/v1.0.6/_sources/index.rst.txt b/v1.0.6/_sources/index.rst.txt new file mode 100644 index 00000000..ff4059ba --- /dev/null +++ b/v1.0.6/_sources/index.rst.txt @@ -0,0 +1,168 @@ +.. hymd documentation master file, created by + sphinx-quickstart on Thu Dec 16 13:31:43 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +############################### +HylleraasMD documentation +############################### + +:Release: + |release| +:Date: + |today| + +**HylleraasMD** (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems. + +HyMD can run canonical hPF-MD simulations :cite:`Milano2009JCP`, or filtered +density Hamiltonian hPF (HhPF-MD) simulations :cite:`bore2020hamiltonian`, with +or without explicit PME electrostatic interactions :cite:`kolli2018JCTC`. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +:cite:`Cascella2008,bore2018hybrid`. Martini +style elastic networks (ElNeDyn) :cite:`periole2009combining` are also +supported. + +HyMD uses the pmesh (`github.com/rainwoodman/pmesh`_) library for particle-mesh +operations, with the PPFT :cite:`pippig2013pfft` backend for FFTs through the +pfft-python bindings (`github.com/rainwoodman/pfft-python`_). File IO is done +via HDF5 formats to allow MPI parallel reads. + +User Guide +========== +The HylleraasMD :doc:`User Guide ` provides comprehensive information on how to run +simulations. Selected :doc:`Examples ` are available to guide new users. + +.. _`github.com/rainwoodman/pmesh`: + https://github.com/rainwoodman/pmesh +.. _`github.com/rainwoodman/pfft-python`: + https://github.com/rainwoodman/pfft-python + +Installing HyMD +=============== +The easiest approach is to install using pip_: + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + +For more information and **required dependencies**, see +:ref:`installation-label`. + +.. _pip: + http://www.pip-installer.org/en/latest/index.html + + +Run in Google colab +------------------- +Run HyMD interactively in `Google Colaboratory`_ jupyter notebook `here`_. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Source Code +=========== +**Source code** is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the `GNU Lesser General Public +License v3.0`_. Obtain the source code with `git`_: + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git + +.. _GNU Lesser General Public License v3.0: + https://www.gnu.org/licenses/lgpl-3.0.html +.. _git: + https://git-scm.com/ + + +Development +=========== +HyMD is developed and maintained by researchers at the `Hylleraas Centre for +Quantum Molecular Sciences`_ at the `University of Oslo`_. + +|pic1| |pic2| + +.. _`Hylleraas Centre for Quantum Molecular Sciences`: + https://www.mn.uio.no/hylleraas/english/ +.. _`University of Oslo`: + https://www.uio.no/ + +.. |pic1| image:: img/hylleraas_centre_logo_black.png + :target: img/hylleraas_centre_logo_black.png + :width: 250 px + +.. |pic2| image:: img/uio_full_logo_eng_pos.png + :target: img/uio_full_logo_eng_pos.png + :width: 325 px + + + +References +========== +.. bibliography:: + :all: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. Contents +.. ======== + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Getting started + + ./doc_pages/installation + ./doc_pages/overview + ./doc_pages/config_file + ./doc_pages/topology_input + ./doc_pages/command_line + ./doc_pages/constants_and_units + + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Examples + + ./doc_pages/examples + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Theory + + ./doc_pages/theory + ./doc_pages/intramolecular_bonds + ./doc_pages/electrostatics + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Developer documentation + + ./doc_pages/interaction_energy_functionals + ./doc_pages/filtering + ./doc_pages/benchmarks + ./doc_pages/api diff --git a/v1.0.6/_static/basic.css b/v1.0.6/_static/basic.css new file mode 100644 index 00000000..be19270e --- /dev/null +++ b/v1.0.6/_static/basic.css @@ -0,0 +1,856 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/v1.0.6/_static/css/badge_only.css b/v1.0.6/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/v1.0.6/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/v1.0.6/_static/css/fonts/Roboto-Slab-Bold.woff b/v1.0.6/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/v1.0.6/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/v1.0.6/_static/css/fonts/Roboto-Slab-Bold.woff2 b/v1.0.6/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/v1.0.6/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/v1.0.6/_static/css/fonts/Roboto-Slab-Regular.woff b/v1.0.6/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/v1.0.6/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/v1.0.6/_static/css/fonts/Roboto-Slab-Regular.woff2 b/v1.0.6/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/v1.0.6/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/v1.0.6/_static/css/fonts/fontawesome-webfont.eot b/v1.0.6/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/v1.0.6/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/v1.0.6/_static/css/fonts/fontawesome-webfont.svg b/v1.0.6/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/v1.0.6/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v1.0.6/_static/css/fonts/fontawesome-webfont.ttf b/v1.0.6/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/v1.0.6/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/v1.0.6/_static/css/fonts/fontawesome-webfont.woff b/v1.0.6/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/v1.0.6/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/v1.0.6/_static/css/fonts/fontawesome-webfont.woff2 b/v1.0.6/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/v1.0.6/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/v1.0.6/_static/css/fonts/lato-bold-italic.woff b/v1.0.6/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/v1.0.6/_static/css/fonts/lato-bold-italic.woff differ diff --git a/v1.0.6/_static/css/fonts/lato-bold-italic.woff2 b/v1.0.6/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/v1.0.6/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/v1.0.6/_static/css/fonts/lato-bold.woff b/v1.0.6/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/v1.0.6/_static/css/fonts/lato-bold.woff differ diff --git a/v1.0.6/_static/css/fonts/lato-bold.woff2 b/v1.0.6/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/v1.0.6/_static/css/fonts/lato-bold.woff2 differ diff --git a/v1.0.6/_static/css/fonts/lato-normal-italic.woff b/v1.0.6/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/v1.0.6/_static/css/fonts/lato-normal-italic.woff differ diff --git a/v1.0.6/_static/css/fonts/lato-normal-italic.woff2 b/v1.0.6/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/v1.0.6/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/v1.0.6/_static/css/fonts/lato-normal.woff b/v1.0.6/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/v1.0.6/_static/css/fonts/lato-normal.woff differ diff --git a/v1.0.6/_static/css/fonts/lato-normal.woff2 b/v1.0.6/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/v1.0.6/_static/css/fonts/lato-normal.woff2 differ diff --git a/v1.0.6/_static/css/theme.css b/v1.0.6/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/v1.0.6/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/v1.0.6/_static/custom.css b/v1.0.6/_static/custom.css new file mode 100644 index 00000000..b20d6282 --- /dev/null +++ b/v1.0.6/_static/custom.css @@ -0,0 +1,91 @@ + +body{ + background: #FFFFFF !important; +} + +.wy-menu-vertical header, .wy-menu-vertical p.caption{ + color: #4EA0AF!important; +} +.wy-menu-vertical li.current{ + background-color: #f4f4f4!important; +} +.wy-menu-vertical li.toctree-l2.current>a{ + background-color: #ebebeb!important; +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{ + background-color: #e3e3e3!important; +} + +.rst-content .sidebar{ + background-color: #fff!important; + border-radius: 6px; + -moz-border-radius: 6px; + -webkit-border-radius: 6px; +} + +h1 > a, h2 > a, h3 > a, h4 > a, h5 > a, h6 > a { + color: #17d9ff; +} + +h1, h2, h3, h4, h5, h6 { + color: black; + font-weight: normal; + padding: 0; +} + +h1, h2, h3 { + margin-top: 30px; + margin-bottom: 20px; +} + +h1 { + color: white; + padding: 20px 20px 20px 45px; + margin: 20px 0 35px -45px; + background: linear-gradient(to left, #fff, #2b38ff)!important; + + width: calc(100% + 90px); + border-bottom: 3px solid #000; +} + +h2 { + padding: .2em 0; + border-bottom: 1px solid #ddd; +} + +h3 { + margin-top: 35px; +} + +h4 { + margin-top: 30px; +} + +h5 { + margin-top: 25px; +} + +.wy-nav-content{ + max-width: none!important; +} + +.wy-side-nav-search{ + background: #2b38ff!important; +} + +.wy-side-nav-search input[type=text]{ + border-color:#4DA0B0!important; +} + +.wy-side-nav-search input[type=text]{ + border-radius: 4px!important; +} + +#caption-api { + background: red !important; +} + +#caption-text-api { + text-color: blue !important; +} diff --git a/v1.0.6/_static/doctools.js b/v1.0.6/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/v1.0.6/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/v1.0.6/_static/documentation_options.js b/v1.0.6/_static/documentation_options.js new file mode 100644 index 00000000..42185a7b --- /dev/null +++ b/v1.0.6/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '1.0.6', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/v1.0.6/_static/file.png b/v1.0.6/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/v1.0.6/_static/file.png differ diff --git a/v1.0.6/_static/hymd_icon_white.png b/v1.0.6/_static/hymd_icon_white.png new file mode 100644 index 00000000..d0396a17 Binary files /dev/null and b/v1.0.6/_static/hymd_icon_white.png differ diff --git a/v1.0.6/_static/hymd_logl_white_text_abbr.png b/v1.0.6/_static/hymd_logl_white_text_abbr.png new file mode 100644 index 00000000..8c0e50c8 Binary files /dev/null and b/v1.0.6/_static/hymd_logl_white_text_abbr.png differ diff --git a/v1.0.6/_static/jquery-3.5.1.js b/v1.0.6/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/v1.0.6/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. API reference

+
+

4.1. Integrator

+

Integrates equations of motion.

+

Implements the Velocity Verlet integrator. The reversible reference system +propagator algorithm (rRESPA) integrator uses the Velocity Verlet functions +inside the MD loop in the main module.

+
+
+hymd.integrator.integrate_position(positions, velocities, time_step)[source]
+

Position update step of the Velocity Verlet integration algorithm.

+

Computes the position update step of the Velocity Verlet algorithm. The +positions argument is not changed in place.

+
+
Parameters:
+
+
positions(N, D) numpy.ndarray

Array of positions of N particles in D dimensions.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_velocity

The velocity update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step, then the positions are updated a full step using the updated +velocities

+
+\[\mathbf{x}_{\text{new}} = \mathbf{x} + \Delta t \mathbf{v}\]
+
+ +
+
+hymd.integrator.integrate_velocity(velocities, accelerations, time_step)[source]
+

Velocity update step of the Velocity Verlet integration algorithm.

+

Computes the velocity update step of the Velocity Verlet algorithm. The +velocities argument is not changed in place.

+
+
Parameters:
+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
accelerations(N, D) numpy.ndarray

Array of accelerations of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_position

The position update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step

+
+\[\mathbf{v}_{\text{new}} = \mathbf{v} + \frac{\Delta t}{2m} +\mathbf{f}\]
+

before the positions are moved a full step using the updated half-step +velocities.

+
+ +
+
+

4.2. Thermostat

+

Scales or otherwise modifies the particle velocities during simulation to +simulate coupling to an external heat bath with temperature T₀.

+
+
+hymd.thermostat._random_chi_squared(prng: numpy.random._generator.Generator, M: int)float[source]
+

Draw the sum of M squared normally distributed values

+

The value is generated by the Gamma distribution, in lieu of generating +M Gaussian distributed numbers and summing their squares.

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
Mint

Number of standard normally distributed numbers in the sum.

+
+
+
+
Returns:
+
+
float

The sum of M squared normally distributed values centered at +zero with unit standard deviation.

+
+
+
+
+

Notes

+

The sum of the squares of k independent standard normal random variables is +distributed according to a \(\chi^2\) distribution.

+
+\[\chi^2_1 + \chi_2^2 + \chi_3^2 + \dots + \chi_M^2 +\sim +\sigma^2\chi^2(k)\]
+

This is a special case of the \(\Gamma\) distribution, +\(\Gamma(k/2, 2)\), and may be generated by

+
+\[\chi^2(k) \sim 2 \Gamma(k/2, 2)\]
+

References

+

Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of +Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. +J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246.

+
+ +
+
+hymd.thermostat._random_gaussian(prng: numpy.random._generator.Generator)float[source]
+

Draw a single random number from the standard normal distribution +Generate a number from the Gaussian distribution centered at zero with unit +standard deviation, \(N(0, 1)\).

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
+
+
Returns:
+
+
float

A random number drawn from \(N(0, 1)\).

+
+
+
+
+
+ +
+
+hymd.thermostat.csvr_thermostat(velocity: numpy.ndarray, names: numpy.ndarray, config: hymd.input_parser.Config, prng: numpy.random._generator.Generator, comm: mpi4py.MPI.Intracomm = <mpi4py.MPI.Intracomm object>, random_gaussian: Callable[[numpy.random._generator.Generator], float] = <function _random_gaussian>, random_chi_squared: Callable[[numpy.random._generator.Generator, int, float], float] = <function _random_chi_squared>, remove_center_of_mass_momentum: bool = True)numpy.ndarray[source]
+

Canonical sampling through velocity rescaling thermostat

+

Implements the CSVR thermostat. Rescales the system kinetic energy by a +stochastically chosen factor to keep the temperature constant. Requires +communcation of the kinetic energies calculated locally for each MPI rank. +The random numbers sampled through random_gaussian and +random_chi_squared are broadcast from the root rank to the other +ranks to ensure the scaling is performed with the same stochasticity for +all particles in the full system.

+

The velocities are cleaned of center of mass momentum before the thermostat +is applied, and the center of mass momentum is subsequently reapplied. This +is performed for each thermostat coupling group, i.e. the center of mass +momenta of each group is separately removed and reapplied after +thermostatting.

+

The implementation here is based on the derivation presented in the 2008 +Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper.

+
+
Parameters:
+
+
velocity(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
names(N,) numpy.ndarray

Array of particle names.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
random_gaussiancallable, optional

Function for generating standard normally distributed numbers.

+
+
random_chi_squaredcallable, optional

Function for generating \(\chi^2\)-distributed numbers

+
+
remove_center_of_mass_momentumbool, optional

If True, the center of mass of each coupling group is removed before +the thermostat is applied. The center of mass momenta are added back +after the kinetic energy rescaling is complete.

+
+
+
+
+
+

See also

+
+
_random_gaussian

Used to sample Gaussian-distributed numbers.

+
+
_random_chi_squared

Used to sample \(\chi^2\)-distributed numbers.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +

References

+

G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). +G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008).

+
+ +
+
+

4.3. Hamiltonian

+
+
+class hymd.hamiltonian.Hamiltonian(config)[source]
+

Interaction energy functional superclass

+
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+_setup()[source]
+

Superclass setup

+

Sets up the grid-independent filtering function H, and the +SymPy logic for symbolically differentiating interaction energy +functionals in Hamiltonian subclasses.

+
+ +
+ +
+
+class hymd.hamiltonian.SquaredPhi(config)[source]
+

Simple squared density interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + \sum_k \tilde\phi_k + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(rho_0\) is the +average density of the fully homogenous system. Expressing the species +densities in terms of fluctuations from the average,

+
+\[\mathrm{d}\tilde\phi_k = \rho_0 - \tilde\phi_k,\]
+

it is evident that this interaction energy functional is a slight change of +the DefaultNoChi Hamiltonian, as the expanded interaction energy +density becomes

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + 6\rho_0\left[ + \sum_k \mathrm{d}\tilde\phi_k + \right] + + + 9\rho_0^2 + + + \sum_k \mathrm{d}\tilde\phi_k^2 + + + \prod_{k\not=l} + \mathrm{d}\tilde\phi_k \mathrm{d}\tilde\phi_l + \right),\]
+

identical to DefaultNoChi apart from a constant energy shift +\(9\rho_0^2`(which does not impact dynamics) and the +:math:\)rho_0`–\(\mathrm{d}\tilde\phi_k\) cross-terms. These +cross-terms constitute contributions to the energy linear in +\(\mathrm{d}\tilde\phi_k\) absent in DefaultNoChi, which has +only quadratic terms present.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultNoChi(config)[source]
+

Incompressibility-only interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a +\right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. The SquaredPhi Hamiltonian implements a similar +functional with an additional linear term component depending on

+
+\[\mathmr{d}\tilde\phi_k = \tilde\phi_k - \rho_0\]
+

and not \(\mathrm{d}\tilde\phi_k^2\). No explicit inter-species +interaction is present apart from the indirect interaction through the +incompressibility.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultWithChi(config, unique_names, type_to_name_map)[source]
+

Incompressibility and \(\chi\)-interactions energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = + \frac{1}{2\rho_0} + \sum_{k,l}\chi_{kl} \tilde\phi_k \tilde\phi_l + + + \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. \(\chi_{ij}\) is the Flory-Huggins-like +inter-species mixing energy.

+
+
+__init__(config, unique_names, type_to_name_map)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup(unique_names, type_to_name_map)[source]
+

Setup the interaction energy potential and the external potential

+
+
Parameters:
+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+ +
+ +
+
+

4.4. Force

+

Calculates intramolecular forces between bonded particles in molecules

+
+
+class hymd.force.Angle(atom_1: str, atom_2: str, equilibrium: float, strength: float, atom_3: str)[source]
+

Dataclass representing a single three-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any three-particle bond between particles of specific types A, +B, and C (where A, B, and C may be +different or the same). Harmonic angular three-particle bonds in HyMD take +the form

+
+\[V_3(\mathbf{r}_1, \mathbf{r}_2, \mathbf{r}_3) = + \frac{1}{2}k + \left( + \cos^{-1} + \left[ + \frac{ + (\mathbf{r}_1-\mathbf{r}_2) + \cdot + (\mathbf{r}_3-\mathbf{r}_2) + } + { + \vert\mathbf{r}_1-\mathbf{r}_2\vert + \vert\mathbf{r}_3-\mathbf{r}_2\vert + } + \right] - \theta_0 + \right)^2\]
+
+

See also

+
+
Bond

Two-particle bond type dataclass

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
equilibriumfloat

Equilibrium angle at which the energy associated with the +three-particle angular bond vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient.

+
+
+
+
+
+
+atom_3: str
+
+ +
+ +
+
+class hymd.force.Bond(atom_1: str, atom_2: str, equilibrium: float, strength: float)[source]
+

Dataclass representing a single two-particle bond type

+

A bond type is a bond strength and equilibrium distance associated with +any bond between particles of specific types A and B +(where A and B may be the same or different). Harmonic +two-particle bonds in HyMD take the form

+
+\[V_2(\mathbf{r}_1, \mathbf{r}_2) = + \frac{1}{2}k + \left( + \vert \mathbf{r}_1 - \mathbf{r}_2 \vert - r_0 + \right)^2,\]
+

where \(k\) is the bond strength (spring constant) and \(r_0\) is +the equilibrium bond length (at which the energy is zero).

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
equilibriumfloat

Equilibrium distance at which the energy associated with the bond +vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient (spring constant).

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+equilibrium: float
+
+ +
+
+strength: float
+
+ +
+ +
+
+class hymd.force.Chi(atom_1: str, atom_2: str, interaction_energy: float)[source]
+

Dataclass representing a single \(\chi\) mixing interaction type

+

An interaction mixing energy type is a mixing energy associated with +density overlap between species of types A and B +(specified as inputs atom_1 and atom_2). A positive mixing +energy promotes phase separation, a negative mixing energy promotes mixing. +The interaction energy density (provided the DefaultWithChi +Hamiltonian is used) takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} + \sum_{k,l}\chi_{k,l} \tilde\phi_k\tilde\phi_l,\]
+

where \(\chi_{k,l}\) denotes the mixing energy between species +\(k\) and \(l\), with \(\kappa\) being the incompressibility. +The value of the interaction mixing energy parameter may be extracted from +Flory-Huggins theory.

+
+

See also

+
+
hymd.hamiltonian.DefaultWithChi

Interaction energy functional using \(\chi\)-interactions.

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
interaction_energyfloat

Interaction mixing energy.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+interaction_energy: float
+
+ +
+ +
+
+class hymd.force.Dielectric_type(atom_1: str, dielectric_value: float)[source]
+
+
+atom_1: str
+
+ +
+
+dielectric_value: float
+
+ +
+ +
+
+class hymd.force.Dihedral(atom_1: str, atom_2: str, atom_3: str, atom_4: str, coeffs: numpy.ndarray, dih_type: int)[source]
+

Dataclass representing a single four-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any four-particle torsional bond between particles of specific types +A, B, C, and D (where A, B, +C, and D may be different or the same). Dihedral +four-particle bonds in HyMD take different forms depending on the +dih_type parameter.

+

In the following, let \(\phi\) denote the angle between the planes +spanned by the relative positions of atoms A-B-C +and B-C-D. If dih_type = 0, then

+
+\[V_4(\phi) = \sum_n c_n + \left( + 1 + \cos\left[ + n\phi - d_n + \right] + \right),\]
+

where \(c_n\) are energy coefficients and \(d_n\) are propensity +phases. By default, the cosine sum is truncated at five terms. If +coeffs provides only a single float, this is used as the coiling +propensity parameter \(\lambda\). In this case, \(c_n\) and +\(d_n\) are automatically set to values which promote alpha helical +(\(\lambda=-1\)), beta sheet (\(\lambda=1\)), or a mixed +(\(1>\lambda>-1\)) structure (using values provided by Bore et al. +(2018)). In this case, the full potential takes the form

+
+\[V_4(\phi;\lambda) = + \frac{1}{2}(1-\lambda) V_{\text{prop},\alpha}(\phi) + + + \frac{1}{2}(1+\lambda) V_{\text{prop},\beta}(\phi) + + + (1-\vert\lambda\vert) V_{\text{prop}, \text{coil}}(\phi),\]
+

with each of the \(V_{\mathrm{prop}, X}\) being fixed cosine series +potentials with pre-set \(c_n\) -s and \(d_n\) -s.

+

If dih_type = 1, then a combined bending torsional (CBT) potential +is employed,

+
+\[V_4(\phi,\gamma;\lambda) = + V_4(\phi;\lambda) + + + \frac{1}{2}K(\phi)(\gamma - \gamma_0)^2,\]
+

where \(V_4(\phi;\lambda)\) specifies the potential as given by the +coiling propensity parameter above, \(K(\phi)\) is a separate cosine +series potential acting as the angular three-particle bond strength, and +\(\gamma_0\) is the three-particle bond equilibrium angle. In this +case, the coeffs parameter must specify both a \(\lambda\) +value, in additon to the energy and phases dictating the \(K(\phi)\) +potential.

+

References

+

Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018.

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
atom_4str

Type name of particle 4.

+
+
coeffslist[list[float]] or list[float] or numpy.ndarray

Dihedral coefficients defining the series expansion of the dihedral +energy.

+
+
dih_typeint

Specifies the type of dihedral used; If 0, then coeffs +must contain either two lists of five energy coefficients +\(c_n\) and five propensity phases \(d_n\) or a single +floating point number defining the \(\lambda\) coiling propensity +parameter. If 1, the combined bending-torsional potential is +used, and coeffs must specify \(\lambda\) and two lists +containing energy coefficients and propensity phases for the +\(V_\text{prop}\) propensity potential, defined in terms of cosine +series.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+atom_3: str
+
+ +
+
+atom_4: str
+
+ +
+
+coeffs: numpy.ndarray
+
+ +
+
+dih_type: int
+
+ +
+ +
+
+hymd.force.compute_angle_forces__plain(f_angles, r, bonds_3, box_size)[source]
+

Computes forces resulting from angular interactions

+
+

Deprecated since version 1.0.0: compute_angle_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_bond_forces__plain(f_bonds, r, bonds_2, box_size)[source]
+

Computes forces resulting from bonded interactions

+
+

Deprecated since version 1.0.0: compute_bond_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size)[source]
+

Computes forces resulting from dihedral interactions

+
+

Deprecated since version 1.0.0: compute_dihedral_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.dipole_forces_redistribution(f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb)[source]
+

Redistribute electrostatic forces calculated from topologically +reconstructed ghost dipole point charges to the backcone atoms of the protein.

+
+ +
+
+hymd.force.find_all_paths(G, u, n)[source]
+

Helper function that recursively finds all paths of given lenght ‘n + 1’ inside a network ‘G’. +Adapted from https://stackoverflow.com/a/28103735.

+
+ +
+
+hymd.force.prepare_bonds(molecules, names, bonds, indices, config, topol=None)[source]
+

Rearrange the bond information for usage in compiled Fortran kernels

+

Restructures the lists resulting from the execution of +prepare_bonds_old into numpy arrays suitable for calls to optimized +Fortran code calculating bonded forces and energiesself.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2_atom_1(B,) numpy.ndarray

Local index of particle 1 for each of B constructed +two-particle bonds.

+
+
bonds_2_atom_2(B,) numpy.ndarray

Local index of particle 2 for each of B constructed +two-particle bonds.

+
+
bonds_2_equilibrium(B,) numpy.ndarray

Equilibrium distance for each of B constructed two-particle +bonds.

+
+
bonds_2_strength(B,) numpy.ndarray

Bond strength for each of B constructed two-particle +bonds.

+
+
bonds_3_atom_1(A,) numpy.ndarray

Local index of particle 1 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_2(A,) numpy.ndarray

Local index of particle 2 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_3(A,) numpy.ndarray

Local index of particle 3 for each of A constructed +three-particle bonds.

+
+
bonds_3_equilibrium(A,) numpy.ndarray

Equilibrium angle for each of A constructed three-particle +bonds.

+
+
bonds_3_strength(A,) numpy.ndarray

Bond strength for each of A constructed three-particle +bonds.

+
+
bonds_4_atom_1(D,) numpy.ndarray

Local index of particle 1 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_2(D,) numpy.ndarray

Local index of particle 2 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_3(D,) numpy.ndarray

Local index of particle 3 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_4(D,) numpy.ndarray

Local index of particle 4 for each of D constructed +four-particle bonds.

+
+
bonds_4_coeff(D,) numpy.ndarray

Cosine series coefficients for each of D constructed +four-particle bonds.

+
+
bonds_4_type(D,) numpy.ndarray

Dihedral type for each of D constructed four-particle +bonds.

+
+
bonds_4_last(D,) numpy.ndarray

Flags indicating if dih_type is 1 for each of D +constructed four-particle bonds.

+
+
+
+
+
+

See also

+
+
prepare_bonds_old

Used internally to reconstruct the bonded interactions types from the connectivity information in the structure/topology input file and the bonded types specified in the configuration file.

+
+
+ +
+ +
+
+hymd.force.prepare_bonds_old(molecules, names, bonds, indices, config)[source]
+

Find bonded interactions from connectivity and bond types information

+
+

Deprecated since version 1.0.0: prepare_bonds_old was replaced by prepare_bonds for +use with compiled Fortran kernels prior to 1.0.0 release.

+
+

Prepares the necessary equilibrium and bond strength information needed by +the intramolecular interaction functions. This is performed locally on each +MPI rank, as the domain decomposition ensures that for all molecules all +consituent particles are always contained on the same MPI rankself.

+

This function traverses the bond connectivity information provided in the +structure/topology input file and indentifies any two-, three-, or +four-particle potential bonds. For each connected chain of two, three, or +four particles, a matching to bond types is attempted. If the corresponding +names match, a bond object is initialized.

+

In order to investigate the connectivity, a graph is created using +networkx functionality.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2list

List of lists containing local particle indices, equilibrium +distance, and bond strength coefficient for each reconstructed +two-particle bond.

+
+
bonds_3

List of lists containing local particle indices, equilibrium angle, +and bond strength coefficient for each reconstructed three-particle +bond.

+
+
bonds_4

List of lists containing local particle indices, dihedral type index, +and dihedral coefficients for each reconstructed four-particle +torsional bond.

+
+
bb_indexlist

List indicating the dihedral type of each four-particle bond in +bonds_4.

+
+
+
+
+
+

See also

+
+
Bond

Two-particle bond type dataclass.

+
+
Angle

Three-particle angular bond type dataclass.

+
+
Dihedral

Four-particle torsional bond type dataclass.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+hymd.force.prepare_index_based_bonds(molecules, topol)[source]
+
+ +
+
+hymd.force.propensity_potential_coeffs(x: float)[source]
+
+ +
+
+

4.5. Logger

+
+
+class hymd.logger.Logger[source]
+

Log output handler class

+

Notes

+

This wraps the default python library logging, see +docs.python.org/3/library/logging.html.

+
+
Attributes:
+
+
levelint

Determines the verbosity level of the log, corresponding to +logging.level. Numerical values 50 (logging.CRITICAL), +40 (logging.ERROR), 30 +(logging.WARNING), 20 (logging.INFO), +10 (logging.DEBUG), and 0 +(logging.UNSET) are supported values. Any log event message +less severe than the specified level is ignored. All other event +messages are emitted.

+
+
log_filestr

Path to output log file.

+
+
formatstr

Prepended dump string for each log event. Specifies the log event +level, the module emitting the event, the code line, the enclosing +function name, and the MPI rank writing the message.

+
+
date_formatstr

Prepends the date before all log event messages.

+
+
formatterlogging.Formatter

Formatter handling the prepending of the information in format and +date_format to each log event message. Used by default for all +loggers.

+
+
rank0logging.Logger

Default logger object for the root MPI rank.

+
+
all_rankslogging.Logger

Default logger object for messages being emitted from all MPI ranks +simultaneously.

+
+
+
+
+
+
+classmethod setup(default_level=20, log_file=None, verbose=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Sets up the logger object.

+

If a log_file path is provided, log event messages are output +to it. Otherwise, the logging messages are emitted to stdout.

+
+
Parameters:
+
+
default_levelint, optional

Default verbosity level of the logger. Unless specified, it is +10 (logging.INFO).

+
+
log_filestr, optional

Path to output log file. If None or not priovided, no log file is +used and all logging is done to stdout.

+
+
verbosebool, optional

Increases the logging level to 30 (logging.WARNING) +if True, otherwise leaves the logging level unchanged.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterRoot(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the root MPI rank log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterAll(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the all-MPI-ranks log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+

4.6. Input parser

+

Parses and handles the configuration information provided for the simulation

+
+
+class hymd.input_parser.Config(n_steps: int, time_step: float, mesh_size: Union[List[int], numpy.ndarray, int], sigma: float, kappa: float, dtype: Optional[numpy.dtype] = None, box_size: Optional[Union[List[float], numpy.ndarray]] = None, n_print: Optional[int] = None, tau: Optional[float] = None, start_temperature: Optional[Union[float, bool]] = None, target_temperature: Optional[Union[float, bool]] = None, mass: Optional[float] = None, hamiltonian: Optional[str] = None, domain_decomposition: Optional[Union[int, bool]] = None, integrator: Optional[str] = None, respa_inner: int = 1, file_name: str = '<config file path unknown>', name: Optional[str] = None, tags: List[str] = <factory>, bonds: List[hymd.force.Bond] = <factory>, angle_bonds: List[hymd.force.Angle] = <factory>, dihedrals: List[hymd.force.Dihedral] = <factory>, chi: List[hymd.force.Chi] = <factory>, n_particles: Optional[int] = None, max_molecule_size: Optional[int] = None, n_flush: Optional[int] = None, thermostat_work: float = 0.0, thermostat_coupling_groups: List[List[str]] = <factory>, initial_energy: Optional[float] = None, cancel_com_momentum: Union[int, bool] = False, coulombtype: Optional[str] = None, convergence_type: Optional[str] = None, pol_mixing: Optional[float] = None, dielectric_const: Optional[float] = None, conv_crit: Optional[float] = None, dielectric_type: List[hymd.force.Dielectric_type] = <factory>, self_energy: Optional[float] = None, type_charges: Optional[Union[List[float], numpy.ndarray]] = None, rho0: Optional[float] = None, a: Optional[float] = None, pressure: bool = False, barostat: Optional[str] = None, barostat_type: Optional[str] = None, tau_p: Optional[float] = None, target_pressure: List[hymd.barostat.Target_pressure] = <factory>, n_b: Optional[int] = None, m: List[float] = <factory>)[source]
+

Configuration object

+

Handles and verifies the simulation configuration specified in the +configuration file.

+
+

See also

+
+
hymd.input_parser.Bond

Two-particle bond type dataclass.

+
+
hymd.input_parser.Angle

Three-particle bond type dataclass.

+
+
hymd.input_parser.Dihedral

Four-particle bond type dataclass.

+
+
+ +
+
Attributes:
+
+
gas_constantfloat

Constant value of the gas constant, R (equivalently the Boltzmann +constant) in the units used internally in HyMD.

+
+
coulomb_constantfloat

Constant value of the Coulomb constant which converts electric field +values to forces and electric potential values to energies in the units +used internally in HyMD.

+
+
n_steps: int

Number of time steps in the simulation.

+
+
time_step: float

Outer time step used in the simulation. If the rRESPA intergrator is +used, the inner time step (the time step used in the integration of +intramolecular bending, stretching, and torsional forces) is +time_step / respa_inner.

+
+
box_sizelist[float] or (D,) numpy.ndarray

Simulation box size of simulation in D dimensions in units of +nanometers.

+
+
mesh_sizelist[int] or int or numpy.ndarray

Number of grid points used for the discrete density grid.

+
+
sigmafloat

Filter width representing the effective coarse-graining level of the +particles in the simulation.

+
+
kappafloat

Compressibility parameter used in the relaxed incompressibility term in +the interaction energy functional.

+
+
n_printint, optional

Frequency of trajectory/energy output to the H5MD trajectory/energy +output file (in units of number of time steps).

+
+
taufloat, optional

The time scale of the CSVR thermostat coupling.

+
+
start_temperaturefloat, optional

Generate starting temperature by assigning all particle velocities +randomly according to the Maxwell-Boltzmann distribution at +start_temperature Kelvin prior to starting the simulation.

+
+
target_temperaturefloat, optional

Couple the system to a heat bath at target_temperature Kelvin.

+
+
massfloat, optional

Mass of the particles in the simulation.

+
+
hamiltonianstr, optional

Specifies the interaction energy functional \(W[\tilde\phi]\) +for use with the particle-field interactions. Options: +SquaredPhi, DefaultNohChi, or DefaultWithChi.

+
+
domain_decompositionint, optional

Specifies the interval (in time steps) of domain decomposition +exchange, involving all MPI ranks sending and receiving particles +according to the particles’ positions in the integration box and the +MPI ranks’ assigned domain.

+
+
integratorstr, optional

Specifies the time integrator used in the simulation. Options: +velocity-verlet or respa.

+
+
respa_innerint, optional

The number of inner time steps in the rRESPA integrator. This denotes +the number of intramolecular force calculations (stretching, bending, +torsional) are performed between each impulse applied from the field +forces.

+
+
file_namestr, optional

File path of the parsed configuration file.

+
+
namestr, optional

Name for the simulation.

+
+
tagslist[str], optional

Tags for the simulation.

+
+
bondslist[Bond], optional

Specifies harmonic stretching potentials between particles in the +same molecule.

+
+
angle_bondslist[Angle], optional

Specifies harmonic angular bending potentials between particles in the +same molecule.

+
+
dihedralslist[Dihedral], optional

Specifies four-particle torsional potentials by cosine series.

+
+
chilist[Chi], optional

Specifies \(\chi\)-interaction parameters between particle +species.

+
+
n_particlesint, optional

Specifies the total number of particles in the input. Optional keyword +for validation, ensuring the input HDF5 topology has the correct number +of particles and molecules.

+
+
max_molecule_sizeint, optional

Maximum size of any single molecule in the system. Used to speed up +distribution of particles onto MPI ranks in a parallel fashion.

+
+
n_flushint, optional

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be +written to disk (in units of number of n_print).

+
+
thermostat_workfloat

Work performed by the thermostat on the system.

+
+
thermostat_coupling_groupslist[str], optional

Specifies individual groups coupling independently to the CSVR +thermostat. E.g. in a system containing "A", "B", and +"C" type particles, +thermostat_coupling_groups = [["A", "B"], ["C"],] would +thermalise types "A" and "B" together and couple +"C" type particles to a different thermostat (all individual +thermostats are at the same temperature, i.e. target_temperature +Kelvin).

+
+
initial_energyfloat

Value of the total energy prior to the start of the simulation.

+
+
cancel_com_momentumint, optional

If True, the total linear momentum of the center of mass is +removed before starting the simulation. If an integer is specifed, the +total linear momentum of the center of mass is removed every +remove_com_momentum time steps. If False, the linear +momentum is never removed.

+
+
coulombtypestr, optional

Specifies the type of electrostatic Coulomb interactions in the system. +The strength of the electrostatic forces is modulated by the relative +dielectric constant of the simulation medium, specified with the +dielectric_const keyword. Charges for individual particles are +specified in the structure/topology HDF5 input file, not in the +configuration file. If no charges (or peptide backbone dipoles) are +present, the electrostatic forces will not be calculated even if this +keyword is set to "PIC_Spectral".

+
+
dielectric_constfloat, optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. When +using helical propensity dihedrals, this keyword must be specified—even +if electrostatics are not included with the coulombtype +keyword.

+
+
dielectric_type: list[float], optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. The list assigns +relative dielectric values to each bead type, and an anisotropic +dielectric function is obtained from a weighted average.

+
+
+
+
+
+
+a: float = None
+
+ +
+
+angle_bonds: List[hymd.force.Angle]
+
+ +
+
+barostat: str = None
+
+ +
+
+barostat_type: str = None
+
+ +
+
+bonds: List[hymd.force.Bond]
+
+ +
+
+box_size: Union[List[float], numpy.ndarray] = None
+
+ +
+
+cancel_com_momentum: Union[int, bool] = False
+
+ +
+
+chi: List[hymd.force.Chi]
+
+ +
+
+conv_crit: float = None
+
+ +
+
+convergence_type: str = None
+
+ +
+
+coulomb_constant: ClassVar[float] = 138.935458
+
+ +
+
+coulombtype: str = None
+
+ +
+
+dielectric_const: float = None
+
+ +
+
+dielectric_type: List[hymd.force.Dielectric_type]
+
+ +
+
+dihedrals: List[hymd.force.Dihedral]
+
+ +
+
+domain_decomposition: Union[int, bool] = None
+
+ +
+
+dtype: numpy.dtype = None
+
+ +
+
+file_name: str = '<config file path unknown>'
+
+ +
+
+gas_constant: ClassVar[float] = 0.0083144621
+
+ +
+
+hamiltonian: str = None
+
+ +
+
+initial_energy: float = None
+
+ +
+
+integrator: str = None
+
+ +
+
+kappa: float
+
+ +
+
+m: List[float]
+
+ +
+
+mass: float = None
+
+ +
+
+max_molecule_size: int = None
+
+ +
+
+mesh_size: Union[List[int], numpy.ndarray, int]
+
+ +
+
+n_b: int = None
+
+ +
+
+n_flush: int = None
+
+ +
+
+n_particles: int = None
+
+ +
+
+n_print: int = None
+
+ +
+
+n_steps: int
+
+ +
+
+name: str = None
+
+ +
+
+pol_mixing: float = None
+
+ +
+
+pressure: bool = False
+
+ +
+
+respa_inner: int = 1
+
+ +
+
+rho0: float = None
+
+ +
+
+self_energy: float = None
+
+ +
+
+sigma: float
+
+ +
+
+start_temperature: Union[float, bool] = None
+
+ +
+
+tags: List[str]
+
+ +
+
+target_pressure: List[hymd.barostat.Target_pressure]
+
+ +
+
+target_temperature: Union[float, bool] = None
+
+ +
+
+tau: float = None
+
+ +
+
+tau_p: float = None
+
+ +
+
+thermostat_coupling_groups: List[List[str]]
+
+ +
+
+thermostat_work: float = 0.0
+
+ +
+
+time_step: float
+
+ +
+
+type_charges: Union[List[float], numpy.ndarray] = None
+
+ +
+ +
+
+hymd.input_parser.check_NPT_conditions(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check validity of barostat_type, barostat, +a, rho0, target_pressure, tau_p

+
+ +
+
+hymd.input_parser.check_angles(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_bonds(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_box_size(config, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_cancel_com_momentum(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_charges(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if charges across ranks sum to zero.

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of floats with charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_charges_types_list(config, types, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates a list of charge values of length types. +Charges are sorted according to type ID. Used in field.py. +# TODO: this is messy, we should fix it

+
+ +
+
+hymd.input_parser.check_chi(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_config(config, indices, names, types, charges, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs various checks on the specfied config to ensure consistency

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
indices(N,) numpy.ndarray

Array of integer indices for N particles.

+
+
names(N,) numpy.ndarray

Array of string names for N particles.

+
+
types(N,) numpy.ndarray

Array of integer type indices for N particles.

+
+
charges(N,) numpy.ndarray

Array of floats charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
Returns:
+
+
configConfig

Validated configuration object.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_dielectric(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Error handling for electrostatics. +Unit testing of toml/tomli input.

+
+ +
+
+hymd.input_parser.check_dihedrals(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_domain_decomposition(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_hamiltonian(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_integrator(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_m(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_mass(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_max_molecule_size(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_b(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_flush(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_particles(config, indices, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_print(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_name(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_start_and_target_temperature(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Validate provided starting and target thermostat temperatures

+

Assesses the provided temperature target and ensures it is a non-negative +floating point number or False. Ensures the starting temperature is +a non-negative floating point number or False.

+

If the value for either is None, the returned configuration object +has the values defaulted to False in each case.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
validated_configConfig

Configuration object with validated target_temperature and +start_temperature.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_tau(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_thermostat_coupling_groups(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.parse_config_toml(toml_content, file_path=None, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.read_config_toml(file_path)[source]
+
+ +
+
+hymd.input_parser.sort_dielectric_by_type_id(config, charges, types)[source]
+

Creates a list of length N CG-particles, sorted after the charges from +the input HDF5 file. Used in file_io.py

+
+ +
+
+

4.7. Field

+

Forces and energies from the discretized particle-field grid interactions

+
+
+hymd.field.compute_field_and_kinetic_energy(phi, phi_q, psi, velocity, hamiltonian, positions, types, v_ext, config, layouts, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the particle-field and kinetic energy contributions

+

Calculates the kinetic energy through

+
+\[E_k = \sum_j \frac{1}{2}m_j\mathbf{v}_j\cdot\mathbf{v}_j,\]
+

and the particle-field energy by

+
+\[E_\text{field} = \int\mathrm{d}\mathbf{r}\, + w[\tilde\phi],\]
+

where \(w\) is the interaction energy functional density.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
velocity(N,D) numpy.ndarray

Array of velocities for N particles in D dimensions. +Local for each MPI rank.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Local for each MPI rank–the full computational grid is +represented by the collective fields of all MPI ranks.

+
+
configConfig

Configuration object.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field

Computes the up-to-date external potential for use in calculating the particle-field energy.

+
+
+ +
+ +
+
+hymd.field.compute_field_energy_q_GPE(config, phi_eps, field_q_energy, dot_elec, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the electrostatic energy after electrosatic forces is +calculated.

+

From the definition of the elecrostatic potential \(\Psi\), the energy +is

+
+
+
W = frac{1}{2}intmathrm{d}mathbf{r},

epsilon(mathbf{r})} left(mathbf{E}cdot mathbf{E}right),

+
+
+
+

where \(\epsilon(\mathbf{r})}\) is the anisotropic, spatially dependent, +relative dielectric of the simulation medium.

+
+
Parameters:
+
+
confighymd.input_parser.Config

Configuration object.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
field_q_energyfloat

Total elecrostatic energy.

+
+
dot_elecpmesh.pm.RealField

Pmesh RealField object for storing \(|\mathbf{E(r)}|^{2}\) +on the computational grid. Local for each MPI rank – the full computational +grid is represented by the collective fields of all MPI ranks.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field_force_q_GPE

Compute the electrosatic force from an anisotropic dielectric general Poisson equation.

+
+
+ +
+ +
+
+hymd.field.compute_field_force(layouts, r, force_mesh, force, types, n_types)[source]
+

Interpolate particle-field forces from the grid onto particle positions

+

Backmaps the forces calculated on the grid to particle positions using the +window function \(P\) (by default cloud-in-cell [CIC]). In the +following, let \(\mathbf{F}_j\) denote the force acting on the +particle with index \(j\) and position \(\mathbf{r}_j\). The +interpolated force is

+
+\[\mathbf{F}_j = -\sum_k\nabla V_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(V_{j_k}\) is the discretized external potential at grid vertex +\(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid vertex +with index \(j_k\), and \(h^3\) is the volume of each grid voxel. +The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
r(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
force(N,D) numpy.ndarray

Array of forces for N particles in D dimensions. Local +for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
n_typesint

Number of different unique types present in the simulation system. +n_types is global, i.e. the same for all MPI ranks even if some +ranks contain zero particles of certain types.

+
+
+
+
+
+ +
+
+hymd.field.compute_self_energy_q(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the self energy for the interaction due to the Ewald scheme +used to compute the electrostatics. The energy is stored in config.

+

The self interaction energy is given by:

+
+\[U_{self} = \sqrt{\frac{1}{2\pi\sigma^2}} \sum_{i=1}^{N} q_i^2\]
+

where \(q_i\) are the charges and \(\sigma\) is the half-width +of the Gaussian filter.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
Returns:
+
+
field_q_self_energyfloat

Electrostatic self energy.

+
+
+
+
+
+ +
+
+hymd.field.domain_decomposition(positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs domain decomposition

+

Rearranges the MPI rank memory layout into one that better mimics the PFFT +pencil grid 2D decomposition. As molecules are always required to be fully +contained on a single MPI rank, a perfect decomposition is not always +possible. The best decomposition which leaves the center of mass of all +molecules in their respective correct domains is used, with possible +overlap into neighbouring domains if the spatial extent of any molecule +crosses domain boundaries.

+
+
Parameters:
+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
*args

Variable length argument list containing arrays to include in the +domain decomposition.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
bonds(N,M) numpy.ndarray, optional

Array of M bonds originating from each of N particles.

+
+
verboseint, optional

Specify the logging event verbosity of this function.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
Domain decomposedcode:positions and any array specified in
+
:code:`*args`, in addition tocode:bonds and molecules if these
+
arrays were provided as input.
+
+
+
+
+ +
+
+hymd.field.initialize_pm(pmesh, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates the necessary pmesh objects for pfft operations.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pmobject ‘pmesh.pm.ParticleMesh’
+
field_listlist[pmesh.pm.RealField], (multiple)

Essential list of pmesh objects required for MD

+
+
list_coulomblist[pmesh.pm.RealField], (multiple)

Additional list of pmesh objects required for electrostatics.

+
+
+
+
+
+ +
+
+hymd.field.update_field(phi, phi_laplacian, phi_transfer, layouts, force_mesh, hamiltonian, pm, positions, types, config, v_ext, phi_fourier, v_ext_fourier, m, compute_potential=False)[source]
+

Calculate the particle-field potential and force density

+

If compute_potential is True, the energy may subsequently +be computed by calling compute_field_and_kinetic_energy.

+

Computes the particle-field external potential \(V_\text{ext}\) from +particle number densities through the smoothed density field, +\(\phi(\mathbf{r})\). With \(P\) being the cloud-in-cell (CIC) +window function, the density and filtered densities are computed as

+
+\[\phi(\mathbf{r}) = \sum_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\phi(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +external potential is computed in reciprocal space as

+
+\[V_\text{ext} = \mathrm{FFT}^{-1}\left[ + \mathrm{FFT} + \left( + \frac{\partial w}{\partial \tilde\phi} + \right) + \mathrm{FFT}(H) +\right],\]
+

where \(w\) is the interaction energy functional. Differentiating +\(V_\text{ext}\) is done by simply applying \(i\mathbf{k}\) in +Fourier space, and the resulting forces are back-transformed to direct +space and interpolated to particle positions by

+
+\[\mathbf{F}_j = -\sum_{j_k} \nabla V_{j_k} + P(\mathbf{r}_{j_k} - \mathbf{r}_j)h^3,\]
+

where \(j_k\) are the neighbouring vertices of particle \(j\) at +position \(\mathbf{r}_j\), and \(h^3\) is the volume of each grid +voxel.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Pre-allocated, but empty; any values +in this field are discarded. Changed in-place. Local for each MPI +rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
configConfig

Configuration object.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Pre-allocated, but empty; any values in this field are +discarded Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
phi_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computational grid is represented by the collective fields of all +MPI ranks.

+
+
v_ext_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplesField objects containing discretized +particle-field external potential values in reciprocal space on the +computational grid; D+1 fields in D dimensions for each +particle type. D copies are made after calculation for later +use in force calculation, because the force transfer function +application differentiates the field in-place, ruining the contents +for differentiation in the remaining D-1 spatial directions. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
m: list[float], (M,)

pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. +Defaults to 1.0 for all particle types.

+
+
compute_potentialbool, optional

If True, a D+1-th copy of the Fourier transformed +external potential field is made to be used later in particle-field +energy calculation. If False, only D copies are made.

+
+
+
+
+
+

See also

+
+
compute_field_and_kinetic_energy

Compute the particle-field energy after the external potential is calculated.

+
+
+ +
+ +
+
+hymd.field.update_field_force_q(charges, phi_q, phi_q_fourier, psi, psi_fourier, elec_field_fourier, elec_field, elec_forces, layout_q, hamiltonian, pm, positions, config)[source]
+

Calculate the electrostatic particle-field forces on the grid

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential is computed in reciprocal space as

+
+\[\Phi = \mathrm{FFT}^{-1}\left[ + \frac{4\pi k_e}{\varepsilon \vert\mathbf{k}\vert^2} + \mathrm{FFT}(\rho)\mathrm{FFT}(H) +\right],\]
+

with the electric field

+
+\[\mathbf{E} = \mathrm{FFT}^{-1}\left[ + -i\mathbf{k}\,\mathrm{FFT}(\Psi) +\right].\]
+

In the following, let \(\mathbf{F}_j\) denote the electrostatic force +acting on the particle with index \(j\) and position +\(\mathbf{r}_j\). The interpolated electrostatic force is

+
+\[\mathbf{F}_j = \sum_k q_j\mathbf{E}_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(\mathbf{E}_{j_k}\) is the discretized electric field at grid +vertex \(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid +vertex with index \(j_k\), and \(h^3\) is the volume of each grid +voxel. The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty; any values in this field +are discarded. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
elec_field_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +electric field values in reciprocal space on the computational grid. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
+
+
+
+ +
+
+hymd.field.update_field_force_q_GPE(conv_fun, phi, types, charges, phi_q, phi_q_fourier, phi_eps, phi_eps_fourier, phi_eta, phi_eta_fourier, phi_pol_prev, phi_pol, elec_field, elec_forces, elec_field_contrib, psi, Vbar_elec, Vbar_elec_fourier, force_mesh_elec, force_mesh_elec_fourier, hamiltonian, layout_q, layouts, pm, positions, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Calculate the electrostatic particle-field forces on the grid, arising from +a general Poisson equation, i.e. anisotropic permittivity/dielectric. +The function is called when tomli input config.coulombtype = “PIC_Spectral_GPE.”

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential for a variable dielectric does not have an +analytical expression, and is computed in reciprocal through an iterative +method.

+

The GPE states that

+
+\[\nabla \cdot \left(\epsilon(\mathbf{r}) +\nabla{\mathbf{\psi(r)}}\right) = -\rho({\mathbf{r}}).\]
+

where \(\epsilon(\mathbf{r})\) is the relative dielectric function.

+
+
Parameters:
+
+
conv_funConvergence function.

Returns a scalar. Depends on MPI allreduce for similar convergence +across MPI ranks.

+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_eps_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_etapmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +gradients of the relative dielectric values on the computational grid. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank–the +full computational grid is represented by the collective fields of all MPI ranks.

+
+
phi_eta_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated discretized +Fourier transformed gradient relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_pol_prevpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charge values on the computational grid. Parameter in +the iterative method.Pre-allocated,but empty. Changedin-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_polpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charges on the computational grid. Parameter in the iterative +method, updating the next quess in solving for the electrostatic potential. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank– +the full computational grid is represented by the collective fields of +all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all +MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
elec_field_contribpmesh.pm.RealField

Pmesh RealField object for storing +\(|\mathbf{E(r)}|^2/\phi_{0}\) on the computational grid. +Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
psipmesh.pm.RealField

Pmesh RealField object for storing electrostatic potential +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
Vbar_elecmesh.pm.RealField

Pmesh RealField object for storing functional derivatives of +:math:`|w({ phi })_{elec}`on the computational grid. +Pre-allocated, but empty. Changed in-place. Local for each MPI rank– +the full computational grid is represented by the collective fields of

+
+

all MPI ranks.

+
+
+
Vbar_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated functional +derivatives of \(\|w(\{ \phi \})_{elec}\) in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
force_mesh_elecpmesh.pm.RealField

Pmesh RealField object for storing electrostatic force values +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
force_mesh_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated electrostatic +force values in reciprocal space on the computational grid. Local for +each MPI rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
layouts: list[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
comm: mpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
compute_field_energy_q_GPE

Compute the electrostatic energy after electrosatic force is calculated for a variable (anisotropic) dielectric general Poisson equation.

+
+
+ +
+ +
+
+

4.8. File input/output

+

Handle file input/output in parllel HDF5 fashion

+
+
+class hymd.file_io.OutDataset(dest_directory, config, double_out=False, disable_mpio=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

HDF5 dataset handler for file output

+
+
+close_file(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Closes the HDF5 output file

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+
+flush()[source]
+

Flushes output buffers, forcing file writes

+
+ +
+
+is_open(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if HDF5 output file is open

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+ +
+
+hymd.file_io.distribute_input(in_file, rank, size, n_particles, max_molecule_size=201, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Assign global arrays onto MPI ranks, attempting load balancing

+

Distributes approximately equal numbers of particles (workload) onto each +independent MPI rank, while respecting the requirement that any molecule +must be fully contained on a single MPI rank only (no splitting molecules +across multiple CPUs).

+
+
Parameters:
+
+
in_fileh5py.File

HDF5 input file object.

+
+
rankint

Local rank number for this MPI rank.

+
+
sizeint

Global size of the MPI communicator (number of total CPUs).

+
+
n_particlesint

Total number of particles.

+
+
max_molecule_sizeint, optional

Maximum size of any molecule present in the system. Used to initially +guess where the MPI rank boundaries (start/end indices) in the global +arrays should be placed. If molecules of size +>max_molecule_size exist in the simulation system, HyMD +might work as expected. Or it might fail spectacularly.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
rank_range

Starting and ending indices in the global arrays for each MPI rank.

+
+
+
+
+
+ +
+
+hymd.file_io.setup_time_dependent_element(name, parent_group, n_frames, shape, dtype, units=None)[source]
+

Helper function for setting up time-dependent HDF5 group datasets

+

All output groups must adhere to the H5MD standard, meaning a structure of

+
+
┗━ group particle group (e.g. all) or observables group
+
+
┗━ group time-dependent data
+
+
┣━ dataset step shape=(n_frames,)
+
┣━ dataset time shape=(n_frames,)
+
┗━ dataset value shape=(n_frames, *)
+
+
+
+

is necessary.

+

References

+
+
H5MD specification :

https://www.nongnu.org/h5md/h5md.html

+
+
+
+ +
+
+hymd.file_io.store_data(h5md, step, frame, indices, positions, velocities, forces, box_size, temperature, pressure, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, field_energy, field_q_energy, plumed_bias, time_step, config, velocity_out=False, force_out=False, charge_out=False, plumed_out=False, dump_per_particle=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Writes time-step data to HDF5 output file

+

Handles all quantities which change during simulation, as opposed to +static quanitities (see store_static).

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
stepint

Step number.

+
+
frameint

Output frame number (step // n_print).

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
positions(N,) numpy.ndarray

Array of positions for N particles in D dimensions.

+
+
velocities(N,) numpy.ndarray

Array of velocities for N particles in D dimensions.

+
+
forces(N,) numpy.ndarray

Array of forces for N particles in D dimensions.

+
+
box_size(D,) numpy.ndarray

Array containing the simulation box size.

+
+
temperaturefloat

Calculated instantaneous temperature.

+
+
kinetic_energyfloat

Calculated instantaneous kinetic energy.

+
+
bond2_energyfloat

Calculated instantaneous harmonic two-particle bond energy.

+
+
bond3_energyfloat

Calculated instantaneous harmonic angular three-particle bond energy.

+
+
bond4_energyfloat

Calculated instantaneous dihedral four-particle torsion energy.

+
+
field_energyfloat

Calculated instantaneous particle-field energy.

+
+
field_q_energyfloat

Calculated instantaneous electrostatic energy.

+
+
plumed_biasfloat

PLUMED instantaneous bias energy.

+
+
time_stepfloat

Value of the time step.

+
+
configConfig

Configuration object.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charge_outbool, optional

If True, electrostatic energies are written to the output +HDF5 file.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to the output HDF5 file.

+
+
dump_per_particlebool, optional

If True, all quantities are written per particle.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
store_static

Outputs all static time-independent quantities to the HDF5 output file

+
+
+ +
+ +
+
+hymd.file_io.store_static(h5md, rank_range, names, types, indices, config, bonds_2_atom1, bonds_2_atom2, molecules=None, velocity_out=False, force_out=False, charges=False, dielectrics=False, plumed_out=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Outputs all static time-independent quantities to the HDF5 output file

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
rank_rangelist[int]

Start and end indices for global arrays for each MPI rank.

+
+
names(N,) numpy.ndarray

Array of names for N particles.

+
+
types(N,) numpy.ndarray

Array of type indices for N particles.

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
configConfig

Configuration object.

+
+
bonds_2_atom1(B,) numpy.ndarray

Array of indices of the first particle for B total +two-particle bonds.

+
+
bonds_2_atom2(B,) numpy.ndarray

Array of indices of the second particle for B total +two-particle bonds.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles.

+
+
dielectrics(N,) numpy.ndarray

Array of particle relative dielectric values for N particles.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to output HDF5 file.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
prepare_bonds

Constructs two-, three-, and four-particle bonds from toplogy input file and bond configuration information.

+
+
distribute_input

Distributes input arrays onto MPI ranks, attempting load balancing.

+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/doc_pages/benchmarks.html b/v1.0.6/doc_pages/benchmarks.html new file mode 100644 index 00000000..9eb1918b --- /dev/null +++ b/v1.0.6/doc_pages/benchmarks.html @@ -0,0 +1,300 @@ + + + + + + + 3. Benchmarks — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Benchmarks

+

Homopolymer melt test systems of \(30^2\), \(40^2\), and \(50^2\) +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively.

+
+

3.1. Bonded forces

+

Legend label denotes the number of particles in the system.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-1.png +
+
+
+

3.2. Particle–field forces

+

Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-2.png +
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/doc_pages/command_line.html b/v1.0.6/doc_pages/command_line.html new file mode 100644 index 00000000..890c1571 --- /dev/null +++ b/v1.0.6/doc_pages/command_line.html @@ -0,0 +1,357 @@ + + + + + + + 5. Command line arguments — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. Command line arguments

+

Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle–field interactions.

+
+

5.1. Required arguments

+
+
configuration file:
+

type positional

+

Specifies the .toml format configuration file containing simulation details. See Configuration file for details.

+
+
structure and topology file:
+

type positional

+

Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See Topology and structure file for details.

+
+
+
+
+

5.2. Optional arguments

+
+
-v  --verbose

type optional

+

Number of following arguments: 0 or 1

+

Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying -v or --verbose with no additional specification. This increases verbosity level by 1. Alternatively, it maye be specified by --verbose V with V being 0, 1, or 2.

+
+
--profile

type optional

+

Number of following arguments: 0

+

Enables code profiling using cProfile. This will output one profiling file per MPI rank invoked in the simulation.

+
+
--double-precision

type optional

+

Number of following arguments: 0

+

Specify usage of double precision internally in HyMD (including in the FFTs).

+
+
--double-output

type optional

+

Number of following arguments: 0

+

Specify usage of double precision in the output trajectory from HyMD.

+
+
--velocity-output

type optional

+

Number of following arguments: 0

+

Specify that velocities should be output to the HyMD trajectory.

+
+
--force-output

type optional

+

Number of following arguments: 0

+

Specify that forces should be output to the HyMD trajectory.

+
+
--disable-mpio

type optional

+

Number of following arguments: 0

+

Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult.

+
+
--logfile

type optional

+

Number of following arguments: 1

+

Specifies the path of a plain text log file in which stdout is mirrored during simulation runs.

+
+
--seed

type optional

+

Number of following arguments: 1

+

Specifies the random seed used in the numpy random library to generate velocities, thermostatting, etc.

+
+
--disable-bonds

type optional

+

Number of following arguments: 0

+

Disable any two-particle bonds present in the system.

+
+
--disable-angle-bonds

type optional

+

Number of following arguments: 0

+

Disable any three-particle bonds present in the system.

+
+
--disable-dihedrals

type optional

+

Number of following arguments: 0

+

Disable any four-particle bonds present in the system.

+
+
--disable-dipole

type optional

+

Number of following arguments: 0

+

Disable any topological reconstruction of peptide backbone dipoles present in the system.

+
+
--disable-field

type optional

+

Number of following arguments: 0

+

Disable any particle–field interactions present in the system.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/doc_pages/config_file.html b/v1.0.6/doc_pages/config_file.html new file mode 100644 index 00000000..7298e6f9 --- /dev/null +++ b/v1.0.6/doc_pages/config_file.html @@ -0,0 +1,444 @@ + + + + + + + 3. Configuration file — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Configuration file

+

The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order.

+

The configuration file is a toml format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs.

+
+

3.1. Configuration file keywords

+

The following constitutes every possible keyword specification in HyMD +configuration files:

+
+

3.1.1. Metadata keywords

+

Configuration keywords specifying metadata for the H5MD output trajectory.

+
+
name:
+

string [optional, default: None]

+

Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file.

+
+
tags:
+

array [string] [optional, default: None]

+

Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file.

+
+
+
+
+

3.1.2. Particle keywords

+

Configuration keywords specifying properties of particles and molecules in the +system.

+
+
n_particles:
+

integer [optional, default: None]

+

Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules.

+
+
mass:
+

float [optional, default: 72.0] {units: \(\text{u}=\text{g}\,\text{mol}^{-1}\)}

+

Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal.

+
+
max_molecule_size:
+

integer [optional, default: 201]

+

Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code will crash if there are molecules larger than max_molecule_size in the topology/structure input file.

+
+
+
+
+

3.1.3. Simulation keywords

+

Configuration keywords specifying simulation parameters.

+
+
n_steps:
+

integer [required]

+

Total number of integration steps to perform for this simulation.

+
+
n_print:
+

integer or boolean [optional, default: False]

+

Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of number of time steps).

+
+
n_flush:
+

integer [optional, default: None]

+

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of number of n_print, i.e. n_print = 13, n_flush = 3 would result in the trajectory/energy being written to disk every 13 x 3 = 39 simulation steps)

+
+
time_step:
+

float [required] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time step per integration step. If the rRESPA multiple time step integrator is used (integrator = "respa"), this specifies the inner time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is respa_inner times the time_step , and the total simulation time is n_steps times time_step times respa_inner .

+
+
box_size:
+

array [float] [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable.

+
+
integrator:
+

string [required] (options: velocity-verlet or respa)

+

Specifies the time integrator used in the simulation. If respa, the reversible reference system propagator algorithm (rRESPA) [Tuckerman et al., 1992] integrator is used, with respa_inner number of inner (intramolecular force) time steps. If velocity-verlet, a normal Velocity Verlet integrator is used. If respa and respa_inner = 1, the rRESPA integrator is equivalent to the Velocity Verlet.

+
+
respa_inner:
+

integer [optional, default: 1]

+

The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces.

+
+
domain_decomposition:
+

integer or boolean [optional, default: False]

+

Specifies the interval (in time steps) of domain decomposition exchange, involving all MPI ranks sending and receiving particles according to the particles’ positions in the integration box and the MPI ranks’ assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If True, the decomposition is performed once (before starting the simulation). If False, no decomposition is performed.

+
+
cancel_com_momentum:
+

integer or boolean [optional, default: False]

+

If True, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every remove_com_momentum time steps. If False, the linear momentum is never removed.

+
+
start_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at start_temperature Kelvin prior to starting the simulation. If False, the velocities are not changed before starting the simulation.

+
+
target_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Couple the system to a heat bath at target_temperature Kelvin by applying a Canonical sampling through velocity rescaling [Bussi et al., 2007] thermostat with coupling strength tau. If False, no temperature control is applied.

+
+
tau:
+

float [optional, default: 0.7] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the CSVR thermostat coupling. In the limit of tau , the Hamiltonian dynamics are preserved and no temperature coupling takes place.

+
+
thermostat_coupling_groups:
+

array [array [string]] [optional, default: []]

+

Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing "A", "B", and "C" type particles, thermostat_coupling_groups = [["A", "B"], ["C"],] would thermalise types "A" and "B" together and couple "C" type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. target_temperature Kelvin).

+
+
hamiltonian:
+

string [optional, default: "DefaultNohChi"] (options: SquaredPhi, DefaultNohChi, or DefaultWithChi)

+

Specifies the interaction energy functional \(W[\tilde\phi]\) for use with the particle-field interactions. See Interaction energy functionals for details.

+
+
+
+
+

3.1.4. Field keywords

+

Configuration keywords specifying field parameters.

+
+
mesh_size:
+

array [integer] or integer [required]

+

Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is box_size / mesh_size.

+
+
kappa:
+

float [required] {units: \(\text{kJ}^{-1}\text{mol}\)}

+

Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional \(W[\tilde\phi]\). See Interaction energy functionals for more details.

+
+
sigma:
+

float [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See Filtering for more details.

+
+
chi:
+

array [array [string, float]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\)}

+

Array of \(\tilde\chi_\text{AB}\)-parameters indicating the strength of the repulsive or attractive interaction between particles of type "A" and the number density due to particles of type "B", and vice versa. Example: chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ] would specify a repulsive "A""B" type interaction, and a weakly attractive "C""D" interaction. Self-interaction \(\tilde\chi\)-terms are always zero. See Interaction energy functionals for more details.

+
+
+
+
+

3.1.5. Bond keywords

+

Configuration keywords specifying bonds and bonds parameters.

+
+
bonds:
+

array [array [2 string, 2 float]] [optional, default: []] {units: \(\text{nm}=10^{-9}~\text{m}\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+

Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ] indicates a "A""A" bond of equilibrium length 0.47 \(\text{nm}\) with a bond strength of 980.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding bond between "A" and "B" type particles with equilibrium length 0.31 \(\text{nm}\) and a strength of 1250.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify stretching bonds.

+
+
angle_bonds:
+

array [array [3 string, 2 float]] [optional, default: []] {units: \({}^\circ\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+
+

Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ] indicates a "A""A""A" angular bond that tries to keep the bond linear at 180 degrees with a bending strength of 55.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding angle bond between "A""B""B" prefering the angle at 120 degrees and a strength of 25.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify angular bonds.

+
+
+
dihedrals:
+

array [array [4 string, integer, COSINE SERIES ]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)}

+

Specifies four-particle torsional potentials by cosine series. See Intramolecular bonds for details about how to specify dihedrals.

+
+
+
+
+

3.1.6. Electrostatic keywords

+

Configuration keywords specifying electrostatics and electrostatic parameters.

+
+
coulombtype:
+

string [optional, default: None] (options: PIC_Spectral)

+

Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the dielectric_const keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, not in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to PIC_Spectral.

+
+
dielectric_const:
+

float [optional, default: None]

+

Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified—even if electrostatics are not included with the coulombtype keyword.

+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/doc_pages/constants_and_units.html b/v1.0.6/doc_pages/constants_and_units.html new file mode 100644 index 00000000..7afe83bc --- /dev/null +++ b/v1.0.6/doc_pages/constants_and_units.html @@ -0,0 +1,391 @@ + + + + + + + 6. Constants and Units — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

6. Constants and Units

+

HyMD uses the following units and constants internally and in all input and +output:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Units

Quantity

Symbol

Unit

length

\(r\)

\(\text{nm}=10^{-9}~\text{m}\)

time

\(t\)

\(\text{ps}=10^{-12}~\text{s}\)

charge

\(q\)

\(e=1.602176634 \cdot 10^{-19}~\text{C}\)

mass

\(m\)

\(\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}\)

temperature

\(\text{T}\)

\(\text{K}\)

energy

\(E\)

\(\text{kJ}\,\text{mol}^{-1}\)

velocity

\(v\)

\(\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}\)

momentum

\(P\)

\(\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}\)

force

\(\mathbf{F}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}\)

pressure

\(p\)

\(\text{bar}=100~\text{kPa}\)

electric potential

\(\Psi\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}\)

electric field

\(\mathbf{E}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}\)

compressibility

\(\kappa\)

\(\text{mol}\,\text{kJ}^{-1}\)

field-interaction

\(\tilde\chi\)

\(\text{kJ}\,\text{mol}^{-1}\)

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants

Constant

Symbol

Value

gas constant

\(R\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Boltzmann’s constant

\(k_\text{B}\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Avogadro’s constant

\(N_\text{A}\)

\(6.02214076 \cdot 10^23~\text{mol}^{-1}\)

Vacuum permittivity

\(\varepsilon_0\)

\(8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2\)

Coulomb constant

\(k_\text{e}\)

\(138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}\)

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/doc_pages/electrostatics.html b/v1.0.6/doc_pages/electrostatics.html new file mode 100644 index 00000000..f3b0e202 --- /dev/null +++ b/v1.0.6/doc_pages/electrostatics.html @@ -0,0 +1,312 @@ + + + + + + + 3. Electrostatic interactions — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Electrostatic interactions

+

In the filtered Hamiltonian hPF formalism [Bore and Cascella, 2020] the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle–mesh Ewald.

+

The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered

+
+\[\tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i),\]
+

with \(q_i\) being the charge of particle \(i\) and \(H\) is the +filtering function (see Filtering). The value of the charge grid at +vertex \((i,j,k)\) is found by

+
+\[\tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)]\]
+

and the electrostatic potential \(\Psi_{ijk}\)

+
+\[\Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right],\]
+

where \(k_\text{e}\) is the Coulomb constant \(1/4\pi\varepsilon_0\). +The electric field is obtained by differentiation of the electrostatic +potential in Fourier space,

+
+\[\mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)]\]
+

from which the forces are interpolated back to the particle positions.

+
+

3.1. Specifying electrostatics

+

In HyMD, electrostatics are specified by the coulombtype and +dielectric_const keywords in the configuration file (see +Configuration file) and the /charge dataset in the HDF5 format +structure/topology input file (see Topology and structure file). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/doc_pages/examples.html b/v1.0.6/doc_pages/examples.html new file mode 100644 index 00000000..70cd8f1b --- /dev/null +++ b/v1.0.6/doc_pages/examples.html @@ -0,0 +1,760 @@ + + + + + + + 1. Examples — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Examples

+

The following examples are ordered in more or less order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the HyMD-tutorial github repository.

+
+

1.1. Ideal gas

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true +

The simplest possible system is one with no interactions at all—intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like:

+
+
ideal_gas.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = false         # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+
+
+

A simple input structure/topology file ideal_gas.HDF5 is available in +the HyMD-tutorial/ideal_gas github repository (along with the code to +generate it). Run the (very) short simulation by

+
python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field   \
+                                              --velocity-output \
+                                              --force-output
+
+
+

with the --disable-field argument to completely turn off all +particle–field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook ideal_gas.ipynb for details.

+
+
+

1.2. Ideal chains

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true +

The simplest available interaction is the harmonic two-particle bond (see +Intramolecular bonds),

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2.\]
+

Extending the configuration file from the ideal gas case, we need to add a +bonds specification. Note that the [bonds] meta specifier is not +necessary, but may be used to help organise the input file.

+
+
ideal_chain.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+
+
+

A simple input structure/topology file ideal_chain.HDF5 with a few +coiled up ideal chain polymers is available in the +HyMD-tutorial/ideal_chain github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field
+
+
+

we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +ideal_chain.ipynb.

+
+
+

1.3. Stiff rods

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true +

Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the i--j--k angle \(\theta\) (see +Intramolecular bonds),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2.\]
+

Extending the configuration file from the ideal chain case, we need to add a +angle_bonds specification. Note that the [bonds] meta specifier +is not necessary, but may be used to help organise the input file.

+
+
rods.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+angle_bonds = [
+  ["A", "A", "A", 180.0, 100.0],   # (i, j, k, equilibrium angle, strength)
+]
+
+
+
+

A simple input structure/topology file rods.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook rods.ipynb.

+
+
+

1.4. Helixes

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true +

Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle \(\phi\) between the +i--j--k plane and the j--k--l plane (see Intramolecular bonds),

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n).\]
+

The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a dihedrals keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the dielectric_const +keyword even though we are not including electrostatic forces in the current +simulation. Note that the [bonds] meta specifier is not necessary, but +may be used to help organise the input file.

+
+
helixes.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+dielectric_const = 15.0
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.31, 10000.0],       # (i name, j name, equilibrium length, strength)
+]
+
+dihedrals = [
+  [
+    ["A", "A", "A", "A"],
+    [
+      [-1],
+      [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+      [0.08, 0.46, 1.65, -0.96, 0.38],
+    ],
+    [1.0]
+  ],
+]
+
+
+
+

A simple input structure/topology file helixes.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook helixes.ipynb.

+
+
+

1.5. Phase separation

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true +

The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types A and B. Using the Hamiltonian

+
+\[\mathcal{H}=H_0+W\]
+

with \(\tilde\chi\)–dependent interactions defined by (specified in the +configuration file by hamiltonian = DefaultWithChi):

+
+\[W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2.\]
+
+
phase_separation.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+
+[field]
+mesh_size = [20, 20, 20]           # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+kappa = 0.05                       # compressibility in mol/kJ
+chi = [
+  ['A', 'B', 5.0],                 # (name i, name j, strength)
+]
+
+
+
+

A simple input structure/topology file phase_separation.HDF5 containing +an equal number of A type and B type particles is available in +the HyMD-tutorial/phase_separation github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd phase_separation.toml phase_separation.HDF5
+
+
+

we may examine the resulting trajectory. In the case of a low interaction +strength \(\tilde\chi\) of 5.0 (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to 40.0 (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +phase_separation.ipynb.

+
+
+

1.6. Diblock copolymers

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true +

Having introduced particle–field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive \(\tilde\chi\)–interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the integrator = "respa" keyword. Putting the pieces together, the +configuration file may look like the following:

+
+
copolymer.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 15
+n_steps = 2000                     # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [10.0, 10.0, 10.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [50, 50, 50]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+chi = [
+  ["A", "B", 30.0],                # (i, j, strength)
+]
+
+[bonds]
+bonds = [
+  ["A", "A", 0.25, 1500.0],        # (i, j, equilibrium length, strength)
+  ["A", "B", 0.25, 1500.0],
+  ["B", "B", 0.25, 1500.0],
+]
+angle_bonds = [
+  ["A", "A", "A", 180.0, 25.0],    # (i, j, k, equilibrium angle, strength)
+  ["B", "B", "B", 180.0, 25.0],
+]
+
+
+
+

A simple input structure/topology file copolymer.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/copolymer github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten A followed by ten B type particles. +Running the simulation with

+
python3 -m hymd copolymer.toml copolymer.HDF5
+
+
+

the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +copolymer.ipynb.

+
+
+

1.7. Lipid bilayer self-assembly

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true +

Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field–particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the thermostat_coupling_groups keyword. With parameters +optimised in [Ledum et al., 2020], the configuration file looks like:

+
+
lipid_self_assembly.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 25
+n_steps = 3000
+n_print = 200
+n_flush = 1
+time_step = 0.01
+box_size = [9.96924, 9.96924, 10.03970]
+start_temperature = 323
+target_temperature = 323
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.05
+domain_decomposition = 10001
+cancel_com_momentum = true
+max_molecule_size = 15
+thermostat_coupling_groups = [
+  ["N", "P", "G", "C"],
+  ["W"],
+]
+
+[field]
+mesh_size = [25, 25, 25]
+sigma = 1.0
+chi = [
+  ["C", "W", 42.24],
+  ["G", "C", 10.47],
+  ["N", "W", -3.77],
+  ["G", "W", 4.53],
+  ["N", "P", -9.34],
+  ["P", "G", 8.04],
+  ["N", "G", 1.97],
+  ["P", "C", 14.72],
+  ["P", "W", -1.51],
+  ["N", "C", 13.56],
+]
+
+[bonds]
+bonds = [
+  ["N", "P", 0.47, 1250.0],
+  ["P", "G", 0.47, 1250.0],
+  ["G", "G", 0.37, 1250.0],
+  ["G", "C", 0.47, 1250.0],
+  ["C", "C", 0.47, 1250.0],
+]
+angle_bonds = [
+  ["P", "G", "G", 120.0, 25.0],
+  ["P", "G", "C", 180.0, 25.0],
+  ["G", "C", "C", 180.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

A randomly mixed input structure/topology file +lipid_self_assembly.HDF5 with a few hundred lipids in a roughy +10 x 10 x 10nm box is available in the +HyMD-tutorial/lipid_self_assembly github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation

+
python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5
+
+
+

we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook lipid_self_assembly.ipynb.

+
+
+

1.8. Peptide in lipid bilayer

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true +

Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer.

+

The configuration file is available in the HyMD-tutorial/peptide github +repository (omitted here for brevity).

+

A pre-equilibrated input structure/topology file peptide.HDF5 with a +few hundred lipids in a roughy 20 x 20 x 20nm box is available in the +HyMD-tutorial/peptide github repository. Running the simulation

+
python3 -m hymd peptide.toml peptide.HDF5
+
+
+

we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook peptide.ipynb.

+
+
+

1.9. SDS

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true +

The last part we introduce is explicit electrostatic interactions through +particle–mesh Ewald. Enabling the electrostatic calculations is done via the +coulombtype keyword. "PIC_Spectral" is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the dielectric_const keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge.

+
+
sds.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 10
+n_steps = 3000
+n_print = 1500
+n_flush =
+time_step = 0.01
+box_size = [8.3, 8.3, 8.3]
+start_temperature = 298
+target_temperature = 298
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.1
+domain_decomposition = 10000
+cancel_com_momentum = true
+max_molecule_size = 5
+thermostat_coupling_groups = [
+  ["S", "C"],
+  ["W", "Na"],
+]
+dielectric_const = 45.0              # dielectric constant for the simulation medium
+coulombtype = "PIC_Spectral"         # particle in cloud, spectral method
+
+[field]
+mesh_size = [64, 64, 64]
+sigma = 0.5
+chi = [
+  ["S", "C",  13.50],
+  ["S", "Na",  0.00],
+  ["S", "W",  -3.60],
+  ["C", "Na", 13.50],
+  ["C", "W",  33.75],
+  ["W", "Na",  0.00],
+]
+
+[bonds]
+bonds = [
+  ["S",   "C",   0.50, 1250.0],
+  ["C",   "C",   0.50, 1250.0],
+]
+angle_bonds = [
+  ["S", "C", "C", 170.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

An input structure/topology file sds.HDF5 with a couple thousand +randomly dispersed SDS chains is available in the HyMD-tutorial/sds github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a /charge dataset. +Running the simulation with

+
python3 -m hymd sds.toml sds.HDF5
+
+
+

we observe the aggregation of the SDS into micellular structures—first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook sds.ipynb.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/doc_pages/filtering.html b/v1.0.6/doc_pages/filtering.html new file mode 100644 index 00000000..e74140e2 --- /dev/null +++ b/v1.0.6/doc_pages/filtering.html @@ -0,0 +1,299 @@ + + + + + + + 2. Filtering — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Filtering

+

The default grid-independent filter function used in HyMD is a Gaussian

+
+\[H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right]\]
+

with reciprocal space representation

+
+\[\hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right].\]
+

The coarse-graining parameter \(\sigma\) determines a length scale of +particle extent and is given as configuration file input by

+
sigma = 0.75
+
+
+
+

2.1. Implementing new filters

+

Implementing new filter functions is straightforward by hijacking +the setup method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/doc_pages/installation.html b/v1.0.6/doc_pages/installation.html new file mode 100644 index 00000000..d0f87529 --- /dev/null +++ b/v1.0.6/doc_pages/installation.html @@ -0,0 +1,407 @@ + + + + + + + 1. Installation — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Installation

+

HyMD may be installed using pip by

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+
+

1.1. Dependencies

+

HyMD requires a working MPI compiler and HDF5. On an Ubuntu system, this +may be installed via

+
sudo apt-get update -y
+sudo apt-get install -y libhdf5-openmpi-dev python3-mpi4py
+CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-cache-dir --no-binary=h5py h5py
+
+
+

It is highly recommended to have MPI-enabled HDF5 and h5py. A +non-MPI-enabled h5py may be installed by simply

+
sudo apt-get update -y
+sudo apt-get install libhdf5-serial-dev
+python3 -m pip --upgrade install h5py
+
+
+

A non-MPI-enabled HDF5 library with corresponding h5py will work +(mostly), but is inconvenient and slow. Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +--disable-mpio argument to HyMD, see Command line arguments. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial.

+
+
+

1.2. Install in docker

+

A docker image with build essentials setup is available at dockerhub with tag +mortele/hymd,

+
docker pull mortele/hymd:latest
+docker run -it mortele/hymd
+/app$ python3 -m pip install hymd
+
+# Grab example input files
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5
+
+# Run simulation
+/app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose
+
+
+
+
+

1.3. Run interactively in Google Colaboratory

+

A Google Colaboratory jupyter notebook is setup here with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons.

+
+
+

1.4. Common issues

+
+

1.4.1. Numpy errors while importing the Fortran force kernels

+
RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd
+
+Traceback (most recent call last):
+
+  (...)
+
+File "/..../HyMD/hymd/__init__.py", line 2, in <module>
+  from .main import main  # noqa: F401
+File "/..../HyMD/hymd/main.py", line 10, in <module>
+  from .configure_runtime import configure_runtime
+File "/..../hymd/configure_runtime.py", line 12, in <module>
+  from .input_parser import read_config_toml, parse_config_toml
+File "/..../HyMD/hymd/input_parser.py", line 12, in <module>
+  from .force import Bond, Angle, Dihedral, Chi
+File "/..../HyMD/hymd/force.py", line 8, in <module>
+  from force_kernels import (  # noqa: F401
+ImportError: numpy.core.multiarray failed to import
+
+
+

can normally be fixed by updating numpy versions,

+
python3 -m pip install -U numpy
+
+
+
+
+

1.4.2. Error building pfft-python due to missing curl/wget

+
Building wheel for pfft-python (setup.py) ... error
+ERROR: Command errored out with exit status 1:
+command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_
+cwd: /tmp/pip-install-fr6nt9m4/pfft-python/
+Complete output (56 lines):
+running bdist_wheel
+running build
+running build_py
+
+  (...)
+
+curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found
+wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found
+Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+Please check curl or wget
+You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/
+Traceback (most recent call last):
+  File "<string>", line 1, in <module>
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in <module>
+    setup(
+  File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup
+    return distutils.core.setup(**attrs)
+  File "/usr/lib/python3.8/distutils/core.py", line 148, in setup
+
+  (...)
+
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions
+    build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:]))
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft
+    raise ValueError("could not build fftw; check MPICC?")
+ValueError: could not build fftw; check MPICC?
+----------------------------------------
+ERROR: Failed building wheel for pfft-python
+Running setup.py clean for pfft-python
+Failed to build pfft-python
+
+
+

can be fixed by installing either curl or wget

+
apt-get install -y curl wget
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/doc_pages/interaction_energy_functionals.html b/v1.0.6/doc_pages/interaction_energy_functionals.html new file mode 100644 index 00000000..0e72b48f --- /dev/null +++ b/v1.0.6/doc_pages/interaction_energy_functionals.html @@ -0,0 +1,352 @@ + + + + + + + 1. Interaction energy functionals — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Interaction energy functionals

+

A few interaction energy functionals \(W\) are defined in HyMD through +the Hamiltonian class and associated subclasses.

+
+

1.1. \(\chi\)–interaction and \(\kappa\)–incompressibility

+

The most common hPF energy functional is specified by

+
hamiltonian = "DefaultWithChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where \(\tilde\chi_{\text{A}-\text{B}}\) is the interaction energy between +overlapping densities of particle types \(\text{A}\) and \(\text{B}\). +The incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\tilde\chi\) +and \(\kappa\) in the configuration file (see Configuration file)

+
kappa = 0.05
+chi = [
+   ["A", "B", 15.85],
+   ["B", "C", -5.70],
+   ...
+]
+
+
+
+
+

1.2. Only \(\kappa\)–incompressibility

+

The only \(\kappa\) interactions energy functional is specified by

+
hamiltonian = "DefaultNoChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where the incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.3. Only \(\phi^2\)

+

The \(\phi^2\) interactions energy functional is specified by

+
hamiltonian = "SquaredPhi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2,\]
+

where the \(\phi\) squared term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.4. Implementing new interaction energy forms

+

Implementing new interaction energy functions is straightforward by subclassing +Hamiltonian and applying sympy differentiation to the symbolic +field objects. The sympy.lamdify function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/doc_pages/intramolecular_bonds.html b/v1.0.6/doc_pages/intramolecular_bonds.html new file mode 100644 index 00000000..5c25fce8 --- /dev/null +++ b/v1.0.6/doc_pages/intramolecular_bonds.html @@ -0,0 +1,392 @@ + + + + + + + 2. Intramolecular bonds — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Intramolecular bonds

+

Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see Configuration file. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +Benchmarks), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable.

+

All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]).

+
+

2.1. Two-particle bonds

+

Stretching bonds in HyMD are implemented as harmonic spring potentials,

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2,\]
+

where \(r=|\mathbf{r}|\) is the inter-particle distance, \(k\) is a +constant of dimension energy (units \(\text{kJ}\,\text{mol}^{-1}\)), and +\(r_0\) is the equilibrum length of the bond (units: \(\text{nm}\)). The +force is calculated as

+
+\[F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r},\]
+

where \(\mathbf{r}\) is the vector pointing from \(i\) to \(j\).

+

In the configuration file, two-particle bonds are specified per particle type:

+
+
configuration_two_particle_example.toml
+
[bonds]
+bonds = [
+   ["A", "A", 0.47, 1250.0],
+   ["A", "B", 0.37,  940.0],
+   ["B", "C", 0.50, 1010.0],
+   ["C", "A", 0.42,  550.0],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.2. Three-particle bonds

+

Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle–particle–particle angle \(\theta\),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2,\]
+

where \(k\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\)), and \(\theta_0\) is the equilibrum +angle of the bond (units: \({}^\circ\)). Defining the particles with labels +\(a\), \(b\), and \(c\), let \(\mathbf{r}_a\) denote the vector +pointing from \(b\) to \(a\), and correspondingly let +\(\mathbf{r}_c\) point from \(b\) to \(c\). The +\(a\)\(b\)\(c\) may be computed through the law of Cosines,

+
+\[\theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right]\]
+

Then the force acting on \(a\) and \(c\) is

+
+\[ \begin{align}\begin{aligned}\mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a},\\\mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c},\end{aligned}\end{align} \]
+

and

+
+\[\mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c\]
+

In the configuration file, three-particle bonds are specified per particle type:

+
+
configuration_three_particle_example.toml
+
[bonds]
+angle_bonds = [
+   ["A", "A", "A", 180.0, 90.0],
+   ["A", "B", "A", 120.0, 55.0],
+   ["B", "C", "C",  30.0, 10.0],
+   ["C", "A", "B", 110.0, 25.5],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.3. Four-particle bonds

+

Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle \(\phi\) between the +\(a\)\(b\)\(c\) and \(b\)\(c\)\(d\) planes, for +a dihedral bond quartet \(a\), \(b\), \(c\), and \(d\). The +potential takes the form

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n),\]
+

where \(c_n\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)), and \(\phi_n\) are +specified phase angles in the cosine series.

+

In the configuration file, four-particle bonds are specified per particle type:

+
+
configuration_four_particle_example.toml
+
[bonds]
+dihedrals = [
+   ["A", "B", "C", "D"],
+   [
+     [-1],
+     [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+     [0.08, 0.46, 1.65, -0.96, 0.38],
+   ],
+   [1.0],
+]
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/doc_pages/overview.html b/v1.0.6/doc_pages/overview.html new file mode 100644 index 00000000..b56546a2 --- /dev/null +++ b/v1.0.6/doc_pages/overview.html @@ -0,0 +1,413 @@ + + + + + + + 2. Usage overview for HylleraasMD — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Usage overview for HylleraasMD

+

HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a toml format configuration file, along with a topology and structure +file specifying the input system in HDF5 format.

+

Configuration file

+

The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a [5, 5, 5] nm simulation box at 300 K may look like +the following:

+
+
config_simple_1.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "SquaredPhi"         # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [30, 30, 30]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+
+
+
+

Note that for the version 1.0 release of HyMD, the [particles], +[simulation], and [field] groups are optional specifiers for +structuring the configuration file.

+

For a full specification of every recognised configuration keyword in HyMD, +please refer to Configuration file.

+

Topology and structure file

+

The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +N particles may look like the following:

+
+
example_structure.HDF5
+
group   /
+   # root group
+
+dataset /coordinates
+   # float32, shape (T, N, D,)
+   # Time steps of N rows of D dimensional coordinate data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /velocities
+   # float32, shape (T, N, D,) OPTIONAL
+   # Time steps of N rows of D dimensional velocity data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /bonds
+   # int32,   shape (N, B,)    OPTIONAL
+   # Each row i contains indices of the particles bonds from/to i
+   # B denotes the maximum bonds per particle
+
+dataset /indices
+   # int32,   shape (N,)
+   # Index of each particle, 0--(N-1)
+
+dataset /molecules
+   # int32,   shape (N,)
+   # Index of molecule each particle belongs to
+   # Used to construct bond network locally on MPI ranks
+
+dataset /names
+   # str10,   shape (N,)
+   # Fixed size string array containing particle type names
+
+dataset /types
+   # int32,   shape (N,)       OPTIONAL
+   # Mapping of particle names to type indices
+
+
+
+

For a full specification of the topology and structure input file, see +Topology and structure file.

+

Command line arguments

+

A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the config_simple_1.toml and example_structure.HDF5 +files may look like the following:

+
mpirun -n ${MPI_NUM_RANKS} python3 -m hymd         \  # HyMD executable
+                           config_simple_1.toml    \  # configuration file
+                           example_structure.HDF5  \  # structure file
+                           --logfile=log_out.txt   \  # set logfile path
+                           --seed 123456           \  # set random seed
+                           --verbose 2             \  # set logging verbosity
+                           --velocity-output          # enable velocity in trajectory output
+
+
+

For a full specification of all command line arguments, see +Command line arguments.

+

More examples

+

For more thorough rundown and concrete usage examples, see +Examples.

+
+

2.1. Running parallel simulations

+

Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the only difference being how the python3 interpreter is +invoked. Prepending mpirun -n ${NPROCS} to the usual +python3 -m hymd runs the simulation with ${NPROCS} MPI ranks.

+

Inputting

+
mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field
+
+
+

sets up an example simulation of the HyMD-tutorial/ideal_gas system. For +more details about this system in particular, or other example simulations, see +the HyMD-tutorial repository.

+
+
+

2.2. Running tests

+

Run serial code tests by

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd
+cd hymd/
+python3 -m pip install pytest pytest-mpi
+python3 -m pytest
+
+
+

There is a small convenience script in hymd/ for running the MPI-enabled +tests,

+
chmod +x pytest-mpi
+./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/doc_pages/theory.html b/v1.0.6/doc_pages/theory.html new file mode 100644 index 00000000..5d161d1f --- /dev/null +++ b/v1.0.6/doc_pages/theory.html @@ -0,0 +1,355 @@ + + + + + + + 1. Theory — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Theory

+

Hybrid particle–field simulations switch out the ordinary particle–particle +Lennard-Jones interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle–field densities are +defined as

+
+\[\phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i),\]
+

where \(\mathbf{r}\) is a spatial coordinate, \(P\) is a window function +used to distribute particle number densities onto a computational grid, and +\(\mathbf{r}_i\) is the position of particle \(i\) (of total \(N\)). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of \(N\) particles in \(M\) molecules is

+
+\[\mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})]\]
+

with \(H_0\) being a standard intramolecular Hamiltonian form (see +Intramolecular bonds) including kinetic terms, while \(W\) is a density +dependent interaction energy functional.

+

In the Hamiltonian hPF-MD formalism [Bore and Cascella, 2020], the density +field is filtered using a grid-independent filtering function \(H\),

+
+\[\tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}).\]
+

The filter smooths the density, ensuring that \(\tilde\phi\) and +\(W[\tilde\phi([\phi])]\) both converge as the grid size is reduced.

+
+

1.1. External potential

+

The external potential acting on a particle is defined as the functional +derivative of \(W\) with respect to \(\phi\). In the filtered formalism, +the potential takes the form

+
+\[\begin{split}V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ +&= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})},\end{split}\]
+

under the assumption of a local form of the interaction energy functional, +\(W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]\). Note +that

+
+\[\frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}).\]
+
+
+

1.2. Force interpolation

+

The forces on particle \(i\) are obtained by differentiation of the external +potential,

+
+\[\mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i).\]
+
+
+

1.3. Reciprocal space calculations

+

The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density \(\phi_{ijk}\) with CIC, we apply the filtering +and obtain the discrete version of the external potential by

+
+\[\tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big]\]
+

and

+
+\[V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+

The forces are obtained by differentiation of \(V\) in Fourier space as

+
+\[\nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+
+
+

1.4. Filter

+

By default, the filter used in HyMD is a simple Gaussian of the form

+
+\[\begin{split}H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ +\hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right].\end{split}\]
+

For more details about the filtering, see Filtering.

+
+
+

1.5. Hamiltonian form

+

The default form of the interaction energy functional in HyMD is

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2.\]
+

See Interaction energy functionals for details.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/doc_pages/topology_input.html b/v1.0.6/doc_pages/topology_input.html new file mode 100644 index 00000000..b7733249 --- /dev/null +++ b/v1.0.6/doc_pages/topology_input.html @@ -0,0 +1,336 @@ + + + + + + + 4. Topology and structure file — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Topology and structure file

+

The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root / group.

+

The HyMD-tutorial has multiple examples of structure files for various levels +of complexity.

+
+

4.1. Required datasets

+
+
/coordinates:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/indices:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/names:
+

array shape [N,]

+

datatype [string (length between 1 and 16)]

+

The shape represents one particle name per N particles. The datatype may be a string of length =<16.

+
+
+
+
+

4.2. Optional datasets

+
+
/velocities:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/types:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle type index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/molecules:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one molecule index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/bonds:
+

array shape [N, B,]

+

datatype [int32 or int64]

+

The shape represents B bond specifications (indices of different particles) per N particles. The data type may be either 32 or 64 bit integers.

+
+
/charge:
+

array shape [N,]

+

datatype [float32 or float64]

+

The shape represents one particle charge per N particles. The data type may be either four or eight byte reals.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/genindex.html b/v1.0.6/genindex.html new file mode 100644 index 00000000..034c7962 --- /dev/null +++ b/v1.0.6/genindex.html @@ -0,0 +1,814 @@ + + + + + + Index — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + +
+ +

F

+ + + +
+ +

G

+ + +
+ +

H

+ + + +
    +
  • + hymd.input_parser + +
  • +
  • + hymd.integrator + +
  • +
  • + hymd.thermostat + +
  • +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/index.html b/v1.0.6/index.html new file mode 100644 index 00000000..8b7d6e25 --- /dev/null +++ b/v1.0.6/index.html @@ -0,0 +1,400 @@ + + + + + + + HylleraasMD documentation — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

HylleraasMD documentation

+
+
Release:
+

1.0.6

+
+
Date:
+

Mar 09, 2022

+
+
+

HylleraasMD (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems.

+

HyMD can run canonical hPF-MD simulations [Milano and Kawakatsu, 2009], or filtered +density Hamiltonian hPF (HhPF-MD) simulations [Bore and Cascella, 2020], with +or without explicit PME electrostatic interactions [Kolli et al., 2018]. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +[Bore et al., 2018, Cascella et al., 2008]. Martini +style elastic networks (ElNeDyn) [Periole et al., 2009] are also +supported.

+

HyMD uses the pmesh (github.com/rainwoodman/pmesh) library for particle-mesh +operations, with the PPFT [Pippig, 2013] backend for FFTs through the +pfft-python bindings (github.com/rainwoodman/pfft-python). File IO is done +via HDF5 formats to allow MPI parallel reads.

+
+

User Guide

+

The HylleraasMD User Guide provides comprehensive information on how to run +simulations. Selected Examples are available to guide new users.

+
+
+

Installing HyMD

+

The easiest approach is to install using pip:

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+

For more information and required dependencies, see +Installation.

+
+

Run in Google colab

+

Run HyMD interactively in Google Colaboratory jupyter notebook here.

+
+
+
+

Source Code

+

Source code is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the GNU Lesser General Public +License v3.0. Obtain the source code with git:

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git
+
+
+
+
+

Development

+

HyMD is developed and maintained by researchers at the Hylleraas Centre for +Quantum Molecular Sciences at the University of Oslo.

+

pic1 pic2

+
+
+

References

+
+
+[BC20] +

Sigbjørn Løland Bore and Michele Cascella. Hamiltonian and alias-free hybrid particle–field molecular dynamics. J. Chem. Phys., 153(9):094106, 2020. doi:10.1063/5.0020733.

+
+
+[BMC18] +

Sigbjørn Løland Bore, Giuseppe Milano, and Michele Cascella. Hybrid particle-field model for conformational dynamics of peptide chains. J. Chem. Theory Comput., 14(2):1120–1130, 2018. doi:10.1021/acs.jctc.7b01160.

+
+
+[BDP07] +

Giovanni Bussi, Davide Donadio, and Michele Parrinello. Canonical sampling through velocity rescaling. J. Chem. Phys., 126(1):014101, 2007. doi:10.1063/1.2408420.

+
+
+[CNCDP08] +

Michele Cascella, Marilisa A. Neri, Paolo Carloni, and Matteo Dal Peraro. Topologically based multipolar reconstruction of electrostatic interactions in multiscale simulations of proteins. J. Chem. Theory Comput., 4(8):1378–1385, 2008. doi:10.1021/ct800122x.

+
+
+[KDNB+18] +

Hima Bindu Kolli, Antonio De Nicola, Sigbjørn Løland Bore, Ken Schäfer, Gregor Diezemann, Jürgen Gauss, Toshihiro Kawakatsu, Zhong-Yuan Lu, You-Liang Zhu, Giuseppe Milano, and Michele Cascella. Hybrid particle-field molecular dynamics simulations of charged amphiphiles in an aqueous environment. J. Chem. Theory Comput., 14(9):4928–4937, 2018. doi:10.26434/chemrxiv.6264644.v1.

+
+
+[LBC20] +

Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Automated determination of hybrid particle-field parameters by machine learning. Mol. Phys., 118(19-20):e1785571, 2020. doi:10.1080/00268976.2020.1785571.

+
+
+[MK09] +

Giuseppe Milano and Toshihiro Kawakatsu. Hybrid particle-field molecular dynamics simulations for dense polymer systems. J. Chem. Phys., 130(21):214106, 2009. doi:10.1063/1.3142103.

+
+
+[PCMC09] +

Xavier Periole, Marco Cavalli, Siewert-Jan Marrink, and Marco A Ceruso. Combining an elastic network with a coarse-grained molecular force field: structure, dynamics, and intermolecular recognition. Journal of chemical theory and computation, 5(9):2531–2543, 2009. doi:10.1021/ct9002114.

+
+
+[Pip13] +

Michael Pippig. Pfft: an extension of fftw to massively parallel architectures. SIAM J. Sci. Comput., 35(3):C213–C236, 2013. doi:10.1137/120885887.

+
+
+[TBM92] +

MBBJM Tuckerman, Bruce J Berne, and Glenn J Martyna. Reversible multiple time scale molecular dynamics. J. Chem. Phys., 97(3):1990–2001, 1992. doi:10.1063/1.463137.

+
+
+
+
+
+

Indices and tables

+ +
+
+
+
+
+
+
+
+
+ + + +
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+ + + + + +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/objects.inv b/v1.0.6/objects.inv new file mode 100644 index 00000000..95ab8f6d Binary files /dev/null and b/v1.0.6/objects.inv differ diff --git a/v1.0.6/py-modindex.html b/v1.0.6/py-modindex.html new file mode 100644 index 00000000..0bc0f5f4 --- /dev/null +++ b/v1.0.6/py-modindex.html @@ -0,0 +1,322 @@ + + + + + + Python Module Index — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ h +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ h
+ hymd +
    + hymd.field +
    + hymd.file_io +
    + hymd.force +
    + hymd.input_parser +
    + hymd.integrator +
    + hymd.thermostat +
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.6/search.html b/v1.0.6/search.html new file mode 100644 index 00000000..a40e5a6d --- /dev/null +++ b/v1.0.6/search.html @@ -0,0 +1,292 @@ + + + + + + Search — hymd 1.0.6 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.6 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v1.0.6/searchindex.js b/v1.0.6/searchindex.js new file mode 100644 index 00000000..57fc8f2f --- /dev/null +++ b/v1.0.6/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["doc_pages/api","doc_pages/benchmarks","doc_pages/command_line","doc_pages/config_file","doc_pages/constants_and_units","doc_pages/electrostatics","doc_pages/examples","doc_pages/filtering","doc_pages/installation","doc_pages/interaction_energy_functionals","doc_pages/intramolecular_bonds","doc_pages/overview","doc_pages/theory","doc_pages/topology_input","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,"sphinxcontrib.bibtex":9,sphinx:56},filenames:["doc_pages/api.rst","doc_pages/benchmarks.rst","doc_pages/command_line.rst","doc_pages/config_file.rst","doc_pages/constants_and_units.rst","doc_pages/electrostatics.rst","doc_pages/examples.rst","doc_pages/filtering.rst","doc_pages/installation.rst","doc_pages/interaction_energy_functionals.rst","doc_pages/intramolecular_bonds.rst","doc_pages/overview.rst","doc_pages/theory.rst","doc_pages/topology_input.rst","index.rst"],objects:{"hymd.field":{compute_field_and_kinetic_energy:[0,1,1,""],compute_field_energy_q_GPE:[0,1,1,""],compute_field_force:[0,1,1,""],compute_self_energy_q:[0,1,1,""],domain_decomposition:[0,1,1,""],initialize_pm:[0,1,1,""],update_field:[0,1,1,""],update_field_force_q:[0,1,1,""],update_field_force_q_GPE:[0,1,1,""]},"hymd.file_io":{OutDataset:[0,2,1,""],distribute_input:[0,1,1,""],setup_time_dependent_element:[0,1,1,""],store_data:[0,1,1,""],store_static:[0,1,1,""]},"hymd.file_io.OutDataset":{close_file:[0,3,1,""],flush:[0,3,1,""],is_open:[0,3,1,""]},"hymd.force":{Angle:[0,2,1,""],Bond:[0,2,1,""],Chi:[0,2,1,""],Dielectric_type:[0,2,1,""],Dihedral:[0,2,1,""],compute_angle_forces__plain:[0,1,1,""],compute_bond_forces__plain:[0,1,1,""],compute_dihedral_forces__plain:[0,1,1,""],dipole_forces_redistribution:[0,1,1,""],find_all_paths:[0,1,1,""],prepare_bonds:[0,1,1,""],prepare_bonds_old:[0,1,1,""],prepare_index_based_bonds:[0,1,1,""],propensity_potential_coeffs:[0,1,1,""]},"hymd.force.Angle":{atom_3:[0,4,1,""]},"hymd.force.Bond":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],equilibrium:[0,4,1,""],strength:[0,4,1,""]},"hymd.force.Chi":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],interaction_energy:[0,4,1,""]},"hymd.force.Dielectric_type":{atom_1:[0,4,1,""],dielectric_value:[0,4,1,""]},"hymd.force.Dihedral":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],atom_3:[0,4,1,""],atom_4:[0,4,1,""],coeffs:[0,4,1,""],dih_type:[0,4,1,""]},"hymd.hamiltonian":{DefaultNoChi:[0,2,1,""],DefaultWithChi:[0,2,1,""],Hamiltonian:[0,2,1,""],SquaredPhi:[0,2,1,""]},"hymd.hamiltonian.DefaultNoChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.DefaultWithChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.Hamiltonian":{__init__:[0,3,1,""],_setup:[0,3,1,""]},"hymd.hamiltonian.SquaredPhi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.input_parser":{Config:[0,2,1,""],check_NPT_conditions:[0,1,1,""],check_angles:[0,1,1,""],check_bonds:[0,1,1,""],check_box_size:[0,1,1,""],check_cancel_com_momentum:[0,1,1,""],check_charges:[0,1,1,""],check_charges_types_list:[0,1,1,""],check_chi:[0,1,1,""],check_config:[0,1,1,""],check_dielectric:[0,1,1,""],check_dihedrals:[0,1,1,""],check_domain_decomposition:[0,1,1,""],check_hamiltonian:[0,1,1,""],check_integrator:[0,1,1,""],check_m:[0,1,1,""],check_mass:[0,1,1,""],check_max_molecule_size:[0,1,1,""],check_n_b:[0,1,1,""],check_n_flush:[0,1,1,""],check_n_particles:[0,1,1,""],check_n_print:[0,1,1,""],check_name:[0,1,1,""],check_start_and_target_temperature:[0,1,1,""],check_tau:[0,1,1,""],check_thermostat_coupling_groups:[0,1,1,""],parse_config_toml:[0,1,1,""],read_config_toml:[0,1,1,""],sort_dielectric_by_type_id:[0,1,1,""]},"hymd.input_parser.Config":{a:[0,4,1,""],angle_bonds:[0,4,1,""],barostat:[0,4,1,""],barostat_type:[0,4,1,""],bonds:[0,4,1,""],box_size:[0,4,1,""],cancel_com_momentum:[0,4,1,""],chi:[0,4,1,""],conv_crit:[0,4,1,""],convergence_type:[0,4,1,""],coulomb_constant:[0,4,1,""],coulombtype:[0,4,1,""],dielectric_const:[0,4,1,""],dielectric_type:[0,4,1,""],dihedrals:[0,4,1,""],domain_decomposition:[0,4,1,""],dtype:[0,4,1,""],file_name:[0,4,1,""],gas_constant:[0,4,1,""],hamiltonian:[0,4,1,""],initial_energy:[0,4,1,""],integrator:[0,4,1,""],kappa:[0,4,1,""],m:[0,4,1,""],mass:[0,4,1,""],max_molecule_size:[0,4,1,""],mesh_size:[0,4,1,""],n_b:[0,4,1,""],n_flush:[0,4,1,""],n_particles:[0,4,1,""],n_print:[0,4,1,""],n_steps:[0,4,1,""],name:[0,4,1,""],pol_mixing:[0,4,1,""],pressure:[0,4,1,""],respa_inner:[0,4,1,""],rho0:[0,4,1,""],self_energy:[0,4,1,""],sigma:[0,4,1,""],start_temperature:[0,4,1,""],tags:[0,4,1,""],target_pressure:[0,4,1,""],target_temperature:[0,4,1,""],tau:[0,4,1,""],tau_p:[0,4,1,""],thermostat_coupling_groups:[0,4,1,""],thermostat_work:[0,4,1,""],time_step:[0,4,1,""],type_charges:[0,4,1,""]},"hymd.integrator":{integrate_position:[0,1,1,""],integrate_velocity:[0,1,1,""]},"hymd.logger":{Logger:[0,2,1,""],MPIFilterAll:[0,2,1,""],MPIFilterRoot:[0,2,1,""]},"hymd.logger.Logger":{setup:[0,3,1,""]},"hymd.logger.MPIFilterAll":{filter:[0,3,1,""]},"hymd.logger.MPIFilterRoot":{filter:[0,3,1,""]},"hymd.thermostat":{_random_chi_squared:[0,1,1,""],_random_gaussian:[0,1,1,""],csvr_thermostat:[0,1,1,""]},hymd:{field:[0,0,0,"-"],file_io:[0,0,0,"-"],force:[0,0,0,"-"],input_parser:[0,0,0,"-"],integrator:[0,0,0,"-"],thermostat:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0020733":14,"00268976":14,"0083144621":0,"01036426965":4,"014101":[0,14],"02214076":4,"03642696562":4,"03970":6,"08790868":[6,10],"094106":14,"0xd":8,"0xe":8,"100":[4,6,11],"1000":6,"10000":6,"10001":6,"1010":10,"1021":14,"1063":14,"1080":14,"10nm":6,"110":10,"1120":[0,14],"1130":[0,14],"1137":14,"118":14,"120":[3,6,10],"120885887":14,"120ff":0,"123456":11,"1250":[3,6,10],"126":[0,14],"130":14,"1378":14,"138":[0,4],"1385":14,"144":8,"148":8,"1500":6,"153":14,"170":6,"1785571":14,"179":0,"180":[3,6,10],"1974":0,"1981":0,"1990":14,"1992":[3,14],"200":[6,10],"2000":6,"2001":14,"2007":[0,3,14],"2008":[0,14],"2009":14,"201":[0,3],"2013":14,"2018":[0,14],"2020":[5,6,12,14],"2022":14,"20nm":6,"214106":14,"223":0,"224":1,"2408420":14,"2408724":[6,10],"246":0,"251":[6,10],"2531":14,"2543":14,"26434":14,"28103735":0,"298":6,"2_1":0,"2don2d":8,"2nd":0,"300":[6,11],"3000":6,"3142103":14,"3144621":4,"323":6,"449":[6,10],"463137":14,"48626121":[6,10],"4928":14,"4937":14,"533":1,"544":[6,10],"550":10,"59427866":[6,10],"602176634":4,"610":[6,10],"6264644":14,"66053906660":4,"7b01160":14,"85418781281":4,"935458":[0,4],"940":10,"96924":6,"980":3,"9918564":[6,10],"boolean":3,"byte":13,"case":[0,3,6,10],"class":[0,9],"default":[0,3,7,11,12,13],"float":[0,3],"function":[0,3,5,6,7,11,12],"int":[0,5,6,9,12],"long":[5,6],"new":[0,10,13,14],"public":14,"return":[0,8],"short":[6,11],"sigbj\u00e3":14,"static":0,"switch":12,"true":[0,3,6],"while":[0,12],Adding:6,For:[0,11,12,14],The:[0,3,5,6,7,9,10,11,12,13,14],Then:10,There:11,These:0,Used:[0,3,11],Using:[6,9],With:[0,6],__file__:8,__init__:[0,8],_gener:0,_random_chi_squar:0,_random_gaussian:0,_setup:0,about:[3,11,12],abov:[0,6],absent:0,acceler:0,accompani:6,accord:[0,3],accur:14,acid:6,across:[0,3],acs:14,act:[0,10,12],adapt:0,add:[5,6],added:0,adding:6,addison:0,addit:[0,2,5,11],addition:14,additon:0,adher:0,affect:0,affili:[0,2],after:[0,10,12],against:8,aggreg:6,ahren:0,alanin:6,algorithm:[0,3,12],alia:14,all:[0,2,3,4,6,8,10,11,14],all_nam:0,all_rank:0,alloc:0,allow:[11,14],allreduc:0,along:[6,11],alpha3:8,alpha:0,also:[6,8,14],altern:2,alwai:[0,3],amino:6,amphiphil:14,analyt:0,angl:[0,2,3,6,8,10],angle_bond:[0,3,6,10],angular:[0,3,6,10],ani:[0,2,3],anisotrop:0,antonio:14,apart:0,api:8,app:8,appli:[0,3,7,9,12],applic:0,approach:14,approxim:0,apt:8,aqueou:14,architectur:14,arg:0,argument:[0,6,8,11],argv:8,aris:0,around:10,arrai:[0,3,11,13],arriv:6,art:0,aspect:3,assess:0,assign:[0,3,10],associ:[0,9],assum:3,assumpt:12,atom:0,atom_1:0,atom_2:0,atom_3:0,atom_4:0,attach:13,attempt:0,attr:8,attract:3,attribut:0,autom:14,automat:[0,7,9],avail:[6,8,14],averag:[0,9],avogadro:4,back:[0,5],backbon:[0,2,3,14],backcon:0,backend:14,backmap:0,balanc:0,ballist:6,bar:4,barostat:0,barostat_typ:0,base:[0,14],bath:[0,3],bb_index:0,bc20:14,bdist_wheel:8,bdp07:14,bead:0,becaus:0,becom:0,befor:[0,3,6],being:[0,2,3,5,10,11,12],belong:11,below:6,benchmark:10,bend:[0,3,10,14],bern:14,besid:2,best:0,beta:0,better:0,between:[0,3,5,6,9,10,12,13],bia:0,big:12,bin:8,binari:8,bind:14,bindu:14,bio:14,bit:[0,13],blueprint:0,bmc18:14,boltzmann:[0,3,4],bond2_energi:0,bond3_energi:0,bond4_energi:0,bond:[0,2,6,8,11,12,13],bonds_2:0,bonds_2_atom1:0,bonds_2_atom2:0,bonds_2_atom_1:0,bonds_2_atom_2:0,bonds_2_equilibrium:0,bonds_2_strength:0,bonds_3:0,bonds_3_atom_1:0,bonds_3_atom_2:0,bonds_3_atom_3:0,bonds_3_equilibrium:0,bonds_3_strength:0,bonds_4:0,bonds_4_atom_1:0,bonds_4_atom_2:0,bonds_4_atom_3:0,bonds_4_atom_4:0,bonds_4_coeff:0,bonds_4_last:0,bonds_4_typ:0,bool:0,bore:[0,5,12,14],both:[0,12],boundari:[0,3],box:[0,3,6,11],box_siz:[0,3,6,11],breviti:6,broadcast:0,browser:8,bruce:14,buffer:[0,3],build_extens:8,build_pfft:8,build_pi:8,built:8,bussi:[0,3,14],c213:14,c236:14,c_n:[0,6,10],cach:8,calcul:[0,3,6,10],calibr:0,call:[0,8],callabl:0,can:[6,8,14],cancel_com_momentum:[0,3,6],canon:[0,3,14],capabl:2,captur:11,carloni:14,carri:6,cascella:[5,8,11,12,14],caval:14,cbt:0,cdot10:4,cdot:[0,4,10],cell:[0,12],center:[0,3],centr:14,certain:[0,2],ceruso:14,chain:[0,14],chang:[0,3],changedin:0,charg:[0,3,4,5,6,13,14],charge_out:0,check:[0,8],check_angl:0,check_bond:0,check_box_s:0,check_cancel_com_momentum:0,check_charg:0,check_charges_types_list:0,check_chi:0,check_config:0,check_dielectr:0,check_dihedr:0,check_domain_decomposit:0,check_hamiltonian:0,check_integr:0,check_m:0,check_mass:0,check_max_molecule_s:0,check_n_b:0,check_n_flush:0,check_n_particl:0,check_n_print:0,check_nam:0,check_npt_condit:0,check_start_and_target_temperatur:0,check_tau:0,check_thermostat_coupling_group:0,chem:[0,14],chemic:14,chemrxiv:14,chi:[0,3,4,6,8],chi_2:0,chi_3:0,chi_:[0,3,6,9,12],chi_m:0,chmod:11,chosen:0,cic:[0,5,12],circ:[3,10],circumv:12,classmethod:0,classvar:0,clean:[0,8],clone:[11,14],close:[0,8],close_fil:0,closest:0,cloud:[0,6,12],cncdp08:14,coars:[0,3,7,14],code:[0,1,2,3,6,8,11],coeff:0,coeffici:0,coil:[0,6],colab:8,colaboratori:14,collect:[0,13],com:[0,8,11,14],combin:[0,6,14],comm:0,comm_world:0,command:[8,11],common:9,commuic:0,commun:[0,3,10],communc:0,compar:6,compat:2,compil:[0,8],compiler_so:8,complesfield:0,complet:[0,6,8],complex:[6,13],complexfield:0,compon:0,comprehens:14,compress:[0,3,4,6,9,11],comput:[0,5,10,12,14],compute_angle_forces__plain:0,compute_bond_forces__plain:0,compute_dihedral_forces__plain:0,compute_field_and_kinetic_energi:0,compute_field_energy_q_gp:0,compute_field_forc:0,compute_potenti:0,compute_self_energy_q:0,concret:11,condit:6,config:0,config_simple_1:11,configur:[0,2,5,6,7,9,10,11],configuration_four_particle_exampl:10,configuration_three_particle_exampl:10,configuration_two_particle_exampl:10,configure_runtim:8,conform:[6,13,14],connect:0,conserv:1,consid:6,consist:[0,6],consit:6,consitu:0,constant:[0,3,5,6,10],constitut:[0,2,3],construct:[0,10,11],constructor:0,contain:[0,1,2,3,6,11],content:[0,6],contribut:0,control:3,conv_crit:0,conv_fun:0,conveni:11,converg:[0,12],convergence_typ:0,convert:0,coordin:[11,12,13],copi:0,core:8,correct:[0,3],correspond:[0,3,8],correspondingli:10,cos:[0,6,10],cosin:[0,3,6,10],cost:[3,10],could:8,coulomb:[0,3,4,5],coulomb_const:0,coulombtyp:[0,3,5,6],counter:6,coupl:[0,3,6,11],cprofil:2,cpu:[0,10],crash:3,creat:[0,9],critic:[0,6],cross:0,csvr:[0,3],csvr_thermostat:0,ct800122x:14,ct9002114:14,current:6,cwd:8,cython:[8,14],d_n:0,dal:14,data:[0,6,11,13],dataclass:0,dataset:[0,5,6,11],datatyp:13,date:[0,14],date_format:0,david:14,debug:[0,2],decompos:0,decomposit:[0,3,10],default_level:0,defaultnochi:[0,6,9],defaultnohchi:[0,3],defaultwithchi:[0,3,6,9],defin:[0,6,9,10,12],definit:0,degre:3,delta:[0,12],denot:[0,1,3,9,10,11],dens:14,densiti:[0,3,5,9,12,14],depend:[0,6,10,12,14],deprec:0,deriv:[0,12],design:6,dest_directori:0,detail:[2,3,6,11,12],determin:[0,2,7,14],dev:8,develop:6,deviat:[0,3],dict:0,dictat:0,dictionari:0,dielectr:[0,3,6],dielectric_const:[0,3,5,6],dielectric_typ:0,dielectric_valu:0,dieter:0,diezemann:14,differ:[0,3,6,11,13],differenti:[0,5,7,9,12],difficult:2,dih_typ:0,dihedr:[0,2,3,5,6,8,10,14],dimens:[0,10,11,13],dimension:11,dipol:[0,2,3,5,6,14],dipole_forces_redistribut:0,dir:8,direct:[0,3],directori:11,disabl:[2,6,8,11],disable_mpio:0,discard:0,discret:[0,12],discretis:12,disk:[0,3],dispers:6,dist:8,distanc:[0,3,10],distinct:0,distribut:[0,3,5,6,12],distribute_input:0,distutil:8,doc:0,dockerhub:8,dodecyl:6,doe:[0,10],doi:14,domain:[0,3,10],domain_decomposit:[0,3,6],donadio:[0,14],done:[0,6,14],dopc:6,dot:0,dot_elec:0,doubl:2,double_out:0,download:8,dppc:6,draw:0,drawn:0,driver:11,dtype:0,due:[0,3],dump:0,dump_per_particl:0,dure:[0,2,3,10,11],dynam:[0,3,11,12,14],e1785571:14,e_k:0,each:[0,3,6,10,11],easiest:14,effect:[0,3],effici:10,eight:13,either:[0,3,8,13],elast:14,elec:0,elec_field:0,elec_field_contrib:0,elec_field_fouri:0,elec_forc:0,elecrostat:0,electr:[0,4,5],electrosat:0,electrostat:[0,6,14],elnedyn:14,elucid:6,embed:6,emit:0,emploi:0,empti:0,enabl:[2,6,8,11],enclos:0,end:0,energi:[0,1,3,4,6,7,10,11,12],energiesself:0,ensur:[0,3,6,12],entri:3,environ:14,epsilon:0,equal:[0,3,6],equat:0,equilibr:6,equilibrium:[0,3,6],equilibrum:10,equival:[0,3],error:0,essenti:[0,1,8],etc:[2,3],even:[0,3,6,8],event:0,everi:[0,3,6,10,11],evid:0,ewald:[0,5,6],examin:6,exampl:[3,8,11,13,14],example_structur:11,except:10,exchang:[0,3],exec:8,execut:[0,8,11],exist:0,exit:8,exp:[7,12],expand:0,expans:0,expect:0,expens:[3,12],explicit:[0,6,10,14],express:0,ext:0,extend:6,extens:14,extent:[0,7],extern:0,extract:0,f401:8,f_angl:0,f_bond:0,f_dihedr:0,f_dipol:0,f_on_bead:0,factor:0,factori:0,fail:[0,8],fals:[0,3,6],fashion:[0,3],fast:12,fer:14,few:[6,9,10,11],fft:[0,1,2,3,5,6,11,12,14],fftw3:8,fftw:[8,14],field:[2,4,5,6,9,11,12,14],field_energi:0,field_list:0,field_q_energi:0,field_q_self_energi:0,file:[2,5,6,7,8,9,10,11,14],file_io:0,file_nam:0,file_path:0,filter:[0,3,5,6,11,14],find:0,find_all_path:0,first:[0,3,6,11],five:0,fix:[0,8,11],flag:[0,13],flat:11,float32:[11,13],float64:13,flori:0,fluctuat:0,flush:[0,3],follow:[0,2,3,4,6,11],forc:[2,3,4,5,6,10,14],force_kernel:8,force_mesh:0,force_mesh_elec:0,force_mesh_elec_fouri:0,force_out:0,forego:2,form:[0,5,10],formal:[5,12],format:[0,2,3,5,11,13,14],formatt:0,fortran:[0,10],forward:0,found:[5,8],four:[0,2,3,6,13],fourier:[0,5,12],fr6nt9m4:8,frac:[0,5,6,7,9,10,12],frame:[0,11,13],free:14,frequenc:[0,3],from:[0,2,3,5,6,8,9,10,11,14],full:[0,9,11],fulli:[0,6,8],fundament:11,gamma:0,gamma_0:0,gas:[0,4],gas_const:0,gather:0,gauss:14,gaussian:[0,3,7,12],gener:[0,2,3,6,14],get:8,getattr:8,ghost:0,giovanni:14,git:[11,14],github:[6,8,11,14],githubusercont:8,giusepp:14,given:[0,3,6,7],glenn:14,global:0,gnu:14,govern:9,gpe:0,grab:8,gradient:0,grain:[0,3,7,14],graph:0,gregor:14,grid:[0,1,3,5,6,7,11,12],group:[0,3,6,8,11,13,14],guess:0,gyrat:6,h5md:[0,3],h5py:[0,2,8],h_0:[6,12],half:0,hamiltonian:[3,5,6,7,9,11,14],handl:0,handler:0,happen:10,harmon:[0,3,6,10],has:[0,3,13],hat:[7,12],have:[0,6,8],hdf5:[0,2,3,5,6,8,11,13,14],hdf5_mpi:8,head:6,heat:[0,3],helic:[0,3,5,6],help:6,helper:0,here:[0,6,8,14],hhpf:14,highli:[8,10,11],hijack:7,hima:14,hire:1,homogen:0,homopolym:1,homopolypeptid:6,how:[3,11,14],howev:6,hpf:[3,5,9,11,12,14],html:0,http:[0,8,11,14],huggin:0,hundr:[6,10],hybrid:[11,12,14],hylleraa:14,hymd:[0,2,3,4,5,6,7,8,9,10,11,12,13],ideal:10,ideal_chain:[6,8],ideal_ga:[6,11],ident:0,ignor:0,ijk:[5,12],imag:8,impact:0,implement:[0,10],importerror:8,impuls:[0,3],in_fil:0,includ:[0,2,3,6,12,14],incompress:[0,3],inconveni:8,increas:[0,2,6],indentifi:0,independ:[0,3,7,12],index:[0,11,13,14],indic:[0,2,3,10,11,13],indirect:0,individu:[0,3,6],induc:5,infer:10,info:0,inform:[0,10,14],ingredi:6,initi:0,initial_energi:0,initialis:11,initialize_pm:0,inner:[0,3],input:[2,3,4,5,6,7,8,11,13],input_box:0,input_pars:[0,8],insid:[0,3,6],instal:[2,11],install_pfft:8,instantan:0,int32:[11,13],int64:13,integ:[0,3,6,13],integr:[3,6,11],integrate_posit:0,integrate_veloc:0,intend:8,inter:[0,10],interact:[0,2,3,4,6,7,11,12,14],interaction_energi:0,interfac:0,intergr:0,intermediari:0,intermolecular:[6,14],intern:[0,2,4,10],interpol:[0,5],interpret:11,interv:[0,3],intmathrm:0,intracomm:0,intramolecular:[0,3,6,12,14],intrins:5,introduc:6,investig:0,invok:[2,11],involv:[0,3,10],ion:6,ipynb:6,is_open:0,iter:0,j_k:0,jan:14,jctc:14,join:8,jone:12,journal:14,jupyt:[6,8,14],k_e:0,kappa:[0,3,4,6,11,12],kawakatsu:14,kdnb:14,keep:[0,3],kelvin:[0,3,6,11],ken:14,kernel:[0,10],keyword:[0,5,6,11],kinet:[0,12],kinetic_energi:0,knuth:0,kolli:14,kpa:4,label:[1,10],lambda:0,lamdifi:9,land:14,laplacian:0,larg:[8,11],larger:3,last:[6,8,11,13],last_bb:0,later:[0,6],latest:8,law:10,layout:0,layout_q:0,lbc20:14,learn:14,leav:0,ledum:[6,14],left:[0,5,6,7,9,10,12],legend:1,lenght:0,length:[0,3,4,6,7,10,11,13],lennard:12,less:[0,6],lesser:14,let:[0,10],level:[0,2,3,13],liang:14,lib:8,libhdf5:8,librari:[0,2,8,14],licens:14,lieu:0,like:[0,6,11],limit:3,line:[0,8,11],linear:[0,3],lipid_self_assembl:6,list:0,list_coulomb:0,load:0,local:[0,10,11,12],log:[0,2,11],log_fil:0,log_out:11,logfil:[2,11],logger:2,logic:0,logrecord:0,look:[6,11],loop:0,lost:3,low:6,m_j:0,machin:[2,14],made:0,mai:[0,2,3,6,8,10,11,13],main:[0,8,11],maintain:14,make:6,manner:6,manual:8,map:[0,11],mar:14,marco:14,marilisa:14,marrink:14,martini:[6,14],martyna:14,mass:[0,3,4,13],massiv:14,match:0,math:0,mathbf:[0,4,5,6,9,10,12],mathcal:[6,12],mathmr:0,mathrm:[0,5,6,9,10,12],matteo:14,matter:[6,10,14],max_molecule_s:[0,3,6],maximum:[0,3,10,11],maxwel:[0,3],may:2,mbbjm:14,mean:[0,2,3],measur:10,medium:[0,3,6],melt:1,membran:6,memori:0,mesh:[0,1,3,5,6,14],mesh_siz:[0,3,6,11],messag:0,messi:0,meta:6,metadata:0,method:[0,1,6,7],mh_0:12,micellular:6,michael:14,michel:14,might:0,milano:14,mimic:0,minim:6,minuscul:10,mirror:2,mix:[0,6],mk09:14,model:[6,14],modifi:0,modul:[0,3,8,14],mol:[3,4,6,10,11,14],molecul:[0,3,11,12,13],molecular:[2,11,12,14],momenta:[0,11],momentum:[0,3,4],monoatom:6,more:[2,3,6,11,12,14],mortel:8,morten:14,most:[8,9,11,12],mostli:[2,8],motion:[0,6],move:0,mpi4pi:[0,8,14],mpi:[0,2,3,8,10,11,14],mpi_num_rank:11,mpicc:8,mpifilteral:0,mpifilterroot:0,mpio:[2,8],mpirun:11,multiarrai:8,multipl:[0,3,6,11,13,14],multipolar:14,multiscal:14,must:[0,3],n_b:0,n_flush:[0,3,6],n_frame:0,n_particl:[0,3],n_print:[0,3,6,11],n_step:[0,3,6,11],n_type:0,nabla:[0,12],name:[0,2,3,6,10,11,13],nanomet:[0,1],nanosecond:6,ndarrai:0,ne5et1y_:8,necessari:[0,6],necessit:[8,9],need:[0,6],neg:[0,6],neighbour:0,neri:14,network:[0,10,11,13,14],networkx:0,neutralis:6,never:[0,3],nevertheless:3,next:[0,6],nicola:14,non:[0,2,6,8],none:[0,3],nongnu:0,noqa:8,normal:[0,2,3,8,12],notabl:11,note:[0,6,8,11,12],notebook:[6,8,14],now:6,nproc:11,npt:0,nq_i:5,number:[0,1,2,3,6,11,12,13],numer:0,numpi:[0,2,9,14],nvt:0,object:[0,9],oblat:6,observ:[0,6],obtain:[0,5,12,14],obviou:8,off:6,omit:6,onc:[3,10],one:[0,2,3,6,13],onli:[0,6,10,11],onto:[0,3,5,12],open:[0,8],openmpi:8,oper:[0,3,12,14],oppos:0,optim:[0,10],optimis:[6,10],option:[0,3,6,11],order:[0,3,6,10,11],ordinari:[5,12],org:0,organis:6,origin:0,oslo:14,other:[0,11],otherwis:0,out:[8,12],outdataset:0,outer:0,output:[2,3,4,6,8,11],outsid:3,over:0,overlap:[0,9],packag:[8,11,14],page:14,paint:0,paolo:14,paper:0,parallel:[0,2,3,8,14],paramet:[0,3,6,7,9,14],parent_group:0,parllel:0,parrinello:[0,14],pars:[0,3],parse_config_toml:[0,8],part:[5,6,12],partial:0,particl:[0,2,5,6,7,9,11,12,13,14],particlemesh:0,particular:11,path:[0,2,11],pcmc09:14,pdf:1,pencil:0,peptid:[0,2,3,5,14],per:[0,2,3,10,11,13],peraro:14,perfect:0,perform:[0,3,10,11,12],periol:14,perman:[10,14],permitt:[0,4],pfft:[0,14],pfft_build_dir:8,phase:[0,10],phase_separ:6,phi:[0,3,6,10,12],phi_0:[6,9,12],phi_:[0,6,9,12],phi_ep:0,phi_eps_fouri:0,phi_eta:0,phi_eta_fouri:0,phi_fouri:0,phi_k:0,phi_l:0,phi_laplacian:0,phi_n:[6,10],phi_pol:0,phi_pol_prev:0,phi_q:0,phi_q_fouri:0,phi_transf:0,phospholipid:6,phy:[0,14],pic_spectr:[0,3,6],pic_spectral_gp:0,piec:6,pip13:14,pip:[8,11,14],pippig:14,place:[0,3],plain:2,plane:[0,6,10],pleas:[8,11],plume:0,plumed_bia:0,plumed_out:0,pme:14,pmesh:[0,14],png:1,point:[0,1,10,13],poisson:0,pol_mix:0,polar:0,polym:[6,14],posit:[0,2,3,5,6,11,12],possibl:[0,3,6,14],potenti:[0,3,4,5,7,10,14],ppft:14,practic:10,pre:[0,6],precis:[1,2],prefer:3,prepar:0,prepare_bond:0,prepare_bonds_old:0,prepare_index_based_bond:0,prepend:[0,11],present:[0,2,3,6],preserv:3,pressur:[0,4],pretti:8,previou:0,previous:6,prior:[0,3],priovid:0,prng:0,prod_:0,profil:2,program:[0,11],project:5,promot:0,prop:0,propag:[0,3],propens:[0,3,5,6],propensity_potential_coeff:0,properti:3,protein:[0,14],provid:[0,2,3,11,13,14],psi:[0,4,5],psi_:5,psi_fouri:0,pull:8,put:6,pytest:11,python3:[6,8,11,14],python:[0,11,14],q_i:[0,5],q_j:0,quadrat:0,quanit:0,quantiti:[0,4],quantum:14,quartet:10,quess:0,r_0:[0,6,10],r_a:10,r_c:10,rad:[3,10],radial:6,radii:6,radiu:6,rainwoodman:[8,14],rais:[6,8],random:[0,2,11],random_chi_squar:0,random_gaussian:0,randomli:[0,3,6],rang:5,rank0:0,rank:[0,2,3,10,11],rank_rang:0,rankself:0,rare:10,raw:8,read:[0,8,11,14],read_config_toml:[0,8],readout:0,real:13,realfield:0,realist:6,reappli:0,rearrang:0,reason:8,receiv:[0,3],recent:8,reciproc:[0,7],recognis:11,recognit:14,recommend:8,reconstruct:[0,2,5,6,10,14],record:0,recreat:14,recurs:0,redistribut:0,reduc:[3,12],refer:[3,11],regim:6,regul:[0,3],rel:[0,3,6,10],relax:[0,3],releas:[0,6,8,11,14],remain:[0,6],remov:[0,3],remove_center_of_mass_momentum:0,remove_com_momentum:[0,3],replac:[0,8],repositori:[6,11],repres:[0,3,13],represent:7,repuls:3,requir:[0,3,8,10,11,14],rescal:[0,3,14],research:14,respa:[0,3,6],respa_inn:[0,3,6],respect:[0,1,12],restructur:0,result:[0,3,6,9],revers:[0,3,14],rgen:14,rho0:0,rho:[0,5],rho_0:0,rho_:5,right:[0,5,6,7,9,10,12],rightarrow:10,root:[0,11,13],roughi:6,row:11,rrespa:[0,3,6],ruin:0,run:[0,2,3,6,10],rundown:11,runtimeerror:8,same:[0,3,6],sampl:[0,3,14],scalar:0,scale:[0,3,6,7,8,10,11,14],sch:14,scheme:[0,6],sci:14,scienc:14,script:11,sds:6,search:14,second:[0,11],see:[0,2,3,5,6,8,9,10,11,12,14],seed:[2,11],select:[11,14],self:[0,3,8],self_energi:0,seminumer:0,send:[0,3],separ:0,seri:[0,3,6,10],serial:[8,11],serialis:3,set:[0,3,11],setup:[0,6,7,8,13],setup_time_dependent_el:0,setuptool:8,sever:0,shape:[0,6,11,13],sheet:0,shift:0,should:[0,2,10],shown:6,siam:14,siewert:14,sigbj:14,sigma:[0,3,6,7,11,12],sim:0,similar:0,simpl:[0,6,11,12],simplest:6,simpli:[0,8],simul:[0,2,6,8,10,12,13,14],simultan:0,sinc:0,singl:[0,3,6],size:[0,3,6,11,12],slight:0,slow:8,slowli:12,small:[3,11],smear:5,smooth:[0,12],sodium:6,soft:[6,14],solv:0,solvent:6,some:[0,3],sort:0,sort_dielectric_by_type_id:0,sourc:[0,1],space:[0,3,5,7],span:0,spatial:[0,3,11,12],specfi:0,speci:0,special:0,specif:[0,2,3,6,9,10,11,13],specifi:[0,2,3,6,9,10,11,13],spectacularli:0,spectral:6,speed:[0,3],spheric:6,spheroid:6,split:0,spontan:6,spring:[0,10],sqrt:[0,7,12],squar:[0,9],squaredphi:[0,3,9,11],stabil:6,stabl:6,stackoverflow:0,standard:[0,3,12,14],start:[0,3,6,10,13],start_temperatur:[0,3,6],state:0,statu:8,stdout:[0,2],step:[0,3,6,10,11],stiff:3,stochast:0,store:0,store_data:0,store_stat:0,str10:11,str:0,straightforward:[7,9],stream:0,strength:[0,3,6,11],stretch:[0,3,10,14],string:[0,3,8,11,13],structur:[0,2,3,5,6,11,14],style:14,sub:6,subclass:[0,9],subsequ:[0,5,6,10],sudo:8,suitabl:0,sulfat:6,sum:0,sum_:[0,5,9,12],sum_i:0,sum_j:0,sum_k:0,sum_n:[0,6,10],summari:11,superclass:[0,7],support:[0,6,14],swap:10,symbol:[0,4,9],sympi:[0,9],sys:8,system:[0,1,2,3,6,8,9,11,12,14],tag:[0,3,8],take:[0,3,5,9,10,11,12],taken:0,tar:8,target:0,target_pressur:0,target_temperatur:[0,3,6,11],tau:[0,3,6,11],tau_p:0,tbm92:14,temperatur:[0,3,4,6,11],ten:6,term:[0,3,6,9,12],test:[0,1],text:[0,2,3,4,5,6,9,10,12],than:[0,3],theori:[0,14],thermalis:[0,3],thermostat:[2,3,6,11],thermostat_coupling_group:[0,3,6],thermostat_work:0,theta:[6,10],theta_0:[0,6,10],thi:[0,2,3,6,8,9,10,11,12],thorough:11,though:6,thousand:[6,10],three:[0,2,3,6],through:[0,3,6,7,9,10,14],tild:[0,3,4,5,6,9,12],time:[0,3,4,6,10,11,14],time_step:[0,3,6,11],tmp:8,todo:0,togeth:[0,3,6],token:8,toml:[0,2,3,6,8,10,11],toml_cont:0,tomli:0,too:3,toplog:0,topol:0,topolog:[0,2,3,5,6,11,14],torsion:[0,3,10,14],toshihiro:14,total:[0,3,6,11,12],traceback:8,trajectori:[0,2,3,6,11],trans_matric:0,transfer:[0,10],transform:[0,9,12],travers:0,tri:3,truncat:0,tuckerman:[3,14],turn:6,tutori:[6,8,11,13],two:[0,2,3,6],txt:11,type:[0,2,3,5,6,9,10,11,13],type_arrai:0,type_charg:0,type_to_name_map:0,ubuntu:8,uio:[8,11,14],unchang:0,under:[6,12,14],union:0,uniqu:0,unique_nam:0,unit:[0,3,10],univers:14,unknown:0,unless:[0,3],unset:0,unstabl:3,until:6,updat:[0,8],update_field:0,update_field_force_q:0,update_field_force_q_gp:0,upgrad:[8,14],usag:[0,2],use:[0,3,5,6,8],used:[0,1,2,3,6,7,9,11,12,13],uses:[0,4,12,14],using:[0,2,3,8,12,14],usr:8,usual:11,v_2:[0,6,10],v_3:[0,6,10],v_4:[0,6,10],v_ext:0,v_ext_fouri:0,vacuum:4,valid:[0,3],validated_config:0,valu:[0,3,4,5,6,10],valueerror:8,vanish:0,varepsilon:0,varepsilon_0:[4,5],vari:12,variabl:0,variant:6,variou:[0,13],vbar_elec:0,vbar_elec_fouri:0,vector:10,vectoris:9,veloc:[0,2,3,4,6,11,13,14],velocity_out:0,velocti:0,verbos:[0,2,8,11],veri:[6,10],verifi:0,verlet:[0,3,6,11],versa:3,version:[0,6,8,11,12],vert:0,vertex:[0,5],vertic:0,via:[6,8,14],vice:3,vol:0,volum:0,voxel:0,wai:[8,12],warn:0,weakli:3,weight:0,well:6,were:0,weslei:0,wheel:8,when:[0,3,10],where:[0,5,9,10,12],which:[0,2,3,5,6,9,10,11],width:[0,3],window:[0,5,12],without:[0,8,14],work:[0,8],workload:0,would:[0,3],wrap:0,wrapper:0,write:[0,3],written:[0,3],www:0,xavier:14,yield:6,you:[8,10,14],yuan:14,zero:[0,3],zhong:14,zhu:14},titles:["4. API reference","3. Benchmarks","5. Command line arguments","3. Configuration file","6. Constants and Units","3. Electrostatic interactions","1. Examples","2. Filtering","1. Installation","1. Interaction energy functionals","2. Intramolecular bonds","2. Usage overview for HylleraasMD","1. Theory","4. Topology and structure file","HylleraasMD documentation"],titleterms:{"function":9,"import":8,"new":[7,9],"while":8,SDS:6,api:0,argument:2,assembl:6,benchmark:1,bilay:6,bond:[1,3,10],build:8,calcul:12,chain:6,chi:9,code:14,colab:14,colaboratori:8,command:2,common:8,configur:3,constant:4,copolym:6,curl:8,dataset:13,depend:8,develop:14,diblock:6,docker:8,document:14,due:8,electrostat:[3,5],energi:9,error:8,exampl:6,extern:12,field:[0,1,3],file:[0,3,13],filter:[7,12],forc:[0,1,8,12],form:[9,12],fortran:8,four:10,gas:6,googl:[8,14],guid:14,hamiltonian:[0,12],helix:6,hylleraasmd:[11,14],hymd:14,ideal:6,implement:[7,9],incompress:9,indic:14,input:0,instal:[8,14],integr:0,interact:[5,8,9],interpol:12,intramolecular:10,issu:8,kappa:9,kernel:8,keyword:3,line:2,lipid:6,logger:0,metadata:3,miss:8,numpi:8,onli:9,option:[2,13],output:0,overview:11,parallel:11,parser:0,particl:[1,3,10],peptid:6,pfft:8,phase:6,phi:9,potenti:12,python:8,reciproc:12,refer:[0,14],requir:[2,13],rod:6,run:[8,11,14],self:6,separ:6,simul:[3,11],sourc:14,space:12,specifi:5,stiff:6,structur:13,tabl:14,test:11,theori:12,thermostat:0,three:10,topolog:13,two:10,unit:4,usag:11,user:14,wget:8}}) \ No newline at end of file diff --git a/v1.0.7/.buildinfo b/v1.0.7/.buildinfo new file mode 100644 index 00000000..f0d9b2a4 --- /dev/null +++ b/v1.0.7/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 0d35e895c8f31f9b3bfb7c5c4927a6a2 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v1.0.7/.doctrees/doc_pages/api.doctree b/v1.0.7/.doctrees/doc_pages/api.doctree new file mode 100644 index 00000000..1cb179eb Binary files /dev/null and b/v1.0.7/.doctrees/doc_pages/api.doctree differ diff --git a/v1.0.7/.doctrees/doc_pages/benchmarks.doctree b/v1.0.7/.doctrees/doc_pages/benchmarks.doctree new file mode 100644 index 00000000..1e92fc7c Binary files /dev/null and b/v1.0.7/.doctrees/doc_pages/benchmarks.doctree differ diff --git a/v1.0.7/.doctrees/doc_pages/command_line.doctree b/v1.0.7/.doctrees/doc_pages/command_line.doctree new file mode 100644 index 00000000..aad813a4 Binary files /dev/null and b/v1.0.7/.doctrees/doc_pages/command_line.doctree differ diff --git a/v1.0.7/.doctrees/doc_pages/config_file.doctree b/v1.0.7/.doctrees/doc_pages/config_file.doctree new file mode 100644 index 00000000..45db3885 Binary files /dev/null and b/v1.0.7/.doctrees/doc_pages/config_file.doctree differ diff --git a/v1.0.7/.doctrees/doc_pages/constants_and_units.doctree b/v1.0.7/.doctrees/doc_pages/constants_and_units.doctree new file mode 100644 index 00000000..d460ab0e Binary files /dev/null and b/v1.0.7/.doctrees/doc_pages/constants_and_units.doctree differ diff --git a/v1.0.7/.doctrees/doc_pages/electrostatics.doctree b/v1.0.7/.doctrees/doc_pages/electrostatics.doctree new file mode 100644 index 00000000..ac665853 Binary files /dev/null and b/v1.0.7/.doctrees/doc_pages/electrostatics.doctree differ diff --git a/v1.0.7/.doctrees/doc_pages/examples.doctree b/v1.0.7/.doctrees/doc_pages/examples.doctree new file mode 100644 index 00000000..4bc63abb Binary files /dev/null and b/v1.0.7/.doctrees/doc_pages/examples.doctree differ diff --git a/v1.0.7/.doctrees/doc_pages/filtering.doctree b/v1.0.7/.doctrees/doc_pages/filtering.doctree new file mode 100644 index 00000000..9ea0b8ab Binary files /dev/null and b/v1.0.7/.doctrees/doc_pages/filtering.doctree differ diff --git a/v1.0.7/.doctrees/doc_pages/installation.doctree b/v1.0.7/.doctrees/doc_pages/installation.doctree new file mode 100644 index 00000000..37611111 Binary files /dev/null and b/v1.0.7/.doctrees/doc_pages/installation.doctree differ diff --git a/v1.0.7/.doctrees/doc_pages/interaction_energy_functionals.doctree b/v1.0.7/.doctrees/doc_pages/interaction_energy_functionals.doctree new file mode 100644 index 00000000..67523b30 Binary files /dev/null and b/v1.0.7/.doctrees/doc_pages/interaction_energy_functionals.doctree differ diff --git a/v1.0.7/.doctrees/doc_pages/intramolecular_bonds.doctree b/v1.0.7/.doctrees/doc_pages/intramolecular_bonds.doctree new file mode 100644 index 00000000..76e302c2 Binary files /dev/null and b/v1.0.7/.doctrees/doc_pages/intramolecular_bonds.doctree differ diff --git a/v1.0.7/.doctrees/doc_pages/overview.doctree b/v1.0.7/.doctrees/doc_pages/overview.doctree new file mode 100644 index 00000000..ba6b0f05 Binary files /dev/null and b/v1.0.7/.doctrees/doc_pages/overview.doctree differ diff --git a/v1.0.7/.doctrees/doc_pages/theory.doctree b/v1.0.7/.doctrees/doc_pages/theory.doctree new file mode 100644 index 00000000..b444efef Binary files /dev/null and b/v1.0.7/.doctrees/doc_pages/theory.doctree differ diff --git a/v1.0.7/.doctrees/doc_pages/topology_input.doctree b/v1.0.7/.doctrees/doc_pages/topology_input.doctree new file mode 100644 index 00000000..08cc826b Binary files /dev/null and b/v1.0.7/.doctrees/doc_pages/topology_input.doctree differ diff --git a/v1.0.7/.doctrees/environment.pickle b/v1.0.7/.doctrees/environment.pickle new file mode 100644 index 00000000..48a3f1d9 Binary files /dev/null and b/v1.0.7/.doctrees/environment.pickle differ diff --git a/v1.0.7/.doctrees/index.doctree b/v1.0.7/.doctrees/index.doctree new file mode 100644 index 00000000..4b614fc4 Binary files /dev/null and b/v1.0.7/.doctrees/index.doctree differ diff --git a/v1.0.7/_downloads/6b813a4204ca6cb89d348ebd564e03f7/benchmarks-1.pdf b/v1.0.7/_downloads/6b813a4204ca6cb89d348ebd564e03f7/benchmarks-1.pdf new file mode 100644 index 00000000..8de771a3 Binary files /dev/null and b/v1.0.7/_downloads/6b813a4204ca6cb89d348ebd564e03f7/benchmarks-1.pdf differ diff --git a/v1.0.7/_downloads/767842e6c509e26a3077b3f70fb9261e/benchmarks-2.pdf b/v1.0.7/_downloads/767842e6c509e26a3077b3f70fb9261e/benchmarks-2.pdf new file mode 100644 index 00000000..39601a22 Binary files /dev/null and b/v1.0.7/_downloads/767842e6c509e26a3077b3f70fb9261e/benchmarks-2.pdf differ diff --git a/v1.0.7/_downloads/7ee3b56ac54492d5f30fbc4167fd4402/benchmarks-1.py b/v1.0.7/_downloads/7ee3b56ac54492d5f30fbc4167fd4402/benchmarks-1.py new file mode 100644 index 00000000..deb4348f --- /dev/null +++ b/v1.0.7/_downloads/7ee3b56ac54492d5f30fbc4167fd4402/benchmarks-1.py @@ -0,0 +1,38 @@ +import numpy as np +import matplotlib.pyplot as plt +nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) +time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 +], dtype=np.float64) +nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 +], dtype=np.float64,) +time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, +], dtype=np.float64) +nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 +], dtype=np.float64) +time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, +], dtype=np.float64) +plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" +) +plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" +) +plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" +) +plt.xlabel("CPUs", fontsize=15) +plt.ylabel("Time per step, us", fontsize=15) +plt.legend(fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.show() \ No newline at end of file diff --git a/v1.0.7/_downloads/b9bbecf7edcb4b03652cca2a1c96cb14/benchmarks-1.hires.png b/v1.0.7/_downloads/b9bbecf7edcb4b03652cca2a1c96cb14/benchmarks-1.hires.png new file mode 100644 index 00000000..173b39f3 Binary files /dev/null and b/v1.0.7/_downloads/b9bbecf7edcb4b03652cca2a1c96cb14/benchmarks-1.hires.png differ diff --git a/v1.0.7/_downloads/bc7f85b4938682df3b2213172e51516a/benchmarks-2.hires.png b/v1.0.7/_downloads/bc7f85b4938682df3b2213172e51516a/benchmarks-2.hires.png new file mode 100644 index 00000000..82806426 Binary files /dev/null and b/v1.0.7/_downloads/bc7f85b4938682df3b2213172e51516a/benchmarks-2.hires.png differ diff --git a/v1.0.7/_downloads/bdbf98f75fe4a91835dba161174afb47/benchmarks-2.py b/v1.0.7/_downloads/bdbf98f75fe4a91835dba161174afb47/benchmarks-2.py new file mode 100644 index 00000000..fd287cbc --- /dev/null +++ b/v1.0.7/_downloads/bdbf98f75fe4a91835dba161174afb47/benchmarks-2.py @@ -0,0 +1,33 @@ +import numpy as np +import matplotlib.pyplot as plt + +mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] +mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + +mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + +mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + +mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] +mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + +mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + +mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + +plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") +plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") +plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") +plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") +plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") +plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") +plt.xlabel("CPUs", fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.ylabel("Time per step, s", fontsize=15) +plt.legend(loc="upper left", fontsize=15) +plt.show() \ No newline at end of file diff --git a/v1.0.7/_downloads/c4fb7389f072a14c84813b6e01cb7900/benchmarks-2.png b/v1.0.7/_downloads/c4fb7389f072a14c84813b6e01cb7900/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v1.0.7/_downloads/c4fb7389f072a14c84813b6e01cb7900/benchmarks-2.png differ diff --git a/v1.0.7/_downloads/d159f05edb94d8b6681d297098abfc89/benchmarks-1.png b/v1.0.7/_downloads/d159f05edb94d8b6681d297098abfc89/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.7/_downloads/d159f05edb94d8b6681d297098abfc89/benchmarks-1.png differ diff --git a/v1.0.7/_images/benchmarks-1.png b/v1.0.7/_images/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.7/_images/benchmarks-1.png differ diff --git a/v1.0.7/_images/benchmarks-2.png b/v1.0.7/_images/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v1.0.7/_images/benchmarks-2.png differ diff --git a/v1.0.7/_images/hylleraas_centre_logo_black.png b/v1.0.7/_images/hylleraas_centre_logo_black.png new file mode 100644 index 00000000..40826396 Binary files /dev/null and b/v1.0.7/_images/hylleraas_centre_logo_black.png differ diff --git a/v1.0.7/_images/uio_full_logo_eng_pos.png b/v1.0.7/_images/uio_full_logo_eng_pos.png new file mode 100644 index 00000000..6c603139 Binary files /dev/null and b/v1.0.7/_images/uio_full_logo_eng_pos.png differ diff --git a/v1.0.7/_modules/hymd/field.html b/v1.0.7/_modules/hymd/field.html new file mode 100644 index 00000000..a2182c29 --- /dev/null +++ b/v1.0.7/_modules/hymd/field.html @@ -0,0 +1,1453 @@ + + + + + + hymd.field — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.field

+"""Forces and energies from the discretized particle-field grid interactions
+"""
+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import warnings
+
+
+
[docs]def initialize_pm(pmesh, config, comm=MPI.COMM_WORLD): + """ + Creates the necessary pmesh objects for pfft operations. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + config : Config + Configuration dataclass containing simulation metadata and parameters. + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm : object 'pmesh.pm.ParticleMesh' + field_list : list[pmesh.pm.RealField], (multiple) + Essential list of pmesh objects required for MD + list_coulomb : list[pmesh.pm.RealField], (multiple) + Additional list of pmesh objects required for electrostatics. + """ + + if config.dtype == np.float64: + pmeshtype = "f8" + else: + pmeshtype = "f4" + # Ignore numpy numpy.VisibleDeprecationWarning: Creating an ndarray from + # ragged nested sequences until it is fixed in pmesh + with warnings.catch_warnings(): + warnings.filterwarnings( + action="ignore", + category=np.VisibleDeprecationWarning, + message=r"Creating an ndarray from ragged nested sequences", + ) + # The first argument of ParticleMesh has to be a tuple + pm = pmesh.ParticleMesh( + config.mesh_size, BoxSize=config.box_size, dtype=pmeshtype, comm=comm + ) + phi = [pm.create("real", value=0.0) for _ in range(config.n_types)] + phi_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] # noqa: E501 + force_on_grid = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + v_ext_fourier = [pm.create("complex", value=0.0) for _ in range(4)] + v_ext = [pm.create("real", value=0.0) for _ in range(config.n_types)] + + phi_transfer = [pm.create("complex", value=0.0) for _ in range(3)] + + phi_laplacian = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + + # Initialize charge density fields + coulomb_list = [] + elec_common_list = [None, None, None, None] + _SPACE_DIM = config.box_size.size + + if config.coulombtype == "PIC_Spectral_GPE" or config.coulombtype == "PIC_Spectral": + phi_q = pm.create("real", value=0.0) + phi_q_fourier = pm.create("complex", value=0.0) + psi = pm.create("real", value=0.0) + elec_field = [pm.create("real", value=0.0) for _ in range(_SPACE_DIM)] + + elec_common_list = [phi_q, phi_q_fourier, psi, elec_field] + + if config.coulombtype == "PIC_Spectral": + elec_field_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] # for force calculation + psi_fourier = pm.create("complex", value=0.0) + + coulomb_list = [ + elec_field_fourier, + psi_fourier, + ] + + if ( + config.coulombtype == "PIC_Spectral_GPE" + ): ## initializing the density mesh #dielectric_flag + phi_eps = pm.create( + "real", value=0.0 + ) ## real contrib of the epsilon dielectric painted to grid + phi_eps_fourier = pm.create("complex", value=0.0) # complex contrib of phi eps + phi_eta = [ + pm.create("real", value=0.0) for _ in range(_SPACE_DIM) + ] ## real contrib of factor in polarization charge density + phi_eta_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] ## fourier of factor in polarization charge density + phi_pol = pm.create( + "real", value=0.0 + ) ## real contrib of the polarization charge + phi_pol_prev = pm.create("real", value=0.0) + elec_dot = pm.create("real", value=0.0) + elec_field_contrib = pm.create( + "real", value=0.0 + ) # needed for pol energies later + + # External potential and force meshes + Vbar_elec = [pm.create("real", value=0.0) for _ in range(config.n_types)] + Vbar_elec_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] + force_mesh_elec = [ + [pm.create("real", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + force_mesh_elec_fourier = [ + [pm.create("complex", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + + coulomb_list = [ + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol, + phi_pol_prev, + elec_dot, + elec_field_contrib, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + ] + + field_list = [ + phi, + phi_fourier, + force_on_grid, + v_ext_fourier, + v_ext, + phi_transfer, + phi_laplacian, + ] + + return (pm, field_list, elec_common_list, coulomb_list)
+ + +
[docs]def compute_field_force(layouts, r, force_mesh, force, types, n_types): + """Interpolate particle-field forces from the grid onto particle positions + + Backmaps the forces calculated on the grid to particle positions using the + window function :math:`P` (by default cloud-in-cell [CIC]). In the + following, let :math:`\\mathbf{F}_j` denote the force acting on the + particle with index :math:`j` and position :math:`\\mathbf{r}_j`. The + interpolated force is + + .. math:: + + \\mathbf{F}_j = -\\sum_k\\nabla V_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`V_{j_k}` is the discretized external potential at grid vertex + :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid vertex + with index :math:`j_k`, and :math:`h^3` is the volume of each grid voxel. + The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + r : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + force : (N,D) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. Local + for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + n_types : int + Number of different unique types present in the simulation system. + :code:`n_types` is global, i.e. the same for all MPI ranks even if some + ranks contain zero particles of certain types. + """ + for t in range(n_types): + ind = types == t + for d in range(3): + force[ind, d] = force_mesh[t][d].readout(r[ind], layout=layouts[t])
+ + +
[docs]def compute_self_energy_q(config, charges, comm=MPI.COMM_WORLD): + """Compute the self energy for the interaction due to the Ewald scheme + used to compute the electrostatics. The energy is stored in :code:`config`. + + The self interaction energy is given by: + + .. math:: + + U_{self} = \\sqrt{\\frac{1}{2\\pi\\sigma^2}} \\sum_{i=1}^{N} q_i^2 + + where :math:`q_i` are the charges and :math:`\\sigma` is the half-width + of the Gaussian filter. + + Parameters + ---------- + config : Config + Configuration object. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + comm : mpi4py.Comm + MPI communicator to use for rank communication. + + Returns + ------- + field_q_self_energy : float + Electrostatic self energy. + """ + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + prefac = elec_conversion_factor * np.sqrt( + 1.0 / (2.0 * np.pi * config.sigma * config.sigma) + ) + _squared_charges = charges * charges + squared_charges_sum = comm.allreduce(np.sum(_squared_charges)) + return prefac * squared_charges_sum
+ + +
[docs]def update_field_force_q( + charges, + phi_q, + phi_q_fourier, + psi, + psi_fourier, + elec_field_fourier, + elec_field, + elec_forces, + layout_q, + hamiltonian, + pm, + positions, + config, +): + """Calculate the electrostatic particle-field forces on the grid + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential is computed in reciprocal space as + + .. math:: + + \\Phi = \\mathrm{FFT}^{-1}\\left[ + \\frac{4\\pi k_e}{\\varepsilon \\vert\\mathbf{k}\\vert^2} + \\mathrm{FFT}(\\rho)\\mathrm{FFT}(H) + \\right], + + with the electric field + + .. math:: + + \\mathbf{E} = \\mathrm{FFT}^{-1}\\left[ + -i\\mathbf{k}\\,\\mathrm{FFT}(\\Psi) + \\right]. + + In the following, let :math:`\\mathbf{F}_j` denote the electrostatic force + acting on the particle with index :math:`j` and position + :math:`\\mathbf{r}_j`. The interpolated electrostatic force is + + .. math:: + + \\mathbf{F}_j = \\sum_k q_j\\mathbf{E}_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`\\mathbf{E}_{j_k}` is the discretized electric field at grid + vertex :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid + vertex with index :math:`j_k`, and :math:`h^3` is the volume of each grid + voxel. The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty; any values in this field + are discarded. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + elec_field_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + electric field values in reciprocal space on the computational grid. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + n_dimensions = config.box_size.size + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + # charges to grid + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) + phi_q /= volume_per_cell + # print("phi_q", np.sum(phi_q)) + phi_q.r2c(out=phi_q_fourier) + + # smear charges with filter + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + + # solve Poisson equation in Fourier space to get electrostatic potential + def poisson_transfer_function(k, v): + return 4.0 * np.pi * elec_conversion_factor * v / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(poisson_transfer_function, out=psi_fourier) + # print("psi_fourier", np.sum(psi_fourier)) + psi_fourier.c2r(out=psi) + # print("phi_q * psi update_field", np.sum(phi_q * psi)) + + # exit() + + # compute electric field directly from smeared charged densities in Fourier + for _d in np.arange(n_dimensions): + + def poisson_transfer_function(k, v, d=_d): + return ( + -1j + * k[d] + * 4.0 + * np.pi + * elec_conversion_factor + * v + / k.normp(p=2, zeromode=1) + ) + + phi_q_fourier.apply(poisson_transfer_function, out=elec_field_fourier[_d]) + elec_field_fourier[_d].c2r(out=elec_field[_d]) + + # get electrostatic force from electric field + for _d in np.arange(n_dimensions): + elec_forces[:, _d] = charges * ( + elec_field[_d].readout(positions, layout=layout_q) + )
+ + +def comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, +): + for t in range(config.n_types): + np.copyto(phi_transfer[0].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[1].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[2].value, phi_fourier[t].value, casting="no", where=True) + + # Evaluate laplacian of phi in fourier space + for d in range(3): + + def laplacian_transfer(k, v, d=d): + return -k[d] ** 2 * v + + phi_transfer[d].apply(laplacian_transfer, out=Ellipsis) + phi_transfer[d].c2r(out=phi_laplacian[t][d]) + + +
[docs]def update_field( + phi, + phi_laplacian, + phi_transfer, + layouts, + force_mesh, + hamiltonian, + pm, + positions, + types, + config, + v_ext, + phi_fourier, + v_ext_fourier, + m, + compute_potential=False, +): + """Calculate the particle-field potential and force density + + If :code:`compute_potential` is :code:`True`, the energy may subsequently + be computed by calling :code:`compute_field_and_kinetic_energy`. + + Computes the particle-field external potential :math:`V_\\text{ext}` from + particle number densities through the smoothed density field, + :math:`\\phi(\\mathbf{r})`. With :math:`P` being the cloud-in-cell (CIC) + window function, the density and filtered densities are computed as + + .. math:: + + \\phi(\\mathbf{r}) = \\sum_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\phi(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\phi(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + external potential is computed in reciprocal space as + + .. math:: + + V_\\text{ext} = \\mathrm{FFT}^{-1}\\left[ + \\mathrm{FFT} + \\left( + \\frac{\\partial w}{\\partial \\tilde\\phi} + \\right) + \\mathrm{FFT}(H) + \\right], + + where :math:`w` is the interaction energy functional. Differentiating + :math:`V_\\text{ext}` is done by simply applying :math:`i\\mathbf{k}` in + Fourier space, and the resulting forces are back-transformed to direct + space and interpolated to particle positions by + + .. math:: + + \\mathbf{F}_j = -\\sum_{j_k} \\nabla V_{j_k} + P(\\mathbf{r}_{j_k} - \\mathbf{r}_j)h^3, + + where :math:`j_k` are the neighbouring vertices of particle :math:`j` at + position :math:`\\mathbf{r}_j`, and :math:`h^3` is the volume of each grid + voxel. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Pre-allocated, but empty; any values + in this field are discarded. Changed in-place. Local for each MPI + rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + config : Config + Configuration object. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Pre-allocated, but empty; any values in this field are + discarded Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + phi_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computational grid is represented by the collective fields of all + MPI ranks. + v_ext_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplesField` objects containing discretized + particle-field external potential values in reciprocal space on the + computational grid; :code:`D+1` fields in D dimensions for each + particle type. :code:`D` copies are made after calculation for later + use in force calculation, because the `force transfer function` + application differentiates the field in-place, ruining the contents + for differentiation in the remaining :code:`D-1` spatial directions. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + m: list[float], (M,) + pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. + Defaults to 1.0 for all particle types. + compute_potential : bool, optional + If :code:`True`, a :code:`D+1`-th copy of the Fourier transformed + external potential field is made to be used later in particle-field + energy calculation. If :code:`False`, only :code:`D` copies are made. + + See also + -------- + compute_field_and_kinetic_energy : + Compute the particle-field energy after the external potential is + calculated. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + for t in range(config.n_types): + pm.paint(positions[types == t], mass=m[t], layout=layouts[t], out=phi[t]) + phi[t] /= volume_per_cell + phi[t].r2c(out=phi_fourier[t]) + phi_fourier[t].apply(hamiltonian.H, out=Ellipsis) + phi_fourier[t].c2r(out=phi[t]) + + # External potential + for t in range(config.n_types): + v = hamiltonian.v_ext[t](phi) + + v.r2c(out=v_ext_fourier[0]) + v_ext_fourier[0].apply(hamiltonian.H, out=Ellipsis) + np.copyto( + v_ext_fourier[1].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + np.copyto( + v_ext_fourier[2].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + if compute_potential: + np.copyto( + v_ext_fourier[3].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + + # Differentiate the external potential in fourier space + for d in range(3): + + def force_transfer_function(k, v, d=d): + return -k[d] * 1j * v + + v_ext_fourier[d].apply(force_transfer_function, out=Ellipsis) + v_ext_fourier[d].c2r(out=force_mesh[t][d]) + + if compute_potential: + v_ext_fourier[3].c2r(out=v_ext[t])
+ + +
[docs]def compute_field_and_kinetic_energy( + phi, + phi_q, + psi, + velocity, + hamiltonian, + positions, + types, + v_ext, + config, + layouts, + comm=MPI.COMM_WORLD, +): + """Compute the particle-field and kinetic energy contributions + + Calculates the kinetic energy through + + .. math:: + + E_k = \\sum_j \\frac{1}{2}m_j\\mathbf{v}_j\\cdot\\mathbf{v}_j, + + and the particle-field energy by + + .. math:: + + E_\\text{field} = \\int\\mathrm{d}\\mathbf{r}\\, + w[\\tilde\\phi], + + where :math:`w` is the interaction energy functional `density`. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + velocity : (N,D) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Local for each MPI rank--the full computational grid is + represented by the collective fields of all MPI ranks. + config : Config + Configuration object. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field : + Computes the up-to-date external potential for use in calculating the + particle-field energy. + """ + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + field_energy = w_0.csum() # w to W + + kinetic_energy = comm.allreduce(0.5 * config.mass * np.sum(velocity**2)) + + if config.coulombtype == "PIC_Spectral": + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + field_q_energy = w_elec.csum() + else: + field_q_energy = 0.0 + + return field_energy, kinetic_energy, field_q_energy
+ + +
[docs]def compute_field_energy_q_GPE( + config, + phi_eps, + field_q_energy, + dot_elec, + comm=MPI.COMM_WORLD, +): + """ + Compute the electrostatic energy after electrosatic forces is + calculated. + + From the definition of the elecrostatic potential :math:`\\Psi`, the energy + is + + W = \\frac{1}{2}\\int\\mathrm{d}\\mathbf{r}\\, + \\epsilon(\\mathbf{r})} \\left(\\mathbf{E}\\cdot \\mathbf{E}\\right), + + where :math:`\\epsilon(\\mathbf{r})}` is the anisotropic, spatially dependent, + relative dielectric of the simulation medium. + + Parameters + ---------- + config : hymd.input_parser.Config + Configuration object. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + field_q_energy : float + Total elecrostatic energy. + dot_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing :math:`|\\mathbf{E(r)}|^{2}` + on the computational grid. Local for each MPI rank -- the full computational + grid is represented by the collective fields of all MPI ranks. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field_force_q_GPE: + Compute the electrosatic force from an anisotropic dielectric general + Poisson equation. + """ + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + # ^ due to integration on local cell before allreduce + + eps_0 = 1.0 / (config.coulomb_constant * 4 * np.pi) + field_q_energy = ( + volume_per_cell * (0.5 * eps_0) * comm.allreduce(np.sum(phi_eps * dot_elec)) + ) + + return field_q_energy
+ + +
[docs]def update_field_force_q_GPE( + conv_fun, + phi, + types, + charges, + phi_q, + phi_q_fourier, + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol_prev, + phi_pol, + elec_field, + elec_forces, + elec_field_contrib, + psi, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + hamiltonian, + layout_q, + layouts, + pm, + positions, + config, + comm=MPI.COMM_WORLD, +): + """ + Calculate the electrostatic particle-field forces on the grid, arising from + a general Poisson equation, i.e. anisotropic permittivity/dielectric. + The function is called when tomli input config.coulombtype = "PIC_Spectral_GPE." + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential for a variable dielectric does not have an + analytical expression, and is computed in reciprocal through an iterative + method. + + The GPE states that + + .. math:: + + \\nabla \\cdot \\left(\\epsilon(\\mathbf{r}) + \\nabla{\\mathbf{\\psi(r)}}\\right) = -\\rho({\\mathbf{r}}). + + where :math:`\\epsilon(\\mathbf{r})` is the relative dielectric function. + + Parameters + ---------- + conv_fun : Convergence function. + Returns a scalar. Depends on MPI allreduce for similar convergence + across MPI ranks. + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_eta : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + gradients of the relative dielectric values on the computational grid. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank--the + full computational grid is represented by the collective fields of all MPI ranks. + phi_eta_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated discretized + Fourier transformed gradient relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol_prev : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charge values on the computational grid. Parameter in + the iterative method.Pre-allocated,but empty. Changedin-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charges on the computational grid. Parameter in the iterative + method, updating the next quess in solving for the electrostatic potential. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all + MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + elec_field_contrib : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing + :math:`|\\mathbf{E(r)}|^2/\\phi_{0}` on the computational grid. + Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + psi : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic potential + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + Vbar_elec : mesh.pm.RealField + Pmesh :code:`RealField` object for storing functional derivatives of + :math:`\\|w(\\{ \\phi \\})_{elec}`on the computational grid. + Pre-allocated, but empty. Changed in-place. Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + Vbar_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated functional + derivatives of :math:`\\|w(\\{ \\phi \\})_{elec}` in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + force_mesh_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic force values + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + force_mesh_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated electrostatic + force values in reciprocal space on the computational grid. Local for + each MPI rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + layouts: list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + comm: mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + compute_field_energy_q_GPE: + Compute the electrostatic energy after electrosatic force is + calculated for a variable (anisotropic) dielectric general Poisson equation. + """ + + ## basic setup + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + ## old protocol in gen_qe_hpf_use_self + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) ## + ## scale and fft + ## old protocol in gen_qe_hpf_use_self + phi_q /= volume_per_cell + phi_q.r2c(out=phi_q_fourier) + + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + ## ^------ use the same gaussian as the \kai interaciton + phi_q_fourier.c2r(out=phi_q) ## this phi_q is after applying the smearing function + + denom_phi_tot = pm.create("real", value=0.0) + num_types = pm.create("real", value=0.0) + ### ^ ----- Calculate the relative dielectric (permittivity) to field + ### ------- from a mean contribution of particle number densities + + for t_ in range(config.n_types): + num_types = num_types + (config.dielectric_type[t_]) * phi[t_] + denom_phi_tot = denom_phi_tot + phi[t_] + + np.divide(num_types, denom_phi_tot, where=np.abs(denom_phi_tot > 1e-6), out=phi_eps) + + phi_eps.r2c(out=phi_eps_fourier) # FFT dielectric + + # phi_q_eps = (phi_q/phi_eps) + np.divide(phi_q, phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_q) + + _SPACE_DIM = 3 + ##^--------- constants needed throughout the calculations + + ### method for finding the gradient (fourier space), using the spatial dimension of k + for _d in np.arange(_SPACE_DIM): + + def gradient_transfer_function(k, x, d=_d): + return 1j * k[d] * x + + phi_eps_fourier.apply(gradient_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=phi_eta[_d]) + np.divide(phi_eta[_d], phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_eta[_d]) + + ### iterative GPE solver ### + ### ---------------------------------------------- + max_iter = 100 + i = 0 + delta = 1.0 + # phi_pol_prev = pm.create("real", value = 0.0) + ### ^------ set to zero before each iterative procedure or soft start + conv_criteria = config.conv_crit # conv. criteria (default 1e-6) + w = config.pol_mixing # polarization mixing param (default 0.6) + while i < max_iter and delta > conv_criteria: + (phi_q + phi_pol_prev).r2c(out=phi_q_fourier) + for _d in np.arange(_SPACE_DIM): + + def iterate_apply_k_vec(k, additive_terms, d=_d): + return additive_terms * (-1j * k[d]) / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(iterate_apply_k_vec, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + + phi_pol = -( + phi_eta[0] * elec_field[0] + + phi_eta[1] * elec_field[1] + + phi_eta[2] * elec_field[2] + ) + ### ^-- Following a negative sign convention (-ik) of the FT, a neg sign is + ### --- mathematically correct by the definition of the GPE (double - -> +) + phi_pol = w * phi_pol + (1.0 - w) * phi_pol_prev + diff = np.abs(phi_pol - phi_pol_prev) + delta = conv_fun(comm, diff) # decided from toml input + phi_pol_prev = phi_pol.copy() + i = i + 1 + # print("Stopping after iteration {:d} with stop crit {:.2e}, delta {:.2e}".format(i,conv_criteria,delta)) + + # compute_potential = True + def k_norm_divide(k, potential): + return potential / k.normp(p=2, zeromode=1) + + ## > Electrostatic potential + eps0_inv = config.coulomb_constant * 4 * np.pi + ## ^ the 1/(4pi eps0)*4*pi = 1/eps0 + ((eps0_inv) * (phi_q + phi_pol)).r2c(out=phi_q_fourier) + phi_q_fourier.apply(k_norm_divide, out=phi_q_fourier) + phi_q_fourier.c2r(out=psi) + ### ^ electrostatic potential for the GPE + + for _d in np.arange(_SPACE_DIM): + + def field_transfer_function(k, x, d=_d): + return ( + -1j * k[d] * x + ) ## negative sign relation, due to E = - nabla psi relation + + phi_q_fourier.apply(field_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + ## ^-------- Method: Obtaining the electric field from electrostatic potential + ## Assuming the electric field is conserved. + ## Assumption holds if no magnetic flux (magnetic induced fields) + + ############## Obtain forces ############## + elec_dot = ( + elec_field[0] * elec_field[0] + + elec_field[1] * elec_field[1] + + elec_field[2] * elec_field[2] + ) + # needed for energy calculations + + np.divide( + elec_dot, + denom_phi_tot, + where=np.abs(denom_phi_tot > 1e-6), + out=elec_field_contrib, + ) + + eps0_inv = config.coulomb_constant * 4 * np.pi + + for t_ in range(config.n_types): + Vbar_elec[t_] = ( + config.type_charges[t_] * psi + - (0.5 / eps0_inv) + * (config.dielectric_type[t_] - phi_eps) + * elec_field_contrib + ) + + # Obtain Vext,k + for t_ in range(config.n_types): + Vbar_elec[t_].r2c(out=Vbar_elec_fourier[t_]) + Vbar_elec_fourier[t_].apply(hamiltonian.H, out=Vbar_elec_fourier[t_]) + + # force terms + # F = - grad Vext + for t_ in range(config.n_types): + for _d in np.arange(_SPACE_DIM): + + def force_transfer_function(k, x, d=_d): + return -1j * k[_d] * x ## negative gradient + + Vbar_elec_fourier[t_].apply( + force_transfer_function, out=force_mesh_elec_fourier[t_][_d] + ) + force_mesh_elec_fourier[t_][_d].c2r(out=force_mesh_elec[t_][_d]) + elec_forces[types == t_, _d] = force_mesh_elec[t_][_d].readout( + positions[types == t_], layout=layouts[t_] + ) + + return Vbar_elec, phi_eps, elec_dot
+ + +
[docs]def domain_decomposition( + positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=MPI.COMM_WORLD +): + """Performs domain decomposition + + Rearranges the MPI rank memory layout into one that better mimics the PFFT + pencil grid 2D decomposition. As molecules are always required to be fully + contained on a single MPI rank, a perfect decomposition is not always + possible. The best decomposition which leaves the center of mass of all + molecules in their respective correct domains is used, with possible + overlap into neighbouring domains if the spatial extent of any molecule + crosses domain boundaries. + + Parameters + ---------- + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + *args + Variable length argument list containing arrays to include in the + domain decomposition. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + bonds : (N,M) numpy.ndarray, optional + Array of :code:`M` bonds originating from each of :code:`N` particles. + verbose : int, optional + Specify the logging event verbosity of this function. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + Domain decomposed :code:`positions` and any array specified in + :code:`*args`, in addition to :code:`bonds` and :code:`molecules` if these + arrays were provided as input. + """ + if molecules is not None: + if not topol: + assert bonds is not None, "bonds must be provided with molecules" + unique_molecules = np.sort(np.unique(molecules)) + molecules_com = np.empty_like(positions) + for m in unique_molecules: + ind = molecules == m + r = positions[ind, :][0, :] + molecules_com[ind, :] = r + layout = pm.decompose(molecules_com, smoothing=0) + if not topol: + args = (*args, bonds, molecules) + else: + args = (*args, molecules) + else: + layout = pm.decompose(positions, smoothing=0) + if verbose > 1: + Logger.rank0.log( + logging.INFO, + "DOMAIN_DECOMP: Total number of particles to be exchanged = %d", + np.sum(layout.get_exchange_cost()), + ) + return layout.exchange(positions, *args)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/_modules/hymd/file_io.html b/v1.0.7/_modules/hymd/file_io.html new file mode 100644 index 00000000..217891bb --- /dev/null +++ b/v1.0.7/_modules/hymd/file_io.html @@ -0,0 +1,1149 @@ + + + + + + hymd.file_io — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.file_io

+"""Handle file input/output in parllel HDF5 fashion
+"""
+import numpy as np
+import h5py
+import os
+import logging
+import getpass
+from mpi4py import MPI
+from .logger import Logger, get_version
+
+
+
[docs]class OutDataset: + """HDF5 dataset handler for file output""" + + def __init__( + self, + dest_directory, + config, + double_out=False, + disable_mpio=False, + comm=MPI.COMM_WORLD, + ): + """Constructor + + Parameters + ---------- + dest_directory : str + Ouput directory for saving data. + config : Config + Configuration object. + double_out : bool, optional + If :code:`True`, the output HDF5 objects are written in eight byte + floating point representation. Otherwise, four byte single + precision is used. + disable_mpio : bool, optional + If :code:`True`, disables parallel MPI-enabled HDF5 file output. + This is a compatibility option used if HDF5 is not compiled with + MPI support. This makes everything much harder by splitting all + output in one file per MPI rank, and having an MPI-enabled HDF5 + library is **highly recommended**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + """ + self.disable_mpio = disable_mpio + self.config = config + if double_out: + self.float_dtype = "float64" + else: + self.float_dtype = "float32" + + if disable_mpio: + self.file = h5py.File( + os.path.join( + dest_directory, f"sim.hdf5-{comm.rank:6d}-of-{comm.size:6d}" + ), + "w", + ) + else: + self.file = h5py.File( + os.path.join(dest_directory, "sim.H5"), "w", driver="mpio", comm=comm + ) + +
[docs] def is_open(self, comm=MPI.COMM_WORLD): + """Check if HDF5 output file is open + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + return self.file.__bool__()
+ +
[docs] def close_file(self, comm=MPI.COMM_WORLD): + """Closes the HDF5 output file + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + self.file.close()
+ +
[docs] def flush(self): + """Flushes output buffers, forcing file writes""" + self.file.flush()
+ + +
[docs]def setup_time_dependent_element( + name, parent_group, n_frames, shape, dtype, units=None +): + """Helper function for setting up time-dependent HDF5 group datasets + + All output groups must adhere to the H5MD standard, meaning a structure of + + + | ┗━ **group** particle group (e.g. :code:`all`) or :code:`observables` group + | ┗━ **group** time-dependent data + | ┣━ **dataset** :code:`step` :code:`shape=(n_frames,)` + | ┣━ **dataset** :code:`time` :code:`shape=(n_frames,)` + | ┗━ **dataset** :code:`value` :code:`shape=(n_frames, *)` + + is necessary. + + References + ---------- + H5MD specification : + https://www.nongnu.org/h5md/h5md.html + """ # noqa: E501 + group = parent_group.create_group(name) + step = group.create_dataset("step", (n_frames,), "int32") + time = group.create_dataset("time", (n_frames,), "float32") + value = group.create_dataset("value", (n_frames, *shape), dtype) + + if units is not None: + value.attrs["unit"] = units + time.attrs["unit"] = "ps" + return group, step, time, value
+ + +
[docs]def store_static( + h5md, + rank_range, + names, + types, + indices, + config, + bonds_2_atom1, + bonds_2_atom2, + molecules=None, + velocity_out=False, + force_out=False, + charges=False, + dielectrics=False, + plumed_out=False, + comm=MPI.COMM_WORLD, +): + """Outputs all static time-independent quantities to the HDF5 output file + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + rank_range : list[int] + Start and end indices for global arrays for each MPI rank. + names : (N,) numpy.ndarray + Array of names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of type indices for :code:`N` particles. + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + config : Config + Configuration object. + bonds_2_atom1 : (B,) numpy.ndarray + Array of indices of the first particle for :code:`B` total + two-particle bonds. + bonds_2_atom2 : (B,) numpy.ndarray + Array of indices of the second particle for :code:`B` total + two-particle bonds. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. + dielectrics : (N,) numpy.ndarray + Array of particle relative dielectric values for :code:`N` particles. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to output HDF5 file. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + prepare_bonds : + Constructs two-, three-, and four-particle bonds from toplogy input + file and bond configuration information. + distribute_input : + Distributes input arrays onto MPI ranks, attempting load balancing. + """ + dtype = h5md.float_dtype + + h5md_group = h5md.file.create_group("/h5md") + h5md.h5md_group = h5md_group + h5md.observables = h5md.file.create_group("/observables") + h5md.connectivity = h5md.file.create_group("/connectivity") + h5md.parameters = h5md.file.create_group("/parameters") + + h5md_group.attrs["version"] = np.array([1, 1], dtype=int) + author_group = h5md_group.create_group("author") + author_group.attrs["name"] = np.string_(getpass.getuser()) + creator_group = h5md_group.create_group("creator") + creator_group.attrs["name"] = np.string_("Hylleraas MD") + + # Get HyMD version + creator_group.attrs["version"] = np.string_(get_version()) + + h5md.particles_group = h5md.file.create_group("/particles") + h5md.all_particles = h5md.particles_group.create_group("all") + mass = h5md.all_particles.create_dataset("mass", (config.n_particles,), dtype) + mass[...] = config.mass + + if charges is not False: + charge = h5md.all_particles.create_dataset( + "charge", (config.n_particles,), dtype="float32" + ) + charge[indices] = charges + if dielectrics is not False: + dielectric = h5md.all_particles.create_dataset( + "dielectric", (config.n_particles,), dtype="float32" + ) + dielectric[indices] = dielectrics + + box = h5md.all_particles.create_group("box") + box.attrs["dimension"] = 3 + box.attrs["boundary"] = np.array( + [np.string_(s) for s in 3 * ["periodic"]], dtype="S8" + ) + + n_frames = config.n_steps // config.n_print + if np.mod(config.n_steps - 1, config.n_print) != 0: + n_frames += 1 + if np.mod(config.n_steps, config.n_print) == 1: + n_frames += 1 + if n_frames == config.n_steps: + n_frames += 1 + + species = h5md.all_particles.create_dataset( + "species", + (config.n_particles,), + dtype="i", + ) + + ( + _, + h5md.positions_step, + h5md.positions_time, + h5md.positions, + ) = setup_time_dependent_element( + "position", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm", + ) + if velocity_out: + ( + _, + h5md.velocities_step, + h5md.velocities_time, + h5md.velocities, + ) = setup_time_dependent_element( + "velocity", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm ps-1", + ) + if force_out: + ( + _, + h5md.forces_step, + h5md.forces_time, + h5md.forces, + ) = setup_time_dependent_element( + "force", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="kJ mol-1 nm-1", + ) + ( + _, + h5md.total_energy_step, + h5md.total_energy_time, + h5md.total_energy, + ) = setup_time_dependent_element( + "total_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.kinetc_energy_step, + h5md.kinetc_energy_time, + h5md.kinetc_energy, + ) = setup_time_dependent_element( + "kinetic_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.potential_energy_step, + h5md.potential_energy_time, + h5md.potential_energy, + ) = setup_time_dependent_element( + "potential_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.bond_energy_step, + h5md.bond_energy_time, + h5md.bond_energy, + ) = setup_time_dependent_element( + "bond_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.angle_energy_step, + h5md.angle_energy_time, + h5md.angle_energy, + ) = setup_time_dependent_element( + "angle_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.dihedral_energy_step, + h5md.dihedral_energy_time, + h5md.dihedral_energy, + ) = setup_time_dependent_element( + "dihedral_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.field_energy_step, + h5md.field_energy_time, + h5md.field_energy, + ) = setup_time_dependent_element( + "field_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + if charges is not False: + ( + _, + h5md.field_q_energy_step, + h5md.field_q_energy_time, + h5md.field_q_energy, + ) = setup_time_dependent_element( + "field_q_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) # <-------- xinmeng + if plumed_out is not False: + ( + _, + h5md.plumed_bias_step, + h5md.plumed_bias_time, + h5md.plumed_bias, + ) = setup_time_dependent_element( + "plumed_bias", h5md.observables, n_frames, (1,), dtype, units="kJ mol-1" # noqa: E501 + ) + ( + _, + h5md.total_momentum_step, + h5md.total_momentum_time, + h5md.total_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "total_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm g ps-1 mol-1", + ) + ( + _, + h5md.angular_momentum_step, + h5md.angular_momentum_time, + h5md.angular_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "angular_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm+2 g ps-1 mol-1", + ) + ( + _, + h5md.torque_step, + h5md.torque_time, + h5md.torque, + ) = setup_time_dependent_element( # noqa: E501 + "torque", + h5md.observables, + n_frames, + (3,), + dtype, + units="kJ nm+2 mol-1", + ) + ( + _, + h5md.temperature_step, + h5md.temperature_time, + h5md.temperature, + ) = setup_time_dependent_element( + "temperature", h5md.observables, n_frames, (3,), dtype, units="K" + ) + ( + _, + h5md.thermostat_work_step, + h5md.thermostat_work_time, + h5md.thermostat_work, + ) = setup_time_dependent_element( + "thermostat_work", + h5md.observables, + n_frames, + (1,), + "float32", + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.pressure_step, + h5md.pressure_time, + h5md.pressure, + ) = setup_time_dependent_element( + "pressure", h5md.observables, n_frames, (18,), "float32", units="Bar" + ) + (_, h5md.box_step, h5md.box_time, h5md.box_value,) = setup_time_dependent_element( + "edges", box, n_frames, (3, 3), "float32", units="nm" + ) + + ind_sort = np.argsort(indices) + for i in ind_sort: + species[indices[i]] = config.name_to_type_map[names[i].decode("utf-8")] + + h5md.parameters.attrs["config.toml"] = np.string_(str(config)) + vmd_group = h5md.parameters.create_group("vmd_structure") + index_of_species = vmd_group.create_dataset( + "indexOfSpecies", (config.n_types,), "i" + ) + index_of_species[:] = np.array(list(range(config.n_types))) + + # VMD-h5mdplugin maximum name/type name length is 16 characters (for + # whatever reason [VMD internals?]). + name_dataset = vmd_group.create_dataset("name", (config.n_types,), "S16") + type_dataset = vmd_group.create_dataset("type", (config.n_types,), "S16") + if molecules is not None: + resid_dataset = vmd_group.create_dataset( + "resid", + (config.n_particles,), + "i", + ) + + # Change this + for i, n in config.type_to_name_map.items(): + name_dataset[i] = np.string_(n[:16]) + if n == "W": + type_dataset[i] = np.string_("solvent") + else: + type_dataset[i] = np.string_("membrane") + + total_bonds = comm.allreduce(len(bonds_2_atom1), MPI.SUM) + n_bonds_local = len(bonds_2_atom1) + + receive_buffer = comm.gather(n_bonds_local, root=0) + n_bonds_global = None + if comm.Get_rank() == 0: + n_bonds_global = receive_buffer + n_bonds_global = np.array(comm.bcast(n_bonds_global, root=0)) + rank_bond_start = np.sum(n_bonds_global[: comm.Get_rank()]) + + bonds_from = vmd_group.create_dataset("bond_from", (total_bonds,), "i") + bonds_to = vmd_group.create_dataset("bond_to", (total_bonds,), "i") + for i in range(n_bonds_local): + a = bonds_2_atom1[i] + b = bonds_2_atom2[i] + bonds_from[rank_bond_start + i] = indices[a] + 1 + bonds_to[rank_bond_start + i] = indices[b] + 1 + + if molecules is not None: + resid_dataset[indices[ind_sort]] = molecules
+ + +# store data old vs +""" +h5md, step, frame, indices, positions, velocities, forces, box_size, +temperature, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, +field_energy, field_q_energy, time_step, config, velocity_out=False, +force_out=False, charge_out=False, dump_per_particle=False, +""" + + +
[docs]def store_data( + h5md, + step, + frame, + indices, + positions, + velocities, + forces, + box_size, + temperature, + pressure, + kinetic_energy, + bond2_energy, + bond3_energy, + bond4_energy, + field_energy, + field_q_energy, + plumed_bias, + time_step, + config, + velocity_out=False, + force_out=False, + charge_out=False, + plumed_out=False, + dump_per_particle=False, + comm=MPI.COMM_WORLD, +): + """Writes time-step data to HDF5 output file + + Handles all quantities which change during simulation, as opposed to + static quanitities (see :code:`store_static`). + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + step : int + Step number. + frame : int + Output frame number (:code:`step // n_print`). + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + positions : (N,) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + velocities : (N,) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + forces : (N,) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. + box_size : (D,) numpy.ndarray + Array containing the simulation box size. + temperature : float + Calculated instantaneous temperature. + kinetic_energy : float + Calculated instantaneous kinetic energy. + bond2_energy : float + Calculated instantaneous harmonic two-particle bond energy. + bond3_energy : float + Calculated instantaneous harmonic angular three-particle bond energy. + bond4_energy : float + Calculated instantaneous dihedral four-particle torsion energy. + field_energy : float + Calculated instantaneous particle-field energy. + field_q_energy : float + Calculated instantaneous electrostatic energy. + plumed_bias : float + PLUMED instantaneous bias energy. + time_step : float + Value of the time step. + config : Config + Configuration object. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charge_out : bool, optional + If :code:`True`, electrostatic energies are written to the output + HDF5 file. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to the output HDF5 file. + dump_per_particle : bool, optional + If :code:`True`, all quantities are written **per particle**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + store_static : + Outputs all static time-independent quantities to the HDF5 output file + """ + for dset in ( + h5md.positions_step, + h5md.total_energy_step, + h5md.potential_energy_step, + h5md.kinetc_energy_step, + h5md.bond_energy_step, + h5md.angle_energy_step, + h5md.dihedral_energy_step, + h5md.field_energy_step, + h5md.total_momentum_step, + h5md.angular_momentum_step, + h5md.torque_step, + h5md.temperature_step, + h5md.pressure_step, + h5md.box_step, + h5md.thermostat_work_step, + ): + dset[frame] = step + + for dset in ( + h5md.positions_time, + h5md.total_energy_time, + h5md.potential_energy_time, + h5md.kinetc_energy_time, + h5md.bond_energy_time, + h5md.angle_energy_time, + h5md.dihedral_energy_time, + h5md.field_energy_time, + h5md.total_momentum_time, + h5md.angular_momentum_time, + h5md.torque_time, + h5md.temperature_time, + h5md.pressure_time, + h5md.box_time, + h5md.thermostat_work_time, + ): + dset[frame] = step * time_step + + if velocity_out: + h5md.velocities_step[frame] = step + h5md.velocities_time[frame] = step * time_step + if force_out: + h5md.forces_step[frame] = step + h5md.forces_time[frame] = step * time_step + if charge_out: + h5md.field_q_energy_step[frame] = step + h5md.field_q_energy_time[frame] = step * time_step + if plumed_out: + h5md.plumed_bias_step[frame] = step + h5md.plumed_bias_time[frame] = step * time_step + + ind_sort = np.argsort(indices) + h5md.positions[frame, indices[ind_sort]] = positions[ind_sort] + + if velocity_out: + h5md.velocities[frame, indices[ind_sort]] = velocities[ind_sort] + if force_out: + h5md.forces[frame, indices[ind_sort]] = forces[ind_sort] + if charge_out: + h5md.field_q_energy[frame] = field_q_energy + if plumed_out: + h5md.plumed_bias[frame] = plumed_bias + + potential_energy = ( + bond2_energy + bond3_energy + bond4_energy + field_energy + field_q_energy + ) + + total_momentum = config.mass * comm.allreduce(np.sum(velocities, axis=0), MPI.SUM) + angular_momentum = config.mass * comm.allreduce( + np.sum(np.cross(positions, velocities), axis=0), MPI.SUM + ) + torque = config.mass * comm.allreduce( + np.sum(np.cross(positions, forces), axis=0), MPI.SUM + ) + h5md.total_energy[frame] = kinetic_energy + potential_energy + h5md.potential_energy[frame] = potential_energy + h5md.kinetc_energy[frame] = kinetic_energy + h5md.bond_energy[frame] = bond2_energy + h5md.angle_energy[frame] = bond3_energy + h5md.dihedral_energy[frame] = bond4_energy + h5md.field_energy[frame] = field_energy + h5md.total_momentum[frame, :] = total_momentum + h5md.angular_momentum[frame, :] = angular_momentum + h5md.torque[frame, :] = torque + h5md.temperature[frame] = temperature + h5md.pressure[frame] = pressure + for d in range(3): + h5md.box_value[frame, d, d] = box_size[d] + h5md.thermostat_work[frame] = config.thermostat_work + + fmt_ = [ + "step", + "time", + "temp", + "tot E", + "kin E", + "pot E", + "field E", + "elec E", + "bond E", + "ang E", + "dih E", + "bias E", + "Px", + "Py", + "Pz", + "ΔH" if config.target_temperature else "ΔE", + ] + fmt_ = np.array(fmt_) + + # create mask to show only energies != 0 + en_array = np.array([ + field_energy, + field_q_energy, + bond2_energy, + bond3_energy, + bond4_energy, + plumed_bias, + ]) + mask = np.full_like(fmt_, True, dtype=bool) + mask[range(6,12)] = en_array != 0. + + header_ = fmt_[mask].shape[0] * "{:>13}" + if config.initial_energy is None: + fmt_[-1] = "" + + divide_by = 1.0 + if dump_per_particle: + for i in range(3, 9): + fmt_[i] = fmt_[i][:-2] + "E/N" + fmt_[-1] += "/N" + divide_by = config.n_particles + total_energy = kinetic_energy + potential_energy + if config.initial_energy is not None: + if config.target_temperature: + H_tilde = total_energy - config.initial_energy - config.thermostat_work + else: + H_tilde = total_energy - config.initial_energy + else: + H_tilde = 0.0 + + header = header_.format(*fmt_[mask]) + data_fmt = f'{"{:13}"}{(fmt_[mask].shape[0]-1) * "{:13.5g}" }' + all_data = [ + step, + time_step * step, + temperature, + total_energy / divide_by, + kinetic_energy / divide_by, + potential_energy / divide_by, + field_energy / divide_by, + field_q_energy / divide_by, + bond2_energy / divide_by, + bond3_energy / divide_by, + bond4_energy / divide_by, + plumed_bias / divide_by, + total_momentum[0] / divide_by, + total_momentum[1] / divide_by, + total_momentum[2] / divide_by, + H_tilde / divide_by, + ] + data = data_fmt.format(*[val for i, val in enumerate(all_data) if mask[i]]) + Logger.rank0.log(logging.INFO, ("\n" + header + "\n" + data))
+ + +
[docs]def distribute_input( + in_file, rank, size, n_particles, max_molecule_size=201, comm=MPI.COMM_WORLD +): + """Assign global arrays onto MPI ranks, attempting load balancing + + Distributes approximately equal numbers of particles (workload) onto each + independent MPI rank, while respecting the requirement that any molecule + must be fully contained on a single MPI rank only (no splitting molecules + across multiple CPUs). + + Parameters + ---------- + in_file : h5py.File + HDF5 input file object. + rank : int + Local rank number for this MPI rank. + size : int + Global size of the MPI communicator (number of total CPUs). + n_particles : int + Total number of particles. + max_molecule_size : int, optional + Maximum size of any molecule present in the system. Used to initially + guess where the MPI rank boundaries (start/end indices) in the global + arrays should be placed. If molecules of size + :code:`>max_molecule_size` exist in the simulation system, HyMD + **might** work as expected. Or it might fail spectacularly. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + rank_range : + Starting and ending indices in the global arrays for each MPI rank. + """ + if n_particles is None: + n_particles = len(in_file["indices"]) + np_per_MPI = n_particles // size + + molecules_flag = False + if "molecules" in in_file: + molecules_flag = True + + if not molecules_flag: + if rank == size - 1: + np_cum_mpi = [rank * np_per_MPI, n_particles] + else: + np_cum_mpi = [rank * np_per_MPI, (rank + 1) * np_per_MPI] + p_mpi_range = list(range(np_cum_mpi[0], np_cum_mpi[1])) + return p_mpi_range, molecules_flag + + # To avoid splitting molecules across multiple different ranks, we need + # to read in some extra indices before/after the expected break points + # and iterate until we find a molecule break. + # + # Implicitly assuming no molecule is bigger than + # min(max_molecule_size, n_particles // n_MPI_ranks) atoms. + max_molecule_size += 2 + grab_extra = max_molecule_size if np_per_MPI > max_molecule_size else np_per_MPI + if rank == 0: + mpi_range_start = 0 + if size == 1: + mpi_range_end = n_particles + else: + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + elif rank == size - 1: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = n_particles + else: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + + molecules = in_file["molecules"][mpi_range_start:mpi_range_end] + indices = in_file["indices"][mpi_range_start:mpi_range_end] + molecule_end_indices = np.nonzero(np.diff(molecules))[0] + + p_mpi_range = [None, None] + if rank == 0: + p_mpi_range[0] = 0 + if size == 1: + p_mpi_range[1] = n_particles + else: + p_mpi_range[1] = indices[ + molecule_end_indices[molecule_end_indices >= np_per_MPI][0] + 1 + ] + elif rank == size - 1: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = n_particles + else: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = ( + indices[molecule_end_indices[molecule_end_indices > np_per_MPI][0]] + + 1 # noqa: E501 + ) + return list(range(p_mpi_range[0], p_mpi_range[1])), molecules_flag
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/_modules/hymd/force.html b/v1.0.7/_modules/hymd/force.html new file mode 100644 index 00000000..01ea77d2 --- /dev/null +++ b/v1.0.7/_modules/hymd/force.html @@ -0,0 +1,1152 @@ + + + + + + hymd.force — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.force

+"""Calculates intramolecular forces between bonded particles in molecules
+"""
+import numpy as np
+import networkx as nx
+from dataclasses import dataclass
+
+# Imported here so we can call from force import compute_bond_forces__fortran
+from force_kernels import cbf as compute_bond_forces__fortran  # noqa: F401
+from force_kernels import (  # noqa: F401
+    caf as compute_angle_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cdf as compute_dihedral_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cbf_d as compute_bond_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    caf_d as compute_angle_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    cdf_d as compute_dihedral_forces__fortran__double,
+)
+
+
+
[docs]@dataclass # might not be needed +class Dielectric_type: + atom_1: str + dielectric_value: float
+ + +
[docs]@dataclass +class Bond: + """Dataclass representing a single two-particle bond type + + A `bond type` is a bond strength and equilibrium distance associated with + any bond between particles of specific types :code:`A` and :code:`B` + (where :code:`A` and :code:`B` may be the same or different). Harmonic + two-particle bonds in HyMD take the form + + .. math:: + + V_2(\\mathbf{r}_1, \\mathbf{r}_2) = + \\frac{1}{2}k + \\left( + \\vert \\mathbf{r}_1 - \\mathbf{r}_2 \\vert - r_0 + \\right)^2, + + where :math:`k` is the bond strength (spring constant) and :math:`r_0` is + the equilibrium bond length (at which the energy is zero). + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + equilibrium : float + Equilibrium distance at which the energy associated with the bond + vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient (spring constant). + """ + + atom_1: str + atom_2: str + equilibrium: float + strength: float
+ + +
[docs]@dataclass +class Angle(Bond): + """Dataclass representing a single three-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any three-particle bond between particles of specific types :code:`A`, + :code:`B`, and :code:`C` (where :code:`A`, :code:`B`, and :code:`C` may be + different or the same). Harmonic angular three-particle bonds in HyMD take + the form + + .. math:: + + V_3(\\mathbf{r}_1, \\mathbf{r}_2, \\mathbf{r}_3) = + \\frac{1}{2}k + \\left( + \\cos^{-1} + \\left[ + \\frac{ + (\\mathbf{r}_1-\\mathbf{r}_2) + \\cdot + (\\mathbf{r}_3-\\mathbf{r}_2) + } + { + \\vert\\mathbf{r}_1-\\mathbf{r}_2\\vert + \\vert\\mathbf{r}_3-\\mathbf{r}_2\\vert + } + \\right] - \\theta_0 + \\right)^2 + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + equilibrium : float + Equilibrium angle at which the energy associated with the + three-particle angular bond vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient. + + See also + -------- + Bond : + Two-particle bond type dataclass + """ + + atom_3: str
+ + +
[docs]@dataclass +class Dihedral: + """Dataclass representing a single four-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any four-particle torsional bond between particles of specific types + :code:`A`, :code:`B`, :code:`C`, and :code:`D` (where :code:`A`, :code:`B`, + :code:`C`, and :code:`D` may be different or the same). Dihedral + four-particle bonds in HyMD take different forms depending on the + :code:`dih_type` parameter. + + In the following, let :math:`\\phi` denote the angle between the planes + spanned by the relative positions of atoms :code:`A`-:code:`B`-:code:`C` + and :code:`B`-:code:`C`-:code:`D`. If :code:`dih_type = 0`, then + + .. math:: + + V_4(\\phi) = \\sum_n c_n + \\left( + 1 + \\cos\\left[ + n\\phi - d_n + \\right] + \\right), + + where :math:`c_n` are energy coefficients and :math:`d_n` are propensity + phases. By default, the cosine sum is truncated at five terms. If + :code:`coeffs` provides only a single float, this is used as the coiling + propensity parameter :math:`\\lambda`. In this case, :math:`c_n` and + :math:`d_n` are automatically set to values which promote alpha helical + (:math:`\\lambda=-1`), beta sheet (:math:`\\lambda=1`), or a mixed + (:math:`1>\\lambda>-1`) structure (using values provided by Bore et al. + (2018)). In this case, the full potential takes the form + + .. math:: + + V_4(\\phi;\\lambda) = + \\frac{1}{2}(1-\\lambda) V_{\\text{prop},\\alpha}(\\phi) + + + \\frac{1}{2}(1+\\lambda) V_{\\text{prop},\\beta}(\\phi) + + + (1-\\vert\\lambda\\vert) V_{\\text{prop}, \\text{coil}}(\\phi), + + with each of the :math:`V_{\\mathrm{prop}, X}` being fixed cosine series + potentials with pre-set :math:`c_n` -s and :math:`d_n` -s. + + If :code:`dih_type = 1`, then a combined bending torsional (CBT) potential + is employed, + + .. math:: + + V_4(\\phi,\\gamma;\\lambda) = + V_4(\\phi;\\lambda) + + + \\frac{1}{2}K(\\phi)(\\gamma - \\gamma_0)^2, + + where :math:`V_4(\\phi;\\lambda)` specifies the potential as given by the + coiling propensity parameter above, :math:`K(\\phi)` is a separate cosine + series potential acting as the angular three-particle bond strength, and + :math:`\\gamma_0` is the three-particle bond equilibrium angle. In this + case, the :code:`coeffs` parameter must specify *both* a :math:`\\lambda` + value, in additon to the energy and phases dictating the :math:`K(\\phi)` + potential. + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + atom_4 : str + Type name of particle 4. + coeffs : list[list[float]] or list[float] or numpy.ndarray + Dihedral coefficients defining the series expansion of the dihedral + energy. + dih_type : int + Specifies the type of dihedral used; If :code:`0`, then :code:`coeffs` + must contain **either** two lists of five energy coefficients + :math:`c_n` and five propensity phases :math:`d_n` **or** a single + floating point number defining the :math:`\\lambda` coiling propensity + parameter. If :code:`1`, the combined bending-torsional potential is + used, and :code:`coeffs` must specify :math:`\\lambda` *and* two lists + containing energy coefficients and propensity phases for the + :math:`V_\\text{prop}` propensity potential, defined in terms of cosine + series. + + References + ---------- + Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018. + """ + + atom_1: str + atom_2: str + atom_3: str + atom_4: str + coeffs: np.ndarray + dih_type: int
+ + +
[docs]@dataclass +class Chi: + """Dataclass representing a single :math:`\\chi` mixing interaction type + + An `interaction mixing energy type` is a mixing energy associated with + density overlap between species of types :code:`A` and :code:`B` + (specified as inputs :code:`atom_1` and :code:`atom_2`). A positive mixing + energy promotes phase separation, a negative mixing energy promotes mixing. + The interaction energy density (provided the :code:`DefaultWithChi` + Hamiltonian is used) takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} + \\sum_{k,l}\\chi_{k,l} \\tilde\\phi_k\\tilde\\phi_l, + + where :math:`\\chi_{k,l}` denotes the mixing energy between species + :math:`k` and :math:`l`, with :math:`\\kappa` being the incompressibility. + The value of the interaction mixing energy parameter may be extracted from + `Flory-Huggins theory`_. + + .. _`Flory-Huggins theory`: + https://en.wikipedia.org/wiki/Flory%E2%80%93Huggins_solution_theory + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + interaction_energy : float + Interaction mixing energy. + + See also + -------- + hymd.hamiltonian.DefaultWithChi : + Interaction energy functional using :math:`\\chi`-interactions. + """ + + atom_1: str + atom_2: str + interaction_energy: float
+ + +
[docs]def find_all_paths(G, u, n): + """Helper function that recursively finds all paths of given lenght 'n + 1' inside a network 'G'. + Adapted from https://stackoverflow.com/a/28103735.""" + if n == 0: + return [[u]] + paths = [] + for neighbor in G.neighbors(u): + for path in find_all_paths(G, neighbor, n - 1): + if u not in path: + paths.append([u] + path) + return paths
+ + +
[docs]def propensity_potential_coeffs(x: float): + alpha_coeffs = np.array( + [ + [7.406, -5.298, -2.570, 1.336, 0.739], + [-0.28632126, 1.2099146, 1.18122138, 0.49075168, 0.98495911], + ] + ) + beta_coeffs = np.array( + [ + [3.770, 5.929, -4.151, -0.846, 0.190], + [-0.2300693, -0.0583289, 0.99342396, 1.03237971, 2.90160988], + ] + ) + coil_coeffs = np.array( + [ + [1.416, -0.739, 0.990, -0.397, 0.136], + [1.3495933, 0.45649087, 2.30441057, -0.12274901, -0.26179939], + ] + ) + + zero_add = np.zeros((2, 5)) + if np.isclose(x, -1): + return np.concatenate((alpha_coeffs, zero_add)) + elif np.isclose(x, 0): + return np.concatenate((coil_coeffs, zero_add)) + elif np.isclose(x, 1): + return np.concatenate((beta_coeffs, zero_add)) + + abs_x = np.abs(x) + if abs_x > 1: + err_str = ( + f"The provided value of lambda = {x} is out of lambda definition range, " + f"[-1.0, 1.0]." + ) + Logger.rank0.log(logging.ERROR, err_str) + else: + coil_coeffs[0] *= 1 - abs_x + if x < 0: + alpha_coeffs[0] *= 0.5 * (abs_x - x) + return np.concatenate((alpha_coeffs, coil_coeffs)) + else: + beta_coeffs[0] *= 0.5 * (abs_x + x) + return np.concatenate((beta_coeffs, coil_coeffs))
+ + +
[docs]def prepare_bonds_old(molecules, names, bonds, indices, config): + """Find bonded interactions from connectivity and bond types information + + .. deprecated:: 1.0.0 + :code:`prepare_bonds_old` was replaced by :code:`prepare_bonds` for + use with compiled Fortran kernels prior to 1.0.0 release. + + Prepares the necessary equilibrium and bond strength information needed by + the intramolecular interaction functions. This is performed locally on each + MPI rank, as the domain decomposition ensures that for all molecules *all* + consituent particles are always contained on *the same* MPI rankself. + + This function traverses the bond connectivity information provided in the + structure/topology input file and indentifies any two-, three-, or + four-particle potential bonds. For each connected chain of two, three, or + four particles, a matching to bond types is attempted. If the corresponding + names match, a bond object is initialized. + + In order to investigate the connectivity, a graph is created using + networkx functionality. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2 : list + List of lists containing *local* particle indices, equilibrium + distance, and bond strength coefficient for each reconstructed + two-particle bond. + bonds_3 : + List of lists containing *local* particle indices, equilibrium angle, + and bond strength coefficient for each reconstructed three-particle + bond. + bonds_4 : + List of lists containing *local* particle indices, dihedral type index, + and dihedral coefficients for each reconstructed four-particle + torsional bond. + bb_index : list + List indicating the dihedral type of each four-particle bond in + :code:`bonds_4`. + + See also + -------- + Bond : + Two-particle bond type dataclass. + Angle : + Three-particle angular bond type dataclass. + Dihedral : + Four-particle torsional bond type dataclass. + hymd.input_parser.Config + Configuration dataclass handler. + """ + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + bb_index = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + bb_dihedral = 0 + bond_graph = nx.Graph() + + for local_index, global_index in enumerate(indices): + if molecules[local_index] != mol: + continue + + bond_graph.add_node( + global_index, + name=names[local_index].decode("UTF-8"), + local_index=local_index, + ) + for bond in [b for b in bonds[local_index] if b != -1]: + bond_graph.add_edge(global_index, bond) + + connectivity = nx.all_pairs_shortest_path(bond_graph) + for c in connectivity: + i = c[0] + connected = c[1] + for j, path in connected.items(): + if len(path) == 2 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for b in config.bonds: + match_forward = name_i == b.atom_1 and name_j == b.atom_2 + match_backward = name_i == b.atom_2 and name_j == b.atom_1 + if match_forward or match_backward: + bonds_2.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[j]["local_index"], + b.equilibrium, + b.strength, + ] + ) + + if len(path) == 3 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_mid = bond_graph.nodes()[path[1]]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for a in config.angle_bonds: + match_forward = ( + name_i == a.atom_1 + and name_mid == a.atom_2 + and name_j == a.atom_3 + ) + match_backward = ( + name_i == a.atom_3 + and name_mid == a.atom_2 + and name_j == a.atom_1 + ) + if match_forward or match_backward: + bonds_3.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[path[1]]["local_index"], + bond_graph.nodes()[j]["local_index"], + np.radians(a.equilibrium), + a.strength, + ] + ) + + all_paths_len_four = find_all_paths(bond_graph, i, 3) + for p in all_paths_len_four: + name_i = bond_graph.nodes()[i]["name"] + name_mid_1 = bond_graph.nodes()[p[1]]["name"] + name_mid_2 = bond_graph.nodes()[p[2]]["name"] + name_j = bond_graph.nodes()[p[3]]["name"] + + for a in config.dihedrals: + match_forward = ( + name_i == a.atom_1 + and name_mid_1 == a.atom_2 + and name_mid_2 == a.atom_3 + and name_j == a.atom_4 + ) + if ( + match_forward + and [ + bond_graph.nodes()[p[3]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[i]["local_index"], + a.coeffs, + a.dih_type, + ] + not in bonds_4 + ): + bonds_4.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[3]]["local_index"], + a.coeffs, + a.dih_type, + ] + ) + if a.dih_type == 1: + bb_dihedral = len(bonds_4) + + if bb_dihedral: + bb_index.append(bb_dihedral - 1) + + return bonds_2, bonds_3, bonds_4, bb_index
+ + +
[docs]def prepare_index_based_bonds(molecules, topol): + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + resid = mol + 1 + top_summary = topol["system"]["molecules"] + resname = None + test_mol_number = 0 + for molname in top_summary: + test_mol_number += molname[1] + if resid <= test_mol_number: + resname = molname[0] + break + + if resname is None: + break + + if "bonds" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for bond in topol[resname]["bonds"]: + index_i = bond[0] - 1 + first_id + index_j = bond[1] - 1 + first_id + # bond[2] is the bond type, inherited by the itp format. Not used + equilibrium = bond[3] + strength = bond[4] + bonds_2.append([index_i, index_j, equilibrium, strength]) + + if "angles" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["angles"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + # angle[3] is the angle type, inherited by the itp format. Not used + equilibrium = np.radians(angle[4]) + strength = angle[5] + bonds_3.append([index_i, index_j, index_k, equilibrium, strength]) + + if "dihedrals" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["dihedrals"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + index_l = angle[3] - 1 + first_id + dih_type = angle[4] + coeff = angle[5] + if dih_type == 0 and isinstance(coeff[0], (float, int)): + coeff = propensity_potential_coeffs(coeff[0]) + elif dih_type == 1 and len(coeff) == 3: + coeff = np.array( + propensity_potential_coeffs(coeff[0][0]).tolist() + + coeff[1:] + ) + elif dih_type == 2: + coeff = np.array(coeff) + else: + coeff = np.insert(np.array(coeff), 2, np.zeros((2, 5)), axis=0) + bonds_4.append([index_i, index_j, index_k, index_l, coeff, dih_type, 0]) + return bonds_2, bonds_3, bonds_4
+ + +
[docs]def prepare_bonds(molecules, names, bonds, indices, config, topol=None): + """Rearrange the bond information for usage in compiled Fortran kernels + + Restructures the lists resulting from the execution of + :code:`prepare_bonds_old` into numpy arrays suitable for calls to optimized + Fortran code calculating bonded forces and energiesself. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2_atom_1 : (B,) numpy.ndarray + Local index of particle 1 for each of :code:`B` constructed + two-particle bonds. + bonds_2_atom_2 : (B,) numpy.ndarray + Local index of particle 2 for each of :code:`B` constructed + two-particle bonds. + bonds_2_equilibrium : (B,) numpy.ndarray + Equilibrium distance for each of :code:`B` constructed two-particle + bonds. + bonds_2_strength : (B,) numpy.ndarray + Bond strength for each of :code:`B` constructed two-particle + bonds. + bonds_3_atom_1 : (A,) numpy.ndarray + Local index of particle 1 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_2 : (A,) numpy.ndarray + Local index of particle 2 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_3 : (A,) numpy.ndarray + Local index of particle 3 for each of :code:`A` constructed + three-particle bonds. + bonds_3_equilibrium : (A,) numpy.ndarray + Equilibrium angle for each of :code:`A` constructed three-particle + bonds. + bonds_3_strength : (A,) numpy.ndarray + Bond strength for each of :code:`A` constructed three-particle + bonds. + bonds_4_atom_1 : (D,) numpy.ndarray + Local index of particle 1 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_2 : (D,) numpy.ndarray + Local index of particle 2 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_3 : (D,) numpy.ndarray + Local index of particle 3 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_4 : (D,) numpy.ndarray + Local index of particle 4 for each of :code:`D` constructed + four-particle bonds. + bonds_4_coeff : (D,) numpy.ndarray + Cosine series coefficients for each of :code:`D` constructed + four-particle bonds. + bonds_4_type : (D,) numpy.ndarray + Dihedral type for each of :code:`D` constructed four-particle + bonds. + bonds_4_last : (D,) numpy.ndarray + Flags indicating if :code:`dih_type` is :code:`1` for each of :code:`D` + constructed four-particle bonds. + + See also + -------- + prepare_bonds_old : + Used internally to reconstruct the bonded interactions types from the + connectivity information in the structure/topology input file and the + bonded types specified in the configuration file. + """ + if topol is not None: + bonds_2, bonds_3, bonds_4 = prepare_index_based_bonds( + molecules, topol + ) + else: + bonds_2, bonds_3, bonds_4, bb_index = prepare_bonds_old( + molecules, names, bonds, indices, config + ) + + # Bonds + bonds_2_atom1 = np.empty(len(bonds_2), dtype=int) + bonds_2_atom2 = np.empty(len(bonds_2), dtype=int) + bonds_2_equilibrium = np.empty(len(bonds_2), dtype=np.float64) + bonds_2_strength = np.empty(len(bonds_2), dtype=np.float64) + for i, b in enumerate(bonds_2): + bonds_2_atom1[i] = b[0] + bonds_2_atom2[i] = b[1] + bonds_2_equilibrium[i] = b[2] + bonds_2_strength[i] = b[3] + + # Angles + bonds_3_atom1 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom2 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom3 = np.empty(len(bonds_3), dtype=int) + bonds_3_equilibrium = np.empty(len(bonds_3), dtype=np.float64) + bonds_3_strength = np.empty(len(bonds_3), dtype=np.float64) + for i, b in enumerate(bonds_3): + bonds_3_atom1[i] = b[0] + bonds_3_atom2[i] = b[1] + bonds_3_atom3[i] = b[2] + bonds_3_equilibrium[i] = b[3] + bonds_3_strength[i] = b[4] + # Dihedrals + bonds_4_atom1 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom2 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom3 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom4 = np.empty(len(bonds_4), dtype=int) + number_of_coeff = 6 + len_of_coeff = 5 + bonds_4_coeff = np.empty( + (len(bonds_4), number_of_coeff, len_of_coeff), dtype=np.float64 + ) + bonds_4_type = np.empty(len(bonds_4), dtype=int) + bonds_4_last = np.zeros(len(bonds_4), dtype=int) + for i, b in enumerate(bonds_4): + bonds_4_atom1[i] = b[0] + bonds_4_atom2[i] = b[1] + bonds_4_atom3[i] = b[2] + bonds_4_atom4[i] = b[3] + bonds_4_coeff[i] = np.resize(b[4], (number_of_coeff, len_of_coeff)) + bonds_4_type[i] = b[5] + if topol is not None: + bonds_4_last[i] = b[6] + if topol is None: + bonds_4_last[bb_index] = 1 + + return ( + bonds_2_atom1, + bonds_2_atom2, + bonds_2_equilibrium, + bonds_2_strength, + bonds_3_atom1, + bonds_3_atom2, + bonds_3_atom3, + bonds_3_equilibrium, + bonds_3_strength, # noqa: E501 + bonds_4_atom1, + bonds_4_atom2, + bonds_4_atom3, + bonds_4_atom4, + bonds_4_coeff, + bonds_4_type, + bonds_4_last, # noqa: E501 + )
+ + +
[docs]def compute_bond_forces__plain(f_bonds, r, bonds_2, box_size): + """Computes forces resulting from bonded interactions + + .. deprecated:: 1.0.0 + :code:`compute_bond_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_bonds.fill(0.0) + energy = 0.0 + + for i, j, r0, k in bonds_2: + ri = r[i, :] + rj = r[j, :] + rij = rj - ri + + # Apply periodic boundary conditions to the distance rij + for dim in range(len(rij)): + rij[dim] -= box_size[dim] * np.around(rij[dim] / box_size[dim]) + dr = np.linalg.norm(rij) + df = -k * (dr - r0) + f_bond_vector = df * rij / dr + f_bonds[i, :] -= f_bond_vector + f_bonds[j, :] += f_bond_vector + + energy += 0.5 * k * (dr - r0) ** 2 + return energy
+ + +
[docs]def compute_angle_forces__plain(f_angles, r, bonds_3, box_size): + """Computes forces resulting from angular interactions + + .. deprecated:: 1.0.0 + :code:`compute_angle_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_angles.fill(0.0) + energy = 0.0 + + for a, b, c, theta0, k in bonds_3: + ra = r[a, :] - r[b, :] + rc = r[c, :] - r[b, :] + + for dim in range(len(ra)): + ra[dim] -= box_size[dim] * np.around(ra[dim] / box_size[dim]) + rc[dim] -= box_size[dim] * np.around(rc[dim] / box_size[dim]) + + xra = 1.0 / np.sqrt(np.dot(ra, ra)) + xrc = 1.0 / np.sqrt(np.dot(rc, rc)) + ea = ra * xra + ec = rc * xrc + + cosphi = np.dot(ea, ec) + theta = np.arccos(cosphi) + xsinph = 1.0 / np.sqrt(1.0 - cosphi**2) + + d = theta - theta0 + f = -k * d + + xrasin = xra * xsinph * f + xrcsin = xrc * xsinph * f + + fa = (ea * cosphi - ec) * xrasin + fc = (ec * cosphi - ea) * xrcsin + + f_angles[a, :] += fa + f_angles[c, :] += fc + f_angles[b, :] -= fa + fc + # f_angles[b, :] += -(fa + fc) + + energy -= 0.5 * f * d + + return energy
+ + +
[docs]def compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size): + """Computes forces resulting from dihedral interactions + + .. deprecated:: 1.0.0 + :code:`compute_dihedral_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_dihedrals.fill(0.0) + energy = 0.0 + + for a, b, c, d, coeffs, phase in bonds_4: + f = r[a, :] - r[b, :] + g = r[b, :] - r[c, :] + h = r[d, :] - r[c, :] + + for dim in range(3): + f -= box_size[dim] * np.around(f[dim] / box_size[dim]) + g -= box_size[dim] * np.around(g[dim] / box_size[dim]) + h -= box_size[dim] * np.around(h[dim] / box_size[dim]) + + v = np.cross(f, g) + w = np.cross(h, g) + vv = np.dot(v, v) + ww = np.dot(w, w) + gn = np.linalg.norm(g) + + cosphi = np.dot(v, w) + sinphi = np.dot(np.cross(v, w), g) / gn + phi = np.arctan2(sinphi, cosphi) + + fg = np.dot(f, g) + hg = np.dot(h, g) + sc = v * fg / (vv * gn) - w * hg / (ww * gn) + + df = 0 + + for m in range(len(coeffs[0])): + energy += coeffs[0][m] * (1 + np.cos(m * phi - coeffs[1][m])) + df += m * coeffs[0][m] * np.sin(m * phi - coeffs[1][m]) + + force_on_a = df * gn * v / vv + force_on_d = df * gn * w / ww + + f_dihedrals[a, :] -= force_on_a + f_dihedrals[b, :] += df * sc + force_on_a + f_dihedrals[c, :] -= df * sc + force_on_d + f_dihedrals[d, :] += force_on_d + return energy
+ + +
[docs]def dipole_forces_redistribution( + f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb +): + """Redistribute electrostatic forces calculated from topologically + reconstructed ghost dipole point charges to the backcone atoms of the protein. + """ + f_on_bead.fill(0.0) + for i, j, k, l, fd, matrix, dih_type, is_last in zip( + a, b, c, d, f_dipoles, trans_matrices, type_array, last_bb + ): + if dih_type == 1: + sum_force = fd[0] + fd[1] + diff_force = fd[0] - fd[1] + f_on_bead[i] += matrix[0] @ diff_force # Atom A + f_on_bead[j] += matrix[1] @ diff_force + 0.5 * sum_force # Atom B + f_on_bead[k] += matrix[2] @ diff_force + 0.5 * sum_force # Atom C + + if is_last == 1: + sum_force = fd[2] + fd[3] + diff_force = fd[2] - fd[3] + f_on_bead[j] += matrix[3] @ diff_force + f_on_bead[k] += matrix[4] @ diff_force + 0.5 * sum_force + f_on_bead[l] += matrix[5] @ diff_force + 0.5 * sum_force
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/_modules/hymd/hamiltonian.html b/v1.0.7/_modules/hymd/hamiltonian.html new file mode 100644 index 00000000..f447179e --- /dev/null +++ b/v1.0.7/_modules/hymd/hamiltonian.html @@ -0,0 +1,787 @@ + + + + + + hymd.hamiltonian — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.hamiltonian

+"""Interaction energy functionals.
+
+Implements field--particle interaction energy functionals depending on the
+field configuration. Extending HyMD with a new Hamiltonian is done by
+subclassing the :code:`Hamiltonian` superclass with logic intialized in the
+constructor.
+
+The grid-independent filtering function is defined in the :code:`Hamiltonian`
+superclass constructor. Hijack :code:`self.H` in a subclass to change the
+filter.
+"""
+import numpy as np
+import sympy
+
+
+
[docs]class Hamiltonian: + """Interaction energy functional superclass""" + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + self.config = config + self._setup()
+ +
[docs] def _setup(self): + """Superclass setup + + Sets up the grid-independent filtering function :code:`H`, and the + SymPy logic for symbolically differentiating interaction energy + functionals in Hamiltonian subclasses. + """ + if not hasattr(self.config, "simulation_volume"): + self.config.simulation_volume = np.prod(np.asarray(self.config.box_size)) + if not self.config.barostat: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.config.a = self.config.rho0 + if not self.config.rho0: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.phi = sympy.var("phi:%d" % (self.config.n_types)) + k = sympy.var("k:%d" % (3)) + + # electrostatics variables + self.psi = sympy.var("psi") + self.phi_q = sympy.var("phi_q") + if not self.config.self_energy: + self.config.self_energy = 0.0 + + def fourier_space_window_function(k): + return sympy.functions.elementary.exponential.exp( + -0.5 + * self.config.sigma**2 + * (k0**2 + k1**2 + k2**2) # noqa: F821, E501 + ) + + self.window_function_lambda = sympy.lambdify( + [k], fourier_space_window_function(k) + ) + + def H(k, v): + return v * self.window_function_lambda(k) + + self.H = H
+ + +
[docs]class SquaredPhi(Hamiltonian): + """Simple squared density interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + \\sum_k \\tilde\\phi_k + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`rho_0` is the + average density of the fully homogenous system. Expressing the species + densities in terms of fluctuations from the average, + + .. math:: + + \\mathrm{d}\\tilde\\phi_k = \\rho_0 - \\tilde\\phi_k, + + it is evident that this interaction energy functional is a slight change of + the :code:`DefaultNoChi` Hamiltonian, as the expanded interaction energy + density becomes + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + 6\\rho_0\\left[ + \\sum_k \\mathrm{d}\\tilde\\phi_k + \\right] + + + 9\\rho_0^2 + + + \\sum_k \\mathrm{d}\\tilde\\phi_k^2 + + + \\prod_{k\\not=l} + \\mathrm{d}\\tilde\\phi_k \\mathrm{d}\\tilde\\phi_l + \\right), + + identical to :code:`DefaultNoChi` apart from a constant energy shift + :math:`9\\rho_0^2`(which does not impact dynamics) and the + :math:`\\rho_0`--:math:`\\mathrm{d}\\tilde\\phi_k` cross-terms. These + cross-terms constitute contributions to the energy linear in + :math:`\\mathrm{d}\\tilde\\phi_k` absent in :code:`DefaultNoChi`, which has + only quadratic terms present. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(SquaredPhi, self).__init__(config) + super(SquaredPhi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0): + return 0.5 / (kappa * rho0) * (sum(phi)) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + ): + V_incompressibility = 1 / (kappa * rho0) * sum(phi) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultNoChi(Hamiltonian): + """Incompressibility-only interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. The :code:`SquaredPhi` Hamiltonian implements a similar + functional with an additional linear term component depending on + + .. math:: + + \\mathmr{d}\\tilde\\phi_k = \\tilde\\phi_k - \\rho_0 + + and not :math:`\\mathrm{d}\\tilde\\phi_k^2`. No explicit inter-species + interaction is present apart from the indirect interaction through the + incompressibility. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + hymd.input_parser.Config : + Configuration dataclass handler. + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultNoChi, self).__init__(config) + super(DefaultNoChi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0, a=self.config.a): + return 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultWithChi(Hamiltonian): + """Incompressibility and :math:`\\chi`-interactions energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = + \\frac{1}{2\\rho_0} + \\sum_{k,l}\\chi_{kl} \\tilde\\phi_k \\tilde\\phi_l + + + \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. :math:`\\chi_{ij}` is the Flory-Huggins-like + inter-species mixing energy. + """ + +
[docs] def __init__(self, config, unique_names, type_to_name_map): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultWithChi, self).__init__(config) + super(DefaultWithChi, self)._setup() + self.setup(unique_names, type_to_name_map)
+ +
[docs] def setup(self, unique_names, type_to_name_map): + """Setup the interaction energy potential and the external potential + + Parameters + ---------- + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + """ + self.type_to_name_map = type_to_name_map + self.chi_type_dictionary = { + tuple(sorted([c.atom_1, c.atom_2])): c.interaction_energy + for c in self.config.chi + } + self.phi_laplacian = [ + sympy.var("phi_laplacian%d(0:%d)" % (t, 3)) + for t in range(self.config.n_types) + ] + + def w( + phi, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + interaction = 0.0 + for i in range(self.config.n_types): + for j in range(i + 1, self.config.n_types): + ni = type_to_name_map[i] + nj = type_to_name_map[j] + names = sorted([ni, nj]) + c = chi_type_dictionary[tuple(names)] + + interaction += c * phi[i] * phi[j] / rho0 + incompressibility = 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + return incompressibility + interaction + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + t, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + + V_interaction = 0.0 + nk = type_to_name_map[t] + for i in range(self.config.n_types): + ni = type_to_name_map[i] + names = sorted([nk, ni]) + if ni != nk: + c = chi_type_dictionary[tuple(names)] + else: + c = 0.0 + # uncomment to count diagonal chi terms: + # c = chi_type_dictionary[tuple(names)] + V_interaction += c * phi[i] / rho0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[t])) + for t in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +def get_hamiltonian(config): + """Return appropriate Hamiltonian object based on the + config.hamiltonian string. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ---------- + hamiltonian : Hamiltonian + Hamiltonian object. + """ + if config.hamiltonian.lower() == "defaultnochi": + hamiltonian = DefaultNoChi(config) + elif config.hamiltonian.lower() == "defaultwithchi": + hamiltonian = DefaultWithChi( + config, config.unique_names, config.type_to_name_map + ) + elif config.hamiltonian.lower() == "squaredphi": + hamiltonian = SquaredPhi(config) + + return hamiltonian +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/_modules/hymd/input_parser.html b/v1.0.7/_modules/hymd/input_parser.html new file mode 100644 index 00000000..28481d19 --- /dev/null +++ b/v1.0.7/_modules/hymd/input_parser.html @@ -0,0 +1,1625 @@ + + + + + + hymd.input_parser — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.input_parser

+"""Parses and handles the configuration information provided for the simulation
+"""
+import copy
+import tomli
+import datetime
+import logging
+import warnings
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass, field
+from typing import List, Union, ClassVar
+from .force import Bond, Angle, Dihedral, Chi, Dielectric_type, propensity_potential_coeffs
+from .barostat import Target_pressure
+from .logger import Logger
+
+
+
[docs]@dataclass +class Config: + """Configuration object + + Handles and verifies the simulation configuration specified in the + configuration file. + + Attributes + ---------- + gas_constant : float + Constant value of the gas constant, R (equivalently the Boltzmann + constant) in the units used internally in HyMD. + coulomb_constant : float + Constant value of the Coulomb constant which converts electric field + values to forces and electric potential values to energies in the units + used internally in HyMD. + n_steps: int + Number of time steps in the simulation. + time_step: float + *Outer* time step used in the simulation. If the rRESPA intergrator is + used, the *inner* time step (the time step used in the integration of + intramolecular bending, stretching, and torsional forces) is + :code:`time_step / respa_inner`. + box_size : list[float] or (D,) numpy.ndarray + Simulation box size of simulation in :code:`D` dimensions in units of + nanometers. + mesh_size : list[int] or int or numpy.ndarray + Number of grid points used for the discrete density grid. + sigma : float + Filter width representing the effective coarse-graining level of the + particles in the simulation. + kappa : float + Compressibility parameter used in the relaxed incompressibility term in + the interaction energy functional. + n_print : int, optional + Frequency of trajectory/energy output to the H5MD trajectory/energy + output file (in units of number of time steps). + tau : float, optional + The time scale of the CSVR thermostat coupling. + start_temperature : float, optional + Generate starting temperature by assigning all particle velocities + randomly according to the Maxwell-Boltzmann distribution at + :code:`start_temperature` Kelvin prior to starting the simulation. + target_temperature : float, optional + Couple the system to a heat bath at :code:`target_temperature` Kelvin. + mass : float, optional + Mass of the particles in the simulation. + hamiltonian : str, optional + Specifies the interaction energy functional :math:`W[\\tilde\\phi]` + for use with the particle-field interactions. Options: + :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`. + domain_decomposition : int, optional + Specifies the interval (in time steps) of domain decomposition + exchange, involving all MPI ranks sending and receiving particles + according to the particles’ positions in the integration box and the + MPI ranks’ assigned domain. + integrator : str, optional + Specifies the time integrator used in the simulation. Options: + :code:`velocity-verlet` or :code:`respa`. + respa_inner : int, optional + The number of inner time steps in the rRESPA integrator. This denotes + the number of intramolecular force calculations (stretching, bending, + torsional) are performed between each impulse applied from the field + forces. + file_name : str, optional + File path of the parsed configuration file. + name : str, optional + Name for the simulation. + tags : list[str], optional + Tags for the simulation. + bonds : list[Bond], optional + Specifies harmonic stretching potentials between particles in the + same molecule. + angle_bonds : list[Angle], optional + Specifies harmonic angular bending potentials between particles in the + same molecule. + dihedrals : list[Dihedral], optional + Specifies four-particle torsional potentials by cosine series. + chi : list[Chi], optional + Specifies :math:`\\chi`-interaction parameters between particle + species. + n_particles : int, optional + Specifies the total number of particles in the input. Optional keyword + for validation, ensuring the input HDF5 topology has the correct number + of particles and molecules. + max_molecule_size : int, optional + Maximum size of any single molecule in the system. Used to speed up + distribution of particles onto MPI ranks in a parallel fashion. + n_flush : int, optional + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be + written to disk (in units of number of :code:`n_print`). + thermostat_work : float + Work performed by the thermostat on the system. + thermostat_coupling_groups : list[str], optional + Specifies individual groups coupling independently to the CSVR + thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and + :code:`"C"` type particles, + :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would + thermalise types :code:`"A"` and :code:`"B"` together and couple + :code:`"C"` type particles to a different thermostat (all individual + thermostats are at the same temperature, i.e. target_temperature + Kelvin). + initial_energy : float + Value of the total energy prior to the start of the simulation. + cancel_com_momentum : int, optional + If :code:`True`, the total linear momentum of the center of mass is + removed before starting the simulation. If an integer is specifed, the + total linear momentum of the center of mass is removed every + :code:`remove_com_momentum` time steps. If :code:`False`, the linear + momentum is never removed. + coulombtype : str, optional + Specifies the type of electrostatic Coulomb interactions in the system. + The strength of the electrostatic forces is modulated by the relative + dielectric constant of the simulation medium, specified with the + :code:`dielectric_const` keyword. Charges for individual particles are + specified in the structure/topology HDF5 input file, not in the + configuration file. If no charges (or peptide backbone dipoles) are + present, the electrostatic forces will not be calculated even if this + keyword is set to :code:`"PIC_Spectral"`. + dielectric_const : float, optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. When + using helical propensity dihedrals, this keyword must be specified—even + if electrostatics are not included with the :code:`coulombtype` + keyword. + dielectric_type: list[float], optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. The list assigns + relative dielectric values to each bead type, and an anisotropic + dielectric function is obtained from a weighted average. + + + See also + -------- + hymd.input_parser.Bond : + Two-particle bond type dataclass. + hymd.input_parser.Angle : + Three-particle bond type dataclass. + hymd.input_parser.Dihedral : + Four-particle bond type dataclass. + """ + + gas_constant: ClassVar[float] = 0.0083144621 # kJ mol-1 K-1 + coulomb_constant: ClassVar[float] = 138.935458 # kJ nm mol-1 e-2 + + n_steps: int + time_step: float + mesh_size: Union[Union[List[int], np.ndarray], int] + sigma: float + kappa: float + + dtype: np.dtype = None + box_size: Union[List[float], np.ndarray] = None + n_print: int = None + tau: float = None + start_temperature: Union[float, bool] = None + target_temperature: Union[float, bool] = None + mass: float = None + hamiltonian: str = None + domain_decomposition: Union[int, bool] = None + integrator: str = None + respa_inner: int = 1 + file_name: str = "<config file path unknown>" + name: str = None + tags: List[str] = field(default_factory=list) + bonds: List[Bond] = field(default_factory=list) + angle_bonds: List[Angle] = field(default_factory=list) + dihedrals: List[Dihedral] = field(default_factory=list) + chi: List[Chi] = field(default_factory=list) + n_particles: int = None + max_molecule_size: int = None + n_flush: int = None + thermostat_work: float = 0.0 + thermostat_coupling_groups: List[List[str]] = field(default_factory=list) + initial_energy: float = None + cancel_com_momentum: Union[int, bool] = False + coulombtype: str = None + convergence_type: str = None + pol_mixing: float = None + dielectric_const: float = None + conv_crit: float = None + dielectric_type: List[Dielectric_type] = field(default_factory=list) + self_energy: float = None + type_charges: Union[List[float], np.ndarray] = None + + # For NPT runs + rho0: float = None + a: float = None + pressure: bool = False + barostat: str = None + barostat_type: str = None + tau_p: float = None + target_pressure: List[Target_pressure] = field(default_factory=list) + n_b: int = None + m: List[float] = field(default_factory=list) + + def __str__(self): + target_pressure_str = "\ttarget_pressure:\n" + "".join( + "\t\tP_L: " + + f"{self.target_pressure.P_L}\n" + + "\t\tP_N: " + + f"{self.target_pressure.P_N}\n" + ) + bonds_str = "\tbonds:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " f"{k.equilibrium}, {k.strength}\n") + for k in self.bonds + ] + ) + angle_str = "\tangle_bonds:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3}: " + + f"{k.equilibrium}, {k.strength}\n" + ) + for k in self.angle_bonds + ] + ) + dihedrals_str = "\tdihedrals:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: " + # This might need to be fixed/made prettier, probably + # there's an easier way + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ).join( + map( + str, + [ + [round(num, 3) for num in c_in] + if isinstance(c_in, list) + else c_in + for c_in in k.coeffs + ], + ) + ) + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ) + + f"dih_type = {k.dih_type}\n" + ) + for k in self.dihedrals + ] + ) + chi_str = "\tchi:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " + f"{k.interaction_energy}\n") + for k in self.chi + ] + ) + + """ If dielectric wanted as dictionary + dielectric_type_str = "\tdielectric_type:\n" + "".join( + [ + (f"\t\t{k.atom_1}: " + f"{k.dielectric_value}\n") + for k in self.dielectric_type + ] + ) + + """ + + thermostat_coupling_groups_str = "" + if any(self.thermostat_coupling_groups): + thermostat_coupling_groups_str = ( + "\tthermostat_coupling_groups:\n" + + "".join( + [ + "\t\t" + ", ".join([f"{n}" for n in ng]) + "\n" + for ng in self.thermostat_coupling_groups + ] + ) + ) + + ret_str = f'\n\n\tConfig: {self.file_name}\n\t{50 * "-"}\n' + for k, v in self.__dict__.items(): + if k not in ( + "target_pressure", + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "thermostat_coupling_groups", + ): + ret_str += f"\t{k}: {v}\n" + ret_str += ( + target_pressure_str + + bonds_str + + angle_str + + dihedrals_str + + chi_str + + thermostat_coupling_groups_str + ) + return ret_str
+ + +
[docs]def read_config_toml(file_path): + with open(file_path, "r") as in_file: + file_content = in_file.read() + return file_content
+ +
[docs]def parse_config_toml(toml_content, file_path=None, comm=MPI.COMM_WORLD): + config_dict = {} + + # read toml to a dictionary + toml_content = tomli.loads(toml_content) + + # Defaults = None + for n in ( + "box_size", + "n_print", + "tau", + "start_temperature", + "target_temperature", + "mass", + "hamiltonian", + "domain_decomposition", + "integrator", + "name", + "n_particles", + "max_molecule_size", + "coulombtype", + "convergence_type", + "dielectric_const", + "pol_mixing", + "conv_crit", + "dielectric_type", + "n_b", + "box_size", + "n_flush", + "self_energy", + "dtype", + ): + config_dict[n] = None + + # Defaults = [] + + for n in ( + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "tags", + "m", + "dielectric_type", + "target_pressure", + "type_charges", + ): + config_dict[n] = [] + + # Defaults: bool + config_dict["pressure"] = False + + # Flatten the .toml dictionary, ignoring the top level [tag] directives (if + # any). + for k, v in toml_content.items(): + if isinstance(v, dict): + if k == "nn": # Don't parse diff-hymd optimization options + continue + for nested_k, nested_v in v.items(): + config_dict[nested_k] = nested_v + else: + config_dict[k] = v + for k, v in config_dict.items(): + if k == "bonds": + config_dict["bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["bonds"][i] = Bond( + atom_1=b[0], + atom_2=b[1], + equilibrium=b[2], + strength=b[3], + ) + if k == "angle_bonds": + config_dict["angle_bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["angle_bonds"][i] = Angle( + atom_1=b[0], + atom_2=b[1], + atom_3=b[2], + equilibrium=b[3], + strength=b[4], + ) + if k == "dihedrals": + config_dict["dihedrals"] = [None] * len(v) + for i, b in enumerate(v): + try: + dih_type = int(b[2][0]) + except IndexError: + Logger.rank0.log( + logging.WARNING, "Dihedral type not provided, defaulting to 0." + ) + dih_type = 0 + + # Probably it's better to move this in check_dihedrals? + wrong_len = len(b[1]) not in (1, 2) + wrong_type_1 = len(b[1]) == 1 and not isinstance(b[1][0], float) + wrong_type_2 = len(b[1]) == 2 and not isinstance(b[1][0], list) + if wrong_len or wrong_type_1 or wrong_type_2: + err_str = ( + "The coefficients specified for the dihedral type " + "(0) do not match the correct structure. Either " + "use [lambda] or [[cn_prop], [dn_prop]], or select" + " the correct dihedral type." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise RuntimeError(err_str) + + # FIXME: this is messy af, I don't like it + if dih_type == 0 and isinstance(b[1][0], (float, int)): + coeff = propensity_potential_coeffs(b[1][0]) + elif dih_type == 1 and len(b[1]) == 3: + coeff = np.array( + propensity_potential_coeffs(b[1][0][0]).tolist() + + b[1][1:] + ) + elif dih_type == 2: + coeff = np.array(b[1]) + else: + coeff = np.insert(np.array(b[1]), 2, np.zeros((2, 5)), axis=0) + + config_dict["dihedrals"][i] = Dihedral( + atom_1=b[0][0], + atom_2=b[0][1], + atom_3=b[0][2], + atom_4=b[0][3], + coeffs=coeff, + dih_type=dih_type, + ) + if k == "chi": + config_dict["chi"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0], c[1]]) + config_dict["chi"][i] = Chi( + atom_1=c_[0], atom_2=c_[1], interaction_energy=c[2] + ) + + """ + if k == "dielectric_type": + config_dict["dielectric_type"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0][0]]) + config_dict["dielectric_type"][i] = Dielectric_type( + atom_1=c_[0], dielectric_value=c[1][0] + ) + """ + if k == "target_pressure": + if len(v) == 2: + config_dict["target_pressure"] = Target_pressure( + P_L=v[0], + P_N=v[1], # check condition # V array (still read as array?) + ) + elif len(v) == 1: + config_dict["target_pressure"] = Target_pressure(P_L=v[0], P_N=None) + else: + config_dict["target_pressure"] = Target_pressure(P_L=None, P_N=None) + + if file_path is not None: + config_dict["file_name"] = file_path + + for n in ( + "n_steps", "time_step", "mesh_size", "sigma", "kappa" + ): + if n not in config_dict: + err_str = ( + f"No {n} specified in config file {file_path}. Unable to start" + f" simulation." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return Config(**config_dict)
+ + +
[docs]def check_n_particles(config, indices, comm=MPI.COMM_WORLD): + n_particles = comm.allreduce(len(indices), MPI.SUM) + if config.n_particles is None: + config = copy.deepcopy(config) + config.n_particles = n_particles + info_str = ( + f"No n_particles found in toml file {config.file_name}, defaulting" + f" to indices.shape ({n_particles})" + ) + Logger.rank0.log(logging.INFO, info_str) + return config + + if n_particles != config.n_particles: + warn_str = ( + f"n_particles in {config.file_name} ({config.n_particles}) does " + "not match the shape of the indices array in the .HDF5 file " + f"({n_particles}). Defaulting to using indices.shape " + f"({n_particles})" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.n_particles = n_particles + return config
+ + +
[docs]def check_max_molecule_size(config, comm=MPI.COMM_WORLD): + if config.max_molecule_size is None: + info_str = ( + f"No max_molecule_size found in toml file {config.file_name}, " + f"defaulting to 201" + ) + Logger.rank0.log(logging.INFO, info_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + + if config.max_molecule_size < 1: + warn_str = ( + f"max_molecule_size in {config.file_name} must be a positive " + f"integer, not {config.max_molecule_size}, defaulting to 201" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + return config
+ + +def _find_unique_names(config, names, comm=MPI.COMM_WORLD): + unique_names = np.unique(names) + receive_buffer = comm.gather(unique_names, root=0) + + gathered_unique_names = None + if comm.Get_rank() == 0: + gathered_unique_names = np.unique(np.concatenate(receive_buffer)) + unique_names = comm.bcast(gathered_unique_names, root=0) + unique_names = sorted([n.decode("UTF-8") for n in unique_names]) + config.unique_names = unique_names + config.n_types = len(unique_names) + return config + + +def _setup_type_to_name_map(config, names, types, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + name_to_type_ = {} + for n, t in zip(names, types): + n = n.decode("utf-8") + if n not in name_to_type_: + name_to_type_[n] = t + receive_buffer = comm.gather(name_to_type_, root=0) + gathered_dict = None + if comm.Get_rank() == 0: + gathered_dict = {} + for d in receive_buffer: + for k, v in d.items(): + if k not in gathered_dict: + gathered_dict[k] = v + else: + assert v == gathered_dict[k] + name_to_type_map = comm.bcast(gathered_dict, root=0) + config.name_to_type_map = name_to_type_map + config.type_to_name_map = {v: k for k, v in name_to_type_map.items()} + return config + + +
[docs]def check_bonds(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for b in config.bonds: + if b.atom_1 not in unique_names or b.atom_2 not in unique_names: + missing_str = "" + if b.atom_1 not in unique_names: + if b.atom_2 not in unique_names: + if b.atom_1 == b.atom_2: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"neither {b.atom_1}, {b.atom_2} atoms" + else: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"no {b.atom_2} atoms" + + warn_str = ( + f"Bond type {b.atom_1}--{b.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_angles(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for a in config.angle_bonds: + if ( + a.atom_1 not in unique_names + or a.atom_2 not in unique_names + or a.atom_3 not in unique_names + ): + missing = [ + a.atom_1 not in unique_names, + a.atom_2 not in unique_names, + a.atom_3 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([a.atom_1, a.atom_2, a.atom_3]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Angle bond type {a.atom_1}--{a.atom_2}--{a.atom_3} " + f"specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_dihedrals(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for d in config.dihedrals: + if ( + d.atom_1 not in unique_names + or d.atom_2 not in unique_names + or d.atom_3 not in unique_names + or d.atom_4 not in unique_names + ): + missing = [ + d.atom_1 not in unique_names, + d.atom_2 not in unique_names, + d.atom_3 not in unique_names, + d.atom_4 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([d.atom_1, d.atom_2, d.atom_3, d.atom_4]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Dihedral type {d.atom_1}--{d.atom_2}--{d.atom_3}--{d.atom_4}" + f" specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_chi(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for c in config.chi: + if c.atom_1 not in unique_names or c.atom_2 not in unique_names: + missing_str = "" + if c.atom_1 not in unique_names: + if c.atom_2 not in unique_names: + if c.atom_1 == c.atom_2: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"neither {c.atom_1}, {c.atom_2} atoms" + else: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"no {c.atom_2} atoms" + + warn_str = ( + f"Chi interaction {c.atom_1}--{c.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + for i, n in enumerate(unique_names): + for m in unique_names[i + 1 :]: + found = False + for c in config.chi: + if (c.atom_1 == n and c.atom_2 == m) or ( + c.atom_1 == m and c.atom_2 == n + ): + found = True + if not found: + config.chi.append(Chi(atom_1=n, atom_2=m, interaction_energy=0.0)) + warn_str = ( + f"Atom types {n} and {m} found in the " + f"system, but no chi interaction {n}--{m} " + f"specified in {config.file_name}. Defaulting to " + f"chi[{n}, {m}] = 0" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_box_size(config, input_box, comm=MPI.COMM_WORLD): + if config.box_size is not None: + config.box_size = np.array(config.box_size, dtype=np.float32) + if input_box.all() and not np.allclose(config.box_size, input_box, atol=0.009): + err_str = ( + f"Box size specified in {config.file_name}: " + f"{config.box_size} does not match input box:" + f"{input_box}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + else: + if input_box.all(): + config.box_size = input_box + else: + err_str = f"No box information found" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + for b in config.box_size: + if b <= 0.0: + err_str = ( + f"Invalid box size specified in {config.file_name}: " + f"{config.box_size}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return config
+ + +
[docs]def check_integrator(config, comm=MPI.COMM_WORLD): + if config.integrator.lower() not in ("velocity-verlet", "respa"): + err_str = ( + f"Invalid integrator specified in {config.file_name}: " + f'{config.integrator}. Available options "velocity-verlet" or ' + f'"respa".' + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + if config.integrator.lower() == "respa": + if isinstance(config.respa_inner, float): + warn_str = ( + f"Number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner} specified " + f"as float, using {int(config.respa_inner)}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = int(config.respa_inner) + elif not isinstance(config.respa_inner, int): + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + + if config.respa_inner <= 0: + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + if config.integrator.lower() == "velocity-verlet" and config.respa_inner != 1: + warn_str = ( + f"Integrator type Velocity-Verlet specified in {config.file_name} " + f"and inner rRESPA time steps set to {config.respa_inner}. " + f"Using respa_inner = 1" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = 1 + + return config
+ + +
[docs]def check_hamiltonian(config, comm=MPI.COMM_WORLD): + valid_hamiltonians = ["defaultnochi", "defaultwithchi", "squaredphi"] + + if config.hamiltonian is None: + if len(config.chi) == 0: + warn_str = ( + f"No hamiltonian form and no chi interactions specified in " + f"{config.file_name}, defaulting to DefaultNoChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultNoChi" + else: + warn_str = ( + f"No hamiltonian form specified in {config.file_name}, but " + f"chi interactions are specified, defaulting to " + f"DefaultWithChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultWithChi" + elif config.hamiltonian.lower() not in valid_hamiltonians: + err_str = ( + f"The specified Hamiltonian {config.hamiltonian} was not " + f"recognized as a valid Hamiltonian." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise NotImplementedError(err_str) + + return config
+ + +
[docs]def check_n_flush(config, comm=MPI.COMM_WORLD): + if config.n_print: + if config.n_flush is None: + config.n_flush = 10000 // config.n_print + return config
+ + +
[docs]def check_n_print(config, comm=MPI.COMM_WORLD): + if ( + not isinstance(config.n_print, int) + and not isinstance(config.n_print, float) + and config.n_print is not None + ): + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if config.n_print is None or config.n_print <= 0: + config.n_print = False + elif not isinstance(config.n_print, int): + if isinstance(config.n_print, float): + warn_str = ( + f"n_print is a float ({config.n_print}), not int, using " + f"{int(round(config.n_print))}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + config.n_print = int(round(config.n_print)) + else: + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + return config
+ + +
[docs]def check_tau(config, comm=MPI.COMM_WORLD): + if config.tau is None and config.target_temperature is not None: + warn_str = "target temp specified but no tau, defaulting 0.7" + config.tau = 0.7 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_start_and_target_temperature(config, comm=MPI.COMM_WORLD): + """Validate provided starting and target thermostat temperatures + + Assesses the provided temperature target and ensures it is a non-negative + floating point number or :code:`False`. Ensures the starting temperature is + a non-negative floating point number or :code:`False`. + + If the value for either is :code:`None`, the returned configuration object + has the values defaulted to :code:`False` in each case. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ------- + validated_config : Config + Configuration object with validated :code:`target_temperature` and + :code:`start_temperature`. + """ + for t in ("start_temperature", "target_temperature"): + if getattr(config, t) is not None: + try: + if getattr(config, t) < 0: + warn_str = ( + f"{t} set to negative value ({getattr(config, t)}), " + f"defaulting to False" + ) + setattr(config, t, False) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + except TypeError as e: + err_str = ( + f"Could not interpret {t} = {repr(getattr(config, t))} as " + f"a number." + ) + raise TypeError(err_str) from e + + if config.start_temperature is None: + config.start_temperature = False + if config.target_temperature is None: + config.target_temperature = False + return config
+ + +
[docs]def check_mass(config, comm=MPI.COMM_WORLD): + if config.mass is None: + info_str = "no mass specified, defaulting to 72.0" + config.mass = 72.0 + Logger.rank0.log(logging.INFO, info_str) + elif not isinstance(config.mass, int) and not isinstance(config.mass, float): + err_str = ( + f"specified mass is invalid type {config.mass}, " f"({type(config.mass)})" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + elif config.mass < 0: + err_str = f"invalid mass specified, {config.mass}" + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + else: + config.mass = float(config.mass) + + return config
+ + +
[docs]def check_domain_decomposition(config, comm=MPI.COMM_WORLD): + dd = config.domain_decomposition + if dd is None or dd is False: + config.domain_decomposition = False + return config + + if isinstance(dd, int): + if dd < 0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + elif isinstance(dd, float): + if dd < 0.0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + else: + warn_str = ( + f"domain_decomposition ({config.domain_decomposition}) is not " + f"an integer, using {int(round(dd))}" + ) + config.domain_decomposition = int(round(dd)) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + else: + err_str = ( + f"invalid value for domain_decomposition " + f"({config.domain_decomposition}) use an integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + return config
+ + +
[docs]def check_name(config, comm=MPI.COMM_WORLD): + if config.name is None: + root_current_time = "" + if comm.Get_rank() == 0: + root_current_time = datetime.datetime.now().strftime("%m/%d/%Y, %H:%M:%S") + current_time = comm.bcast(root_current_time, root=0) + + if config.name is None: + config.name = "sim" + current_time + else: + config.name = str(config.name) + return config
+ + +
[docs]def check_NPT_conditions(config, comm=MPI.COMM_WORLD): + """ + Check validity of barostat_type, barostat, + a, rho0, target_pressure, tau_p + """ + if config.barostat is None: + if ( + config.tau_p is not None + or (config.target_pressure.P_L and config.target_pressure.P_N) is not None + ): + err_str = ( + "barostat not specified but config.tau_p " + "or config.target_pressure specified, cannot start simulation {config.barostat}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.a: + warn_str = "a specified but no barostat," "setting a to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.rho0: + warn_str = ( + "rho0 specified but no barostat," "setting rho0 to average density" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + if config.barostat is not None: + if not config.barostat_type: + config.barostat_type = "berendsen" + warn_str = "barostat_type not specified," "setting to berendsen" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.barostat != "isotropic" and config.barostat != "semiisotropic": + err_str = "barostat option not recognised. Valid options: isotropic, semiisotropic" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.target_pressure.P_L is None: + config.target_pressure.P_L = 1.0 # bar + config.target_pressure.P_N = None + if config.barostat == "semiisotropic": + config.target_pressure.P_N = 1.0 # bar + warn_str = ( + "barostat specified but no target_pressure, defaulting to 1.0 bar" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.tau_p is None: + if config.tau <= 0.1: + config.tau_p = config.tau * 10.0 + else: + config.tau_p = 1.0 + warn_str = "barostat specified but no tau_p, defaulting to " + str( + config.tau_p + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if not config.a: + err_str = "a not specified; cannot start simulation {config.a}" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if not config.rho0: + warn_str = "rho0 not specified;" "setting rho0 to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + return config
+ + +
[docs]def check_thermostat_coupling_groups(config, comm=MPI.COMM_WORLD): + if any(config.thermostat_coupling_groups): + found = [0 for _ in config.unique_names] + unique_names = [n for n in config.unique_names] + for i, group in enumerate(config.thermostat_coupling_groups): + for species in group: + try: + ind = unique_names.index(species) + found[ind] += 1 + except ValueError as e: + err_str = ( + f"Particle species {species} specified in thermostat " + f"coupling group {i}, but no {species} particles were " + "found in the system." + ) + raise ValueError(err_str) from e + if any([True if f > 1 else False for f in found]): + for i, f in enumerate(found): + if f > 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} specified in multiple " + "thermostat coupling groups; " + f"{config.thermostat_coupling_groups}." + ) + raise ValueError(err_str) + if not all([True if f == 1 else False for f in found]): + for i, f in enumerate(found): + if f != 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} not specified in any " + f"thermostat coupling group, but {species} particles " + "were found in the system" + ) + raise ValueError(err_str) + return config
+ + +
[docs]def check_m(config, comm=MPI.COMM_WORLD): + if config.m == []: + config.m = [1.0 for t in range(config.n_types)] + return config
+ + +
[docs]def check_n_b(config, comm=MPI.COMM_WORLD): + if config.n_b is None: + warn_str = f"config.n_b not specified." "Defaulting to 1" + config.n_b = 1 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_cancel_com_momentum(config, comm=MPI.COMM_WORLD): + if isinstance(config.cancel_com_momentum, int): + if config.cancel_com_momentum == 0 or config.cancel_com_momentum < 0: + config.cancel_com_momentum = False + elif not isinstance(config.cancel_com_momentum, bool): + err_str = ( + f"Could not interpret {config.cancel_com_momentum} as an integer " + f"or boolean." + ) + raise ValueError(err_str) + return config
+ + +
[docs]def sort_dielectric_by_type_id(config, charges, types): + """ + Creates a list of length N CG-particles, sorted after the charges from + the input HDF5 file. Used in file_io.py + """ + dielectric_val = np.zeros(config.n_types) + for j in range(config.n_types): + name = config.dielectric_type[j][0][0] + type_id = config.name_to_type_map[name] + dielectric_val[type_id] = config.dielectric_type[j][1][0] + config.dielectric_type = dielectric_val.copy() + + N = len(charges) + len_list = np.zeros(config.n_types) + dielectric_by_types = np.zeros(N) + for i in range(N): + dielectric_by_types[i] = dielectric_val[types[i]] + # print("types ", types) + # print("diel val", dielectric_by_types) + # print("charges", charges) + # print(config.name_to_type_map) + return dielectric_by_types # by types with each particle id
+ + +
[docs]def check_charges_types_list(config, types, charges, comm=MPI.COMM_WORLD): + """ + Creates a list of charge values of length types. + Charges are sorted according to type ID. Used in field.py. + # TODO: this is messy, we should fix it + """ + if charges is None: + config.type_charges = [0.0] * config.n_types + return config + + check_val = -100.0 # some random value that will never be encountered + charges_list = np.full(config.n_types, check_val) # gatherv cant handle None + rank = comm.Get_rank() + # print(charges_list) + for t_ in range(config.n_types): + if t_ in types: + charges_list[t_] = charges[types == t_][0] + + nprocs = int(comm.Get_size()) + recv_charges = None + if rank == 0: + recv_charges = np.full( + config.n_types * nprocs, check_val + ) # gatherv cant handle None + comm.Gather(charges_list, recv_charges, root=0) + + ## make a charges list + if rank == 0: + config_charges = np.zeros(config.n_types) + test_config = np.full(config.n_types, check_val) + for j in range(nprocs): + for i in range(config.n_types): + if recv_charges[i + j * config.n_types] != check_val: + config_charges[i] = recv_charges[i + j * config.n_types] + if np.any([test_config, config_charges]): + continue + else: + break + + # print(config_charges) + # print(config.name_to_type_map) + # print(charges[types == 0][0],charges[types == 1][0],charges[types == 2][0],charges[types == 3][0], + # charges[types == 4][0]) + else: + config_charges = np.zeros(config.n_types) + + comm.Bcast(config_charges, root=0) + # print("config_charges", config_charges , "rank", rank) + # print(recv_charges) + # rank = comm.Get_rank() + # print(all_charges) + config.type_charges = config_charges + return config
+ + +
[docs]def check_dielectric(config, comm=MPI.COMM_WORLD): + """ + Error handling for electrostatics. + Unit testing of toml/tomli input. + """ + err_str_const = "Dielectric constant not given." + if config.coulombtype == "PIC_Spectral": + assert config.dielectric_const != None, err_str_const + + err_str = "Dielectric list is empty." + if config.coulombtype == "PIC_Spectral_GPE": + assert len(config.dielectric_type) != 0, err_str + # default values + if config.pol_mixing is None: + config.pol_mixing = 0.6 + if config.conv_crit is None: + config.conv_crit = 1e-6 + return config
+ + +
[docs]def check_charges(config, charges, comm=MPI.COMM_WORLD): + """Check if charges across ranks sum to zero. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of floats with charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + """ + total_charge = comm.allreduce(np.sum(charges), MPI.SUM) + + if not np.isclose(total_charge, 0.0): + warn_str = ( + f"Charges in the input file do not sum to zero. " + f"Total charge is {total_charge}." + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + # if charges are ok, compute self energy + if config.coulombtype == "PIC_Spectral": + from .field import compute_self_energy_q + + config.self_energy = compute_self_energy_q(config, charges, comm=comm) + + return config
+ + +
[docs]def check_config( + config, indices, names, types, charges, input_box, comm=MPI.COMM_WORLD +): + """Performs various checks on the specfied config to ensure consistency + + Parameters + ---------- + config : Config + Configuration object. + indices : (N,) numpy.ndarray + Array of integer indices for :code:`N` particles. + names : (N,) numpy.ndarray + Array of string names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of integer type indices for :code:`N` particles. + charges : (N,) numpy.ndarray + Array of floats charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + + Returns + ------- + config : Config + Validated configuration object. + """ + config = _find_unique_names(config, names, comm=comm) + if types is not None: + config = _setup_type_to_name_map(config, names, types, comm=comm) + config = check_box_size(config, input_box, comm=comm) + config = check_integrator(config, comm=comm) + config = check_max_molecule_size(config, comm=comm) + config = check_tau(config, comm=comm) + config = check_start_and_target_temperature(config, comm=comm) + config = check_mass(config, comm=comm) + config = check_domain_decomposition(config, comm=comm) + config = check_name(config, comm=comm) + config = check_n_particles(config, indices, comm=comm) + config = check_chi(config, names, comm=comm) + config = check_bonds(config, names, comm=comm) + config = check_angles(config, names, comm=comm) + config = check_dihedrals(config, names, comm=comm) + config = check_hamiltonian(config, comm=comm) + config = check_NPT_conditions(config, comm=comm) + config = check_n_b(config, comm=comm) + config = check_m(config, comm=comm) + config = check_thermostat_coupling_groups(config, comm=comm) + config = check_cancel_com_momentum(config, comm=comm) + config = check_dielectric(config, comm=comm) + config = check_n_print(config, comm=comm) + config = check_n_flush(config, comm=comm) + config = check_charges_types_list(config, types, charges, comm=comm) + if charges is not None: + config = check_charges(config, charges, comm=comm) + + return config
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/_modules/hymd/integrator.html b/v1.0.7/_modules/hymd/integrator.html new file mode 100644 index 00000000..a55979a7 --- /dev/null +++ b/v1.0.7/_modules/hymd/integrator.html @@ -0,0 +1,348 @@ + + + + + + hymd.integrator — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.integrator

+"""Integrates equations of motion.
+
+Implements the Velocity Verlet integrator. The *reversible reference system
+propagator algorithm* (rRESPA) integrator uses the Velocity Verlet functions
+inside the MD loop in the main module.
+"""
+
+
+
[docs]def integrate_velocity(velocities, accelerations, time_step): + """Velocity update step of the Velocity Verlet integration algorithm. + + Computes the velocity update step of the Velocity Verlet algorithm. The + :code:`velocities` argument is **not** changed in place. + + Parameters + ---------- + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + accelerations : (N, D) numpy.ndarray + Array of accelerations of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step + + .. math:: \\mathbf{v}_{\\text{new}} = \\mathbf{v} + \\frac{\\Delta t}{2m} + \\mathbf{f} + + before the positions are moved a full step using the updated half-step + velocities. + + See Also + -------- + integrate_position : The position update step of the Velocity Verlet + algorithm. + """ + return velocities + 0.5 * time_step * accelerations
+ + +
[docs]def integrate_position(positions, velocities, time_step): + """Position update step of the Velocity Verlet integration algorithm. + + Computes the position update step of the Velocity Verlet algorithm. The + :code:`positions` argument is **not** changed in place. + + Parameters + ---------- + positions : (N, D) numpy.ndarray + Array of positions of :code:`N` particles in :code:`D` dimensions. + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step, then the positions are updated a full step using the updated + velocities + + .. math:: \\mathbf{x}_{\\text{new}} = \\mathbf{x} + \\Delta t \\mathbf{v} + + See Also + -------- + integrate_velocity : The velocity update step of the Velocity Verlet + algorithm. + """ + return positions + time_step * velocities
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/_modules/hymd/logger.html b/v1.0.7/_modules/hymd/logger.html new file mode 100644 index 00000000..5dc456ca --- /dev/null +++ b/v1.0.7/_modules/hymd/logger.html @@ -0,0 +1,537 @@ + + + + + + hymd.logger — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.logger

+"""Handles event logging for simulation information, warnings, and errors.
+"""
+import sys
+import os
+import logging
+from mpi4py import MPI
+from .version import __version__
+
+
+
[docs]class MPIFilterRoot(logging.Filter): + """Log output Filter wrapper class for the root MPI rank log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + if self.comm.Get_rank() == 0: + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True + else: + return False
+ + +
[docs]class MPIFilterAll(logging.Filter): + """Log output Filter wrapper class for the all-MPI-ranks log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True
+ + +class MPIFilterStdout(logging.Filter): + """Log output Filter wrapper class for filtering STDOUT log""" + + def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.funcName = "replica 0 " + record.funcName + if MPI.COMM_WORLD.Get_rank() == 0: + record.rank = MPI.COMM_WORLD.Get_rank() + record.size = MPI.COMM_WORLD.Get_size() + return True + else: + return False + + +
[docs]class Logger: + """Log output handler class + + Notes + ----- + This wraps the default python library :code:`logging`, see + `docs.python.org/3/library/logging.html`_. + + .. _`docs.python.org/3/library/logging.html`: + https://docs.python.org/3/library/logging.html + + Attributes + ---------- + level : int + Determines the verbosity level of the log, corresponding to + logging.level. Numerical values :code:`50` (:code:`logging.CRITICAL`), + :code:`40` (:code:`logging.ERROR`), :code:`30` + (:code:`logging.WARNING`), :code:`20` (:code:`logging.INFO`), + :code:`10` (:code:`logging.DEBUG`), and :code:`0` + (:code:`logging.UNSET`) are supported values. Any log event message + less severe than the specified level is ignored. All other event + messages are emitted. + log_file : str + Path to output log file. + format : str + Prepended dump string for each log event. Specifies the log event + level, the module emitting the event, the code line, the enclosing + function name, and the MPI rank writing the message. + date_format : str + Prepends the date before all log event messages. + formatter : logging.Formatter + Formatter handling the prepending of the information in `format` and + `date_format` to each log event message. Used by default for all + loggers. + rank0 : logging.Logger + Default logger object for the root MPI rank. + all_ranks : logging.Logger + Default logger object for messages being emitted from all MPI ranks + simultaneously. + """ + + level = None + log_file = None + format = " %(levelname)-8s [%(filename)s:%(lineno)d] <%(funcName)s> {rank %(rank)d/%(size)d} %(message)s" # noqa: E501 + date_format = "%(asctime)s" + formatter = logging.Formatter(fmt=date_format + format) + rank0 = logging.getLogger("HyMD.rank_0") + all_ranks = logging.getLogger("HyMD.all_ranks") + +
[docs] @classmethod + def setup(cls, default_level=logging.INFO, log_file=None, verbose=False, comm=MPI.COMM_WORLD): + """Sets up the logger object. + + If a :code:`log_file` path is provided, log event messages are output + to it. Otherwise, the logging messages are emitted to stdout. + + Parameters + ---------- + default_level : int, optional + Default verbosity level of the logger. Unless specified, it is + :code:`10` (:code:`logging.INFO`). + log_file : str, optional + Path to output log file. If `None` or not priovided, no log file is + used and all logging is done to stdout. + verbose : bool, optional + Increases the logging level to :code:`30` (:code:`logging.WARNING`) + if True, otherwise leaves the logging level unchanged. + """ + cls.level = default_level + cls.log_file = log_file + + log_to_stdout = False + if verbose: + log_to_stdout = True + + level = default_level + if not verbose: + level = logging.WARNING + cls.rank0.setLevel(level) + cls.all_ranks.setLevel(level) + + root_filter = MPIFilterRoot(comm) + all_filter = MPIFilterAll(comm) + cls.rank0.addFilter(root_filter) + cls.all_ranks.addFilter(all_filter) + + if (not log_file) and (not log_to_stdout): + return + if log_file: + cls.log_file_handler = logging.FileHandler(log_file) + cls.log_file_handler.setLevel(level) + cls.log_file_handler.setFormatter(cls.formatter) + + cls.rank0.addHandler(cls.log_file_handler) + cls.all_ranks.addHandler(cls.log_file_handler) + if log_to_stdout: + cls.log_to_stdout = True + cls.stdout_handler = logging.StreamHandler() + cls.stdout_handler.setLevel(level) + cls.stdout_handler.setStream(sys.stdout) + cls.stdout_handler.setFormatter(cls.formatter) + cls.stdout_handler.addFilter(MPIFilterStdout()) + + cls.rank0.addHandler(cls.stdout_handler) + cls.all_ranks.addHandler(cls.stdout_handler)
+ + +def format_timedelta(timedelta): + days = timedelta.days + hours, rem = divmod(timedelta.seconds, 3600) + minutes, seconds = divmod(rem, 60) + microseconds = timedelta.microseconds + ret_str = "" + if days != 0: + ret_str += f"{days} days " + ret_str += f"{hours:02d}:{minutes:02d}:{seconds:02d}.{microseconds:06d}" + return ret_str + + +def get_version(): + # Check if we are in a git repo and grab the commit hash and the branch if + # we are, append it to the version number in the output specification. + try: + import git + + try: + repo_dir = os.path.abspath( + os.path.join(os.path.dirname(__file__), os.pardir) + ) + repo = git.Repo(repo_dir) + commit = str(repo.head.commit)[:7] + branch = repo.active_branch + version = f"{__version__} [{branch} branch commit {commit}]" + except git.exc.InvalidGitRepositoryError: + version = f"{__version__}" + except ModuleNotFoundError: + version = f"{__version__}" + + return version + + +def print_header(): + banner = r""" + __ __ ____ __ _______ + / / / /_ __/ / /__ _________ _____ ______ / |/ / __ \ + / /_/ / / / / / / _ \/ ___/ __ `/ __ `/ ___/ / /|_/ / / / / + / __ / /_/ / / / __/ / / /_/ / /_/ (__ ) / / / / /_/ / + /_/ /_/\__, /_/_/\___/_/ \__,_/\__,_/____/ /_/ /_/_____/ + /____/ + """ + + refs_set = """ + + [1] Ledum, M.; Sen, S.; Li, X.; Carrer, M.; Feng Y.; Cascella, M.; Bore, S. L. + HylleraasMD: A Domain Decomposition-Based Hybrid Particle-Field Software for Multi-Scale Simulations of Soft Matter. + J. Chem. Theory Comput. 2023. + + [2] Ledum, M.; Carrer, M.; Sen, S.; Li, X.; Cascella, M.; Bore, S. L. + HyMD: Massively parallel hybrid particle-field molecular dynamics in Python. + J. Open Source Softw. 8(84), 4149, 2023. + + [3] Sen, S.; Ledum, M.; Bore, S. L.; Cascella, M. + Soft Matter under Pressure: Pushing Particle–Field Molecular Dynamics to the Isobaric Ensemble. + J Chem Inf Model 2023, 63(7), 1549-9596. + + [4] Bore, S. L.; Cascella, M. + Hamiltonian and alias-free hybrid particle–field molecular dynamics. + J. Chem. Phys. 2020, 153, 094106. + + [5] Pippig, M. PFFT: An extension of FFTW to massively parallel architectures. + SIAM J. Sci. Comput. 2013, 35, C213–C236. + +""" + + version = f"Version {get_version()}" + header = banner + header += version.center(56) + "\n\n" + #header += " Please read and cite the references below:" + header += " PLEASE READ AND CITE THE REFERENCES BELOW:" + header += refs_set + + return header +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/_modules/hymd/thermostat.html b/v1.0.7/_modules/hymd/thermostat.html new file mode 100644 index 00000000..99f922dd --- /dev/null +++ b/v1.0.7/_modules/hymd/thermostat.html @@ -0,0 +1,494 @@ + + + + + + hymd.thermostat — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.thermostat

+"""Scales or otherwise modifies the particle velocities during simulation to
+simulate coupling to an external heat bath with temperature T₀.
+"""
+import numpy as np
+import logging
+from mpi4py import MPI
+from typing import Callable
+from .logger import Logger
+from .input_parser import Config
+
+
+def cancel_com_momentum(velocities, config, comm=MPI.COMM_WORLD):
+    com_velocity = comm.allreduce(np.sum(velocities[...], axis=0), MPI.SUM)
+    velocities[...] = velocities[...] - com_velocity / config.n_particles
+    return velocities
+
+
+def generate_initial_velocities(velocities, config, prng, comm=MPI.COMM_WORLD):
+    kT_start = config.gas_constant * config.start_temperature
+    n_particles_ = velocities.shape[0]
+    velocities[...] = prng.normal(
+        loc=0, scale=kT_start / config.mass, size=(n_particles_, 3)
+    )
+    velocities = cancel_com_momentum(velocities, config, comm=comm)
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    start_kinetic_energy_target = (
+        1.5 * config.gas_constant * config.n_particles * config.start_temperature
+    )
+    factor = np.sqrt(1.5 * config.n_particles * kT_start / kinetic_energy)
+    velocities[...] = velocities[...] * factor
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    Logger.rank0.log(
+        logging.INFO,
+        (
+            f"Initialized {config.n_particles} velocities, target kinetic "
+            f"energy: {start_kinetic_energy_target}, actual kinetic energy "
+            f"generated: {kinetic_energy}"
+        ),
+    )
+    return velocities
+
+
+
[docs]def _random_gaussian(prng: np.random.Generator) -> float: + """Draw a single random number from the standard normal distribution + Generate a number from the Gaussian distribution centered at zero with unit + standard deviation, :math:`N(0, 1)`. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + + Returns + ------- + float + A random number drawn from :math:`N(0, 1)`. + """ + return prng.normal()
+ + +
[docs]def _random_chi_squared(prng: np.random.Generator, M: int) -> float: + """Draw the sum of :code:`M` squared normally distributed values + + The value is generated by the Gamma distribution, in lieu of generating + :code:`M` Gaussian distributed numbers and summing their squares. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + M : int + Number of standard normally distributed numbers in the sum. + + Returns + ------- + float + The sum of :code:`M` squared normally distributed values centered at + zero with unit standard deviation. + + Notes + ----- + The sum of the squares of k independent standard normal random variables is + distributed according to a :math:`\\chi^2` distribution. + + .. math:: + + \\chi^2_1 + \\chi_2^2 + \\chi_3^2 + \\dots + \\chi_M^2 + \\sim + \\sigma^2\\chi^2(k) + + This is a special case of the :math:`\\Gamma` distribution, + :math:`\\Gamma(k/2, 2)`, and may be generated by + + .. math:: + + \\chi^2(k) \\sim 2 \\Gamma(k/2, 2) + + References + ---------- + Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of + Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. + J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246. + """ + return prng.chisquare(M)
+ + +
[docs]def csvr_thermostat( + velocity: np.ndarray, + names: np.ndarray, + config: Config, + prng: np.random.Generator, + comm: MPI.Intracomm = MPI.COMM_WORLD, + random_gaussian: Callable[[np.random.Generator], float] = _random_gaussian, + random_chi_squared: Callable[ + [np.random.Generator, int, float], float + ] = _random_chi_squared, + remove_center_of_mass_momentum: bool = True, +) -> np.ndarray: + """Canonical sampling through velocity rescaling thermostat + + Implements the CSVR thermostat. Rescales the system kinetic energy by a + stochastically chosen factor to keep the temperature constant. Requires + communcation of the kinetic energies calculated locally for each MPI rank. + The random numbers sampled through :code:`random_gaussian` and + :code:`random_chi_squared` are broadcast from the root rank to the other + ranks to ensure the scaling is performed with the same stochasticity for + all particles in the full system. + + The velocities are cleaned of center of mass momentum before the thermostat + is applied, and the center of mass momentum is subsequently reapplied. This + is performed for each thermostat coupling group, i.e. the center of mass + momenta of each *group* is separately removed and reapplied after + thermostatting. + + The implementation here is based on the derivation presented in the 2008 + Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper. + + Parameters + ---------- + velocity : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + names : (N,) numpy.ndarray + Array of particle names. + config : Config + Configuration dataclass containing simulation metadata and parameters. + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + random_gaussian : callable, optional + Function for generating standard normally distributed numbers. + random_chi_squared : callable, optional + Function for generating :math:`\\chi^2`-distributed numbers + remove_center_of_mass_momentum : bool, optional + If True, the center of mass of each coupling group is removed before + the thermostat is applied. The center of mass momenta are added back + after the kinetic energy rescaling is complete. + + See Also + -------- + _random_gaussian : + Used to sample Gaussian-distributed numbers. + _random_chi_squared : + Used to sample :math:`\\chi^2`-distributed numbers. + hymd.input_parser.Config : + Configuration dataclass handler. + + References + ---------- + G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). + G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008). + """ + if not any(config.thermostat_coupling_groups): + config.thermostat_coupling_groups = [config.unique_names.copy()] + for i, group in enumerate(config.thermostat_coupling_groups): + ind = np.where( + np.logical_or.reduce(list(names == np.string_(t) for t in group)) + ) + group_n_particles = comm.allreduce(len(ind[0]), MPI.SUM) + + # Clean velocities of center of mass momentum + if remove_center_of_mass_momentum and group_n_particles > 1: + com_velocity = comm.allreduce(np.sum(velocity[ind], axis=0)) + velocity_clean = velocity[ind] - com_velocity / group_n_particles + K = comm.allreduce(0.5 * config.mass * np.sum(velocity_clean[...] ** 2)) + else: + K = comm.allreduce(0.5 * config.mass * np.sum(velocity[...] ** 2)) + K_target = ( + 1.5 * config.gas_constant * group_n_particles * config.target_temperature + ) + N_f = 3 * group_n_particles + c = np.exp(-(config.time_step * config.respa_inner) / config.tau) + + # Random numbers are identical across ranks because all ranks have + # the same prng after the initialization of the velocities + R = random_gaussian(prng) + SNf = random_chi_squared(prng, N_f - 1) + + alpha2 = ( + c + + (1 - c) * (SNf + R**2) * K_target / (N_f * K) + + 2 * R * np.sqrt(c * (1 - c) * K_target / (N_f * K)) + ) + dK = K * (alpha2 - 1) + alpha = np.sqrt(alpha2) + + if remove_center_of_mass_momentum and group_n_particles > 1: + # Assign velocities and reapply the previously removed center + # of mass momentum removed + velocity_clean *= alpha + velocity[ind] = velocity_clean + com_velocity / group_n_particles + else: + velocity *= alpha + config.thermostat_work += dK
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/_modules/index.html b/v1.0.7/_modules/index.html new file mode 100644 index 00000000..8dc93779 --- /dev/null +++ b/v1.0.7/_modules/index.html @@ -0,0 +1,282 @@ + + + + + + Overview: module code — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+ +
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/v1.0.7/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css new file mode 100644 index 00000000..1b057df2 --- /dev/null +++ b/v1.0.7/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css @@ -0,0 +1 @@ +.badge{border-radius:.25rem;display:inline-block;font-size:75%;font-weight:700;line-height:1;padding:.25em .4em;text-align:center;vertical-align:baseline;white-space:nowrap}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{border-radius:10rem;padding-left:.6em;padding-right:.6em}.badge-primary{background-color:#007bff;color:#fff}.badge-primary[href]:focus,.badge-primary[href]:hover{background-color:#0062cc;color:#fff;text-decoration:none}.badge-secondary{background-color:#6c757d;color:#fff}.badge-secondary[href]:focus,.badge-secondary[href]:hover{background-color:#545b62;color:#fff;text-decoration:none}.badge-success{background-color:#28a745;color:#fff}.badge-success[href]:focus,.badge-success[href]:hover{background-color:#1e7e34;color:#fff;text-decoration:none}.badge-info{background-color:#17a2b8;color:#fff}.badge-info[href]:focus,.badge-info[href]:hover{background-color:#117a8b;color:#fff;text-decoration:none}.badge-warning{background-color:#ffc107;color:#212529}.badge-warning[href]:focus,.badge-warning[href]:hover{background-color:#d39e00;color:#212529;text-decoration:none}.badge-danger{background-color:#dc3545;color:#fff}.badge-danger[href]:focus,.badge-danger[href]:hover{background-color:#bd2130;color:#fff;text-decoration:none}.badge-light{background-color:#f8f9fa;color:#212529}.badge-light[href]:focus,.badge-light[href]:hover{background-color:#dae0e5;color:#212529;text-decoration:none}.badge-dark{background-color:#343a40;color:#fff}.badge-dark[href]:focus,.badge-dark[href]:hover{background-color:#1d2124;color:#fff;text-decoration:none}.border-0{border:0 !important}.border-top-0{border-top:0 !important}.border-right-0{border-right:0 !important}.border-bottom-0{border-bottom:0 !important}.border-left-0{border-left:0 !important}.p-0{padding:0 !important}.pt-0,.py-0{padding-top:0 !important}.pr-0,.px-0{padding-right:0 !important}.pb-0,.py-0{padding-bottom:0 !important}.pl-0,.px-0{padding-left:0 !important}.p-1{padding:.25rem !important}.pt-1,.py-1{padding-top:.25rem !important}.pr-1,.px-1{padding-right:.25rem !important}.pb-1,.py-1{padding-bottom:.25rem !important}.pl-1,.px-1{padding-left:.25rem !important}.p-2{padding:.5rem !important}.pt-2,.py-2{padding-top:.5rem !important}.pr-2,.px-2{padding-right:.5rem !important}.pb-2,.py-2{padding-bottom:.5rem !important}.pl-2,.px-2{padding-left:.5rem !important}.p-3{padding:1rem !important}.pt-3,.py-3{padding-top:1rem !important}.pr-3,.px-3{padding-right:1rem !important}.pb-3,.py-3{padding-bottom:1rem !important}.pl-3,.px-3{padding-left:1rem !important}.p-4{padding:1.5rem !important}.pt-4,.py-4{padding-top:1.5rem !important}.pr-4,.px-4{padding-right:1.5rem !important}.pb-4,.py-4{padding-bottom:1.5rem !important}.pl-4,.px-4{padding-left:1.5rem !important}.p-5{padding:3rem !important}.pt-5,.py-5{padding-top:3rem !important}.pr-5,.px-5{padding-right:3rem !important}.pb-5,.py-5{padding-bottom:3rem !important}.pl-5,.px-5{padding-left:3rem !important}.m-0{margin:0 !important}.mt-0,.my-0{margin-top:0 !important}.mr-0,.mx-0{margin-right:0 !important}.mb-0,.my-0{margin-bottom:0 !important}.ml-0,.mx-0{margin-left:0 !important}.m-1{margin:.25rem !important}.mt-1,.my-1{margin-top:.25rem !important}.mr-1,.mx-1{margin-right:.25rem !important}.mb-1,.my-1{margin-bottom:.25rem !important}.ml-1,.mx-1{margin-left:.25rem !important}.m-2{margin:.5rem !important}.mt-2,.my-2{margin-top:.5rem !important}.mr-2,.mx-2{margin-right:.5rem !important}.mb-2,.my-2{margin-bottom:.5rem !important}.ml-2,.mx-2{margin-left:.5rem !important}.m-3{margin:1rem !important}.mt-3,.my-3{margin-top:1rem !important}.mr-3,.mx-3{margin-right:1rem !important}.mb-3,.my-3{margin-bottom:1rem !important}.ml-3,.mx-3{margin-left:1rem !important}.m-4{margin:1.5rem !important}.mt-4,.my-4{margin-top:1.5rem !important}.mr-4,.mx-4{margin-right:1.5rem !important}.mb-4,.my-4{margin-bottom:1.5rem !important}.ml-4,.mx-4{margin-left:1.5rem !important}.m-5{margin:3rem !important}.mt-5,.my-5{margin-top:3rem !important}.mr-5,.mx-5{margin-right:3rem !important}.mb-5,.my-5{margin-bottom:3rem !important}.ml-5,.mx-5{margin-left:3rem !important}.btn{background-color:transparent;border:1px solid transparent;border-radius:.25rem;color:#212529;cursor:pointer;display:inline-block;font-size:1rem;font-weight:400;line-height:1.5;padding:.375rem .75rem;text-align:center;transition:color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none;vertical-align:middle}.btn:hover{color:#212529;text-decoration:none}.btn:visited{color:#212529}.btn.focus,.btn:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.25);outline:0}.btn.disabled,.btn:disabled{opacity:.65}@media (prefers-reduced-motion: reduce){.btn{transition:none}}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary:visited{color:#fff}.btn-primary:hover{background-color:#0069d9;border-color:#0062cc;color:#fff}.btn-primary.focus,.btn-primary:focus{background-color:#0069d9;border-color:#0062cc;box-shadow:0 0 0 .2rem rgba(0,123,255,0.5);color:#fff}.btn-primary.disabled,.btn-primary:disabled{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary.active:not(:disabled):not(.disabled),.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{background-color:#0062cc;border-color:#005cbf;color:#fff}.btn-primary.active:not(:disabled):not(.disabled):focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-secondary{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary:visited{color:#fff}.btn-secondary:hover{background-color:#5a6268;border-color:#545b62;color:#fff}.btn-secondary.focus,.btn-secondary:focus{background-color:#5a6268;border-color:#545b62;box-shadow:0 0 0 .2rem rgba(108,117,125,0.5);color:#fff}.btn-secondary.disabled,.btn-secondary:disabled{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled),.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{background-color:#545b62;border-color:#4e555b;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled):focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-success{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success:visited{color:#fff}.btn-success:hover{background-color:#218838;border-color:#1e7e34;color:#fff}.btn-success.focus,.btn-success:focus{background-color:#218838;border-color:#1e7e34;box-shadow:0 0 0 .2rem rgba(40,167,69,0.5);color:#fff}.btn-success.disabled,.btn-success:disabled{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success.active:not(:disabled):not(.disabled),.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{background-color:#1e7e34;border-color:#1c7430;color:#fff}.btn-success.active:not(:disabled):not(.disabled):focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-info{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info:visited{color:#fff}.btn-info:hover{background-color:#138496;border-color:#117a8b;color:#fff}.btn-info.focus,.btn-info:focus{background-color:#138496;border-color:#117a8b;box-shadow:0 0 0 .2rem rgba(23,162,184,0.5);color:#fff}.btn-info.disabled,.btn-info:disabled{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info.active:not(:disabled):not(.disabled),.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{background-color:#117a8b;border-color:#10707f;color:#fff}.btn-info.active:not(:disabled):not(.disabled):focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-warning{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning:visited{color:#212529}.btn-warning:hover{background-color:#e0a800;border-color:#d39e00;color:#212529}.btn-warning.focus,.btn-warning:focus{background-color:#e0a800;border-color:#d39e00;box-shadow:0 0 0 .2rem rgba(255,193,7,0.5);color:#212529}.btn-warning.disabled,.btn-warning:disabled{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning.active:not(:disabled):not(.disabled),.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{background-color:#d39e00;border-color:#c69500;color:#212529}.btn-warning.active:not(:disabled):not(.disabled):focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-danger{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger:visited{color:#fff}.btn-danger:hover{background-color:#c82333;border-color:#bd2130;color:#fff}.btn-danger.focus,.btn-danger:focus{background-color:#c82333;border-color:#bd2130;box-shadow:0 0 0 .2rem rgba(220,53,69,0.5);color:#fff}.btn-danger.disabled,.btn-danger:disabled{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger.active:not(:disabled):not(.disabled),.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{background-color:#bd2130;border-color:#b21f2d;color:#fff}.btn-danger.active:not(:disabled):not(.disabled):focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-light{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light:visited{color:#212529}.btn-light:hover{background-color:#e2e6ea;border-color:#dae0e5;color:#212529}.btn-light.focus,.btn-light:focus{background-color:#e2e6ea;border-color:#dae0e5;box-shadow:0 0 0 .2rem rgba(248,249,250,0.5);color:#212529}.btn-light.disabled,.btn-light:disabled{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light.active:not(:disabled):not(.disabled),.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{background-color:#dae0e5;border-color:#d3d9df;color:#212529}.btn-light.active:not(:disabled):not(.disabled):focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-dark{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark:visited{color:#fff}.btn-dark:hover{background-color:#23272b;border-color:#1d2124;color:#fff}.btn-dark.focus,.btn-dark:focus{background-color:#23272b;border-color:#1d2124;box-shadow:0 0 0 .2rem rgba(52,58,64,0.5);color:#fff}.btn-dark.disabled,.btn-dark:disabled{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark.active:not(:disabled):not(.disabled),.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{background-color:#1d2124;border-color:#171a1d;color:#fff}.btn-dark.active:not(:disabled):not(.disabled):focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-primary{border-color:#007bff;color:#007bff}.btn-outline-primary:visited{color:#007bff}.btn-outline-primary:hover{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{background-color:transparent;color:#007bff}.btn-outline-primary.active:not(:disabled):not(.disabled),.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.active:not(:disabled):not(.disabled):focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-secondary{border-color:#6c757d;color:#6c757d}.btn-outline-secondary:visited{color:#6c757d}.btn-outline-secondary:hover{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{background-color:transparent;color:#6c757d}.btn-outline-secondary.active:not(:disabled):not(.disabled),.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.active:not(:disabled):not(.disabled):focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-success{border-color:#28a745;color:#28a745}.btn-outline-success:visited{color:#28a745}.btn-outline-success:hover{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{background-color:transparent;color:#28a745}.btn-outline-success.active:not(:disabled):not(.disabled),.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.active:not(:disabled):not(.disabled):focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-info{border-color:#17a2b8;color:#17a2b8}.btn-outline-info:visited{color:#17a2b8}.btn-outline-info:hover{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{background-color:transparent;color:#17a2b8}.btn-outline-info.active:not(:disabled):not(.disabled),.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.active:not(:disabled):not(.disabled):focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-warning{border-color:#ffc107;color:#ffc107}.btn-outline-warning:visited{color:#ffc107}.btn-outline-warning:hover{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{background-color:transparent;color:#ffc107}.btn-outline-warning.active:not(:disabled):not(.disabled),.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.active:not(:disabled):not(.disabled):focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-danger{border-color:#dc3545;color:#dc3545}.btn-outline-danger:visited{color:#dc3545}.btn-outline-danger:hover{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{background-color:transparent;color:#dc3545}.btn-outline-danger.active:not(:disabled):not(.disabled),.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.active:not(:disabled):not(.disabled):focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-light{border-color:#f8f9fa;color:#f8f9fa}.btn-outline-light:visited{color:#f8f9fa}.btn-outline-light:hover{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{background-color:transparent;color:#f8f9fa}.btn-outline-light.active:not(:disabled):not(.disabled),.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.active:not(:disabled):not(.disabled):focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-dark{border-color:#343a40;color:#343a40}.btn-outline-dark:visited{color:#343a40}.btn-outline-dark:hover{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{background-color:transparent;color:#343a40}.btn-outline-dark.active:not(:disabled):not(.disabled),.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.active:not(:disabled):not(.disabled):focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-link{color:#007bff;font-weight:400;text-decoration:none}.btn-link:hover{color:#0056b3;text-decoration:underline}.btn-link.focus,.btn-link:focus{box-shadow:none;text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{border-radius:.3rem;font-size:1.25rem;line-height:1.5;padding:.5rem 1rem}.btn-group-sm>.btn,.btn-sm{border-radius:.2rem;font-size:.875rem;line-height:1.5;padding:.25rem .5rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input.btn-block[type=button],input.btn-block[type=reset],input.btn-block[type=submit]{width:100%}.stretched-link::after{background-color:rgba(0,0,0,0);bottom:0;content:'';left:0;pointer-events:auto;position:absolute;right:0;top:0;z-index:1}.text-wrap{white-space:normal !important}.card{background-clip:border-box;background-color:#fff;border:1px solid rgba(0,0,0,0.125);border-radius:.25rem;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;min-width:0;position:relative;word-wrap:break-word}.card>hr{margin-left:0;margin-right:0}.card>.list-group:first-child .list-group-item:first-child{border-top-left-radius:.25rem;border-top-right-radius:.25rem}.card>.list-group:last-child .list-group-item:last-child{border-bottom-left-radius:.25rem;border-bottom-right-radius:.25rem}.card-body{-ms-flex:1 1 auto;flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-bottom:0;margin-top:-.375rem}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{background-color:rgba(0,0,0,0.03);border-bottom:1px solid rgba(0,0,0,0.125);margin-bottom:0;padding:.75rem 1.25rem}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-header+.list-group .list-group-item:first-child{border-top:0}.card-footer{background-color:rgba(0,0,0,0.03);border-top:1px solid rgba(0,0,0,0.125);padding:.75rem 1.25rem}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{border-bottom:0;margin-bottom:-.75rem;margin-left:-.625rem;margin-right:-.625rem}.card-header-pills{margin-left:-.625rem;margin-right:-.625rem}.card-img-overlay{bottom:0;left:0;padding:1.25rem;position:absolute;right:0;top:0}.card-img,.card-img-bottom,.card-img-top{-ms-flex-negative:0;flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-left-radius:calc(.25rem - 1px);border-bottom-right-radius:calc(.25rem - 1px)}.w-100{width:100% !important}.shadow{box-shadow:0 0.5rem 1rem rgba(0,0,0,0.15) !important}.bg-primary{background-color:#007bff !important}button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc !important}a.bg-primary:focus,a.bg-primary:hover{background-color:#0062cc !important}a.text-primary:focus,a.text-primary:hover{color:#121416 !important}.bg-secondary{background-color:#6c757d !important}button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62 !important}a.bg-secondary:focus,a.bg-secondary:hover{background-color:#545b62 !important}a.text-secondary:focus,a.text-secondary:hover{color:#121416 !important}.bg-success{background-color:#28a745 !important}button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34 !important}a.bg-success:focus,a.bg-success:hover{background-color:#1e7e34 !important}a.text-success:focus,a.text-success:hover{color:#121416 !important}.bg-info{background-color:#17a2b8 !important}button.bg-info:focus,button.bg-info:hover{background-color:#117a8b !important}a.bg-info:focus,a.bg-info:hover{background-color:#117a8b !important}a.text-info:focus,a.text-info:hover{color:#121416 !important}.bg-warning{background-color:#ffc107 !important}button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00 !important}a.bg-warning:focus,a.bg-warning:hover{background-color:#d39e00 !important}a.text-warning:focus,a.text-warning:hover{color:#121416 !important}.bg-danger{background-color:#dc3545 !important}button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130 !important}a.bg-danger:focus,a.bg-danger:hover{background-color:#bd2130 !important}a.text-danger:focus,a.text-danger:hover{color:#121416 !important}.bg-light{background-color:#f8f9fa !important}button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5 !important}a.bg-light:focus,a.bg-light:hover{background-color:#dae0e5 !important}a.text-light:focus,a.text-light:hover{color:#121416 !important}.bg-dark{background-color:#343a40 !important}button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124 !important}a.bg-dark:focus,a.bg-dark:hover{background-color:#1d2124 !important}a.text-dark:focus,a.text-dark:hover{color:#121416 !important}.bg-white{background-color:#fff !important}button.bg-white:focus,button.bg-white:hover{background-color:#e6e6e6 !important}a.bg-white:focus,a.bg-white:hover{background-color:#e6e6e6 !important}a.text-white:focus,a.text-white:hover{color:#121416 !important}.text-primary{color:#007bff !important}.text-secondary{color:#6c757d !important}.text-success{color:#28a745 !important}.text-info{color:#17a2b8 !important}.text-warning{color:#ffc107 !important}.text-danger{color:#dc3545 !important}.text-light{color:#f8f9fa !important}.text-dark{color:#343a40 !important}.text-white{color:#fff !important}.text-body{color:#212529 !important}.text-muted{color:#6c757d !important}.text-black-50{color:rgba(0,0,0,0.5) !important}.text-white-50{color:rgba(255,255,255,0.5) !important}.bg-transparent{background-color:transparent !important}.text-justify{text-align:justify !important}.text-left{text-align:left !important}.text-right{text-align:right !important}.text-center{text-align:center !important}.font-weight-light{font-weight:300 !important}.font-weight-lighter{font-weight:lighter !important}.font-weight-normal{font-weight:400 !important}.font-weight-bold{font-weight:700 !important}.font-weight-bolder{font-weight:bolder !important}.font-italic{font-style:italic !important}.container{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container{max-width:540px}}@media (min-width: 768px){.container{max-width:720px}}@media (min-width: 992px){.container{max-width:960px}}@media (min-width: 1200px){.container{max-width:1140px}}.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container,.container-sm{max-width:540px}}@media (min-width: 768px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width: 992px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width: 1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1140px}}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;margin-right:-15px}.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{padding-left:15px;padding-right:15px;position:relative;width:100%}@media (min-width: 576px){.col-sm{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-sm-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-sm-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-sm-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-sm-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-sm-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 768px){.col-md{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-md-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-md-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-md-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-md-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-md-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 992px){.col-lg{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-lg-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-lg-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-lg-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-lg-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-lg-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 1200px){.col-xl{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-xl-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-xl-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-xl-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-xl-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-xl-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}.d-flex{display:-ms-flexbox !important;display:flex !important}.sphinx-bs,.sphinx-bs *{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sphinx-bs p{margin-top:0} diff --git a/v1.0.7/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/v1.0.7/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css new file mode 100644 index 00000000..fc14abc8 --- /dev/null +++ b/v1.0.7/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css @@ -0,0 +1 @@ +details.dropdown .summary-title{padding-right:3em !important;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none}details.dropdown:hover{cursor:pointer}details.dropdown .summary-content{cursor:default}details.dropdown summary{list-style:none;padding:1em}details.dropdown summary .octicon.no-title{vertical-align:middle}details.dropdown[open] summary .octicon.no-title{visibility:hidden}details.dropdown summary::-webkit-details-marker{display:none}details.dropdown summary:focus{outline:none}details.dropdown summary:hover .summary-up svg,details.dropdown summary:hover .summary-down svg{opacity:1}details.dropdown .summary-up svg,details.dropdown .summary-down svg{display:block;opacity:.6}details.dropdown .summary-up,details.dropdown .summary-down{pointer-events:none;position:absolute;right:1em;top:.75em}details.dropdown[open] .summary-down{visibility:hidden}details.dropdown:not([open]) .summary-up{visibility:hidden}details.dropdown.fade-in[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out;animation:panels-fade-in .5s ease-in-out}details.dropdown.fade-in-slide-down[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out}@keyframes panels-fade-in{0%{opacity:0}100%{opacity:1}}@keyframes panels-slide-down{0%{transform:translate(0, -10px)}100%{transform:translate(0, 0)}}.octicon{display:inline-block;fill:currentColor;vertical-align:text-top}.tabbed-content{box-shadow:0 -.0625rem var(--tabs-color-overline),0 .0625rem var(--tabs-color-underline);display:none;order:99;padding-bottom:.75rem;padding-top:.75rem;width:100%}.tabbed-content>:first-child{margin-top:0 !important}.tabbed-content>:last-child{margin-bottom:0 !important}.tabbed-content>.tabbed-set{margin:0}.tabbed-set{border-radius:.125rem;display:flex;flex-wrap:wrap;margin:1em 0;position:relative}.tabbed-set>input{opacity:0;position:absolute}.tabbed-set>input:checked+label{border-color:var(--tabs-color-label-active);color:var(--tabs-color-label-active)}.tabbed-set>input:checked+label+.tabbed-content{display:block}.tabbed-set>input:focus+label{outline-style:auto}.tabbed-set>input:not(.focus-visible)+label{outline:none;-webkit-tap-highlight-color:transparent}.tabbed-set>label{border-bottom:.125rem solid transparent;color:var(--tabs-color-label-inactive);cursor:pointer;font-size:var(--tabs-size-label);font-weight:700;padding:1em 1.25em .5em;transition:color 250ms;width:auto;z-index:1}html .tabbed-set>label:hover{color:var(--tabs-color-label-active)} diff --git a/v1.0.7/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css b/v1.0.7/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css new file mode 100644 index 00000000..adc61662 --- /dev/null +++ b/v1.0.7/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css @@ -0,0 +1,7 @@ +:root { +--tabs-color-label-active: hsla(231, 99%, 66%, 1); +--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); +--tabs-color-overline: rgb(207, 236, 238); +--tabs-color-underline: rgb(207, 236, 238); +--tabs-size-label: 1rem; +} \ No newline at end of file diff --git a/v1.0.7/_sources/doc_pages/api.rst.txt b/v1.0.7/_sources/doc_pages/api.rst.txt new file mode 100644 index 00000000..c9f8837b --- /dev/null +++ b/v1.0.7/_sources/doc_pages/api.rst.txt @@ -0,0 +1,90 @@ +.. _api-label: + + +API reference +============= + +Integrator +---------- + +.. automodule:: hymd.integrator + :members: + + +Thermostat +---------- + +.. automodule:: hymd.thermostat + :members: csvr_thermostat, _random_chi_squared, _random_gaussian + :undoc-members: + + +Hamiltonian +----------- + +.. autoclass:: hymd.hamiltonian.Hamiltonian + :members: + + .. automethod:: __init__ + + .. automethod:: _setup + +.. autoclass:: hymd.hamiltonian.SquaredPhi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultNoChi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultWithChi + :members: + + .. automethod:: __init__ + + +Force +----- + +.. automodule:: hymd.force + :members: + :undoc-members: + + +Logger +------ + +.. autoclass:: hymd.logger.Logger + :members: + +.. autoclass:: hymd.logger.MPIFilterRoot + :members: + +.. autoclass:: hymd.logger.MPIFilterAll + :members: + + +Input parser +------------ + +.. automodule:: hymd.input_parser + :members: + :undoc-members: propensity_potential_coeffs + + +Field +----- + +.. automodule:: hymd.field + :members: + + +File input/output +----------------- + +.. automodule:: hymd.file_io + :members: diff --git a/v1.0.7/_sources/doc_pages/benchmarks.rst.txt b/v1.0.7/_sources/doc_pages/benchmarks.rst.txt new file mode 100644 index 00000000..06377a85 --- /dev/null +++ b/v1.0.7/_sources/doc_pages/benchmarks.rst.txt @@ -0,0 +1,93 @@ +.. _benchmarks-label: + +Benchmarks +########## +Homopolymer melt test systems of :math:`30^2`, :math:`40^2`, and :math:`50^2` +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively. + +Bonded forces +^^^^^^^^^^^^^ +Legend label denotes the number of particles in the system. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) + time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 + ], dtype=np.float64) + nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 + ], dtype=np.float64,) + time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, + ], dtype=np.float64) + nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 + ], dtype=np.float64) + time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, + ], dtype=np.float64) + plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" + ) + plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" + ) + plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" + ) + plt.xlabel("CPUs", fontsize=15) + plt.ylabel("Time per step, us", fontsize=15) + plt.legend(fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.show() + + +Particle--field forces +^^^^^^^^^^^^^^^^^^^^^^ +Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + + mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] + mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + + mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + + mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + + mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] + mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + + mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + + mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + + plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") + plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") + plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") + plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") + plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") + plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") + plt.xlabel("CPUs", fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.ylabel("Time per step, s", fontsize=15) + plt.legend(loc="upper left", fontsize=15) + plt.show() diff --git a/v1.0.7/_sources/doc_pages/command_line.rst.txt b/v1.0.7/_sources/doc_pages/command_line.rst.txt new file mode 100644 index 00000000..5233710f --- /dev/null +++ b/v1.0.7/_sources/doc_pages/command_line.rst.txt @@ -0,0 +1,120 @@ +.. _commandline-label: + +Command line arguments +###################### +Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle--field interactions. + + +Required arguments +================== +:configuration file: + :code:`type` positional + + Specifies the :code:`.toml` format configuration file containing simulation details. See :ref:`config-label` for details. + +:structure and topology file: + :code:`type` positional + + Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See :ref:`topology-label` for details. + +Optional arguments +================== +:code:`-v --verbose` + :code:`type` optional + + Number of following arguments: :code:`0` or :code:`1` + + Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying :code:`-v` or :code:`--verbose` with no additional specification. This increases verbosity level by :code:`1`. Alternatively, it maye be specified by :code:`--verbose V` with :code:`V` being :code:`0`, :code:`1`, or :code:`2`. + +:code:`--profile` + :code:`type` optional + + Number of following arguments: :code:`0` + + Enables code profiling using :code:`cProfile`. This will output one profiling file per MPI rank invoked in the simulation. + +:code:`--double-precision` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision internally in HyMD (including in the FFTs). + +:code:`--double-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision in the output trajectory from HyMD. + +:code:`--velocity-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that velocities should be output to the HyMD trajectory. + +:code:`--force-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that forces should be output to the HyMD trajectory. + +:code:`--disable-mpio` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult. + +:code:`--logfile` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the path of a plain text log file in which stdout is mirrored during simulation runs. + +:code:`--seed` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the random seed used in the :code:`numpy` random library to generate velocities, thermostatting, etc. + +:code:`--disable-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any two-particle bonds present in the system. + +:code:`--disable-angle-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any three-particle bonds present in the system. + +:code:`--disable-dihedrals` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any four-particle bonds present in the system. + +:code:`--disable-dipole` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any topological reconstruction of peptide backbone dipoles present in the system. + +:code:`--disable-field` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any particle--field interactions present in the system. diff --git a/v1.0.7/_sources/doc_pages/config_file.rst.txt b/v1.0.7/_sources/doc_pages/config_file.rst.txt new file mode 100644 index 00000000..40ee0479 --- /dev/null +++ b/v1.0.7/_sources/doc_pages/config_file.rst.txt @@ -0,0 +1,194 @@ +.. _config-label: + +Configuration file +################## +The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order. + +The configuration file is a `toml`_ format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs. + +.. _`toml`: + https://github.com/toml-lang/toml + +.. role:: required + +Configuration file keywords +--------------------------- + +The following constitutes every possible keyword specification in HyMD +configuration files: + +Metadata keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying metadata for the H5MD output trajectory. + +:name: + :code:`string` [**optional**, default: :code:`None`] + + Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file. + + +:tags: + :code:`array` [:code:`string`] [**optional**, default: :code:`None`] + + Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file. + + +Particle keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying properties of particles and molecules in the +system. + +:n_particles: + :code:`integer` [**optional**, default: :code:`None`] + + Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules. + +:mass: + :code:`float` [**optional**, default: :code:`72.0`] {units: :math:`\text{u}=\text{g}\,\text{mol}^{-1}`} + + Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal. + +:max_molecule_size: + :code:`integer` [**optional**, default: :code:`201`] + + Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code **will** crash if there are molecules larger than :code:`max_molecule_size` in the topology/structure input file. + + +Simulation keywords +^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying simulation parameters. + +:n_steps: + :code:`integer` [:required:`required`] + + Total number of integration steps to perform for this simulation. + +:n_print: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of *number of time steps*). + +:n_flush: + :code:`integer` [**optional**, default: :code:`None`] + + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of *number of* :code:`n_print`, i.e. :code:`n_print = 13`, :code:`n_flush = 3` would result in the trajectory/energy being written to disk every :code:`13 x 3 = 39` *simulation steps*) + +:time_step: + :code:`float` [:required:`required`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time step per integration step. If the rRESPA multiple time step integrator is used (:code:`integrator = "respa"`), this specifies the **inner** time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is :code:`respa_inner` times the :code:`time_step` , and the total simulation time is :code:`n_steps` times :code:`time_step` times :code:`respa_inner` . + +:box_size: + :code:`array` [:code:`float`] [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable. + +:integrator: + :code:`string` [:required:`required`] (options: :code:`velocity-verlet` or :code:`respa`) + + Specifies the time integrator used in the simulation. If :code:`respa`, the *reversible reference system propagator algorithm (rRESPA)* :cite:`tuckerman1992reversible` integrator is used, with :code:`respa_inner` number of inner (intramolecular force) time steps. If :code:`velocity-verlet`, a normal Velocity Verlet integrator is used. If :code:`respa` and :code:`respa_inner = 1`, the rRESPA integrator is equivalent to the Velocity Verlet. + +:respa_inner: + :code:`integer` [**optional**, default: :code:`1`] + + The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces. + +:domain_decomposition: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Specifies the interval (in time steps) of *domain decomposition exchange*, involving all MPI ranks sending and receiving particles according to the particles' positions in the integration box and the MPI ranks' assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If :code:`True`, the decomposition is performed once (before starting the simulation). If :code:`False`, no decomposition is performed. + +:cancel_com_momentum: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + If :code:`True`, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every :code:`remove_com_momentum` time steps. If :code:`False`, the linear momentum is never removed. + +:start_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at :code:`start_temperature` Kelvin prior to starting the simulation. If :code:`False`, the velocities are not changed before starting the simulation. + +:target_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Couple the system to a heat bath at :code:`target_temperature` Kelvin by applying a *Canonical sampling through velocity rescaling* :cite:`Bussi2007JCP` thermostat with coupling strength :code:`tau`. If :code:`False`, no temperature control is applied. + +:tau: + :code:`float` [**optional**, default: :code:`0.7`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the CSVR thermostat coupling. In the limit of :code:`tau → ∞`, the Hamiltonian dynamics are preserved and no temperature coupling takes place. + +:thermostat_coupling_groups: + :code:`array` [:code:`array` [:code:`string`]] [**optional**, default: :code:`[]`] + + Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and :code:`"C"` type particles, :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would thermalise types :code:`"A"` and :code:`"B"` together and couple :code:`"C"` type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. :code:`target_temperature` Kelvin). +:hamiltonian: + :code:`string` [**optional**, default: :code:`"DefaultNohChi"`] (options: :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`) + + Specifies the interaction energy functional :math:`W[\tilde\phi]` for use with the particle-field interactions. See :ref:`functionals-label` for details. + + +Field keywords +^^^^^^^^^^^^^^ +Configuration keywords specifying field parameters. + +:mesh_size: + :code:`array` [:code:`integer`] or :code:`integer` [:required:`required`] + + Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is :code:`box_size / mesh_size`. + +:kappa: + :code:`float` [:required:`required`] {units: :math:`\text{kJ}^{-1}\text{mol}`} + + Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional :math:`W[\tilde\phi]`. See :ref:`functionals-label` for more details. + +:sigma: + :code:`float` [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See :ref:`filtering-label` for more details. + +:chi: + :code:`array` [:code:`array` [:code:`string`, :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}`} + + Array of :math:`\tilde\chi_\text{AB}`-parameters indicating the strength of the repulsive or attractive interaction between particles of type :code:`"A"` and the number density due to particles of type :code:`"B"`, and vice versa. Example: :code:`chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ]` would specify a repulsive :code:`"A"`--:code:`"B"` type interaction, and a weakly attractive :code:`"C"`--:code:`"D"` interaction. Self-interaction :math:`\tilde\chi`-terms are always zero. See :ref:`functionals-label` for more details. + + +Bond keywords +^^^^^^^^^^^^^ +Configuration keywords specifying bonds and bonds parameters. + +:bonds: + :code:`array` [:code:`array` [2 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{nm}=10^{-9}~\text{m}` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: :code:`bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ]` indicates a :code:`"A"`--:code:`"A"` bond of equilibrium length :code:`0.47` :math:`\text{nm}` with a bond strength of :code:`980.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding bond between :code:`"A"` and :code:`"B"` type particles with equilibrium length :code:`0.31` :math:`\text{nm}` and a strength of :code:`1250.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify stretching bonds. + +:angle_bonds: + :code:`array` [:code:`array` [3 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`{}^\circ` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: :code:`bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ]` indicates a :code:`"A"`--:code:`"A"`--:code:`"A"` angular bond that tries to keep the bond linear at :code:`180` degrees with a bending strength of :code:`55.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding angle bond between :code:`"A"`--:code:`"B"`--:code:`"B"` prefering the angle at :code:`120` degrees and a strength of :code:`25.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify angular bonds. + +:dihedrals: + :code:`array` [:code:`array` [4 :code:`string`, :code:`integer`, :code:`COSINE SERIES` ]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`} + + Specifies four-particle torsional potentials by cosine series. See :ref:`bonds-label` for details about how to specify dihedrals. + + + +Electrostatic keywords +^^^^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying electrostatics and electrostatic parameters. + +:coulombtype: + :code:`string` [**optional**, default: :code:`None`] (options: :code:`PIC_Spectral`) + + Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the :code:`dielectric_const` keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, *not* in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to `PIC_Spectral`. + +:dielectric_const: + :code:`float` [**optional**, default: :code:`None`] + + Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified---even if electrostatics are not included with the :code:`coulombtype` keyword. diff --git a/v1.0.7/_sources/doc_pages/constants_and_units.rst.txt b/v1.0.7/_sources/doc_pages/constants_and_units.rst.txt new file mode 100644 index 00000000..ee429829 --- /dev/null +++ b/v1.0.7/_sources/doc_pages/constants_and_units.rst.txt @@ -0,0 +1,80 @@ +.. _units-label: + +Constants and Units +################### + +HyMD uses the following units and constants internally and in all input and +output: + +.. list-table:: **Units** + :widths: 30 10 75 + :header-rows: 1 + + * - Quantity + - Symbol + - Unit + * - length + - :math:`r` + - :math:`\text{nm}=10^{-9}~\text{m}` + * - time + - :math:`t` + - :math:`\text{ps}=10^{-12}~\text{s}` + * - charge + - :math:`q` + - :math:`e=1.602176634 \cdot 10^{-19}~\text{C}` + * - mass + - :math:`m` + - :math:`\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}` + * - temperature + - :math:`\text{T}` + - :math:`\text{K}` + * - energy + - :math:`E` + - :math:`\text{kJ}\,\text{mol}^{-1}` + * - velocity + - :math:`v` + - :math:`\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}` + * - momentum + - :math:`P` + - :math:`\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}` + * - force + - :math:`\mathbf{F}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}` + * - pressure + - :math:`p` + - :math:`\text{bar}=100~\text{kPa}` + * - electric potential + - :math:`\Psi` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}` + * - electric field + - :math:`\mathbf{E}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}` + * - compressibility + - :math:`\kappa` + - :math:`\text{mol}\,\text{kJ}^{-1}` + * - field-interaction + - :math:`\tilde\chi` + - :math:`\text{kJ}\,\text{mol}^{-1}` + +.. list-table:: **Constants** + :widths: 30 10 75 + :header-rows: 1 + + * - Constant + - Symbol + - Value + * - gas constant + - :math:`R` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Boltzmann’s constant + - :math:`k_\text{B}` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Avogadro's constant + - :math:`N_\text{A}` + - :math:`6.02214076 \cdot 10^23~\text{mol}^{-1}` + * - Vacuum permittivity + - :math:`\varepsilon_0` + - :math:`8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2` + * - Coulomb constant + - :math:`k_\text{e}` + - :math:`138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}` diff --git a/v1.0.7/_sources/doc_pages/electrostatics.rst.txt b/v1.0.7/_sources/doc_pages/electrostatics.rst.txt new file mode 100644 index 00000000..7e11c09d --- /dev/null +++ b/v1.0.7/_sources/doc_pages/electrostatics.rst.txt @@ -0,0 +1,48 @@ +.. _electrostatics-label: + +Electrostatic interactions +########################## +In the filtered Hamiltonian hPF formalism :cite:`bore2020hamiltonian` the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle--mesh Ewald. + +The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered + +.. math:: + + \tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i), + +with :math:`q_i` being the charge of particle :math:`i` and :math:`H` is the +filtering function (see :ref:`filtering-label`). The value of the charge grid at +vertex :math:`(i,j,k)` is found by + +.. math:: + + \tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)] + +and the electrostatic potential :math:`\Psi_{ijk}` + +.. math:: + + \Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right], + +where :math:`k_\text{e}` is the Coulomb constant :math:`1/4\pi\varepsilon_0`. +The *electric field* is obtained by differentiation of the electrostatic +potential in Fourier space, + +.. math:: + + \mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)] + +from which the forces are interpolated back to the particle positions. + +Specifying electrostatics +^^^^^^^^^^^^^^^^^^^^^^^^^ +In HyMD, electrostatics are specified by the :code:`coulombtype` and +:code:`dielectric_const` keywords in the configuration file (see +:ref:`config-label`) and the :code:`/charge` dataset in the HDF5 format +structure/topology input file (see :ref:`topology-label`). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions. diff --git a/v1.0.7/_sources/doc_pages/examples.rst.txt b/v1.0.7/_sources/doc_pages/examples.rst.txt new file mode 100644 index 00000000..9f9c3655 --- /dev/null +++ b/v1.0.7/_sources/doc_pages/examples.rst.txt @@ -0,0 +1,621 @@ +.. _examples-label: + +Examples +######## +The following examples are ordered in *more or less* order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the `HyMD-tutorial`_ github repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Ideal gas +========= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true + :align: right + :width: 200 + +The simplest possible system is one with no interactions at all---intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like: + + +.. code-block:: toml + :caption: **ideal_gas.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = false # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + +A simple input structure/topology file :code:`ideal_gas.HDF5` is available in +the `HyMD-tutorial/ideal_gas`_ github repository (along with the code to +generate it). Run the (very) short simulation by + +.. code:: bash + + python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field \ + --velocity-output \ + --force-output + +with the :code:`--disable-field` argument to completely turn off all +particle--field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook `ideal_gas.ipynb`_ for details. + + +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas +.. _ideal_gas.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.ipynb + + +Ideal chains +============ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true + :align: right + :width: 200 + +The simplest available interaction is the harmonic two-particle bond (see +:ref:`bonds-label`), + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2. + +Extending the configuration file from the ideal gas case, we need to add a +:code:`bonds` specification. Note that the :code:`[bonds]` meta specifier is not +necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **ideal_chain.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + +A simple input structure/topology file :code:`ideal_chain.HDF5` with a few +coiled up ideal chain polymers is available in the +`HyMD-tutorial/ideal_chain`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field + +we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +`ideal_chain.ipynb`_. + + +.. _HyMD-tutorial/ideal_chain: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_chain +.. _ideal_chain.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/ideal_chain.ipynb + + +Stiff rods +========== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true + :align: right + :width: 200 + +Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the :code:`i--j--k` angle :math:`\theta` (see +:ref:`bonds-label`), + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2. + +Extending the configuration file from the ideal chain case, we need to add a +:code:`angle_bonds` specification. Note that the :code:`[bonds]` meta specifier +is not necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **rods.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + + angle_bonds = [ + ["A", "A", "A", 180.0, 100.0], # (i, j, k, equilibrium angle, strength) + ] + + +A simple input structure/topology file :code:`rods.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook `rods.ipynb`_. + + +.. _HyMD-tutorial/rods: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/rods +.. _rods.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.ipynb + + + +Helixes +======= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true + :align: right + :width: 200 + +Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle :math:`\phi` between the +:code:`i--j--k` plane and the :code:`j--k--l` plane (see :ref:`bonds-label`), + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n). + +The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a :code:`dihedrals` keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the :code:`dielectric_const` +keyword even though we are not including electrostatic forces in the current +simulation. Note that the :code:`[bonds]` meta specifier is not necessary, but +may be used to help organise the input file. + +.. code-block:: toml + :caption: **helixes.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + dielectric_const = 15.0 + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.31, 10000.0], # (i name, j name, equilibrium length, strength) + ] + + dihedrals = [ + [ + ["A", "A", "A", "A"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0] + ], + ] + +A simple input structure/topology file :code:`helixes.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook `helixes.ipynb`_. + + +.. _HyMD-tutorial/helixes: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/helixes +.. _helixes.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.ipynb + + +Phase separation +================ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true + :align: right + :width: 200 + +The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types :code:`A` and :code:`B`. Using the Hamiltonian + +.. math:: + + \mathcal{H}=H_0+W + +with :math:`\tilde\chi`--dependent interactions defined by (specified in the +configuration file by :code:`hamiltonian = DefaultWithChi`): + +.. math:: + + W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2. + + +.. code-block:: toml + :caption: **phase_separation.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + + [field] + mesh_size = [20, 20, 20] # FFT grid size + sigma = 1.0 # filtering length scale in nm + kappa = 0.05 # compressibility in mol/kJ + chi = [ + ['A', 'B', 5.0], # (name i, name j, strength) + ] + +A simple input structure/topology file :code:`phase_separation.HDF5` containing +an equal number of :code:`A` type and :code:`B` type particles is available in +the `HyMD-tutorial/phase_separation`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd phase_separation.toml phase_separation.HDF5 + +we may examine the resulting trajectory. In the case of a low interaction +strength :math:`\tilde\chi` of :code:`5.0` (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to :code:`40.0` (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +`phase_separation.ipynb`_. + + +.. _HyMD-tutorial/phase_separation: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/phase_separation +.. _phase_separation.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/phase_separation.ipynb + + +Diblock copolymers +================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true + :align: right + :width: 200 + +Having introduced particle--field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive :math:`\tilde\chi`--interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the :code:`integrator = "respa"` keyword. Putting the pieces together, the +configuration file may look like the following: + +.. code-block:: toml + :caption: **copolymer.toml** + + [simulation] + integrator = "respa" + respa_inner = 15 + n_steps = 2000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [10.0, 10.0, 10.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [50, 50, 50] # FFT grid size + sigma = 0.5 # filtering length scale in nm + chi = [ + ["A", "B", 30.0], # (i, j, strength) + ] + + [bonds] + bonds = [ + ["A", "A", 0.25, 1500.0], # (i, j, equilibrium length, strength) + ["A", "B", 0.25, 1500.0], + ["B", "B", 0.25, 1500.0], + ] + angle_bonds = [ + ["A", "A", "A", 180.0, 25.0], # (i, j, k, equilibrium angle, strength) + ["B", "B", "B", 180.0, 25.0], + ] + +A simple input structure/topology file :code:`copolymer.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/copolymer`_ github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten :code:`A` followed by ten :code:`B` type particles. +Running the simulation with + +.. code:: bash + + python3 -m hymd copolymer.toml copolymer.HDF5 + +the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +`copolymer.ipynb`_. + + +.. _HyMD-tutorial/copolymer: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/copolymer +.. _copolymer.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer.ipynb + + +Lipid bilayer self-assembly +=========================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true + :align: right + :width: 300 + +Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field--particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the :code:`thermostat_coupling_groups` keyword. With parameters +optimised in :cite:`ledum2020automated`, the configuration file looks like: + + +.. code-block:: toml + :caption: **lipid_self_assembly.toml** + + [simulation] + integrator = "respa" + respa_inner = 25 + n_steps = 3000 + n_print = 200 + n_flush = 1 + time_step = 0.01 + box_size = [9.96924, 9.96924, 10.03970] + start_temperature = 323 + target_temperature = 323 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.05 + domain_decomposition = 10001 + cancel_com_momentum = true + max_molecule_size = 15 + thermostat_coupling_groups = [ + ["N", "P", "G", "C"], + ["W"], + ] + + [field] + mesh_size = [25, 25, 25] + sigma = 1.0 + chi = [ + ["C", "W", 42.24], + ["G", "C", 10.47], + ["N", "W", -3.77], + ["G", "W", 4.53], + ["N", "P", -9.34], + ["P", "G", 8.04], + ["N", "G", 1.97], + ["P", "C", 14.72], + ["P", "W", -1.51], + ["N", "C", 13.56], + ] + + [bonds] + bonds = [ + ["N", "P", 0.47, 1250.0], + ["P", "G", 0.47, 1250.0], + ["G", "G", 0.37, 1250.0], + ["G", "C", 0.47, 1250.0], + ["C", "C", 0.47, 1250.0], + ] + angle_bonds = [ + ["P", "G", "G", 120.0, 25.0], + ["P", "G", "C", 180.0, 25.0], + ["G", "C", "C", 180.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +A randomly mixed input structure/topology file +:code:`lipid_self_assembly.HDF5` with a few hundred lipids in a roughy +:code:`10 x 10 x 10nm` box is available in the +`HyMD-tutorial/lipid_self_assembly`_ github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation + +.. code:: bash + + python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5 + +we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook `lipid_self_assembly.ipynb`_. + + +.. _HyMD-tutorial/lipid_self_assembly: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/lipid_self_assembly +.. _lipid_self_assembly.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/lipid_self_assembly.ipynb + + +Peptide in lipid bilayer +======================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true + :align: right + :width: 300 + +Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer. + + +The `configuration file`_ is available in the `HyMD-tutorial/peptide`_ github +repository (omitted here for brevity). + +A pre-equilibrated input structure/topology file :code:`peptide.HDF5` with a +few hundred lipids in a roughy :code:`20 x 20 x 20nm` box is available in the +`HyMD-tutorial/peptide`_ github repository. Running the simulation + +.. code:: bash + + python3 -m hymd peptide.toml peptide.HDF5 + +we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook `peptide.ipynb`_. + + +.. _HyMD-tutorial/peptide: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/peptide +.. _configuration file: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.toml +.. _peptide.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.ipynb + + +SDS +=== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true + :align: right + :width: 300 + +The last part we introduce is explicit electrostatic interactions through +particle--mesh Ewald. Enabling the electrostatic calculations is done via the +:code:`coulombtype` keyword. :code:`"PIC_Spectral"` is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the :code:`dielectric_const` keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge. + + + +.. code-block:: toml + :caption: **sds.toml** + + [simulation] + integrator = "respa" + respa_inner = 10 + n_steps = 3000 + n_print = 1500 + n_flush = + time_step = 0.01 + box_size = [8.3, 8.3, 8.3] + start_temperature = 298 + target_temperature = 298 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.1 + domain_decomposition = 10000 + cancel_com_momentum = true + max_molecule_size = 5 + thermostat_coupling_groups = [ + ["S", "C"], + ["W", "Na"], + ] + dielectric_const = 45.0 # dielectric constant for the simulation medium + coulombtype = "PIC_Spectral" # particle in cloud, spectral method + + [field] + mesh_size = [64, 64, 64] + sigma = 0.5 + chi = [ + ["S", "C", 13.50], + ["S", "Na", 0.00], + ["S", "W", -3.60], + ["C", "Na", 13.50], + ["C", "W", 33.75], + ["W", "Na", 0.00], + ] + + [bonds] + bonds = [ + ["S", "C", 0.50, 1250.0], + ["C", "C", 0.50, 1250.0], + ] + angle_bonds = [ + ["S", "C", "C", 170.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +An input structure/topology file :code:`sds.HDF5` with a couple thousand +randomly dispersed SDS chains is available in the `HyMD-tutorial/sds`_ github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a :code:`/charge` dataset. +Running the simulation with + +.. code:: bash + + python3 -m hymd sds.toml sds.HDF5 + +we observe the aggregation of the SDS into micellular structures---first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook `sds.ipynb`_. + + +.. _HyMD-tutorial/sds: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/sds +.. _sds.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/sds.ipynb diff --git a/v1.0.7/_sources/doc_pages/filtering.rst.txt b/v1.0.7/_sources/doc_pages/filtering.rst.txt new file mode 100644 index 00000000..02af68c6 --- /dev/null +++ b/v1.0.7/_sources/doc_pages/filtering.rst.txt @@ -0,0 +1,30 @@ +.. _filtering-label: + +Filtering +######### +The default grid-independent filter function used in HyMD is a Gaussian + +.. math:: + + H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] + +with reciprocal space representation + +.. math:: + + \hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +The coarse-graining parameter :math:`\sigma` determines a length scale of +particle extent and is given as configuration file input by + +.. code:: toml + + sigma = 0.75 + + +Implementing new filters +^^^^^^^^^^^^^^^^^^^^^^^^ +Implementing new filter functions is straightforward by hijacking +the :code:`setup` method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional. diff --git a/v1.0.7/_sources/doc_pages/installation.rst.txt b/v1.0.7/_sources/doc_pages/installation.rst.txt new file mode 100644 index 00000000..9ab7e59c --- /dev/null +++ b/v1.0.7/_sources/doc_pages/installation.rst.txt @@ -0,0 +1,324 @@ +.. _installation-label: + +Installation +############ + +Dependencies +============ + +.. note:: + HyMD requires Python ≥3.6. Python version 3.9 is most likely fine + to use, but HyMD is only regularly tested with Python3.8 at the moment. + +.. warning:: + MPI-enabled h5py may fail to build under Python3.10. In this case, a + fall-back to Python3.9 or lower may be necessary. + + +**Installing non-Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-openmpi-dev # Install MPI-enabled HDF5 + sudo apt-get install -y pkg-config # Install pkg-config, required for h5py install + sudo apt-get install -y curl wget + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + sudo dnf update -y + sudo dnf install -y python3.9 python3-devel # Install python3 and pip + sudo dnf install -y openmpi-devel # Install MPI development headers + sudo dnf install -y hdf5-openmpi-devel # Install MPI-enabled HDF5 + sudo dnf install -y curl wget + + + The automatic download and building of PFFT has some issues, so we + manually build FFTW and PFFT before calling :code:`pip3 install pfft-python`. + + .. code-block:: bash + + sudo dnf install -y git + sudo dnf install -y libtool + sudo dnf install -y fftw-openmpi-devel fftw-openmpi-libs + export PATH=$PATH:/usr/lib64/openmpi/bin/ # Ensure MPICC is in path + git clone https://github.com/mpip/pfft.git + cd pfft/ + ./bootstrap.sh + ./configure + make + make install + + + .. group-tab:: Mac OSX (brew) + + .. code-block:: bash + + brew update + brew install python # Install python3 and pip + brew install open-mpi # Install MPI development headers + brew install hdf5-mpi # Install MPI-enabled HDF5 + brew install pkg-config # Install pkg-config, required for h5py install + brew install curl wget + +.. warning:: + There might be memory leaks when using HyMD with OpenMPI 4.1.1. + Therefore, using a newer version of OpenMPI is recommended. + See `Issue #186 `_ for more details. + + +**Installing Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + python3 -m pip install --upgrade pip + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + python3.9 -m ensurepip --upgrade + PATH=$PATH:/usr/lib64/openmpi/bin/:/usr/lib64/openmpi/lib/ + python3.9 -m pip install mpi4py numpy cython + export HDF5_DIR="/usr/lib64/openmpi/" + CC="mpicc" HDF5_MPI="ON" python3.9 -m pip install --no-binary=h5py h5py + + .. group-tab:: Mac OSX (brew) + + Find the location of the installed :code:`hdf5-mpi` package by + + .. code-block:: bash + + find /usr -iname "*hdf5.h" + + or + + .. code-block:: bash + + brew info hdf5-mpi + + and extract the path, which will look like for example + :code:`/usr/local/Cellar/hdf5-mpi/1.13.0/`. Export it as :code:`HDF5_DIR` + + .. code-block:: bash + + python3 -m ensurepip --upgrade + export HDF5_DIR="/usr/local/Cellar/hdf5-mpi/1.13.0/" + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + + +.. warning:: + + If MPI-enabled HDF5 and :code:`h5py` can not be installed, limited support + for serial HDF5 is available. Note that having MPI-enabled file IO is + **highly recommended**, and simulation performance under serial HDF5 will + potentially be very low. + + Example dependency install on Ubuntu (apt) using serial HDF5: + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-serial-dev # Install serial HDF5 + sudo apt-get install -y curl wget + + python3 -m pip install h5py mpi4py numpy cython + + Running parallel simulations without a + MPI-enabled HDF5 library available necessitates the use of the + :code:`--disable-mpio` argument to HyMD, see :ref:`commandline-label`. Note that + due to the way HyMD is built, a working MPI compiler is required even if all + intended simulations are serial. + + +Installing HyMD +=============== +HyMD may be installed using :code:`pip` by + +.. code-block:: bash + + python3 -m pip install hymd + + + +Install in docker +================= +A docker image with build essentials setup is available at `dockerhub`_ with tag +:code:`mortele/hymd`, + +.. code-block:: bash + + docker pull mortele/hymd:latest + docker run -it mortele/hymd + /app$ python3 -m pip install hymd + + # Grab example input files + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5 + + # Run simulation + /app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose + +.. _dockerhub: + https://hub.docker.com/repository/docker/mortele/hymd + + +Run interactively in Google Colaboratory +======================================== +A `Google Colaboratory`_ jupyter notebook is setup `here`_ with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Common issues +============= + +Numpy errors while importing the Fortran force kernels +------------------------------------------------------ + +.. code-block:: python + + RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd + + Traceback (most recent call last): + + (...) + + File "/..../HyMD/hymd/__init__.py", line 2, in + from .main import main # noqa: F401 + File "/..../HyMD/hymd/main.py", line 10, in + from .configure_runtime import configure_runtime + File "/..../hymd/configure_runtime.py", line 12, in + from .input_parser import read_config_toml, parse_config_toml + File "/..../HyMD/hymd/input_parser.py", line 12, in + from .force import Bond, Angle, Dihedral, Chi + File "/..../HyMD/hymd/force.py", line 8, in + from force_kernels import ( # noqa: F401 + ImportError: numpy.core.multiarray failed to import + +can normally be fixed by updating numpy versions, + +.. code-block:: bash + + python3 -m pip install -U numpy + + +Error building pfft-python due to missing curl/wget +--------------------------------------------------- + +.. code-block:: python + + Building wheel for pfft-python (setup.py) ... error + ERROR: Command errored out with exit status 1: + command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_ + cwd: /tmp/pip-install-fr6nt9m4/pfft-python/ + Complete output (56 lines): + running bdist_wheel + running build + running build_py + + (...) + + curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found + wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found + Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + Please check curl or wget + You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ + Traceback (most recent call last): + File "", line 1, in + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in + setup( + File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup + return distutils.core.setup(**attrs) + File "/usr/lib/python3.8/distutils/core.py", line 148, in setup + + (...) + + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions + build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:])) + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft + raise ValueError("could not build fftw; check MPICC?") + ValueError: could not build fftw; check MPICC? + ---------------------------------------- + ERROR: Failed building wheel for pfft-python + Running setup.py clean for pfft-python + Failed to build pfft-python + +can be fixed by installing either `curl`_ or `wget`_ + +.. code-block:: bash + + apt-get install -y curl wget + + +.. _`curl`: + https://curl.se/ + +.. _`wget`: + https://www.gnu.org/software/wget/ + + +Error running parallel HyMD without MPI-enabled h5py +---------------------------------------------------- + +.. code-block:: python + + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + main() + File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main + with h5py.File(args.input, "r", **_kwargs) as in_file: + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__ + with h5py.File(args.input, "r", **_kwargs) as in_file: + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + raise ValueError("h5py was built without MPI support, can't use mpio driver") + ValueError: h5py was built without MPI support, can't use mpio driver + +Can be fixed by installing a MPI-enabled :code:`h5py` through + +.. code-block:: bash + + python3 -m pip uninstall -y h5py + HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py diff --git a/v1.0.7/_sources/doc_pages/interaction_energy_functionals.rst.txt b/v1.0.7/_sources/doc_pages/interaction_energy_functionals.rst.txt new file mode 100644 index 00000000..f33c004e --- /dev/null +++ b/v1.0.7/_sources/doc_pages/interaction_energy_functionals.rst.txt @@ -0,0 +1,98 @@ +.. _functionals-label: + +Interaction energy functionals +############################## +A few interaction energy functionals :math:`W` are defined in HyMD through +the :code:`Hamiltonian` class and associated subclasses. + +:math:`\chi`--interaction and :math:`\kappa`--incompressibility +=============================================================== +The most common hPF energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultWithChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where :math:`\tilde\chi_{\text{A}-\text{B}}` is the interaction energy between +overlapping densities of particle types :math:`\text{A}` and :math:`\text{B}`. +The incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\tilde\chi` +and :math:`\kappa` in the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + chi = [ + ["A", "B", 15.85], + ["B", "C", -5.70], + ... + ] + +Only :math:`\kappa`--incompressibility +====================================== +The only :math:`\kappa` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultNoChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where the incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Only :math:`\phi^2` +=================== +The :math:`\phi^2` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "SquaredPhi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2, + +where the :math:`\phi` squared term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Implementing new interaction energy forms +========================================= +Implementing new interaction energy functions is straightforward by subclassing +:code:`Hamiltonian` and applying :code:`sympy` differentiation to the symbolic +field objects. The :code:`sympy.lamdify` function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields. diff --git a/v1.0.7/_sources/doc_pages/intramolecular_bonds.rst.txt b/v1.0.7/_sources/doc_pages/intramolecular_bonds.rst.txt new file mode 100644 index 00000000..820e81bc --- /dev/null +++ b/v1.0.7/_sources/doc_pages/intramolecular_bonds.rst.txt @@ -0,0 +1,142 @@ +.. _bonds-label: + +Intramolecular bonds +#################### + +Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see :ref:`config-label`. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +:ref:`benchmarks-label`), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable. + +All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]). + + +Two-particle bonds +^^^^^^^^^^^^^^^^^^ +Stretching bonds in HyMD are implemented as harmonic spring potentials, + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2, + +where :math:`r=|\mathbf{r}|` is the inter-particle distance, :math:`k` is a +constant of dimension energy (units :math:`\text{kJ}\,\text{mol}^{-1}`), and +:math:`r_0` is the equilibrum length of the bond (units: :math:`\text{nm}`). The +force is calculated as + +.. math:: + + F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r}, + +where :math:`\mathbf{r}` is the vector pointing *from* :math:`i` *to* :math:`j`. + +In the configuration file, two-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_two_particle_example.toml + + [bonds] + bonds = [ + ["A", "A", 0.47, 1250.0], + ["A", "B", 0.37, 940.0], + ["B", "C", 0.50, 1010.0], + ["C", "A", 0.42, 550.0], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Three-particle bonds +^^^^^^^^^^^^^^^^^^^^ +Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle--particle--particle angle :math:`\theta`, + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2, + +where :math:`k` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}`), and :math:`\theta_0` is the equilibrum +angle of the bond (units: :math:`{}^\circ`). Defining the particles with labels +:math:`a`, :math:`b`, and :math:`c`, let :math:`\mathbf{r}_a` denote the vector +pointing from :math:`b` to :math:`a`, and correspondingly let +:math:`\mathbf{r}_c` point from :math:`b` to :math:`c`. The +:math:`a`--:math:`b`--:math:`c` may be computed through the law of Cosines, + +.. math:: + + \theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right] + +Then the force acting on :math:`a` and :math:`c` is + +.. math:: + + \mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a}, + + \mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c}, + +and + +.. math:: + + \mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c + +In the configuration file, three-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_three_particle_example.toml + + [bonds] + angle_bonds = [ + ["A", "A", "A", 180.0, 90.0], + ["A", "B", "A", 120.0, 55.0], + ["B", "C", "C", 30.0, 10.0], + ["C", "A", "B", 110.0, 25.5], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Four-particle bonds +^^^^^^^^^^^^^^^^^^^ +Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle :math:`\phi` between the +:math:`a`--:math:`b`--:math:`c` and :math:`b`--:math:`c`--:math:`d` planes, for +a dihedral bond quartet :math:`a`, :math:`b`, :math:`c`, and :math:`d`. The +potential takes the form + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n), + +where :math:`c_n` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`), and :math:`\phi_n` are +specified phase angles in the cosine series. + +In the configuration file, four-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_four_particle_example.toml + + [bonds] + dihedrals = [ + ["A", "B", "C", "D"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0], + ] diff --git a/v1.0.7/_sources/doc_pages/overview.rst.txt b/v1.0.7/_sources/doc_pages/overview.rst.txt new file mode 100644 index 00000000..0e4d6b65 --- /dev/null +++ b/v1.0.7/_sources/doc_pages/overview.rst.txt @@ -0,0 +1,166 @@ +.. _overview-label: + +================================ + Usage overview for HylleraasMD +================================ + +HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a `toml`_ format configuration file, along with a topology and structure +file specifying the input system in HDF5 format. + +.. _`toml`: + https://github.com/toml-lang/toml + +**Configuration file** + +The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a :code:`[5, 5, 5]` nm simulation box at 300 K may look like +the following: + +.. code-block:: toml + :caption: **config_simple_1.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "SquaredPhi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [30, 30, 30] # FFT grid size + sigma = 0.5 # filtering length scale in nm + +Note that for the version 1.0 release of HyMD, the :code:`[particles]`, +:code:`[simulation]`, and :code:`[field]` groups are optional specifiers for +structuring the configuration file. + +For a full specification of every recognised configuration keyword in HyMD, +please refer to :ref:`config-label`. + +**Topology and structure file** + +The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +:code:`N` particles may look like the following: + +.. code-block:: bash + :caption: **example_structure.HDF5** + + group / + # root group + + dataset /coordinates + # float32, shape (T, N, D,) + # Time steps of N rows of D dimensional coordinate data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /velocities + # float32, shape (T, N, D,) OPTIONAL + # Time steps of N rows of D dimensional velocity data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /bonds + # int32, shape (N, B,) OPTIONAL + # Each row i contains indices of the particles bonds from/to i + # B denotes the maximum bonds per particle + + dataset /indices + # int32, shape (N,) + # Index of each particle, 0--(N-1) + + dataset /molecules + # int32, shape (N,) + # Index of molecule each particle belongs to + # Used to construct bond network locally on MPI ranks + + dataset /names + # str10, shape (N,) + # Fixed size string array containing particle type names + + dataset /types + # int32, shape (N,) OPTIONAL + # Mapping of particle names to type indices + + +For a full specification of the topology and structure input file, see +:ref:`topology-label`. + +**Command line arguments** + +A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the :code:`config_simple_1.toml` and :code:`example_structure.HDF5` +files may look like the following: + +.. code-block:: bash + + mpirun -n ${MPI_NUM_RANKS} python3 -m hymd \ # HyMD executable + config_simple_1.toml \ # configuration file + example_structure.HDF5 \ # structure file + --logfile=log_out.txt \ # set logfile path + --seed 123456 \ # set random seed + --verbose 2 \ # set logging verbosity + --velocity-output # enable velocity in trajectory output + +For a full specification of all command line arguments, see +:ref:`commandline-label`. + +**More examples** + +For more thorough rundown and concrete usage examples, see +:ref:`examples-label`. + +Running parallel simulations +============================ +Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the **only** difference being how the python3 interpreter is +invoked. Prepending :code:`mpirun -n ${NPROCS}` to the usual +:code:`python3 -m hymd` runs the simulation with :code:`${NPROCS}` MPI ranks. + +Inputting + +.. code:: bash + + mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field + +sets up an example simulation of the `HyMD-tutorial/ideal_gas`_ system. For +more details about this system in particular, or other example simulations, see +the `HyMD-tutorial`_ repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas + + +Running tests +============= +Run serial code tests by + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd + cd hymd/ + python3 -m pip install pytest pytest-mpi + python3 -m pytest + +There is a small convenience script in :code:`hymd/` for running the MPI-enabled +tests, + +.. code-block:: bash + + chmod +x pytest-mpi + ./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no diff --git a/v1.0.7/_sources/doc_pages/theory.rst.txt b/v1.0.7/_sources/doc_pages/theory.rst.txt new file mode 100644 index 00000000..95d7842c --- /dev/null +++ b/v1.0.7/_sources/doc_pages/theory.rst.txt @@ -0,0 +1,114 @@ +.. _theory-label: + +Theory +###### +Hybrid particle--field simulations switch out the ordinary particle--particle +`Lennard-Jones`_ interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle--field densities are +defined as + +.. math:: + + \phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i), + +where :math:`\mathbf{r}` is a spatial coordinate, :math:`P` is a window function +used to distribute particle number densities onto a computational grid, and +:math:`\mathbf{r}_i` is the position of particle :math:`i` (of total :math:`N`). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of :math:`N` particles in :math:`M` molecules is + +.. math:: + + \mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})] + +with :math:`H_0` being a standard intramolecular Hamiltonian form (see +:ref:`bonds-label`) including kinetic terms, while :math:`W` is a density +dependent *interaction energy functional*. + +In the Hamiltonian hPF-MD formalism :cite:`bore2020hamiltonian`, the density +field is filtered using a grid-independent filtering function :math:`H`, + +.. math:: + + \tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}). + +The filter smooths the density, ensuring that :math:`\tilde\phi` and +:math:`W[\tilde\phi([\phi])]` both converge as the grid size is reduced. + +External potential +================== +The external potential acting on a particle is defined as the functional +derivative of :math:`W` with respect to :math:`\phi`. In the filtered formalism, +the potential takes the form + +.. math:: + + V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ + &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})}, + +under the assumption of a *local* form of the interaction energy functional, +:math:`W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]`. Note +that + +.. math:: + + \frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}). + +Force interpolation +=================== +The forces on particle :math:`i` are obtained by differentiation of the external +potential, + +.. math:: + + \mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i). + + +Reciprocal space calculations +============================= +The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density :math:`\phi_{ijk}` with CIC, we apply the filtering +and obtain the discrete version of the external potential by + +.. math:: + + \tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big] + +and + +.. math:: + + V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +The forces are obtained by differentiation of :math:`V` in Fourier space as + +.. math:: + + \nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +Filter +====== +By default, the filter used in HyMD is a simple Gaussian of the form + +.. math:: + + H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ + \hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +For more details about the filtering, see :ref:`filtering-label`. + +Hamiltonian form +================ +The default form of the interaction energy functional in HyMD is + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2. + +See :ref:`functionals-label` for details. + + +.. _`Lennard-Jones`: + https://en.wikipedia.org/wiki/Lennard-Jones_potential diff --git a/v1.0.7/_sources/doc_pages/topology_input.rst.txt b/v1.0.7/_sources/doc_pages/topology_input.rst.txt new file mode 100644 index 00000000..adabe129 --- /dev/null +++ b/v1.0.7/_sources/doc_pages/topology_input.rst.txt @@ -0,0 +1,77 @@ +.. _topology-label: + +============================ +Topology and structure file +============================ +The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root :code:`/` group. + +The `HyMD-tutorial`_ has multiple examples of structure files for various levels +of complexity. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Required datasets +================= +:/coordinates: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/indices: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/names: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`string` (:code:`length` between :code:`1` and :code:`16`)] + + The shape represents one particle name per :code:`N` particles. The datatype may be a string of length :code:`=<16`. + + + +Optional datasets +================= +:/velocities: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/types: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle type index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/molecules: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one molecule index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/bonds: + :code:`array` shape [:code:`N`, :code:`B`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents :code:`B` bond specifications (indices of different particles) per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/charge: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents one particle charge per :code:`N` particles. The data type may be either four or eight byte reals. diff --git a/v1.0.7/_sources/index.rst.txt b/v1.0.7/_sources/index.rst.txt new file mode 100644 index 00000000..ff4059ba --- /dev/null +++ b/v1.0.7/_sources/index.rst.txt @@ -0,0 +1,168 @@ +.. hymd documentation master file, created by + sphinx-quickstart on Thu Dec 16 13:31:43 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +############################### +HylleraasMD documentation +############################### + +:Release: + |release| +:Date: + |today| + +**HylleraasMD** (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems. + +HyMD can run canonical hPF-MD simulations :cite:`Milano2009JCP`, or filtered +density Hamiltonian hPF (HhPF-MD) simulations :cite:`bore2020hamiltonian`, with +or without explicit PME electrostatic interactions :cite:`kolli2018JCTC`. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +:cite:`Cascella2008,bore2018hybrid`. Martini +style elastic networks (ElNeDyn) :cite:`periole2009combining` are also +supported. + +HyMD uses the pmesh (`github.com/rainwoodman/pmesh`_) library for particle-mesh +operations, with the PPFT :cite:`pippig2013pfft` backend for FFTs through the +pfft-python bindings (`github.com/rainwoodman/pfft-python`_). File IO is done +via HDF5 formats to allow MPI parallel reads. + +User Guide +========== +The HylleraasMD :doc:`User Guide ` provides comprehensive information on how to run +simulations. Selected :doc:`Examples ` are available to guide new users. + +.. _`github.com/rainwoodman/pmesh`: + https://github.com/rainwoodman/pmesh +.. _`github.com/rainwoodman/pfft-python`: + https://github.com/rainwoodman/pfft-python + +Installing HyMD +=============== +The easiest approach is to install using pip_: + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + +For more information and **required dependencies**, see +:ref:`installation-label`. + +.. _pip: + http://www.pip-installer.org/en/latest/index.html + + +Run in Google colab +------------------- +Run HyMD interactively in `Google Colaboratory`_ jupyter notebook `here`_. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Source Code +=========== +**Source code** is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the `GNU Lesser General Public +License v3.0`_. Obtain the source code with `git`_: + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git + +.. _GNU Lesser General Public License v3.0: + https://www.gnu.org/licenses/lgpl-3.0.html +.. _git: + https://git-scm.com/ + + +Development +=========== +HyMD is developed and maintained by researchers at the `Hylleraas Centre for +Quantum Molecular Sciences`_ at the `University of Oslo`_. + +|pic1| |pic2| + +.. _`Hylleraas Centre for Quantum Molecular Sciences`: + https://www.mn.uio.no/hylleraas/english/ +.. _`University of Oslo`: + https://www.uio.no/ + +.. |pic1| image:: img/hylleraas_centre_logo_black.png + :target: img/hylleraas_centre_logo_black.png + :width: 250 px + +.. |pic2| image:: img/uio_full_logo_eng_pos.png + :target: img/uio_full_logo_eng_pos.png + :width: 325 px + + + +References +========== +.. bibliography:: + :all: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. Contents +.. ======== + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Getting started + + ./doc_pages/installation + ./doc_pages/overview + ./doc_pages/config_file + ./doc_pages/topology_input + ./doc_pages/command_line + ./doc_pages/constants_and_units + + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Examples + + ./doc_pages/examples + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Theory + + ./doc_pages/theory + ./doc_pages/intramolecular_bonds + ./doc_pages/electrostatics + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Developer documentation + + ./doc_pages/interaction_energy_functionals + ./doc_pages/filtering + ./doc_pages/benchmarks + ./doc_pages/api diff --git a/v1.0.7/_static/basic.css b/v1.0.7/_static/basic.css new file mode 100644 index 00000000..be19270e --- /dev/null +++ b/v1.0.7/_static/basic.css @@ -0,0 +1,856 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/v1.0.7/_static/css/badge_only.css b/v1.0.7/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/v1.0.7/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/v1.0.7/_static/css/fonts/Roboto-Slab-Bold.woff b/v1.0.7/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/v1.0.7/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/v1.0.7/_static/css/fonts/Roboto-Slab-Bold.woff2 b/v1.0.7/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/v1.0.7/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/v1.0.7/_static/css/fonts/Roboto-Slab-Regular.woff b/v1.0.7/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/v1.0.7/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/v1.0.7/_static/css/fonts/Roboto-Slab-Regular.woff2 b/v1.0.7/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/v1.0.7/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/v1.0.7/_static/css/fonts/fontawesome-webfont.eot b/v1.0.7/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/v1.0.7/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/v1.0.7/_static/css/fonts/fontawesome-webfont.svg b/v1.0.7/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/v1.0.7/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v1.0.7/_static/css/fonts/fontawesome-webfont.ttf b/v1.0.7/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/v1.0.7/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/v1.0.7/_static/css/fonts/fontawesome-webfont.woff b/v1.0.7/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/v1.0.7/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/v1.0.7/_static/css/fonts/fontawesome-webfont.woff2 b/v1.0.7/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/v1.0.7/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/v1.0.7/_static/css/fonts/lato-bold-italic.woff b/v1.0.7/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/v1.0.7/_static/css/fonts/lato-bold-italic.woff differ diff --git a/v1.0.7/_static/css/fonts/lato-bold-italic.woff2 b/v1.0.7/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/v1.0.7/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/v1.0.7/_static/css/fonts/lato-bold.woff b/v1.0.7/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/v1.0.7/_static/css/fonts/lato-bold.woff differ diff --git a/v1.0.7/_static/css/fonts/lato-bold.woff2 b/v1.0.7/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/v1.0.7/_static/css/fonts/lato-bold.woff2 differ diff --git a/v1.0.7/_static/css/fonts/lato-normal-italic.woff b/v1.0.7/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/v1.0.7/_static/css/fonts/lato-normal-italic.woff differ diff --git a/v1.0.7/_static/css/fonts/lato-normal-italic.woff2 b/v1.0.7/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/v1.0.7/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/v1.0.7/_static/css/fonts/lato-normal.woff b/v1.0.7/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/v1.0.7/_static/css/fonts/lato-normal.woff differ diff --git a/v1.0.7/_static/css/fonts/lato-normal.woff2 b/v1.0.7/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/v1.0.7/_static/css/fonts/lato-normal.woff2 differ diff --git a/v1.0.7/_static/css/theme.css b/v1.0.7/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/v1.0.7/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/v1.0.7/_static/custom.css b/v1.0.7/_static/custom.css new file mode 100644 index 00000000..b20d6282 --- /dev/null +++ b/v1.0.7/_static/custom.css @@ -0,0 +1,91 @@ + +body{ + background: #FFFFFF !important; +} + +.wy-menu-vertical header, .wy-menu-vertical p.caption{ + color: #4EA0AF!important; +} +.wy-menu-vertical li.current{ + background-color: #f4f4f4!important; +} +.wy-menu-vertical li.toctree-l2.current>a{ + background-color: #ebebeb!important; +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{ + background-color: #e3e3e3!important; +} + +.rst-content .sidebar{ + background-color: #fff!important; + border-radius: 6px; + -moz-border-radius: 6px; + -webkit-border-radius: 6px; +} + +h1 > a, h2 > a, h3 > a, h4 > a, h5 > a, h6 > a { + color: #17d9ff; +} + +h1, h2, h3, h4, h5, h6 { + color: black; + font-weight: normal; + padding: 0; +} + +h1, h2, h3 { + margin-top: 30px; + margin-bottom: 20px; +} + +h1 { + color: white; + padding: 20px 20px 20px 45px; + margin: 20px 0 35px -45px; + background: linear-gradient(to left, #fff, #2b38ff)!important; + + width: calc(100% + 90px); + border-bottom: 3px solid #000; +} + +h2 { + padding: .2em 0; + border-bottom: 1px solid #ddd; +} + +h3 { + margin-top: 35px; +} + +h4 { + margin-top: 30px; +} + +h5 { + margin-top: 25px; +} + +.wy-nav-content{ + max-width: none!important; +} + +.wy-side-nav-search{ + background: #2b38ff!important; +} + +.wy-side-nav-search input[type=text]{ + border-color:#4DA0B0!important; +} + +.wy-side-nav-search input[type=text]{ + border-radius: 4px!important; +} + +#caption-api { + background: red !important; +} + +#caption-text-api { + text-color: blue !important; +} diff --git a/v1.0.7/_static/doctools.js b/v1.0.7/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/v1.0.7/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/v1.0.7/_static/documentation_options.js b/v1.0.7/_static/documentation_options.js new file mode 100644 index 00000000..364d89fd --- /dev/null +++ b/v1.0.7/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '1.0.7', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/v1.0.7/_static/file.png b/v1.0.7/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/v1.0.7/_static/file.png differ diff --git a/v1.0.7/_static/hymd_icon_white.png b/v1.0.7/_static/hymd_icon_white.png new file mode 100644 index 00000000..d0396a17 Binary files /dev/null and b/v1.0.7/_static/hymd_icon_white.png differ diff --git a/v1.0.7/_static/hymd_logl_white_text_abbr.png b/v1.0.7/_static/hymd_logl_white_text_abbr.png new file mode 100644 index 00000000..8c0e50c8 Binary files /dev/null and b/v1.0.7/_static/hymd_logl_white_text_abbr.png differ diff --git a/v1.0.7/_static/jquery-3.5.1.js b/v1.0.7/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/v1.0.7/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. API reference

+
+

4.1. Integrator

+

Integrates equations of motion.

+

Implements the Velocity Verlet integrator. The reversible reference system +propagator algorithm (rRESPA) integrator uses the Velocity Verlet functions +inside the MD loop in the main module.

+
+
+hymd.integrator.integrate_position(positions, velocities, time_step)[source]
+

Position update step of the Velocity Verlet integration algorithm.

+

Computes the position update step of the Velocity Verlet algorithm. The +positions argument is not changed in place.

+
+
Parameters:
+
+
positions(N, D) numpy.ndarray

Array of positions of N particles in D dimensions.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_velocity

The velocity update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step, then the positions are updated a full step using the updated +velocities

+
+\[\mathbf{x}_{\text{new}} = \mathbf{x} + \Delta t \mathbf{v}\]
+
+ +
+
+hymd.integrator.integrate_velocity(velocities, accelerations, time_step)[source]
+

Velocity update step of the Velocity Verlet integration algorithm.

+

Computes the velocity update step of the Velocity Verlet algorithm. The +velocities argument is not changed in place.

+
+
Parameters:
+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
accelerations(N, D) numpy.ndarray

Array of accelerations of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_position

The position update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step

+
+\[\mathbf{v}_{\text{new}} = \mathbf{v} + \frac{\Delta t}{2m} +\mathbf{f}\]
+

before the positions are moved a full step using the updated half-step +velocities.

+
+ +
+
+

4.2. Thermostat

+

Scales or otherwise modifies the particle velocities during simulation to +simulate coupling to an external heat bath with temperature T₀.

+
+
+hymd.thermostat._random_chi_squared(prng: numpy.random._generator.Generator, M: int)float[source]
+

Draw the sum of M squared normally distributed values

+

The value is generated by the Gamma distribution, in lieu of generating +M Gaussian distributed numbers and summing their squares.

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
Mint

Number of standard normally distributed numbers in the sum.

+
+
+
+
Returns:
+
+
float

The sum of M squared normally distributed values centered at +zero with unit standard deviation.

+
+
+
+
+

Notes

+

The sum of the squares of k independent standard normal random variables is +distributed according to a \(\chi^2\) distribution.

+
+\[\chi^2_1 + \chi_2^2 + \chi_3^2 + \dots + \chi_M^2 +\sim +\sigma^2\chi^2(k)\]
+

This is a special case of the \(\Gamma\) distribution, +\(\Gamma(k/2, 2)\), and may be generated by

+
+\[\chi^2(k) \sim 2 \Gamma(k/2, 2)\]
+

References

+

Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of +Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. +J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246.

+
+ +
+
+hymd.thermostat._random_gaussian(prng: numpy.random._generator.Generator)float[source]
+

Draw a single random number from the standard normal distribution +Generate a number from the Gaussian distribution centered at zero with unit +standard deviation, \(N(0, 1)\).

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
+
+
Returns:
+
+
float

A random number drawn from \(N(0, 1)\).

+
+
+
+
+
+ +
+
+hymd.thermostat.csvr_thermostat(velocity: numpy.ndarray, names: numpy.ndarray, config: hymd.input_parser.Config, prng: numpy.random._generator.Generator, comm: mpi4py.MPI.Intracomm = <mpi4py.MPI.Intracomm object>, random_gaussian: Callable[[numpy.random._generator.Generator], float] = <function _random_gaussian>, random_chi_squared: Callable[[numpy.random._generator.Generator, int, float], float] = <function _random_chi_squared>, remove_center_of_mass_momentum: bool = True)numpy.ndarray[source]
+

Canonical sampling through velocity rescaling thermostat

+

Implements the CSVR thermostat. Rescales the system kinetic energy by a +stochastically chosen factor to keep the temperature constant. Requires +communcation of the kinetic energies calculated locally for each MPI rank. +The random numbers sampled through random_gaussian and +random_chi_squared are broadcast from the root rank to the other +ranks to ensure the scaling is performed with the same stochasticity for +all particles in the full system.

+

The velocities are cleaned of center of mass momentum before the thermostat +is applied, and the center of mass momentum is subsequently reapplied. This +is performed for each thermostat coupling group, i.e. the center of mass +momenta of each group is separately removed and reapplied after +thermostatting.

+

The implementation here is based on the derivation presented in the 2008 +Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper.

+
+
Parameters:
+
+
velocity(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
names(N,) numpy.ndarray

Array of particle names.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
random_gaussiancallable, optional

Function for generating standard normally distributed numbers.

+
+
random_chi_squaredcallable, optional

Function for generating \(\chi^2\)-distributed numbers

+
+
remove_center_of_mass_momentumbool, optional

If True, the center of mass of each coupling group is removed before +the thermostat is applied. The center of mass momenta are added back +after the kinetic energy rescaling is complete.

+
+
+
+
+
+

See also

+
+
_random_gaussian

Used to sample Gaussian-distributed numbers.

+
+
_random_chi_squared

Used to sample \(\chi^2\)-distributed numbers.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +

References

+

G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). +G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008).

+
+ +
+
+

4.3. Hamiltonian

+
+
+class hymd.hamiltonian.Hamiltonian(config)[source]
+

Interaction energy functional superclass

+
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+_setup()[source]
+

Superclass setup

+

Sets up the grid-independent filtering function H, and the +SymPy logic for symbolically differentiating interaction energy +functionals in Hamiltonian subclasses.

+
+ +
+ +
+
+class hymd.hamiltonian.SquaredPhi(config)[source]
+

Simple squared density interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + \sum_k \tilde\phi_k + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(rho_0\) is the +average density of the fully homogenous system. Expressing the species +densities in terms of fluctuations from the average,

+
+\[\mathrm{d}\tilde\phi_k = \rho_0 - \tilde\phi_k,\]
+

it is evident that this interaction energy functional is a slight change of +the DefaultNoChi Hamiltonian, as the expanded interaction energy +density becomes

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + 6\rho_0\left[ + \sum_k \mathrm{d}\tilde\phi_k + \right] + + + 9\rho_0^2 + + + \sum_k \mathrm{d}\tilde\phi_k^2 + + + \prod_{k\not=l} + \mathrm{d}\tilde\phi_k \mathrm{d}\tilde\phi_l + \right),\]
+

identical to DefaultNoChi apart from a constant energy shift +\(9\rho_0^2`(which does not impact dynamics) and the +:math:\)rho_0`–\(\mathrm{d}\tilde\phi_k\) cross-terms. These +cross-terms constitute contributions to the energy linear in +\(\mathrm{d}\tilde\phi_k\) absent in DefaultNoChi, which has +only quadratic terms present.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultNoChi(config)[source]
+

Incompressibility-only interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a +\right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. The SquaredPhi Hamiltonian implements a similar +functional with an additional linear term component depending on

+
+\[\mathmr{d}\tilde\phi_k = \tilde\phi_k - \rho_0\]
+

and not \(\mathrm{d}\tilde\phi_k^2\). No explicit inter-species +interaction is present apart from the indirect interaction through the +incompressibility.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultWithChi(config, unique_names, type_to_name_map)[source]
+

Incompressibility and \(\chi\)-interactions energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = + \frac{1}{2\rho_0} + \sum_{k,l}\chi_{kl} \tilde\phi_k \tilde\phi_l + + + \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. \(\chi_{ij}\) is the Flory-Huggins-like +inter-species mixing energy.

+
+
+__init__(config, unique_names, type_to_name_map)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup(unique_names, type_to_name_map)[source]
+

Setup the interaction energy potential and the external potential

+
+
Parameters:
+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+ +
+ +
+
+

4.4. Force

+

Calculates intramolecular forces between bonded particles in molecules

+
+
+class hymd.force.Angle(atom_1: str, atom_2: str, equilibrium: float, strength: float, atom_3: str)[source]
+

Dataclass representing a single three-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any three-particle bond between particles of specific types A, +B, and C (where A, B, and C may be +different or the same). Harmonic angular three-particle bonds in HyMD take +the form

+
+\[V_3(\mathbf{r}_1, \mathbf{r}_2, \mathbf{r}_3) = + \frac{1}{2}k + \left( + \cos^{-1} + \left[ + \frac{ + (\mathbf{r}_1-\mathbf{r}_2) + \cdot + (\mathbf{r}_3-\mathbf{r}_2) + } + { + \vert\mathbf{r}_1-\mathbf{r}_2\vert + \vert\mathbf{r}_3-\mathbf{r}_2\vert + } + \right] - \theta_0 + \right)^2\]
+
+

See also

+
+
Bond

Two-particle bond type dataclass

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
equilibriumfloat

Equilibrium angle at which the energy associated with the +three-particle angular bond vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient.

+
+
+
+
+
+
+atom_3: str
+
+ +
+ +
+
+class hymd.force.Bond(atom_1: str, atom_2: str, equilibrium: float, strength: float)[source]
+

Dataclass representing a single two-particle bond type

+

A bond type is a bond strength and equilibrium distance associated with +any bond between particles of specific types A and B +(where A and B may be the same or different). Harmonic +two-particle bonds in HyMD take the form

+
+\[V_2(\mathbf{r}_1, \mathbf{r}_2) = + \frac{1}{2}k + \left( + \vert \mathbf{r}_1 - \mathbf{r}_2 \vert - r_0 + \right)^2,\]
+

where \(k\) is the bond strength (spring constant) and \(r_0\) is +the equilibrium bond length (at which the energy is zero).

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
equilibriumfloat

Equilibrium distance at which the energy associated with the bond +vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient (spring constant).

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+equilibrium: float
+
+ +
+
+strength: float
+
+ +
+ +
+
+class hymd.force.Chi(atom_1: str, atom_2: str, interaction_energy: float)[source]
+

Dataclass representing a single \(\chi\) mixing interaction type

+

An interaction mixing energy type is a mixing energy associated with +density overlap between species of types A and B +(specified as inputs atom_1 and atom_2). A positive mixing +energy promotes phase separation, a negative mixing energy promotes mixing. +The interaction energy density (provided the DefaultWithChi +Hamiltonian is used) takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} + \sum_{k,l}\chi_{k,l} \tilde\phi_k\tilde\phi_l,\]
+

where \(\chi_{k,l}\) denotes the mixing energy between species +\(k\) and \(l\), with \(\kappa\) being the incompressibility. +The value of the interaction mixing energy parameter may be extracted from +Flory-Huggins theory.

+
+

See also

+
+
hymd.hamiltonian.DefaultWithChi

Interaction energy functional using \(\chi\)-interactions.

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
interaction_energyfloat

Interaction mixing energy.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+interaction_energy: float
+
+ +
+ +
+
+class hymd.force.Dielectric_type(atom_1: str, dielectric_value: float)[source]
+
+
+atom_1: str
+
+ +
+
+dielectric_value: float
+
+ +
+ +
+
+class hymd.force.Dihedral(atom_1: str, atom_2: str, atom_3: str, atom_4: str, coeffs: numpy.ndarray, dih_type: int)[source]
+

Dataclass representing a single four-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any four-particle torsional bond between particles of specific types +A, B, C, and D (where A, B, +C, and D may be different or the same). Dihedral +four-particle bonds in HyMD take different forms depending on the +dih_type parameter.

+

In the following, let \(\phi\) denote the angle between the planes +spanned by the relative positions of atoms A-B-C +and B-C-D. If dih_type = 0, then

+
+\[V_4(\phi) = \sum_n c_n + \left( + 1 + \cos\left[ + n\phi - d_n + \right] + \right),\]
+

where \(c_n\) are energy coefficients and \(d_n\) are propensity +phases. By default, the cosine sum is truncated at five terms. If +coeffs provides only a single float, this is used as the coiling +propensity parameter \(\lambda\). In this case, \(c_n\) and +\(d_n\) are automatically set to values which promote alpha helical +(\(\lambda=-1\)), beta sheet (\(\lambda=1\)), or a mixed +(\(1>\lambda>-1\)) structure (using values provided by Bore et al. +(2018)). In this case, the full potential takes the form

+
+\[V_4(\phi;\lambda) = + \frac{1}{2}(1-\lambda) V_{\text{prop},\alpha}(\phi) + + + \frac{1}{2}(1+\lambda) V_{\text{prop},\beta}(\phi) + + + (1-\vert\lambda\vert) V_{\text{prop}, \text{coil}}(\phi),\]
+

with each of the \(V_{\mathrm{prop}, X}\) being fixed cosine series +potentials with pre-set \(c_n\) -s and \(d_n\) -s.

+

If dih_type = 1, then a combined bending torsional (CBT) potential +is employed,

+
+\[V_4(\phi,\gamma;\lambda) = + V_4(\phi;\lambda) + + + \frac{1}{2}K(\phi)(\gamma - \gamma_0)^2,\]
+

where \(V_4(\phi;\lambda)\) specifies the potential as given by the +coiling propensity parameter above, \(K(\phi)\) is a separate cosine +series potential acting as the angular three-particle bond strength, and +\(\gamma_0\) is the three-particle bond equilibrium angle. In this +case, the coeffs parameter must specify both a \(\lambda\) +value, in additon to the energy and phases dictating the \(K(\phi)\) +potential.

+

References

+

Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018.

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
atom_4str

Type name of particle 4.

+
+
coeffslist[list[float]] or list[float] or numpy.ndarray

Dihedral coefficients defining the series expansion of the dihedral +energy.

+
+
dih_typeint

Specifies the type of dihedral used; If 0, then coeffs +must contain either two lists of five energy coefficients +\(c_n\) and five propensity phases \(d_n\) or a single +floating point number defining the \(\lambda\) coiling propensity +parameter. If 1, the combined bending-torsional potential is +used, and coeffs must specify \(\lambda\) and two lists +containing energy coefficients and propensity phases for the +\(V_\text{prop}\) propensity potential, defined in terms of cosine +series.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+atom_3: str
+
+ +
+
+atom_4: str
+
+ +
+
+coeffs: numpy.ndarray
+
+ +
+
+dih_type: int
+
+ +
+ +
+
+hymd.force.compute_angle_forces__plain(f_angles, r, bonds_3, box_size)[source]
+

Computes forces resulting from angular interactions

+
+

Deprecated since version 1.0.0: compute_angle_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_bond_forces__plain(f_bonds, r, bonds_2, box_size)[source]
+

Computes forces resulting from bonded interactions

+
+

Deprecated since version 1.0.0: compute_bond_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size)[source]
+

Computes forces resulting from dihedral interactions

+
+

Deprecated since version 1.0.0: compute_dihedral_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.dipole_forces_redistribution(f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb)[source]
+

Redistribute electrostatic forces calculated from topologically +reconstructed ghost dipole point charges to the backcone atoms of the protein.

+
+ +
+
+hymd.force.find_all_paths(G, u, n)[source]
+

Helper function that recursively finds all paths of given lenght ‘n + 1’ inside a network ‘G’. +Adapted from https://stackoverflow.com/a/28103735.

+
+ +
+
+hymd.force.prepare_bonds(molecules, names, bonds, indices, config, topol=None)[source]
+

Rearrange the bond information for usage in compiled Fortran kernels

+

Restructures the lists resulting from the execution of +prepare_bonds_old into numpy arrays suitable for calls to optimized +Fortran code calculating bonded forces and energiesself.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2_atom_1(B,) numpy.ndarray

Local index of particle 1 for each of B constructed +two-particle bonds.

+
+
bonds_2_atom_2(B,) numpy.ndarray

Local index of particle 2 for each of B constructed +two-particle bonds.

+
+
bonds_2_equilibrium(B,) numpy.ndarray

Equilibrium distance for each of B constructed two-particle +bonds.

+
+
bonds_2_strength(B,) numpy.ndarray

Bond strength for each of B constructed two-particle +bonds.

+
+
bonds_3_atom_1(A,) numpy.ndarray

Local index of particle 1 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_2(A,) numpy.ndarray

Local index of particle 2 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_3(A,) numpy.ndarray

Local index of particle 3 for each of A constructed +three-particle bonds.

+
+
bonds_3_equilibrium(A,) numpy.ndarray

Equilibrium angle for each of A constructed three-particle +bonds.

+
+
bonds_3_strength(A,) numpy.ndarray

Bond strength for each of A constructed three-particle +bonds.

+
+
bonds_4_atom_1(D,) numpy.ndarray

Local index of particle 1 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_2(D,) numpy.ndarray

Local index of particle 2 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_3(D,) numpy.ndarray

Local index of particle 3 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_4(D,) numpy.ndarray

Local index of particle 4 for each of D constructed +four-particle bonds.

+
+
bonds_4_coeff(D,) numpy.ndarray

Cosine series coefficients for each of D constructed +four-particle bonds.

+
+
bonds_4_type(D,) numpy.ndarray

Dihedral type for each of D constructed four-particle +bonds.

+
+
bonds_4_last(D,) numpy.ndarray

Flags indicating if dih_type is 1 for each of D +constructed four-particle bonds.

+
+
+
+
+
+

See also

+
+
prepare_bonds_old

Used internally to reconstruct the bonded interactions types from the connectivity information in the structure/topology input file and the bonded types specified in the configuration file.

+
+
+ +
+ +
+
+hymd.force.prepare_bonds_old(molecules, names, bonds, indices, config)[source]
+

Find bonded interactions from connectivity and bond types information

+
+

Deprecated since version 1.0.0: prepare_bonds_old was replaced by prepare_bonds for +use with compiled Fortran kernels prior to 1.0.0 release.

+
+

Prepares the necessary equilibrium and bond strength information needed by +the intramolecular interaction functions. This is performed locally on each +MPI rank, as the domain decomposition ensures that for all molecules all +consituent particles are always contained on the same MPI rankself.

+

This function traverses the bond connectivity information provided in the +structure/topology input file and indentifies any two-, three-, or +four-particle potential bonds. For each connected chain of two, three, or +four particles, a matching to bond types is attempted. If the corresponding +names match, a bond object is initialized.

+

In order to investigate the connectivity, a graph is created using +networkx functionality.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2list

List of lists containing local particle indices, equilibrium +distance, and bond strength coefficient for each reconstructed +two-particle bond.

+
+
bonds_3

List of lists containing local particle indices, equilibrium angle, +and bond strength coefficient for each reconstructed three-particle +bond.

+
+
bonds_4

List of lists containing local particle indices, dihedral type index, +and dihedral coefficients for each reconstructed four-particle +torsional bond.

+
+
bb_indexlist

List indicating the dihedral type of each four-particle bond in +bonds_4.

+
+
+
+
+
+

See also

+
+
Bond

Two-particle bond type dataclass.

+
+
Angle

Three-particle angular bond type dataclass.

+
+
Dihedral

Four-particle torsional bond type dataclass.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+hymd.force.prepare_index_based_bonds(molecules, topol)[source]
+
+ +
+
+hymd.force.propensity_potential_coeffs(x: float)[source]
+
+ +
+
+

4.5. Logger

+
+
+class hymd.logger.Logger[source]
+

Log output handler class

+

Notes

+

This wraps the default python library logging, see +docs.python.org/3/library/logging.html.

+
+
Attributes:
+
+
levelint

Determines the verbosity level of the log, corresponding to +logging.level. Numerical values 50 (logging.CRITICAL), +40 (logging.ERROR), 30 +(logging.WARNING), 20 (logging.INFO), +10 (logging.DEBUG), and 0 +(logging.UNSET) are supported values. Any log event message +less severe than the specified level is ignored. All other event +messages are emitted.

+
+
log_filestr

Path to output log file.

+
+
formatstr

Prepended dump string for each log event. Specifies the log event +level, the module emitting the event, the code line, the enclosing +function name, and the MPI rank writing the message.

+
+
date_formatstr

Prepends the date before all log event messages.

+
+
formatterlogging.Formatter

Formatter handling the prepending of the information in format and +date_format to each log event message. Used by default for all +loggers.

+
+
rank0logging.Logger

Default logger object for the root MPI rank.

+
+
all_rankslogging.Logger

Default logger object for messages being emitted from all MPI ranks +simultaneously.

+
+
+
+
+
+
+classmethod setup(default_level=20, log_file=None, verbose=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Sets up the logger object.

+

If a log_file path is provided, log event messages are output +to it. Otherwise, the logging messages are emitted to stdout.

+
+
Parameters:
+
+
default_levelint, optional

Default verbosity level of the logger. Unless specified, it is +10 (logging.INFO).

+
+
log_filestr, optional

Path to output log file. If None or not priovided, no log file is +used and all logging is done to stdout.

+
+
verbosebool, optional

Increases the logging level to 30 (logging.WARNING) +if True, otherwise leaves the logging level unchanged.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterRoot(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the root MPI rank log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterAll(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the all-MPI-ranks log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+

4.6. Input parser

+

Parses and handles the configuration information provided for the simulation

+
+
+class hymd.input_parser.Config(n_steps: int, time_step: float, mesh_size: Union[List[int], numpy.ndarray, int], sigma: float, kappa: float, dtype: Optional[numpy.dtype] = None, box_size: Optional[Union[List[float], numpy.ndarray]] = None, n_print: Optional[int] = None, tau: Optional[float] = None, start_temperature: Optional[Union[float, bool]] = None, target_temperature: Optional[Union[float, bool]] = None, mass: Optional[float] = None, hamiltonian: Optional[str] = None, domain_decomposition: Optional[Union[int, bool]] = None, integrator: Optional[str] = None, respa_inner: int = 1, file_name: str = '<config file path unknown>', name: Optional[str] = None, tags: List[str] = <factory>, bonds: List[hymd.force.Bond] = <factory>, angle_bonds: List[hymd.force.Angle] = <factory>, dihedrals: List[hymd.force.Dihedral] = <factory>, chi: List[hymd.force.Chi] = <factory>, n_particles: Optional[int] = None, max_molecule_size: Optional[int] = None, n_flush: Optional[int] = None, thermostat_work: float = 0.0, thermostat_coupling_groups: List[List[str]] = <factory>, initial_energy: Optional[float] = None, cancel_com_momentum: Union[int, bool] = False, coulombtype: Optional[str] = None, convergence_type: Optional[str] = None, pol_mixing: Optional[float] = None, dielectric_const: Optional[float] = None, conv_crit: Optional[float] = None, dielectric_type: List[hymd.force.Dielectric_type] = <factory>, self_energy: Optional[float] = None, type_charges: Optional[Union[List[float], numpy.ndarray]] = None, rho0: Optional[float] = None, a: Optional[float] = None, pressure: bool = False, barostat: Optional[str] = None, barostat_type: Optional[str] = None, tau_p: Optional[float] = None, target_pressure: List[hymd.barostat.Target_pressure] = <factory>, n_b: Optional[int] = None, m: List[float] = <factory>)[source]
+

Configuration object

+

Handles and verifies the simulation configuration specified in the +configuration file.

+
+

See also

+
+
hymd.input_parser.Bond

Two-particle bond type dataclass.

+
+
hymd.input_parser.Angle

Three-particle bond type dataclass.

+
+
hymd.input_parser.Dihedral

Four-particle bond type dataclass.

+
+
+ +
+
Attributes:
+
+
gas_constantfloat

Constant value of the gas constant, R (equivalently the Boltzmann +constant) in the units used internally in HyMD.

+
+
coulomb_constantfloat

Constant value of the Coulomb constant which converts electric field +values to forces and electric potential values to energies in the units +used internally in HyMD.

+
+
n_steps: int

Number of time steps in the simulation.

+
+
time_step: float

Outer time step used in the simulation. If the rRESPA intergrator is +used, the inner time step (the time step used in the integration of +intramolecular bending, stretching, and torsional forces) is +time_step / respa_inner.

+
+
box_sizelist[float] or (D,) numpy.ndarray

Simulation box size of simulation in D dimensions in units of +nanometers.

+
+
mesh_sizelist[int] or int or numpy.ndarray

Number of grid points used for the discrete density grid.

+
+
sigmafloat

Filter width representing the effective coarse-graining level of the +particles in the simulation.

+
+
kappafloat

Compressibility parameter used in the relaxed incompressibility term in +the interaction energy functional.

+
+
n_printint, optional

Frequency of trajectory/energy output to the H5MD trajectory/energy +output file (in units of number of time steps).

+
+
taufloat, optional

The time scale of the CSVR thermostat coupling.

+
+
start_temperaturefloat, optional

Generate starting temperature by assigning all particle velocities +randomly according to the Maxwell-Boltzmann distribution at +start_temperature Kelvin prior to starting the simulation.

+
+
target_temperaturefloat, optional

Couple the system to a heat bath at target_temperature Kelvin.

+
+
massfloat, optional

Mass of the particles in the simulation.

+
+
hamiltonianstr, optional

Specifies the interaction energy functional \(W[\tilde\phi]\) +for use with the particle-field interactions. Options: +SquaredPhi, DefaultNohChi, or DefaultWithChi.

+
+
domain_decompositionint, optional

Specifies the interval (in time steps) of domain decomposition +exchange, involving all MPI ranks sending and receiving particles +according to the particles’ positions in the integration box and the +MPI ranks’ assigned domain.

+
+
integratorstr, optional

Specifies the time integrator used in the simulation. Options: +velocity-verlet or respa.

+
+
respa_innerint, optional

The number of inner time steps in the rRESPA integrator. This denotes +the number of intramolecular force calculations (stretching, bending, +torsional) are performed between each impulse applied from the field +forces.

+
+
file_namestr, optional

File path of the parsed configuration file.

+
+
namestr, optional

Name for the simulation.

+
+
tagslist[str], optional

Tags for the simulation.

+
+
bondslist[Bond], optional

Specifies harmonic stretching potentials between particles in the +same molecule.

+
+
angle_bondslist[Angle], optional

Specifies harmonic angular bending potentials between particles in the +same molecule.

+
+
dihedralslist[Dihedral], optional

Specifies four-particle torsional potentials by cosine series.

+
+
chilist[Chi], optional

Specifies \(\chi\)-interaction parameters between particle +species.

+
+
n_particlesint, optional

Specifies the total number of particles in the input. Optional keyword +for validation, ensuring the input HDF5 topology has the correct number +of particles and molecules.

+
+
max_molecule_sizeint, optional

Maximum size of any single molecule in the system. Used to speed up +distribution of particles onto MPI ranks in a parallel fashion.

+
+
n_flushint, optional

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be +written to disk (in units of number of n_print).

+
+
thermostat_workfloat

Work performed by the thermostat on the system.

+
+
thermostat_coupling_groupslist[str], optional

Specifies individual groups coupling independently to the CSVR +thermostat. E.g. in a system containing "A", "B", and +"C" type particles, +thermostat_coupling_groups = [["A", "B"], ["C"],] would +thermalise types "A" and "B" together and couple +"C" type particles to a different thermostat (all individual +thermostats are at the same temperature, i.e. target_temperature +Kelvin).

+
+
initial_energyfloat

Value of the total energy prior to the start of the simulation.

+
+
cancel_com_momentumint, optional

If True, the total linear momentum of the center of mass is +removed before starting the simulation. If an integer is specifed, the +total linear momentum of the center of mass is removed every +remove_com_momentum time steps. If False, the linear +momentum is never removed.

+
+
coulombtypestr, optional

Specifies the type of electrostatic Coulomb interactions in the system. +The strength of the electrostatic forces is modulated by the relative +dielectric constant of the simulation medium, specified with the +dielectric_const keyword. Charges for individual particles are +specified in the structure/topology HDF5 input file, not in the +configuration file. If no charges (or peptide backbone dipoles) are +present, the electrostatic forces will not be calculated even if this +keyword is set to "PIC_Spectral".

+
+
dielectric_constfloat, optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. When +using helical propensity dihedrals, this keyword must be specified—even +if electrostatics are not included with the coulombtype +keyword.

+
+
dielectric_type: list[float], optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. The list assigns +relative dielectric values to each bead type, and an anisotropic +dielectric function is obtained from a weighted average.

+
+
+
+
+
+
+a: float = None
+
+ +
+
+angle_bonds: List[hymd.force.Angle]
+
+ +
+
+barostat: str = None
+
+ +
+
+barostat_type: str = None
+
+ +
+
+bonds: List[hymd.force.Bond]
+
+ +
+
+box_size: Union[List[float], numpy.ndarray] = None
+
+ +
+
+cancel_com_momentum: Union[int, bool] = False
+
+ +
+
+chi: List[hymd.force.Chi]
+
+ +
+
+conv_crit: float = None
+
+ +
+
+convergence_type: str = None
+
+ +
+
+coulomb_constant: ClassVar[float] = 138.935458
+
+ +
+
+coulombtype: str = None
+
+ +
+
+dielectric_const: float = None
+
+ +
+
+dielectric_type: List[hymd.force.Dielectric_type]
+
+ +
+
+dihedrals: List[hymd.force.Dihedral]
+
+ +
+
+domain_decomposition: Union[int, bool] = None
+
+ +
+
+dtype: numpy.dtype = None
+
+ +
+
+file_name: str = '<config file path unknown>'
+
+ +
+
+gas_constant: ClassVar[float] = 0.0083144621
+
+ +
+
+hamiltonian: str = None
+
+ +
+
+initial_energy: float = None
+
+ +
+
+integrator: str = None
+
+ +
+
+kappa: float
+
+ +
+
+m: List[float]
+
+ +
+
+mass: float = None
+
+ +
+
+max_molecule_size: int = None
+
+ +
+
+mesh_size: Union[List[int], numpy.ndarray, int]
+
+ +
+
+n_b: int = None
+
+ +
+
+n_flush: int = None
+
+ +
+
+n_particles: int = None
+
+ +
+
+n_print: int = None
+
+ +
+
+n_steps: int
+
+ +
+
+name: str = None
+
+ +
+
+pol_mixing: float = None
+
+ +
+
+pressure: bool = False
+
+ +
+
+respa_inner: int = 1
+
+ +
+
+rho0: float = None
+
+ +
+
+self_energy: float = None
+
+ +
+
+sigma: float
+
+ +
+
+start_temperature: Union[float, bool] = None
+
+ +
+
+tags: List[str]
+
+ +
+
+target_pressure: List[hymd.barostat.Target_pressure]
+
+ +
+
+target_temperature: Union[float, bool] = None
+
+ +
+
+tau: float = None
+
+ +
+
+tau_p: float = None
+
+ +
+
+thermostat_coupling_groups: List[List[str]]
+
+ +
+
+thermostat_work: float = 0.0
+
+ +
+
+time_step: float
+
+ +
+
+type_charges: Union[List[float], numpy.ndarray] = None
+
+ +
+ +
+
+hymd.input_parser.check_NPT_conditions(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check validity of barostat_type, barostat, +a, rho0, target_pressure, tau_p

+
+ +
+
+hymd.input_parser.check_angles(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_bonds(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_box_size(config, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_cancel_com_momentum(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_charges(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if charges across ranks sum to zero.

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of floats with charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_charges_types_list(config, types, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates a list of charge values of length types. +Charges are sorted according to type ID. Used in field.py. +# TODO: this is messy, we should fix it

+
+ +
+
+hymd.input_parser.check_chi(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_config(config, indices, names, types, charges, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs various checks on the specfied config to ensure consistency

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
indices(N,) numpy.ndarray

Array of integer indices for N particles.

+
+
names(N,) numpy.ndarray

Array of string names for N particles.

+
+
types(N,) numpy.ndarray

Array of integer type indices for N particles.

+
+
charges(N,) numpy.ndarray

Array of floats charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
Returns:
+
+
configConfig

Validated configuration object.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_dielectric(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Error handling for electrostatics. +Unit testing of toml/tomli input.

+
+ +
+
+hymd.input_parser.check_dihedrals(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_domain_decomposition(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_hamiltonian(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_integrator(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_m(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_mass(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_max_molecule_size(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_b(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_flush(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_particles(config, indices, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_print(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_name(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_start_and_target_temperature(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Validate provided starting and target thermostat temperatures

+

Assesses the provided temperature target and ensures it is a non-negative +floating point number or False. Ensures the starting temperature is +a non-negative floating point number or False.

+

If the value for either is None, the returned configuration object +has the values defaulted to False in each case.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
validated_configConfig

Configuration object with validated target_temperature and +start_temperature.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_tau(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_thermostat_coupling_groups(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.parse_config_toml(toml_content, file_path=None, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.read_config_toml(file_path)[source]
+
+ +
+
+hymd.input_parser.sort_dielectric_by_type_id(config, charges, types)[source]
+

Creates a list of length N CG-particles, sorted after the charges from +the input HDF5 file. Used in file_io.py

+
+ +
+
+

4.7. Field

+

Forces and energies from the discretized particle-field grid interactions

+
+
+hymd.field.compute_field_and_kinetic_energy(phi, phi_q, psi, velocity, hamiltonian, positions, types, v_ext, config, layouts, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the particle-field and kinetic energy contributions

+

Calculates the kinetic energy through

+
+\[E_k = \sum_j \frac{1}{2}m_j\mathbf{v}_j\cdot\mathbf{v}_j,\]
+

and the particle-field energy by

+
+\[E_\text{field} = \int\mathrm{d}\mathbf{r}\, + w[\tilde\phi],\]
+

where \(w\) is the interaction energy functional density.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
velocity(N,D) numpy.ndarray

Array of velocities for N particles in D dimensions. +Local for each MPI rank.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Local for each MPI rank–the full computational grid is +represented by the collective fields of all MPI ranks.

+
+
configConfig

Configuration object.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field

Computes the up-to-date external potential for use in calculating the particle-field energy.

+
+
+ +
+ +
+
+hymd.field.compute_field_energy_q_GPE(config, phi_eps, field_q_energy, dot_elec, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the electrostatic energy after electrosatic forces is +calculated.

+

From the definition of the elecrostatic potential \(\Psi\), the energy +is

+
+
+
W = frac{1}{2}intmathrm{d}mathbf{r},

epsilon(mathbf{r})} left(mathbf{E}cdot mathbf{E}right),

+
+
+
+

where \(\epsilon(\mathbf{r})}\) is the anisotropic, spatially dependent, +relative dielectric of the simulation medium.

+
+
Parameters:
+
+
confighymd.input_parser.Config

Configuration object.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
field_q_energyfloat

Total elecrostatic energy.

+
+
dot_elecpmesh.pm.RealField

Pmesh RealField object for storing \(|\mathbf{E(r)}|^{2}\) +on the computational grid. Local for each MPI rank – the full computational +grid is represented by the collective fields of all MPI ranks.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field_force_q_GPE

Compute the electrosatic force from an anisotropic dielectric general Poisson equation.

+
+
+ +
+ +
+
+hymd.field.compute_field_force(layouts, r, force_mesh, force, types, n_types)[source]
+

Interpolate particle-field forces from the grid onto particle positions

+

Backmaps the forces calculated on the grid to particle positions using the +window function \(P\) (by default cloud-in-cell [CIC]). In the +following, let \(\mathbf{F}_j\) denote the force acting on the +particle with index \(j\) and position \(\mathbf{r}_j\). The +interpolated force is

+
+\[\mathbf{F}_j = -\sum_k\nabla V_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(V_{j_k}\) is the discretized external potential at grid vertex +\(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid vertex +with index \(j_k\), and \(h^3\) is the volume of each grid voxel. +The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
r(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
force(N,D) numpy.ndarray

Array of forces for N particles in D dimensions. Local +for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
n_typesint

Number of different unique types present in the simulation system. +n_types is global, i.e. the same for all MPI ranks even if some +ranks contain zero particles of certain types.

+
+
+
+
+
+ +
+
+hymd.field.compute_self_energy_q(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the self energy for the interaction due to the Ewald scheme +used to compute the electrostatics. The energy is stored in config.

+

The self interaction energy is given by:

+
+\[U_{self} = \sqrt{\frac{1}{2\pi\sigma^2}} \sum_{i=1}^{N} q_i^2\]
+

where \(q_i\) are the charges and \(\sigma\) is the half-width +of the Gaussian filter.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
Returns:
+
+
field_q_self_energyfloat

Electrostatic self energy.

+
+
+
+
+
+ +
+
+hymd.field.domain_decomposition(positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs domain decomposition

+

Rearranges the MPI rank memory layout into one that better mimics the PFFT +pencil grid 2D decomposition. As molecules are always required to be fully +contained on a single MPI rank, a perfect decomposition is not always +possible. The best decomposition which leaves the center of mass of all +molecules in their respective correct domains is used, with possible +overlap into neighbouring domains if the spatial extent of any molecule +crosses domain boundaries.

+
+
Parameters:
+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
*args

Variable length argument list containing arrays to include in the +domain decomposition.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
bonds(N,M) numpy.ndarray, optional

Array of M bonds originating from each of N particles.

+
+
verboseint, optional

Specify the logging event verbosity of this function.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
Domain decomposedcode:positions and any array specified in
+
:code:`*args`, in addition tocode:bonds and molecules if these
+
arrays were provided as input.
+
+
+
+
+ +
+
+hymd.field.initialize_pm(pmesh, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates the necessary pmesh objects for pfft operations.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pmobject ‘pmesh.pm.ParticleMesh’
+
field_listlist[pmesh.pm.RealField], (multiple)

Essential list of pmesh objects required for MD

+
+
list_coulomblist[pmesh.pm.RealField], (multiple)

Additional list of pmesh objects required for electrostatics.

+
+
+
+
+
+ +
+
+hymd.field.update_field(phi, phi_laplacian, phi_transfer, layouts, force_mesh, hamiltonian, pm, positions, types, config, v_ext, phi_fourier, v_ext_fourier, m, compute_potential=False)[source]
+

Calculate the particle-field potential and force density

+

If compute_potential is True, the energy may subsequently +be computed by calling compute_field_and_kinetic_energy.

+

Computes the particle-field external potential \(V_\text{ext}\) from +particle number densities through the smoothed density field, +\(\phi(\mathbf{r})\). With \(P\) being the cloud-in-cell (CIC) +window function, the density and filtered densities are computed as

+
+\[\phi(\mathbf{r}) = \sum_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\phi(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +external potential is computed in reciprocal space as

+
+\[V_\text{ext} = \mathrm{FFT}^{-1}\left[ + \mathrm{FFT} + \left( + \frac{\partial w}{\partial \tilde\phi} + \right) + \mathrm{FFT}(H) +\right],\]
+

where \(w\) is the interaction energy functional. Differentiating +\(V_\text{ext}\) is done by simply applying \(i\mathbf{k}\) in +Fourier space, and the resulting forces are back-transformed to direct +space and interpolated to particle positions by

+
+\[\mathbf{F}_j = -\sum_{j_k} \nabla V_{j_k} + P(\mathbf{r}_{j_k} - \mathbf{r}_j)h^3,\]
+

where \(j_k\) are the neighbouring vertices of particle \(j\) at +position \(\mathbf{r}_j\), and \(h^3\) is the volume of each grid +voxel.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Pre-allocated, but empty; any values +in this field are discarded. Changed in-place. Local for each MPI +rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
configConfig

Configuration object.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Pre-allocated, but empty; any values in this field are +discarded Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
phi_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computational grid is represented by the collective fields of all +MPI ranks.

+
+
v_ext_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplesField objects containing discretized +particle-field external potential values in reciprocal space on the +computational grid; D+1 fields in D dimensions for each +particle type. D copies are made after calculation for later +use in force calculation, because the force transfer function +application differentiates the field in-place, ruining the contents +for differentiation in the remaining D-1 spatial directions. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
m: list[float], (M,)

pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. +Defaults to 1.0 for all particle types.

+
+
compute_potentialbool, optional

If True, a D+1-th copy of the Fourier transformed +external potential field is made to be used later in particle-field +energy calculation. If False, only D copies are made.

+
+
+
+
+
+

See also

+
+
compute_field_and_kinetic_energy

Compute the particle-field energy after the external potential is calculated.

+
+
+ +
+ +
+
+hymd.field.update_field_force_q(charges, phi_q, phi_q_fourier, psi, psi_fourier, elec_field_fourier, elec_field, elec_forces, layout_q, hamiltonian, pm, positions, config)[source]
+

Calculate the electrostatic particle-field forces on the grid

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential is computed in reciprocal space as

+
+\[\Phi = \mathrm{FFT}^{-1}\left[ + \frac{4\pi k_e}{\varepsilon \vert\mathbf{k}\vert^2} + \mathrm{FFT}(\rho)\mathrm{FFT}(H) +\right],\]
+

with the electric field

+
+\[\mathbf{E} = \mathrm{FFT}^{-1}\left[ + -i\mathbf{k}\,\mathrm{FFT}(\Psi) +\right].\]
+

In the following, let \(\mathbf{F}_j\) denote the electrostatic force +acting on the particle with index \(j\) and position +\(\mathbf{r}_j\). The interpolated electrostatic force is

+
+\[\mathbf{F}_j = \sum_k q_j\mathbf{E}_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(\mathbf{E}_{j_k}\) is the discretized electric field at grid +vertex \(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid +vertex with index \(j_k\), and \(h^3\) is the volume of each grid +voxel. The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty; any values in this field +are discarded. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
elec_field_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +electric field values in reciprocal space on the computational grid. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
+
+
+
+ +
+
+hymd.field.update_field_force_q_GPE(conv_fun, phi, types, charges, phi_q, phi_q_fourier, phi_eps, phi_eps_fourier, phi_eta, phi_eta_fourier, phi_pol_prev, phi_pol, elec_field, elec_forces, elec_field_contrib, psi, Vbar_elec, Vbar_elec_fourier, force_mesh_elec, force_mesh_elec_fourier, hamiltonian, layout_q, layouts, pm, positions, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Calculate the electrostatic particle-field forces on the grid, arising from +a general Poisson equation, i.e. anisotropic permittivity/dielectric. +The function is called when tomli input config.coulombtype = “PIC_Spectral_GPE.”

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential for a variable dielectric does not have an +analytical expression, and is computed in reciprocal through an iterative +method.

+

The GPE states that

+
+\[\nabla \cdot \left(\epsilon(\mathbf{r}) +\nabla{\mathbf{\psi(r)}}\right) = -\rho({\mathbf{r}}).\]
+

where \(\epsilon(\mathbf{r})\) is the relative dielectric function.

+
+
Parameters:
+
+
conv_funConvergence function.

Returns a scalar. Depends on MPI allreduce for similar convergence +across MPI ranks.

+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_eps_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_etapmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +gradients of the relative dielectric values on the computational grid. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank–the +full computational grid is represented by the collective fields of all MPI ranks.

+
+
phi_eta_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated discretized +Fourier transformed gradient relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_pol_prevpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charge values on the computational grid. Parameter in +the iterative method.Pre-allocated,but empty. Changedin-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_polpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charges on the computational grid. Parameter in the iterative +method, updating the next quess in solving for the electrostatic potential. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank– +the full computational grid is represented by the collective fields of +all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all +MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
elec_field_contribpmesh.pm.RealField

Pmesh RealField object for storing +\(|\mathbf{E(r)}|^2/\phi_{0}\) on the computational grid. +Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
psipmesh.pm.RealField

Pmesh RealField object for storing electrostatic potential +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
Vbar_elecmesh.pm.RealField

Pmesh RealField object for storing functional derivatives of +:math:`|w({ phi })_{elec}`on the computational grid. +Pre-allocated, but empty. Changed in-place. Local for each MPI rank– +the full computational grid is represented by the collective fields of

+
+

all MPI ranks.

+
+
+
Vbar_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated functional +derivatives of \(\|w(\{ \phi \})_{elec}\) in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
force_mesh_elecpmesh.pm.RealField

Pmesh RealField object for storing electrostatic force values +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
force_mesh_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated electrostatic +force values in reciprocal space on the computational grid. Local for +each MPI rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
layouts: list[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
comm: mpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
compute_field_energy_q_GPE

Compute the electrostatic energy after electrosatic force is calculated for a variable (anisotropic) dielectric general Poisson equation.

+
+
+ +
+ +
+
+

4.8. File input/output

+

Handle file input/output in parllel HDF5 fashion

+
+
+class hymd.file_io.OutDataset(dest_directory, config, double_out=False, disable_mpio=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

HDF5 dataset handler for file output

+
+
+close_file(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Closes the HDF5 output file

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+
+flush()[source]
+

Flushes output buffers, forcing file writes

+
+ +
+
+is_open(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if HDF5 output file is open

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+ +
+
+hymd.file_io.distribute_input(in_file, rank, size, n_particles, max_molecule_size=201, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Assign global arrays onto MPI ranks, attempting load balancing

+

Distributes approximately equal numbers of particles (workload) onto each +independent MPI rank, while respecting the requirement that any molecule +must be fully contained on a single MPI rank only (no splitting molecules +across multiple CPUs).

+
+
Parameters:
+
+
in_fileh5py.File

HDF5 input file object.

+
+
rankint

Local rank number for this MPI rank.

+
+
sizeint

Global size of the MPI communicator (number of total CPUs).

+
+
n_particlesint

Total number of particles.

+
+
max_molecule_sizeint, optional

Maximum size of any molecule present in the system. Used to initially +guess where the MPI rank boundaries (start/end indices) in the global +arrays should be placed. If molecules of size +>max_molecule_size exist in the simulation system, HyMD +might work as expected. Or it might fail spectacularly.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
rank_range

Starting and ending indices in the global arrays for each MPI rank.

+
+
+
+
+
+ +
+
+hymd.file_io.setup_time_dependent_element(name, parent_group, n_frames, shape, dtype, units=None)[source]
+

Helper function for setting up time-dependent HDF5 group datasets

+

All output groups must adhere to the H5MD standard, meaning a structure of

+
+
┗━ group particle group (e.g. all) or observables group
+
+
┗━ group time-dependent data
+
+
┣━ dataset step shape=(n_frames,)
+
┣━ dataset time shape=(n_frames,)
+
┗━ dataset value shape=(n_frames, *)
+
+
+
+

is necessary.

+

References

+
+
H5MD specification :

https://www.nongnu.org/h5md/h5md.html

+
+
+
+ +
+
+hymd.file_io.store_data(h5md, step, frame, indices, positions, velocities, forces, box_size, temperature, pressure, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, field_energy, field_q_energy, plumed_bias, time_step, config, velocity_out=False, force_out=False, charge_out=False, plumed_out=False, dump_per_particle=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Writes time-step data to HDF5 output file

+

Handles all quantities which change during simulation, as opposed to +static quanitities (see store_static).

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
stepint

Step number.

+
+
frameint

Output frame number (step // n_print).

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
positions(N,) numpy.ndarray

Array of positions for N particles in D dimensions.

+
+
velocities(N,) numpy.ndarray

Array of velocities for N particles in D dimensions.

+
+
forces(N,) numpy.ndarray

Array of forces for N particles in D dimensions.

+
+
box_size(D,) numpy.ndarray

Array containing the simulation box size.

+
+
temperaturefloat

Calculated instantaneous temperature.

+
+
kinetic_energyfloat

Calculated instantaneous kinetic energy.

+
+
bond2_energyfloat

Calculated instantaneous harmonic two-particle bond energy.

+
+
bond3_energyfloat

Calculated instantaneous harmonic angular three-particle bond energy.

+
+
bond4_energyfloat

Calculated instantaneous dihedral four-particle torsion energy.

+
+
field_energyfloat

Calculated instantaneous particle-field energy.

+
+
field_q_energyfloat

Calculated instantaneous electrostatic energy.

+
+
plumed_biasfloat

PLUMED instantaneous bias energy.

+
+
time_stepfloat

Value of the time step.

+
+
configConfig

Configuration object.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charge_outbool, optional

If True, electrostatic energies are written to the output +HDF5 file.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to the output HDF5 file.

+
+
dump_per_particlebool, optional

If True, all quantities are written per particle.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
store_static

Outputs all static time-independent quantities to the HDF5 output file

+
+
+ +
+ +
+
+hymd.file_io.store_static(h5md, rank_range, names, types, indices, config, bonds_2_atom1, bonds_2_atom2, molecules=None, velocity_out=False, force_out=False, charges=False, dielectrics=False, plumed_out=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Outputs all static time-independent quantities to the HDF5 output file

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
rank_rangelist[int]

Start and end indices for global arrays for each MPI rank.

+
+
names(N,) numpy.ndarray

Array of names for N particles.

+
+
types(N,) numpy.ndarray

Array of type indices for N particles.

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
configConfig

Configuration object.

+
+
bonds_2_atom1(B,) numpy.ndarray

Array of indices of the first particle for B total +two-particle bonds.

+
+
bonds_2_atom2(B,) numpy.ndarray

Array of indices of the second particle for B total +two-particle bonds.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles.

+
+
dielectrics(N,) numpy.ndarray

Array of particle relative dielectric values for N particles.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to output HDF5 file.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
prepare_bonds

Constructs two-, three-, and four-particle bonds from toplogy input file and bond configuration information.

+
+
distribute_input

Distributes input arrays onto MPI ranks, attempting load balancing.

+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/doc_pages/benchmarks.html b/v1.0.7/doc_pages/benchmarks.html new file mode 100644 index 00000000..9fb9bb4f --- /dev/null +++ b/v1.0.7/doc_pages/benchmarks.html @@ -0,0 +1,302 @@ + + + + + + + 3. Benchmarks — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Benchmarks

+

Homopolymer melt test systems of \(30^2\), \(40^2\), and \(50^2\) +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively.

+
+

3.1. Bonded forces

+

Legend label denotes the number of particles in the system.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-1.png +
+
+
+

3.2. Particle–field forces

+

Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-2.png +
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/doc_pages/command_line.html b/v1.0.7/doc_pages/command_line.html new file mode 100644 index 00000000..8e8dfd64 --- /dev/null +++ b/v1.0.7/doc_pages/command_line.html @@ -0,0 +1,359 @@ + + + + + + + 5. Command line arguments — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. Command line arguments

+

Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle–field interactions.

+
+

5.1. Required arguments

+
+
configuration file:
+

type positional

+

Specifies the .toml format configuration file containing simulation details. See Configuration file for details.

+
+
structure and topology file:
+

type positional

+

Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See Topology and structure file for details.

+
+
+
+
+

5.2. Optional arguments

+
+
-v  --verbose

type optional

+

Number of following arguments: 0 or 1

+

Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying -v or --verbose with no additional specification. This increases verbosity level by 1. Alternatively, it maye be specified by --verbose V with V being 0, 1, or 2.

+
+
--profile

type optional

+

Number of following arguments: 0

+

Enables code profiling using cProfile. This will output one profiling file per MPI rank invoked in the simulation.

+
+
--double-precision

type optional

+

Number of following arguments: 0

+

Specify usage of double precision internally in HyMD (including in the FFTs).

+
+
--double-output

type optional

+

Number of following arguments: 0

+

Specify usage of double precision in the output trajectory from HyMD.

+
+
--velocity-output

type optional

+

Number of following arguments: 0

+

Specify that velocities should be output to the HyMD trajectory.

+
+
--force-output

type optional

+

Number of following arguments: 0

+

Specify that forces should be output to the HyMD trajectory.

+
+
--disable-mpio

type optional

+

Number of following arguments: 0

+

Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult.

+
+
--logfile

type optional

+

Number of following arguments: 1

+

Specifies the path of a plain text log file in which stdout is mirrored during simulation runs.

+
+
--seed

type optional

+

Number of following arguments: 1

+

Specifies the random seed used in the numpy random library to generate velocities, thermostatting, etc.

+
+
--disable-bonds

type optional

+

Number of following arguments: 0

+

Disable any two-particle bonds present in the system.

+
+
--disable-angle-bonds

type optional

+

Number of following arguments: 0

+

Disable any three-particle bonds present in the system.

+
+
--disable-dihedrals

type optional

+

Number of following arguments: 0

+

Disable any four-particle bonds present in the system.

+
+
--disable-dipole

type optional

+

Number of following arguments: 0

+

Disable any topological reconstruction of peptide backbone dipoles present in the system.

+
+
--disable-field

type optional

+

Number of following arguments: 0

+

Disable any particle–field interactions present in the system.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/doc_pages/config_file.html b/v1.0.7/doc_pages/config_file.html new file mode 100644 index 00000000..21ce4db8 --- /dev/null +++ b/v1.0.7/doc_pages/config_file.html @@ -0,0 +1,446 @@ + + + + + + + 3. Configuration file — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Configuration file

+

The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order.

+

The configuration file is a toml format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs.

+
+

3.1. Configuration file keywords

+

The following constitutes every possible keyword specification in HyMD +configuration files:

+
+

3.1.1. Metadata keywords

+

Configuration keywords specifying metadata for the H5MD output trajectory.

+
+
name:
+

string [optional, default: None]

+

Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file.

+
+
tags:
+

array [string] [optional, default: None]

+

Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file.

+
+
+
+
+

3.1.2. Particle keywords

+

Configuration keywords specifying properties of particles and molecules in the +system.

+
+
n_particles:
+

integer [optional, default: None]

+

Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules.

+
+
mass:
+

float [optional, default: 72.0] {units: \(\text{u}=\text{g}\,\text{mol}^{-1}\)}

+

Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal.

+
+
max_molecule_size:
+

integer [optional, default: 201]

+

Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code will crash if there are molecules larger than max_molecule_size in the topology/structure input file.

+
+
+
+
+

3.1.3. Simulation keywords

+

Configuration keywords specifying simulation parameters.

+
+
n_steps:
+

integer [required]

+

Total number of integration steps to perform for this simulation.

+
+
n_print:
+

integer or boolean [optional, default: False]

+

Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of number of time steps).

+
+
n_flush:
+

integer [optional, default: None]

+

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of number of n_print, i.e. n_print = 13, n_flush = 3 would result in the trajectory/energy being written to disk every 13 x 3 = 39 simulation steps)

+
+
time_step:
+

float [required] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time step per integration step. If the rRESPA multiple time step integrator is used (integrator = "respa"), this specifies the inner time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is respa_inner times the time_step , and the total simulation time is n_steps times time_step times respa_inner .

+
+
box_size:
+

array [float] [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable.

+
+
integrator:
+

string [required] (options: velocity-verlet or respa)

+

Specifies the time integrator used in the simulation. If respa, the reversible reference system propagator algorithm (rRESPA) [Tuckerman et al., 1992] integrator is used, with respa_inner number of inner (intramolecular force) time steps. If velocity-verlet, a normal Velocity Verlet integrator is used. If respa and respa_inner = 1, the rRESPA integrator is equivalent to the Velocity Verlet.

+
+
respa_inner:
+

integer [optional, default: 1]

+

The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces.

+
+
domain_decomposition:
+

integer or boolean [optional, default: False]

+

Specifies the interval (in time steps) of domain decomposition exchange, involving all MPI ranks sending and receiving particles according to the particles’ positions in the integration box and the MPI ranks’ assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If True, the decomposition is performed once (before starting the simulation). If False, no decomposition is performed.

+
+
cancel_com_momentum:
+

integer or boolean [optional, default: False]

+

If True, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every remove_com_momentum time steps. If False, the linear momentum is never removed.

+
+
start_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at start_temperature Kelvin prior to starting the simulation. If False, the velocities are not changed before starting the simulation.

+
+
target_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Couple the system to a heat bath at target_temperature Kelvin by applying a Canonical sampling through velocity rescaling [Bussi et al., 2007] thermostat with coupling strength tau. If False, no temperature control is applied.

+
+
tau:
+

float [optional, default: 0.7] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the CSVR thermostat coupling. In the limit of tau , the Hamiltonian dynamics are preserved and no temperature coupling takes place.

+
+
thermostat_coupling_groups:
+

array [array [string]] [optional, default: []]

+

Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing "A", "B", and "C" type particles, thermostat_coupling_groups = [["A", "B"], ["C"],] would thermalise types "A" and "B" together and couple "C" type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. target_temperature Kelvin).

+
+
hamiltonian:
+

string [optional, default: "DefaultNohChi"] (options: SquaredPhi, DefaultNohChi, or DefaultWithChi)

+

Specifies the interaction energy functional \(W[\tilde\phi]\) for use with the particle-field interactions. See Interaction energy functionals for details.

+
+
+
+
+

3.1.4. Field keywords

+

Configuration keywords specifying field parameters.

+
+
mesh_size:
+

array [integer] or integer [required]

+

Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is box_size / mesh_size.

+
+
kappa:
+

float [required] {units: \(\text{kJ}^{-1}\text{mol}\)}

+

Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional \(W[\tilde\phi]\). See Interaction energy functionals for more details.

+
+
sigma:
+

float [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See Filtering for more details.

+
+
chi:
+

array [array [string, float]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\)}

+

Array of \(\tilde\chi_\text{AB}\)-parameters indicating the strength of the repulsive or attractive interaction between particles of type "A" and the number density due to particles of type "B", and vice versa. Example: chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ] would specify a repulsive "A""B" type interaction, and a weakly attractive "C""D" interaction. Self-interaction \(\tilde\chi\)-terms are always zero. See Interaction energy functionals for more details.

+
+
+
+
+

3.1.5. Bond keywords

+

Configuration keywords specifying bonds and bonds parameters.

+
+
bonds:
+

array [array [2 string, 2 float]] [optional, default: []] {units: \(\text{nm}=10^{-9}~\text{m}\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+

Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ] indicates a "A""A" bond of equilibrium length 0.47 \(\text{nm}\) with a bond strength of 980.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding bond between "A" and "B" type particles with equilibrium length 0.31 \(\text{nm}\) and a strength of 1250.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify stretching bonds.

+
+
angle_bonds:
+

array [array [3 string, 2 float]] [optional, default: []] {units: \({}^\circ\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+
+

Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ] indicates a "A""A""A" angular bond that tries to keep the bond linear at 180 degrees with a bending strength of 55.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding angle bond between "A""B""B" prefering the angle at 120 degrees and a strength of 25.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify angular bonds.

+
+
+
dihedrals:
+

array [array [4 string, integer, COSINE SERIES ]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)}

+

Specifies four-particle torsional potentials by cosine series. See Intramolecular bonds for details about how to specify dihedrals.

+
+
+
+
+

3.1.6. Electrostatic keywords

+

Configuration keywords specifying electrostatics and electrostatic parameters.

+
+
coulombtype:
+

string [optional, default: None] (options: PIC_Spectral)

+

Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the dielectric_const keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, not in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to PIC_Spectral.

+
+
dielectric_const:
+

float [optional, default: None]

+

Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified—even if electrostatics are not included with the coulombtype keyword.

+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/doc_pages/constants_and_units.html b/v1.0.7/doc_pages/constants_and_units.html new file mode 100644 index 00000000..4945fe4a --- /dev/null +++ b/v1.0.7/doc_pages/constants_and_units.html @@ -0,0 +1,393 @@ + + + + + + + 6. Constants and Units — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

6. Constants and Units

+

HyMD uses the following units and constants internally and in all input and +output:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Units

Quantity

Symbol

Unit

length

\(r\)

\(\text{nm}=10^{-9}~\text{m}\)

time

\(t\)

\(\text{ps}=10^{-12}~\text{s}\)

charge

\(q\)

\(e=1.602176634 \cdot 10^{-19}~\text{C}\)

mass

\(m\)

\(\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}\)

temperature

\(\text{T}\)

\(\text{K}\)

energy

\(E\)

\(\text{kJ}\,\text{mol}^{-1}\)

velocity

\(v\)

\(\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}\)

momentum

\(P\)

\(\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}\)

force

\(\mathbf{F}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}\)

pressure

\(p\)

\(\text{bar}=100~\text{kPa}\)

electric potential

\(\Psi\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}\)

electric field

\(\mathbf{E}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}\)

compressibility

\(\kappa\)

\(\text{mol}\,\text{kJ}^{-1}\)

field-interaction

\(\tilde\chi\)

\(\text{kJ}\,\text{mol}^{-1}\)

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants

Constant

Symbol

Value

gas constant

\(R\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Boltzmann’s constant

\(k_\text{B}\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Avogadro’s constant

\(N_\text{A}\)

\(6.02214076 \cdot 10^23~\text{mol}^{-1}\)

Vacuum permittivity

\(\varepsilon_0\)

\(8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2\)

Coulomb constant

\(k_\text{e}\)

\(138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}\)

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/doc_pages/electrostatics.html b/v1.0.7/doc_pages/electrostatics.html new file mode 100644 index 00000000..a898f489 --- /dev/null +++ b/v1.0.7/doc_pages/electrostatics.html @@ -0,0 +1,314 @@ + + + + + + + 3. Electrostatic interactions — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Electrostatic interactions

+

In the filtered Hamiltonian hPF formalism [Bore and Cascella, 2020] the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle–mesh Ewald.

+

The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered

+
+\[\tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i),\]
+

with \(q_i\) being the charge of particle \(i\) and \(H\) is the +filtering function (see Filtering). The value of the charge grid at +vertex \((i,j,k)\) is found by

+
+\[\tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)]\]
+

and the electrostatic potential \(\Psi_{ijk}\)

+
+\[\Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right],\]
+

where \(k_\text{e}\) is the Coulomb constant \(1/4\pi\varepsilon_0\). +The electric field is obtained by differentiation of the electrostatic +potential in Fourier space,

+
+\[\mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)]\]
+

from which the forces are interpolated back to the particle positions.

+
+

3.1. Specifying electrostatics

+

In HyMD, electrostatics are specified by the coulombtype and +dielectric_const keywords in the configuration file (see +Configuration file) and the /charge dataset in the HDF5 format +structure/topology input file (see Topology and structure file). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/doc_pages/examples.html b/v1.0.7/doc_pages/examples.html new file mode 100644 index 00000000..42f68485 --- /dev/null +++ b/v1.0.7/doc_pages/examples.html @@ -0,0 +1,762 @@ + + + + + + + 1. Examples — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Examples

+

The following examples are ordered in more or less order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the HyMD-tutorial github repository.

+
+

1.1. Ideal gas

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true +

The simplest possible system is one with no interactions at all—intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like:

+
+
ideal_gas.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = false         # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+
+
+

A simple input structure/topology file ideal_gas.HDF5 is available in +the HyMD-tutorial/ideal_gas github repository (along with the code to +generate it). Run the (very) short simulation by

+
python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field   \
+                                              --velocity-output \
+                                              --force-output
+
+
+

with the --disable-field argument to completely turn off all +particle–field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook ideal_gas.ipynb for details.

+
+
+

1.2. Ideal chains

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true +

The simplest available interaction is the harmonic two-particle bond (see +Intramolecular bonds),

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2.\]
+

Extending the configuration file from the ideal gas case, we need to add a +bonds specification. Note that the [bonds] meta specifier is not +necessary, but may be used to help organise the input file.

+
+
ideal_chain.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+
+
+

A simple input structure/topology file ideal_chain.HDF5 with a few +coiled up ideal chain polymers is available in the +HyMD-tutorial/ideal_chain github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field
+
+
+

we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +ideal_chain.ipynb.

+
+
+

1.3. Stiff rods

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true +

Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the i--j--k angle \(\theta\) (see +Intramolecular bonds),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2.\]
+

Extending the configuration file from the ideal chain case, we need to add a +angle_bonds specification. Note that the [bonds] meta specifier +is not necessary, but may be used to help organise the input file.

+
+
rods.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+angle_bonds = [
+  ["A", "A", "A", 180.0, 100.0],   # (i, j, k, equilibrium angle, strength)
+]
+
+
+
+

A simple input structure/topology file rods.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook rods.ipynb.

+
+
+

1.4. Helixes

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true +

Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle \(\phi\) between the +i--j--k plane and the j--k--l plane (see Intramolecular bonds),

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n).\]
+

The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a dihedrals keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the dielectric_const +keyword even though we are not including electrostatic forces in the current +simulation. Note that the [bonds] meta specifier is not necessary, but +may be used to help organise the input file.

+
+
helixes.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+dielectric_const = 15.0
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.31, 10000.0],       # (i name, j name, equilibrium length, strength)
+]
+
+dihedrals = [
+  [
+    ["A", "A", "A", "A"],
+    [
+      [-1],
+      [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+      [0.08, 0.46, 1.65, -0.96, 0.38],
+    ],
+    [1.0]
+  ],
+]
+
+
+
+

A simple input structure/topology file helixes.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook helixes.ipynb.

+
+
+

1.5. Phase separation

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true +

The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types A and B. Using the Hamiltonian

+
+\[\mathcal{H}=H_0+W\]
+

with \(\tilde\chi\)–dependent interactions defined by (specified in the +configuration file by hamiltonian = DefaultWithChi):

+
+\[W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2.\]
+
+
phase_separation.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+
+[field]
+mesh_size = [20, 20, 20]           # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+kappa = 0.05                       # compressibility in mol/kJ
+chi = [
+  ['A', 'B', 5.0],                 # (name i, name j, strength)
+]
+
+
+
+

A simple input structure/topology file phase_separation.HDF5 containing +an equal number of A type and B type particles is available in +the HyMD-tutorial/phase_separation github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd phase_separation.toml phase_separation.HDF5
+
+
+

we may examine the resulting trajectory. In the case of a low interaction +strength \(\tilde\chi\) of 5.0 (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to 40.0 (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +phase_separation.ipynb.

+
+
+

1.6. Diblock copolymers

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true +

Having introduced particle–field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive \(\tilde\chi\)–interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the integrator = "respa" keyword. Putting the pieces together, the +configuration file may look like the following:

+
+
copolymer.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 15
+n_steps = 2000                     # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [10.0, 10.0, 10.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [50, 50, 50]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+chi = [
+  ["A", "B", 30.0],                # (i, j, strength)
+]
+
+[bonds]
+bonds = [
+  ["A", "A", 0.25, 1500.0],        # (i, j, equilibrium length, strength)
+  ["A", "B", 0.25, 1500.0],
+  ["B", "B", 0.25, 1500.0],
+]
+angle_bonds = [
+  ["A", "A", "A", 180.0, 25.0],    # (i, j, k, equilibrium angle, strength)
+  ["B", "B", "B", 180.0, 25.0],
+]
+
+
+
+

A simple input structure/topology file copolymer.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/copolymer github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten A followed by ten B type particles. +Running the simulation with

+
python3 -m hymd copolymer.toml copolymer.HDF5
+
+
+

the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +copolymer.ipynb.

+
+
+

1.7. Lipid bilayer self-assembly

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true +

Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field–particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the thermostat_coupling_groups keyword. With parameters +optimised in [Ledum et al., 2020], the configuration file looks like:

+
+
lipid_self_assembly.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 25
+n_steps = 3000
+n_print = 200
+n_flush = 1
+time_step = 0.01
+box_size = [9.96924, 9.96924, 10.03970]
+start_temperature = 323
+target_temperature = 323
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.05
+domain_decomposition = 10001
+cancel_com_momentum = true
+max_molecule_size = 15
+thermostat_coupling_groups = [
+  ["N", "P", "G", "C"],
+  ["W"],
+]
+
+[field]
+mesh_size = [25, 25, 25]
+sigma = 1.0
+chi = [
+  ["C", "W", 42.24],
+  ["G", "C", 10.47],
+  ["N", "W", -3.77],
+  ["G", "W", 4.53],
+  ["N", "P", -9.34],
+  ["P", "G", 8.04],
+  ["N", "G", 1.97],
+  ["P", "C", 14.72],
+  ["P", "W", -1.51],
+  ["N", "C", 13.56],
+]
+
+[bonds]
+bonds = [
+  ["N", "P", 0.47, 1250.0],
+  ["P", "G", 0.47, 1250.0],
+  ["G", "G", 0.37, 1250.0],
+  ["G", "C", 0.47, 1250.0],
+  ["C", "C", 0.47, 1250.0],
+]
+angle_bonds = [
+  ["P", "G", "G", 120.0, 25.0],
+  ["P", "G", "C", 180.0, 25.0],
+  ["G", "C", "C", 180.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

A randomly mixed input structure/topology file +lipid_self_assembly.HDF5 with a few hundred lipids in a roughy +10 x 10 x 10nm box is available in the +HyMD-tutorial/lipid_self_assembly github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation

+
python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5
+
+
+

we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook lipid_self_assembly.ipynb.

+
+
+

1.8. Peptide in lipid bilayer

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true +

Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer.

+

The configuration file is available in the HyMD-tutorial/peptide github +repository (omitted here for brevity).

+

A pre-equilibrated input structure/topology file peptide.HDF5 with a +few hundred lipids in a roughy 20 x 20 x 20nm box is available in the +HyMD-tutorial/peptide github repository. Running the simulation

+
python3 -m hymd peptide.toml peptide.HDF5
+
+
+

we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook peptide.ipynb.

+
+
+

1.9. SDS

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true +

The last part we introduce is explicit electrostatic interactions through +particle–mesh Ewald. Enabling the electrostatic calculations is done via the +coulombtype keyword. "PIC_Spectral" is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the dielectric_const keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge.

+
+
sds.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 10
+n_steps = 3000
+n_print = 1500
+n_flush =
+time_step = 0.01
+box_size = [8.3, 8.3, 8.3]
+start_temperature = 298
+target_temperature = 298
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.1
+domain_decomposition = 10000
+cancel_com_momentum = true
+max_molecule_size = 5
+thermostat_coupling_groups = [
+  ["S", "C"],
+  ["W", "Na"],
+]
+dielectric_const = 45.0              # dielectric constant for the simulation medium
+coulombtype = "PIC_Spectral"         # particle in cloud, spectral method
+
+[field]
+mesh_size = [64, 64, 64]
+sigma = 0.5
+chi = [
+  ["S", "C",  13.50],
+  ["S", "Na",  0.00],
+  ["S", "W",  -3.60],
+  ["C", "Na", 13.50],
+  ["C", "W",  33.75],
+  ["W", "Na",  0.00],
+]
+
+[bonds]
+bonds = [
+  ["S",   "C",   0.50, 1250.0],
+  ["C",   "C",   0.50, 1250.0],
+]
+angle_bonds = [
+  ["S", "C", "C", 170.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

An input structure/topology file sds.HDF5 with a couple thousand +randomly dispersed SDS chains is available in the HyMD-tutorial/sds github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a /charge dataset. +Running the simulation with

+
python3 -m hymd sds.toml sds.HDF5
+
+
+

we observe the aggregation of the SDS into micellular structures—first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook sds.ipynb.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/doc_pages/filtering.html b/v1.0.7/doc_pages/filtering.html new file mode 100644 index 00000000..e78cd319 --- /dev/null +++ b/v1.0.7/doc_pages/filtering.html @@ -0,0 +1,301 @@ + + + + + + + 2. Filtering — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Filtering

+

The default grid-independent filter function used in HyMD is a Gaussian

+
+\[H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right]\]
+

with reciprocal space representation

+
+\[\hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right].\]
+

The coarse-graining parameter \(\sigma\) determines a length scale of +particle extent and is given as configuration file input by

+
sigma = 0.75
+
+
+
+

2.1. Implementing new filters

+

Implementing new filter functions is straightforward by hijacking +the setup method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/doc_pages/installation.html b/v1.0.7/doc_pages/installation.html new file mode 100644 index 00000000..67be1e9f --- /dev/null +++ b/v1.0.7/doc_pages/installation.html @@ -0,0 +1,543 @@ + + + + + + + 1. Installation — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Installation

+
+

1.1. Dependencies

+
+

Note

+

HyMD requires Python ≥3.6. Python version 3.9 is most likely fine +to use, but HyMD is only regularly tested with Python3.8 at the moment.

+ +
+

Warning

+

MPI-enabled h5py may fail to build under Python3.10. In this case, a +fall-back to Python3.9 or lower may be necessary.

+ +

Installing non-Python dependencies may be done by

+
+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-openmpi-dev  # Install MPI-enabled HDF5
+sudo apt-get install -y pkg-config           # Install pkg-config, required for h5py install
+sudo apt-get install -y curl wget
+
+
+
+
+

Warning

+

There might be memory leaks when using HyMD with OpenMPI 4.1.1. +Therefore, using a newer version of OpenMPI is recommended. +See Issue #186 for more details.

+ +

Installing Python dependencies may be done by

+
+
python3 -m pip install --upgrade pip
+CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+python3 -m pip install mpi4py numpy cython
+
+
+
+
+

Warning

+

If MPI-enabled HDF5 and h5py can not be installed, limited support +for serial HDF5 is available. Note that having MPI-enabled file IO is +highly recommended, and simulation performance under serial HDF5 will +potentially be very low.

+

Example dependency install on Ubuntu (apt) using serial HDF5:

+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-serial-dev   # Install serial HDF5
+sudo apt-get install -y curl wget
+
+python3 -m pip install h5py mpi4py numpy cython
+
+
+

Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +--disable-mpio argument to HyMD, see Command line arguments. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial.

+ +
+
+

1.2. Installing HyMD

+

HyMD may be installed using pip by

+
python3 -m pip install hymd
+
+
+
+
+

1.3. Install in docker

+

A docker image with build essentials setup is available at dockerhub with tag +mortele/hymd,

+
docker pull mortele/hymd:latest
+docker run -it mortele/hymd
+/app$ python3 -m pip install hymd
+
+# Grab example input files
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5
+
+# Run simulation
+/app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose
+
+
+
+
+

1.4. Run interactively in Google Colaboratory

+

A Google Colaboratory jupyter notebook is setup here with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons.

+
+
+

1.5. Common issues

+
+

1.5.1. Numpy errors while importing the Fortran force kernels

+
RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd
+
+Traceback (most recent call last):
+
+  (...)
+
+File "/..../HyMD/hymd/__init__.py", line 2, in <module>
+  from .main import main  # noqa: F401
+File "/..../HyMD/hymd/main.py", line 10, in <module>
+  from .configure_runtime import configure_runtime
+File "/..../hymd/configure_runtime.py", line 12, in <module>
+  from .input_parser import read_config_toml, parse_config_toml
+File "/..../HyMD/hymd/input_parser.py", line 12, in <module>
+  from .force import Bond, Angle, Dihedral, Chi
+File "/..../HyMD/hymd/force.py", line 8, in <module>
+  from force_kernels import (  # noqa: F401
+ImportError: numpy.core.multiarray failed to import
+
+
+

can normally be fixed by updating numpy versions,

+
python3 -m pip install -U numpy
+
+
+
+
+

1.5.2. Error building pfft-python due to missing curl/wget

+
Building wheel for pfft-python (setup.py) ... error
+ERROR: Command errored out with exit status 1:
+command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_
+cwd: /tmp/pip-install-fr6nt9m4/pfft-python/
+Complete output (56 lines):
+running bdist_wheel
+running build
+running build_py
+
+  (...)
+
+curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found
+wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found
+Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+Please check curl or wget
+You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/
+Traceback (most recent call last):
+  File "<string>", line 1, in <module>
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in <module>
+    setup(
+  File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup
+    return distutils.core.setup(**attrs)
+  File "/usr/lib/python3.8/distutils/core.py", line 148, in setup
+
+  (...)
+
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions
+    build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:]))
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft
+    raise ValueError("could not build fftw; check MPICC?")
+ValueError: could not build fftw; check MPICC?
+----------------------------------------
+ERROR: Failed building wheel for pfft-python
+Running setup.py clean for pfft-python
+Failed to build pfft-python
+
+
+

can be fixed by installing either curl or wget

+
apt-get install -y curl wget
+
+
+
+
+

1.5.3. Error running parallel HyMD without MPI-enabled h5py

+
Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    main()
+  File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    raise ValueError("h5py was built without MPI support, can't use mpio driver")
+ValueError: h5py was built without MPI support, can't use mpio driver
+
+
+

Can be fixed by installing a MPI-enabled h5py through

+
python3 -m pip uninstall -y h5py
+HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/doc_pages/interaction_energy_functionals.html b/v1.0.7/doc_pages/interaction_energy_functionals.html new file mode 100644 index 00000000..7c75423e --- /dev/null +++ b/v1.0.7/doc_pages/interaction_energy_functionals.html @@ -0,0 +1,354 @@ + + + + + + + 1. Interaction energy functionals — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Interaction energy functionals

+

A few interaction energy functionals \(W\) are defined in HyMD through +the Hamiltonian class and associated subclasses.

+
+

1.1. \(\chi\)–interaction and \(\kappa\)–incompressibility

+

The most common hPF energy functional is specified by

+
hamiltonian = "DefaultWithChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where \(\tilde\chi_{\text{A}-\text{B}}\) is the interaction energy between +overlapping densities of particle types \(\text{A}\) and \(\text{B}\). +The incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\tilde\chi\) +and \(\kappa\) in the configuration file (see Configuration file)

+
kappa = 0.05
+chi = [
+   ["A", "B", 15.85],
+   ["B", "C", -5.70],
+   ...
+]
+
+
+
+
+

1.2. Only \(\kappa\)–incompressibility

+

The only \(\kappa\) interactions energy functional is specified by

+
hamiltonian = "DefaultNoChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where the incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.3. Only \(\phi^2\)

+

The \(\phi^2\) interactions energy functional is specified by

+
hamiltonian = "SquaredPhi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2,\]
+

where the \(\phi\) squared term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.4. Implementing new interaction energy forms

+

Implementing new interaction energy functions is straightforward by subclassing +Hamiltonian and applying sympy differentiation to the symbolic +field objects. The sympy.lamdify function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/doc_pages/intramolecular_bonds.html b/v1.0.7/doc_pages/intramolecular_bonds.html new file mode 100644 index 00000000..0b7f566f --- /dev/null +++ b/v1.0.7/doc_pages/intramolecular_bonds.html @@ -0,0 +1,394 @@ + + + + + + + 2. Intramolecular bonds — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Intramolecular bonds

+

Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see Configuration file. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +Benchmarks), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable.

+

All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]).

+
+

2.1. Two-particle bonds

+

Stretching bonds in HyMD are implemented as harmonic spring potentials,

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2,\]
+

where \(r=|\mathbf{r}|\) is the inter-particle distance, \(k\) is a +constant of dimension energy (units \(\text{kJ}\,\text{mol}^{-1}\)), and +\(r_0\) is the equilibrum length of the bond (units: \(\text{nm}\)). The +force is calculated as

+
+\[F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r},\]
+

where \(\mathbf{r}\) is the vector pointing from \(i\) to \(j\).

+

In the configuration file, two-particle bonds are specified per particle type:

+
+
configuration_two_particle_example.toml
+
[bonds]
+bonds = [
+   ["A", "A", 0.47, 1250.0],
+   ["A", "B", 0.37,  940.0],
+   ["B", "C", 0.50, 1010.0],
+   ["C", "A", 0.42,  550.0],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.2. Three-particle bonds

+

Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle–particle–particle angle \(\theta\),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2,\]
+

where \(k\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\)), and \(\theta_0\) is the equilibrum +angle of the bond (units: \({}^\circ\)). Defining the particles with labels +\(a\), \(b\), and \(c\), let \(\mathbf{r}_a\) denote the vector +pointing from \(b\) to \(a\), and correspondingly let +\(\mathbf{r}_c\) point from \(b\) to \(c\). The +\(a\)\(b\)\(c\) may be computed through the law of Cosines,

+
+\[\theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right]\]
+

Then the force acting on \(a\) and \(c\) is

+
+\[ \begin{align}\begin{aligned}\mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a},\\\mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c},\end{aligned}\end{align} \]
+

and

+
+\[\mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c\]
+

In the configuration file, three-particle bonds are specified per particle type:

+
+
configuration_three_particle_example.toml
+
[bonds]
+angle_bonds = [
+   ["A", "A", "A", 180.0, 90.0],
+   ["A", "B", "A", 120.0, 55.0],
+   ["B", "C", "C",  30.0, 10.0],
+   ["C", "A", "B", 110.0, 25.5],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.3. Four-particle bonds

+

Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle \(\phi\) between the +\(a\)\(b\)\(c\) and \(b\)\(c\)\(d\) planes, for +a dihedral bond quartet \(a\), \(b\), \(c\), and \(d\). The +potential takes the form

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n),\]
+

where \(c_n\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)), and \(\phi_n\) are +specified phase angles in the cosine series.

+

In the configuration file, four-particle bonds are specified per particle type:

+
+
configuration_four_particle_example.toml
+
[bonds]
+dihedrals = [
+   ["A", "B", "C", "D"],
+   [
+     [-1],
+     [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+     [0.08, 0.46, 1.65, -0.96, 0.38],
+   ],
+   [1.0],
+]
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/doc_pages/overview.html b/v1.0.7/doc_pages/overview.html new file mode 100644 index 00000000..5296b788 --- /dev/null +++ b/v1.0.7/doc_pages/overview.html @@ -0,0 +1,415 @@ + + + + + + + 2. Usage overview for HylleraasMD — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Usage overview for HylleraasMD

+

HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a toml format configuration file, along with a topology and structure +file specifying the input system in HDF5 format.

+

Configuration file

+

The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a [5, 5, 5] nm simulation box at 300 K may look like +the following:

+
+
config_simple_1.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "SquaredPhi"         # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [30, 30, 30]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+
+
+
+

Note that for the version 1.0 release of HyMD, the [particles], +[simulation], and [field] groups are optional specifiers for +structuring the configuration file.

+

For a full specification of every recognised configuration keyword in HyMD, +please refer to Configuration file.

+

Topology and structure file

+

The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +N particles may look like the following:

+
+
example_structure.HDF5
+
group   /
+   # root group
+
+dataset /coordinates
+   # float32, shape (T, N, D,)
+   # Time steps of N rows of D dimensional coordinate data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /velocities
+   # float32, shape (T, N, D,) OPTIONAL
+   # Time steps of N rows of D dimensional velocity data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /bonds
+   # int32,   shape (N, B,)    OPTIONAL
+   # Each row i contains indices of the particles bonds from/to i
+   # B denotes the maximum bonds per particle
+
+dataset /indices
+   # int32,   shape (N,)
+   # Index of each particle, 0--(N-1)
+
+dataset /molecules
+   # int32,   shape (N,)
+   # Index of molecule each particle belongs to
+   # Used to construct bond network locally on MPI ranks
+
+dataset /names
+   # str10,   shape (N,)
+   # Fixed size string array containing particle type names
+
+dataset /types
+   # int32,   shape (N,)       OPTIONAL
+   # Mapping of particle names to type indices
+
+
+
+

For a full specification of the topology and structure input file, see +Topology and structure file.

+

Command line arguments

+

A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the config_simple_1.toml and example_structure.HDF5 +files may look like the following:

+
mpirun -n ${MPI_NUM_RANKS} python3 -m hymd         \  # HyMD executable
+                           config_simple_1.toml    \  # configuration file
+                           example_structure.HDF5  \  # structure file
+                           --logfile=log_out.txt   \  # set logfile path
+                           --seed 123456           \  # set random seed
+                           --verbose 2             \  # set logging verbosity
+                           --velocity-output          # enable velocity in trajectory output
+
+
+

For a full specification of all command line arguments, see +Command line arguments.

+

More examples

+

For more thorough rundown and concrete usage examples, see +Examples.

+
+

2.1. Running parallel simulations

+

Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the only difference being how the python3 interpreter is +invoked. Prepending mpirun -n ${NPROCS} to the usual +python3 -m hymd runs the simulation with ${NPROCS} MPI ranks.

+

Inputting

+
mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field
+
+
+

sets up an example simulation of the HyMD-tutorial/ideal_gas system. For +more details about this system in particular, or other example simulations, see +the HyMD-tutorial repository.

+
+
+

2.2. Running tests

+

Run serial code tests by

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd
+cd hymd/
+python3 -m pip install pytest pytest-mpi
+python3 -m pytest
+
+
+

There is a small convenience script in hymd/ for running the MPI-enabled +tests,

+
chmod +x pytest-mpi
+./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/doc_pages/theory.html b/v1.0.7/doc_pages/theory.html new file mode 100644 index 00000000..e4c02f57 --- /dev/null +++ b/v1.0.7/doc_pages/theory.html @@ -0,0 +1,357 @@ + + + + + + + 1. Theory — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Theory

+

Hybrid particle–field simulations switch out the ordinary particle–particle +Lennard-Jones interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle–field densities are +defined as

+
+\[\phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i),\]
+

where \(\mathbf{r}\) is a spatial coordinate, \(P\) is a window function +used to distribute particle number densities onto a computational grid, and +\(\mathbf{r}_i\) is the position of particle \(i\) (of total \(N\)). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of \(N\) particles in \(M\) molecules is

+
+\[\mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})]\]
+

with \(H_0\) being a standard intramolecular Hamiltonian form (see +Intramolecular bonds) including kinetic terms, while \(W\) is a density +dependent interaction energy functional.

+

In the Hamiltonian hPF-MD formalism [Bore and Cascella, 2020], the density +field is filtered using a grid-independent filtering function \(H\),

+
+\[\tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}).\]
+

The filter smooths the density, ensuring that \(\tilde\phi\) and +\(W[\tilde\phi([\phi])]\) both converge as the grid size is reduced.

+
+

1.1. External potential

+

The external potential acting on a particle is defined as the functional +derivative of \(W\) with respect to \(\phi\). In the filtered formalism, +the potential takes the form

+
+\[\begin{split}V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ +&= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})},\end{split}\]
+

under the assumption of a local form of the interaction energy functional, +\(W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]\). Note +that

+
+\[\frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}).\]
+
+
+

1.2. Force interpolation

+

The forces on particle \(i\) are obtained by differentiation of the external +potential,

+
+\[\mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i).\]
+
+
+

1.3. Reciprocal space calculations

+

The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density \(\phi_{ijk}\) with CIC, we apply the filtering +and obtain the discrete version of the external potential by

+
+\[\tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big]\]
+

and

+
+\[V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+

The forces are obtained by differentiation of \(V\) in Fourier space as

+
+\[\nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+
+
+

1.4. Filter

+

By default, the filter used in HyMD is a simple Gaussian of the form

+
+\[\begin{split}H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ +\hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right].\end{split}\]
+

For more details about the filtering, see Filtering.

+
+
+

1.5. Hamiltonian form

+

The default form of the interaction energy functional in HyMD is

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2.\]
+

See Interaction energy functionals for details.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/doc_pages/topology_input.html b/v1.0.7/doc_pages/topology_input.html new file mode 100644 index 00000000..1da4b57b --- /dev/null +++ b/v1.0.7/doc_pages/topology_input.html @@ -0,0 +1,338 @@ + + + + + + + 4. Topology and structure file — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Topology and structure file

+

The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root / group.

+

The HyMD-tutorial has multiple examples of structure files for various levels +of complexity.

+
+

4.1. Required datasets

+
+
/coordinates:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/indices:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/names:
+

array shape [N,]

+

datatype [string (length between 1 and 16)]

+

The shape represents one particle name per N particles. The datatype may be a string of length =<16.

+
+
+
+
+

4.2. Optional datasets

+
+
/velocities:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/types:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle type index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/molecules:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one molecule index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/bonds:
+

array shape [N, B,]

+

datatype [int32 or int64]

+

The shape represents B bond specifications (indices of different particles) per N particles. The data type may be either 32 or 64 bit integers.

+
+
/charge:
+

array shape [N,]

+

datatype [float32 or float64]

+

The shape represents one particle charge per N particles. The data type may be either four or eight byte reals.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/genindex.html b/v1.0.7/genindex.html new file mode 100644 index 00000000..8e9aaac4 --- /dev/null +++ b/v1.0.7/genindex.html @@ -0,0 +1,816 @@ + + + + + + Index — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + +
+ +

F

+ + + +
+ +

G

+ + +
+ +

H

+ + + +
    +
  • + hymd.input_parser + +
  • +
  • + hymd.integrator + +
  • +
  • + hymd.thermostat + +
  • +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/index.html b/v1.0.7/index.html new file mode 100644 index 00000000..4eaaa5eb --- /dev/null +++ b/v1.0.7/index.html @@ -0,0 +1,402 @@ + + + + + + + HylleraasMD documentation — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

HylleraasMD documentation

+
+
Release:
+

1.0.7

+
+
Date:
+

Aug 23, 2022

+
+
+

HylleraasMD (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems.

+

HyMD can run canonical hPF-MD simulations [Milano and Kawakatsu, 2009], or filtered +density Hamiltonian hPF (HhPF-MD) simulations [Bore and Cascella, 2020], with +or without explicit PME electrostatic interactions [Kolli et al., 2018]. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +[Bore et al., 2018, Cascella et al., 2008]. Martini +style elastic networks (ElNeDyn) [Periole et al., 2009] are also +supported.

+

HyMD uses the pmesh (github.com/rainwoodman/pmesh) library for particle-mesh +operations, with the PPFT [Pippig, 2013] backend for FFTs through the +pfft-python bindings (github.com/rainwoodman/pfft-python). File IO is done +via HDF5 formats to allow MPI parallel reads.

+
+

User Guide

+

The HylleraasMD User Guide provides comprehensive information on how to run +simulations. Selected Examples are available to guide new users.

+
+
+

Installing HyMD

+

The easiest approach is to install using pip:

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+

For more information and required dependencies, see +Installation.

+
+

Run in Google colab

+

Run HyMD interactively in Google Colaboratory jupyter notebook here.

+
+
+
+

Source Code

+

Source code is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the GNU Lesser General Public +License v3.0. Obtain the source code with git:

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git
+
+
+
+
+

Development

+

HyMD is developed and maintained by researchers at the Hylleraas Centre for +Quantum Molecular Sciences at the University of Oslo.

+

pic1 pic2

+
+
+

References

+
+
+[BC20] +

Sigbjørn Løland Bore and Michele Cascella. Hamiltonian and alias-free hybrid particle–field molecular dynamics. J. Chem. Phys., 153(9):094106, 2020. doi:10.1063/5.0020733.

+
+
+[BMC18] +

Sigbjørn Løland Bore, Giuseppe Milano, and Michele Cascella. Hybrid particle-field model for conformational dynamics of peptide chains. J. Chem. Theory Comput., 14(2):1120–1130, 2018. doi:10.1021/acs.jctc.7b01160.

+
+
+[BDP07] +

Giovanni Bussi, Davide Donadio, and Michele Parrinello. Canonical sampling through velocity rescaling. J. Chem. Phys., 126(1):014101, 2007. doi:10.1063/1.2408420.

+
+
+[CNCDP08] +

Michele Cascella, Marilisa A. Neri, Paolo Carloni, and Matteo Dal Peraro. Topologically based multipolar reconstruction of electrostatic interactions in multiscale simulations of proteins. J. Chem. Theory Comput., 4(8):1378–1385, 2008. doi:10.1021/ct800122x.

+
+
+[KDNB+18] +

Hima Bindu Kolli, Antonio De Nicola, Sigbjørn Løland Bore, Ken Schäfer, Gregor Diezemann, Jürgen Gauss, Toshihiro Kawakatsu, Zhong-Yuan Lu, You-Liang Zhu, Giuseppe Milano, and Michele Cascella. Hybrid particle-field molecular dynamics simulations of charged amphiphiles in an aqueous environment. J. Chem. Theory Comput., 14(9):4928–4937, 2018. doi:10.26434/chemrxiv.6264644.v1.

+
+
+[LBC20] +

Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Automated determination of hybrid particle-field parameters by machine learning. Mol. Phys., 118(19-20):e1785571, 2020. doi:10.1080/00268976.2020.1785571.

+
+
+[MK09] +

Giuseppe Milano and Toshihiro Kawakatsu. Hybrid particle-field molecular dynamics simulations for dense polymer systems. J. Chem. Phys., 130(21):214106, 2009. doi:10.1063/1.3142103.

+
+
+[PCMC09] +

Xavier Periole, Marco Cavalli, Siewert-Jan Marrink, and Marco A Ceruso. Combining an elastic network with a coarse-grained molecular force field: structure, dynamics, and intermolecular recognition. Journal of chemical theory and computation, 5(9):2531–2543, 2009. doi:10.1021/ct9002114.

+
+
+[Pip13] +

Michael Pippig. Pfft: an extension of fftw to massively parallel architectures. SIAM J. Sci. Comput., 35(3):C213–C236, 2013. doi:10.1137/120885887.

+
+
+[TBM92] +

MBBJM Tuckerman, Bruce J Berne, and Glenn J Martyna. Reversible multiple time scale molecular dynamics. J. Chem. Phys., 97(3):1990–2001, 1992. doi:10.1063/1.463137.

+
+
+
+
+
+

Indices and tables

+ +
+
+
+
+
+
+
+
+
+ + + +
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+ + + + + +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/objects.inv b/v1.0.7/objects.inv new file mode 100644 index 00000000..26dee56d Binary files /dev/null and b/v1.0.7/objects.inv differ diff --git a/v1.0.7/py-modindex.html b/v1.0.7/py-modindex.html new file mode 100644 index 00000000..f71bbfff --- /dev/null +++ b/v1.0.7/py-modindex.html @@ -0,0 +1,324 @@ + + + + + + Python Module Index — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ h +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ h
+ hymd +
    + hymd.field +
    + hymd.file_io +
    + hymd.force +
    + hymd.input_parser +
    + hymd.integrator +
    + hymd.thermostat +
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.7/search.html b/v1.0.7/search.html new file mode 100644 index 00000000..f095baa7 --- /dev/null +++ b/v1.0.7/search.html @@ -0,0 +1,294 @@ + + + + + + Search — hymd 1.0.7 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.7 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v1.0.7/searchindex.js b/v1.0.7/searchindex.js new file mode 100644 index 00000000..75200ff3 --- /dev/null +++ b/v1.0.7/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["doc_pages/api","doc_pages/benchmarks","doc_pages/command_line","doc_pages/config_file","doc_pages/constants_and_units","doc_pages/electrostatics","doc_pages/examples","doc_pages/filtering","doc_pages/installation","doc_pages/interaction_energy_functionals","doc_pages/intramolecular_bonds","doc_pages/overview","doc_pages/theory","doc_pages/topology_input","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,"sphinxcontrib.bibtex":9,sphinx:56},filenames:["doc_pages/api.rst","doc_pages/benchmarks.rst","doc_pages/command_line.rst","doc_pages/config_file.rst","doc_pages/constants_and_units.rst","doc_pages/electrostatics.rst","doc_pages/examples.rst","doc_pages/filtering.rst","doc_pages/installation.rst","doc_pages/interaction_energy_functionals.rst","doc_pages/intramolecular_bonds.rst","doc_pages/overview.rst","doc_pages/theory.rst","doc_pages/topology_input.rst","index.rst"],objects:{"hymd.field":{compute_field_and_kinetic_energy:[0,1,1,""],compute_field_energy_q_GPE:[0,1,1,""],compute_field_force:[0,1,1,""],compute_self_energy_q:[0,1,1,""],domain_decomposition:[0,1,1,""],initialize_pm:[0,1,1,""],update_field:[0,1,1,""],update_field_force_q:[0,1,1,""],update_field_force_q_GPE:[0,1,1,""]},"hymd.file_io":{OutDataset:[0,2,1,""],distribute_input:[0,1,1,""],setup_time_dependent_element:[0,1,1,""],store_data:[0,1,1,""],store_static:[0,1,1,""]},"hymd.file_io.OutDataset":{close_file:[0,3,1,""],flush:[0,3,1,""],is_open:[0,3,1,""]},"hymd.force":{Angle:[0,2,1,""],Bond:[0,2,1,""],Chi:[0,2,1,""],Dielectric_type:[0,2,1,""],Dihedral:[0,2,1,""],compute_angle_forces__plain:[0,1,1,""],compute_bond_forces__plain:[0,1,1,""],compute_dihedral_forces__plain:[0,1,1,""],dipole_forces_redistribution:[0,1,1,""],find_all_paths:[0,1,1,""],prepare_bonds:[0,1,1,""],prepare_bonds_old:[0,1,1,""],prepare_index_based_bonds:[0,1,1,""],propensity_potential_coeffs:[0,1,1,""]},"hymd.force.Angle":{atom_3:[0,4,1,""]},"hymd.force.Bond":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],equilibrium:[0,4,1,""],strength:[0,4,1,""]},"hymd.force.Chi":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],interaction_energy:[0,4,1,""]},"hymd.force.Dielectric_type":{atom_1:[0,4,1,""],dielectric_value:[0,4,1,""]},"hymd.force.Dihedral":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],atom_3:[0,4,1,""],atom_4:[0,4,1,""],coeffs:[0,4,1,""],dih_type:[0,4,1,""]},"hymd.hamiltonian":{DefaultNoChi:[0,2,1,""],DefaultWithChi:[0,2,1,""],Hamiltonian:[0,2,1,""],SquaredPhi:[0,2,1,""]},"hymd.hamiltonian.DefaultNoChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.DefaultWithChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.Hamiltonian":{__init__:[0,3,1,""],_setup:[0,3,1,""]},"hymd.hamiltonian.SquaredPhi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.input_parser":{Config:[0,2,1,""],check_NPT_conditions:[0,1,1,""],check_angles:[0,1,1,""],check_bonds:[0,1,1,""],check_box_size:[0,1,1,""],check_cancel_com_momentum:[0,1,1,""],check_charges:[0,1,1,""],check_charges_types_list:[0,1,1,""],check_chi:[0,1,1,""],check_config:[0,1,1,""],check_dielectric:[0,1,1,""],check_dihedrals:[0,1,1,""],check_domain_decomposition:[0,1,1,""],check_hamiltonian:[0,1,1,""],check_integrator:[0,1,1,""],check_m:[0,1,1,""],check_mass:[0,1,1,""],check_max_molecule_size:[0,1,1,""],check_n_b:[0,1,1,""],check_n_flush:[0,1,1,""],check_n_particles:[0,1,1,""],check_n_print:[0,1,1,""],check_name:[0,1,1,""],check_start_and_target_temperature:[0,1,1,""],check_tau:[0,1,1,""],check_thermostat_coupling_groups:[0,1,1,""],parse_config_toml:[0,1,1,""],read_config_toml:[0,1,1,""],sort_dielectric_by_type_id:[0,1,1,""]},"hymd.input_parser.Config":{a:[0,4,1,""],angle_bonds:[0,4,1,""],barostat:[0,4,1,""],barostat_type:[0,4,1,""],bonds:[0,4,1,""],box_size:[0,4,1,""],cancel_com_momentum:[0,4,1,""],chi:[0,4,1,""],conv_crit:[0,4,1,""],convergence_type:[0,4,1,""],coulomb_constant:[0,4,1,""],coulombtype:[0,4,1,""],dielectric_const:[0,4,1,""],dielectric_type:[0,4,1,""],dihedrals:[0,4,1,""],domain_decomposition:[0,4,1,""],dtype:[0,4,1,""],file_name:[0,4,1,""],gas_constant:[0,4,1,""],hamiltonian:[0,4,1,""],initial_energy:[0,4,1,""],integrator:[0,4,1,""],kappa:[0,4,1,""],m:[0,4,1,""],mass:[0,4,1,""],max_molecule_size:[0,4,1,""],mesh_size:[0,4,1,""],n_b:[0,4,1,""],n_flush:[0,4,1,""],n_particles:[0,4,1,""],n_print:[0,4,1,""],n_steps:[0,4,1,""],name:[0,4,1,""],pol_mixing:[0,4,1,""],pressure:[0,4,1,""],respa_inner:[0,4,1,""],rho0:[0,4,1,""],self_energy:[0,4,1,""],sigma:[0,4,1,""],start_temperature:[0,4,1,""],tags:[0,4,1,""],target_pressure:[0,4,1,""],target_temperature:[0,4,1,""],tau:[0,4,1,""],tau_p:[0,4,1,""],thermostat_coupling_groups:[0,4,1,""],thermostat_work:[0,4,1,""],time_step:[0,4,1,""],type_charges:[0,4,1,""]},"hymd.integrator":{integrate_position:[0,1,1,""],integrate_velocity:[0,1,1,""]},"hymd.logger":{Logger:[0,2,1,""],MPIFilterAll:[0,2,1,""],MPIFilterRoot:[0,2,1,""]},"hymd.logger.Logger":{setup:[0,3,1,""]},"hymd.logger.MPIFilterAll":{filter:[0,3,1,""]},"hymd.logger.MPIFilterRoot":{filter:[0,3,1,""]},"hymd.thermostat":{_random_chi_squared:[0,1,1,""],_random_gaussian:[0,1,1,""],csvr_thermostat:[0,1,1,""]},hymd:{field:[0,0,0,"-"],file_io:[0,0,0,"-"],force:[0,0,0,"-"],input_parser:[0,0,0,"-"],integrator:[0,0,0,"-"],thermostat:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0020733":14,"00268976":14,"0083144621":0,"01036426965":4,"014101":[0,14],"02214076":4,"03642696562":4,"03970":6,"08790868":[6,10],"094106":14,"0xd":8,"0xe":8,"100":[4,6,11],"1000":6,"10000":6,"10001":6,"1010":10,"1021":14,"1063":14,"1080":14,"10nm":6,"110":10,"1120":[0,14],"1130":[0,14],"1137":14,"118":14,"120":[3,6,10],"120885887":14,"120ff":0,"123456":11,"1250":[3,6,10],"126":[0,14],"130":14,"1378":14,"138":[0,4],"1385":14,"144":8,"148":8,"1500":6,"153":14,"166":8,"170":6,"1785571":14,"179":0,"180":[3,6,10],"186":8,"197":8,"1974":0,"1981":0,"1990":14,"1992":[3,14],"200":[6,10],"2000":6,"2001":14,"2007":[0,3,14],"2008":[0,14],"2009":14,"201":[0,3],"2013":14,"2018":[0,14],"2020":[5,6,12,14],"2022":14,"20nm":6,"214106":14,"223":0,"224":1,"2408420":14,"2408724":[6,10],"246":0,"251":[6,10],"2531":14,"2543":14,"26434":14,"28103735":0,"298":6,"2_1":0,"2don2d":8,"2nd":0,"300":[6,11],"3000":6,"3142103":14,"3144621":4,"323":6,"449":[6,10],"463137":14,"48626121":[6,10],"4928":14,"4937":14,"502":8,"533":1,"544":[6,10],"550":10,"59427866":[6,10],"602176634":4,"610":[6,10],"6264644":14,"66053906660":4,"7b01160":14,"85418781281":4,"935458":[0,4],"940":10,"96924":6,"980":3,"9918564":[6,10],"boolean":3,"byte":13,"case":[0,3,6,8,10],"class":[0,9],"default":[0,3,7,11,12,13],"export":8,"float":[0,3],"function":[0,3,5,6,7,11,12],"int":[0,5,6,9,12],"long":[5,6],"new":[0,10,13,14],"public":14,"return":[0,8],"short":[6,11],"sigbj\u00e3":14,"static":0,"switch":12,"true":[0,3,6],"while":[0,12],Adding:6,For:[0,11,12,14],The:[0,3,5,6,7,8,9,10,11,12,13,14],Then:10,There:[8,11],These:0,Used:[0,3,11],Using:[6,9],With:[0,6],__file__:8,__init__:[0,8],__main__:8,_gener:0,_hl:8,_kwarg:8,_random_chi_squar:0,_random_gaussian:0,_run_cod:8,_run_module_as_main:8,_set_fapl_mpio:8,_setup:0,about:[3,11,12],abov:[0,6],absent:0,acceler:0,accompani:6,accord:[0,3],accur:14,acid:6,across:[0,3],acs:14,act:[0,10,12],adapt:0,add:[5,6],added:0,adding:6,addison:0,addit:[0,2,5,11],addition:14,additon:0,adher:0,affect:0,affili:[0,2],after:[0,10,12],against:8,aggreg:6,ahren:0,alanin:6,algorithm:[0,3,12],alia:14,all:[0,2,3,4,6,8,10,11,14],all_nam:0,all_rank:0,alloc:0,allow:[11,14],allreduc:0,along:[6,11],alpha3:8,alpha:0,also:[6,8,14],altern:2,alwai:[0,3],amino:6,amphiphil:14,analyt:0,angl:[0,2,3,6,8,10],angle_bond:[0,3,6,10],angular:[0,3,6,10],ani:[0,2,3],anisotrop:0,antonio:14,apart:0,api:8,app:8,appli:[0,3,7,9,12],applic:0,approach:14,approxim:0,apt:8,aqueou:14,architectur:14,arg:[0,8],argument:[0,6,8,11],argv:8,aris:0,around:10,arrai:[0,3,11,13],arriv:6,art:0,aspect:3,assess:0,assign:[0,3,10],associ:[0,9],assum:3,assumpt:12,atom:0,atom_1:0,atom_2:0,atom_3:0,atom_4:0,attach:13,attempt:0,attr:8,attract:3,attribut:0,aug:14,autom:14,automat:[0,7,8,9],avail:[6,8,14],averag:[0,9],avogadro:4,back:[0,5,8],backbon:[0,2,3,14],backcon:0,backend:14,backmap:0,balanc:0,ballist:6,bar:4,barostat:0,barostat_typ:0,base:[0,14],bath:[0,3],bb_index:0,bc20:14,bdist_wheel:8,bdp07:14,bead:0,becaus:0,becom:0,befor:[0,3,6,8],being:[0,2,3,5,10,11,12],belong:11,below:6,benchmark:10,bend:[0,3,10,14],bern:14,besid:2,best:0,beta:0,better:0,between:[0,3,5,6,9,10,12,13],bia:0,big:12,bin:8,binari:8,bind:14,bindu:14,bio:14,bit:[0,13],blueprint:0,bmc18:14,boltzmann:[0,3,4],bond2_energi:0,bond3_energi:0,bond4_energi:0,bond:[0,2,6,8,11,12,13],bonds_2:0,bonds_2_atom1:0,bonds_2_atom2:0,bonds_2_atom_1:0,bonds_2_atom_2:0,bonds_2_equilibrium:0,bonds_2_strength:0,bonds_3:0,bonds_3_atom_1:0,bonds_3_atom_2:0,bonds_3_atom_3:0,bonds_3_equilibrium:0,bonds_3_strength:0,bonds_4:0,bonds_4_atom_1:0,bonds_4_atom_2:0,bonds_4_atom_3:0,bonds_4_atom_4:0,bonds_4_coeff:0,bonds_4_last:0,bonds_4_typ:0,bool:0,bootstrap:8,bore:[0,5,12,14],both:[0,12],boundari:[0,3],box:[0,3,6,11],box_siz:[0,3,6,11],breviti:6,brew:8,broadcast:0,browser:8,bruce:14,buffer:[0,3],build_extens:8,build_pfft:8,build_pi:8,built:8,bussi:[0,3,14],c213:14,c236:14,c_n:[0,6,10],calcul:[0,3,6,10],calibr:0,call:[0,8],callabl:0,can:[6,8,14],cancel_com_momentum:[0,3,6],canon:[0,3,14],capabl:2,captur:11,carloni:14,carri:6,cascella:[5,8,11,12,14],caval:14,cbt:0,cdot10:4,cdot:[0,4,10],cell:[0,12],cellar:8,center:[0,3],centr:14,certain:[0,2],ceruso:14,chain:[0,14],chang:[0,3],changedin:0,charg:[0,3,4,5,6,13,14],charge_out:0,check:[0,8],check_angl:0,check_bond:0,check_box_s:0,check_cancel_com_momentum:0,check_charg:0,check_charges_types_list:0,check_chi:0,check_config:0,check_dielectr:0,check_dihedr:0,check_domain_decomposit:0,check_hamiltonian:0,check_integr:0,check_m:0,check_mass:0,check_max_molecule_s:0,check_n_b:0,check_n_flush:0,check_n_particl:0,check_n_print:0,check_nam:0,check_npt_condit:0,check_start_and_target_temperatur:0,check_tau:0,check_thermostat_coupling_group:0,chem:[0,14],chemic:14,chemrxiv:14,chi:[0,3,4,6,8],chi_2:0,chi_3:0,chi_:[0,3,6,9,12],chi_m:0,chmod:11,chosen:0,cic:[0,5,12],circ:[3,10],circumv:12,classmethod:0,classvar:0,clean:[0,8],clone:[8,11,14],close:[0,8],close_fil:0,closest:0,cloud:[0,6,12],cncdp08:14,coars:[0,3,7,14],code:[0,1,2,3,6,8,11],coeff:0,coeffici:0,coil:[0,6],colab:8,colaboratori:14,collect:[0,13],com:[0,8,11,14],combin:[0,6,14],comm:0,comm_world:0,command:[8,11],common:9,commuic:0,commun:[0,3,10],communc:0,compar:6,compat:2,compil:[0,8],compiler_so:8,complesfield:0,complet:[0,6,8],complex:[6,13],complexfield:0,compon:0,comprehens:14,compress:[0,3,4,6,9,11],comput:[0,5,10,12,14],compute_angle_forces__plain:0,compute_bond_forces__plain:0,compute_dihedral_forces__plain:0,compute_field_and_kinetic_energi:0,compute_field_energy_q_gp:0,compute_field_forc:0,compute_potenti:0,compute_self_energy_q:0,concret:11,condit:6,config:[0,8],config_simple_1:11,configur:[0,2,5,6,7,8,9,10,11],configuration_four_particle_exampl:10,configuration_three_particle_exampl:10,configuration_two_particle_exampl:10,configure_runtim:8,conform:[6,13,14],connect:0,conserv:1,consid:6,consist:[0,6],consit:6,consitu:0,constant:[0,3,5,6,10],constitut:[0,2,3],construct:[0,10,11],constructor:0,contain:[0,1,2,3,6,11],content:[0,6],contribut:0,control:3,conv_crit:0,conv_fun:0,conveni:11,converg:[0,12],convergence_typ:0,convert:0,coordin:[11,12,13],copi:0,core:8,correct:[0,3],correspond:[0,3],correspondingli:10,cos:[0,6,10],cosin:[0,3,6,10],cost:[3,10],could:8,coulomb:[0,3,4,5],coulomb_const:0,coulombtyp:[0,3,5,6],counter:6,coupl:[0,3,6,11],cprofil:2,cpu:[0,10],crash:3,creat:[0,9],critic:[0,6],cross:0,csvr:[0,3],csvr_thermostat:0,ct800122x:14,ct9002114:14,current:6,cwd:8,cython:[8,14],d_n:0,dal:14,data:[0,6,11,13],dataclass:0,dataset:[0,5,6,11],datatyp:13,date:[0,14],date_format:0,david:14,debug:[0,2],decompos:0,decomposit:[0,3,10],default_level:0,defaultnochi:[0,6,9],defaultnohchi:[0,3],defaultwithchi:[0,3,6,9],defin:[0,6,9,10,12],definit:0,degre:3,delta:[0,12],denot:[0,1,3,9,10,11],dens:14,densiti:[0,3,5,9,12,14],depend:[0,6,10,12,14],deprec:0,deriv:[0,12],design:6,dest_directori:0,detail:[2,3,6,8,11,12],determin:[0,2,7,14],dev:8,devel:8,develop:[6,8],deviat:[0,3],dict:0,dictat:0,dictionari:0,dielectr:[0,3,6],dielectric_const:[0,3,5,6],dielectric_typ:0,dielectric_valu:0,dieter:0,diezemann:14,differ:[0,3,6,11,13],differenti:[0,5,7,9,12],difficult:2,dih_typ:0,dihedr:[0,2,3,5,6,8,10,14],dimens:[0,10,11,13],dimension:11,dipol:[0,2,3,5,6,14],dipole_forces_redistribut:0,direct:[0,3],directori:11,disabl:[2,6,8,11],disable_mpio:0,discard:0,discret:[0,12],discretis:12,disk:[0,3],dispers:6,dist:8,distanc:[0,3,10],distinct:0,distribut:[0,3,5,6,12],distribute_input:0,distutil:8,dnf:8,doc:0,dockerhub:8,dodecyl:6,doe:[0,10],doi:14,domain:[0,3,10],domain_decomposit:[0,3,6],donadio:[0,14],done:[0,6,8,14],dopc:6,dot:0,dot_elec:0,doubl:2,double_out:0,download:8,dppc:6,draw:0,drawn:0,driver:[8,11],dtype:0,due:[0,3],dump:0,dump_per_particl:0,dure:[0,2,3,10,11],dynam:[0,3,11,12,14],e1785571:14,e_k:0,each:[0,3,6,10,11],easiest:14,effect:[0,3],effici:10,eight:13,either:[0,3,8,13],elast:14,elec:0,elec_field:0,elec_field_contrib:0,elec_field_fouri:0,elec_forc:0,elecrostat:0,electr:[0,4,5],electrosat:0,electrostat:[0,6,14],elnedyn:14,elucid:6,embed:6,emit:0,emploi:0,empti:0,enabl:[2,6,11],enclos:0,end:0,energi:[0,1,3,4,6,7,10,11,12],energiesself:0,ensur:[0,3,6,8,12],ensurepip:8,entri:3,environ:14,epsilon:0,equal:[0,3,6],equat:0,equilibr:6,equilibrium:[0,3,6],equilibrum:10,equival:[0,3],error:0,essenti:[0,1,8],etc:[2,3],even:[0,3,6,8],event:0,everi:[0,3,6,10,11],evid:0,ewald:[0,5,6],examin:6,exampl:[3,8,11,13,14],example_structur:11,except:10,exchang:[0,3],exec:8,execut:[0,8,11],exist:0,exit:8,exp:[7,12],expand:0,expans:0,expect:0,expens:[3,12],explicit:[0,6,10,14],express:0,ext:0,extend:6,extens:14,extent:[0,7],extern:0,extract:[0,8],f401:8,f_angl:0,f_bond:0,f_dihedr:0,f_dipol:0,f_on_bead:0,factor:0,factori:0,fail:[0,8],fall:8,fals:[0,3,6],fapl:8,fashion:[0,3],fast:12,fedora:8,fer:14,few:[6,9,10,11],fft:[0,1,2,3,5,6,11,12,14],fftw3:8,fftw:[8,14],field:[2,4,5,6,9,11,12,14],field_energi:0,field_list:0,field_q_energi:0,field_q_self_energi:0,file:[2,5,6,7,8,9,10,11,14],file_io:0,file_nam:0,file_path:0,filter:[0,3,5,6,11,14],find:[0,8],find_all_path:0,fine:8,first:[0,3,6,11],five:0,fix:[0,8,11],flag:[0,13],flat:11,float32:[11,13],float64:13,flori:0,fluctuat:0,flush:[0,3],follow:[0,2,3,4,6,11],forc:[2,3,4,5,6,10,14],force_kernel:8,force_mesh:0,force_mesh_elec:0,force_mesh_elec_fouri:0,force_out:0,forego:2,form:[0,5,10],formal:[5,12],format:[0,2,3,5,11,13,14],formatt:0,fortran:[0,10],forward:0,found:[5,8],four:[0,2,3,6,13],fourier:[0,5,12],fr6nt9m4:8,frac:[0,5,6,7,9,10,12],frame:[0,11,13],framework:8,free:14,frequenc:[0,3],from:[0,2,3,5,6,8,9,10,11,14],full:[0,9,11],fulli:[0,6,8],fundament:11,gamma:0,gamma_0:0,gas:[0,4],gas_const:0,gather:0,gauss:14,gaussian:[0,3,7,12],gener:[0,2,3,6,14],get:8,getattr:8,ghost:0,giovanni:14,git:[8,11,14],github:[6,8,11,14],githubusercont:8,giusepp:14,given:[0,3,6,7],glenn:14,global:0,gnu:14,govern:9,gpe:0,grab:8,gradient:0,grain:[0,3,7,14],graph:0,gregor:14,grid:[0,1,3,5,6,7,11,12],group:[0,3,6,8,11,13,14],guess:0,gyrat:6,h5md:[0,3],h5py:[0,2],h_0:[6,12],half:0,hamiltonian:[3,5,6,7,9,11,14],handl:0,handler:0,happen:10,harmon:[0,3,6,10],has:[0,3,8,13],hat:[7,12],have:[0,6,8],hdf5:[0,2,3,5,6,8,11,13,14],hdf5_dir:8,hdf5_mpi:8,head:6,header:8,heat:[0,3],helic:[0,3,5,6],help:6,helper:0,here:[0,6,8,14],hhpf:14,highli:[8,10,11],hijack:7,hima:14,hire:1,homogen:0,homopolym:1,homopolypeptid:6,how:[3,11,14],howev:6,hpf:[3,5,9,11,12,14],html:0,http:[0,8,11,14],huggin:0,hundr:[6,10],hybrid:[11,12,14],hylleraa:14,hymd:[0,2,3,4,5,6,7,9,10,11,12,13],ideal:10,ideal_chain:[6,8],ideal_ga:[6,11],ident:0,ignor:0,ijk:[5,12],imag:8,impact:0,implement:[0,10],importerror:8,impuls:[0,3],in_fil:[0,8],inam:8,includ:[0,2,3,6,12,14],incompress:[0,3],increas:[0,2,6],indentifi:0,independ:[0,3,7,12],index:[0,11,13,14],indic:[0,2,3,10,11,13],indirect:0,individu:[0,3,6],induc:5,infer:10,info:[0,8],inform:[0,10,14],ingredi:6,initi:0,initial_energi:0,initialis:11,initialize_pm:0,inner:[0,3],input:[2,3,4,5,6,7,8,11,13],input_box:0,input_pars:[0,8],insid:[0,3,6],instal:[2,11],install_pfft:8,instantan:0,int32:[11,13],int64:13,integ:[0,3,6,13],integr:[3,6,11],integrate_posit:0,integrate_veloc:0,intend:8,inter:[0,10],interact:[0,2,3,4,6,7,11,12,14],interaction_energi:0,interfac:0,intergr:0,intermediari:0,intermolecular:[6,14],intern:[0,2,4,10],interpol:[0,5],interpret:11,interv:[0,3],intmathrm:0,intracomm:0,intramolecular:[0,3,6,12,14],intrins:5,introduc:6,investig:0,invok:[2,11],involv:[0,3,10],ion:6,ipynb:6,is_open:0,iter:0,j_k:0,jan:14,jctc:14,join:8,jone:12,journal:14,jupyt:[6,8,14],k_e:0,kappa:[0,3,4,6,11,12],kawakatsu:14,kdnb:14,keep:[0,3],kelvin:[0,3,6,11],ken:14,kernel:[0,10],keyword:[0,5,6,11],kinet:[0,12],kinetic_energi:0,knuth:0,kolli:14,kpa:4,kwd:8,label:[1,10],lambda:0,lamdifi:9,land:14,laplacian:0,larg:[8,11],larger:3,last:[6,8,11,13],last_bb:0,later:[0,6],latest:8,law:10,layout:0,layout_q:0,lbc20:14,leak:8,learn:14,leav:0,ledum:[6,14],left:[0,5,6,7,9,10,12],legend:1,lenght:0,length:[0,3,4,6,7,10,11,13],lennard:12,less:[0,6],lesser:14,let:[0,10],level:[0,2,3,13],liang:14,lib64:8,lib:8,libhdf5:8,libopenmpi:8,librari:[0,2,8,14],libtool:8,libver:8,licens:14,lieu:0,like:[0,6,8,11],limit:[3,8],line:[0,8,11],linear:[0,3],lipid_self_assembl:6,list:0,list_coulomb:0,load:0,local:[0,8,10,11,12],locat:8,log:[0,2,11],log_fil:0,log_out:11,logfil:[2,11],logger:2,logic:0,logrecord:0,look:[6,8,11],loop:0,lost:3,low:[6,8],lower:8,m_j:0,mac:8,machin:[2,14],made:0,mai:[0,2,3,6,8,10,11,13],main:[0,8,11],main_glob:8,maintain:14,make:[6,8],make_fapl:8,manner:6,manual:8,map:[0,11],marco:14,marilisa:14,marrink:14,martini:[6,14],martyna:14,mass:[0,3,4,13],massiv:14,match:0,math:0,mathbf:[0,4,5,6,9,10,12],mathcal:[6,12],mathmr:0,mathrm:[0,5,6,9,10,12],matteo:14,matter:[6,10,14],max_molecule_s:[0,3,6],maximum:[0,3,10,11],maxwel:[0,3],may:2,mbbjm:14,mean:[0,2,3],measur:10,medium:[0,3,6],melt:1,membran:6,memori:[0,8],mesh:[0,1,3,5,6,14],mesh_siz:[0,3,6,11],messag:0,messi:0,meta:6,metadata:0,method:[0,1,6,7],mh_0:12,micellular:6,michael:14,michel:14,might:[0,8],milano:14,mimic:0,minim:6,minuscul:10,mirror:2,mix:[0,6],mk09:14,model:[6,14],modifi:0,modul:[0,3,8,14],mol:[3,4,6,10,11,14],molecul:[0,3,11,12,13],molecular:[2,11,12,14],moment:8,momenta:[0,11],momentum:[0,3,4],monoatom:6,more:[2,3,6,8,11,12,14],mortel:8,morten:14,most:[8,9,11,12],mostli:2,motion:[0,6],move:0,mpi4pi:[0,8,14],mpi:[0,2,3,10,11,14],mpi_num_rank:11,mpicc:8,mpifilteral:0,mpifilterroot:0,mpio:[2,8],mpip:8,mpirun:11,multiarrai:8,multipl:[0,3,6,11,13,14],multipolar:14,multiscal:14,must:[0,3],n_b:0,n_flush:[0,3,6],n_frame:0,n_particl:[0,3],n_print:[0,3,6,11],n_step:[0,3,6,11],n_type:0,nabla:[0,12],name:[0,2,3,6,10,11,13],nanomet:[0,1],nanosecond:6,ndarrai:0,ne5et1y_:8,necessari:[0,6,8],necessit:[8,9],need:[0,6],neg:[0,6],neighbour:0,neri:14,network:[0,10,11,13,14],networkx:0,neutralis:6,never:[0,3],nevertheless:3,newer:8,next:[0,6],nicola:14,non:[0,2,6,8],none:[0,3,8],nongnu:0,noqa:8,normal:[0,2,3,8,12],notabl:11,note:[0,6,8,11,12],notebook:[6,8,14],now:6,nproc:11,npt:0,nq_i:5,number:[0,1,2,3,6,11,12,13],numer:0,numpi:[0,2,9,14],nvt:0,object:[0,9],oblat:6,observ:[0,6],obtain:[0,5,12,14],obviou:8,off:6,omit:6,onc:[3,10],one:[0,2,3,6,13],onli:[0,6,8,10,11],onto:[0,3,5,12],open:[0,8],openmpi:8,oper:[0,3,12,14],oppos:0,optim:[0,10],optimis:[6,10],option:[0,3,6,11],order:[0,3,6,10,11],ordinari:[5,12],org:0,organis:6,origin:0,oslo:14,osx:8,other:[0,11],otherwis:0,out:[8,12],outdataset:0,outer:0,output:[2,3,4,6,8,11],outsid:3,over:0,overlap:[0,9],packag:[8,11,14],page:14,paint:0,paolo:14,paper:0,parallel:[0,2,3,14],paramet:[0,3,6,7,9,14],parent_group:0,parllel:0,parrinello:[0,14],pars:[0,3],parse_config_toml:[0,8],part:[5,6,12],partial:0,particl:[0,2,5,6,7,9,11,12,13,14],particlemesh:0,particular:11,path:[0,2,8,11],pcmc09:14,pdf:1,pencil:0,peptid:[0,2,3,5,14],per:[0,2,3,10,11,13],peraro:14,perfect:0,perform:[0,3,8,10,11,12],periol:14,perman:[10,14],permitt:[0,4],pfft:[0,14],pfft_build_dir:8,phase:[0,10],phase_separ:6,phi:[0,3,6,10,12],phi_0:[6,9,12],phi_:[0,6,9,12],phi_ep:0,phi_eps_fouri:0,phi_eta:0,phi_eta_fouri:0,phi_fouri:0,phi_k:0,phi_l:0,phi_laplacian:0,phi_n:[6,10],phi_pol:0,phi_pol_prev:0,phi_q:0,phi_q_fouri:0,phi_transf:0,phospholipid:6,phy:[0,14],pic_spectr:[0,3,6],pic_spectral_gp:0,piec:6,pip13:14,pip3:8,pip:[8,11,14],pippig:14,pkg:8,place:[0,3],plain:2,plane:[0,6,10],pleas:[8,11],plist:8,plume:0,plumed_bia:0,plumed_out:0,pme:14,pmesh:[0,14],png:1,point:[0,1,10,13],poisson:0,pol_mix:0,polar:0,polym:[6,14],posit:[0,2,3,5,6,11,12],possibl:[0,3,6,14],potenti:[0,3,4,5,7,8,10,14],ppft:14,practic:10,pre:[0,6],precis:[1,2],prefer:3,prepar:0,prepare_bond:0,prepare_bonds_old:0,prepare_index_based_bond:0,prepend:[0,11],present:[0,2,3,6],preserv:3,pressur:[0,4],pretti:8,previou:0,previous:6,prior:[0,3],priovid:0,prng:0,prod_:0,profil:2,program:[0,11],project:5,promot:0,prop:0,propag:[0,3],propens:[0,3,5,6],propensity_potential_coeff:0,properti:3,protein:[0,14],provid:[0,2,3,11,13,14],psi:[0,4,5],psi_:5,psi_fouri:0,pull:8,put:6,pytest:11,python3:[6,8,11,14],python:[0,11,14],q_i:[0,5],q_j:0,quadrat:0,quanit:0,quantiti:[0,4],quantum:14,quartet:10,quess:0,r_0:[0,6,10],r_a:10,r_c:10,rad:[3,10],radial:6,radii:6,radiu:6,rainwoodman:[8,14],rais:[6,8],random:[0,2,11],random_chi_squar:0,random_gaussian:0,randomli:[0,3,6],rang:5,rank0:0,rank:[0,2,3,10,11],rank_rang:0,rankself:0,rare:10,raw:8,rdcc_nbyte:8,rdcc_nslot:8,rdcc_w0:8,read:[0,8,11,14],read_config_toml:[0,8],readout:0,real:13,realfield:0,realist:6,reappli:0,rearrang:0,reason:8,receiv:[0,3],recent:8,reciproc:[0,7],recognis:11,recognit:14,recommend:8,reconstruct:[0,2,5,6,10,14],record:0,recreat:14,recurs:0,redistribut:0,reduc:[3,12],refer:[3,11],regim:6,regul:[0,3],regularli:8,rel:[0,3,6,10],relax:[0,3],releas:[0,6,8,11,14],remain:[0,6],remov:[0,3],remove_center_of_mass_momentum:0,remove_com_momentum:[0,3],replac:[0,8],repositori:[6,11],repres:[0,3,13],represent:7,repuls:3,requir:[0,3,8,10,11,14],rescal:[0,3,14],research:14,respa:[0,3,6],respa_inn:[0,3,6],respect:[0,1,12],restructur:0,result:[0,3,6,9],revers:[0,3,14],rgen:14,rho0:0,rho:[0,5],rho_0:0,rho_:5,right:[0,5,6,7,9,10,12],rightarrow:10,root:[0,11,13],roughi:6,row:11,rrespa:[0,3,6],ruin:0,run:[0,2,3,6,10],run_glob:8,rundown:11,runpi:8,runtimeerror:8,same:[0,3,6],sampl:[0,3,14],scalar:0,scale:[0,3,6,7,8,10,11,14],sch:14,scheme:[0,6],sci:14,scienc:14,script:11,sds:6,search:14,second:[0,11],see:[0,2,3,5,6,8,9,10,11,12,14],seed:[2,11],select:[11,14],self:[0,3,8],self_energi:0,seminumer:0,send:[0,3],separ:0,seri:[0,3,6,10],serial:[8,11],serialis:3,set:[0,3,11],set_fapl:8,setup:[0,6,7,8,13],setup_time_dependent_el:0,setuptool:8,sever:0,shape:[0,6,11,13],sheet:0,shift:0,should:[0,2,10],shown:6,siam:14,siewert:14,sigbj:14,sigma:[0,3,6,7,11,12],sim:0,similar:0,simpl:[0,6,11,12],simplest:6,simpli:0,simul:[0,2,6,8,10,12,13,14],simultan:0,sinc:0,singl:[0,3,6],site:8,size:[0,3,6,11,12],slight:0,slowli:12,small:[3,11],smear:5,smooth:[0,12],sodium:6,soft:[6,14],solv:0,solvent:6,some:[0,3,8],sort:0,sort_dielectric_by_type_id:0,sourc:[0,1],space:[0,3,5,7],span:0,spatial:[0,3,11,12],specfi:0,speci:0,special:0,specif:[0,2,3,6,9,10,11,13],specifi:[0,2,3,6,9,10,11,13],spectacularli:0,spectral:6,speed:[0,3],spheric:6,spheroid:6,split:0,spontan:6,spring:[0,10],sqrt:[0,7,12],squar:[0,9],squaredphi:[0,3,9,11],stabil:6,stabl:6,stackoverflow:0,standard:[0,3,12,14],start:[0,3,6,10,13],start_temperatur:[0,3,6],state:0,statu:8,stdout:[0,2],step:[0,3,6,10,11],stiff:3,stochast:0,store:0,store_data:0,store_stat:0,str10:11,str:0,straightforward:[7,9],stream:0,strength:[0,3,6,11],stretch:[0,3,10,14],string:[0,3,8,11,13],structur:[0,2,3,5,6,11,14],style:14,sub:6,subclass:[0,9],subsequ:[0,5,6,10],sudo:8,suitabl:0,sulfat:6,sum:0,sum_:[0,5,9,12],sum_i:0,sum_j:0,sum_k:0,sum_n:[0,6,10],summari:11,superclass:[0,7],support:[0,6,8,14],swap:10,symbol:[0,4,9],sympi:[0,9],sys:8,system:[0,1,2,3,6,9,11,12,14],tag:[0,3,8],take:[0,3,5,9,10,11,12],taken:0,tar:8,target:0,target_pressur:0,target_temperatur:[0,3,6,11],tau:[0,3,6,11],tau_p:0,tbm92:14,temperatur:[0,3,4,6,11],ten:6,term:[0,3,6,9,12],test:[0,1,8],text:[0,2,3,4,5,6,9,10,12],than:[0,3],theori:[0,14],therefor:8,thermalis:[0,3],thermostat:[2,3,6,11],thermostat_coupling_group:[0,3,6],thermostat_work:0,theta:[6,10],theta_0:[0,6,10],thi:[0,2,3,6,8,9,10,11,12],thorough:11,though:6,thousand:[6,10],three:[0,2,3,6],through:[0,3,6,7,8,9,10,14],tild:[0,3,4,5,6,9,12],time:[0,3,4,6,10,11,14],time_step:[0,3,6,11],tmp:8,todo:0,togeth:[0,3,6],token:8,toml:[0,2,3,6,8,10,11],toml_cont:0,tomli:0,too:3,toplog:0,topol:0,topolog:[0,2,3,5,6,11,14],torsion:[0,3,10,14],toshihiro:14,total:[0,3,6,11,12],traceback:8,trajectori:[0,2,3,6,11],trans_matric:0,transfer:[0,10],transform:[0,9,12],travers:0,tri:3,truncat:0,tuckerman:[3,14],turn:6,tutori:[6,8,11,13],two:[0,2,3,6],txt:11,type:[0,2,3,5,6,9,10,11,13],type_arrai:0,type_charg:0,type_to_name_map:0,ubuntu:8,uio:[8,11,14],unchang:0,under:[6,8,12,14],uninstal:8,union:0,uniqu:0,unique_nam:0,unit:[0,3,10],univers:14,unknown:0,unless:[0,3],unset:0,unstabl:3,until:6,updat:[0,8],update_field:0,update_field_force_q:0,update_field_force_q_gp:0,upgrad:[8,14],usag:[0,2],use:[0,3,5,6,8],used:[0,1,2,3,6,7,9,11,12,13],uses:[0,4,12,14],using:[0,2,3,8,12,14],usr:8,usual:11,v_2:[0,6,10],v_3:[0,6,10],v_4:[0,6,10],v_ext:0,v_ext_fouri:0,vacuum:4,valid:[0,3],validated_config:0,valu:[0,3,4,5,6,10],valueerror:8,vanish:0,varepsilon:0,varepsilon_0:[4,5],vari:12,variabl:0,variant:6,variou:[0,13],vbar_elec:0,vbar_elec_fouri:0,vector:10,vectoris:9,veloc:[0,2,3,4,6,11,13,14],velocity_out:0,velocti:0,verbos:[0,2,8,11],veri:[6,8,10],verifi:0,verlet:[0,3,6,11],versa:3,version:[0,6,8,11,12],vert:0,vertex:[0,5],vertic:0,via:[6,14],vice:3,vol:0,volum:0,voxel:0,wai:[8,12],warn:0,weakli:3,weight:0,well:6,were:0,weslei:0,wheel:8,when:[0,3,8,10],where:[0,5,9,10,12],which:[0,2,3,5,6,8,9,10,11],width:[0,3],window:[0,5,12],without:[0,14],work:[0,8],workload:0,would:[0,3],wrap:0,wrapper:0,write:[0,3],written:[0,3],www:0,xavier:14,yield:6,you:[8,10,14],yuan:14,zero:[0,3],zhong:14,zhu:14},titles:["4. API reference","3. Benchmarks","5. Command line arguments","3. Configuration file","6. Constants and Units","3. Electrostatic interactions","1. Examples","2. Filtering","1. Installation","1. Interaction energy functionals","2. Intramolecular bonds","2. Usage overview for HylleraasMD","1. Theory","4. Topology and structure file","HylleraasMD documentation"],titleterms:{"function":9,"import":8,"new":[7,9],"while":8,SDS:6,api:0,argument:2,assembl:6,benchmark:1,bilay:6,bond:[1,3,10],build:8,calcul:12,chain:6,chi:9,code:14,colab:14,colaboratori:8,command:2,common:8,configur:3,constant:4,copolym:6,curl:8,dataset:13,depend:8,develop:14,diblock:6,docker:8,document:14,due:8,electrostat:[3,5],enabl:8,energi:9,error:8,exampl:6,extern:12,field:[0,1,3],file:[0,3,13],filter:[7,12],forc:[0,1,8,12],form:[9,12],fortran:8,four:10,gas:6,googl:[8,14],guid:14,h5py:8,hamiltonian:[0,12],helix:6,hylleraasmd:[11,14],hymd:[8,14],ideal:6,implement:[7,9],incompress:9,indic:14,input:0,instal:[8,14],integr:0,interact:[5,8,9],interpol:12,intramolecular:10,issu:8,kappa:9,kernel:8,keyword:3,line:2,lipid:6,logger:0,metadata:3,miss:8,mpi:8,numpi:8,onli:9,option:[2,13],output:0,overview:11,parallel:[8,11],parser:0,particl:[1,3,10],peptid:6,pfft:8,phase:6,phi:9,potenti:12,python:8,reciproc:12,refer:[0,14],requir:[2,13],rod:6,run:[8,11,14],self:6,separ:6,simul:[3,11],sourc:14,space:12,specifi:5,stiff:6,structur:13,tabl:14,test:11,theori:12,thermostat:0,three:10,topolog:13,two:10,unit:4,usag:11,user:14,wget:8,without:8}}) \ No newline at end of file diff --git a/v1.0.8/.buildinfo b/v1.0.8/.buildinfo new file mode 100644 index 00000000..0f0c86a1 --- /dev/null +++ b/v1.0.8/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 37a84330742b48c328f69763410e32db +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v1.0.8/.doctrees/doc_pages/api.doctree b/v1.0.8/.doctrees/doc_pages/api.doctree new file mode 100644 index 00000000..7bd55df8 Binary files /dev/null and b/v1.0.8/.doctrees/doc_pages/api.doctree differ diff --git a/v1.0.8/.doctrees/doc_pages/benchmarks.doctree b/v1.0.8/.doctrees/doc_pages/benchmarks.doctree new file mode 100644 index 00000000..08d2da2b Binary files /dev/null and b/v1.0.8/.doctrees/doc_pages/benchmarks.doctree differ diff --git a/v1.0.8/.doctrees/doc_pages/command_line.doctree b/v1.0.8/.doctrees/doc_pages/command_line.doctree new file mode 100644 index 00000000..a7d4ce7a Binary files /dev/null and b/v1.0.8/.doctrees/doc_pages/command_line.doctree differ diff --git a/v1.0.8/.doctrees/doc_pages/config_file.doctree b/v1.0.8/.doctrees/doc_pages/config_file.doctree new file mode 100644 index 00000000..d89d9018 Binary files /dev/null and b/v1.0.8/.doctrees/doc_pages/config_file.doctree differ diff --git a/v1.0.8/.doctrees/doc_pages/constants_and_units.doctree b/v1.0.8/.doctrees/doc_pages/constants_and_units.doctree new file mode 100644 index 00000000..32b670c0 Binary files /dev/null and b/v1.0.8/.doctrees/doc_pages/constants_and_units.doctree differ diff --git a/v1.0.8/.doctrees/doc_pages/electrostatics.doctree b/v1.0.8/.doctrees/doc_pages/electrostatics.doctree new file mode 100644 index 00000000..f6c2c8e7 Binary files /dev/null and b/v1.0.8/.doctrees/doc_pages/electrostatics.doctree differ diff --git a/v1.0.8/.doctrees/doc_pages/examples.doctree b/v1.0.8/.doctrees/doc_pages/examples.doctree new file mode 100644 index 00000000..3e0eee2c Binary files /dev/null and b/v1.0.8/.doctrees/doc_pages/examples.doctree differ diff --git a/v1.0.8/.doctrees/doc_pages/filtering.doctree b/v1.0.8/.doctrees/doc_pages/filtering.doctree new file mode 100644 index 00000000..f382e1c3 Binary files /dev/null and b/v1.0.8/.doctrees/doc_pages/filtering.doctree differ diff --git a/v1.0.8/.doctrees/doc_pages/installation.doctree b/v1.0.8/.doctrees/doc_pages/installation.doctree new file mode 100644 index 00000000..8f2a31a0 Binary files /dev/null and b/v1.0.8/.doctrees/doc_pages/installation.doctree differ diff --git a/v1.0.8/.doctrees/doc_pages/interaction_energy_functionals.doctree b/v1.0.8/.doctrees/doc_pages/interaction_energy_functionals.doctree new file mode 100644 index 00000000..f71d35ce Binary files /dev/null and b/v1.0.8/.doctrees/doc_pages/interaction_energy_functionals.doctree differ diff --git a/v1.0.8/.doctrees/doc_pages/intramolecular_bonds.doctree b/v1.0.8/.doctrees/doc_pages/intramolecular_bonds.doctree new file mode 100644 index 00000000..f3f2e90e Binary files /dev/null and b/v1.0.8/.doctrees/doc_pages/intramolecular_bonds.doctree differ diff --git a/v1.0.8/.doctrees/doc_pages/overview.doctree b/v1.0.8/.doctrees/doc_pages/overview.doctree new file mode 100644 index 00000000..03157974 Binary files /dev/null and b/v1.0.8/.doctrees/doc_pages/overview.doctree differ diff --git a/v1.0.8/.doctrees/doc_pages/theory.doctree b/v1.0.8/.doctrees/doc_pages/theory.doctree new file mode 100644 index 00000000..264e6987 Binary files /dev/null and b/v1.0.8/.doctrees/doc_pages/theory.doctree differ diff --git a/v1.0.8/.doctrees/doc_pages/topology_input.doctree b/v1.0.8/.doctrees/doc_pages/topology_input.doctree new file mode 100644 index 00000000..e994e0c6 Binary files /dev/null and b/v1.0.8/.doctrees/doc_pages/topology_input.doctree differ diff --git a/v1.0.8/.doctrees/environment.pickle b/v1.0.8/.doctrees/environment.pickle new file mode 100644 index 00000000..f72604d5 Binary files /dev/null and b/v1.0.8/.doctrees/environment.pickle differ diff --git a/v1.0.8/.doctrees/index.doctree b/v1.0.8/.doctrees/index.doctree new file mode 100644 index 00000000..3c452842 Binary files /dev/null and b/v1.0.8/.doctrees/index.doctree differ diff --git a/v1.0.8/_downloads/14dce7e9abc3fcf7ac2a114f9370e7b3/benchmarks-1.pdf b/v1.0.8/_downloads/14dce7e9abc3fcf7ac2a114f9370e7b3/benchmarks-1.pdf new file mode 100644 index 00000000..ba64c325 Binary files /dev/null and b/v1.0.8/_downloads/14dce7e9abc3fcf7ac2a114f9370e7b3/benchmarks-1.pdf differ diff --git a/v1.0.8/_downloads/3493f83031f8cb19fcf8104e34daa7c6/benchmarks-1.py b/v1.0.8/_downloads/3493f83031f8cb19fcf8104e34daa7c6/benchmarks-1.py new file mode 100644 index 00000000..deb4348f --- /dev/null +++ b/v1.0.8/_downloads/3493f83031f8cb19fcf8104e34daa7c6/benchmarks-1.py @@ -0,0 +1,38 @@ +import numpy as np +import matplotlib.pyplot as plt +nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) +time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 +], dtype=np.float64) +nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 +], dtype=np.float64,) +time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, +], dtype=np.float64) +nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 +], dtype=np.float64) +time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, +], dtype=np.float64) +plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" +) +plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" +) +plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" +) +plt.xlabel("CPUs", fontsize=15) +plt.ylabel("Time per step, us", fontsize=15) +plt.legend(fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.show() \ No newline at end of file diff --git a/v1.0.8/_downloads/3542a9796cd50a5d3267827e5ce7fd3e/benchmarks-1.hires.png b/v1.0.8/_downloads/3542a9796cd50a5d3267827e5ce7fd3e/benchmarks-1.hires.png new file mode 100644 index 00000000..173b39f3 Binary files /dev/null and b/v1.0.8/_downloads/3542a9796cd50a5d3267827e5ce7fd3e/benchmarks-1.hires.png differ diff --git a/v1.0.8/_downloads/393123f81ea32975f52fc618f92233f5/benchmarks-2.png b/v1.0.8/_downloads/393123f81ea32975f52fc618f92233f5/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v1.0.8/_downloads/393123f81ea32975f52fc618f92233f5/benchmarks-2.png differ diff --git a/v1.0.8/_downloads/5a9d5457452cbb84c79cb28b8a44b693/benchmarks-2.hires.png b/v1.0.8/_downloads/5a9d5457452cbb84c79cb28b8a44b693/benchmarks-2.hires.png new file mode 100644 index 00000000..82806426 Binary files /dev/null and b/v1.0.8/_downloads/5a9d5457452cbb84c79cb28b8a44b693/benchmarks-2.hires.png differ diff --git a/v1.0.8/_downloads/75b0808008a0891d355649d3d0fc0e56/benchmarks-2.pdf b/v1.0.8/_downloads/75b0808008a0891d355649d3d0fc0e56/benchmarks-2.pdf new file mode 100644 index 00000000..1ca8716f Binary files /dev/null and b/v1.0.8/_downloads/75b0808008a0891d355649d3d0fc0e56/benchmarks-2.pdf differ diff --git a/v1.0.8/_downloads/7788eb8b698f5500289ddeac78c36f0c/benchmarks-1.png b/v1.0.8/_downloads/7788eb8b698f5500289ddeac78c36f0c/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.8/_downloads/7788eb8b698f5500289ddeac78c36f0c/benchmarks-1.png differ diff --git a/v1.0.8/_downloads/fbc23d1abaab5e6a18a8f3feecae056d/benchmarks-2.py b/v1.0.8/_downloads/fbc23d1abaab5e6a18a8f3feecae056d/benchmarks-2.py new file mode 100644 index 00000000..fd287cbc --- /dev/null +++ b/v1.0.8/_downloads/fbc23d1abaab5e6a18a8f3feecae056d/benchmarks-2.py @@ -0,0 +1,33 @@ +import numpy as np +import matplotlib.pyplot as plt + +mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] +mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + +mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + +mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + +mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] +mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + +mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + +mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + +plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") +plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") +plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") +plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") +plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") +plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") +plt.xlabel("CPUs", fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.ylabel("Time per step, s", fontsize=15) +plt.legend(loc="upper left", fontsize=15) +plt.show() \ No newline at end of file diff --git a/v1.0.8/_images/benchmarks-1.png b/v1.0.8/_images/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.8/_images/benchmarks-1.png differ diff --git a/v1.0.8/_images/benchmarks-2.png b/v1.0.8/_images/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v1.0.8/_images/benchmarks-2.png differ diff --git a/v1.0.8/_images/hylleraas_centre_logo_black.png b/v1.0.8/_images/hylleraas_centre_logo_black.png new file mode 100644 index 00000000..40826396 Binary files /dev/null and b/v1.0.8/_images/hylleraas_centre_logo_black.png differ diff --git a/v1.0.8/_images/uio_full_logo_eng_pos.png b/v1.0.8/_images/uio_full_logo_eng_pos.png new file mode 100644 index 00000000..6c603139 Binary files /dev/null and b/v1.0.8/_images/uio_full_logo_eng_pos.png differ diff --git a/v1.0.8/_modules/hymd/field.html b/v1.0.8/_modules/hymd/field.html new file mode 100644 index 00000000..c7240eb5 --- /dev/null +++ b/v1.0.8/_modules/hymd/field.html @@ -0,0 +1,1453 @@ + + + + + + hymd.field — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.field

+"""Forces and energies from the discretized particle-field grid interactions
+"""
+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import warnings
+
+
+
[docs]def initialize_pm(pmesh, config, comm=MPI.COMM_WORLD): + """ + Creates the necessary pmesh objects for pfft operations. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + config : Config + Configuration dataclass containing simulation metadata and parameters. + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm : object 'pmesh.pm.ParticleMesh' + field_list : list[pmesh.pm.RealField], (multiple) + Essential list of pmesh objects required for MD + list_coulomb : list[pmesh.pm.RealField], (multiple) + Additional list of pmesh objects required for electrostatics. + """ + + if config.dtype == np.float64: + pmeshtype = "f8" + else: + pmeshtype = "f4" + # Ignore numpy numpy.VisibleDeprecationWarning: Creating an ndarray from + # ragged nested sequences until it is fixed in pmesh + with warnings.catch_warnings(): + warnings.filterwarnings( + action="ignore", + category=np.VisibleDeprecationWarning, + message=r"Creating an ndarray from ragged nested sequences", + ) + # The first argument of ParticleMesh has to be a tuple + pm = pmesh.ParticleMesh( + config.mesh_size, BoxSize=config.box_size, dtype=pmeshtype, comm=comm + ) + phi = [pm.create("real", value=0.0) for _ in range(config.n_types)] + phi_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] # noqa: E501 + force_on_grid = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + v_ext_fourier = [pm.create("complex", value=0.0) for _ in range(4)] + v_ext = [pm.create("real", value=0.0) for _ in range(config.n_types)] + + phi_transfer = [pm.create("complex", value=0.0) for _ in range(3)] + + phi_laplacian = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + + # Initialize charge density fields + coulomb_list = [] + elec_common_list = [None, None, None, None] + _SPACE_DIM = config.box_size.size + + if config.coulombtype == "PIC_Spectral_GPE" or config.coulombtype == "PIC_Spectral": + phi_q = pm.create("real", value=0.0) + phi_q_fourier = pm.create("complex", value=0.0) + psi = pm.create("real", value=0.0) + elec_field = [pm.create("real", value=0.0) for _ in range(_SPACE_DIM)] + + elec_common_list = [phi_q, phi_q_fourier, psi, elec_field] + + if config.coulombtype == "PIC_Spectral": + elec_field_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] # for force calculation + psi_fourier = pm.create("complex", value=0.0) + + coulomb_list = [ + elec_field_fourier, + psi_fourier, + ] + + if ( + config.coulombtype == "PIC_Spectral_GPE" + ): ## initializing the density mesh #dielectric_flag + phi_eps = pm.create( + "real", value=0.0 + ) ## real contrib of the epsilon dielectric painted to grid + phi_eps_fourier = pm.create("complex", value=0.0) # complex contrib of phi eps + phi_eta = [ + pm.create("real", value=0.0) for _ in range(_SPACE_DIM) + ] ## real contrib of factor in polarization charge density + phi_eta_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] ## fourier of factor in polarization charge density + phi_pol = pm.create( + "real", value=0.0 + ) ## real contrib of the polarization charge + phi_pol_prev = pm.create("real", value=0.0) + elec_dot = pm.create("real", value=0.0) + elec_field_contrib = pm.create( + "real", value=0.0 + ) # needed for pol energies later + + # External potential and force meshes + Vbar_elec = [pm.create("real", value=0.0) for _ in range(config.n_types)] + Vbar_elec_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] + force_mesh_elec = [ + [pm.create("real", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + force_mesh_elec_fourier = [ + [pm.create("complex", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + + coulomb_list = [ + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol, + phi_pol_prev, + elec_dot, + elec_field_contrib, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + ] + + field_list = [ + phi, + phi_fourier, + force_on_grid, + v_ext_fourier, + v_ext, + phi_transfer, + phi_laplacian, + ] + + return (pm, field_list, elec_common_list, coulomb_list)
+ + +
[docs]def compute_field_force(layouts, r, force_mesh, force, types, n_types): + """Interpolate particle-field forces from the grid onto particle positions + + Backmaps the forces calculated on the grid to particle positions using the + window function :math:`P` (by default cloud-in-cell [CIC]). In the + following, let :math:`\\mathbf{F}_j` denote the force acting on the + particle with index :math:`j` and position :math:`\\mathbf{r}_j`. The + interpolated force is + + .. math:: + + \\mathbf{F}_j = -\\sum_k\\nabla V_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`V_{j_k}` is the discretized external potential at grid vertex + :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid vertex + with index :math:`j_k`, and :math:`h^3` is the volume of each grid voxel. + The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + r : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + force : (N,D) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. Local + for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + n_types : int + Number of different unique types present in the simulation system. + :code:`n_types` is global, i.e. the same for all MPI ranks even if some + ranks contain zero particles of certain types. + """ + for t in range(n_types): + ind = types == t + for d in range(3): + force[ind, d] = force_mesh[t][d].readout(r[ind], layout=layouts[t])
+ + +
[docs]def compute_self_energy_q(config, charges, comm=MPI.COMM_WORLD): + """Compute the self energy for the interaction due to the Ewald scheme + used to compute the electrostatics. The energy is stored in :code:`config`. + + The self interaction energy is given by: + + .. math:: + + U_{self} = \\sqrt{\\frac{1}{2\\pi\\sigma^2}} \\sum_{i=1}^{N} q_i^2 + + where :math:`q_i` are the charges and :math:`\\sigma` is the half-width + of the Gaussian filter. + + Parameters + ---------- + config : Config + Configuration object. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + comm : mpi4py.Comm + MPI communicator to use for rank communication. + + Returns + ------- + field_q_self_energy : float + Electrostatic self energy. + """ + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + prefac = elec_conversion_factor * np.sqrt( + 1.0 / (2.0 * np.pi * config.sigma * config.sigma) + ) + _squared_charges = charges * charges + squared_charges_sum = comm.allreduce(np.sum(_squared_charges)) + return prefac * squared_charges_sum
+ + +
[docs]def update_field_force_q( + charges, + phi_q, + phi_q_fourier, + psi, + psi_fourier, + elec_field_fourier, + elec_field, + elec_forces, + layout_q, + hamiltonian, + pm, + positions, + config, +): + """Calculate the electrostatic particle-field forces on the grid + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential is computed in reciprocal space as + + .. math:: + + \\Phi = \\mathrm{FFT}^{-1}\\left[ + \\frac{4\\pi k_e}{\\varepsilon \\vert\\mathbf{k}\\vert^2} + \\mathrm{FFT}(\\rho)\\mathrm{FFT}(H) + \\right], + + with the electric field + + .. math:: + + \\mathbf{E} = \\mathrm{FFT}^{-1}\\left[ + -i\\mathbf{k}\\,\\mathrm{FFT}(\\Psi) + \\right]. + + In the following, let :math:`\\mathbf{F}_j` denote the electrostatic force + acting on the particle with index :math:`j` and position + :math:`\\mathbf{r}_j`. The interpolated electrostatic force is + + .. math:: + + \\mathbf{F}_j = \\sum_k q_j\\mathbf{E}_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`\\mathbf{E}_{j_k}` is the discretized electric field at grid + vertex :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid + vertex with index :math:`j_k`, and :math:`h^3` is the volume of each grid + voxel. The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty; any values in this field + are discarded. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + elec_field_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + electric field values in reciprocal space on the computational grid. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + n_dimensions = config.box_size.size + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + # charges to grid + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) + phi_q /= volume_per_cell + # print("phi_q", np.sum(phi_q)) + phi_q.r2c(out=phi_q_fourier) + + # smear charges with filter + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + + # solve Poisson equation in Fourier space to get electrostatic potential + def poisson_transfer_function(k, v): + return 4.0 * np.pi * elec_conversion_factor * v / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(poisson_transfer_function, out=psi_fourier) + # print("psi_fourier", np.sum(psi_fourier)) + psi_fourier.c2r(out=psi) + # print("phi_q * psi update_field", np.sum(phi_q * psi)) + + # exit() + + # compute electric field directly from smeared charged densities in Fourier + for _d in np.arange(n_dimensions): + + def poisson_transfer_function(k, v, d=_d): + return ( + -1j + * k[d] + * 4.0 + * np.pi + * elec_conversion_factor + * v + / k.normp(p=2, zeromode=1) + ) + + phi_q_fourier.apply(poisson_transfer_function, out=elec_field_fourier[_d]) + elec_field_fourier[_d].c2r(out=elec_field[_d]) + + # get electrostatic force from electric field + for _d in np.arange(n_dimensions): + elec_forces[:, _d] = charges * ( + elec_field[_d].readout(positions, layout=layout_q) + )
+ + +def comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, +): + for t in range(config.n_types): + np.copyto(phi_transfer[0].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[1].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[2].value, phi_fourier[t].value, casting="no", where=True) + + # Evaluate laplacian of phi in fourier space + for d in range(3): + + def laplacian_transfer(k, v, d=d): + return -k[d] ** 2 * v + + phi_transfer[d].apply(laplacian_transfer, out=Ellipsis) + phi_transfer[d].c2r(out=phi_laplacian[t][d]) + + +
[docs]def update_field( + phi, + phi_laplacian, + phi_transfer, + layouts, + force_mesh, + hamiltonian, + pm, + positions, + types, + config, + v_ext, + phi_fourier, + v_ext_fourier, + m, + compute_potential=False, +): + """Calculate the particle-field potential and force density + + If :code:`compute_potential` is :code:`True`, the energy may subsequently + be computed by calling :code:`compute_field_and_kinetic_energy`. + + Computes the particle-field external potential :math:`V_\\text{ext}` from + particle number densities through the smoothed density field, + :math:`\\phi(\\mathbf{r})`. With :math:`P` being the cloud-in-cell (CIC) + window function, the density and filtered densities are computed as + + .. math:: + + \\phi(\\mathbf{r}) = \\sum_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\phi(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\phi(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + external potential is computed in reciprocal space as + + .. math:: + + V_\\text{ext} = \\mathrm{FFT}^{-1}\\left[ + \\mathrm{FFT} + \\left( + \\frac{\\partial w}{\\partial \\tilde\\phi} + \\right) + \\mathrm{FFT}(H) + \\right], + + where :math:`w` is the interaction energy functional. Differentiating + :math:`V_\\text{ext}` is done by simply applying :math:`i\\mathbf{k}` in + Fourier space, and the resulting forces are back-transformed to direct + space and interpolated to particle positions by + + .. math:: + + \\mathbf{F}_j = -\\sum_{j_k} \\nabla V_{j_k} + P(\\mathbf{r}_{j_k} - \\mathbf{r}_j)h^3, + + where :math:`j_k` are the neighbouring vertices of particle :math:`j` at + position :math:`\\mathbf{r}_j`, and :math:`h^3` is the volume of each grid + voxel. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Pre-allocated, but empty; any values + in this field are discarded. Changed in-place. Local for each MPI + rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + config : Config + Configuration object. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Pre-allocated, but empty; any values in this field are + discarded Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + phi_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computational grid is represented by the collective fields of all + MPI ranks. + v_ext_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplesField` objects containing discretized + particle-field external potential values in reciprocal space on the + computational grid; :code:`D+1` fields in D dimensions for each + particle type. :code:`D` copies are made after calculation for later + use in force calculation, because the `force transfer function` + application differentiates the field in-place, ruining the contents + for differentiation in the remaining :code:`D-1` spatial directions. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + m: list[float], (M,) + pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. + Defaults to 1.0 for all particle types. + compute_potential : bool, optional + If :code:`True`, a :code:`D+1`-th copy of the Fourier transformed + external potential field is made to be used later in particle-field + energy calculation. If :code:`False`, only :code:`D` copies are made. + + See also + -------- + compute_field_and_kinetic_energy : + Compute the particle-field energy after the external potential is + calculated. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + for t in range(config.n_types): + pm.paint(positions[types == t], mass=m[t], layout=layouts[t], out=phi[t]) + phi[t] /= volume_per_cell + phi[t].r2c(out=phi_fourier[t]) + phi_fourier[t].apply(hamiltonian.H, out=Ellipsis) + phi_fourier[t].c2r(out=phi[t]) + + # External potential + for t in range(config.n_types): + v = hamiltonian.v_ext[t](phi) + + v.r2c(out=v_ext_fourier[0]) + v_ext_fourier[0].apply(hamiltonian.H, out=Ellipsis) + np.copyto( + v_ext_fourier[1].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + np.copyto( + v_ext_fourier[2].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + if compute_potential: + np.copyto( + v_ext_fourier[3].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + + # Differentiate the external potential in fourier space + for d in range(3): + + def force_transfer_function(k, v, d=d): + return -k[d] * 1j * v + + v_ext_fourier[d].apply(force_transfer_function, out=Ellipsis) + v_ext_fourier[d].c2r(out=force_mesh[t][d]) + + if compute_potential: + v_ext_fourier[3].c2r(out=v_ext[t])
+ + +
[docs]def compute_field_and_kinetic_energy( + phi, + phi_q, + psi, + velocity, + hamiltonian, + positions, + types, + v_ext, + config, + layouts, + comm=MPI.COMM_WORLD, +): + """Compute the particle-field and kinetic energy contributions + + Calculates the kinetic energy through + + .. math:: + + E_k = \\sum_j \\frac{1}{2}m_j\\mathbf{v}_j\\cdot\\mathbf{v}_j, + + and the particle-field energy by + + .. math:: + + E_\\text{field} = \\int\\mathrm{d}\\mathbf{r}\\, + w[\\tilde\\phi], + + where :math:`w` is the interaction energy functional `density`. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + velocity : (N,D) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Local for each MPI rank--the full computational grid is + represented by the collective fields of all MPI ranks. + config : Config + Configuration object. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field : + Computes the up-to-date external potential for use in calculating the + particle-field energy. + """ + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + field_energy = w_0.csum() # w to W + + kinetic_energy = comm.allreduce(0.5 * config.mass * np.sum(velocity**2)) + + if config.coulombtype == "PIC_Spectral": + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + field_q_energy = w_elec.csum() + else: + field_q_energy = 0.0 + + return field_energy, kinetic_energy, field_q_energy
+ + +
[docs]def compute_field_energy_q_GPE( + config, + phi_eps, + field_q_energy, + dot_elec, + comm=MPI.COMM_WORLD, +): + """ + Compute the electrostatic energy after electrosatic forces is + calculated. + + From the definition of the elecrostatic potential :math:`\\Psi`, the energy + is + + W = \\frac{1}{2}\\int\\mathrm{d}\\mathbf{r}\\, + \\epsilon(\\mathbf{r})} \\left(\\mathbf{E}\\cdot \\mathbf{E}\\right), + + where :math:`\\epsilon(\\mathbf{r})}` is the anisotropic, spatially dependent, + relative dielectric of the simulation medium. + + Parameters + ---------- + config : hymd.input_parser.Config + Configuration object. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + field_q_energy : float + Total elecrostatic energy. + dot_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing :math:`|\\mathbf{E(r)}|^{2}` + on the computational grid. Local for each MPI rank -- the full computational + grid is represented by the collective fields of all MPI ranks. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field_force_q_GPE: + Compute the electrosatic force from an anisotropic dielectric general + Poisson equation. + """ + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + # ^ due to integration on local cell before allreduce + + eps_0 = 1.0 / (config.coulomb_constant * 4 * np.pi) + field_q_energy = ( + volume_per_cell * (0.5 * eps_0) * comm.allreduce(np.sum(phi_eps * dot_elec)) + ) + + return field_q_energy
+ + +
[docs]def update_field_force_q_GPE( + conv_fun, + phi, + types, + charges, + phi_q, + phi_q_fourier, + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol_prev, + phi_pol, + elec_field, + elec_forces, + elec_field_contrib, + psi, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + hamiltonian, + layout_q, + layouts, + pm, + positions, + config, + comm=MPI.COMM_WORLD, +): + """ + Calculate the electrostatic particle-field forces on the grid, arising from + a general Poisson equation, i.e. anisotropic permittivity/dielectric. + The function is called when tomli input config.coulombtype = "PIC_Spectral_GPE." + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential for a variable dielectric does not have an + analytical expression, and is computed in reciprocal through an iterative + method. + + The GPE states that + + .. math:: + + \\nabla \\cdot \\left(\\epsilon(\\mathbf{r}) + \\nabla{\\mathbf{\\psi(r)}}\\right) = -\\rho({\\mathbf{r}}). + + where :math:`\\epsilon(\\mathbf{r})` is the relative dielectric function. + + Parameters + ---------- + conv_fun : Convergence function. + Returns a scalar. Depends on MPI allreduce for similar convergence + across MPI ranks. + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_eta : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + gradients of the relative dielectric values on the computational grid. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank--the + full computational grid is represented by the collective fields of all MPI ranks. + phi_eta_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated discretized + Fourier transformed gradient relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol_prev : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charge values on the computational grid. Parameter in + the iterative method.Pre-allocated,but empty. Changedin-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charges on the computational grid. Parameter in the iterative + method, updating the next quess in solving for the electrostatic potential. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all + MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + elec_field_contrib : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing + :math:`|\\mathbf{E(r)}|^2/\\phi_{0}` on the computational grid. + Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + psi : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic potential + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + Vbar_elec : mesh.pm.RealField + Pmesh :code:`RealField` object for storing functional derivatives of + :math:`\\|w(\\{ \\phi \\})_{elec}`on the computational grid. + Pre-allocated, but empty. Changed in-place. Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + Vbar_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated functional + derivatives of :math:`\\|w(\\{ \\phi \\})_{elec}` in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + force_mesh_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic force values + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + force_mesh_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated electrostatic + force values in reciprocal space on the computational grid. Local for + each MPI rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + layouts: list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + comm: mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + compute_field_energy_q_GPE: + Compute the electrostatic energy after electrosatic force is + calculated for a variable (anisotropic) dielectric general Poisson equation. + """ + + ## basic setup + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + ## old protocol in gen_qe_hpf_use_self + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) ## + ## scale and fft + ## old protocol in gen_qe_hpf_use_self + phi_q /= volume_per_cell + phi_q.r2c(out=phi_q_fourier) + + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + ## ^------ use the same gaussian as the \kai interaciton + phi_q_fourier.c2r(out=phi_q) ## this phi_q is after applying the smearing function + + denom_phi_tot = pm.create("real", value=0.0) + num_types = pm.create("real", value=0.0) + ### ^ ----- Calculate the relative dielectric (permittivity) to field + ### ------- from a mean contribution of particle number densities + + for t_ in range(config.n_types): + num_types = num_types + (config.dielectric_type[t_]) * phi[t_] + denom_phi_tot = denom_phi_tot + phi[t_] + + np.divide(num_types, denom_phi_tot, where=np.abs(denom_phi_tot > 1e-6), out=phi_eps) + + phi_eps.r2c(out=phi_eps_fourier) # FFT dielectric + + # phi_q_eps = (phi_q/phi_eps) + np.divide(phi_q, phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_q) + + _SPACE_DIM = 3 + ##^--------- constants needed throughout the calculations + + ### method for finding the gradient (fourier space), using the spatial dimension of k + for _d in np.arange(_SPACE_DIM): + + def gradient_transfer_function(k, x, d=_d): + return 1j * k[d] * x + + phi_eps_fourier.apply(gradient_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=phi_eta[_d]) + np.divide(phi_eta[_d], phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_eta[_d]) + + ### iterative GPE solver ### + ### ---------------------------------------------- + max_iter = 100 + i = 0 + delta = 1.0 + # phi_pol_prev = pm.create("real", value = 0.0) + ### ^------ set to zero before each iterative procedure or soft start + conv_criteria = config.conv_crit # conv. criteria (default 1e-6) + w = config.pol_mixing # polarization mixing param (default 0.6) + while i < max_iter and delta > conv_criteria: + (phi_q + phi_pol_prev).r2c(out=phi_q_fourier) + for _d in np.arange(_SPACE_DIM): + + def iterate_apply_k_vec(k, additive_terms, d=_d): + return additive_terms * (-1j * k[d]) / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(iterate_apply_k_vec, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + + phi_pol = -( + phi_eta[0] * elec_field[0] + + phi_eta[1] * elec_field[1] + + phi_eta[2] * elec_field[2] + ) + ### ^-- Following a negative sign convention (-ik) of the FT, a neg sign is + ### --- mathematically correct by the definition of the GPE (double - -> +) + phi_pol = w * phi_pol + (1.0 - w) * phi_pol_prev + diff = np.abs(phi_pol - phi_pol_prev) + delta = conv_fun(comm, diff) # decided from toml input + phi_pol_prev = phi_pol.copy() + i = i + 1 + # print("Stopping after iteration {:d} with stop crit {:.2e}, delta {:.2e}".format(i,conv_criteria,delta)) + + # compute_potential = True + def k_norm_divide(k, potential): + return potential / k.normp(p=2, zeromode=1) + + ## > Electrostatic potential + eps0_inv = config.coulomb_constant * 4 * np.pi + ## ^ the 1/(4pi eps0)*4*pi = 1/eps0 + ((eps0_inv) * (phi_q + phi_pol)).r2c(out=phi_q_fourier) + phi_q_fourier.apply(k_norm_divide, out=phi_q_fourier) + phi_q_fourier.c2r(out=psi) + ### ^ electrostatic potential for the GPE + + for _d in np.arange(_SPACE_DIM): + + def field_transfer_function(k, x, d=_d): + return ( + -1j * k[d] * x + ) ## negative sign relation, due to E = - nabla psi relation + + phi_q_fourier.apply(field_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + ## ^-------- Method: Obtaining the electric field from electrostatic potential + ## Assuming the electric field is conserved. + ## Assumption holds if no magnetic flux (magnetic induced fields) + + ############## Obtain forces ############## + elec_dot = ( + elec_field[0] * elec_field[0] + + elec_field[1] * elec_field[1] + + elec_field[2] * elec_field[2] + ) + # needed for energy calculations + + np.divide( + elec_dot, + denom_phi_tot, + where=np.abs(denom_phi_tot > 1e-6), + out=elec_field_contrib, + ) + + eps0_inv = config.coulomb_constant * 4 * np.pi + + for t_ in range(config.n_types): + Vbar_elec[t_] = ( + config.type_charges[t_] * psi + - (0.5 / eps0_inv) + * (config.dielectric_type[t_] - phi_eps) + * elec_field_contrib + ) + + # Obtain Vext,k + for t_ in range(config.n_types): + Vbar_elec[t_].r2c(out=Vbar_elec_fourier[t_]) + Vbar_elec_fourier[t_].apply(hamiltonian.H, out=Vbar_elec_fourier[t_]) + + # force terms + # F = - grad Vext + for t_ in range(config.n_types): + for _d in np.arange(_SPACE_DIM): + + def force_transfer_function(k, x, d=_d): + return -1j * k[_d] * x ## negative gradient + + Vbar_elec_fourier[t_].apply( + force_transfer_function, out=force_mesh_elec_fourier[t_][_d] + ) + force_mesh_elec_fourier[t_][_d].c2r(out=force_mesh_elec[t_][_d]) + elec_forces[types == t_, _d] = force_mesh_elec[t_][_d].readout( + positions[types == t_], layout=layouts[t_] + ) + + return Vbar_elec, phi_eps, elec_dot
+ + +
[docs]def domain_decomposition( + positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=MPI.COMM_WORLD +): + """Performs domain decomposition + + Rearranges the MPI rank memory layout into one that better mimics the PFFT + pencil grid 2D decomposition. As molecules are always required to be fully + contained on a single MPI rank, a perfect decomposition is not always + possible. The best decomposition which leaves the center of mass of all + molecules in their respective correct domains is used, with possible + overlap into neighbouring domains if the spatial extent of any molecule + crosses domain boundaries. + + Parameters + ---------- + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + *args + Variable length argument list containing arrays to include in the + domain decomposition. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + bonds : (N,M) numpy.ndarray, optional + Array of :code:`M` bonds originating from each of :code:`N` particles. + verbose : int, optional + Specify the logging event verbosity of this function. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + Domain decomposed :code:`positions` and any array specified in + :code:`*args`, in addition to :code:`bonds` and :code:`molecules` if these + arrays were provided as input. + """ + if molecules is not None: + if not topol: + assert bonds is not None, "bonds must be provided with molecules" + unique_molecules = np.sort(np.unique(molecules)) + molecules_com = np.empty_like(positions) + for m in unique_molecules: + ind = molecules == m + r = positions[ind, :][0, :] + molecules_com[ind, :] = r + layout = pm.decompose(molecules_com, smoothing=0) + if not topol: + args = (*args, bonds, molecules) + else: + args = (*args, molecules) + else: + layout = pm.decompose(positions, smoothing=0) + if verbose > 1: + Logger.rank0.log( + logging.INFO, + "DOMAIN_DECOMP: Total number of particles to be exchanged = %d", + np.sum(layout.get_exchange_cost()), + ) + return layout.exchange(positions, *args)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/_modules/hymd/file_io.html b/v1.0.8/_modules/hymd/file_io.html new file mode 100644 index 00000000..48254962 --- /dev/null +++ b/v1.0.8/_modules/hymd/file_io.html @@ -0,0 +1,1149 @@ + + + + + + hymd.file_io — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.file_io

+"""Handle file input/output in parllel HDF5 fashion
+"""
+import numpy as np
+import h5py
+import os
+import logging
+import getpass
+from mpi4py import MPI
+from .logger import Logger, get_version
+
+
+
[docs]class OutDataset: + """HDF5 dataset handler for file output""" + + def __init__( + self, + dest_directory, + config, + double_out=False, + disable_mpio=False, + comm=MPI.COMM_WORLD, + ): + """Constructor + + Parameters + ---------- + dest_directory : str + Ouput directory for saving data. + config : Config + Configuration object. + double_out : bool, optional + If :code:`True`, the output HDF5 objects are written in eight byte + floating point representation. Otherwise, four byte single + precision is used. + disable_mpio : bool, optional + If :code:`True`, disables parallel MPI-enabled HDF5 file output. + This is a compatibility option used if HDF5 is not compiled with + MPI support. This makes everything much harder by splitting all + output in one file per MPI rank, and having an MPI-enabled HDF5 + library is **highly recommended**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + """ + self.disable_mpio = disable_mpio + self.config = config + if double_out: + self.float_dtype = "float64" + else: + self.float_dtype = "float32" + + if disable_mpio: + self.file = h5py.File( + os.path.join( + dest_directory, f"sim.hdf5-{comm.rank:6d}-of-{comm.size:6d}" + ), + "w", + ) + else: + self.file = h5py.File( + os.path.join(dest_directory, "sim.H5"), "w", driver="mpio", comm=comm + ) + +
[docs] def is_open(self, comm=MPI.COMM_WORLD): + """Check if HDF5 output file is open + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + return self.file.__bool__()
+ +
[docs] def close_file(self, comm=MPI.COMM_WORLD): + """Closes the HDF5 output file + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + self.file.close()
+ +
[docs] def flush(self): + """Flushes output buffers, forcing file writes""" + self.file.flush()
+ + +
[docs]def setup_time_dependent_element( + name, parent_group, n_frames, shape, dtype, units=None +): + """Helper function for setting up time-dependent HDF5 group datasets + + All output groups must adhere to the H5MD standard, meaning a structure of + + + | ┗━ **group** particle group (e.g. :code:`all`) or :code:`observables` group + | ┗━ **group** time-dependent data + | ┣━ **dataset** :code:`step` :code:`shape=(n_frames,)` + | ┣━ **dataset** :code:`time` :code:`shape=(n_frames,)` + | ┗━ **dataset** :code:`value` :code:`shape=(n_frames, *)` + + is necessary. + + References + ---------- + H5MD specification : + https://www.nongnu.org/h5md/h5md.html + """ # noqa: E501 + group = parent_group.create_group(name) + step = group.create_dataset("step", (n_frames,), "int32") + time = group.create_dataset("time", (n_frames,), "float32") + value = group.create_dataset("value", (n_frames, *shape), dtype) + + if units is not None: + value.attrs["unit"] = units + time.attrs["unit"] = "ps" + return group, step, time, value
+ + +
[docs]def store_static( + h5md, + rank_range, + names, + types, + indices, + config, + bonds_2_atom1, + bonds_2_atom2, + molecules=None, + velocity_out=False, + force_out=False, + charges=False, + dielectrics=False, + plumed_out=False, + comm=MPI.COMM_WORLD, +): + """Outputs all static time-independent quantities to the HDF5 output file + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + rank_range : list[int] + Start and end indices for global arrays for each MPI rank. + names : (N,) numpy.ndarray + Array of names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of type indices for :code:`N` particles. + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + config : Config + Configuration object. + bonds_2_atom1 : (B,) numpy.ndarray + Array of indices of the first particle for :code:`B` total + two-particle bonds. + bonds_2_atom2 : (B,) numpy.ndarray + Array of indices of the second particle for :code:`B` total + two-particle bonds. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. + dielectrics : (N,) numpy.ndarray + Array of particle relative dielectric values for :code:`N` particles. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to output HDF5 file. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + prepare_bonds : + Constructs two-, three-, and four-particle bonds from toplogy input + file and bond configuration information. + distribute_input : + Distributes input arrays onto MPI ranks, attempting load balancing. + """ + dtype = h5md.float_dtype + + h5md_group = h5md.file.create_group("/h5md") + h5md.h5md_group = h5md_group + h5md.observables = h5md.file.create_group("/observables") + h5md.connectivity = h5md.file.create_group("/connectivity") + h5md.parameters = h5md.file.create_group("/parameters") + + h5md_group.attrs["version"] = np.array([1, 1], dtype=int) + author_group = h5md_group.create_group("author") + author_group.attrs["name"] = np.string_(getpass.getuser()) + creator_group = h5md_group.create_group("creator") + creator_group.attrs["name"] = np.string_("Hylleraas MD") + + # Get HyMD version + creator_group.attrs["version"] = np.string_(get_version()) + + h5md.particles_group = h5md.file.create_group("/particles") + h5md.all_particles = h5md.particles_group.create_group("all") + mass = h5md.all_particles.create_dataset("mass", (config.n_particles,), dtype) + mass[...] = config.mass + + if charges is not False: + charge = h5md.all_particles.create_dataset( + "charge", (config.n_particles,), dtype="float32" + ) + charge[indices] = charges + if dielectrics is not False: + dielectric = h5md.all_particles.create_dataset( + "dielectric", (config.n_particles,), dtype="float32" + ) + dielectric[indices] = dielectrics + + box = h5md.all_particles.create_group("box") + box.attrs["dimension"] = 3 + box.attrs["boundary"] = np.array( + [np.string_(s) for s in 3 * ["periodic"]], dtype="S8" + ) + + n_frames = config.n_steps // config.n_print + if np.mod(config.n_steps - 1, config.n_print) != 0: + n_frames += 1 + if np.mod(config.n_steps, config.n_print) == 1: + n_frames += 1 + if n_frames == config.n_steps: + n_frames += 1 + + species = h5md.all_particles.create_dataset( + "species", + (config.n_particles,), + dtype="i", + ) + + ( + _, + h5md.positions_step, + h5md.positions_time, + h5md.positions, + ) = setup_time_dependent_element( + "position", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm", + ) + if velocity_out: + ( + _, + h5md.velocities_step, + h5md.velocities_time, + h5md.velocities, + ) = setup_time_dependent_element( + "velocity", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm ps-1", + ) + if force_out: + ( + _, + h5md.forces_step, + h5md.forces_time, + h5md.forces, + ) = setup_time_dependent_element( + "force", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="kJ mol-1 nm-1", + ) + ( + _, + h5md.total_energy_step, + h5md.total_energy_time, + h5md.total_energy, + ) = setup_time_dependent_element( + "total_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.kinetc_energy_step, + h5md.kinetc_energy_time, + h5md.kinetc_energy, + ) = setup_time_dependent_element( + "kinetic_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.potential_energy_step, + h5md.potential_energy_time, + h5md.potential_energy, + ) = setup_time_dependent_element( + "potential_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.bond_energy_step, + h5md.bond_energy_time, + h5md.bond_energy, + ) = setup_time_dependent_element( + "bond_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.angle_energy_step, + h5md.angle_energy_time, + h5md.angle_energy, + ) = setup_time_dependent_element( + "angle_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.dihedral_energy_step, + h5md.dihedral_energy_time, + h5md.dihedral_energy, + ) = setup_time_dependent_element( + "dihedral_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.field_energy_step, + h5md.field_energy_time, + h5md.field_energy, + ) = setup_time_dependent_element( + "field_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + if charges is not False: + ( + _, + h5md.field_q_energy_step, + h5md.field_q_energy_time, + h5md.field_q_energy, + ) = setup_time_dependent_element( + "field_q_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) # <-------- xinmeng + if plumed_out is not False: + ( + _, + h5md.plumed_bias_step, + h5md.plumed_bias_time, + h5md.plumed_bias, + ) = setup_time_dependent_element( + "plumed_bias", h5md.observables, n_frames, (1,), dtype, units="kJ mol-1" # noqa: E501 + ) + ( + _, + h5md.total_momentum_step, + h5md.total_momentum_time, + h5md.total_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "total_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm g ps-1 mol-1", + ) + ( + _, + h5md.angular_momentum_step, + h5md.angular_momentum_time, + h5md.angular_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "angular_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm+2 g ps-1 mol-1", + ) + ( + _, + h5md.torque_step, + h5md.torque_time, + h5md.torque, + ) = setup_time_dependent_element( # noqa: E501 + "torque", + h5md.observables, + n_frames, + (3,), + dtype, + units="kJ nm+2 mol-1", + ) + ( + _, + h5md.temperature_step, + h5md.temperature_time, + h5md.temperature, + ) = setup_time_dependent_element( + "temperature", h5md.observables, n_frames, (3,), dtype, units="K" + ) + ( + _, + h5md.thermostat_work_step, + h5md.thermostat_work_time, + h5md.thermostat_work, + ) = setup_time_dependent_element( + "thermostat_work", + h5md.observables, + n_frames, + (1,), + "float32", + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.pressure_step, + h5md.pressure_time, + h5md.pressure, + ) = setup_time_dependent_element( + "pressure", h5md.observables, n_frames, (18,), "float32", units="Bar" + ) + (_, h5md.box_step, h5md.box_time, h5md.box_value,) = setup_time_dependent_element( + "edges", box, n_frames, (3, 3), "float32", units="nm" + ) + + ind_sort = np.argsort(indices) + for i in ind_sort: + species[indices[i]] = config.name_to_type_map[names[i].decode("utf-8")] + + h5md.parameters.attrs["config.toml"] = np.string_(str(config)) + vmd_group = h5md.parameters.create_group("vmd_structure") + index_of_species = vmd_group.create_dataset( + "indexOfSpecies", (config.n_types,), "i" + ) + index_of_species[:] = np.array(list(range(config.n_types))) + + # VMD-h5mdplugin maximum name/type name length is 16 characters (for + # whatever reason [VMD internals?]). + name_dataset = vmd_group.create_dataset("name", (config.n_types,), "S16") + type_dataset = vmd_group.create_dataset("type", (config.n_types,), "S16") + if molecules is not None: + resid_dataset = vmd_group.create_dataset( + "resid", + (config.n_particles,), + "i", + ) + + # Change this + for i, n in config.type_to_name_map.items(): + name_dataset[i] = np.string_(n[:16]) + if n == "W": + type_dataset[i] = np.string_("solvent") + else: + type_dataset[i] = np.string_("membrane") + + total_bonds = comm.allreduce(len(bonds_2_atom1), MPI.SUM) + n_bonds_local = len(bonds_2_atom1) + + receive_buffer = comm.gather(n_bonds_local, root=0) + n_bonds_global = None + if comm.Get_rank() == 0: + n_bonds_global = receive_buffer + n_bonds_global = np.array(comm.bcast(n_bonds_global, root=0)) + rank_bond_start = np.sum(n_bonds_global[: comm.Get_rank()]) + + bonds_from = vmd_group.create_dataset("bond_from", (total_bonds,), "i") + bonds_to = vmd_group.create_dataset("bond_to", (total_bonds,), "i") + for i in range(n_bonds_local): + a = bonds_2_atom1[i] + b = bonds_2_atom2[i] + bonds_from[rank_bond_start + i] = indices[a] + 1 + bonds_to[rank_bond_start + i] = indices[b] + 1 + + if molecules is not None: + resid_dataset[indices[ind_sort]] = molecules
+ + +# store data old vs +""" +h5md, step, frame, indices, positions, velocities, forces, box_size, +temperature, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, +field_energy, field_q_energy, time_step, config, velocity_out=False, +force_out=False, charge_out=False, dump_per_particle=False, +""" + + +
[docs]def store_data( + h5md, + step, + frame, + indices, + positions, + velocities, + forces, + box_size, + temperature, + pressure, + kinetic_energy, + bond2_energy, + bond3_energy, + bond4_energy, + field_energy, + field_q_energy, + plumed_bias, + time_step, + config, + velocity_out=False, + force_out=False, + charge_out=False, + plumed_out=False, + dump_per_particle=False, + comm=MPI.COMM_WORLD, +): + """Writes time-step data to HDF5 output file + + Handles all quantities which change during simulation, as opposed to + static quanitities (see :code:`store_static`). + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + step : int + Step number. + frame : int + Output frame number (:code:`step // n_print`). + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + positions : (N,) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + velocities : (N,) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + forces : (N,) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. + box_size : (D,) numpy.ndarray + Array containing the simulation box size. + temperature : float + Calculated instantaneous temperature. + kinetic_energy : float + Calculated instantaneous kinetic energy. + bond2_energy : float + Calculated instantaneous harmonic two-particle bond energy. + bond3_energy : float + Calculated instantaneous harmonic angular three-particle bond energy. + bond4_energy : float + Calculated instantaneous dihedral four-particle torsion energy. + field_energy : float + Calculated instantaneous particle-field energy. + field_q_energy : float + Calculated instantaneous electrostatic energy. + plumed_bias : float + PLUMED instantaneous bias energy. + time_step : float + Value of the time step. + config : Config + Configuration object. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charge_out : bool, optional + If :code:`True`, electrostatic energies are written to the output + HDF5 file. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to the output HDF5 file. + dump_per_particle : bool, optional + If :code:`True`, all quantities are written **per particle**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + store_static : + Outputs all static time-independent quantities to the HDF5 output file + """ + for dset in ( + h5md.positions_step, + h5md.total_energy_step, + h5md.potential_energy_step, + h5md.kinetc_energy_step, + h5md.bond_energy_step, + h5md.angle_energy_step, + h5md.dihedral_energy_step, + h5md.field_energy_step, + h5md.total_momentum_step, + h5md.angular_momentum_step, + h5md.torque_step, + h5md.temperature_step, + h5md.pressure_step, + h5md.box_step, + h5md.thermostat_work_step, + ): + dset[frame] = step + + for dset in ( + h5md.positions_time, + h5md.total_energy_time, + h5md.potential_energy_time, + h5md.kinetc_energy_time, + h5md.bond_energy_time, + h5md.angle_energy_time, + h5md.dihedral_energy_time, + h5md.field_energy_time, + h5md.total_momentum_time, + h5md.angular_momentum_time, + h5md.torque_time, + h5md.temperature_time, + h5md.pressure_time, + h5md.box_time, + h5md.thermostat_work_time, + ): + dset[frame] = step * time_step + + if velocity_out: + h5md.velocities_step[frame] = step + h5md.velocities_time[frame] = step * time_step + if force_out: + h5md.forces_step[frame] = step + h5md.forces_time[frame] = step * time_step + if charge_out: + h5md.field_q_energy_step[frame] = step + h5md.field_q_energy_time[frame] = step * time_step + if plumed_out: + h5md.plumed_bias_step[frame] = step + h5md.plumed_bias_time[frame] = step * time_step + + ind_sort = np.argsort(indices) + h5md.positions[frame, indices[ind_sort]] = positions[ind_sort] + + if velocity_out: + h5md.velocities[frame, indices[ind_sort]] = velocities[ind_sort] + if force_out: + h5md.forces[frame, indices[ind_sort]] = forces[ind_sort] + if charge_out: + h5md.field_q_energy[frame] = field_q_energy + if plumed_out: + h5md.plumed_bias[frame] = plumed_bias + + potential_energy = ( + bond2_energy + bond3_energy + bond4_energy + field_energy + field_q_energy + ) + + total_momentum = config.mass * comm.allreduce(np.sum(velocities, axis=0), MPI.SUM) + angular_momentum = config.mass * comm.allreduce( + np.sum(np.cross(positions, velocities), axis=0), MPI.SUM + ) + torque = config.mass * comm.allreduce( + np.sum(np.cross(positions, forces), axis=0), MPI.SUM + ) + h5md.total_energy[frame] = kinetic_energy + potential_energy + h5md.potential_energy[frame] = potential_energy + h5md.kinetc_energy[frame] = kinetic_energy + h5md.bond_energy[frame] = bond2_energy + h5md.angle_energy[frame] = bond3_energy + h5md.dihedral_energy[frame] = bond4_energy + h5md.field_energy[frame] = field_energy + h5md.total_momentum[frame, :] = total_momentum + h5md.angular_momentum[frame, :] = angular_momentum + h5md.torque[frame, :] = torque + h5md.temperature[frame] = temperature + h5md.pressure[frame] = pressure + for d in range(3): + h5md.box_value[frame, d, d] = box_size[d] + h5md.thermostat_work[frame] = config.thermostat_work + + fmt_ = [ + "step", + "time", + "temp", + "tot E", + "kin E", + "pot E", + "field E", + "elec E", + "bond E", + "ang E", + "dih E", + "bias E", + "Px", + "Py", + "Pz", + "ΔH" if config.target_temperature else "ΔE", + ] + fmt_ = np.array(fmt_) + + # create mask to show only energies != 0 + en_array = np.array([ + field_energy, + field_q_energy, + bond2_energy, + bond3_energy, + bond4_energy, + plumed_bias, + ]) + mask = np.full_like(fmt_, True, dtype=bool) + mask[range(6,12)] = en_array != 0. + + header_ = fmt_[mask].shape[0] * "{:>13}" + if config.initial_energy is None: + fmt_[-1] = "" + + divide_by = 1.0 + if dump_per_particle: + for i in range(3, 9): + fmt_[i] = fmt_[i][:-2] + "E/N" + fmt_[-1] += "/N" + divide_by = config.n_particles + total_energy = kinetic_energy + potential_energy + if config.initial_energy is not None: + if config.target_temperature: + H_tilde = total_energy - config.initial_energy - config.thermostat_work + else: + H_tilde = total_energy - config.initial_energy + else: + H_tilde = 0.0 + + header = header_.format(*fmt_[mask]) + data_fmt = f'{"{:13}"}{(fmt_[mask].shape[0]-1) * "{:13.5g}" }' + all_data = [ + step, + time_step * step, + temperature, + total_energy / divide_by, + kinetic_energy / divide_by, + potential_energy / divide_by, + field_energy / divide_by, + field_q_energy / divide_by, + bond2_energy / divide_by, + bond3_energy / divide_by, + bond4_energy / divide_by, + plumed_bias / divide_by, + total_momentum[0] / divide_by, + total_momentum[1] / divide_by, + total_momentum[2] / divide_by, + H_tilde / divide_by, + ] + data = data_fmt.format(*[val for i, val in enumerate(all_data) if mask[i]]) + Logger.rank0.log(logging.INFO, ("\n" + header + "\n" + data))
+ + +
[docs]def distribute_input( + in_file, rank, size, n_particles, max_molecule_size=201, comm=MPI.COMM_WORLD +): + """Assign global arrays onto MPI ranks, attempting load balancing + + Distributes approximately equal numbers of particles (workload) onto each + independent MPI rank, while respecting the requirement that any molecule + must be fully contained on a single MPI rank only (no splitting molecules + across multiple CPUs). + + Parameters + ---------- + in_file : h5py.File + HDF5 input file object. + rank : int + Local rank number for this MPI rank. + size : int + Global size of the MPI communicator (number of total CPUs). + n_particles : int + Total number of particles. + max_molecule_size : int, optional + Maximum size of any molecule present in the system. Used to initially + guess where the MPI rank boundaries (start/end indices) in the global + arrays should be placed. If molecules of size + :code:`>max_molecule_size` exist in the simulation system, HyMD + **might** work as expected. Or it might fail spectacularly. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + rank_range : + Starting and ending indices in the global arrays for each MPI rank. + """ + if n_particles is None: + n_particles = len(in_file["indices"]) + np_per_MPI = n_particles // size + + molecules_flag = False + if "molecules" in in_file: + molecules_flag = True + + if not molecules_flag: + if rank == size - 1: + np_cum_mpi = [rank * np_per_MPI, n_particles] + else: + np_cum_mpi = [rank * np_per_MPI, (rank + 1) * np_per_MPI] + p_mpi_range = list(range(np_cum_mpi[0], np_cum_mpi[1])) + return p_mpi_range, molecules_flag + + # To avoid splitting molecules across multiple different ranks, we need + # to read in some extra indices before/after the expected break points + # and iterate until we find a molecule break. + # + # Implicitly assuming no molecule is bigger than + # min(max_molecule_size, n_particles // n_MPI_ranks) atoms. + max_molecule_size += 2 + grab_extra = max_molecule_size if np_per_MPI > max_molecule_size else np_per_MPI + if rank == 0: + mpi_range_start = 0 + if size == 1: + mpi_range_end = n_particles + else: + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + elif rank == size - 1: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = n_particles + else: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + + molecules = in_file["molecules"][mpi_range_start:mpi_range_end] + indices = in_file["indices"][mpi_range_start:mpi_range_end] + molecule_end_indices = np.nonzero(np.diff(molecules))[0] + + p_mpi_range = [None, None] + if rank == 0: + p_mpi_range[0] = 0 + if size == 1: + p_mpi_range[1] = n_particles + else: + p_mpi_range[1] = indices[ + molecule_end_indices[molecule_end_indices >= np_per_MPI][0] + 1 + ] + elif rank == size - 1: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = n_particles + else: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = ( + indices[molecule_end_indices[molecule_end_indices > np_per_MPI][0]] + + 1 # noqa: E501 + ) + return list(range(p_mpi_range[0], p_mpi_range[1])), molecules_flag
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/_modules/hymd/force.html b/v1.0.8/_modules/hymd/force.html new file mode 100644 index 00000000..4b86bf2b --- /dev/null +++ b/v1.0.8/_modules/hymd/force.html @@ -0,0 +1,1152 @@ + + + + + + hymd.force — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.force

+"""Calculates intramolecular forces between bonded particles in molecules
+"""
+import numpy as np
+import networkx as nx
+from dataclasses import dataclass
+
+# Imported here so we can call from force import compute_bond_forces__fortran
+from force_kernels import cbf as compute_bond_forces__fortran  # noqa: F401
+from force_kernels import (  # noqa: F401
+    caf as compute_angle_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cdf as compute_dihedral_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cbf_d as compute_bond_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    caf_d as compute_angle_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    cdf_d as compute_dihedral_forces__fortran__double,
+)
+
+
+
[docs]@dataclass # might not be needed +class Dielectric_type: + atom_1: str + dielectric_value: float
+ + +
[docs]@dataclass +class Bond: + """Dataclass representing a single two-particle bond type + + A `bond type` is a bond strength and equilibrium distance associated with + any bond between particles of specific types :code:`A` and :code:`B` + (where :code:`A` and :code:`B` may be the same or different). Harmonic + two-particle bonds in HyMD take the form + + .. math:: + + V_2(\\mathbf{r}_1, \\mathbf{r}_2) = + \\frac{1}{2}k + \\left( + \\vert \\mathbf{r}_1 - \\mathbf{r}_2 \\vert - r_0 + \\right)^2, + + where :math:`k` is the bond strength (spring constant) and :math:`r_0` is + the equilibrium bond length (at which the energy is zero). + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + equilibrium : float + Equilibrium distance at which the energy associated with the bond + vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient (spring constant). + """ + + atom_1: str + atom_2: str + equilibrium: float + strength: float
+ + +
[docs]@dataclass +class Angle(Bond): + """Dataclass representing a single three-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any three-particle bond between particles of specific types :code:`A`, + :code:`B`, and :code:`C` (where :code:`A`, :code:`B`, and :code:`C` may be + different or the same). Harmonic angular three-particle bonds in HyMD take + the form + + .. math:: + + V_3(\\mathbf{r}_1, \\mathbf{r}_2, \\mathbf{r}_3) = + \\frac{1}{2}k + \\left( + \\cos^{-1} + \\left[ + \\frac{ + (\\mathbf{r}_1-\\mathbf{r}_2) + \\cdot + (\\mathbf{r}_3-\\mathbf{r}_2) + } + { + \\vert\\mathbf{r}_1-\\mathbf{r}_2\\vert + \\vert\\mathbf{r}_3-\\mathbf{r}_2\\vert + } + \\right] - \\theta_0 + \\right)^2 + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + equilibrium : float + Equilibrium angle at which the energy associated with the + three-particle angular bond vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient. + + See also + -------- + Bond : + Two-particle bond type dataclass + """ + + atom_3: str
+ + +
[docs]@dataclass +class Dihedral: + """Dataclass representing a single four-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any four-particle torsional bond between particles of specific types + :code:`A`, :code:`B`, :code:`C`, and :code:`D` (where :code:`A`, :code:`B`, + :code:`C`, and :code:`D` may be different or the same). Dihedral + four-particle bonds in HyMD take different forms depending on the + :code:`dih_type` parameter. + + In the following, let :math:`\\phi` denote the angle between the planes + spanned by the relative positions of atoms :code:`A`-:code:`B`-:code:`C` + and :code:`B`-:code:`C`-:code:`D`. If :code:`dih_type = 0`, then + + .. math:: + + V_4(\\phi) = \\sum_n c_n + \\left( + 1 + \\cos\\left[ + n\\phi - d_n + \\right] + \\right), + + where :math:`c_n` are energy coefficients and :math:`d_n` are propensity + phases. By default, the cosine sum is truncated at five terms. If + :code:`coeffs` provides only a single float, this is used as the coiling + propensity parameter :math:`\\lambda`. In this case, :math:`c_n` and + :math:`d_n` are automatically set to values which promote alpha helical + (:math:`\\lambda=-1`), beta sheet (:math:`\\lambda=1`), or a mixed + (:math:`1>\\lambda>-1`) structure (using values provided by Bore et al. + (2018)). In this case, the full potential takes the form + + .. math:: + + V_4(\\phi;\\lambda) = + \\frac{1}{2}(1-\\lambda) V_{\\text{prop},\\alpha}(\\phi) + + + \\frac{1}{2}(1+\\lambda) V_{\\text{prop},\\beta}(\\phi) + + + (1-\\vert\\lambda\\vert) V_{\\text{prop}, \\text{coil}}(\\phi), + + with each of the :math:`V_{\\mathrm{prop}, X}` being fixed cosine series + potentials with pre-set :math:`c_n` -s and :math:`d_n` -s. + + If :code:`dih_type = 1`, then a combined bending torsional (CBT) potential + is employed, + + .. math:: + + V_4(\\phi,\\gamma;\\lambda) = + V_4(\\phi;\\lambda) + + + \\frac{1}{2}K(\\phi)(\\gamma - \\gamma_0)^2, + + where :math:`V_4(\\phi;\\lambda)` specifies the potential as given by the + coiling propensity parameter above, :math:`K(\\phi)` is a separate cosine + series potential acting as the angular three-particle bond strength, and + :math:`\\gamma_0` is the three-particle bond equilibrium angle. In this + case, the :code:`coeffs` parameter must specify *both* a :math:`\\lambda` + value, in additon to the energy and phases dictating the :math:`K(\\phi)` + potential. + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + atom_4 : str + Type name of particle 4. + coeffs : list[list[float]] or list[float] or numpy.ndarray + Dihedral coefficients defining the series expansion of the dihedral + energy. + dih_type : int + Specifies the type of dihedral used; If :code:`0`, then :code:`coeffs` + must contain **either** two lists of five energy coefficients + :math:`c_n` and five propensity phases :math:`d_n` **or** a single + floating point number defining the :math:`\\lambda` coiling propensity + parameter. If :code:`1`, the combined bending-torsional potential is + used, and :code:`coeffs` must specify :math:`\\lambda` *and* two lists + containing energy coefficients and propensity phases for the + :math:`V_\\text{prop}` propensity potential, defined in terms of cosine + series. + + References + ---------- + Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018. + """ + + atom_1: str + atom_2: str + atom_3: str + atom_4: str + coeffs: np.ndarray + dih_type: int
+ + +
[docs]@dataclass +class Chi: + """Dataclass representing a single :math:`\\chi` mixing interaction type + + An `interaction mixing energy type` is a mixing energy associated with + density overlap between species of types :code:`A` and :code:`B` + (specified as inputs :code:`atom_1` and :code:`atom_2`). A positive mixing + energy promotes phase separation, a negative mixing energy promotes mixing. + The interaction energy density (provided the :code:`DefaultWithChi` + Hamiltonian is used) takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} + \\sum_{k,l}\\chi_{k,l} \\tilde\\phi_k\\tilde\\phi_l, + + where :math:`\\chi_{k,l}` denotes the mixing energy between species + :math:`k` and :math:`l`, with :math:`\\kappa` being the incompressibility. + The value of the interaction mixing energy parameter may be extracted from + `Flory-Huggins theory`_. + + .. _`Flory-Huggins theory`: + https://en.wikipedia.org/wiki/Flory%E2%80%93Huggins_solution_theory + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + interaction_energy : float + Interaction mixing energy. + + See also + -------- + hymd.hamiltonian.DefaultWithChi : + Interaction energy functional using :math:`\\chi`-interactions. + """ + + atom_1: str + atom_2: str + interaction_energy: float
+ + +
[docs]def find_all_paths(G, u, n): + """Helper function that recursively finds all paths of given lenght 'n + 1' inside a network 'G'. + Adapted from https://stackoverflow.com/a/28103735.""" + if n == 0: + return [[u]] + paths = [] + for neighbor in G.neighbors(u): + for path in find_all_paths(G, neighbor, n - 1): + if u not in path: + paths.append([u] + path) + return paths
+ + +
[docs]def propensity_potential_coeffs(x: float): + alpha_coeffs = np.array( + [ + [7.406, -5.298, -2.570, 1.336, 0.739], + [-0.28632126, 1.2099146, 1.18122138, 0.49075168, 0.98495911], + ] + ) + beta_coeffs = np.array( + [ + [3.770, 5.929, -4.151, -0.846, 0.190], + [-0.2300693, -0.0583289, 0.99342396, 1.03237971, 2.90160988], + ] + ) + coil_coeffs = np.array( + [ + [1.416, -0.739, 0.990, -0.397, 0.136], + [1.3495933, 0.45649087, 2.30441057, -0.12274901, -0.26179939], + ] + ) + + zero_add = np.zeros((2, 5)) + if np.isclose(x, -1): + return np.concatenate((alpha_coeffs, zero_add)) + elif np.isclose(x, 0): + return np.concatenate((coil_coeffs, zero_add)) + elif np.isclose(x, 1): + return np.concatenate((beta_coeffs, zero_add)) + + abs_x = np.abs(x) + if abs_x > 1: + err_str = ( + f"The provided value of lambda = {x} is out of lambda definition range, " + f"[-1.0, 1.0]." + ) + Logger.rank0.log(logging.ERROR, err_str) + else: + coil_coeffs[0] *= 1 - abs_x + if x < 0: + alpha_coeffs[0] *= 0.5 * (abs_x - x) + return np.concatenate((alpha_coeffs, coil_coeffs)) + else: + beta_coeffs[0] *= 0.5 * (abs_x + x) + return np.concatenate((beta_coeffs, coil_coeffs))
+ + +
[docs]def prepare_bonds_old(molecules, names, bonds, indices, config): + """Find bonded interactions from connectivity and bond types information + + .. deprecated:: 1.0.0 + :code:`prepare_bonds_old` was replaced by :code:`prepare_bonds` for + use with compiled Fortran kernels prior to 1.0.0 release. + + Prepares the necessary equilibrium and bond strength information needed by + the intramolecular interaction functions. This is performed locally on each + MPI rank, as the domain decomposition ensures that for all molecules *all* + consituent particles are always contained on *the same* MPI rankself. + + This function traverses the bond connectivity information provided in the + structure/topology input file and indentifies any two-, three-, or + four-particle potential bonds. For each connected chain of two, three, or + four particles, a matching to bond types is attempted. If the corresponding + names match, a bond object is initialized. + + In order to investigate the connectivity, a graph is created using + networkx functionality. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2 : list + List of lists containing *local* particle indices, equilibrium + distance, and bond strength coefficient for each reconstructed + two-particle bond. + bonds_3 : + List of lists containing *local* particle indices, equilibrium angle, + and bond strength coefficient for each reconstructed three-particle + bond. + bonds_4 : + List of lists containing *local* particle indices, dihedral type index, + and dihedral coefficients for each reconstructed four-particle + torsional bond. + bb_index : list + List indicating the dihedral type of each four-particle bond in + :code:`bonds_4`. + + See also + -------- + Bond : + Two-particle bond type dataclass. + Angle : + Three-particle angular bond type dataclass. + Dihedral : + Four-particle torsional bond type dataclass. + hymd.input_parser.Config + Configuration dataclass handler. + """ + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + bb_index = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + bb_dihedral = 0 + bond_graph = nx.Graph() + + for local_index, global_index in enumerate(indices): + if molecules[local_index] != mol: + continue + + bond_graph.add_node( + global_index, + name=names[local_index].decode("UTF-8"), + local_index=local_index, + ) + for bond in [b for b in bonds[local_index] if b != -1]: + bond_graph.add_edge(global_index, bond) + + connectivity = nx.all_pairs_shortest_path(bond_graph) + for c in connectivity: + i = c[0] + connected = c[1] + for j, path in connected.items(): + if len(path) == 2 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for b in config.bonds: + match_forward = name_i == b.atom_1 and name_j == b.atom_2 + match_backward = name_i == b.atom_2 and name_j == b.atom_1 + if match_forward or match_backward: + bonds_2.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[j]["local_index"], + b.equilibrium, + b.strength, + ] + ) + + if len(path) == 3 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_mid = bond_graph.nodes()[path[1]]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for a in config.angle_bonds: + match_forward = ( + name_i == a.atom_1 + and name_mid == a.atom_2 + and name_j == a.atom_3 + ) + match_backward = ( + name_i == a.atom_3 + and name_mid == a.atom_2 + and name_j == a.atom_1 + ) + if match_forward or match_backward: + bonds_3.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[path[1]]["local_index"], + bond_graph.nodes()[j]["local_index"], + np.radians(a.equilibrium), + a.strength, + ] + ) + + all_paths_len_four = find_all_paths(bond_graph, i, 3) + for p in all_paths_len_four: + name_i = bond_graph.nodes()[i]["name"] + name_mid_1 = bond_graph.nodes()[p[1]]["name"] + name_mid_2 = bond_graph.nodes()[p[2]]["name"] + name_j = bond_graph.nodes()[p[3]]["name"] + + for a in config.dihedrals: + match_forward = ( + name_i == a.atom_1 + and name_mid_1 == a.atom_2 + and name_mid_2 == a.atom_3 + and name_j == a.atom_4 + ) + if ( + match_forward + and [ + bond_graph.nodes()[p[3]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[i]["local_index"], + a.coeffs, + a.dih_type, + ] + not in bonds_4 + ): + bonds_4.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[3]]["local_index"], + a.coeffs, + a.dih_type, + ] + ) + if a.dih_type == 1: + bb_dihedral = len(bonds_4) + + if bb_dihedral: + bb_index.append(bb_dihedral - 1) + + return bonds_2, bonds_3, bonds_4, bb_index
+ + +
[docs]def prepare_index_based_bonds(molecules, topol): + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + resid = mol + 1 + top_summary = topol["system"]["molecules"] + resname = None + test_mol_number = 0 + for molname in top_summary: + test_mol_number += molname[1] + if resid <= test_mol_number: + resname = molname[0] + break + + if resname is None: + break + + if "bonds" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for bond in topol[resname]["bonds"]: + index_i = bond[0] - 1 + first_id + index_j = bond[1] - 1 + first_id + # bond[2] is the bond type, inherited by the itp format. Not used + equilibrium = bond[3] + strength = bond[4] + bonds_2.append([index_i, index_j, equilibrium, strength]) + + if "angles" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["angles"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + # angle[3] is the angle type, inherited by the itp format. Not used + equilibrium = np.radians(angle[4]) + strength = angle[5] + bonds_3.append([index_i, index_j, index_k, equilibrium, strength]) + + if "dihedrals" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["dihedrals"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + index_l = angle[3] - 1 + first_id + dih_type = angle[4] + coeff = angle[5] + if dih_type == 0 and isinstance(coeff[0], (float, int)): + coeff = propensity_potential_coeffs(coeff[0]) + elif dih_type == 1 and len(coeff) == 3: + coeff = np.array( + propensity_potential_coeffs(coeff[0][0]).tolist() + + coeff[1:] + ) + elif dih_type == 2: + coeff = np.array(coeff) + else: + coeff = np.insert(np.array(coeff), 2, np.zeros((2, 5)), axis=0) + bonds_4.append([index_i, index_j, index_k, index_l, coeff, dih_type, 0]) + return bonds_2, bonds_3, bonds_4
+ + +
[docs]def prepare_bonds(molecules, names, bonds, indices, config, topol=None): + """Rearrange the bond information for usage in compiled Fortran kernels + + Restructures the lists resulting from the execution of + :code:`prepare_bonds_old` into numpy arrays suitable for calls to optimized + Fortran code calculating bonded forces and energiesself. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2_atom_1 : (B,) numpy.ndarray + Local index of particle 1 for each of :code:`B` constructed + two-particle bonds. + bonds_2_atom_2 : (B,) numpy.ndarray + Local index of particle 2 for each of :code:`B` constructed + two-particle bonds. + bonds_2_equilibrium : (B,) numpy.ndarray + Equilibrium distance for each of :code:`B` constructed two-particle + bonds. + bonds_2_strength : (B,) numpy.ndarray + Bond strength for each of :code:`B` constructed two-particle + bonds. + bonds_3_atom_1 : (A,) numpy.ndarray + Local index of particle 1 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_2 : (A,) numpy.ndarray + Local index of particle 2 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_3 : (A,) numpy.ndarray + Local index of particle 3 for each of :code:`A` constructed + three-particle bonds. + bonds_3_equilibrium : (A,) numpy.ndarray + Equilibrium angle for each of :code:`A` constructed three-particle + bonds. + bonds_3_strength : (A,) numpy.ndarray + Bond strength for each of :code:`A` constructed three-particle + bonds. + bonds_4_atom_1 : (D,) numpy.ndarray + Local index of particle 1 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_2 : (D,) numpy.ndarray + Local index of particle 2 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_3 : (D,) numpy.ndarray + Local index of particle 3 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_4 : (D,) numpy.ndarray + Local index of particle 4 for each of :code:`D` constructed + four-particle bonds. + bonds_4_coeff : (D,) numpy.ndarray + Cosine series coefficients for each of :code:`D` constructed + four-particle bonds. + bonds_4_type : (D,) numpy.ndarray + Dihedral type for each of :code:`D` constructed four-particle + bonds. + bonds_4_last : (D,) numpy.ndarray + Flags indicating if :code:`dih_type` is :code:`1` for each of :code:`D` + constructed four-particle bonds. + + See also + -------- + prepare_bonds_old : + Used internally to reconstruct the bonded interactions types from the + connectivity information in the structure/topology input file and the + bonded types specified in the configuration file. + """ + if topol is not None: + bonds_2, bonds_3, bonds_4 = prepare_index_based_bonds( + molecules, topol + ) + else: + bonds_2, bonds_3, bonds_4, bb_index = prepare_bonds_old( + molecules, names, bonds, indices, config + ) + + # Bonds + bonds_2_atom1 = np.empty(len(bonds_2), dtype=int) + bonds_2_atom2 = np.empty(len(bonds_2), dtype=int) + bonds_2_equilibrium = np.empty(len(bonds_2), dtype=np.float64) + bonds_2_strength = np.empty(len(bonds_2), dtype=np.float64) + for i, b in enumerate(bonds_2): + bonds_2_atom1[i] = b[0] + bonds_2_atom2[i] = b[1] + bonds_2_equilibrium[i] = b[2] + bonds_2_strength[i] = b[3] + + # Angles + bonds_3_atom1 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom2 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom3 = np.empty(len(bonds_3), dtype=int) + bonds_3_equilibrium = np.empty(len(bonds_3), dtype=np.float64) + bonds_3_strength = np.empty(len(bonds_3), dtype=np.float64) + for i, b in enumerate(bonds_3): + bonds_3_atom1[i] = b[0] + bonds_3_atom2[i] = b[1] + bonds_3_atom3[i] = b[2] + bonds_3_equilibrium[i] = b[3] + bonds_3_strength[i] = b[4] + # Dihedrals + bonds_4_atom1 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom2 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom3 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom4 = np.empty(len(bonds_4), dtype=int) + number_of_coeff = 6 + len_of_coeff = 5 + bonds_4_coeff = np.empty( + (len(bonds_4), number_of_coeff, len_of_coeff), dtype=np.float64 + ) + bonds_4_type = np.empty(len(bonds_4), dtype=int) + bonds_4_last = np.zeros(len(bonds_4), dtype=int) + for i, b in enumerate(bonds_4): + bonds_4_atom1[i] = b[0] + bonds_4_atom2[i] = b[1] + bonds_4_atom3[i] = b[2] + bonds_4_atom4[i] = b[3] + bonds_4_coeff[i] = np.resize(b[4], (number_of_coeff, len_of_coeff)) + bonds_4_type[i] = b[5] + if topol is not None: + bonds_4_last[i] = b[6] + if topol is None: + bonds_4_last[bb_index] = 1 + + return ( + bonds_2_atom1, + bonds_2_atom2, + bonds_2_equilibrium, + bonds_2_strength, + bonds_3_atom1, + bonds_3_atom2, + bonds_3_atom3, + bonds_3_equilibrium, + bonds_3_strength, # noqa: E501 + bonds_4_atom1, + bonds_4_atom2, + bonds_4_atom3, + bonds_4_atom4, + bonds_4_coeff, + bonds_4_type, + bonds_4_last, # noqa: E501 + )
+ + +
[docs]def compute_bond_forces__plain(f_bonds, r, bonds_2, box_size): + """Computes forces resulting from bonded interactions + + .. deprecated:: 1.0.0 + :code:`compute_bond_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_bonds.fill(0.0) + energy = 0.0 + + for i, j, r0, k in bonds_2: + ri = r[i, :] + rj = r[j, :] + rij = rj - ri + + # Apply periodic boundary conditions to the distance rij + for dim in range(len(rij)): + rij[dim] -= box_size[dim] * np.around(rij[dim] / box_size[dim]) + dr = np.linalg.norm(rij) + df = -k * (dr - r0) + f_bond_vector = df * rij / dr + f_bonds[i, :] -= f_bond_vector + f_bonds[j, :] += f_bond_vector + + energy += 0.5 * k * (dr - r0) ** 2 + return energy
+ + +
[docs]def compute_angle_forces__plain(f_angles, r, bonds_3, box_size): + """Computes forces resulting from angular interactions + + .. deprecated:: 1.0.0 + :code:`compute_angle_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_angles.fill(0.0) + energy = 0.0 + + for a, b, c, theta0, k in bonds_3: + ra = r[a, :] - r[b, :] + rc = r[c, :] - r[b, :] + + for dim in range(len(ra)): + ra[dim] -= box_size[dim] * np.around(ra[dim] / box_size[dim]) + rc[dim] -= box_size[dim] * np.around(rc[dim] / box_size[dim]) + + xra = 1.0 / np.sqrt(np.dot(ra, ra)) + xrc = 1.0 / np.sqrt(np.dot(rc, rc)) + ea = ra * xra + ec = rc * xrc + + cosphi = np.dot(ea, ec) + theta = np.arccos(cosphi) + xsinph = 1.0 / np.sqrt(1.0 - cosphi**2) + + d = theta - theta0 + f = -k * d + + xrasin = xra * xsinph * f + xrcsin = xrc * xsinph * f + + fa = (ea * cosphi - ec) * xrasin + fc = (ec * cosphi - ea) * xrcsin + + f_angles[a, :] += fa + f_angles[c, :] += fc + f_angles[b, :] -= fa + fc + # f_angles[b, :] += -(fa + fc) + + energy -= 0.5 * f * d + + return energy
+ + +
[docs]def compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size): + """Computes forces resulting from dihedral interactions + + .. deprecated:: 1.0.0 + :code:`compute_dihedral_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_dihedrals.fill(0.0) + energy = 0.0 + + for a, b, c, d, coeffs, phase in bonds_4: + f = r[a, :] - r[b, :] + g = r[b, :] - r[c, :] + h = r[d, :] - r[c, :] + + for dim in range(3): + f -= box_size[dim] * np.around(f[dim] / box_size[dim]) + g -= box_size[dim] * np.around(g[dim] / box_size[dim]) + h -= box_size[dim] * np.around(h[dim] / box_size[dim]) + + v = np.cross(f, g) + w = np.cross(h, g) + vv = np.dot(v, v) + ww = np.dot(w, w) + gn = np.linalg.norm(g) + + cosphi = np.dot(v, w) + sinphi = np.dot(np.cross(v, w), g) / gn + phi = np.arctan2(sinphi, cosphi) + + fg = np.dot(f, g) + hg = np.dot(h, g) + sc = v * fg / (vv * gn) - w * hg / (ww * gn) + + df = 0 + + for m in range(len(coeffs[0])): + energy += coeffs[0][m] * (1 + np.cos(m * phi - coeffs[1][m])) + df += m * coeffs[0][m] * np.sin(m * phi - coeffs[1][m]) + + force_on_a = df * gn * v / vv + force_on_d = df * gn * w / ww + + f_dihedrals[a, :] -= force_on_a + f_dihedrals[b, :] += df * sc + force_on_a + f_dihedrals[c, :] -= df * sc + force_on_d + f_dihedrals[d, :] += force_on_d + return energy
+ + +
[docs]def dipole_forces_redistribution( + f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb +): + """Redistribute electrostatic forces calculated from topologically + reconstructed ghost dipole point charges to the backcone atoms of the protein. + """ + f_on_bead.fill(0.0) + for i, j, k, l, fd, matrix, dih_type, is_last in zip( + a, b, c, d, f_dipoles, trans_matrices, type_array, last_bb + ): + if dih_type == 1: + sum_force = fd[0] + fd[1] + diff_force = fd[0] - fd[1] + f_on_bead[i] += matrix[0] @ diff_force # Atom A + f_on_bead[j] += matrix[1] @ diff_force + 0.5 * sum_force # Atom B + f_on_bead[k] += matrix[2] @ diff_force + 0.5 * sum_force # Atom C + + if is_last == 1: + sum_force = fd[2] + fd[3] + diff_force = fd[2] - fd[3] + f_on_bead[j] += matrix[3] @ diff_force + f_on_bead[k] += matrix[4] @ diff_force + 0.5 * sum_force + f_on_bead[l] += matrix[5] @ diff_force + 0.5 * sum_force
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/_modules/hymd/hamiltonian.html b/v1.0.8/_modules/hymd/hamiltonian.html new file mode 100644 index 00000000..588cf635 --- /dev/null +++ b/v1.0.8/_modules/hymd/hamiltonian.html @@ -0,0 +1,787 @@ + + + + + + hymd.hamiltonian — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.hamiltonian

+"""Interaction energy functionals.
+
+Implements field--particle interaction energy functionals depending on the
+field configuration. Extending HyMD with a new Hamiltonian is done by
+subclassing the :code:`Hamiltonian` superclass with logic intialized in the
+constructor.
+
+The grid-independent filtering function is defined in the :code:`Hamiltonian`
+superclass constructor. Hijack :code:`self.H` in a subclass to change the
+filter.
+"""
+import numpy as np
+import sympy
+
+
+
[docs]class Hamiltonian: + """Interaction energy functional superclass""" + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + self.config = config + self._setup()
+ +
[docs] def _setup(self): + """Superclass setup + + Sets up the grid-independent filtering function :code:`H`, and the + SymPy logic for symbolically differentiating interaction energy + functionals in Hamiltonian subclasses. + """ + if not hasattr(self.config, "simulation_volume"): + self.config.simulation_volume = np.prod(np.asarray(self.config.box_size)) + if not self.config.barostat: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.config.a = self.config.rho0 + if not self.config.rho0: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.phi = sympy.var("phi:%d" % (self.config.n_types)) + k = sympy.var("k:%d" % (3)) + + # electrostatics variables + self.psi = sympy.var("psi") + self.phi_q = sympy.var("phi_q") + if not self.config.self_energy: + self.config.self_energy = 0.0 + + def fourier_space_window_function(k): + return sympy.functions.elementary.exponential.exp( + -0.5 + * self.config.sigma**2 + * (k0**2 + k1**2 + k2**2) # noqa: F821, E501 + ) + + self.window_function_lambda = sympy.lambdify( + [k], fourier_space_window_function(k) + ) + + def H(k, v): + return v * self.window_function_lambda(k) + + self.H = H
+ + +
[docs]class SquaredPhi(Hamiltonian): + """Simple squared density interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + \\sum_k \\tilde\\phi_k + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`rho_0` is the + average density of the fully homogenous system. Expressing the species + densities in terms of fluctuations from the average, + + .. math:: + + \\mathrm{d}\\tilde\\phi_k = \\rho_0 - \\tilde\\phi_k, + + it is evident that this interaction energy functional is a slight change of + the :code:`DefaultNoChi` Hamiltonian, as the expanded interaction energy + density becomes + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + 6\\rho_0\\left[ + \\sum_k \\mathrm{d}\\tilde\\phi_k + \\right] + + + 9\\rho_0^2 + + + \\sum_k \\mathrm{d}\\tilde\\phi_k^2 + + + \\prod_{k\\not=l} + \\mathrm{d}\\tilde\\phi_k \\mathrm{d}\\tilde\\phi_l + \\right), + + identical to :code:`DefaultNoChi` apart from a constant energy shift + :math:`9\\rho_0^2`(which does not impact dynamics) and the + :math:`\\rho_0`--:math:`\\mathrm{d}\\tilde\\phi_k` cross-terms. These + cross-terms constitute contributions to the energy linear in + :math:`\\mathrm{d}\\tilde\\phi_k` absent in :code:`DefaultNoChi`, which has + only quadratic terms present. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(SquaredPhi, self).__init__(config) + super(SquaredPhi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0): + return 0.5 / (kappa * rho0) * (sum(phi)) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + ): + V_incompressibility = 1 / (kappa * rho0) * sum(phi) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultNoChi(Hamiltonian): + """Incompressibility-only interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. The :code:`SquaredPhi` Hamiltonian implements a similar + functional with an additional linear term component depending on + + .. math:: + + \\mathmr{d}\\tilde\\phi_k = \\tilde\\phi_k - \\rho_0 + + and not :math:`\\mathrm{d}\\tilde\\phi_k^2`. No explicit inter-species + interaction is present apart from the indirect interaction through the + incompressibility. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + hymd.input_parser.Config : + Configuration dataclass handler. + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultNoChi, self).__init__(config) + super(DefaultNoChi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0, a=self.config.a): + return 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultWithChi(Hamiltonian): + """Incompressibility and :math:`\\chi`-interactions energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = + \\frac{1}{2\\rho_0} + \\sum_{k,l}\\chi_{kl} \\tilde\\phi_k \\tilde\\phi_l + + + \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. :math:`\\chi_{ij}` is the Flory-Huggins-like + inter-species mixing energy. + """ + +
[docs] def __init__(self, config, unique_names, type_to_name_map): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultWithChi, self).__init__(config) + super(DefaultWithChi, self)._setup() + self.setup(unique_names, type_to_name_map)
+ +
[docs] def setup(self, unique_names, type_to_name_map): + """Setup the interaction energy potential and the external potential + + Parameters + ---------- + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + """ + self.type_to_name_map = type_to_name_map + self.chi_type_dictionary = { + tuple(sorted([c.atom_1, c.atom_2])): c.interaction_energy + for c in self.config.chi + } + self.phi_laplacian = [ + sympy.var("phi_laplacian%d(0:%d)" % (t, 3)) + for t in range(self.config.n_types) + ] + + def w( + phi, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + interaction = 0.0 + for i in range(self.config.n_types): + for j in range(i + 1, self.config.n_types): + ni = type_to_name_map[i] + nj = type_to_name_map[j] + names = sorted([ni, nj]) + c = chi_type_dictionary[tuple(names)] + + interaction += c * phi[i] * phi[j] / rho0 + incompressibility = 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + return incompressibility + interaction + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + t, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + + V_interaction = 0.0 + nk = type_to_name_map[t] + for i in range(self.config.n_types): + ni = type_to_name_map[i] + names = sorted([nk, ni]) + if ni != nk: + c = chi_type_dictionary[tuple(names)] + else: + c = 0.0 + # uncomment to count diagonal chi terms: + # c = chi_type_dictionary[tuple(names)] + V_interaction += c * phi[i] / rho0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[t])) + for t in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +def get_hamiltonian(config): + """Return appropriate Hamiltonian object based on the + config.hamiltonian string. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ---------- + hamiltonian : Hamiltonian + Hamiltonian object. + """ + if config.hamiltonian.lower() == "defaultnochi": + hamiltonian = DefaultNoChi(config) + elif config.hamiltonian.lower() == "defaultwithchi": + hamiltonian = DefaultWithChi( + config, config.unique_names, config.type_to_name_map + ) + elif config.hamiltonian.lower() == "squaredphi": + hamiltonian = SquaredPhi(config) + + return hamiltonian +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/_modules/hymd/input_parser.html b/v1.0.8/_modules/hymd/input_parser.html new file mode 100644 index 00000000..3e075ec8 --- /dev/null +++ b/v1.0.8/_modules/hymd/input_parser.html @@ -0,0 +1,1625 @@ + + + + + + hymd.input_parser — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.input_parser

+"""Parses and handles the configuration information provided for the simulation
+"""
+import copy
+import tomli
+import datetime
+import logging
+import warnings
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass, field
+from typing import List, Union, ClassVar
+from .force import Bond, Angle, Dihedral, Chi, Dielectric_type, propensity_potential_coeffs
+from .barostat import Target_pressure
+from .logger import Logger
+
+
+
[docs]@dataclass +class Config: + """Configuration object + + Handles and verifies the simulation configuration specified in the + configuration file. + + Attributes + ---------- + gas_constant : float + Constant value of the gas constant, R (equivalently the Boltzmann + constant) in the units used internally in HyMD. + coulomb_constant : float + Constant value of the Coulomb constant which converts electric field + values to forces and electric potential values to energies in the units + used internally in HyMD. + n_steps: int + Number of time steps in the simulation. + time_step: float + *Outer* time step used in the simulation. If the rRESPA intergrator is + used, the *inner* time step (the time step used in the integration of + intramolecular bending, stretching, and torsional forces) is + :code:`time_step / respa_inner`. + box_size : list[float] or (D,) numpy.ndarray + Simulation box size of simulation in :code:`D` dimensions in units of + nanometers. + mesh_size : list[int] or int or numpy.ndarray + Number of grid points used for the discrete density grid. + sigma : float + Filter width representing the effective coarse-graining level of the + particles in the simulation. + kappa : float + Compressibility parameter used in the relaxed incompressibility term in + the interaction energy functional. + n_print : int, optional + Frequency of trajectory/energy output to the H5MD trajectory/energy + output file (in units of number of time steps). + tau : float, optional + The time scale of the CSVR thermostat coupling. + start_temperature : float, optional + Generate starting temperature by assigning all particle velocities + randomly according to the Maxwell-Boltzmann distribution at + :code:`start_temperature` Kelvin prior to starting the simulation. + target_temperature : float, optional + Couple the system to a heat bath at :code:`target_temperature` Kelvin. + mass : float, optional + Mass of the particles in the simulation. + hamiltonian : str, optional + Specifies the interaction energy functional :math:`W[\\tilde\\phi]` + for use with the particle-field interactions. Options: + :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`. + domain_decomposition : int, optional + Specifies the interval (in time steps) of domain decomposition + exchange, involving all MPI ranks sending and receiving particles + according to the particles’ positions in the integration box and the + MPI ranks’ assigned domain. + integrator : str, optional + Specifies the time integrator used in the simulation. Options: + :code:`velocity-verlet` or :code:`respa`. + respa_inner : int, optional + The number of inner time steps in the rRESPA integrator. This denotes + the number of intramolecular force calculations (stretching, bending, + torsional) are performed between each impulse applied from the field + forces. + file_name : str, optional + File path of the parsed configuration file. + name : str, optional + Name for the simulation. + tags : list[str], optional + Tags for the simulation. + bonds : list[Bond], optional + Specifies harmonic stretching potentials between particles in the + same molecule. + angle_bonds : list[Angle], optional + Specifies harmonic angular bending potentials between particles in the + same molecule. + dihedrals : list[Dihedral], optional + Specifies four-particle torsional potentials by cosine series. + chi : list[Chi], optional + Specifies :math:`\\chi`-interaction parameters between particle + species. + n_particles : int, optional + Specifies the total number of particles in the input. Optional keyword + for validation, ensuring the input HDF5 topology has the correct number + of particles and molecules. + max_molecule_size : int, optional + Maximum size of any single molecule in the system. Used to speed up + distribution of particles onto MPI ranks in a parallel fashion. + n_flush : int, optional + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be + written to disk (in units of number of :code:`n_print`). + thermostat_work : float + Work performed by the thermostat on the system. + thermostat_coupling_groups : list[str], optional + Specifies individual groups coupling independently to the CSVR + thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and + :code:`"C"` type particles, + :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would + thermalise types :code:`"A"` and :code:`"B"` together and couple + :code:`"C"` type particles to a different thermostat (all individual + thermostats are at the same temperature, i.e. target_temperature + Kelvin). + initial_energy : float + Value of the total energy prior to the start of the simulation. + cancel_com_momentum : int, optional + If :code:`True`, the total linear momentum of the center of mass is + removed before starting the simulation. If an integer is specifed, the + total linear momentum of the center of mass is removed every + :code:`remove_com_momentum` time steps. If :code:`False`, the linear + momentum is never removed. + coulombtype : str, optional + Specifies the type of electrostatic Coulomb interactions in the system. + The strength of the electrostatic forces is modulated by the relative + dielectric constant of the simulation medium, specified with the + :code:`dielectric_const` keyword. Charges for individual particles are + specified in the structure/topology HDF5 input file, not in the + configuration file. If no charges (or peptide backbone dipoles) are + present, the electrostatic forces will not be calculated even if this + keyword is set to :code:`"PIC_Spectral"`. + dielectric_const : float, optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. When + using helical propensity dihedrals, this keyword must be specified—even + if electrostatics are not included with the :code:`coulombtype` + keyword. + dielectric_type: list[float], optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. The list assigns + relative dielectric values to each bead type, and an anisotropic + dielectric function is obtained from a weighted average. + + + See also + -------- + hymd.input_parser.Bond : + Two-particle bond type dataclass. + hymd.input_parser.Angle : + Three-particle bond type dataclass. + hymd.input_parser.Dihedral : + Four-particle bond type dataclass. + """ + + gas_constant: ClassVar[float] = 0.0083144621 # kJ mol-1 K-1 + coulomb_constant: ClassVar[float] = 138.935458 # kJ nm mol-1 e-2 + + n_steps: int + time_step: float + mesh_size: Union[Union[List[int], np.ndarray], int] + sigma: float + kappa: float + + dtype: np.dtype = None + box_size: Union[List[float], np.ndarray] = None + n_print: int = None + tau: float = None + start_temperature: Union[float, bool] = None + target_temperature: Union[float, bool] = None + mass: float = None + hamiltonian: str = None + domain_decomposition: Union[int, bool] = None + integrator: str = None + respa_inner: int = 1 + file_name: str = "<config file path unknown>" + name: str = None + tags: List[str] = field(default_factory=list) + bonds: List[Bond] = field(default_factory=list) + angle_bonds: List[Angle] = field(default_factory=list) + dihedrals: List[Dihedral] = field(default_factory=list) + chi: List[Chi] = field(default_factory=list) + n_particles: int = None + max_molecule_size: int = None + n_flush: int = None + thermostat_work: float = 0.0 + thermostat_coupling_groups: List[List[str]] = field(default_factory=list) + initial_energy: float = None + cancel_com_momentum: Union[int, bool] = False + coulombtype: str = None + convergence_type: str = None + pol_mixing: float = None + dielectric_const: float = None + conv_crit: float = None + dielectric_type: List[Dielectric_type] = field(default_factory=list) + self_energy: float = None + type_charges: Union[List[float], np.ndarray] = None + + # For NPT runs + rho0: float = None + a: float = None + pressure: bool = False + barostat: str = None + barostat_type: str = None + tau_p: float = None + target_pressure: List[Target_pressure] = field(default_factory=list) + n_b: int = None + m: List[float] = field(default_factory=list) + + def __str__(self): + target_pressure_str = "\ttarget_pressure:\n" + "".join( + "\t\tP_L: " + + f"{self.target_pressure.P_L}\n" + + "\t\tP_N: " + + f"{self.target_pressure.P_N}\n" + ) + bonds_str = "\tbonds:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " f"{k.equilibrium}, {k.strength}\n") + for k in self.bonds + ] + ) + angle_str = "\tangle_bonds:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3}: " + + f"{k.equilibrium}, {k.strength}\n" + ) + for k in self.angle_bonds + ] + ) + dihedrals_str = "\tdihedrals:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: " + # This might need to be fixed/made prettier, probably + # there's an easier way + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ).join( + map( + str, + [ + [round(num, 3) for num in c_in] + if isinstance(c_in, list) + else c_in + for c_in in k.coeffs + ], + ) + ) + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ) + + f"dih_type = {k.dih_type}\n" + ) + for k in self.dihedrals + ] + ) + chi_str = "\tchi:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " + f"{k.interaction_energy}\n") + for k in self.chi + ] + ) + + """ If dielectric wanted as dictionary + dielectric_type_str = "\tdielectric_type:\n" + "".join( + [ + (f"\t\t{k.atom_1}: " + f"{k.dielectric_value}\n") + for k in self.dielectric_type + ] + ) + + """ + + thermostat_coupling_groups_str = "" + if any(self.thermostat_coupling_groups): + thermostat_coupling_groups_str = ( + "\tthermostat_coupling_groups:\n" + + "".join( + [ + "\t\t" + ", ".join([f"{n}" for n in ng]) + "\n" + for ng in self.thermostat_coupling_groups + ] + ) + ) + + ret_str = f'\n\n\tConfig: {self.file_name}\n\t{50 * "-"}\n' + for k, v in self.__dict__.items(): + if k not in ( + "target_pressure", + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "thermostat_coupling_groups", + ): + ret_str += f"\t{k}: {v}\n" + ret_str += ( + target_pressure_str + + bonds_str + + angle_str + + dihedrals_str + + chi_str + + thermostat_coupling_groups_str + ) + return ret_str
+ + +
[docs]def read_config_toml(file_path): + with open(file_path, "r") as in_file: + file_content = in_file.read() + return file_content
+ +
[docs]def parse_config_toml(toml_content, file_path=None, comm=MPI.COMM_WORLD): + config_dict = {} + + # read toml to a dictionary + toml_content = tomli.loads(toml_content) + + # Defaults = None + for n in ( + "box_size", + "n_print", + "tau", + "start_temperature", + "target_temperature", + "mass", + "hamiltonian", + "domain_decomposition", + "integrator", + "name", + "n_particles", + "max_molecule_size", + "coulombtype", + "convergence_type", + "dielectric_const", + "pol_mixing", + "conv_crit", + "dielectric_type", + "n_b", + "box_size", + "n_flush", + "self_energy", + "dtype", + ): + config_dict[n] = None + + # Defaults = [] + + for n in ( + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "tags", + "m", + "dielectric_type", + "target_pressure", + "type_charges", + ): + config_dict[n] = [] + + # Defaults: bool + config_dict["pressure"] = False + + # Flatten the .toml dictionary, ignoring the top level [tag] directives (if + # any). + for k, v in toml_content.items(): + if isinstance(v, dict): + if k == "nn": # Don't parse diff-hymd optimization options + continue + for nested_k, nested_v in v.items(): + config_dict[nested_k] = nested_v + else: + config_dict[k] = v + for k, v in config_dict.items(): + if k == "bonds": + config_dict["bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["bonds"][i] = Bond( + atom_1=b[0], + atom_2=b[1], + equilibrium=b[2], + strength=b[3], + ) + if k == "angle_bonds": + config_dict["angle_bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["angle_bonds"][i] = Angle( + atom_1=b[0], + atom_2=b[1], + atom_3=b[2], + equilibrium=b[3], + strength=b[4], + ) + if k == "dihedrals": + config_dict["dihedrals"] = [None] * len(v) + for i, b in enumerate(v): + try: + dih_type = int(b[2][0]) + except IndexError: + Logger.rank0.log( + logging.WARNING, "Dihedral type not provided, defaulting to 0." + ) + dih_type = 0 + + # Probably it's better to move this in check_dihedrals? + wrong_len = len(b[1]) not in (1, 2) + wrong_type_1 = len(b[1]) == 1 and not isinstance(b[1][0], float) + wrong_type_2 = len(b[1]) == 2 and not isinstance(b[1][0], list) + if wrong_len or wrong_type_1 or wrong_type_2: + err_str = ( + "The coefficients specified for the dihedral type " + "(0) do not match the correct structure. Either " + "use [lambda] or [[cn_prop], [dn_prop]], or select" + " the correct dihedral type." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise RuntimeError(err_str) + + # FIXME: this is messy af, I don't like it + if dih_type == 0 and isinstance(b[1][0], (float, int)): + coeff = propensity_potential_coeffs(b[1][0]) + elif dih_type == 1 and len(b[1]) == 3: + coeff = np.array( + propensity_potential_coeffs(b[1][0][0]).tolist() + + b[1][1:] + ) + elif dih_type == 2: + coeff = np.array(b[1]) + else: + coeff = np.insert(np.array(b[1]), 2, np.zeros((2, 5)), axis=0) + + config_dict["dihedrals"][i] = Dihedral( + atom_1=b[0][0], + atom_2=b[0][1], + atom_3=b[0][2], + atom_4=b[0][3], + coeffs=coeff, + dih_type=dih_type, + ) + if k == "chi": + config_dict["chi"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0], c[1]]) + config_dict["chi"][i] = Chi( + atom_1=c_[0], atom_2=c_[1], interaction_energy=c[2] + ) + + """ + if k == "dielectric_type": + config_dict["dielectric_type"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0][0]]) + config_dict["dielectric_type"][i] = Dielectric_type( + atom_1=c_[0], dielectric_value=c[1][0] + ) + """ + if k == "target_pressure": + if len(v) == 2: + config_dict["target_pressure"] = Target_pressure( + P_L=v[0], + P_N=v[1], # check condition # V array (still read as array?) + ) + elif len(v) == 1: + config_dict["target_pressure"] = Target_pressure(P_L=v[0], P_N=None) + else: + config_dict["target_pressure"] = Target_pressure(P_L=None, P_N=None) + + if file_path is not None: + config_dict["file_name"] = file_path + + for n in ( + "n_steps", "time_step", "mesh_size", "sigma", "kappa" + ): + if n not in config_dict: + err_str = ( + f"No {n} specified in config file {file_path}. Unable to start" + f" simulation." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return Config(**config_dict)
+ + +
[docs]def check_n_particles(config, indices, comm=MPI.COMM_WORLD): + n_particles = comm.allreduce(len(indices), MPI.SUM) + if config.n_particles is None: + config = copy.deepcopy(config) + config.n_particles = n_particles + info_str = ( + f"No n_particles found in toml file {config.file_name}, defaulting" + f" to indices.shape ({n_particles})" + ) + Logger.rank0.log(logging.INFO, info_str) + return config + + if n_particles != config.n_particles: + warn_str = ( + f"n_particles in {config.file_name} ({config.n_particles}) does " + "not match the shape of the indices array in the .HDF5 file " + f"({n_particles}). Defaulting to using indices.shape " + f"({n_particles})" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.n_particles = n_particles + return config
+ + +
[docs]def check_max_molecule_size(config, comm=MPI.COMM_WORLD): + if config.max_molecule_size is None: + info_str = ( + f"No max_molecule_size found in toml file {config.file_name}, " + f"defaulting to 201" + ) + Logger.rank0.log(logging.INFO, info_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + + if config.max_molecule_size < 1: + warn_str = ( + f"max_molecule_size in {config.file_name} must be a positive " + f"integer, not {config.max_molecule_size}, defaulting to 201" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + return config
+ + +def _find_unique_names(config, names, comm=MPI.COMM_WORLD): + unique_names = np.unique(names) + receive_buffer = comm.gather(unique_names, root=0) + + gathered_unique_names = None + if comm.Get_rank() == 0: + gathered_unique_names = np.unique(np.concatenate(receive_buffer)) + unique_names = comm.bcast(gathered_unique_names, root=0) + unique_names = sorted([n.decode("UTF-8") for n in unique_names]) + config.unique_names = unique_names + config.n_types = len(unique_names) + return config + + +def _setup_type_to_name_map(config, names, types, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + name_to_type_ = {} + for n, t in zip(names, types): + n = n.decode("utf-8") + if n not in name_to_type_: + name_to_type_[n] = t + receive_buffer = comm.gather(name_to_type_, root=0) + gathered_dict = None + if comm.Get_rank() == 0: + gathered_dict = {} + for d in receive_buffer: + for k, v in d.items(): + if k not in gathered_dict: + gathered_dict[k] = v + else: + assert v == gathered_dict[k] + name_to_type_map = comm.bcast(gathered_dict, root=0) + config.name_to_type_map = name_to_type_map + config.type_to_name_map = {v: k for k, v in name_to_type_map.items()} + return config + + +
[docs]def check_bonds(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for b in config.bonds: + if b.atom_1 not in unique_names or b.atom_2 not in unique_names: + missing_str = "" + if b.atom_1 not in unique_names: + if b.atom_2 not in unique_names: + if b.atom_1 == b.atom_2: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"neither {b.atom_1}, {b.atom_2} atoms" + else: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"no {b.atom_2} atoms" + + warn_str = ( + f"Bond type {b.atom_1}--{b.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_angles(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for a in config.angle_bonds: + if ( + a.atom_1 not in unique_names + or a.atom_2 not in unique_names + or a.atom_3 not in unique_names + ): + missing = [ + a.atom_1 not in unique_names, + a.atom_2 not in unique_names, + a.atom_3 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([a.atom_1, a.atom_2, a.atom_3]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Angle bond type {a.atom_1}--{a.atom_2}--{a.atom_3} " + f"specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_dihedrals(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for d in config.dihedrals: + if ( + d.atom_1 not in unique_names + or d.atom_2 not in unique_names + or d.atom_3 not in unique_names + or d.atom_4 not in unique_names + ): + missing = [ + d.atom_1 not in unique_names, + d.atom_2 not in unique_names, + d.atom_3 not in unique_names, + d.atom_4 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([d.atom_1, d.atom_2, d.atom_3, d.atom_4]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Dihedral type {d.atom_1}--{d.atom_2}--{d.atom_3}--{d.atom_4}" + f" specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_chi(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for c in config.chi: + if c.atom_1 not in unique_names or c.atom_2 not in unique_names: + missing_str = "" + if c.atom_1 not in unique_names: + if c.atom_2 not in unique_names: + if c.atom_1 == c.atom_2: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"neither {c.atom_1}, {c.atom_2} atoms" + else: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"no {c.atom_2} atoms" + + warn_str = ( + f"Chi interaction {c.atom_1}--{c.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + for i, n in enumerate(unique_names): + for m in unique_names[i + 1 :]: + found = False + for c in config.chi: + if (c.atom_1 == n and c.atom_2 == m) or ( + c.atom_1 == m and c.atom_2 == n + ): + found = True + if not found: + config.chi.append(Chi(atom_1=n, atom_2=m, interaction_energy=0.0)) + warn_str = ( + f"Atom types {n} and {m} found in the " + f"system, but no chi interaction {n}--{m} " + f"specified in {config.file_name}. Defaulting to " + f"chi[{n}, {m}] = 0" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_box_size(config, input_box, comm=MPI.COMM_WORLD): + if config.box_size is not None: + config.box_size = np.array(config.box_size, dtype=np.float32) + if input_box.all() and not np.allclose(config.box_size, input_box, atol=0.009): + err_str = ( + f"Box size specified in {config.file_name}: " + f"{config.box_size} does not match input box:" + f"{input_box}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + else: + if input_box.all(): + config.box_size = input_box + else: + err_str = f"No box information found" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + for b in config.box_size: + if b <= 0.0: + err_str = ( + f"Invalid box size specified in {config.file_name}: " + f"{config.box_size}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return config
+ + +
[docs]def check_integrator(config, comm=MPI.COMM_WORLD): + if config.integrator.lower() not in ("velocity-verlet", "respa"): + err_str = ( + f"Invalid integrator specified in {config.file_name}: " + f'{config.integrator}. Available options "velocity-verlet" or ' + f'"respa".' + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + if config.integrator.lower() == "respa": + if isinstance(config.respa_inner, float): + warn_str = ( + f"Number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner} specified " + f"as float, using {int(config.respa_inner)}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = int(config.respa_inner) + elif not isinstance(config.respa_inner, int): + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + + if config.respa_inner <= 0: + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + if config.integrator.lower() == "velocity-verlet" and config.respa_inner != 1: + warn_str = ( + f"Integrator type Velocity-Verlet specified in {config.file_name} " + f"and inner rRESPA time steps set to {config.respa_inner}. " + f"Using respa_inner = 1" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = 1 + + return config
+ + +
[docs]def check_hamiltonian(config, comm=MPI.COMM_WORLD): + valid_hamiltonians = ["defaultnochi", "defaultwithchi", "squaredphi"] + + if config.hamiltonian is None: + if len(config.chi) == 0: + warn_str = ( + f"No hamiltonian form and no chi interactions specified in " + f"{config.file_name}, defaulting to DefaultNoChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultNoChi" + else: + warn_str = ( + f"No hamiltonian form specified in {config.file_name}, but " + f"chi interactions are specified, defaulting to " + f"DefaultWithChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultWithChi" + elif config.hamiltonian.lower() not in valid_hamiltonians: + err_str = ( + f"The specified Hamiltonian {config.hamiltonian} was not " + f"recognized as a valid Hamiltonian." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise NotImplementedError(err_str) + + return config
+ + +
[docs]def check_n_flush(config, comm=MPI.COMM_WORLD): + if config.n_print: + if config.n_flush is None: + config.n_flush = 10000 // config.n_print + return config
+ + +
[docs]def check_n_print(config, comm=MPI.COMM_WORLD): + if ( + not isinstance(config.n_print, int) + and not isinstance(config.n_print, float) + and config.n_print is not None + ): + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if config.n_print is None or config.n_print <= 0: + config.n_print = False + elif not isinstance(config.n_print, int): + if isinstance(config.n_print, float): + warn_str = ( + f"n_print is a float ({config.n_print}), not int, using " + f"{int(round(config.n_print))}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + config.n_print = int(round(config.n_print)) + else: + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + return config
+ + +
[docs]def check_tau(config, comm=MPI.COMM_WORLD): + if config.tau is None and config.target_temperature is not None: + warn_str = "target temp specified but no tau, defaulting 0.7" + config.tau = 0.7 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_start_and_target_temperature(config, comm=MPI.COMM_WORLD): + """Validate provided starting and target thermostat temperatures + + Assesses the provided temperature target and ensures it is a non-negative + floating point number or :code:`False`. Ensures the starting temperature is + a non-negative floating point number or :code:`False`. + + If the value for either is :code:`None`, the returned configuration object + has the values defaulted to :code:`False` in each case. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ------- + validated_config : Config + Configuration object with validated :code:`target_temperature` and + :code:`start_temperature`. + """ + for t in ("start_temperature", "target_temperature"): + if getattr(config, t) is not None: + try: + if getattr(config, t) < 0: + warn_str = ( + f"{t} set to negative value ({getattr(config, t)}), " + f"defaulting to False" + ) + setattr(config, t, False) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + except TypeError as e: + err_str = ( + f"Could not interpret {t} = {repr(getattr(config, t))} as " + f"a number." + ) + raise TypeError(err_str) from e + + if config.start_temperature is None: + config.start_temperature = False + if config.target_temperature is None: + config.target_temperature = False + return config
+ + +
[docs]def check_mass(config, comm=MPI.COMM_WORLD): + if config.mass is None: + info_str = "no mass specified, defaulting to 72.0" + config.mass = 72.0 + Logger.rank0.log(logging.INFO, info_str) + elif not isinstance(config.mass, int) and not isinstance(config.mass, float): + err_str = ( + f"specified mass is invalid type {config.mass}, " f"({type(config.mass)})" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + elif config.mass < 0: + err_str = f"invalid mass specified, {config.mass}" + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + else: + config.mass = float(config.mass) + + return config
+ + +
[docs]def check_domain_decomposition(config, comm=MPI.COMM_WORLD): + dd = config.domain_decomposition + if dd is None or dd is False: + config.domain_decomposition = False + return config + + if isinstance(dd, int): + if dd < 0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + elif isinstance(dd, float): + if dd < 0.0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + else: + warn_str = ( + f"domain_decomposition ({config.domain_decomposition}) is not " + f"an integer, using {int(round(dd))}" + ) + config.domain_decomposition = int(round(dd)) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + else: + err_str = ( + f"invalid value for domain_decomposition " + f"({config.domain_decomposition}) use an integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + return config
+ + +
[docs]def check_name(config, comm=MPI.COMM_WORLD): + if config.name is None: + root_current_time = "" + if comm.Get_rank() == 0: + root_current_time = datetime.datetime.now().strftime("%m/%d/%Y, %H:%M:%S") + current_time = comm.bcast(root_current_time, root=0) + + if config.name is None: + config.name = "sim" + current_time + else: + config.name = str(config.name) + return config
+ + +
[docs]def check_NPT_conditions(config, comm=MPI.COMM_WORLD): + """ + Check validity of barostat_type, barostat, + a, rho0, target_pressure, tau_p + """ + if config.barostat is None: + if ( + config.tau_p is not None + or (config.target_pressure.P_L and config.target_pressure.P_N) is not None + ): + err_str = ( + "barostat not specified but config.tau_p " + "or config.target_pressure specified, cannot start simulation {config.barostat}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.a: + warn_str = "a specified but no barostat," "setting a to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.rho0: + warn_str = ( + "rho0 specified but no barostat," "setting rho0 to average density" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + if config.barostat is not None: + if not config.barostat_type: + config.barostat_type = "berendsen" + warn_str = "barostat_type not specified," "setting to berendsen" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.barostat != "isotropic" and config.barostat != "semiisotropic": + err_str = "barostat option not recognised. Valid options: isotropic, semiisotropic" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.target_pressure.P_L is None: + config.target_pressure.P_L = 1.0 # bar + config.target_pressure.P_N = None + if config.barostat == "semiisotropic": + config.target_pressure.P_N = 1.0 # bar + warn_str = ( + "barostat specified but no target_pressure, defaulting to 1.0 bar" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.tau_p is None: + if config.tau <= 0.1: + config.tau_p = config.tau * 10.0 + else: + config.tau_p = 1.0 + warn_str = "barostat specified but no tau_p, defaulting to " + str( + config.tau_p + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if not config.a: + err_str = "a not specified; cannot start simulation {config.a}" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if not config.rho0: + warn_str = "rho0 not specified;" "setting rho0 to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + return config
+ + +
[docs]def check_thermostat_coupling_groups(config, comm=MPI.COMM_WORLD): + if any(config.thermostat_coupling_groups): + found = [0 for _ in config.unique_names] + unique_names = [n for n in config.unique_names] + for i, group in enumerate(config.thermostat_coupling_groups): + for species in group: + try: + ind = unique_names.index(species) + found[ind] += 1 + except ValueError as e: + err_str = ( + f"Particle species {species} specified in thermostat " + f"coupling group {i}, but no {species} particles were " + "found in the system." + ) + raise ValueError(err_str) from e + if any([True if f > 1 else False for f in found]): + for i, f in enumerate(found): + if f > 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} specified in multiple " + "thermostat coupling groups; " + f"{config.thermostat_coupling_groups}." + ) + raise ValueError(err_str) + if not all([True if f == 1 else False for f in found]): + for i, f in enumerate(found): + if f != 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} not specified in any " + f"thermostat coupling group, but {species} particles " + "were found in the system" + ) + raise ValueError(err_str) + return config
+ + +
[docs]def check_m(config, comm=MPI.COMM_WORLD): + if config.m == []: + config.m = [1.0 for t in range(config.n_types)] + return config
+ + +
[docs]def check_n_b(config, comm=MPI.COMM_WORLD): + if config.n_b is None: + warn_str = f"config.n_b not specified." "Defaulting to 1" + config.n_b = 1 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_cancel_com_momentum(config, comm=MPI.COMM_WORLD): + if isinstance(config.cancel_com_momentum, int): + if config.cancel_com_momentum == 0 or config.cancel_com_momentum < 0: + config.cancel_com_momentum = False + elif not isinstance(config.cancel_com_momentum, bool): + err_str = ( + f"Could not interpret {config.cancel_com_momentum} as an integer " + f"or boolean." + ) + raise ValueError(err_str) + return config
+ + +
[docs]def sort_dielectric_by_type_id(config, charges, types): + """ + Creates a list of length N CG-particles, sorted after the charges from + the input HDF5 file. Used in file_io.py + """ + dielectric_val = np.zeros(config.n_types) + for j in range(config.n_types): + name = config.dielectric_type[j][0][0] + type_id = config.name_to_type_map[name] + dielectric_val[type_id] = config.dielectric_type[j][1][0] + config.dielectric_type = dielectric_val.copy() + + N = len(charges) + len_list = np.zeros(config.n_types) + dielectric_by_types = np.zeros(N) + for i in range(N): + dielectric_by_types[i] = dielectric_val[types[i]] + # print("types ", types) + # print("diel val", dielectric_by_types) + # print("charges", charges) + # print(config.name_to_type_map) + return dielectric_by_types # by types with each particle id
+ + +
[docs]def check_charges_types_list(config, types, charges, comm=MPI.COMM_WORLD): + """ + Creates a list of charge values of length types. + Charges are sorted according to type ID. Used in field.py. + # TODO: this is messy, we should fix it + """ + if charges is None: + config.type_charges = [0.0] * config.n_types + return config + + check_val = -100.0 # some random value that will never be encountered + charges_list = np.full(config.n_types, check_val) # gatherv cant handle None + rank = comm.Get_rank() + # print(charges_list) + for t_ in range(config.n_types): + if t_ in types: + charges_list[t_] = charges[types == t_][0] + + nprocs = int(comm.Get_size()) + recv_charges = None + if rank == 0: + recv_charges = np.full( + config.n_types * nprocs, check_val + ) # gatherv cant handle None + comm.Gather(charges_list, recv_charges, root=0) + + ## make a charges list + if rank == 0: + config_charges = np.zeros(config.n_types) + test_config = np.full(config.n_types, check_val) + for j in range(nprocs): + for i in range(config.n_types): + if recv_charges[i + j * config.n_types] != check_val: + config_charges[i] = recv_charges[i + j * config.n_types] + if np.any([test_config, config_charges]): + continue + else: + break + + # print(config_charges) + # print(config.name_to_type_map) + # print(charges[types == 0][0],charges[types == 1][0],charges[types == 2][0],charges[types == 3][0], + # charges[types == 4][0]) + else: + config_charges = np.zeros(config.n_types) + + comm.Bcast(config_charges, root=0) + # print("config_charges", config_charges , "rank", rank) + # print(recv_charges) + # rank = comm.Get_rank() + # print(all_charges) + config.type_charges = config_charges + return config
+ + +
[docs]def check_dielectric(config, comm=MPI.COMM_WORLD): + """ + Error handling for electrostatics. + Unit testing of toml/tomli input. + """ + err_str_const = "Dielectric constant not given." + if config.coulombtype == "PIC_Spectral": + assert config.dielectric_const != None, err_str_const + + err_str = "Dielectric list is empty." + if config.coulombtype == "PIC_Spectral_GPE": + assert len(config.dielectric_type) != 0, err_str + # default values + if config.pol_mixing is None: + config.pol_mixing = 0.6 + if config.conv_crit is None: + config.conv_crit = 1e-6 + return config
+ + +
[docs]def check_charges(config, charges, comm=MPI.COMM_WORLD): + """Check if charges across ranks sum to zero. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of floats with charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + """ + total_charge = comm.allreduce(np.sum(charges), MPI.SUM) + + if not np.isclose(total_charge, 0.0): + warn_str = ( + f"Charges in the input file do not sum to zero. " + f"Total charge is {total_charge}." + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + # if charges are ok, compute self energy + if config.coulombtype == "PIC_Spectral": + from .field import compute_self_energy_q + + config.self_energy = compute_self_energy_q(config, charges, comm=comm) + + return config
+ + +
[docs]def check_config( + config, indices, names, types, charges, input_box, comm=MPI.COMM_WORLD +): + """Performs various checks on the specfied config to ensure consistency + + Parameters + ---------- + config : Config + Configuration object. + indices : (N,) numpy.ndarray + Array of integer indices for :code:`N` particles. + names : (N,) numpy.ndarray + Array of string names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of integer type indices for :code:`N` particles. + charges : (N,) numpy.ndarray + Array of floats charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + + Returns + ------- + config : Config + Validated configuration object. + """ + config = _find_unique_names(config, names, comm=comm) + if types is not None: + config = _setup_type_to_name_map(config, names, types, comm=comm) + config = check_box_size(config, input_box, comm=comm) + config = check_integrator(config, comm=comm) + config = check_max_molecule_size(config, comm=comm) + config = check_tau(config, comm=comm) + config = check_start_and_target_temperature(config, comm=comm) + config = check_mass(config, comm=comm) + config = check_domain_decomposition(config, comm=comm) + config = check_name(config, comm=comm) + config = check_n_particles(config, indices, comm=comm) + config = check_chi(config, names, comm=comm) + config = check_bonds(config, names, comm=comm) + config = check_angles(config, names, comm=comm) + config = check_dihedrals(config, names, comm=comm) + config = check_hamiltonian(config, comm=comm) + config = check_NPT_conditions(config, comm=comm) + config = check_n_b(config, comm=comm) + config = check_m(config, comm=comm) + config = check_thermostat_coupling_groups(config, comm=comm) + config = check_cancel_com_momentum(config, comm=comm) + config = check_dielectric(config, comm=comm) + config = check_n_print(config, comm=comm) + config = check_n_flush(config, comm=comm) + config = check_charges_types_list(config, types, charges, comm=comm) + if charges is not None: + config = check_charges(config, charges, comm=comm) + + return config
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/_modules/hymd/integrator.html b/v1.0.8/_modules/hymd/integrator.html new file mode 100644 index 00000000..eafed63a --- /dev/null +++ b/v1.0.8/_modules/hymd/integrator.html @@ -0,0 +1,348 @@ + + + + + + hymd.integrator — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.integrator

+"""Integrates equations of motion.
+
+Implements the Velocity Verlet integrator. The *reversible reference system
+propagator algorithm* (rRESPA) integrator uses the Velocity Verlet functions
+inside the MD loop in the main module.
+"""
+
+
+
[docs]def integrate_velocity(velocities, accelerations, time_step): + """Velocity update step of the Velocity Verlet integration algorithm. + + Computes the velocity update step of the Velocity Verlet algorithm. The + :code:`velocities` argument is **not** changed in place. + + Parameters + ---------- + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + accelerations : (N, D) numpy.ndarray + Array of accelerations of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step + + .. math:: \\mathbf{v}_{\\text{new}} = \\mathbf{v} + \\frac{\\Delta t}{2m} + \\mathbf{f} + + before the positions are moved a full step using the updated half-step + velocities. + + See Also + -------- + integrate_position : The position update step of the Velocity Verlet + algorithm. + """ + return velocities + 0.5 * time_step * accelerations
+ + +
[docs]def integrate_position(positions, velocities, time_step): + """Position update step of the Velocity Verlet integration algorithm. + + Computes the position update step of the Velocity Verlet algorithm. The + :code:`positions` argument is **not** changed in place. + + Parameters + ---------- + positions : (N, D) numpy.ndarray + Array of positions of :code:`N` particles in :code:`D` dimensions. + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step, then the positions are updated a full step using the updated + velocities + + .. math:: \\mathbf{x}_{\\text{new}} = \\mathbf{x} + \\Delta t \\mathbf{v} + + See Also + -------- + integrate_velocity : The velocity update step of the Velocity Verlet + algorithm. + """ + return positions + time_step * velocities
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/_modules/hymd/logger.html b/v1.0.8/_modules/hymd/logger.html new file mode 100644 index 00000000..3304771d --- /dev/null +++ b/v1.0.8/_modules/hymd/logger.html @@ -0,0 +1,537 @@ + + + + + + hymd.logger — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.logger

+"""Handles event logging for simulation information, warnings, and errors.
+"""
+import sys
+import os
+import logging
+from mpi4py import MPI
+from .version import __version__
+
+
+
[docs]class MPIFilterRoot(logging.Filter): + """Log output Filter wrapper class for the root MPI rank log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + if self.comm.Get_rank() == 0: + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True + else: + return False
+ + +
[docs]class MPIFilterAll(logging.Filter): + """Log output Filter wrapper class for the all-MPI-ranks log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True
+ + +class MPIFilterStdout(logging.Filter): + """Log output Filter wrapper class for filtering STDOUT log""" + + def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.funcName = "replica 0 " + record.funcName + if MPI.COMM_WORLD.Get_rank() == 0: + record.rank = MPI.COMM_WORLD.Get_rank() + record.size = MPI.COMM_WORLD.Get_size() + return True + else: + return False + + +
[docs]class Logger: + """Log output handler class + + Notes + ----- + This wraps the default python library :code:`logging`, see + `docs.python.org/3/library/logging.html`_. + + .. _`docs.python.org/3/library/logging.html`: + https://docs.python.org/3/library/logging.html + + Attributes + ---------- + level : int + Determines the verbosity level of the log, corresponding to + logging.level. Numerical values :code:`50` (:code:`logging.CRITICAL`), + :code:`40` (:code:`logging.ERROR`), :code:`30` + (:code:`logging.WARNING`), :code:`20` (:code:`logging.INFO`), + :code:`10` (:code:`logging.DEBUG`), and :code:`0` + (:code:`logging.UNSET`) are supported values. Any log event message + less severe than the specified level is ignored. All other event + messages are emitted. + log_file : str + Path to output log file. + format : str + Prepended dump string for each log event. Specifies the log event + level, the module emitting the event, the code line, the enclosing + function name, and the MPI rank writing the message. + date_format : str + Prepends the date before all log event messages. + formatter : logging.Formatter + Formatter handling the prepending of the information in `format` and + `date_format` to each log event message. Used by default for all + loggers. + rank0 : logging.Logger + Default logger object for the root MPI rank. + all_ranks : logging.Logger + Default logger object for messages being emitted from all MPI ranks + simultaneously. + """ + + level = None + log_file = None + format = " %(levelname)-8s [%(filename)s:%(lineno)d] <%(funcName)s> {rank %(rank)d/%(size)d} %(message)s" # noqa: E501 + date_format = "%(asctime)s" + formatter = logging.Formatter(fmt=date_format + format) + rank0 = logging.getLogger("HyMD.rank_0") + all_ranks = logging.getLogger("HyMD.all_ranks") + +
[docs] @classmethod + def setup(cls, default_level=logging.INFO, log_file=None, verbose=False, comm=MPI.COMM_WORLD): + """Sets up the logger object. + + If a :code:`log_file` path is provided, log event messages are output + to it. Otherwise, the logging messages are emitted to stdout. + + Parameters + ---------- + default_level : int, optional + Default verbosity level of the logger. Unless specified, it is + :code:`10` (:code:`logging.INFO`). + log_file : str, optional + Path to output log file. If `None` or not priovided, no log file is + used and all logging is done to stdout. + verbose : bool, optional + Increases the logging level to :code:`30` (:code:`logging.WARNING`) + if True, otherwise leaves the logging level unchanged. + """ + cls.level = default_level + cls.log_file = log_file + + log_to_stdout = False + if verbose: + log_to_stdout = True + + level = default_level + if not verbose: + level = logging.WARNING + cls.rank0.setLevel(level) + cls.all_ranks.setLevel(level) + + root_filter = MPIFilterRoot(comm) + all_filter = MPIFilterAll(comm) + cls.rank0.addFilter(root_filter) + cls.all_ranks.addFilter(all_filter) + + if (not log_file) and (not log_to_stdout): + return + if log_file: + cls.log_file_handler = logging.FileHandler(log_file) + cls.log_file_handler.setLevel(level) + cls.log_file_handler.setFormatter(cls.formatter) + + cls.rank0.addHandler(cls.log_file_handler) + cls.all_ranks.addHandler(cls.log_file_handler) + if log_to_stdout: + cls.log_to_stdout = True + cls.stdout_handler = logging.StreamHandler() + cls.stdout_handler.setLevel(level) + cls.stdout_handler.setStream(sys.stdout) + cls.stdout_handler.setFormatter(cls.formatter) + cls.stdout_handler.addFilter(MPIFilterStdout()) + + cls.rank0.addHandler(cls.stdout_handler) + cls.all_ranks.addHandler(cls.stdout_handler)
+ + +def format_timedelta(timedelta): + days = timedelta.days + hours, rem = divmod(timedelta.seconds, 3600) + minutes, seconds = divmod(rem, 60) + microseconds = timedelta.microseconds + ret_str = "" + if days != 0: + ret_str += f"{days} days " + ret_str += f"{hours:02d}:{minutes:02d}:{seconds:02d}.{microseconds:06d}" + return ret_str + + +def get_version(): + # Check if we are in a git repo and grab the commit hash and the branch if + # we are, append it to the version number in the output specification. + try: + import git + + try: + repo_dir = os.path.abspath( + os.path.join(os.path.dirname(__file__), os.pardir) + ) + repo = git.Repo(repo_dir) + commit = str(repo.head.commit)[:7] + branch = repo.active_branch + version = f"{__version__} [{branch} branch commit {commit}]" + except git.exc.InvalidGitRepositoryError: + version = f"{__version__}" + except ModuleNotFoundError: + version = f"{__version__}" + + return version + + +def print_header(): + banner = r""" + __ __ ____ __ _______ + / / / /_ __/ / /__ _________ _____ ______ / |/ / __ \ + / /_/ / / / / / / _ \/ ___/ __ `/ __ `/ ___/ / /|_/ / / / / + / __ / /_/ / / / __/ / / /_/ / /_/ (__ ) / / / / /_/ / + /_/ /_/\__, /_/_/\___/_/ \__,_/\__,_/____/ /_/ /_/_____/ + /____/ + """ + + refs_set = """ + + [1] Ledum, M.; Sen, S.; Li, X.; Carrer, M.; Feng Y.; Cascella, M.; Bore, S. L. + HylleraasMD: A Domain Decomposition-Based Hybrid Particle-Field Software for Multi-Scale Simulations of Soft Matter. + J. Chem. Theory Comput. 2023. + + [2] Ledum, M.; Carrer, M.; Sen, S.; Li, X.; Cascella, M.; Bore, S. L. + HyMD: Massively parallel hybrid particle-field molecular dynamics in Python. + J. Open Source Softw. 8(84), 4149, 2023. + + [3] Sen, S.; Ledum, M.; Bore, S. L.; Cascella, M. + Soft Matter under Pressure: Pushing Particle–Field Molecular Dynamics to the Isobaric Ensemble. + J Chem Inf Model 2023, 63(7), 1549-9596. + + [4] Bore, S. L.; Cascella, M. + Hamiltonian and alias-free hybrid particle–field molecular dynamics. + J. Chem. Phys. 2020, 153, 094106. + + [5] Pippig, M. PFFT: An extension of FFTW to massively parallel architectures. + SIAM J. Sci. Comput. 2013, 35, C213–C236. + +""" + + version = f"Version {get_version()}" + header = banner + header += version.center(56) + "\n\n" + #header += " Please read and cite the references below:" + header += " PLEASE READ AND CITE THE REFERENCES BELOW:" + header += refs_set + + return header +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/_modules/hymd/thermostat.html b/v1.0.8/_modules/hymd/thermostat.html new file mode 100644 index 00000000..d9b73ce4 --- /dev/null +++ b/v1.0.8/_modules/hymd/thermostat.html @@ -0,0 +1,494 @@ + + + + + + hymd.thermostat — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.thermostat

+"""Scales or otherwise modifies the particle velocities during simulation to
+simulate coupling to an external heat bath with temperature T₀.
+"""
+import numpy as np
+import logging
+from mpi4py import MPI
+from typing import Callable
+from .logger import Logger
+from .input_parser import Config
+
+
+def cancel_com_momentum(velocities, config, comm=MPI.COMM_WORLD):
+    com_velocity = comm.allreduce(np.sum(velocities[...], axis=0), MPI.SUM)
+    velocities[...] = velocities[...] - com_velocity / config.n_particles
+    return velocities
+
+
+def generate_initial_velocities(velocities, config, prng, comm=MPI.COMM_WORLD):
+    kT_start = config.gas_constant * config.start_temperature
+    n_particles_ = velocities.shape[0]
+    velocities[...] = prng.normal(
+        loc=0, scale=kT_start / config.mass, size=(n_particles_, 3)
+    )
+    velocities = cancel_com_momentum(velocities, config, comm=comm)
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    start_kinetic_energy_target = (
+        1.5 * config.gas_constant * config.n_particles * config.start_temperature
+    )
+    factor = np.sqrt(1.5 * config.n_particles * kT_start / kinetic_energy)
+    velocities[...] = velocities[...] * factor
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    Logger.rank0.log(
+        logging.INFO,
+        (
+            f"Initialized {config.n_particles} velocities, target kinetic "
+            f"energy: {start_kinetic_energy_target}, actual kinetic energy "
+            f"generated: {kinetic_energy}"
+        ),
+    )
+    return velocities
+
+
+
[docs]def _random_gaussian(prng: np.random.Generator) -> float: + """Draw a single random number from the standard normal distribution + Generate a number from the Gaussian distribution centered at zero with unit + standard deviation, :math:`N(0, 1)`. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + + Returns + ------- + float + A random number drawn from :math:`N(0, 1)`. + """ + return prng.normal()
+ + +
[docs]def _random_chi_squared(prng: np.random.Generator, M: int) -> float: + """Draw the sum of :code:`M` squared normally distributed values + + The value is generated by the Gamma distribution, in lieu of generating + :code:`M` Gaussian distributed numbers and summing their squares. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + M : int + Number of standard normally distributed numbers in the sum. + + Returns + ------- + float + The sum of :code:`M` squared normally distributed values centered at + zero with unit standard deviation. + + Notes + ----- + The sum of the squares of k independent standard normal random variables is + distributed according to a :math:`\\chi^2` distribution. + + .. math:: + + \\chi^2_1 + \\chi_2^2 + \\chi_3^2 + \\dots + \\chi_M^2 + \\sim + \\sigma^2\\chi^2(k) + + This is a special case of the :math:`\\Gamma` distribution, + :math:`\\Gamma(k/2, 2)`, and may be generated by + + .. math:: + + \\chi^2(k) \\sim 2 \\Gamma(k/2, 2) + + References + ---------- + Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of + Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. + J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246. + """ + return prng.chisquare(M)
+ + +
[docs]def csvr_thermostat( + velocity: np.ndarray, + names: np.ndarray, + config: Config, + prng: np.random.Generator, + comm: MPI.Intracomm = MPI.COMM_WORLD, + random_gaussian: Callable[[np.random.Generator], float] = _random_gaussian, + random_chi_squared: Callable[ + [np.random.Generator, int, float], float + ] = _random_chi_squared, + remove_center_of_mass_momentum: bool = True, +) -> np.ndarray: + """Canonical sampling through velocity rescaling thermostat + + Implements the CSVR thermostat. Rescales the system kinetic energy by a + stochastically chosen factor to keep the temperature constant. Requires + communcation of the kinetic energies calculated locally for each MPI rank. + The random numbers sampled through :code:`random_gaussian` and + :code:`random_chi_squared` are broadcast from the root rank to the other + ranks to ensure the scaling is performed with the same stochasticity for + all particles in the full system. + + The velocities are cleaned of center of mass momentum before the thermostat + is applied, and the center of mass momentum is subsequently reapplied. This + is performed for each thermostat coupling group, i.e. the center of mass + momenta of each *group* is separately removed and reapplied after + thermostatting. + + The implementation here is based on the derivation presented in the 2008 + Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper. + + Parameters + ---------- + velocity : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + names : (N,) numpy.ndarray + Array of particle names. + config : Config + Configuration dataclass containing simulation metadata and parameters. + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + random_gaussian : callable, optional + Function for generating standard normally distributed numbers. + random_chi_squared : callable, optional + Function for generating :math:`\\chi^2`-distributed numbers + remove_center_of_mass_momentum : bool, optional + If True, the center of mass of each coupling group is removed before + the thermostat is applied. The center of mass momenta are added back + after the kinetic energy rescaling is complete. + + See Also + -------- + _random_gaussian : + Used to sample Gaussian-distributed numbers. + _random_chi_squared : + Used to sample :math:`\\chi^2`-distributed numbers. + hymd.input_parser.Config : + Configuration dataclass handler. + + References + ---------- + G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). + G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008). + """ + if not any(config.thermostat_coupling_groups): + config.thermostat_coupling_groups = [config.unique_names.copy()] + for i, group in enumerate(config.thermostat_coupling_groups): + ind = np.where( + np.logical_or.reduce(list(names == np.string_(t) for t in group)) + ) + group_n_particles = comm.allreduce(len(ind[0]), MPI.SUM) + + # Clean velocities of center of mass momentum + if remove_center_of_mass_momentum and group_n_particles > 1: + com_velocity = comm.allreduce(np.sum(velocity[ind], axis=0)) + velocity_clean = velocity[ind] - com_velocity / group_n_particles + K = comm.allreduce(0.5 * config.mass * np.sum(velocity_clean[...] ** 2)) + else: + K = comm.allreduce(0.5 * config.mass * np.sum(velocity[...] ** 2)) + K_target = ( + 1.5 * config.gas_constant * group_n_particles * config.target_temperature + ) + N_f = 3 * group_n_particles + c = np.exp(-(config.time_step * config.respa_inner) / config.tau) + + # Random numbers are identical across ranks because all ranks have + # the same prng after the initialization of the velocities + R = random_gaussian(prng) + SNf = random_chi_squared(prng, N_f - 1) + + alpha2 = ( + c + + (1 - c) * (SNf + R**2) * K_target / (N_f * K) + + 2 * R * np.sqrt(c * (1 - c) * K_target / (N_f * K)) + ) + dK = K * (alpha2 - 1) + alpha = np.sqrt(alpha2) + + if remove_center_of_mass_momentum and group_n_particles > 1: + # Assign velocities and reapply the previously removed center + # of mass momentum removed + velocity_clean *= alpha + velocity[ind] = velocity_clean + com_velocity / group_n_particles + else: + velocity *= alpha + config.thermostat_work += dK
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/_modules/index.html b/v1.0.8/_modules/index.html new file mode 100644 index 00000000..beb43c1e --- /dev/null +++ b/v1.0.8/_modules/index.html @@ -0,0 +1,282 @@ + + + + + + Overview: module code — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+ +
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/v1.0.8/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css new file mode 100644 index 00000000..1b057df2 --- /dev/null +++ b/v1.0.8/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css @@ -0,0 +1 @@ +.badge{border-radius:.25rem;display:inline-block;font-size:75%;font-weight:700;line-height:1;padding:.25em .4em;text-align:center;vertical-align:baseline;white-space:nowrap}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{border-radius:10rem;padding-left:.6em;padding-right:.6em}.badge-primary{background-color:#007bff;color:#fff}.badge-primary[href]:focus,.badge-primary[href]:hover{background-color:#0062cc;color:#fff;text-decoration:none}.badge-secondary{background-color:#6c757d;color:#fff}.badge-secondary[href]:focus,.badge-secondary[href]:hover{background-color:#545b62;color:#fff;text-decoration:none}.badge-success{background-color:#28a745;color:#fff}.badge-success[href]:focus,.badge-success[href]:hover{background-color:#1e7e34;color:#fff;text-decoration:none}.badge-info{background-color:#17a2b8;color:#fff}.badge-info[href]:focus,.badge-info[href]:hover{background-color:#117a8b;color:#fff;text-decoration:none}.badge-warning{background-color:#ffc107;color:#212529}.badge-warning[href]:focus,.badge-warning[href]:hover{background-color:#d39e00;color:#212529;text-decoration:none}.badge-danger{background-color:#dc3545;color:#fff}.badge-danger[href]:focus,.badge-danger[href]:hover{background-color:#bd2130;color:#fff;text-decoration:none}.badge-light{background-color:#f8f9fa;color:#212529}.badge-light[href]:focus,.badge-light[href]:hover{background-color:#dae0e5;color:#212529;text-decoration:none}.badge-dark{background-color:#343a40;color:#fff}.badge-dark[href]:focus,.badge-dark[href]:hover{background-color:#1d2124;color:#fff;text-decoration:none}.border-0{border:0 !important}.border-top-0{border-top:0 !important}.border-right-0{border-right:0 !important}.border-bottom-0{border-bottom:0 !important}.border-left-0{border-left:0 !important}.p-0{padding:0 !important}.pt-0,.py-0{padding-top:0 !important}.pr-0,.px-0{padding-right:0 !important}.pb-0,.py-0{padding-bottom:0 !important}.pl-0,.px-0{padding-left:0 !important}.p-1{padding:.25rem !important}.pt-1,.py-1{padding-top:.25rem !important}.pr-1,.px-1{padding-right:.25rem !important}.pb-1,.py-1{padding-bottom:.25rem !important}.pl-1,.px-1{padding-left:.25rem !important}.p-2{padding:.5rem !important}.pt-2,.py-2{padding-top:.5rem !important}.pr-2,.px-2{padding-right:.5rem !important}.pb-2,.py-2{padding-bottom:.5rem !important}.pl-2,.px-2{padding-left:.5rem !important}.p-3{padding:1rem !important}.pt-3,.py-3{padding-top:1rem !important}.pr-3,.px-3{padding-right:1rem !important}.pb-3,.py-3{padding-bottom:1rem !important}.pl-3,.px-3{padding-left:1rem !important}.p-4{padding:1.5rem !important}.pt-4,.py-4{padding-top:1.5rem !important}.pr-4,.px-4{padding-right:1.5rem !important}.pb-4,.py-4{padding-bottom:1.5rem !important}.pl-4,.px-4{padding-left:1.5rem !important}.p-5{padding:3rem !important}.pt-5,.py-5{padding-top:3rem !important}.pr-5,.px-5{padding-right:3rem !important}.pb-5,.py-5{padding-bottom:3rem !important}.pl-5,.px-5{padding-left:3rem !important}.m-0{margin:0 !important}.mt-0,.my-0{margin-top:0 !important}.mr-0,.mx-0{margin-right:0 !important}.mb-0,.my-0{margin-bottom:0 !important}.ml-0,.mx-0{margin-left:0 !important}.m-1{margin:.25rem !important}.mt-1,.my-1{margin-top:.25rem !important}.mr-1,.mx-1{margin-right:.25rem !important}.mb-1,.my-1{margin-bottom:.25rem !important}.ml-1,.mx-1{margin-left:.25rem !important}.m-2{margin:.5rem !important}.mt-2,.my-2{margin-top:.5rem !important}.mr-2,.mx-2{margin-right:.5rem !important}.mb-2,.my-2{margin-bottom:.5rem !important}.ml-2,.mx-2{margin-left:.5rem !important}.m-3{margin:1rem !important}.mt-3,.my-3{margin-top:1rem !important}.mr-3,.mx-3{margin-right:1rem !important}.mb-3,.my-3{margin-bottom:1rem !important}.ml-3,.mx-3{margin-left:1rem !important}.m-4{margin:1.5rem !important}.mt-4,.my-4{margin-top:1.5rem !important}.mr-4,.mx-4{margin-right:1.5rem !important}.mb-4,.my-4{margin-bottom:1.5rem !important}.ml-4,.mx-4{margin-left:1.5rem !important}.m-5{margin:3rem !important}.mt-5,.my-5{margin-top:3rem !important}.mr-5,.mx-5{margin-right:3rem !important}.mb-5,.my-5{margin-bottom:3rem !important}.ml-5,.mx-5{margin-left:3rem !important}.btn{background-color:transparent;border:1px solid transparent;border-radius:.25rem;color:#212529;cursor:pointer;display:inline-block;font-size:1rem;font-weight:400;line-height:1.5;padding:.375rem .75rem;text-align:center;transition:color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none;vertical-align:middle}.btn:hover{color:#212529;text-decoration:none}.btn:visited{color:#212529}.btn.focus,.btn:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.25);outline:0}.btn.disabled,.btn:disabled{opacity:.65}@media (prefers-reduced-motion: reduce){.btn{transition:none}}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary:visited{color:#fff}.btn-primary:hover{background-color:#0069d9;border-color:#0062cc;color:#fff}.btn-primary.focus,.btn-primary:focus{background-color:#0069d9;border-color:#0062cc;box-shadow:0 0 0 .2rem rgba(0,123,255,0.5);color:#fff}.btn-primary.disabled,.btn-primary:disabled{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary.active:not(:disabled):not(.disabled),.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{background-color:#0062cc;border-color:#005cbf;color:#fff}.btn-primary.active:not(:disabled):not(.disabled):focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-secondary{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary:visited{color:#fff}.btn-secondary:hover{background-color:#5a6268;border-color:#545b62;color:#fff}.btn-secondary.focus,.btn-secondary:focus{background-color:#5a6268;border-color:#545b62;box-shadow:0 0 0 .2rem rgba(108,117,125,0.5);color:#fff}.btn-secondary.disabled,.btn-secondary:disabled{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled),.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{background-color:#545b62;border-color:#4e555b;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled):focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-success{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success:visited{color:#fff}.btn-success:hover{background-color:#218838;border-color:#1e7e34;color:#fff}.btn-success.focus,.btn-success:focus{background-color:#218838;border-color:#1e7e34;box-shadow:0 0 0 .2rem rgba(40,167,69,0.5);color:#fff}.btn-success.disabled,.btn-success:disabled{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success.active:not(:disabled):not(.disabled),.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{background-color:#1e7e34;border-color:#1c7430;color:#fff}.btn-success.active:not(:disabled):not(.disabled):focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-info{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info:visited{color:#fff}.btn-info:hover{background-color:#138496;border-color:#117a8b;color:#fff}.btn-info.focus,.btn-info:focus{background-color:#138496;border-color:#117a8b;box-shadow:0 0 0 .2rem rgba(23,162,184,0.5);color:#fff}.btn-info.disabled,.btn-info:disabled{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info.active:not(:disabled):not(.disabled),.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{background-color:#117a8b;border-color:#10707f;color:#fff}.btn-info.active:not(:disabled):not(.disabled):focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-warning{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning:visited{color:#212529}.btn-warning:hover{background-color:#e0a800;border-color:#d39e00;color:#212529}.btn-warning.focus,.btn-warning:focus{background-color:#e0a800;border-color:#d39e00;box-shadow:0 0 0 .2rem rgba(255,193,7,0.5);color:#212529}.btn-warning.disabled,.btn-warning:disabled{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning.active:not(:disabled):not(.disabled),.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{background-color:#d39e00;border-color:#c69500;color:#212529}.btn-warning.active:not(:disabled):not(.disabled):focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-danger{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger:visited{color:#fff}.btn-danger:hover{background-color:#c82333;border-color:#bd2130;color:#fff}.btn-danger.focus,.btn-danger:focus{background-color:#c82333;border-color:#bd2130;box-shadow:0 0 0 .2rem rgba(220,53,69,0.5);color:#fff}.btn-danger.disabled,.btn-danger:disabled{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger.active:not(:disabled):not(.disabled),.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{background-color:#bd2130;border-color:#b21f2d;color:#fff}.btn-danger.active:not(:disabled):not(.disabled):focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-light{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light:visited{color:#212529}.btn-light:hover{background-color:#e2e6ea;border-color:#dae0e5;color:#212529}.btn-light.focus,.btn-light:focus{background-color:#e2e6ea;border-color:#dae0e5;box-shadow:0 0 0 .2rem rgba(248,249,250,0.5);color:#212529}.btn-light.disabled,.btn-light:disabled{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light.active:not(:disabled):not(.disabled),.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{background-color:#dae0e5;border-color:#d3d9df;color:#212529}.btn-light.active:not(:disabled):not(.disabled):focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-dark{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark:visited{color:#fff}.btn-dark:hover{background-color:#23272b;border-color:#1d2124;color:#fff}.btn-dark.focus,.btn-dark:focus{background-color:#23272b;border-color:#1d2124;box-shadow:0 0 0 .2rem rgba(52,58,64,0.5);color:#fff}.btn-dark.disabled,.btn-dark:disabled{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark.active:not(:disabled):not(.disabled),.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{background-color:#1d2124;border-color:#171a1d;color:#fff}.btn-dark.active:not(:disabled):not(.disabled):focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-primary{border-color:#007bff;color:#007bff}.btn-outline-primary:visited{color:#007bff}.btn-outline-primary:hover{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{background-color:transparent;color:#007bff}.btn-outline-primary.active:not(:disabled):not(.disabled),.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.active:not(:disabled):not(.disabled):focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-secondary{border-color:#6c757d;color:#6c757d}.btn-outline-secondary:visited{color:#6c757d}.btn-outline-secondary:hover{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{background-color:transparent;color:#6c757d}.btn-outline-secondary.active:not(:disabled):not(.disabled),.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.active:not(:disabled):not(.disabled):focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-success{border-color:#28a745;color:#28a745}.btn-outline-success:visited{color:#28a745}.btn-outline-success:hover{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{background-color:transparent;color:#28a745}.btn-outline-success.active:not(:disabled):not(.disabled),.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.active:not(:disabled):not(.disabled):focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-info{border-color:#17a2b8;color:#17a2b8}.btn-outline-info:visited{color:#17a2b8}.btn-outline-info:hover{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{background-color:transparent;color:#17a2b8}.btn-outline-info.active:not(:disabled):not(.disabled),.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.active:not(:disabled):not(.disabled):focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-warning{border-color:#ffc107;color:#ffc107}.btn-outline-warning:visited{color:#ffc107}.btn-outline-warning:hover{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{background-color:transparent;color:#ffc107}.btn-outline-warning.active:not(:disabled):not(.disabled),.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.active:not(:disabled):not(.disabled):focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-danger{border-color:#dc3545;color:#dc3545}.btn-outline-danger:visited{color:#dc3545}.btn-outline-danger:hover{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{background-color:transparent;color:#dc3545}.btn-outline-danger.active:not(:disabled):not(.disabled),.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.active:not(:disabled):not(.disabled):focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-light{border-color:#f8f9fa;color:#f8f9fa}.btn-outline-light:visited{color:#f8f9fa}.btn-outline-light:hover{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{background-color:transparent;color:#f8f9fa}.btn-outline-light.active:not(:disabled):not(.disabled),.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.active:not(:disabled):not(.disabled):focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-dark{border-color:#343a40;color:#343a40}.btn-outline-dark:visited{color:#343a40}.btn-outline-dark:hover{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{background-color:transparent;color:#343a40}.btn-outline-dark.active:not(:disabled):not(.disabled),.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.active:not(:disabled):not(.disabled):focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-link{color:#007bff;font-weight:400;text-decoration:none}.btn-link:hover{color:#0056b3;text-decoration:underline}.btn-link.focus,.btn-link:focus{box-shadow:none;text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{border-radius:.3rem;font-size:1.25rem;line-height:1.5;padding:.5rem 1rem}.btn-group-sm>.btn,.btn-sm{border-radius:.2rem;font-size:.875rem;line-height:1.5;padding:.25rem .5rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input.btn-block[type=button],input.btn-block[type=reset],input.btn-block[type=submit]{width:100%}.stretched-link::after{background-color:rgba(0,0,0,0);bottom:0;content:'';left:0;pointer-events:auto;position:absolute;right:0;top:0;z-index:1}.text-wrap{white-space:normal !important}.card{background-clip:border-box;background-color:#fff;border:1px solid rgba(0,0,0,0.125);border-radius:.25rem;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;min-width:0;position:relative;word-wrap:break-word}.card>hr{margin-left:0;margin-right:0}.card>.list-group:first-child .list-group-item:first-child{border-top-left-radius:.25rem;border-top-right-radius:.25rem}.card>.list-group:last-child .list-group-item:last-child{border-bottom-left-radius:.25rem;border-bottom-right-radius:.25rem}.card-body{-ms-flex:1 1 auto;flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-bottom:0;margin-top:-.375rem}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{background-color:rgba(0,0,0,0.03);border-bottom:1px solid rgba(0,0,0,0.125);margin-bottom:0;padding:.75rem 1.25rem}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-header+.list-group .list-group-item:first-child{border-top:0}.card-footer{background-color:rgba(0,0,0,0.03);border-top:1px solid rgba(0,0,0,0.125);padding:.75rem 1.25rem}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{border-bottom:0;margin-bottom:-.75rem;margin-left:-.625rem;margin-right:-.625rem}.card-header-pills{margin-left:-.625rem;margin-right:-.625rem}.card-img-overlay{bottom:0;left:0;padding:1.25rem;position:absolute;right:0;top:0}.card-img,.card-img-bottom,.card-img-top{-ms-flex-negative:0;flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-left-radius:calc(.25rem - 1px);border-bottom-right-radius:calc(.25rem - 1px)}.w-100{width:100% !important}.shadow{box-shadow:0 0.5rem 1rem rgba(0,0,0,0.15) !important}.bg-primary{background-color:#007bff !important}button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc !important}a.bg-primary:focus,a.bg-primary:hover{background-color:#0062cc !important}a.text-primary:focus,a.text-primary:hover{color:#121416 !important}.bg-secondary{background-color:#6c757d !important}button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62 !important}a.bg-secondary:focus,a.bg-secondary:hover{background-color:#545b62 !important}a.text-secondary:focus,a.text-secondary:hover{color:#121416 !important}.bg-success{background-color:#28a745 !important}button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34 !important}a.bg-success:focus,a.bg-success:hover{background-color:#1e7e34 !important}a.text-success:focus,a.text-success:hover{color:#121416 !important}.bg-info{background-color:#17a2b8 !important}button.bg-info:focus,button.bg-info:hover{background-color:#117a8b !important}a.bg-info:focus,a.bg-info:hover{background-color:#117a8b !important}a.text-info:focus,a.text-info:hover{color:#121416 !important}.bg-warning{background-color:#ffc107 !important}button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00 !important}a.bg-warning:focus,a.bg-warning:hover{background-color:#d39e00 !important}a.text-warning:focus,a.text-warning:hover{color:#121416 !important}.bg-danger{background-color:#dc3545 !important}button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130 !important}a.bg-danger:focus,a.bg-danger:hover{background-color:#bd2130 !important}a.text-danger:focus,a.text-danger:hover{color:#121416 !important}.bg-light{background-color:#f8f9fa !important}button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5 !important}a.bg-light:focus,a.bg-light:hover{background-color:#dae0e5 !important}a.text-light:focus,a.text-light:hover{color:#121416 !important}.bg-dark{background-color:#343a40 !important}button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124 !important}a.bg-dark:focus,a.bg-dark:hover{background-color:#1d2124 !important}a.text-dark:focus,a.text-dark:hover{color:#121416 !important}.bg-white{background-color:#fff !important}button.bg-white:focus,button.bg-white:hover{background-color:#e6e6e6 !important}a.bg-white:focus,a.bg-white:hover{background-color:#e6e6e6 !important}a.text-white:focus,a.text-white:hover{color:#121416 !important}.text-primary{color:#007bff !important}.text-secondary{color:#6c757d !important}.text-success{color:#28a745 !important}.text-info{color:#17a2b8 !important}.text-warning{color:#ffc107 !important}.text-danger{color:#dc3545 !important}.text-light{color:#f8f9fa !important}.text-dark{color:#343a40 !important}.text-white{color:#fff !important}.text-body{color:#212529 !important}.text-muted{color:#6c757d !important}.text-black-50{color:rgba(0,0,0,0.5) !important}.text-white-50{color:rgba(255,255,255,0.5) !important}.bg-transparent{background-color:transparent !important}.text-justify{text-align:justify !important}.text-left{text-align:left !important}.text-right{text-align:right !important}.text-center{text-align:center !important}.font-weight-light{font-weight:300 !important}.font-weight-lighter{font-weight:lighter !important}.font-weight-normal{font-weight:400 !important}.font-weight-bold{font-weight:700 !important}.font-weight-bolder{font-weight:bolder !important}.font-italic{font-style:italic !important}.container{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container{max-width:540px}}@media (min-width: 768px){.container{max-width:720px}}@media (min-width: 992px){.container{max-width:960px}}@media (min-width: 1200px){.container{max-width:1140px}}.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container,.container-sm{max-width:540px}}@media (min-width: 768px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width: 992px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width: 1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1140px}}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;margin-right:-15px}.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{padding-left:15px;padding-right:15px;position:relative;width:100%}@media (min-width: 576px){.col-sm{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-sm-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-sm-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-sm-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-sm-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-sm-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 768px){.col-md{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-md-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-md-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-md-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-md-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-md-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 992px){.col-lg{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-lg-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-lg-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-lg-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-lg-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-lg-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 1200px){.col-xl{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-xl-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-xl-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-xl-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-xl-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-xl-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}.d-flex{display:-ms-flexbox !important;display:flex !important}.sphinx-bs,.sphinx-bs *{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sphinx-bs p{margin-top:0} diff --git a/v1.0.8/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/v1.0.8/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css new file mode 100644 index 00000000..fc14abc8 --- /dev/null +++ b/v1.0.8/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css @@ -0,0 +1 @@ +details.dropdown .summary-title{padding-right:3em !important;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none}details.dropdown:hover{cursor:pointer}details.dropdown .summary-content{cursor:default}details.dropdown summary{list-style:none;padding:1em}details.dropdown summary .octicon.no-title{vertical-align:middle}details.dropdown[open] summary .octicon.no-title{visibility:hidden}details.dropdown summary::-webkit-details-marker{display:none}details.dropdown summary:focus{outline:none}details.dropdown summary:hover .summary-up svg,details.dropdown summary:hover .summary-down svg{opacity:1}details.dropdown .summary-up svg,details.dropdown .summary-down svg{display:block;opacity:.6}details.dropdown .summary-up,details.dropdown .summary-down{pointer-events:none;position:absolute;right:1em;top:.75em}details.dropdown[open] .summary-down{visibility:hidden}details.dropdown:not([open]) .summary-up{visibility:hidden}details.dropdown.fade-in[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out;animation:panels-fade-in .5s ease-in-out}details.dropdown.fade-in-slide-down[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out}@keyframes panels-fade-in{0%{opacity:0}100%{opacity:1}}@keyframes panels-slide-down{0%{transform:translate(0, -10px)}100%{transform:translate(0, 0)}}.octicon{display:inline-block;fill:currentColor;vertical-align:text-top}.tabbed-content{box-shadow:0 -.0625rem var(--tabs-color-overline),0 .0625rem var(--tabs-color-underline);display:none;order:99;padding-bottom:.75rem;padding-top:.75rem;width:100%}.tabbed-content>:first-child{margin-top:0 !important}.tabbed-content>:last-child{margin-bottom:0 !important}.tabbed-content>.tabbed-set{margin:0}.tabbed-set{border-radius:.125rem;display:flex;flex-wrap:wrap;margin:1em 0;position:relative}.tabbed-set>input{opacity:0;position:absolute}.tabbed-set>input:checked+label{border-color:var(--tabs-color-label-active);color:var(--tabs-color-label-active)}.tabbed-set>input:checked+label+.tabbed-content{display:block}.tabbed-set>input:focus+label{outline-style:auto}.tabbed-set>input:not(.focus-visible)+label{outline:none;-webkit-tap-highlight-color:transparent}.tabbed-set>label{border-bottom:.125rem solid transparent;color:var(--tabs-color-label-inactive);cursor:pointer;font-size:var(--tabs-size-label);font-weight:700;padding:1em 1.25em .5em;transition:color 250ms;width:auto;z-index:1}html .tabbed-set>label:hover{color:var(--tabs-color-label-active)} diff --git a/v1.0.8/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css b/v1.0.8/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css new file mode 100644 index 00000000..adc61662 --- /dev/null +++ b/v1.0.8/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css @@ -0,0 +1,7 @@ +:root { +--tabs-color-label-active: hsla(231, 99%, 66%, 1); +--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); +--tabs-color-overline: rgb(207, 236, 238); +--tabs-color-underline: rgb(207, 236, 238); +--tabs-size-label: 1rem; +} \ No newline at end of file diff --git a/v1.0.8/_sources/doc_pages/api.rst.txt b/v1.0.8/_sources/doc_pages/api.rst.txt new file mode 100644 index 00000000..c9f8837b --- /dev/null +++ b/v1.0.8/_sources/doc_pages/api.rst.txt @@ -0,0 +1,90 @@ +.. _api-label: + + +API reference +============= + +Integrator +---------- + +.. automodule:: hymd.integrator + :members: + + +Thermostat +---------- + +.. automodule:: hymd.thermostat + :members: csvr_thermostat, _random_chi_squared, _random_gaussian + :undoc-members: + + +Hamiltonian +----------- + +.. autoclass:: hymd.hamiltonian.Hamiltonian + :members: + + .. automethod:: __init__ + + .. automethod:: _setup + +.. autoclass:: hymd.hamiltonian.SquaredPhi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultNoChi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultWithChi + :members: + + .. automethod:: __init__ + + +Force +----- + +.. automodule:: hymd.force + :members: + :undoc-members: + + +Logger +------ + +.. autoclass:: hymd.logger.Logger + :members: + +.. autoclass:: hymd.logger.MPIFilterRoot + :members: + +.. autoclass:: hymd.logger.MPIFilterAll + :members: + + +Input parser +------------ + +.. automodule:: hymd.input_parser + :members: + :undoc-members: propensity_potential_coeffs + + +Field +----- + +.. automodule:: hymd.field + :members: + + +File input/output +----------------- + +.. automodule:: hymd.file_io + :members: diff --git a/v1.0.8/_sources/doc_pages/benchmarks.rst.txt b/v1.0.8/_sources/doc_pages/benchmarks.rst.txt new file mode 100644 index 00000000..06377a85 --- /dev/null +++ b/v1.0.8/_sources/doc_pages/benchmarks.rst.txt @@ -0,0 +1,93 @@ +.. _benchmarks-label: + +Benchmarks +########## +Homopolymer melt test systems of :math:`30^2`, :math:`40^2`, and :math:`50^2` +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively. + +Bonded forces +^^^^^^^^^^^^^ +Legend label denotes the number of particles in the system. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) + time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 + ], dtype=np.float64) + nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 + ], dtype=np.float64,) + time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, + ], dtype=np.float64) + nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 + ], dtype=np.float64) + time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, + ], dtype=np.float64) + plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" + ) + plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" + ) + plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" + ) + plt.xlabel("CPUs", fontsize=15) + plt.ylabel("Time per step, us", fontsize=15) + plt.legend(fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.show() + + +Particle--field forces +^^^^^^^^^^^^^^^^^^^^^^ +Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + + mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] + mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + + mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + + mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + + mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] + mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + + mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + + mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + + plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") + plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") + plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") + plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") + plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") + plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") + plt.xlabel("CPUs", fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.ylabel("Time per step, s", fontsize=15) + plt.legend(loc="upper left", fontsize=15) + plt.show() diff --git a/v1.0.8/_sources/doc_pages/command_line.rst.txt b/v1.0.8/_sources/doc_pages/command_line.rst.txt new file mode 100644 index 00000000..5233710f --- /dev/null +++ b/v1.0.8/_sources/doc_pages/command_line.rst.txt @@ -0,0 +1,120 @@ +.. _commandline-label: + +Command line arguments +###################### +Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle--field interactions. + + +Required arguments +================== +:configuration file: + :code:`type` positional + + Specifies the :code:`.toml` format configuration file containing simulation details. See :ref:`config-label` for details. + +:structure and topology file: + :code:`type` positional + + Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See :ref:`topology-label` for details. + +Optional arguments +================== +:code:`-v --verbose` + :code:`type` optional + + Number of following arguments: :code:`0` or :code:`1` + + Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying :code:`-v` or :code:`--verbose` with no additional specification. This increases verbosity level by :code:`1`. Alternatively, it maye be specified by :code:`--verbose V` with :code:`V` being :code:`0`, :code:`1`, or :code:`2`. + +:code:`--profile` + :code:`type` optional + + Number of following arguments: :code:`0` + + Enables code profiling using :code:`cProfile`. This will output one profiling file per MPI rank invoked in the simulation. + +:code:`--double-precision` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision internally in HyMD (including in the FFTs). + +:code:`--double-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision in the output trajectory from HyMD. + +:code:`--velocity-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that velocities should be output to the HyMD trajectory. + +:code:`--force-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that forces should be output to the HyMD trajectory. + +:code:`--disable-mpio` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult. + +:code:`--logfile` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the path of a plain text log file in which stdout is mirrored during simulation runs. + +:code:`--seed` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the random seed used in the :code:`numpy` random library to generate velocities, thermostatting, etc. + +:code:`--disable-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any two-particle bonds present in the system. + +:code:`--disable-angle-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any three-particle bonds present in the system. + +:code:`--disable-dihedrals` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any four-particle bonds present in the system. + +:code:`--disable-dipole` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any topological reconstruction of peptide backbone dipoles present in the system. + +:code:`--disable-field` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any particle--field interactions present in the system. diff --git a/v1.0.8/_sources/doc_pages/config_file.rst.txt b/v1.0.8/_sources/doc_pages/config_file.rst.txt new file mode 100644 index 00000000..40ee0479 --- /dev/null +++ b/v1.0.8/_sources/doc_pages/config_file.rst.txt @@ -0,0 +1,194 @@ +.. _config-label: + +Configuration file +################## +The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order. + +The configuration file is a `toml`_ format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs. + +.. _`toml`: + https://github.com/toml-lang/toml + +.. role:: required + +Configuration file keywords +--------------------------- + +The following constitutes every possible keyword specification in HyMD +configuration files: + +Metadata keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying metadata for the H5MD output trajectory. + +:name: + :code:`string` [**optional**, default: :code:`None`] + + Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file. + + +:tags: + :code:`array` [:code:`string`] [**optional**, default: :code:`None`] + + Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file. + + +Particle keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying properties of particles and molecules in the +system. + +:n_particles: + :code:`integer` [**optional**, default: :code:`None`] + + Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules. + +:mass: + :code:`float` [**optional**, default: :code:`72.0`] {units: :math:`\text{u}=\text{g}\,\text{mol}^{-1}`} + + Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal. + +:max_molecule_size: + :code:`integer` [**optional**, default: :code:`201`] + + Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code **will** crash if there are molecules larger than :code:`max_molecule_size` in the topology/structure input file. + + +Simulation keywords +^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying simulation parameters. + +:n_steps: + :code:`integer` [:required:`required`] + + Total number of integration steps to perform for this simulation. + +:n_print: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of *number of time steps*). + +:n_flush: + :code:`integer` [**optional**, default: :code:`None`] + + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of *number of* :code:`n_print`, i.e. :code:`n_print = 13`, :code:`n_flush = 3` would result in the trajectory/energy being written to disk every :code:`13 x 3 = 39` *simulation steps*) + +:time_step: + :code:`float` [:required:`required`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time step per integration step. If the rRESPA multiple time step integrator is used (:code:`integrator = "respa"`), this specifies the **inner** time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is :code:`respa_inner` times the :code:`time_step` , and the total simulation time is :code:`n_steps` times :code:`time_step` times :code:`respa_inner` . + +:box_size: + :code:`array` [:code:`float`] [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable. + +:integrator: + :code:`string` [:required:`required`] (options: :code:`velocity-verlet` or :code:`respa`) + + Specifies the time integrator used in the simulation. If :code:`respa`, the *reversible reference system propagator algorithm (rRESPA)* :cite:`tuckerman1992reversible` integrator is used, with :code:`respa_inner` number of inner (intramolecular force) time steps. If :code:`velocity-verlet`, a normal Velocity Verlet integrator is used. If :code:`respa` and :code:`respa_inner = 1`, the rRESPA integrator is equivalent to the Velocity Verlet. + +:respa_inner: + :code:`integer` [**optional**, default: :code:`1`] + + The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces. + +:domain_decomposition: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Specifies the interval (in time steps) of *domain decomposition exchange*, involving all MPI ranks sending and receiving particles according to the particles' positions in the integration box and the MPI ranks' assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If :code:`True`, the decomposition is performed once (before starting the simulation). If :code:`False`, no decomposition is performed. + +:cancel_com_momentum: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + If :code:`True`, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every :code:`remove_com_momentum` time steps. If :code:`False`, the linear momentum is never removed. + +:start_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at :code:`start_temperature` Kelvin prior to starting the simulation. If :code:`False`, the velocities are not changed before starting the simulation. + +:target_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Couple the system to a heat bath at :code:`target_temperature` Kelvin by applying a *Canonical sampling through velocity rescaling* :cite:`Bussi2007JCP` thermostat with coupling strength :code:`tau`. If :code:`False`, no temperature control is applied. + +:tau: + :code:`float` [**optional**, default: :code:`0.7`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the CSVR thermostat coupling. In the limit of :code:`tau → ∞`, the Hamiltonian dynamics are preserved and no temperature coupling takes place. + +:thermostat_coupling_groups: + :code:`array` [:code:`array` [:code:`string`]] [**optional**, default: :code:`[]`] + + Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and :code:`"C"` type particles, :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would thermalise types :code:`"A"` and :code:`"B"` together and couple :code:`"C"` type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. :code:`target_temperature` Kelvin). +:hamiltonian: + :code:`string` [**optional**, default: :code:`"DefaultNohChi"`] (options: :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`) + + Specifies the interaction energy functional :math:`W[\tilde\phi]` for use with the particle-field interactions. See :ref:`functionals-label` for details. + + +Field keywords +^^^^^^^^^^^^^^ +Configuration keywords specifying field parameters. + +:mesh_size: + :code:`array` [:code:`integer`] or :code:`integer` [:required:`required`] + + Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is :code:`box_size / mesh_size`. + +:kappa: + :code:`float` [:required:`required`] {units: :math:`\text{kJ}^{-1}\text{mol}`} + + Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional :math:`W[\tilde\phi]`. See :ref:`functionals-label` for more details. + +:sigma: + :code:`float` [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See :ref:`filtering-label` for more details. + +:chi: + :code:`array` [:code:`array` [:code:`string`, :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}`} + + Array of :math:`\tilde\chi_\text{AB}`-parameters indicating the strength of the repulsive or attractive interaction between particles of type :code:`"A"` and the number density due to particles of type :code:`"B"`, and vice versa. Example: :code:`chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ]` would specify a repulsive :code:`"A"`--:code:`"B"` type interaction, and a weakly attractive :code:`"C"`--:code:`"D"` interaction. Self-interaction :math:`\tilde\chi`-terms are always zero. See :ref:`functionals-label` for more details. + + +Bond keywords +^^^^^^^^^^^^^ +Configuration keywords specifying bonds and bonds parameters. + +:bonds: + :code:`array` [:code:`array` [2 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{nm}=10^{-9}~\text{m}` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: :code:`bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ]` indicates a :code:`"A"`--:code:`"A"` bond of equilibrium length :code:`0.47` :math:`\text{nm}` with a bond strength of :code:`980.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding bond between :code:`"A"` and :code:`"B"` type particles with equilibrium length :code:`0.31` :math:`\text{nm}` and a strength of :code:`1250.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify stretching bonds. + +:angle_bonds: + :code:`array` [:code:`array` [3 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`{}^\circ` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: :code:`bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ]` indicates a :code:`"A"`--:code:`"A"`--:code:`"A"` angular bond that tries to keep the bond linear at :code:`180` degrees with a bending strength of :code:`55.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding angle bond between :code:`"A"`--:code:`"B"`--:code:`"B"` prefering the angle at :code:`120` degrees and a strength of :code:`25.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify angular bonds. + +:dihedrals: + :code:`array` [:code:`array` [4 :code:`string`, :code:`integer`, :code:`COSINE SERIES` ]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`} + + Specifies four-particle torsional potentials by cosine series. See :ref:`bonds-label` for details about how to specify dihedrals. + + + +Electrostatic keywords +^^^^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying electrostatics and electrostatic parameters. + +:coulombtype: + :code:`string` [**optional**, default: :code:`None`] (options: :code:`PIC_Spectral`) + + Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the :code:`dielectric_const` keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, *not* in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to `PIC_Spectral`. + +:dielectric_const: + :code:`float` [**optional**, default: :code:`None`] + + Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified---even if electrostatics are not included with the :code:`coulombtype` keyword. diff --git a/v1.0.8/_sources/doc_pages/constants_and_units.rst.txt b/v1.0.8/_sources/doc_pages/constants_and_units.rst.txt new file mode 100644 index 00000000..ee429829 --- /dev/null +++ b/v1.0.8/_sources/doc_pages/constants_and_units.rst.txt @@ -0,0 +1,80 @@ +.. _units-label: + +Constants and Units +################### + +HyMD uses the following units and constants internally and in all input and +output: + +.. list-table:: **Units** + :widths: 30 10 75 + :header-rows: 1 + + * - Quantity + - Symbol + - Unit + * - length + - :math:`r` + - :math:`\text{nm}=10^{-9}~\text{m}` + * - time + - :math:`t` + - :math:`\text{ps}=10^{-12}~\text{s}` + * - charge + - :math:`q` + - :math:`e=1.602176634 \cdot 10^{-19}~\text{C}` + * - mass + - :math:`m` + - :math:`\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}` + * - temperature + - :math:`\text{T}` + - :math:`\text{K}` + * - energy + - :math:`E` + - :math:`\text{kJ}\,\text{mol}^{-1}` + * - velocity + - :math:`v` + - :math:`\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}` + * - momentum + - :math:`P` + - :math:`\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}` + * - force + - :math:`\mathbf{F}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}` + * - pressure + - :math:`p` + - :math:`\text{bar}=100~\text{kPa}` + * - electric potential + - :math:`\Psi` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}` + * - electric field + - :math:`\mathbf{E}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}` + * - compressibility + - :math:`\kappa` + - :math:`\text{mol}\,\text{kJ}^{-1}` + * - field-interaction + - :math:`\tilde\chi` + - :math:`\text{kJ}\,\text{mol}^{-1}` + +.. list-table:: **Constants** + :widths: 30 10 75 + :header-rows: 1 + + * - Constant + - Symbol + - Value + * - gas constant + - :math:`R` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Boltzmann’s constant + - :math:`k_\text{B}` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Avogadro's constant + - :math:`N_\text{A}` + - :math:`6.02214076 \cdot 10^23~\text{mol}^{-1}` + * - Vacuum permittivity + - :math:`\varepsilon_0` + - :math:`8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2` + * - Coulomb constant + - :math:`k_\text{e}` + - :math:`138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}` diff --git a/v1.0.8/_sources/doc_pages/electrostatics.rst.txt b/v1.0.8/_sources/doc_pages/electrostatics.rst.txt new file mode 100644 index 00000000..7e11c09d --- /dev/null +++ b/v1.0.8/_sources/doc_pages/electrostatics.rst.txt @@ -0,0 +1,48 @@ +.. _electrostatics-label: + +Electrostatic interactions +########################## +In the filtered Hamiltonian hPF formalism :cite:`bore2020hamiltonian` the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle--mesh Ewald. + +The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered + +.. math:: + + \tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i), + +with :math:`q_i` being the charge of particle :math:`i` and :math:`H` is the +filtering function (see :ref:`filtering-label`). The value of the charge grid at +vertex :math:`(i,j,k)` is found by + +.. math:: + + \tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)] + +and the electrostatic potential :math:`\Psi_{ijk}` + +.. math:: + + \Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right], + +where :math:`k_\text{e}` is the Coulomb constant :math:`1/4\pi\varepsilon_0`. +The *electric field* is obtained by differentiation of the electrostatic +potential in Fourier space, + +.. math:: + + \mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)] + +from which the forces are interpolated back to the particle positions. + +Specifying electrostatics +^^^^^^^^^^^^^^^^^^^^^^^^^ +In HyMD, electrostatics are specified by the :code:`coulombtype` and +:code:`dielectric_const` keywords in the configuration file (see +:ref:`config-label`) and the :code:`/charge` dataset in the HDF5 format +structure/topology input file (see :ref:`topology-label`). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions. diff --git a/v1.0.8/_sources/doc_pages/examples.rst.txt b/v1.0.8/_sources/doc_pages/examples.rst.txt new file mode 100644 index 00000000..9f9c3655 --- /dev/null +++ b/v1.0.8/_sources/doc_pages/examples.rst.txt @@ -0,0 +1,621 @@ +.. _examples-label: + +Examples +######## +The following examples are ordered in *more or less* order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the `HyMD-tutorial`_ github repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Ideal gas +========= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true + :align: right + :width: 200 + +The simplest possible system is one with no interactions at all---intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like: + + +.. code-block:: toml + :caption: **ideal_gas.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = false # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + +A simple input structure/topology file :code:`ideal_gas.HDF5` is available in +the `HyMD-tutorial/ideal_gas`_ github repository (along with the code to +generate it). Run the (very) short simulation by + +.. code:: bash + + python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field \ + --velocity-output \ + --force-output + +with the :code:`--disable-field` argument to completely turn off all +particle--field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook `ideal_gas.ipynb`_ for details. + + +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas +.. _ideal_gas.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.ipynb + + +Ideal chains +============ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true + :align: right + :width: 200 + +The simplest available interaction is the harmonic two-particle bond (see +:ref:`bonds-label`), + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2. + +Extending the configuration file from the ideal gas case, we need to add a +:code:`bonds` specification. Note that the :code:`[bonds]` meta specifier is not +necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **ideal_chain.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + +A simple input structure/topology file :code:`ideal_chain.HDF5` with a few +coiled up ideal chain polymers is available in the +`HyMD-tutorial/ideal_chain`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field + +we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +`ideal_chain.ipynb`_. + + +.. _HyMD-tutorial/ideal_chain: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_chain +.. _ideal_chain.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/ideal_chain.ipynb + + +Stiff rods +========== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true + :align: right + :width: 200 + +Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the :code:`i--j--k` angle :math:`\theta` (see +:ref:`bonds-label`), + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2. + +Extending the configuration file from the ideal chain case, we need to add a +:code:`angle_bonds` specification. Note that the :code:`[bonds]` meta specifier +is not necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **rods.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + + angle_bonds = [ + ["A", "A", "A", 180.0, 100.0], # (i, j, k, equilibrium angle, strength) + ] + + +A simple input structure/topology file :code:`rods.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook `rods.ipynb`_. + + +.. _HyMD-tutorial/rods: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/rods +.. _rods.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.ipynb + + + +Helixes +======= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true + :align: right + :width: 200 + +Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle :math:`\phi` between the +:code:`i--j--k` plane and the :code:`j--k--l` plane (see :ref:`bonds-label`), + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n). + +The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a :code:`dihedrals` keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the :code:`dielectric_const` +keyword even though we are not including electrostatic forces in the current +simulation. Note that the :code:`[bonds]` meta specifier is not necessary, but +may be used to help organise the input file. + +.. code-block:: toml + :caption: **helixes.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + dielectric_const = 15.0 + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.31, 10000.0], # (i name, j name, equilibrium length, strength) + ] + + dihedrals = [ + [ + ["A", "A", "A", "A"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0] + ], + ] + +A simple input structure/topology file :code:`helixes.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook `helixes.ipynb`_. + + +.. _HyMD-tutorial/helixes: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/helixes +.. _helixes.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.ipynb + + +Phase separation +================ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true + :align: right + :width: 200 + +The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types :code:`A` and :code:`B`. Using the Hamiltonian + +.. math:: + + \mathcal{H}=H_0+W + +with :math:`\tilde\chi`--dependent interactions defined by (specified in the +configuration file by :code:`hamiltonian = DefaultWithChi`): + +.. math:: + + W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2. + + +.. code-block:: toml + :caption: **phase_separation.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + + [field] + mesh_size = [20, 20, 20] # FFT grid size + sigma = 1.0 # filtering length scale in nm + kappa = 0.05 # compressibility in mol/kJ + chi = [ + ['A', 'B', 5.0], # (name i, name j, strength) + ] + +A simple input structure/topology file :code:`phase_separation.HDF5` containing +an equal number of :code:`A` type and :code:`B` type particles is available in +the `HyMD-tutorial/phase_separation`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd phase_separation.toml phase_separation.HDF5 + +we may examine the resulting trajectory. In the case of a low interaction +strength :math:`\tilde\chi` of :code:`5.0` (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to :code:`40.0` (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +`phase_separation.ipynb`_. + + +.. _HyMD-tutorial/phase_separation: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/phase_separation +.. _phase_separation.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/phase_separation.ipynb + + +Diblock copolymers +================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true + :align: right + :width: 200 + +Having introduced particle--field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive :math:`\tilde\chi`--interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the :code:`integrator = "respa"` keyword. Putting the pieces together, the +configuration file may look like the following: + +.. code-block:: toml + :caption: **copolymer.toml** + + [simulation] + integrator = "respa" + respa_inner = 15 + n_steps = 2000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [10.0, 10.0, 10.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [50, 50, 50] # FFT grid size + sigma = 0.5 # filtering length scale in nm + chi = [ + ["A", "B", 30.0], # (i, j, strength) + ] + + [bonds] + bonds = [ + ["A", "A", 0.25, 1500.0], # (i, j, equilibrium length, strength) + ["A", "B", 0.25, 1500.0], + ["B", "B", 0.25, 1500.0], + ] + angle_bonds = [ + ["A", "A", "A", 180.0, 25.0], # (i, j, k, equilibrium angle, strength) + ["B", "B", "B", 180.0, 25.0], + ] + +A simple input structure/topology file :code:`copolymer.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/copolymer`_ github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten :code:`A` followed by ten :code:`B` type particles. +Running the simulation with + +.. code:: bash + + python3 -m hymd copolymer.toml copolymer.HDF5 + +the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +`copolymer.ipynb`_. + + +.. _HyMD-tutorial/copolymer: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/copolymer +.. _copolymer.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer.ipynb + + +Lipid bilayer self-assembly +=========================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true + :align: right + :width: 300 + +Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field--particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the :code:`thermostat_coupling_groups` keyword. With parameters +optimised in :cite:`ledum2020automated`, the configuration file looks like: + + +.. code-block:: toml + :caption: **lipid_self_assembly.toml** + + [simulation] + integrator = "respa" + respa_inner = 25 + n_steps = 3000 + n_print = 200 + n_flush = 1 + time_step = 0.01 + box_size = [9.96924, 9.96924, 10.03970] + start_temperature = 323 + target_temperature = 323 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.05 + domain_decomposition = 10001 + cancel_com_momentum = true + max_molecule_size = 15 + thermostat_coupling_groups = [ + ["N", "P", "G", "C"], + ["W"], + ] + + [field] + mesh_size = [25, 25, 25] + sigma = 1.0 + chi = [ + ["C", "W", 42.24], + ["G", "C", 10.47], + ["N", "W", -3.77], + ["G", "W", 4.53], + ["N", "P", -9.34], + ["P", "G", 8.04], + ["N", "G", 1.97], + ["P", "C", 14.72], + ["P", "W", -1.51], + ["N", "C", 13.56], + ] + + [bonds] + bonds = [ + ["N", "P", 0.47, 1250.0], + ["P", "G", 0.47, 1250.0], + ["G", "G", 0.37, 1250.0], + ["G", "C", 0.47, 1250.0], + ["C", "C", 0.47, 1250.0], + ] + angle_bonds = [ + ["P", "G", "G", 120.0, 25.0], + ["P", "G", "C", 180.0, 25.0], + ["G", "C", "C", 180.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +A randomly mixed input structure/topology file +:code:`lipid_self_assembly.HDF5` with a few hundred lipids in a roughy +:code:`10 x 10 x 10nm` box is available in the +`HyMD-tutorial/lipid_self_assembly`_ github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation + +.. code:: bash + + python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5 + +we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook `lipid_self_assembly.ipynb`_. + + +.. _HyMD-tutorial/lipid_self_assembly: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/lipid_self_assembly +.. _lipid_self_assembly.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/lipid_self_assembly.ipynb + + +Peptide in lipid bilayer +======================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true + :align: right + :width: 300 + +Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer. + + +The `configuration file`_ is available in the `HyMD-tutorial/peptide`_ github +repository (omitted here for brevity). + +A pre-equilibrated input structure/topology file :code:`peptide.HDF5` with a +few hundred lipids in a roughy :code:`20 x 20 x 20nm` box is available in the +`HyMD-tutorial/peptide`_ github repository. Running the simulation + +.. code:: bash + + python3 -m hymd peptide.toml peptide.HDF5 + +we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook `peptide.ipynb`_. + + +.. _HyMD-tutorial/peptide: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/peptide +.. _configuration file: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.toml +.. _peptide.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.ipynb + + +SDS +=== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true + :align: right + :width: 300 + +The last part we introduce is explicit electrostatic interactions through +particle--mesh Ewald. Enabling the electrostatic calculations is done via the +:code:`coulombtype` keyword. :code:`"PIC_Spectral"` is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the :code:`dielectric_const` keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge. + + + +.. code-block:: toml + :caption: **sds.toml** + + [simulation] + integrator = "respa" + respa_inner = 10 + n_steps = 3000 + n_print = 1500 + n_flush = + time_step = 0.01 + box_size = [8.3, 8.3, 8.3] + start_temperature = 298 + target_temperature = 298 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.1 + domain_decomposition = 10000 + cancel_com_momentum = true + max_molecule_size = 5 + thermostat_coupling_groups = [ + ["S", "C"], + ["W", "Na"], + ] + dielectric_const = 45.0 # dielectric constant for the simulation medium + coulombtype = "PIC_Spectral" # particle in cloud, spectral method + + [field] + mesh_size = [64, 64, 64] + sigma = 0.5 + chi = [ + ["S", "C", 13.50], + ["S", "Na", 0.00], + ["S", "W", -3.60], + ["C", "Na", 13.50], + ["C", "W", 33.75], + ["W", "Na", 0.00], + ] + + [bonds] + bonds = [ + ["S", "C", 0.50, 1250.0], + ["C", "C", 0.50, 1250.0], + ] + angle_bonds = [ + ["S", "C", "C", 170.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +An input structure/topology file :code:`sds.HDF5` with a couple thousand +randomly dispersed SDS chains is available in the `HyMD-tutorial/sds`_ github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a :code:`/charge` dataset. +Running the simulation with + +.. code:: bash + + python3 -m hymd sds.toml sds.HDF5 + +we observe the aggregation of the SDS into micellular structures---first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook `sds.ipynb`_. + + +.. _HyMD-tutorial/sds: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/sds +.. _sds.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/sds.ipynb diff --git a/v1.0.8/_sources/doc_pages/filtering.rst.txt b/v1.0.8/_sources/doc_pages/filtering.rst.txt new file mode 100644 index 00000000..02af68c6 --- /dev/null +++ b/v1.0.8/_sources/doc_pages/filtering.rst.txt @@ -0,0 +1,30 @@ +.. _filtering-label: + +Filtering +######### +The default grid-independent filter function used in HyMD is a Gaussian + +.. math:: + + H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] + +with reciprocal space representation + +.. math:: + + \hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +The coarse-graining parameter :math:`\sigma` determines a length scale of +particle extent and is given as configuration file input by + +.. code:: toml + + sigma = 0.75 + + +Implementing new filters +^^^^^^^^^^^^^^^^^^^^^^^^ +Implementing new filter functions is straightforward by hijacking +the :code:`setup` method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional. diff --git a/v1.0.8/_sources/doc_pages/installation.rst.txt b/v1.0.8/_sources/doc_pages/installation.rst.txt new file mode 100644 index 00000000..9ab7e59c --- /dev/null +++ b/v1.0.8/_sources/doc_pages/installation.rst.txt @@ -0,0 +1,324 @@ +.. _installation-label: + +Installation +############ + +Dependencies +============ + +.. note:: + HyMD requires Python ≥3.6. Python version 3.9 is most likely fine + to use, but HyMD is only regularly tested with Python3.8 at the moment. + +.. warning:: + MPI-enabled h5py may fail to build under Python3.10. In this case, a + fall-back to Python3.9 or lower may be necessary. + + +**Installing non-Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-openmpi-dev # Install MPI-enabled HDF5 + sudo apt-get install -y pkg-config # Install pkg-config, required for h5py install + sudo apt-get install -y curl wget + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + sudo dnf update -y + sudo dnf install -y python3.9 python3-devel # Install python3 and pip + sudo dnf install -y openmpi-devel # Install MPI development headers + sudo dnf install -y hdf5-openmpi-devel # Install MPI-enabled HDF5 + sudo dnf install -y curl wget + + + The automatic download and building of PFFT has some issues, so we + manually build FFTW and PFFT before calling :code:`pip3 install pfft-python`. + + .. code-block:: bash + + sudo dnf install -y git + sudo dnf install -y libtool + sudo dnf install -y fftw-openmpi-devel fftw-openmpi-libs + export PATH=$PATH:/usr/lib64/openmpi/bin/ # Ensure MPICC is in path + git clone https://github.com/mpip/pfft.git + cd pfft/ + ./bootstrap.sh + ./configure + make + make install + + + .. group-tab:: Mac OSX (brew) + + .. code-block:: bash + + brew update + brew install python # Install python3 and pip + brew install open-mpi # Install MPI development headers + brew install hdf5-mpi # Install MPI-enabled HDF5 + brew install pkg-config # Install pkg-config, required for h5py install + brew install curl wget + +.. warning:: + There might be memory leaks when using HyMD with OpenMPI 4.1.1. + Therefore, using a newer version of OpenMPI is recommended. + See `Issue #186 `_ for more details. + + +**Installing Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + python3 -m pip install --upgrade pip + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + python3.9 -m ensurepip --upgrade + PATH=$PATH:/usr/lib64/openmpi/bin/:/usr/lib64/openmpi/lib/ + python3.9 -m pip install mpi4py numpy cython + export HDF5_DIR="/usr/lib64/openmpi/" + CC="mpicc" HDF5_MPI="ON" python3.9 -m pip install --no-binary=h5py h5py + + .. group-tab:: Mac OSX (brew) + + Find the location of the installed :code:`hdf5-mpi` package by + + .. code-block:: bash + + find /usr -iname "*hdf5.h" + + or + + .. code-block:: bash + + brew info hdf5-mpi + + and extract the path, which will look like for example + :code:`/usr/local/Cellar/hdf5-mpi/1.13.0/`. Export it as :code:`HDF5_DIR` + + .. code-block:: bash + + python3 -m ensurepip --upgrade + export HDF5_DIR="/usr/local/Cellar/hdf5-mpi/1.13.0/" + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + + +.. warning:: + + If MPI-enabled HDF5 and :code:`h5py` can not be installed, limited support + for serial HDF5 is available. Note that having MPI-enabled file IO is + **highly recommended**, and simulation performance under serial HDF5 will + potentially be very low. + + Example dependency install on Ubuntu (apt) using serial HDF5: + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-serial-dev # Install serial HDF5 + sudo apt-get install -y curl wget + + python3 -m pip install h5py mpi4py numpy cython + + Running parallel simulations without a + MPI-enabled HDF5 library available necessitates the use of the + :code:`--disable-mpio` argument to HyMD, see :ref:`commandline-label`. Note that + due to the way HyMD is built, a working MPI compiler is required even if all + intended simulations are serial. + + +Installing HyMD +=============== +HyMD may be installed using :code:`pip` by + +.. code-block:: bash + + python3 -m pip install hymd + + + +Install in docker +================= +A docker image with build essentials setup is available at `dockerhub`_ with tag +:code:`mortele/hymd`, + +.. code-block:: bash + + docker pull mortele/hymd:latest + docker run -it mortele/hymd + /app$ python3 -m pip install hymd + + # Grab example input files + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5 + + # Run simulation + /app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose + +.. _dockerhub: + https://hub.docker.com/repository/docker/mortele/hymd + + +Run interactively in Google Colaboratory +======================================== +A `Google Colaboratory`_ jupyter notebook is setup `here`_ with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Common issues +============= + +Numpy errors while importing the Fortran force kernels +------------------------------------------------------ + +.. code-block:: python + + RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd + + Traceback (most recent call last): + + (...) + + File "/..../HyMD/hymd/__init__.py", line 2, in + from .main import main # noqa: F401 + File "/..../HyMD/hymd/main.py", line 10, in + from .configure_runtime import configure_runtime + File "/..../hymd/configure_runtime.py", line 12, in + from .input_parser import read_config_toml, parse_config_toml + File "/..../HyMD/hymd/input_parser.py", line 12, in + from .force import Bond, Angle, Dihedral, Chi + File "/..../HyMD/hymd/force.py", line 8, in + from force_kernels import ( # noqa: F401 + ImportError: numpy.core.multiarray failed to import + +can normally be fixed by updating numpy versions, + +.. code-block:: bash + + python3 -m pip install -U numpy + + +Error building pfft-python due to missing curl/wget +--------------------------------------------------- + +.. code-block:: python + + Building wheel for pfft-python (setup.py) ... error + ERROR: Command errored out with exit status 1: + command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_ + cwd: /tmp/pip-install-fr6nt9m4/pfft-python/ + Complete output (56 lines): + running bdist_wheel + running build + running build_py + + (...) + + curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found + wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found + Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + Please check curl or wget + You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ + Traceback (most recent call last): + File "", line 1, in + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in + setup( + File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup + return distutils.core.setup(**attrs) + File "/usr/lib/python3.8/distutils/core.py", line 148, in setup + + (...) + + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions + build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:])) + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft + raise ValueError("could not build fftw; check MPICC?") + ValueError: could not build fftw; check MPICC? + ---------------------------------------- + ERROR: Failed building wheel for pfft-python + Running setup.py clean for pfft-python + Failed to build pfft-python + +can be fixed by installing either `curl`_ or `wget`_ + +.. code-block:: bash + + apt-get install -y curl wget + + +.. _`curl`: + https://curl.se/ + +.. _`wget`: + https://www.gnu.org/software/wget/ + + +Error running parallel HyMD without MPI-enabled h5py +---------------------------------------------------- + +.. code-block:: python + + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + main() + File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main + with h5py.File(args.input, "r", **_kwargs) as in_file: + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__ + with h5py.File(args.input, "r", **_kwargs) as in_file: + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + raise ValueError("h5py was built without MPI support, can't use mpio driver") + ValueError: h5py was built without MPI support, can't use mpio driver + +Can be fixed by installing a MPI-enabled :code:`h5py` through + +.. code-block:: bash + + python3 -m pip uninstall -y h5py + HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py diff --git a/v1.0.8/_sources/doc_pages/interaction_energy_functionals.rst.txt b/v1.0.8/_sources/doc_pages/interaction_energy_functionals.rst.txt new file mode 100644 index 00000000..f33c004e --- /dev/null +++ b/v1.0.8/_sources/doc_pages/interaction_energy_functionals.rst.txt @@ -0,0 +1,98 @@ +.. _functionals-label: + +Interaction energy functionals +############################## +A few interaction energy functionals :math:`W` are defined in HyMD through +the :code:`Hamiltonian` class and associated subclasses. + +:math:`\chi`--interaction and :math:`\kappa`--incompressibility +=============================================================== +The most common hPF energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultWithChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where :math:`\tilde\chi_{\text{A}-\text{B}}` is the interaction energy between +overlapping densities of particle types :math:`\text{A}` and :math:`\text{B}`. +The incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\tilde\chi` +and :math:`\kappa` in the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + chi = [ + ["A", "B", 15.85], + ["B", "C", -5.70], + ... + ] + +Only :math:`\kappa`--incompressibility +====================================== +The only :math:`\kappa` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultNoChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where the incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Only :math:`\phi^2` +=================== +The :math:`\phi^2` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "SquaredPhi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2, + +where the :math:`\phi` squared term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Implementing new interaction energy forms +========================================= +Implementing new interaction energy functions is straightforward by subclassing +:code:`Hamiltonian` and applying :code:`sympy` differentiation to the symbolic +field objects. The :code:`sympy.lamdify` function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields. diff --git a/v1.0.8/_sources/doc_pages/intramolecular_bonds.rst.txt b/v1.0.8/_sources/doc_pages/intramolecular_bonds.rst.txt new file mode 100644 index 00000000..820e81bc --- /dev/null +++ b/v1.0.8/_sources/doc_pages/intramolecular_bonds.rst.txt @@ -0,0 +1,142 @@ +.. _bonds-label: + +Intramolecular bonds +#################### + +Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see :ref:`config-label`. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +:ref:`benchmarks-label`), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable. + +All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]). + + +Two-particle bonds +^^^^^^^^^^^^^^^^^^ +Stretching bonds in HyMD are implemented as harmonic spring potentials, + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2, + +where :math:`r=|\mathbf{r}|` is the inter-particle distance, :math:`k` is a +constant of dimension energy (units :math:`\text{kJ}\,\text{mol}^{-1}`), and +:math:`r_0` is the equilibrum length of the bond (units: :math:`\text{nm}`). The +force is calculated as + +.. math:: + + F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r}, + +where :math:`\mathbf{r}` is the vector pointing *from* :math:`i` *to* :math:`j`. + +In the configuration file, two-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_two_particle_example.toml + + [bonds] + bonds = [ + ["A", "A", 0.47, 1250.0], + ["A", "B", 0.37, 940.0], + ["B", "C", 0.50, 1010.0], + ["C", "A", 0.42, 550.0], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Three-particle bonds +^^^^^^^^^^^^^^^^^^^^ +Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle--particle--particle angle :math:`\theta`, + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2, + +where :math:`k` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}`), and :math:`\theta_0` is the equilibrum +angle of the bond (units: :math:`{}^\circ`). Defining the particles with labels +:math:`a`, :math:`b`, and :math:`c`, let :math:`\mathbf{r}_a` denote the vector +pointing from :math:`b` to :math:`a`, and correspondingly let +:math:`\mathbf{r}_c` point from :math:`b` to :math:`c`. The +:math:`a`--:math:`b`--:math:`c` may be computed through the law of Cosines, + +.. math:: + + \theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right] + +Then the force acting on :math:`a` and :math:`c` is + +.. math:: + + \mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a}, + + \mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c}, + +and + +.. math:: + + \mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c + +In the configuration file, three-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_three_particle_example.toml + + [bonds] + angle_bonds = [ + ["A", "A", "A", 180.0, 90.0], + ["A", "B", "A", 120.0, 55.0], + ["B", "C", "C", 30.0, 10.0], + ["C", "A", "B", 110.0, 25.5], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Four-particle bonds +^^^^^^^^^^^^^^^^^^^ +Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle :math:`\phi` between the +:math:`a`--:math:`b`--:math:`c` and :math:`b`--:math:`c`--:math:`d` planes, for +a dihedral bond quartet :math:`a`, :math:`b`, :math:`c`, and :math:`d`. The +potential takes the form + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n), + +where :math:`c_n` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`), and :math:`\phi_n` are +specified phase angles in the cosine series. + +In the configuration file, four-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_four_particle_example.toml + + [bonds] + dihedrals = [ + ["A", "B", "C", "D"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0], + ] diff --git a/v1.0.8/_sources/doc_pages/overview.rst.txt b/v1.0.8/_sources/doc_pages/overview.rst.txt new file mode 100644 index 00000000..0e4d6b65 --- /dev/null +++ b/v1.0.8/_sources/doc_pages/overview.rst.txt @@ -0,0 +1,166 @@ +.. _overview-label: + +================================ + Usage overview for HylleraasMD +================================ + +HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a `toml`_ format configuration file, along with a topology and structure +file specifying the input system in HDF5 format. + +.. _`toml`: + https://github.com/toml-lang/toml + +**Configuration file** + +The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a :code:`[5, 5, 5]` nm simulation box at 300 K may look like +the following: + +.. code-block:: toml + :caption: **config_simple_1.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "SquaredPhi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [30, 30, 30] # FFT grid size + sigma = 0.5 # filtering length scale in nm + +Note that for the version 1.0 release of HyMD, the :code:`[particles]`, +:code:`[simulation]`, and :code:`[field]` groups are optional specifiers for +structuring the configuration file. + +For a full specification of every recognised configuration keyword in HyMD, +please refer to :ref:`config-label`. + +**Topology and structure file** + +The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +:code:`N` particles may look like the following: + +.. code-block:: bash + :caption: **example_structure.HDF5** + + group / + # root group + + dataset /coordinates + # float32, shape (T, N, D,) + # Time steps of N rows of D dimensional coordinate data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /velocities + # float32, shape (T, N, D,) OPTIONAL + # Time steps of N rows of D dimensional velocity data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /bonds + # int32, shape (N, B,) OPTIONAL + # Each row i contains indices of the particles bonds from/to i + # B denotes the maximum bonds per particle + + dataset /indices + # int32, shape (N,) + # Index of each particle, 0--(N-1) + + dataset /molecules + # int32, shape (N,) + # Index of molecule each particle belongs to + # Used to construct bond network locally on MPI ranks + + dataset /names + # str10, shape (N,) + # Fixed size string array containing particle type names + + dataset /types + # int32, shape (N,) OPTIONAL + # Mapping of particle names to type indices + + +For a full specification of the topology and structure input file, see +:ref:`topology-label`. + +**Command line arguments** + +A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the :code:`config_simple_1.toml` and :code:`example_structure.HDF5` +files may look like the following: + +.. code-block:: bash + + mpirun -n ${MPI_NUM_RANKS} python3 -m hymd \ # HyMD executable + config_simple_1.toml \ # configuration file + example_structure.HDF5 \ # structure file + --logfile=log_out.txt \ # set logfile path + --seed 123456 \ # set random seed + --verbose 2 \ # set logging verbosity + --velocity-output # enable velocity in trajectory output + +For a full specification of all command line arguments, see +:ref:`commandline-label`. + +**More examples** + +For more thorough rundown and concrete usage examples, see +:ref:`examples-label`. + +Running parallel simulations +============================ +Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the **only** difference being how the python3 interpreter is +invoked. Prepending :code:`mpirun -n ${NPROCS}` to the usual +:code:`python3 -m hymd` runs the simulation with :code:`${NPROCS}` MPI ranks. + +Inputting + +.. code:: bash + + mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field + +sets up an example simulation of the `HyMD-tutorial/ideal_gas`_ system. For +more details about this system in particular, or other example simulations, see +the `HyMD-tutorial`_ repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas + + +Running tests +============= +Run serial code tests by + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd + cd hymd/ + python3 -m pip install pytest pytest-mpi + python3 -m pytest + +There is a small convenience script in :code:`hymd/` for running the MPI-enabled +tests, + +.. code-block:: bash + + chmod +x pytest-mpi + ./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no diff --git a/v1.0.8/_sources/doc_pages/theory.rst.txt b/v1.0.8/_sources/doc_pages/theory.rst.txt new file mode 100644 index 00000000..95d7842c --- /dev/null +++ b/v1.0.8/_sources/doc_pages/theory.rst.txt @@ -0,0 +1,114 @@ +.. _theory-label: + +Theory +###### +Hybrid particle--field simulations switch out the ordinary particle--particle +`Lennard-Jones`_ interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle--field densities are +defined as + +.. math:: + + \phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i), + +where :math:`\mathbf{r}` is a spatial coordinate, :math:`P` is a window function +used to distribute particle number densities onto a computational grid, and +:math:`\mathbf{r}_i` is the position of particle :math:`i` (of total :math:`N`). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of :math:`N` particles in :math:`M` molecules is + +.. math:: + + \mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})] + +with :math:`H_0` being a standard intramolecular Hamiltonian form (see +:ref:`bonds-label`) including kinetic terms, while :math:`W` is a density +dependent *interaction energy functional*. + +In the Hamiltonian hPF-MD formalism :cite:`bore2020hamiltonian`, the density +field is filtered using a grid-independent filtering function :math:`H`, + +.. math:: + + \tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}). + +The filter smooths the density, ensuring that :math:`\tilde\phi` and +:math:`W[\tilde\phi([\phi])]` both converge as the grid size is reduced. + +External potential +================== +The external potential acting on a particle is defined as the functional +derivative of :math:`W` with respect to :math:`\phi`. In the filtered formalism, +the potential takes the form + +.. math:: + + V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ + &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})}, + +under the assumption of a *local* form of the interaction energy functional, +:math:`W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]`. Note +that + +.. math:: + + \frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}). + +Force interpolation +=================== +The forces on particle :math:`i` are obtained by differentiation of the external +potential, + +.. math:: + + \mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i). + + +Reciprocal space calculations +============================= +The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density :math:`\phi_{ijk}` with CIC, we apply the filtering +and obtain the discrete version of the external potential by + +.. math:: + + \tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big] + +and + +.. math:: + + V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +The forces are obtained by differentiation of :math:`V` in Fourier space as + +.. math:: + + \nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +Filter +====== +By default, the filter used in HyMD is a simple Gaussian of the form + +.. math:: + + H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ + \hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +For more details about the filtering, see :ref:`filtering-label`. + +Hamiltonian form +================ +The default form of the interaction energy functional in HyMD is + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2. + +See :ref:`functionals-label` for details. + + +.. _`Lennard-Jones`: + https://en.wikipedia.org/wiki/Lennard-Jones_potential diff --git a/v1.0.8/_sources/doc_pages/topology_input.rst.txt b/v1.0.8/_sources/doc_pages/topology_input.rst.txt new file mode 100644 index 00000000..adabe129 --- /dev/null +++ b/v1.0.8/_sources/doc_pages/topology_input.rst.txt @@ -0,0 +1,77 @@ +.. _topology-label: + +============================ +Topology and structure file +============================ +The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root :code:`/` group. + +The `HyMD-tutorial`_ has multiple examples of structure files for various levels +of complexity. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Required datasets +================= +:/coordinates: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/indices: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/names: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`string` (:code:`length` between :code:`1` and :code:`16`)] + + The shape represents one particle name per :code:`N` particles. The datatype may be a string of length :code:`=<16`. + + + +Optional datasets +================= +:/velocities: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/types: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle type index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/molecules: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one molecule index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/bonds: + :code:`array` shape [:code:`N`, :code:`B`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents :code:`B` bond specifications (indices of different particles) per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/charge: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents one particle charge per :code:`N` particles. The data type may be either four or eight byte reals. diff --git a/v1.0.8/_sources/index.rst.txt b/v1.0.8/_sources/index.rst.txt new file mode 100644 index 00000000..ff4059ba --- /dev/null +++ b/v1.0.8/_sources/index.rst.txt @@ -0,0 +1,168 @@ +.. hymd documentation master file, created by + sphinx-quickstart on Thu Dec 16 13:31:43 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +############################### +HylleraasMD documentation +############################### + +:Release: + |release| +:Date: + |today| + +**HylleraasMD** (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems. + +HyMD can run canonical hPF-MD simulations :cite:`Milano2009JCP`, or filtered +density Hamiltonian hPF (HhPF-MD) simulations :cite:`bore2020hamiltonian`, with +or without explicit PME electrostatic interactions :cite:`kolli2018JCTC`. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +:cite:`Cascella2008,bore2018hybrid`. Martini +style elastic networks (ElNeDyn) :cite:`periole2009combining` are also +supported. + +HyMD uses the pmesh (`github.com/rainwoodman/pmesh`_) library for particle-mesh +operations, with the PPFT :cite:`pippig2013pfft` backend for FFTs through the +pfft-python bindings (`github.com/rainwoodman/pfft-python`_). File IO is done +via HDF5 formats to allow MPI parallel reads. + +User Guide +========== +The HylleraasMD :doc:`User Guide ` provides comprehensive information on how to run +simulations. Selected :doc:`Examples ` are available to guide new users. + +.. _`github.com/rainwoodman/pmesh`: + https://github.com/rainwoodman/pmesh +.. _`github.com/rainwoodman/pfft-python`: + https://github.com/rainwoodman/pfft-python + +Installing HyMD +=============== +The easiest approach is to install using pip_: + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + +For more information and **required dependencies**, see +:ref:`installation-label`. + +.. _pip: + http://www.pip-installer.org/en/latest/index.html + + +Run in Google colab +------------------- +Run HyMD interactively in `Google Colaboratory`_ jupyter notebook `here`_. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Source Code +=========== +**Source code** is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the `GNU Lesser General Public +License v3.0`_. Obtain the source code with `git`_: + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git + +.. _GNU Lesser General Public License v3.0: + https://www.gnu.org/licenses/lgpl-3.0.html +.. _git: + https://git-scm.com/ + + +Development +=========== +HyMD is developed and maintained by researchers at the `Hylleraas Centre for +Quantum Molecular Sciences`_ at the `University of Oslo`_. + +|pic1| |pic2| + +.. _`Hylleraas Centre for Quantum Molecular Sciences`: + https://www.mn.uio.no/hylleraas/english/ +.. _`University of Oslo`: + https://www.uio.no/ + +.. |pic1| image:: img/hylleraas_centre_logo_black.png + :target: img/hylleraas_centre_logo_black.png + :width: 250 px + +.. |pic2| image:: img/uio_full_logo_eng_pos.png + :target: img/uio_full_logo_eng_pos.png + :width: 325 px + + + +References +========== +.. bibliography:: + :all: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. Contents +.. ======== + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Getting started + + ./doc_pages/installation + ./doc_pages/overview + ./doc_pages/config_file + ./doc_pages/topology_input + ./doc_pages/command_line + ./doc_pages/constants_and_units + + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Examples + + ./doc_pages/examples + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Theory + + ./doc_pages/theory + ./doc_pages/intramolecular_bonds + ./doc_pages/electrostatics + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Developer documentation + + ./doc_pages/interaction_energy_functionals + ./doc_pages/filtering + ./doc_pages/benchmarks + ./doc_pages/api diff --git a/v1.0.8/_static/basic.css b/v1.0.8/_static/basic.css new file mode 100644 index 00000000..be19270e --- /dev/null +++ b/v1.0.8/_static/basic.css @@ -0,0 +1,856 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/v1.0.8/_static/css/badge_only.css b/v1.0.8/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/v1.0.8/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/v1.0.8/_static/css/fonts/Roboto-Slab-Bold.woff b/v1.0.8/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/v1.0.8/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/v1.0.8/_static/css/fonts/Roboto-Slab-Bold.woff2 b/v1.0.8/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/v1.0.8/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/v1.0.8/_static/css/fonts/Roboto-Slab-Regular.woff b/v1.0.8/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/v1.0.8/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/v1.0.8/_static/css/fonts/Roboto-Slab-Regular.woff2 b/v1.0.8/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/v1.0.8/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/v1.0.8/_static/css/fonts/fontawesome-webfont.eot b/v1.0.8/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/v1.0.8/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/v1.0.8/_static/css/fonts/fontawesome-webfont.svg b/v1.0.8/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/v1.0.8/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v1.0.8/_static/css/fonts/fontawesome-webfont.ttf b/v1.0.8/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/v1.0.8/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/v1.0.8/_static/css/fonts/fontawesome-webfont.woff b/v1.0.8/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/v1.0.8/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/v1.0.8/_static/css/fonts/fontawesome-webfont.woff2 b/v1.0.8/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/v1.0.8/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/v1.0.8/_static/css/fonts/lato-bold-italic.woff b/v1.0.8/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/v1.0.8/_static/css/fonts/lato-bold-italic.woff differ diff --git a/v1.0.8/_static/css/fonts/lato-bold-italic.woff2 b/v1.0.8/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/v1.0.8/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/v1.0.8/_static/css/fonts/lato-bold.woff b/v1.0.8/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/v1.0.8/_static/css/fonts/lato-bold.woff differ diff --git a/v1.0.8/_static/css/fonts/lato-bold.woff2 b/v1.0.8/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/v1.0.8/_static/css/fonts/lato-bold.woff2 differ diff --git a/v1.0.8/_static/css/fonts/lato-normal-italic.woff b/v1.0.8/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/v1.0.8/_static/css/fonts/lato-normal-italic.woff differ diff --git a/v1.0.8/_static/css/fonts/lato-normal-italic.woff2 b/v1.0.8/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/v1.0.8/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/v1.0.8/_static/css/fonts/lato-normal.woff b/v1.0.8/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/v1.0.8/_static/css/fonts/lato-normal.woff differ diff --git a/v1.0.8/_static/css/fonts/lato-normal.woff2 b/v1.0.8/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/v1.0.8/_static/css/fonts/lato-normal.woff2 differ diff --git a/v1.0.8/_static/css/theme.css b/v1.0.8/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/v1.0.8/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/v1.0.8/_static/custom.css b/v1.0.8/_static/custom.css new file mode 100644 index 00000000..b20d6282 --- /dev/null +++ b/v1.0.8/_static/custom.css @@ -0,0 +1,91 @@ + +body{ + background: #FFFFFF !important; +} + +.wy-menu-vertical header, .wy-menu-vertical p.caption{ + color: #4EA0AF!important; +} +.wy-menu-vertical li.current{ + background-color: #f4f4f4!important; +} +.wy-menu-vertical li.toctree-l2.current>a{ + background-color: #ebebeb!important; +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{ + background-color: #e3e3e3!important; +} + +.rst-content .sidebar{ + background-color: #fff!important; + border-radius: 6px; + -moz-border-radius: 6px; + -webkit-border-radius: 6px; +} + +h1 > a, h2 > a, h3 > a, h4 > a, h5 > a, h6 > a { + color: #17d9ff; +} + +h1, h2, h3, h4, h5, h6 { + color: black; + font-weight: normal; + padding: 0; +} + +h1, h2, h3 { + margin-top: 30px; + margin-bottom: 20px; +} + +h1 { + color: white; + padding: 20px 20px 20px 45px; + margin: 20px 0 35px -45px; + background: linear-gradient(to left, #fff, #2b38ff)!important; + + width: calc(100% + 90px); + border-bottom: 3px solid #000; +} + +h2 { + padding: .2em 0; + border-bottom: 1px solid #ddd; +} + +h3 { + margin-top: 35px; +} + +h4 { + margin-top: 30px; +} + +h5 { + margin-top: 25px; +} + +.wy-nav-content{ + max-width: none!important; +} + +.wy-side-nav-search{ + background: #2b38ff!important; +} + +.wy-side-nav-search input[type=text]{ + border-color:#4DA0B0!important; +} + +.wy-side-nav-search input[type=text]{ + border-radius: 4px!important; +} + +#caption-api { + background: red !important; +} + +#caption-text-api { + text-color: blue !important; +} diff --git a/v1.0.8/_static/doctools.js b/v1.0.8/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/v1.0.8/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/v1.0.8/_static/documentation_options.js b/v1.0.8/_static/documentation_options.js new file mode 100644 index 00000000..f998574c --- /dev/null +++ b/v1.0.8/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '1.0.8', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/v1.0.8/_static/file.png b/v1.0.8/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/v1.0.8/_static/file.png differ diff --git a/v1.0.8/_static/hymd_icon_white.png b/v1.0.8/_static/hymd_icon_white.png new file mode 100644 index 00000000..d0396a17 Binary files /dev/null and b/v1.0.8/_static/hymd_icon_white.png differ diff --git a/v1.0.8/_static/hymd_logl_white_text_abbr.png b/v1.0.8/_static/hymd_logl_white_text_abbr.png new file mode 100644 index 00000000..8c0e50c8 Binary files /dev/null and b/v1.0.8/_static/hymd_logl_white_text_abbr.png differ diff --git a/v1.0.8/_static/jquery-3.5.1.js b/v1.0.8/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/v1.0.8/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. API reference

+
+

4.1. Integrator

+

Integrates equations of motion.

+

Implements the Velocity Verlet integrator. The reversible reference system +propagator algorithm (rRESPA) integrator uses the Velocity Verlet functions +inside the MD loop in the main module.

+
+
+hymd.integrator.integrate_position(positions, velocities, time_step)[source]
+

Position update step of the Velocity Verlet integration algorithm.

+

Computes the position update step of the Velocity Verlet algorithm. The +positions argument is not changed in place.

+
+
Parameters:
+
+
positions(N, D) numpy.ndarray

Array of positions of N particles in D dimensions.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_velocity

The velocity update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step, then the positions are updated a full step using the updated +velocities

+
+\[\mathbf{x}_{\text{new}} = \mathbf{x} + \Delta t \mathbf{v}\]
+
+ +
+
+hymd.integrator.integrate_velocity(velocities, accelerations, time_step)[source]
+

Velocity update step of the Velocity Verlet integration algorithm.

+

Computes the velocity update step of the Velocity Verlet algorithm. The +velocities argument is not changed in place.

+
+
Parameters:
+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
accelerations(N, D) numpy.ndarray

Array of accelerations of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_position

The position update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step

+
+\[\mathbf{v}_{\text{new}} = \mathbf{v} + \frac{\Delta t}{2m} +\mathbf{f}\]
+

before the positions are moved a full step using the updated half-step +velocities.

+
+ +
+
+

4.2. Thermostat

+

Scales or otherwise modifies the particle velocities during simulation to +simulate coupling to an external heat bath with temperature T₀.

+
+
+hymd.thermostat._random_chi_squared(prng: numpy.random._generator.Generator, M: int)float[source]
+

Draw the sum of M squared normally distributed values

+

The value is generated by the Gamma distribution, in lieu of generating +M Gaussian distributed numbers and summing their squares.

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
Mint

Number of standard normally distributed numbers in the sum.

+
+
+
+
Returns:
+
+
float

The sum of M squared normally distributed values centered at +zero with unit standard deviation.

+
+
+
+
+

Notes

+

The sum of the squares of k independent standard normal random variables is +distributed according to a \(\chi^2\) distribution.

+
+\[\chi^2_1 + \chi_2^2 + \chi_3^2 + \dots + \chi_M^2 +\sim +\sigma^2\chi^2(k)\]
+

This is a special case of the \(\Gamma\) distribution, +\(\Gamma(k/2, 2)\), and may be generated by

+
+\[\chi^2(k) \sim 2 \Gamma(k/2, 2)\]
+

References

+

Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of +Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. +J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246.

+
+ +
+
+hymd.thermostat._random_gaussian(prng: numpy.random._generator.Generator)float[source]
+

Draw a single random number from the standard normal distribution +Generate a number from the Gaussian distribution centered at zero with unit +standard deviation, \(N(0, 1)\).

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
+
+
Returns:
+
+
float

A random number drawn from \(N(0, 1)\).

+
+
+
+
+
+ +
+
+hymd.thermostat.csvr_thermostat(velocity: numpy.ndarray, names: numpy.ndarray, config: hymd.input_parser.Config, prng: numpy.random._generator.Generator, comm: mpi4py.MPI.Intracomm = <mpi4py.MPI.Intracomm object>, random_gaussian: Callable[[numpy.random._generator.Generator], float] = <function _random_gaussian>, random_chi_squared: Callable[[numpy.random._generator.Generator, int, float], float] = <function _random_chi_squared>, remove_center_of_mass_momentum: bool = True)numpy.ndarray[source]
+

Canonical sampling through velocity rescaling thermostat

+

Implements the CSVR thermostat. Rescales the system kinetic energy by a +stochastically chosen factor to keep the temperature constant. Requires +communcation of the kinetic energies calculated locally for each MPI rank. +The random numbers sampled through random_gaussian and +random_chi_squared are broadcast from the root rank to the other +ranks to ensure the scaling is performed with the same stochasticity for +all particles in the full system.

+

The velocities are cleaned of center of mass momentum before the thermostat +is applied, and the center of mass momentum is subsequently reapplied. This +is performed for each thermostat coupling group, i.e. the center of mass +momenta of each group is separately removed and reapplied after +thermostatting.

+

The implementation here is based on the derivation presented in the 2008 +Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper.

+
+
Parameters:
+
+
velocity(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
names(N,) numpy.ndarray

Array of particle names.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
random_gaussiancallable, optional

Function for generating standard normally distributed numbers.

+
+
random_chi_squaredcallable, optional

Function for generating \(\chi^2\)-distributed numbers

+
+
remove_center_of_mass_momentumbool, optional

If True, the center of mass of each coupling group is removed before +the thermostat is applied. The center of mass momenta are added back +after the kinetic energy rescaling is complete.

+
+
+
+
+
+

See also

+
+
_random_gaussian

Used to sample Gaussian-distributed numbers.

+
+
_random_chi_squared

Used to sample \(\chi^2\)-distributed numbers.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +

References

+

G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). +G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008).

+
+ +
+
+

4.3. Hamiltonian

+
+
+class hymd.hamiltonian.Hamiltonian(config)[source]
+

Interaction energy functional superclass

+
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+_setup()[source]
+

Superclass setup

+

Sets up the grid-independent filtering function H, and the +SymPy logic for symbolically differentiating interaction energy +functionals in Hamiltonian subclasses.

+
+ +
+ +
+
+class hymd.hamiltonian.SquaredPhi(config)[source]
+

Simple squared density interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + \sum_k \tilde\phi_k + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(rho_0\) is the +average density of the fully homogenous system. Expressing the species +densities in terms of fluctuations from the average,

+
+\[\mathrm{d}\tilde\phi_k = \rho_0 - \tilde\phi_k,\]
+

it is evident that this interaction energy functional is a slight change of +the DefaultNoChi Hamiltonian, as the expanded interaction energy +density becomes

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + 6\rho_0\left[ + \sum_k \mathrm{d}\tilde\phi_k + \right] + + + 9\rho_0^2 + + + \sum_k \mathrm{d}\tilde\phi_k^2 + + + \prod_{k\not=l} + \mathrm{d}\tilde\phi_k \mathrm{d}\tilde\phi_l + \right),\]
+

identical to DefaultNoChi apart from a constant energy shift +\(9\rho_0^2`(which does not impact dynamics) and the +:math:\)rho_0`–\(\mathrm{d}\tilde\phi_k\) cross-terms. These +cross-terms constitute contributions to the energy linear in +\(\mathrm{d}\tilde\phi_k\) absent in DefaultNoChi, which has +only quadratic terms present.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultNoChi(config)[source]
+

Incompressibility-only interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a +\right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. The SquaredPhi Hamiltonian implements a similar +functional with an additional linear term component depending on

+
+\[\mathmr{d}\tilde\phi_k = \tilde\phi_k - \rho_0\]
+

and not \(\mathrm{d}\tilde\phi_k^2\). No explicit inter-species +interaction is present apart from the indirect interaction through the +incompressibility.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultWithChi(config, unique_names, type_to_name_map)[source]
+

Incompressibility and \(\chi\)-interactions energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = + \frac{1}{2\rho_0} + \sum_{k,l}\chi_{kl} \tilde\phi_k \tilde\phi_l + + + \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. \(\chi_{ij}\) is the Flory-Huggins-like +inter-species mixing energy.

+
+
+__init__(config, unique_names, type_to_name_map)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup(unique_names, type_to_name_map)[source]
+

Setup the interaction energy potential and the external potential

+
+
Parameters:
+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+ +
+ +
+
+

4.4. Force

+

Calculates intramolecular forces between bonded particles in molecules

+
+
+class hymd.force.Angle(atom_1: str, atom_2: str, equilibrium: float, strength: float, atom_3: str)[source]
+

Dataclass representing a single three-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any three-particle bond between particles of specific types A, +B, and C (where A, B, and C may be +different or the same). Harmonic angular three-particle bonds in HyMD take +the form

+
+\[V_3(\mathbf{r}_1, \mathbf{r}_2, \mathbf{r}_3) = + \frac{1}{2}k + \left( + \cos^{-1} + \left[ + \frac{ + (\mathbf{r}_1-\mathbf{r}_2) + \cdot + (\mathbf{r}_3-\mathbf{r}_2) + } + { + \vert\mathbf{r}_1-\mathbf{r}_2\vert + \vert\mathbf{r}_3-\mathbf{r}_2\vert + } + \right] - \theta_0 + \right)^2\]
+
+

See also

+
+
Bond

Two-particle bond type dataclass

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
equilibriumfloat

Equilibrium angle at which the energy associated with the +three-particle angular bond vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient.

+
+
+
+
+
+
+atom_3: str
+
+ +
+ +
+
+class hymd.force.Bond(atom_1: str, atom_2: str, equilibrium: float, strength: float)[source]
+

Dataclass representing a single two-particle bond type

+

A bond type is a bond strength and equilibrium distance associated with +any bond between particles of specific types A and B +(where A and B may be the same or different). Harmonic +two-particle bonds in HyMD take the form

+
+\[V_2(\mathbf{r}_1, \mathbf{r}_2) = + \frac{1}{2}k + \left( + \vert \mathbf{r}_1 - \mathbf{r}_2 \vert - r_0 + \right)^2,\]
+

where \(k\) is the bond strength (spring constant) and \(r_0\) is +the equilibrium bond length (at which the energy is zero).

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
equilibriumfloat

Equilibrium distance at which the energy associated with the bond +vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient (spring constant).

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+equilibrium: float
+
+ +
+
+strength: float
+
+ +
+ +
+
+class hymd.force.Chi(atom_1: str, atom_2: str, interaction_energy: float)[source]
+

Dataclass representing a single \(\chi\) mixing interaction type

+

An interaction mixing energy type is a mixing energy associated with +density overlap between species of types A and B +(specified as inputs atom_1 and atom_2). A positive mixing +energy promotes phase separation, a negative mixing energy promotes mixing. +The interaction energy density (provided the DefaultWithChi +Hamiltonian is used) takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} + \sum_{k,l}\chi_{k,l} \tilde\phi_k\tilde\phi_l,\]
+

where \(\chi_{k,l}\) denotes the mixing energy between species +\(k\) and \(l\), with \(\kappa\) being the incompressibility. +The value of the interaction mixing energy parameter may be extracted from +Flory-Huggins theory.

+
+

See also

+
+
hymd.hamiltonian.DefaultWithChi

Interaction energy functional using \(\chi\)-interactions.

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
interaction_energyfloat

Interaction mixing energy.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+interaction_energy: float
+
+ +
+ +
+
+class hymd.force.Dielectric_type(atom_1: str, dielectric_value: float)[source]
+
+
+atom_1: str
+
+ +
+
+dielectric_value: float
+
+ +
+ +
+
+class hymd.force.Dihedral(atom_1: str, atom_2: str, atom_3: str, atom_4: str, coeffs: numpy.ndarray, dih_type: int)[source]
+

Dataclass representing a single four-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any four-particle torsional bond between particles of specific types +A, B, C, and D (where A, B, +C, and D may be different or the same). Dihedral +four-particle bonds in HyMD take different forms depending on the +dih_type parameter.

+

In the following, let \(\phi\) denote the angle between the planes +spanned by the relative positions of atoms A-B-C +and B-C-D. If dih_type = 0, then

+
+\[V_4(\phi) = \sum_n c_n + \left( + 1 + \cos\left[ + n\phi - d_n + \right] + \right),\]
+

where \(c_n\) are energy coefficients and \(d_n\) are propensity +phases. By default, the cosine sum is truncated at five terms. If +coeffs provides only a single float, this is used as the coiling +propensity parameter \(\lambda\). In this case, \(c_n\) and +\(d_n\) are automatically set to values which promote alpha helical +(\(\lambda=-1\)), beta sheet (\(\lambda=1\)), or a mixed +(\(1>\lambda>-1\)) structure (using values provided by Bore et al. +(2018)). In this case, the full potential takes the form

+
+\[V_4(\phi;\lambda) = + \frac{1}{2}(1-\lambda) V_{\text{prop},\alpha}(\phi) + + + \frac{1}{2}(1+\lambda) V_{\text{prop},\beta}(\phi) + + + (1-\vert\lambda\vert) V_{\text{prop}, \text{coil}}(\phi),\]
+

with each of the \(V_{\mathrm{prop}, X}\) being fixed cosine series +potentials with pre-set \(c_n\) -s and \(d_n\) -s.

+

If dih_type = 1, then a combined bending torsional (CBT) potential +is employed,

+
+\[V_4(\phi,\gamma;\lambda) = + V_4(\phi;\lambda) + + + \frac{1}{2}K(\phi)(\gamma - \gamma_0)^2,\]
+

where \(V_4(\phi;\lambda)\) specifies the potential as given by the +coiling propensity parameter above, \(K(\phi)\) is a separate cosine +series potential acting as the angular three-particle bond strength, and +\(\gamma_0\) is the three-particle bond equilibrium angle. In this +case, the coeffs parameter must specify both a \(\lambda\) +value, in additon to the energy and phases dictating the \(K(\phi)\) +potential.

+

References

+

Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018.

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
atom_4str

Type name of particle 4.

+
+
coeffslist[list[float]] or list[float] or numpy.ndarray

Dihedral coefficients defining the series expansion of the dihedral +energy.

+
+
dih_typeint

Specifies the type of dihedral used; If 0, then coeffs +must contain either two lists of five energy coefficients +\(c_n\) and five propensity phases \(d_n\) or a single +floating point number defining the \(\lambda\) coiling propensity +parameter. If 1, the combined bending-torsional potential is +used, and coeffs must specify \(\lambda\) and two lists +containing energy coefficients and propensity phases for the +\(V_\text{prop}\) propensity potential, defined in terms of cosine +series.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+atom_3: str
+
+ +
+
+atom_4: str
+
+ +
+
+coeffs: numpy.ndarray
+
+ +
+
+dih_type: int
+
+ +
+ +
+
+hymd.force.compute_angle_forces__plain(f_angles, r, bonds_3, box_size)[source]
+

Computes forces resulting from angular interactions

+
+

Deprecated since version 1.0.0: compute_angle_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_bond_forces__plain(f_bonds, r, bonds_2, box_size)[source]
+

Computes forces resulting from bonded interactions

+
+

Deprecated since version 1.0.0: compute_bond_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size)[source]
+

Computes forces resulting from dihedral interactions

+
+

Deprecated since version 1.0.0: compute_dihedral_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.dipole_forces_redistribution(f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb)[source]
+

Redistribute electrostatic forces calculated from topologically +reconstructed ghost dipole point charges to the backcone atoms of the protein.

+
+ +
+
+hymd.force.find_all_paths(G, u, n)[source]
+

Helper function that recursively finds all paths of given lenght ‘n + 1’ inside a network ‘G’. +Adapted from https://stackoverflow.com/a/28103735.

+
+ +
+
+hymd.force.prepare_bonds(molecules, names, bonds, indices, config, topol=None)[source]
+

Rearrange the bond information for usage in compiled Fortran kernels

+

Restructures the lists resulting from the execution of +prepare_bonds_old into numpy arrays suitable for calls to optimized +Fortran code calculating bonded forces and energiesself.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2_atom_1(B,) numpy.ndarray

Local index of particle 1 for each of B constructed +two-particle bonds.

+
+
bonds_2_atom_2(B,) numpy.ndarray

Local index of particle 2 for each of B constructed +two-particle bonds.

+
+
bonds_2_equilibrium(B,) numpy.ndarray

Equilibrium distance for each of B constructed two-particle +bonds.

+
+
bonds_2_strength(B,) numpy.ndarray

Bond strength for each of B constructed two-particle +bonds.

+
+
bonds_3_atom_1(A,) numpy.ndarray

Local index of particle 1 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_2(A,) numpy.ndarray

Local index of particle 2 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_3(A,) numpy.ndarray

Local index of particle 3 for each of A constructed +three-particle bonds.

+
+
bonds_3_equilibrium(A,) numpy.ndarray

Equilibrium angle for each of A constructed three-particle +bonds.

+
+
bonds_3_strength(A,) numpy.ndarray

Bond strength for each of A constructed three-particle +bonds.

+
+
bonds_4_atom_1(D,) numpy.ndarray

Local index of particle 1 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_2(D,) numpy.ndarray

Local index of particle 2 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_3(D,) numpy.ndarray

Local index of particle 3 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_4(D,) numpy.ndarray

Local index of particle 4 for each of D constructed +four-particle bonds.

+
+
bonds_4_coeff(D,) numpy.ndarray

Cosine series coefficients for each of D constructed +four-particle bonds.

+
+
bonds_4_type(D,) numpy.ndarray

Dihedral type for each of D constructed four-particle +bonds.

+
+
bonds_4_last(D,) numpy.ndarray

Flags indicating if dih_type is 1 for each of D +constructed four-particle bonds.

+
+
+
+
+
+

See also

+
+
prepare_bonds_old

Used internally to reconstruct the bonded interactions types from the connectivity information in the structure/topology input file and the bonded types specified in the configuration file.

+
+
+ +
+ +
+
+hymd.force.prepare_bonds_old(molecules, names, bonds, indices, config)[source]
+

Find bonded interactions from connectivity and bond types information

+
+

Deprecated since version 1.0.0: prepare_bonds_old was replaced by prepare_bonds for +use with compiled Fortran kernels prior to 1.0.0 release.

+
+

Prepares the necessary equilibrium and bond strength information needed by +the intramolecular interaction functions. This is performed locally on each +MPI rank, as the domain decomposition ensures that for all molecules all +consituent particles are always contained on the same MPI rankself.

+

This function traverses the bond connectivity information provided in the +structure/topology input file and indentifies any two-, three-, or +four-particle potential bonds. For each connected chain of two, three, or +four particles, a matching to bond types is attempted. If the corresponding +names match, a bond object is initialized.

+

In order to investigate the connectivity, a graph is created using +networkx functionality.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2list

List of lists containing local particle indices, equilibrium +distance, and bond strength coefficient for each reconstructed +two-particle bond.

+
+
bonds_3

List of lists containing local particle indices, equilibrium angle, +and bond strength coefficient for each reconstructed three-particle +bond.

+
+
bonds_4

List of lists containing local particle indices, dihedral type index, +and dihedral coefficients for each reconstructed four-particle +torsional bond.

+
+
bb_indexlist

List indicating the dihedral type of each four-particle bond in +bonds_4.

+
+
+
+
+
+

See also

+
+
Bond

Two-particle bond type dataclass.

+
+
Angle

Three-particle angular bond type dataclass.

+
+
Dihedral

Four-particle torsional bond type dataclass.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+hymd.force.prepare_index_based_bonds(molecules, topol)[source]
+
+ +
+
+hymd.force.propensity_potential_coeffs(x: float)[source]
+
+ +
+
+

4.5. Logger

+
+
+class hymd.logger.Logger[source]
+

Log output handler class

+

Notes

+

This wraps the default python library logging, see +docs.python.org/3/library/logging.html.

+
+
Attributes:
+
+
levelint

Determines the verbosity level of the log, corresponding to +logging.level. Numerical values 50 (logging.CRITICAL), +40 (logging.ERROR), 30 +(logging.WARNING), 20 (logging.INFO), +10 (logging.DEBUG), and 0 +(logging.UNSET) are supported values. Any log event message +less severe than the specified level is ignored. All other event +messages are emitted.

+
+
log_filestr

Path to output log file.

+
+
formatstr

Prepended dump string for each log event. Specifies the log event +level, the module emitting the event, the code line, the enclosing +function name, and the MPI rank writing the message.

+
+
date_formatstr

Prepends the date before all log event messages.

+
+
formatterlogging.Formatter

Formatter handling the prepending of the information in format and +date_format to each log event message. Used by default for all +loggers.

+
+
rank0logging.Logger

Default logger object for the root MPI rank.

+
+
all_rankslogging.Logger

Default logger object for messages being emitted from all MPI ranks +simultaneously.

+
+
+
+
+
+
+classmethod setup(default_level=20, log_file=None, verbose=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Sets up the logger object.

+

If a log_file path is provided, log event messages are output +to it. Otherwise, the logging messages are emitted to stdout.

+
+
Parameters:
+
+
default_levelint, optional

Default verbosity level of the logger. Unless specified, it is +10 (logging.INFO).

+
+
log_filestr, optional

Path to output log file. If None or not priovided, no log file is +used and all logging is done to stdout.

+
+
verbosebool, optional

Increases the logging level to 30 (logging.WARNING) +if True, otherwise leaves the logging level unchanged.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterRoot(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the root MPI rank log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterAll(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the all-MPI-ranks log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+

4.6. Input parser

+

Parses and handles the configuration information provided for the simulation

+
+
+class hymd.input_parser.Config(n_steps: int, time_step: float, mesh_size: Union[List[int], numpy.ndarray, int], sigma: float, kappa: float, dtype: Optional[numpy.dtype] = None, box_size: Optional[Union[List[float], numpy.ndarray]] = None, n_print: Optional[int] = None, tau: Optional[float] = None, start_temperature: Optional[Union[float, bool]] = None, target_temperature: Optional[Union[float, bool]] = None, mass: Optional[float] = None, hamiltonian: Optional[str] = None, domain_decomposition: Optional[Union[int, bool]] = None, integrator: Optional[str] = None, respa_inner: int = 1, file_name: str = '<config file path unknown>', name: Optional[str] = None, tags: List[str] = <factory>, bonds: List[hymd.force.Bond] = <factory>, angle_bonds: List[hymd.force.Angle] = <factory>, dihedrals: List[hymd.force.Dihedral] = <factory>, chi: List[hymd.force.Chi] = <factory>, n_particles: Optional[int] = None, max_molecule_size: Optional[int] = None, n_flush: Optional[int] = None, thermostat_work: float = 0.0, thermostat_coupling_groups: List[List[str]] = <factory>, initial_energy: Optional[float] = None, cancel_com_momentum: Union[int, bool] = False, coulombtype: Optional[str] = None, convergence_type: Optional[str] = None, pol_mixing: Optional[float] = None, dielectric_const: Optional[float] = None, conv_crit: Optional[float] = None, dielectric_type: List[hymd.force.Dielectric_type] = <factory>, self_energy: Optional[float] = None, type_charges: Optional[Union[List[float], numpy.ndarray]] = None, rho0: Optional[float] = None, a: Optional[float] = None, pressure: bool = False, barostat: Optional[str] = None, barostat_type: Optional[str] = None, tau_p: Optional[float] = None, target_pressure: List[hymd.barostat.Target_pressure] = <factory>, n_b: Optional[int] = None, m: List[float] = <factory>)[source]
+

Configuration object

+

Handles and verifies the simulation configuration specified in the +configuration file.

+
+

See also

+
+
hymd.input_parser.Bond

Two-particle bond type dataclass.

+
+
hymd.input_parser.Angle

Three-particle bond type dataclass.

+
+
hymd.input_parser.Dihedral

Four-particle bond type dataclass.

+
+
+ +
+
Attributes:
+
+
gas_constantfloat

Constant value of the gas constant, R (equivalently the Boltzmann +constant) in the units used internally in HyMD.

+
+
coulomb_constantfloat

Constant value of the Coulomb constant which converts electric field +values to forces and electric potential values to energies in the units +used internally in HyMD.

+
+
n_steps: int

Number of time steps in the simulation.

+
+
time_step: float

Outer time step used in the simulation. If the rRESPA intergrator is +used, the inner time step (the time step used in the integration of +intramolecular bending, stretching, and torsional forces) is +time_step / respa_inner.

+
+
box_sizelist[float] or (D,) numpy.ndarray

Simulation box size of simulation in D dimensions in units of +nanometers.

+
+
mesh_sizelist[int] or int or numpy.ndarray

Number of grid points used for the discrete density grid.

+
+
sigmafloat

Filter width representing the effective coarse-graining level of the +particles in the simulation.

+
+
kappafloat

Compressibility parameter used in the relaxed incompressibility term in +the interaction energy functional.

+
+
n_printint, optional

Frequency of trajectory/energy output to the H5MD trajectory/energy +output file (in units of number of time steps).

+
+
taufloat, optional

The time scale of the CSVR thermostat coupling.

+
+
start_temperaturefloat, optional

Generate starting temperature by assigning all particle velocities +randomly according to the Maxwell-Boltzmann distribution at +start_temperature Kelvin prior to starting the simulation.

+
+
target_temperaturefloat, optional

Couple the system to a heat bath at target_temperature Kelvin.

+
+
massfloat, optional

Mass of the particles in the simulation.

+
+
hamiltonianstr, optional

Specifies the interaction energy functional \(W[\tilde\phi]\) +for use with the particle-field interactions. Options: +SquaredPhi, DefaultNohChi, or DefaultWithChi.

+
+
domain_decompositionint, optional

Specifies the interval (in time steps) of domain decomposition +exchange, involving all MPI ranks sending and receiving particles +according to the particles’ positions in the integration box and the +MPI ranks’ assigned domain.

+
+
integratorstr, optional

Specifies the time integrator used in the simulation. Options: +velocity-verlet or respa.

+
+
respa_innerint, optional

The number of inner time steps in the rRESPA integrator. This denotes +the number of intramolecular force calculations (stretching, bending, +torsional) are performed between each impulse applied from the field +forces.

+
+
file_namestr, optional

File path of the parsed configuration file.

+
+
namestr, optional

Name for the simulation.

+
+
tagslist[str], optional

Tags for the simulation.

+
+
bondslist[Bond], optional

Specifies harmonic stretching potentials between particles in the +same molecule.

+
+
angle_bondslist[Angle], optional

Specifies harmonic angular bending potentials between particles in the +same molecule.

+
+
dihedralslist[Dihedral], optional

Specifies four-particle torsional potentials by cosine series.

+
+
chilist[Chi], optional

Specifies \(\chi\)-interaction parameters between particle +species.

+
+
n_particlesint, optional

Specifies the total number of particles in the input. Optional keyword +for validation, ensuring the input HDF5 topology has the correct number +of particles and molecules.

+
+
max_molecule_sizeint, optional

Maximum size of any single molecule in the system. Used to speed up +distribution of particles onto MPI ranks in a parallel fashion.

+
+
n_flushint, optional

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be +written to disk (in units of number of n_print).

+
+
thermostat_workfloat

Work performed by the thermostat on the system.

+
+
thermostat_coupling_groupslist[str], optional

Specifies individual groups coupling independently to the CSVR +thermostat. E.g. in a system containing "A", "B", and +"C" type particles, +thermostat_coupling_groups = [["A", "B"], ["C"],] would +thermalise types "A" and "B" together and couple +"C" type particles to a different thermostat (all individual +thermostats are at the same temperature, i.e. target_temperature +Kelvin).

+
+
initial_energyfloat

Value of the total energy prior to the start of the simulation.

+
+
cancel_com_momentumint, optional

If True, the total linear momentum of the center of mass is +removed before starting the simulation. If an integer is specifed, the +total linear momentum of the center of mass is removed every +remove_com_momentum time steps. If False, the linear +momentum is never removed.

+
+
coulombtypestr, optional

Specifies the type of electrostatic Coulomb interactions in the system. +The strength of the electrostatic forces is modulated by the relative +dielectric constant of the simulation medium, specified with the +dielectric_const keyword. Charges for individual particles are +specified in the structure/topology HDF5 input file, not in the +configuration file. If no charges (or peptide backbone dipoles) are +present, the electrostatic forces will not be calculated even if this +keyword is set to "PIC_Spectral".

+
+
dielectric_constfloat, optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. When +using helical propensity dihedrals, this keyword must be specified—even +if electrostatics are not included with the coulombtype +keyword.

+
+
dielectric_type: list[float], optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. The list assigns +relative dielectric values to each bead type, and an anisotropic +dielectric function is obtained from a weighted average.

+
+
+
+
+
+
+a: float = None
+
+ +
+
+angle_bonds: List[hymd.force.Angle]
+
+ +
+
+barostat: str = None
+
+ +
+
+barostat_type: str = None
+
+ +
+
+bonds: List[hymd.force.Bond]
+
+ +
+
+box_size: Union[List[float], numpy.ndarray] = None
+
+ +
+
+cancel_com_momentum: Union[int, bool] = False
+
+ +
+
+chi: List[hymd.force.Chi]
+
+ +
+
+conv_crit: float = None
+
+ +
+
+convergence_type: str = None
+
+ +
+
+coulomb_constant: ClassVar[float] = 138.935458
+
+ +
+
+coulombtype: str = None
+
+ +
+
+dielectric_const: float = None
+
+ +
+
+dielectric_type: List[hymd.force.Dielectric_type]
+
+ +
+
+dihedrals: List[hymd.force.Dihedral]
+
+ +
+
+domain_decomposition: Union[int, bool] = None
+
+ +
+
+dtype: numpy.dtype = None
+
+ +
+
+file_name: str = '<config file path unknown>'
+
+ +
+
+gas_constant: ClassVar[float] = 0.0083144621
+
+ +
+
+hamiltonian: str = None
+
+ +
+
+initial_energy: float = None
+
+ +
+
+integrator: str = None
+
+ +
+
+kappa: float
+
+ +
+
+m: List[float]
+
+ +
+
+mass: float = None
+
+ +
+
+max_molecule_size: int = None
+
+ +
+
+mesh_size: Union[List[int], numpy.ndarray, int]
+
+ +
+
+n_b: int = None
+
+ +
+
+n_flush: int = None
+
+ +
+
+n_particles: int = None
+
+ +
+
+n_print: int = None
+
+ +
+
+n_steps: int
+
+ +
+
+name: str = None
+
+ +
+
+pol_mixing: float = None
+
+ +
+
+pressure: bool = False
+
+ +
+
+respa_inner: int = 1
+
+ +
+
+rho0: float = None
+
+ +
+
+self_energy: float = None
+
+ +
+
+sigma: float
+
+ +
+
+start_temperature: Union[float, bool] = None
+
+ +
+
+tags: List[str]
+
+ +
+
+target_pressure: List[hymd.barostat.Target_pressure]
+
+ +
+
+target_temperature: Union[float, bool] = None
+
+ +
+
+tau: float = None
+
+ +
+
+tau_p: float = None
+
+ +
+
+thermostat_coupling_groups: List[List[str]]
+
+ +
+
+thermostat_work: float = 0.0
+
+ +
+
+time_step: float
+
+ +
+
+type_charges: Union[List[float], numpy.ndarray] = None
+
+ +
+ +
+
+hymd.input_parser.check_NPT_conditions(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check validity of barostat_type, barostat, +a, rho0, target_pressure, tau_p

+
+ +
+
+hymd.input_parser.check_angles(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_bonds(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_box_size(config, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_cancel_com_momentum(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_charges(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if charges across ranks sum to zero.

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of floats with charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_charges_types_list(config, types, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates a list of charge values of length types. +Charges are sorted according to type ID. Used in field.py. +# TODO: this is messy, we should fix it

+
+ +
+
+hymd.input_parser.check_chi(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_config(config, indices, names, types, charges, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs various checks on the specfied config to ensure consistency

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
indices(N,) numpy.ndarray

Array of integer indices for N particles.

+
+
names(N,) numpy.ndarray

Array of string names for N particles.

+
+
types(N,) numpy.ndarray

Array of integer type indices for N particles.

+
+
charges(N,) numpy.ndarray

Array of floats charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
Returns:
+
+
configConfig

Validated configuration object.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_dielectric(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Error handling for electrostatics. +Unit testing of toml/tomli input.

+
+ +
+
+hymd.input_parser.check_dihedrals(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_domain_decomposition(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_hamiltonian(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_integrator(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_m(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_mass(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_max_molecule_size(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_b(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_flush(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_particles(config, indices, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_print(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_name(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_start_and_target_temperature(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Validate provided starting and target thermostat temperatures

+

Assesses the provided temperature target and ensures it is a non-negative +floating point number or False. Ensures the starting temperature is +a non-negative floating point number or False.

+

If the value for either is None, the returned configuration object +has the values defaulted to False in each case.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
validated_configConfig

Configuration object with validated target_temperature and +start_temperature.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_tau(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_thermostat_coupling_groups(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.parse_config_toml(toml_content, file_path=None, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.read_config_toml(file_path)[source]
+
+ +
+
+hymd.input_parser.sort_dielectric_by_type_id(config, charges, types)[source]
+

Creates a list of length N CG-particles, sorted after the charges from +the input HDF5 file. Used in file_io.py

+
+ +
+
+

4.7. Field

+

Forces and energies from the discretized particle-field grid interactions

+
+
+hymd.field.compute_field_and_kinetic_energy(phi, phi_q, psi, velocity, hamiltonian, positions, types, v_ext, config, layouts, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the particle-field and kinetic energy contributions

+

Calculates the kinetic energy through

+
+\[E_k = \sum_j \frac{1}{2}m_j\mathbf{v}_j\cdot\mathbf{v}_j,\]
+

and the particle-field energy by

+
+\[E_\text{field} = \int\mathrm{d}\mathbf{r}\, + w[\tilde\phi],\]
+

where \(w\) is the interaction energy functional density.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
velocity(N,D) numpy.ndarray

Array of velocities for N particles in D dimensions. +Local for each MPI rank.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Local for each MPI rank–the full computational grid is +represented by the collective fields of all MPI ranks.

+
+
configConfig

Configuration object.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field

Computes the up-to-date external potential for use in calculating the particle-field energy.

+
+
+ +
+ +
+
+hymd.field.compute_field_energy_q_GPE(config, phi_eps, field_q_energy, dot_elec, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the electrostatic energy after electrosatic forces is +calculated.

+

From the definition of the elecrostatic potential \(\Psi\), the energy +is

+
+
+
W = frac{1}{2}intmathrm{d}mathbf{r},

epsilon(mathbf{r})} left(mathbf{E}cdot mathbf{E}right),

+
+
+
+

where \(\epsilon(\mathbf{r})}\) is the anisotropic, spatially dependent, +relative dielectric of the simulation medium.

+
+
Parameters:
+
+
confighymd.input_parser.Config

Configuration object.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
field_q_energyfloat

Total elecrostatic energy.

+
+
dot_elecpmesh.pm.RealField

Pmesh RealField object for storing \(|\mathbf{E(r)}|^{2}\) +on the computational grid. Local for each MPI rank – the full computational +grid is represented by the collective fields of all MPI ranks.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field_force_q_GPE

Compute the electrosatic force from an anisotropic dielectric general Poisson equation.

+
+
+ +
+ +
+
+hymd.field.compute_field_force(layouts, r, force_mesh, force, types, n_types)[source]
+

Interpolate particle-field forces from the grid onto particle positions

+

Backmaps the forces calculated on the grid to particle positions using the +window function \(P\) (by default cloud-in-cell [CIC]). In the +following, let \(\mathbf{F}_j\) denote the force acting on the +particle with index \(j\) and position \(\mathbf{r}_j\). The +interpolated force is

+
+\[\mathbf{F}_j = -\sum_k\nabla V_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(V_{j_k}\) is the discretized external potential at grid vertex +\(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid vertex +with index \(j_k\), and \(h^3\) is the volume of each grid voxel. +The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
r(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
force(N,D) numpy.ndarray

Array of forces for N particles in D dimensions. Local +for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
n_typesint

Number of different unique types present in the simulation system. +n_types is global, i.e. the same for all MPI ranks even if some +ranks contain zero particles of certain types.

+
+
+
+
+
+ +
+
+hymd.field.compute_self_energy_q(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the self energy for the interaction due to the Ewald scheme +used to compute the electrostatics. The energy is stored in config.

+

The self interaction energy is given by:

+
+\[U_{self} = \sqrt{\frac{1}{2\pi\sigma^2}} \sum_{i=1}^{N} q_i^2\]
+

where \(q_i\) are the charges and \(\sigma\) is the half-width +of the Gaussian filter.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
Returns:
+
+
field_q_self_energyfloat

Electrostatic self energy.

+
+
+
+
+
+ +
+
+hymd.field.domain_decomposition(positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs domain decomposition

+

Rearranges the MPI rank memory layout into one that better mimics the PFFT +pencil grid 2D decomposition. As molecules are always required to be fully +contained on a single MPI rank, a perfect decomposition is not always +possible. The best decomposition which leaves the center of mass of all +molecules in their respective correct domains is used, with possible +overlap into neighbouring domains if the spatial extent of any molecule +crosses domain boundaries.

+
+
Parameters:
+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
*args

Variable length argument list containing arrays to include in the +domain decomposition.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
bonds(N,M) numpy.ndarray, optional

Array of M bonds originating from each of N particles.

+
+
verboseint, optional

Specify the logging event verbosity of this function.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
Domain decomposedcode:positions and any array specified in
+
:code:`*args`, in addition tocode:bonds and molecules if these
+
arrays were provided as input.
+
+
+
+
+ +
+
+hymd.field.initialize_pm(pmesh, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates the necessary pmesh objects for pfft operations.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pmobject ‘pmesh.pm.ParticleMesh’
+
field_listlist[pmesh.pm.RealField], (multiple)

Essential list of pmesh objects required for MD

+
+
list_coulomblist[pmesh.pm.RealField], (multiple)

Additional list of pmesh objects required for electrostatics.

+
+
+
+
+
+ +
+
+hymd.field.update_field(phi, phi_laplacian, phi_transfer, layouts, force_mesh, hamiltonian, pm, positions, types, config, v_ext, phi_fourier, v_ext_fourier, m, compute_potential=False)[source]
+

Calculate the particle-field potential and force density

+

If compute_potential is True, the energy may subsequently +be computed by calling compute_field_and_kinetic_energy.

+

Computes the particle-field external potential \(V_\text{ext}\) from +particle number densities through the smoothed density field, +\(\phi(\mathbf{r})\). With \(P\) being the cloud-in-cell (CIC) +window function, the density and filtered densities are computed as

+
+\[\phi(\mathbf{r}) = \sum_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\phi(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +external potential is computed in reciprocal space as

+
+\[V_\text{ext} = \mathrm{FFT}^{-1}\left[ + \mathrm{FFT} + \left( + \frac{\partial w}{\partial \tilde\phi} + \right) + \mathrm{FFT}(H) +\right],\]
+

where \(w\) is the interaction energy functional. Differentiating +\(V_\text{ext}\) is done by simply applying \(i\mathbf{k}\) in +Fourier space, and the resulting forces are back-transformed to direct +space and interpolated to particle positions by

+
+\[\mathbf{F}_j = -\sum_{j_k} \nabla V_{j_k} + P(\mathbf{r}_{j_k} - \mathbf{r}_j)h^3,\]
+

where \(j_k\) are the neighbouring vertices of particle \(j\) at +position \(\mathbf{r}_j\), and \(h^3\) is the volume of each grid +voxel.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Pre-allocated, but empty; any values +in this field are discarded. Changed in-place. Local for each MPI +rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
configConfig

Configuration object.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Pre-allocated, but empty; any values in this field are +discarded Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
phi_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computational grid is represented by the collective fields of all +MPI ranks.

+
+
v_ext_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplesField objects containing discretized +particle-field external potential values in reciprocal space on the +computational grid; D+1 fields in D dimensions for each +particle type. D copies are made after calculation for later +use in force calculation, because the force transfer function +application differentiates the field in-place, ruining the contents +for differentiation in the remaining D-1 spatial directions. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
m: list[float], (M,)

pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. +Defaults to 1.0 for all particle types.

+
+
compute_potentialbool, optional

If True, a D+1-th copy of the Fourier transformed +external potential field is made to be used later in particle-field +energy calculation. If False, only D copies are made.

+
+
+
+
+
+

See also

+
+
compute_field_and_kinetic_energy

Compute the particle-field energy after the external potential is calculated.

+
+
+ +
+ +
+
+hymd.field.update_field_force_q(charges, phi_q, phi_q_fourier, psi, psi_fourier, elec_field_fourier, elec_field, elec_forces, layout_q, hamiltonian, pm, positions, config)[source]
+

Calculate the electrostatic particle-field forces on the grid

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential is computed in reciprocal space as

+
+\[\Phi = \mathrm{FFT}^{-1}\left[ + \frac{4\pi k_e}{\varepsilon \vert\mathbf{k}\vert^2} + \mathrm{FFT}(\rho)\mathrm{FFT}(H) +\right],\]
+

with the electric field

+
+\[\mathbf{E} = \mathrm{FFT}^{-1}\left[ + -i\mathbf{k}\,\mathrm{FFT}(\Psi) +\right].\]
+

In the following, let \(\mathbf{F}_j\) denote the electrostatic force +acting on the particle with index \(j\) and position +\(\mathbf{r}_j\). The interpolated electrostatic force is

+
+\[\mathbf{F}_j = \sum_k q_j\mathbf{E}_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(\mathbf{E}_{j_k}\) is the discretized electric field at grid +vertex \(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid +vertex with index \(j_k\), and \(h^3\) is the volume of each grid +voxel. The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty; any values in this field +are discarded. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
elec_field_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +electric field values in reciprocal space on the computational grid. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
+
+
+
+ +
+
+hymd.field.update_field_force_q_GPE(conv_fun, phi, types, charges, phi_q, phi_q_fourier, phi_eps, phi_eps_fourier, phi_eta, phi_eta_fourier, phi_pol_prev, phi_pol, elec_field, elec_forces, elec_field_contrib, psi, Vbar_elec, Vbar_elec_fourier, force_mesh_elec, force_mesh_elec_fourier, hamiltonian, layout_q, layouts, pm, positions, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Calculate the electrostatic particle-field forces on the grid, arising from +a general Poisson equation, i.e. anisotropic permittivity/dielectric. +The function is called when tomli input config.coulombtype = “PIC_Spectral_GPE.”

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential for a variable dielectric does not have an +analytical expression, and is computed in reciprocal through an iterative +method.

+

The GPE states that

+
+\[\nabla \cdot \left(\epsilon(\mathbf{r}) +\nabla{\mathbf{\psi(r)}}\right) = -\rho({\mathbf{r}}).\]
+

where \(\epsilon(\mathbf{r})\) is the relative dielectric function.

+
+
Parameters:
+
+
conv_funConvergence function.

Returns a scalar. Depends on MPI allreduce for similar convergence +across MPI ranks.

+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_eps_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_etapmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +gradients of the relative dielectric values on the computational grid. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank–the +full computational grid is represented by the collective fields of all MPI ranks.

+
+
phi_eta_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated discretized +Fourier transformed gradient relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_pol_prevpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charge values on the computational grid. Parameter in +the iterative method.Pre-allocated,but empty. Changedin-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_polpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charges on the computational grid. Parameter in the iterative +method, updating the next quess in solving for the electrostatic potential. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank– +the full computational grid is represented by the collective fields of +all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all +MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
elec_field_contribpmesh.pm.RealField

Pmesh RealField object for storing +\(|\mathbf{E(r)}|^2/\phi_{0}\) on the computational grid. +Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
psipmesh.pm.RealField

Pmesh RealField object for storing electrostatic potential +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
Vbar_elecmesh.pm.RealField

Pmesh RealField object for storing functional derivatives of +:math:`|w({ phi })_{elec}`on the computational grid. +Pre-allocated, but empty. Changed in-place. Local for each MPI rank– +the full computational grid is represented by the collective fields of

+
+

all MPI ranks.

+
+
+
Vbar_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated functional +derivatives of \(\|w(\{ \phi \})_{elec}\) in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
force_mesh_elecpmesh.pm.RealField

Pmesh RealField object for storing electrostatic force values +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
force_mesh_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated electrostatic +force values in reciprocal space on the computational grid. Local for +each MPI rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
layouts: list[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
comm: mpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
compute_field_energy_q_GPE

Compute the electrostatic energy after electrosatic force is calculated for a variable (anisotropic) dielectric general Poisson equation.

+
+
+ +
+ +
+
+

4.8. File input/output

+

Handle file input/output in parllel HDF5 fashion

+
+
+class hymd.file_io.OutDataset(dest_directory, config, double_out=False, disable_mpio=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

HDF5 dataset handler for file output

+
+
+close_file(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Closes the HDF5 output file

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+
+flush()[source]
+

Flushes output buffers, forcing file writes

+
+ +
+
+is_open(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if HDF5 output file is open

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+ +
+
+hymd.file_io.distribute_input(in_file, rank, size, n_particles, max_molecule_size=201, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Assign global arrays onto MPI ranks, attempting load balancing

+

Distributes approximately equal numbers of particles (workload) onto each +independent MPI rank, while respecting the requirement that any molecule +must be fully contained on a single MPI rank only (no splitting molecules +across multiple CPUs).

+
+
Parameters:
+
+
in_fileh5py.File

HDF5 input file object.

+
+
rankint

Local rank number for this MPI rank.

+
+
sizeint

Global size of the MPI communicator (number of total CPUs).

+
+
n_particlesint

Total number of particles.

+
+
max_molecule_sizeint, optional

Maximum size of any molecule present in the system. Used to initially +guess where the MPI rank boundaries (start/end indices) in the global +arrays should be placed. If molecules of size +>max_molecule_size exist in the simulation system, HyMD +might work as expected. Or it might fail spectacularly.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
rank_range

Starting and ending indices in the global arrays for each MPI rank.

+
+
+
+
+
+ +
+
+hymd.file_io.setup_time_dependent_element(name, parent_group, n_frames, shape, dtype, units=None)[source]
+

Helper function for setting up time-dependent HDF5 group datasets

+

All output groups must adhere to the H5MD standard, meaning a structure of

+
+
┗━ group particle group (e.g. all) or observables group
+
+
┗━ group time-dependent data
+
+
┣━ dataset step shape=(n_frames,)
+
┣━ dataset time shape=(n_frames,)
+
┗━ dataset value shape=(n_frames, *)
+
+
+
+

is necessary.

+

References

+
+
H5MD specification :

https://www.nongnu.org/h5md/h5md.html

+
+
+
+ +
+
+hymd.file_io.store_data(h5md, step, frame, indices, positions, velocities, forces, box_size, temperature, pressure, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, field_energy, field_q_energy, plumed_bias, time_step, config, velocity_out=False, force_out=False, charge_out=False, plumed_out=False, dump_per_particle=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Writes time-step data to HDF5 output file

+

Handles all quantities which change during simulation, as opposed to +static quanitities (see store_static).

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
stepint

Step number.

+
+
frameint

Output frame number (step // n_print).

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
positions(N,) numpy.ndarray

Array of positions for N particles in D dimensions.

+
+
velocities(N,) numpy.ndarray

Array of velocities for N particles in D dimensions.

+
+
forces(N,) numpy.ndarray

Array of forces for N particles in D dimensions.

+
+
box_size(D,) numpy.ndarray

Array containing the simulation box size.

+
+
temperaturefloat

Calculated instantaneous temperature.

+
+
kinetic_energyfloat

Calculated instantaneous kinetic energy.

+
+
bond2_energyfloat

Calculated instantaneous harmonic two-particle bond energy.

+
+
bond3_energyfloat

Calculated instantaneous harmonic angular three-particle bond energy.

+
+
bond4_energyfloat

Calculated instantaneous dihedral four-particle torsion energy.

+
+
field_energyfloat

Calculated instantaneous particle-field energy.

+
+
field_q_energyfloat

Calculated instantaneous electrostatic energy.

+
+
plumed_biasfloat

PLUMED instantaneous bias energy.

+
+
time_stepfloat

Value of the time step.

+
+
configConfig

Configuration object.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charge_outbool, optional

If True, electrostatic energies are written to the output +HDF5 file.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to the output HDF5 file.

+
+
dump_per_particlebool, optional

If True, all quantities are written per particle.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
store_static

Outputs all static time-independent quantities to the HDF5 output file

+
+
+ +
+ +
+
+hymd.file_io.store_static(h5md, rank_range, names, types, indices, config, bonds_2_atom1, bonds_2_atom2, molecules=None, velocity_out=False, force_out=False, charges=False, dielectrics=False, plumed_out=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Outputs all static time-independent quantities to the HDF5 output file

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
rank_rangelist[int]

Start and end indices for global arrays for each MPI rank.

+
+
names(N,) numpy.ndarray

Array of names for N particles.

+
+
types(N,) numpy.ndarray

Array of type indices for N particles.

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
configConfig

Configuration object.

+
+
bonds_2_atom1(B,) numpy.ndarray

Array of indices of the first particle for B total +two-particle bonds.

+
+
bonds_2_atom2(B,) numpy.ndarray

Array of indices of the second particle for B total +two-particle bonds.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles.

+
+
dielectrics(N,) numpy.ndarray

Array of particle relative dielectric values for N particles.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to output HDF5 file.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
prepare_bonds

Constructs two-, three-, and four-particle bonds from toplogy input file and bond configuration information.

+
+
distribute_input

Distributes input arrays onto MPI ranks, attempting load balancing.

+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/doc_pages/benchmarks.html b/v1.0.8/doc_pages/benchmarks.html new file mode 100644 index 00000000..f790c2a4 --- /dev/null +++ b/v1.0.8/doc_pages/benchmarks.html @@ -0,0 +1,302 @@ + + + + + + + 3. Benchmarks — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Benchmarks

+

Homopolymer melt test systems of \(30^2\), \(40^2\), and \(50^2\) +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively.

+
+

3.1. Bonded forces

+

Legend label denotes the number of particles in the system.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-1.png +
+
+
+

3.2. Particle–field forces

+

Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-2.png +
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/doc_pages/command_line.html b/v1.0.8/doc_pages/command_line.html new file mode 100644 index 00000000..30292eaa --- /dev/null +++ b/v1.0.8/doc_pages/command_line.html @@ -0,0 +1,359 @@ + + + + + + + 5. Command line arguments — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. Command line arguments

+

Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle–field interactions.

+
+

5.1. Required arguments

+
+
configuration file:
+

type positional

+

Specifies the .toml format configuration file containing simulation details. See Configuration file for details.

+
+
structure and topology file:
+

type positional

+

Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See Topology and structure file for details.

+
+
+
+
+

5.2. Optional arguments

+
+
-v  --verbose

type optional

+

Number of following arguments: 0 or 1

+

Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying -v or --verbose with no additional specification. This increases verbosity level by 1. Alternatively, it maye be specified by --verbose V with V being 0, 1, or 2.

+
+
--profile

type optional

+

Number of following arguments: 0

+

Enables code profiling using cProfile. This will output one profiling file per MPI rank invoked in the simulation.

+
+
--double-precision

type optional

+

Number of following arguments: 0

+

Specify usage of double precision internally in HyMD (including in the FFTs).

+
+
--double-output

type optional

+

Number of following arguments: 0

+

Specify usage of double precision in the output trajectory from HyMD.

+
+
--velocity-output

type optional

+

Number of following arguments: 0

+

Specify that velocities should be output to the HyMD trajectory.

+
+
--force-output

type optional

+

Number of following arguments: 0

+

Specify that forces should be output to the HyMD trajectory.

+
+
--disable-mpio

type optional

+

Number of following arguments: 0

+

Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult.

+
+
--logfile

type optional

+

Number of following arguments: 1

+

Specifies the path of a plain text log file in which stdout is mirrored during simulation runs.

+
+
--seed

type optional

+

Number of following arguments: 1

+

Specifies the random seed used in the numpy random library to generate velocities, thermostatting, etc.

+
+
--disable-bonds

type optional

+

Number of following arguments: 0

+

Disable any two-particle bonds present in the system.

+
+
--disable-angle-bonds

type optional

+

Number of following arguments: 0

+

Disable any three-particle bonds present in the system.

+
+
--disable-dihedrals

type optional

+

Number of following arguments: 0

+

Disable any four-particle bonds present in the system.

+
+
--disable-dipole

type optional

+

Number of following arguments: 0

+

Disable any topological reconstruction of peptide backbone dipoles present in the system.

+
+
--disable-field

type optional

+

Number of following arguments: 0

+

Disable any particle–field interactions present in the system.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/doc_pages/config_file.html b/v1.0.8/doc_pages/config_file.html new file mode 100644 index 00000000..07fbe3f1 --- /dev/null +++ b/v1.0.8/doc_pages/config_file.html @@ -0,0 +1,446 @@ + + + + + + + 3. Configuration file — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Configuration file

+

The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order.

+

The configuration file is a toml format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs.

+
+

3.1. Configuration file keywords

+

The following constitutes every possible keyword specification in HyMD +configuration files:

+
+

3.1.1. Metadata keywords

+

Configuration keywords specifying metadata for the H5MD output trajectory.

+
+
name:
+

string [optional, default: None]

+

Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file.

+
+
tags:
+

array [string] [optional, default: None]

+

Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file.

+
+
+
+
+

3.1.2. Particle keywords

+

Configuration keywords specifying properties of particles and molecules in the +system.

+
+
n_particles:
+

integer [optional, default: None]

+

Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules.

+
+
mass:
+

float [optional, default: 72.0] {units: \(\text{u}=\text{g}\,\text{mol}^{-1}\)}

+

Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal.

+
+
max_molecule_size:
+

integer [optional, default: 201]

+

Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code will crash if there are molecules larger than max_molecule_size in the topology/structure input file.

+
+
+
+
+

3.1.3. Simulation keywords

+

Configuration keywords specifying simulation parameters.

+
+
n_steps:
+

integer [required]

+

Total number of integration steps to perform for this simulation.

+
+
n_print:
+

integer or boolean [optional, default: False]

+

Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of number of time steps).

+
+
n_flush:
+

integer [optional, default: None]

+

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of number of n_print, i.e. n_print = 13, n_flush = 3 would result in the trajectory/energy being written to disk every 13 x 3 = 39 simulation steps)

+
+
time_step:
+

float [required] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time step per integration step. If the rRESPA multiple time step integrator is used (integrator = "respa"), this specifies the inner time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is respa_inner times the time_step , and the total simulation time is n_steps times time_step times respa_inner .

+
+
box_size:
+

array [float] [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable.

+
+
integrator:
+

string [required] (options: velocity-verlet or respa)

+

Specifies the time integrator used in the simulation. If respa, the reversible reference system propagator algorithm (rRESPA) [Tuckerman et al., 1992] integrator is used, with respa_inner number of inner (intramolecular force) time steps. If velocity-verlet, a normal Velocity Verlet integrator is used. If respa and respa_inner = 1, the rRESPA integrator is equivalent to the Velocity Verlet.

+
+
respa_inner:
+

integer [optional, default: 1]

+

The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces.

+
+
domain_decomposition:
+

integer or boolean [optional, default: False]

+

Specifies the interval (in time steps) of domain decomposition exchange, involving all MPI ranks sending and receiving particles according to the particles’ positions in the integration box and the MPI ranks’ assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If True, the decomposition is performed once (before starting the simulation). If False, no decomposition is performed.

+
+
cancel_com_momentum:
+

integer or boolean [optional, default: False]

+

If True, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every remove_com_momentum time steps. If False, the linear momentum is never removed.

+
+
start_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at start_temperature Kelvin prior to starting the simulation. If False, the velocities are not changed before starting the simulation.

+
+
target_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Couple the system to a heat bath at target_temperature Kelvin by applying a Canonical sampling through velocity rescaling [Bussi et al., 2007] thermostat with coupling strength tau. If False, no temperature control is applied.

+
+
tau:
+

float [optional, default: 0.7] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the CSVR thermostat coupling. In the limit of tau , the Hamiltonian dynamics are preserved and no temperature coupling takes place.

+
+
thermostat_coupling_groups:
+

array [array [string]] [optional, default: []]

+

Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing "A", "B", and "C" type particles, thermostat_coupling_groups = [["A", "B"], ["C"],] would thermalise types "A" and "B" together and couple "C" type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. target_temperature Kelvin).

+
+
hamiltonian:
+

string [optional, default: "DefaultNohChi"] (options: SquaredPhi, DefaultNohChi, or DefaultWithChi)

+

Specifies the interaction energy functional \(W[\tilde\phi]\) for use with the particle-field interactions. See Interaction energy functionals for details.

+
+
+
+
+

3.1.4. Field keywords

+

Configuration keywords specifying field parameters.

+
+
mesh_size:
+

array [integer] or integer [required]

+

Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is box_size / mesh_size.

+
+
kappa:
+

float [required] {units: \(\text{kJ}^{-1}\text{mol}\)}

+

Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional \(W[\tilde\phi]\). See Interaction energy functionals for more details.

+
+
sigma:
+

float [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See Filtering for more details.

+
+
chi:
+

array [array [string, float]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\)}

+

Array of \(\tilde\chi_\text{AB}\)-parameters indicating the strength of the repulsive or attractive interaction between particles of type "A" and the number density due to particles of type "B", and vice versa. Example: chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ] would specify a repulsive "A""B" type interaction, and a weakly attractive "C""D" interaction. Self-interaction \(\tilde\chi\)-terms are always zero. See Interaction energy functionals for more details.

+
+
+
+
+

3.1.5. Bond keywords

+

Configuration keywords specifying bonds and bonds parameters.

+
+
bonds:
+

array [array [2 string, 2 float]] [optional, default: []] {units: \(\text{nm}=10^{-9}~\text{m}\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+

Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ] indicates a "A""A" bond of equilibrium length 0.47 \(\text{nm}\) with a bond strength of 980.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding bond between "A" and "B" type particles with equilibrium length 0.31 \(\text{nm}\) and a strength of 1250.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify stretching bonds.

+
+
angle_bonds:
+

array [array [3 string, 2 float]] [optional, default: []] {units: \({}^\circ\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+
+

Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ] indicates a "A""A""A" angular bond that tries to keep the bond linear at 180 degrees with a bending strength of 55.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding angle bond between "A""B""B" prefering the angle at 120 degrees and a strength of 25.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify angular bonds.

+
+
+
dihedrals:
+

array [array [4 string, integer, COSINE SERIES ]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)}

+

Specifies four-particle torsional potentials by cosine series. See Intramolecular bonds for details about how to specify dihedrals.

+
+
+
+
+

3.1.6. Electrostatic keywords

+

Configuration keywords specifying electrostatics and electrostatic parameters.

+
+
coulombtype:
+

string [optional, default: None] (options: PIC_Spectral)

+

Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the dielectric_const keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, not in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to PIC_Spectral.

+
+
dielectric_const:
+

float [optional, default: None]

+

Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified—even if electrostatics are not included with the coulombtype keyword.

+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/doc_pages/constants_and_units.html b/v1.0.8/doc_pages/constants_and_units.html new file mode 100644 index 00000000..4d9779b3 --- /dev/null +++ b/v1.0.8/doc_pages/constants_and_units.html @@ -0,0 +1,393 @@ + + + + + + + 6. Constants and Units — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

6. Constants and Units

+

HyMD uses the following units and constants internally and in all input and +output:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Units

Quantity

Symbol

Unit

length

\(r\)

\(\text{nm}=10^{-9}~\text{m}\)

time

\(t\)

\(\text{ps}=10^{-12}~\text{s}\)

charge

\(q\)

\(e=1.602176634 \cdot 10^{-19}~\text{C}\)

mass

\(m\)

\(\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}\)

temperature

\(\text{T}\)

\(\text{K}\)

energy

\(E\)

\(\text{kJ}\,\text{mol}^{-1}\)

velocity

\(v\)

\(\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}\)

momentum

\(P\)

\(\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}\)

force

\(\mathbf{F}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}\)

pressure

\(p\)

\(\text{bar}=100~\text{kPa}\)

electric potential

\(\Psi\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}\)

electric field

\(\mathbf{E}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}\)

compressibility

\(\kappa\)

\(\text{mol}\,\text{kJ}^{-1}\)

field-interaction

\(\tilde\chi\)

\(\text{kJ}\,\text{mol}^{-1}\)

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants

Constant

Symbol

Value

gas constant

\(R\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Boltzmann’s constant

\(k_\text{B}\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Avogadro’s constant

\(N_\text{A}\)

\(6.02214076 \cdot 10^23~\text{mol}^{-1}\)

Vacuum permittivity

\(\varepsilon_0\)

\(8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2\)

Coulomb constant

\(k_\text{e}\)

\(138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}\)

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/doc_pages/electrostatics.html b/v1.0.8/doc_pages/electrostatics.html new file mode 100644 index 00000000..ed408217 --- /dev/null +++ b/v1.0.8/doc_pages/electrostatics.html @@ -0,0 +1,314 @@ + + + + + + + 3. Electrostatic interactions — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Electrostatic interactions

+

In the filtered Hamiltonian hPF formalism [Bore and Cascella, 2020] the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle–mesh Ewald.

+

The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered

+
+\[\tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i),\]
+

with \(q_i\) being the charge of particle \(i\) and \(H\) is the +filtering function (see Filtering). The value of the charge grid at +vertex \((i,j,k)\) is found by

+
+\[\tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)]\]
+

and the electrostatic potential \(\Psi_{ijk}\)

+
+\[\Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right],\]
+

where \(k_\text{e}\) is the Coulomb constant \(1/4\pi\varepsilon_0\). +The electric field is obtained by differentiation of the electrostatic +potential in Fourier space,

+
+\[\mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)]\]
+

from which the forces are interpolated back to the particle positions.

+
+

3.1. Specifying electrostatics

+

In HyMD, electrostatics are specified by the coulombtype and +dielectric_const keywords in the configuration file (see +Configuration file) and the /charge dataset in the HDF5 format +structure/topology input file (see Topology and structure file). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/doc_pages/examples.html b/v1.0.8/doc_pages/examples.html new file mode 100644 index 00000000..3acf10bd --- /dev/null +++ b/v1.0.8/doc_pages/examples.html @@ -0,0 +1,762 @@ + + + + + + + 1. Examples — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Examples

+

The following examples are ordered in more or less order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the HyMD-tutorial github repository.

+
+

1.1. Ideal gas

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true +

The simplest possible system is one with no interactions at all—intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like:

+
+
ideal_gas.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = false         # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+
+
+

A simple input structure/topology file ideal_gas.HDF5 is available in +the HyMD-tutorial/ideal_gas github repository (along with the code to +generate it). Run the (very) short simulation by

+
python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field   \
+                                              --velocity-output \
+                                              --force-output
+
+
+

with the --disable-field argument to completely turn off all +particle–field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook ideal_gas.ipynb for details.

+
+
+

1.2. Ideal chains

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true +

The simplest available interaction is the harmonic two-particle bond (see +Intramolecular bonds),

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2.\]
+

Extending the configuration file from the ideal gas case, we need to add a +bonds specification. Note that the [bonds] meta specifier is not +necessary, but may be used to help organise the input file.

+
+
ideal_chain.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+
+
+

A simple input structure/topology file ideal_chain.HDF5 with a few +coiled up ideal chain polymers is available in the +HyMD-tutorial/ideal_chain github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field
+
+
+

we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +ideal_chain.ipynb.

+
+
+

1.3. Stiff rods

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true +

Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the i--j--k angle \(\theta\) (see +Intramolecular bonds),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2.\]
+

Extending the configuration file from the ideal chain case, we need to add a +angle_bonds specification. Note that the [bonds] meta specifier +is not necessary, but may be used to help organise the input file.

+
+
rods.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+angle_bonds = [
+  ["A", "A", "A", 180.0, 100.0],   # (i, j, k, equilibrium angle, strength)
+]
+
+
+
+

A simple input structure/topology file rods.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook rods.ipynb.

+
+
+

1.4. Helixes

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true +

Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle \(\phi\) between the +i--j--k plane and the j--k--l plane (see Intramolecular bonds),

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n).\]
+

The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a dihedrals keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the dielectric_const +keyword even though we are not including electrostatic forces in the current +simulation. Note that the [bonds] meta specifier is not necessary, but +may be used to help organise the input file.

+
+
helixes.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+dielectric_const = 15.0
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.31, 10000.0],       # (i name, j name, equilibrium length, strength)
+]
+
+dihedrals = [
+  [
+    ["A", "A", "A", "A"],
+    [
+      [-1],
+      [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+      [0.08, 0.46, 1.65, -0.96, 0.38],
+    ],
+    [1.0]
+  ],
+]
+
+
+
+

A simple input structure/topology file helixes.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook helixes.ipynb.

+
+
+

1.5. Phase separation

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true +

The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types A and B. Using the Hamiltonian

+
+\[\mathcal{H}=H_0+W\]
+

with \(\tilde\chi\)–dependent interactions defined by (specified in the +configuration file by hamiltonian = DefaultWithChi):

+
+\[W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2.\]
+
+
phase_separation.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+
+[field]
+mesh_size = [20, 20, 20]           # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+kappa = 0.05                       # compressibility in mol/kJ
+chi = [
+  ['A', 'B', 5.0],                 # (name i, name j, strength)
+]
+
+
+
+

A simple input structure/topology file phase_separation.HDF5 containing +an equal number of A type and B type particles is available in +the HyMD-tutorial/phase_separation github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd phase_separation.toml phase_separation.HDF5
+
+
+

we may examine the resulting trajectory. In the case of a low interaction +strength \(\tilde\chi\) of 5.0 (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to 40.0 (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +phase_separation.ipynb.

+
+
+

1.6. Diblock copolymers

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true +

Having introduced particle–field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive \(\tilde\chi\)–interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the integrator = "respa" keyword. Putting the pieces together, the +configuration file may look like the following:

+
+
copolymer.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 15
+n_steps = 2000                     # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [10.0, 10.0, 10.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [50, 50, 50]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+chi = [
+  ["A", "B", 30.0],                # (i, j, strength)
+]
+
+[bonds]
+bonds = [
+  ["A", "A", 0.25, 1500.0],        # (i, j, equilibrium length, strength)
+  ["A", "B", 0.25, 1500.0],
+  ["B", "B", 0.25, 1500.0],
+]
+angle_bonds = [
+  ["A", "A", "A", 180.0, 25.0],    # (i, j, k, equilibrium angle, strength)
+  ["B", "B", "B", 180.0, 25.0],
+]
+
+
+
+

A simple input structure/topology file copolymer.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/copolymer github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten A followed by ten B type particles. +Running the simulation with

+
python3 -m hymd copolymer.toml copolymer.HDF5
+
+
+

the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +copolymer.ipynb.

+
+
+

1.7. Lipid bilayer self-assembly

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true +

Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field–particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the thermostat_coupling_groups keyword. With parameters +optimised in [Ledum et al., 2020], the configuration file looks like:

+
+
lipid_self_assembly.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 25
+n_steps = 3000
+n_print = 200
+n_flush = 1
+time_step = 0.01
+box_size = [9.96924, 9.96924, 10.03970]
+start_temperature = 323
+target_temperature = 323
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.05
+domain_decomposition = 10001
+cancel_com_momentum = true
+max_molecule_size = 15
+thermostat_coupling_groups = [
+  ["N", "P", "G", "C"],
+  ["W"],
+]
+
+[field]
+mesh_size = [25, 25, 25]
+sigma = 1.0
+chi = [
+  ["C", "W", 42.24],
+  ["G", "C", 10.47],
+  ["N", "W", -3.77],
+  ["G", "W", 4.53],
+  ["N", "P", -9.34],
+  ["P", "G", 8.04],
+  ["N", "G", 1.97],
+  ["P", "C", 14.72],
+  ["P", "W", -1.51],
+  ["N", "C", 13.56],
+]
+
+[bonds]
+bonds = [
+  ["N", "P", 0.47, 1250.0],
+  ["P", "G", 0.47, 1250.0],
+  ["G", "G", 0.37, 1250.0],
+  ["G", "C", 0.47, 1250.0],
+  ["C", "C", 0.47, 1250.0],
+]
+angle_bonds = [
+  ["P", "G", "G", 120.0, 25.0],
+  ["P", "G", "C", 180.0, 25.0],
+  ["G", "C", "C", 180.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

A randomly mixed input structure/topology file +lipid_self_assembly.HDF5 with a few hundred lipids in a roughy +10 x 10 x 10nm box is available in the +HyMD-tutorial/lipid_self_assembly github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation

+
python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5
+
+
+

we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook lipid_self_assembly.ipynb.

+
+
+

1.8. Peptide in lipid bilayer

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true +

Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer.

+

The configuration file is available in the HyMD-tutorial/peptide github +repository (omitted here for brevity).

+

A pre-equilibrated input structure/topology file peptide.HDF5 with a +few hundred lipids in a roughy 20 x 20 x 20nm box is available in the +HyMD-tutorial/peptide github repository. Running the simulation

+
python3 -m hymd peptide.toml peptide.HDF5
+
+
+

we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook peptide.ipynb.

+
+
+

1.9. SDS

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true +

The last part we introduce is explicit electrostatic interactions through +particle–mesh Ewald. Enabling the electrostatic calculations is done via the +coulombtype keyword. "PIC_Spectral" is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the dielectric_const keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge.

+
+
sds.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 10
+n_steps = 3000
+n_print = 1500
+n_flush =
+time_step = 0.01
+box_size = [8.3, 8.3, 8.3]
+start_temperature = 298
+target_temperature = 298
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.1
+domain_decomposition = 10000
+cancel_com_momentum = true
+max_molecule_size = 5
+thermostat_coupling_groups = [
+  ["S", "C"],
+  ["W", "Na"],
+]
+dielectric_const = 45.0              # dielectric constant for the simulation medium
+coulombtype = "PIC_Spectral"         # particle in cloud, spectral method
+
+[field]
+mesh_size = [64, 64, 64]
+sigma = 0.5
+chi = [
+  ["S", "C",  13.50],
+  ["S", "Na",  0.00],
+  ["S", "W",  -3.60],
+  ["C", "Na", 13.50],
+  ["C", "W",  33.75],
+  ["W", "Na",  0.00],
+]
+
+[bonds]
+bonds = [
+  ["S",   "C",   0.50, 1250.0],
+  ["C",   "C",   0.50, 1250.0],
+]
+angle_bonds = [
+  ["S", "C", "C", 170.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

An input structure/topology file sds.HDF5 with a couple thousand +randomly dispersed SDS chains is available in the HyMD-tutorial/sds github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a /charge dataset. +Running the simulation with

+
python3 -m hymd sds.toml sds.HDF5
+
+
+

we observe the aggregation of the SDS into micellular structures—first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook sds.ipynb.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/doc_pages/filtering.html b/v1.0.8/doc_pages/filtering.html new file mode 100644 index 00000000..77753083 --- /dev/null +++ b/v1.0.8/doc_pages/filtering.html @@ -0,0 +1,301 @@ + + + + + + + 2. Filtering — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Filtering

+

The default grid-independent filter function used in HyMD is a Gaussian

+
+\[H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right]\]
+

with reciprocal space representation

+
+\[\hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right].\]
+

The coarse-graining parameter \(\sigma\) determines a length scale of +particle extent and is given as configuration file input by

+
sigma = 0.75
+
+
+
+

2.1. Implementing new filters

+

Implementing new filter functions is straightforward by hijacking +the setup method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/doc_pages/installation.html b/v1.0.8/doc_pages/installation.html new file mode 100644 index 00000000..827fb277 --- /dev/null +++ b/v1.0.8/doc_pages/installation.html @@ -0,0 +1,543 @@ + + + + + + + 1. Installation — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Installation

+
+

1.1. Dependencies

+
+

Note

+

HyMD requires Python ≥3.6. Python version 3.9 is most likely fine +to use, but HyMD is only regularly tested with Python3.8 at the moment.

+ +
+

Warning

+

MPI-enabled h5py may fail to build under Python3.10. In this case, a +fall-back to Python3.9 or lower may be necessary.

+ +

Installing non-Python dependencies may be done by

+
+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-openmpi-dev  # Install MPI-enabled HDF5
+sudo apt-get install -y pkg-config           # Install pkg-config, required for h5py install
+sudo apt-get install -y curl wget
+
+
+
+
+

Warning

+

There might be memory leaks when using HyMD with OpenMPI 4.1.1. +Therefore, using a newer version of OpenMPI is recommended. +See Issue #186 for more details.

+ +

Installing Python dependencies may be done by

+
+
python3 -m pip install --upgrade pip
+CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+python3 -m pip install mpi4py numpy cython
+
+
+
+
+

Warning

+

If MPI-enabled HDF5 and h5py can not be installed, limited support +for serial HDF5 is available. Note that having MPI-enabled file IO is +highly recommended, and simulation performance under serial HDF5 will +potentially be very low.

+

Example dependency install on Ubuntu (apt) using serial HDF5:

+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-serial-dev   # Install serial HDF5
+sudo apt-get install -y curl wget
+
+python3 -m pip install h5py mpi4py numpy cython
+
+
+

Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +--disable-mpio argument to HyMD, see Command line arguments. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial.

+ +
+
+

1.2. Installing HyMD

+

HyMD may be installed using pip by

+
python3 -m pip install hymd
+
+
+
+
+

1.3. Install in docker

+

A docker image with build essentials setup is available at dockerhub with tag +mortele/hymd,

+
docker pull mortele/hymd:latest
+docker run -it mortele/hymd
+/app$ python3 -m pip install hymd
+
+# Grab example input files
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5
+
+# Run simulation
+/app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose
+
+
+
+
+

1.4. Run interactively in Google Colaboratory

+

A Google Colaboratory jupyter notebook is setup here with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons.

+
+
+

1.5. Common issues

+
+

1.5.1. Numpy errors while importing the Fortran force kernels

+
RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd
+
+Traceback (most recent call last):
+
+  (...)
+
+File "/..../HyMD/hymd/__init__.py", line 2, in <module>
+  from .main import main  # noqa: F401
+File "/..../HyMD/hymd/main.py", line 10, in <module>
+  from .configure_runtime import configure_runtime
+File "/..../hymd/configure_runtime.py", line 12, in <module>
+  from .input_parser import read_config_toml, parse_config_toml
+File "/..../HyMD/hymd/input_parser.py", line 12, in <module>
+  from .force import Bond, Angle, Dihedral, Chi
+File "/..../HyMD/hymd/force.py", line 8, in <module>
+  from force_kernels import (  # noqa: F401
+ImportError: numpy.core.multiarray failed to import
+
+
+

can normally be fixed by updating numpy versions,

+
python3 -m pip install -U numpy
+
+
+
+
+

1.5.2. Error building pfft-python due to missing curl/wget

+
Building wheel for pfft-python (setup.py) ... error
+ERROR: Command errored out with exit status 1:
+command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_
+cwd: /tmp/pip-install-fr6nt9m4/pfft-python/
+Complete output (56 lines):
+running bdist_wheel
+running build
+running build_py
+
+  (...)
+
+curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found
+wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found
+Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+Please check curl or wget
+You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/
+Traceback (most recent call last):
+  File "<string>", line 1, in <module>
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in <module>
+    setup(
+  File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup
+    return distutils.core.setup(**attrs)
+  File "/usr/lib/python3.8/distutils/core.py", line 148, in setup
+
+  (...)
+
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions
+    build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:]))
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft
+    raise ValueError("could not build fftw; check MPICC?")
+ValueError: could not build fftw; check MPICC?
+----------------------------------------
+ERROR: Failed building wheel for pfft-python
+Running setup.py clean for pfft-python
+Failed to build pfft-python
+
+
+

can be fixed by installing either curl or wget

+
apt-get install -y curl wget
+
+
+
+
+

1.5.3. Error running parallel HyMD without MPI-enabled h5py

+
Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    main()
+  File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    raise ValueError("h5py was built without MPI support, can't use mpio driver")
+ValueError: h5py was built without MPI support, can't use mpio driver
+
+
+

Can be fixed by installing a MPI-enabled h5py through

+
python3 -m pip uninstall -y h5py
+HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/doc_pages/interaction_energy_functionals.html b/v1.0.8/doc_pages/interaction_energy_functionals.html new file mode 100644 index 00000000..37b9deac --- /dev/null +++ b/v1.0.8/doc_pages/interaction_energy_functionals.html @@ -0,0 +1,354 @@ + + + + + + + 1. Interaction energy functionals — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Interaction energy functionals

+

A few interaction energy functionals \(W\) are defined in HyMD through +the Hamiltonian class and associated subclasses.

+
+

1.1. \(\chi\)–interaction and \(\kappa\)–incompressibility

+

The most common hPF energy functional is specified by

+
hamiltonian = "DefaultWithChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where \(\tilde\chi_{\text{A}-\text{B}}\) is the interaction energy between +overlapping densities of particle types \(\text{A}\) and \(\text{B}\). +The incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\tilde\chi\) +and \(\kappa\) in the configuration file (see Configuration file)

+
kappa = 0.05
+chi = [
+   ["A", "B", 15.85],
+   ["B", "C", -5.70],
+   ...
+]
+
+
+
+
+

1.2. Only \(\kappa\)–incompressibility

+

The only \(\kappa\) interactions energy functional is specified by

+
hamiltonian = "DefaultNoChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where the incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.3. Only \(\phi^2\)

+

The \(\phi^2\) interactions energy functional is specified by

+
hamiltonian = "SquaredPhi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2,\]
+

where the \(\phi\) squared term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.4. Implementing new interaction energy forms

+

Implementing new interaction energy functions is straightforward by subclassing +Hamiltonian and applying sympy differentiation to the symbolic +field objects. The sympy.lamdify function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/doc_pages/intramolecular_bonds.html b/v1.0.8/doc_pages/intramolecular_bonds.html new file mode 100644 index 00000000..c7514c49 --- /dev/null +++ b/v1.0.8/doc_pages/intramolecular_bonds.html @@ -0,0 +1,394 @@ + + + + + + + 2. Intramolecular bonds — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Intramolecular bonds

+

Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see Configuration file. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +Benchmarks), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable.

+

All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]).

+
+

2.1. Two-particle bonds

+

Stretching bonds in HyMD are implemented as harmonic spring potentials,

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2,\]
+

where \(r=|\mathbf{r}|\) is the inter-particle distance, \(k\) is a +constant of dimension energy (units \(\text{kJ}\,\text{mol}^{-1}\)), and +\(r_0\) is the equilibrum length of the bond (units: \(\text{nm}\)). The +force is calculated as

+
+\[F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r},\]
+

where \(\mathbf{r}\) is the vector pointing from \(i\) to \(j\).

+

In the configuration file, two-particle bonds are specified per particle type:

+
+
configuration_two_particle_example.toml
+
[bonds]
+bonds = [
+   ["A", "A", 0.47, 1250.0],
+   ["A", "B", 0.37,  940.0],
+   ["B", "C", 0.50, 1010.0],
+   ["C", "A", 0.42,  550.0],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.2. Three-particle bonds

+

Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle–particle–particle angle \(\theta\),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2,\]
+

where \(k\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\)), and \(\theta_0\) is the equilibrum +angle of the bond (units: \({}^\circ\)). Defining the particles with labels +\(a\), \(b\), and \(c\), let \(\mathbf{r}_a\) denote the vector +pointing from \(b\) to \(a\), and correspondingly let +\(\mathbf{r}_c\) point from \(b\) to \(c\). The +\(a\)\(b\)\(c\) may be computed through the law of Cosines,

+
+\[\theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right]\]
+

Then the force acting on \(a\) and \(c\) is

+
+\[ \begin{align}\begin{aligned}\mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a},\\\mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c},\end{aligned}\end{align} \]
+

and

+
+\[\mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c\]
+

In the configuration file, three-particle bonds are specified per particle type:

+
+
configuration_three_particle_example.toml
+
[bonds]
+angle_bonds = [
+   ["A", "A", "A", 180.0, 90.0],
+   ["A", "B", "A", 120.0, 55.0],
+   ["B", "C", "C",  30.0, 10.0],
+   ["C", "A", "B", 110.0, 25.5],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.3. Four-particle bonds

+

Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle \(\phi\) between the +\(a\)\(b\)\(c\) and \(b\)\(c\)\(d\) planes, for +a dihedral bond quartet \(a\), \(b\), \(c\), and \(d\). The +potential takes the form

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n),\]
+

where \(c_n\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)), and \(\phi_n\) are +specified phase angles in the cosine series.

+

In the configuration file, four-particle bonds are specified per particle type:

+
+
configuration_four_particle_example.toml
+
[bonds]
+dihedrals = [
+   ["A", "B", "C", "D"],
+   [
+     [-1],
+     [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+     [0.08, 0.46, 1.65, -0.96, 0.38],
+   ],
+   [1.0],
+]
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/doc_pages/overview.html b/v1.0.8/doc_pages/overview.html new file mode 100644 index 00000000..989a5295 --- /dev/null +++ b/v1.0.8/doc_pages/overview.html @@ -0,0 +1,415 @@ + + + + + + + 2. Usage overview for HylleraasMD — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Usage overview for HylleraasMD

+

HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a toml format configuration file, along with a topology and structure +file specifying the input system in HDF5 format.

+

Configuration file

+

The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a [5, 5, 5] nm simulation box at 300 K may look like +the following:

+
+
config_simple_1.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "SquaredPhi"         # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [30, 30, 30]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+
+
+
+

Note that for the version 1.0 release of HyMD, the [particles], +[simulation], and [field] groups are optional specifiers for +structuring the configuration file.

+

For a full specification of every recognised configuration keyword in HyMD, +please refer to Configuration file.

+

Topology and structure file

+

The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +N particles may look like the following:

+
+
example_structure.HDF5
+
group   /
+   # root group
+
+dataset /coordinates
+   # float32, shape (T, N, D,)
+   # Time steps of N rows of D dimensional coordinate data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /velocities
+   # float32, shape (T, N, D,) OPTIONAL
+   # Time steps of N rows of D dimensional velocity data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /bonds
+   # int32,   shape (N, B,)    OPTIONAL
+   # Each row i contains indices of the particles bonds from/to i
+   # B denotes the maximum bonds per particle
+
+dataset /indices
+   # int32,   shape (N,)
+   # Index of each particle, 0--(N-1)
+
+dataset /molecules
+   # int32,   shape (N,)
+   # Index of molecule each particle belongs to
+   # Used to construct bond network locally on MPI ranks
+
+dataset /names
+   # str10,   shape (N,)
+   # Fixed size string array containing particle type names
+
+dataset /types
+   # int32,   shape (N,)       OPTIONAL
+   # Mapping of particle names to type indices
+
+
+
+

For a full specification of the topology and structure input file, see +Topology and structure file.

+

Command line arguments

+

A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the config_simple_1.toml and example_structure.HDF5 +files may look like the following:

+
mpirun -n ${MPI_NUM_RANKS} python3 -m hymd         \  # HyMD executable
+                           config_simple_1.toml    \  # configuration file
+                           example_structure.HDF5  \  # structure file
+                           --logfile=log_out.txt   \  # set logfile path
+                           --seed 123456           \  # set random seed
+                           --verbose 2             \  # set logging verbosity
+                           --velocity-output          # enable velocity in trajectory output
+
+
+

For a full specification of all command line arguments, see +Command line arguments.

+

More examples

+

For more thorough rundown and concrete usage examples, see +Examples.

+
+

2.1. Running parallel simulations

+

Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the only difference being how the python3 interpreter is +invoked. Prepending mpirun -n ${NPROCS} to the usual +python3 -m hymd runs the simulation with ${NPROCS} MPI ranks.

+

Inputting

+
mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field
+
+
+

sets up an example simulation of the HyMD-tutorial/ideal_gas system. For +more details about this system in particular, or other example simulations, see +the HyMD-tutorial repository.

+
+
+

2.2. Running tests

+

Run serial code tests by

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd
+cd hymd/
+python3 -m pip install pytest pytest-mpi
+python3 -m pytest
+
+
+

There is a small convenience script in hymd/ for running the MPI-enabled +tests,

+
chmod +x pytest-mpi
+./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/doc_pages/theory.html b/v1.0.8/doc_pages/theory.html new file mode 100644 index 00000000..eed4f710 --- /dev/null +++ b/v1.0.8/doc_pages/theory.html @@ -0,0 +1,357 @@ + + + + + + + 1. Theory — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Theory

+

Hybrid particle–field simulations switch out the ordinary particle–particle +Lennard-Jones interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle–field densities are +defined as

+
+\[\phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i),\]
+

where \(\mathbf{r}\) is a spatial coordinate, \(P\) is a window function +used to distribute particle number densities onto a computational grid, and +\(\mathbf{r}_i\) is the position of particle \(i\) (of total \(N\)). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of \(N\) particles in \(M\) molecules is

+
+\[\mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})]\]
+

with \(H_0\) being a standard intramolecular Hamiltonian form (see +Intramolecular bonds) including kinetic terms, while \(W\) is a density +dependent interaction energy functional.

+

In the Hamiltonian hPF-MD formalism [Bore and Cascella, 2020], the density +field is filtered using a grid-independent filtering function \(H\),

+
+\[\tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}).\]
+

The filter smooths the density, ensuring that \(\tilde\phi\) and +\(W[\tilde\phi([\phi])]\) both converge as the grid size is reduced.

+
+

1.1. External potential

+

The external potential acting on a particle is defined as the functional +derivative of \(W\) with respect to \(\phi\). In the filtered formalism, +the potential takes the form

+
+\[\begin{split}V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ +&= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})},\end{split}\]
+

under the assumption of a local form of the interaction energy functional, +\(W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]\). Note +that

+
+\[\frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}).\]
+
+
+

1.2. Force interpolation

+

The forces on particle \(i\) are obtained by differentiation of the external +potential,

+
+\[\mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i).\]
+
+
+

1.3. Reciprocal space calculations

+

The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density \(\phi_{ijk}\) with CIC, we apply the filtering +and obtain the discrete version of the external potential by

+
+\[\tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big]\]
+

and

+
+\[V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+

The forces are obtained by differentiation of \(V\) in Fourier space as

+
+\[\nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+
+
+

1.4. Filter

+

By default, the filter used in HyMD is a simple Gaussian of the form

+
+\[\begin{split}H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ +\hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right].\end{split}\]
+

For more details about the filtering, see Filtering.

+
+
+

1.5. Hamiltonian form

+

The default form of the interaction energy functional in HyMD is

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2.\]
+

See Interaction energy functionals for details.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/doc_pages/topology_input.html b/v1.0.8/doc_pages/topology_input.html new file mode 100644 index 00000000..c62466ec --- /dev/null +++ b/v1.0.8/doc_pages/topology_input.html @@ -0,0 +1,338 @@ + + + + + + + 4. Topology and structure file — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Topology and structure file

+

The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root / group.

+

The HyMD-tutorial has multiple examples of structure files for various levels +of complexity.

+
+

4.1. Required datasets

+
+
/coordinates:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/indices:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/names:
+

array shape [N,]

+

datatype [string (length between 1 and 16)]

+

The shape represents one particle name per N particles. The datatype may be a string of length =<16.

+
+
+
+
+

4.2. Optional datasets

+
+
/velocities:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/types:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle type index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/molecules:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one molecule index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/bonds:
+

array shape [N, B,]

+

datatype [int32 or int64]

+

The shape represents B bond specifications (indices of different particles) per N particles. The data type may be either 32 or 64 bit integers.

+
+
/charge:
+

array shape [N,]

+

datatype [float32 or float64]

+

The shape represents one particle charge per N particles. The data type may be either four or eight byte reals.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/genindex.html b/v1.0.8/genindex.html new file mode 100644 index 00000000..5f289a17 --- /dev/null +++ b/v1.0.8/genindex.html @@ -0,0 +1,816 @@ + + + + + + Index — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + +
+ +

F

+ + + +
+ +

G

+ + +
+ +

H

+ + + +
    +
  • + hymd.input_parser + +
  • +
  • + hymd.integrator + +
  • +
  • + hymd.thermostat + +
  • +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/index.html b/v1.0.8/index.html new file mode 100644 index 00000000..4b7f1fcb --- /dev/null +++ b/v1.0.8/index.html @@ -0,0 +1,402 @@ + + + + + + + HylleraasMD documentation — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

HylleraasMD documentation

+
+
Release:
+

1.0.8

+
+
Date:
+

Sep 28, 2022

+
+
+

HylleraasMD (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems.

+

HyMD can run canonical hPF-MD simulations [Milano and Kawakatsu, 2009], or filtered +density Hamiltonian hPF (HhPF-MD) simulations [Bore and Cascella, 2020], with +or without explicit PME electrostatic interactions [Kolli et al., 2018]. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +[Bore et al., 2018, Cascella et al., 2008]. Martini +style elastic networks (ElNeDyn) [Periole et al., 2009] are also +supported.

+

HyMD uses the pmesh (github.com/rainwoodman/pmesh) library for particle-mesh +operations, with the PPFT [Pippig, 2013] backend for FFTs through the +pfft-python bindings (github.com/rainwoodman/pfft-python). File IO is done +via HDF5 formats to allow MPI parallel reads.

+
+

User Guide

+

The HylleraasMD User Guide provides comprehensive information on how to run +simulations. Selected Examples are available to guide new users.

+
+
+

Installing HyMD

+

The easiest approach is to install using pip:

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+

For more information and required dependencies, see +Installation.

+
+

Run in Google colab

+

Run HyMD interactively in Google Colaboratory jupyter notebook here.

+
+
+
+

Source Code

+

Source code is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the GNU Lesser General Public +License v3.0. Obtain the source code with git:

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git
+
+
+
+
+

Development

+

HyMD is developed and maintained by researchers at the Hylleraas Centre for +Quantum Molecular Sciences at the University of Oslo.

+

pic1 pic2

+
+
+

References

+
+
+[BC20] +

Sigbjørn Løland Bore and Michele Cascella. Hamiltonian and alias-free hybrid particle–field molecular dynamics. J. Chem. Phys., 153(9):094106, 2020. doi:10.1063/5.0020733.

+
+
+[BMC18] +

Sigbjørn Løland Bore, Giuseppe Milano, and Michele Cascella. Hybrid particle-field model for conformational dynamics of peptide chains. J. Chem. Theory Comput., 14(2):1120–1130, 2018. doi:10.1021/acs.jctc.7b01160.

+
+
+[BDP07] +

Giovanni Bussi, Davide Donadio, and Michele Parrinello. Canonical sampling through velocity rescaling. J. Chem. Phys., 126(1):014101, 2007. doi:10.1063/1.2408420.

+
+
+[CNCDP08] +

Michele Cascella, Marilisa A. Neri, Paolo Carloni, and Matteo Dal Peraro. Topologically based multipolar reconstruction of electrostatic interactions in multiscale simulations of proteins. J. Chem. Theory Comput., 4(8):1378–1385, 2008. doi:10.1021/ct800122x.

+
+
+[KDNB+18] +

Hima Bindu Kolli, Antonio De Nicola, Sigbjørn Løland Bore, Ken Schäfer, Gregor Diezemann, Jürgen Gauss, Toshihiro Kawakatsu, Zhong-Yuan Lu, You-Liang Zhu, Giuseppe Milano, and Michele Cascella. Hybrid particle-field molecular dynamics simulations of charged amphiphiles in an aqueous environment. J. Chem. Theory Comput., 14(9):4928–4937, 2018. doi:10.26434/chemrxiv.6264644.v1.

+
+
+[LBC20] +

Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Automated determination of hybrid particle-field parameters by machine learning. Mol. Phys., 118(19-20):e1785571, 2020. doi:10.1080/00268976.2020.1785571.

+
+
+[MK09] +

Giuseppe Milano and Toshihiro Kawakatsu. Hybrid particle-field molecular dynamics simulations for dense polymer systems. J. Chem. Phys., 130(21):214106, 2009. doi:10.1063/1.3142103.

+
+
+[PCMC09] +

Xavier Periole, Marco Cavalli, Siewert-Jan Marrink, and Marco A Ceruso. Combining an elastic network with a coarse-grained molecular force field: structure, dynamics, and intermolecular recognition. Journal of chemical theory and computation, 5(9):2531–2543, 2009. doi:10.1021/ct9002114.

+
+
+[Pip13] +

Michael Pippig. Pfft: an extension of fftw to massively parallel architectures. SIAM J. Sci. Comput., 35(3):C213–C236, 2013. doi:10.1137/120885887.

+
+
+[TBM92] +

MBBJM Tuckerman, Bruce J Berne, and Glenn J Martyna. Reversible multiple time scale molecular dynamics. J. Chem. Phys., 97(3):1990–2001, 1992. doi:10.1063/1.463137.

+
+
+
+
+
+

Indices and tables

+ +
+
+
+
+
+
+
+
+
+ + + +
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+ + + + + +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/objects.inv b/v1.0.8/objects.inv new file mode 100644 index 00000000..5ef123e5 Binary files /dev/null and b/v1.0.8/objects.inv differ diff --git a/v1.0.8/py-modindex.html b/v1.0.8/py-modindex.html new file mode 100644 index 00000000..222dfdca --- /dev/null +++ b/v1.0.8/py-modindex.html @@ -0,0 +1,324 @@ + + + + + + Python Module Index — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ h +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ h
+ hymd +
    + hymd.field +
    + hymd.file_io +
    + hymd.force +
    + hymd.input_parser +
    + hymd.integrator +
    + hymd.thermostat +
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.8/search.html b/v1.0.8/search.html new file mode 100644 index 00000000..bcab8692 --- /dev/null +++ b/v1.0.8/search.html @@ -0,0 +1,294 @@ + + + + + + Search — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.8 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v1.0.8/searchindex.js b/v1.0.8/searchindex.js new file mode 100644 index 00000000..b503fb1f --- /dev/null +++ b/v1.0.8/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["doc_pages/api","doc_pages/benchmarks","doc_pages/command_line","doc_pages/config_file","doc_pages/constants_and_units","doc_pages/electrostatics","doc_pages/examples","doc_pages/filtering","doc_pages/installation","doc_pages/interaction_energy_functionals","doc_pages/intramolecular_bonds","doc_pages/overview","doc_pages/theory","doc_pages/topology_input","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,"sphinxcontrib.bibtex":9,sphinx:56},filenames:["doc_pages/api.rst","doc_pages/benchmarks.rst","doc_pages/command_line.rst","doc_pages/config_file.rst","doc_pages/constants_and_units.rst","doc_pages/electrostatics.rst","doc_pages/examples.rst","doc_pages/filtering.rst","doc_pages/installation.rst","doc_pages/interaction_energy_functionals.rst","doc_pages/intramolecular_bonds.rst","doc_pages/overview.rst","doc_pages/theory.rst","doc_pages/topology_input.rst","index.rst"],objects:{"hymd.field":{compute_field_and_kinetic_energy:[0,1,1,""],compute_field_energy_q_GPE:[0,1,1,""],compute_field_force:[0,1,1,""],compute_self_energy_q:[0,1,1,""],domain_decomposition:[0,1,1,""],initialize_pm:[0,1,1,""],update_field:[0,1,1,""],update_field_force_q:[0,1,1,""],update_field_force_q_GPE:[0,1,1,""]},"hymd.file_io":{OutDataset:[0,2,1,""],distribute_input:[0,1,1,""],setup_time_dependent_element:[0,1,1,""],store_data:[0,1,1,""],store_static:[0,1,1,""]},"hymd.file_io.OutDataset":{close_file:[0,3,1,""],flush:[0,3,1,""],is_open:[0,3,1,""]},"hymd.force":{Angle:[0,2,1,""],Bond:[0,2,1,""],Chi:[0,2,1,""],Dielectric_type:[0,2,1,""],Dihedral:[0,2,1,""],compute_angle_forces__plain:[0,1,1,""],compute_bond_forces__plain:[0,1,1,""],compute_dihedral_forces__plain:[0,1,1,""],dipole_forces_redistribution:[0,1,1,""],find_all_paths:[0,1,1,""],prepare_bonds:[0,1,1,""],prepare_bonds_old:[0,1,1,""],prepare_index_based_bonds:[0,1,1,""],propensity_potential_coeffs:[0,1,1,""]},"hymd.force.Angle":{atom_3:[0,4,1,""]},"hymd.force.Bond":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],equilibrium:[0,4,1,""],strength:[0,4,1,""]},"hymd.force.Chi":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],interaction_energy:[0,4,1,""]},"hymd.force.Dielectric_type":{atom_1:[0,4,1,""],dielectric_value:[0,4,1,""]},"hymd.force.Dihedral":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],atom_3:[0,4,1,""],atom_4:[0,4,1,""],coeffs:[0,4,1,""],dih_type:[0,4,1,""]},"hymd.hamiltonian":{DefaultNoChi:[0,2,1,""],DefaultWithChi:[0,2,1,""],Hamiltonian:[0,2,1,""],SquaredPhi:[0,2,1,""]},"hymd.hamiltonian.DefaultNoChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.DefaultWithChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.Hamiltonian":{__init__:[0,3,1,""],_setup:[0,3,1,""]},"hymd.hamiltonian.SquaredPhi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.input_parser":{Config:[0,2,1,""],check_NPT_conditions:[0,1,1,""],check_angles:[0,1,1,""],check_bonds:[0,1,1,""],check_box_size:[0,1,1,""],check_cancel_com_momentum:[0,1,1,""],check_charges:[0,1,1,""],check_charges_types_list:[0,1,1,""],check_chi:[0,1,1,""],check_config:[0,1,1,""],check_dielectric:[0,1,1,""],check_dihedrals:[0,1,1,""],check_domain_decomposition:[0,1,1,""],check_hamiltonian:[0,1,1,""],check_integrator:[0,1,1,""],check_m:[0,1,1,""],check_mass:[0,1,1,""],check_max_molecule_size:[0,1,1,""],check_n_b:[0,1,1,""],check_n_flush:[0,1,1,""],check_n_particles:[0,1,1,""],check_n_print:[0,1,1,""],check_name:[0,1,1,""],check_start_and_target_temperature:[0,1,1,""],check_tau:[0,1,1,""],check_thermostat_coupling_groups:[0,1,1,""],parse_config_toml:[0,1,1,""],read_config_toml:[0,1,1,""],sort_dielectric_by_type_id:[0,1,1,""]},"hymd.input_parser.Config":{a:[0,4,1,""],angle_bonds:[0,4,1,""],barostat:[0,4,1,""],barostat_type:[0,4,1,""],bonds:[0,4,1,""],box_size:[0,4,1,""],cancel_com_momentum:[0,4,1,""],chi:[0,4,1,""],conv_crit:[0,4,1,""],convergence_type:[0,4,1,""],coulomb_constant:[0,4,1,""],coulombtype:[0,4,1,""],dielectric_const:[0,4,1,""],dielectric_type:[0,4,1,""],dihedrals:[0,4,1,""],domain_decomposition:[0,4,1,""],dtype:[0,4,1,""],file_name:[0,4,1,""],gas_constant:[0,4,1,""],hamiltonian:[0,4,1,""],initial_energy:[0,4,1,""],integrator:[0,4,1,""],kappa:[0,4,1,""],m:[0,4,1,""],mass:[0,4,1,""],max_molecule_size:[0,4,1,""],mesh_size:[0,4,1,""],n_b:[0,4,1,""],n_flush:[0,4,1,""],n_particles:[0,4,1,""],n_print:[0,4,1,""],n_steps:[0,4,1,""],name:[0,4,1,""],pol_mixing:[0,4,1,""],pressure:[0,4,1,""],respa_inner:[0,4,1,""],rho0:[0,4,1,""],self_energy:[0,4,1,""],sigma:[0,4,1,""],start_temperature:[0,4,1,""],tags:[0,4,1,""],target_pressure:[0,4,1,""],target_temperature:[0,4,1,""],tau:[0,4,1,""],tau_p:[0,4,1,""],thermostat_coupling_groups:[0,4,1,""],thermostat_work:[0,4,1,""],time_step:[0,4,1,""],type_charges:[0,4,1,""]},"hymd.integrator":{integrate_position:[0,1,1,""],integrate_velocity:[0,1,1,""]},"hymd.logger":{Logger:[0,2,1,""],MPIFilterAll:[0,2,1,""],MPIFilterRoot:[0,2,1,""]},"hymd.logger.Logger":{setup:[0,3,1,""]},"hymd.logger.MPIFilterAll":{filter:[0,3,1,""]},"hymd.logger.MPIFilterRoot":{filter:[0,3,1,""]},"hymd.thermostat":{_random_chi_squared:[0,1,1,""],_random_gaussian:[0,1,1,""],csvr_thermostat:[0,1,1,""]},hymd:{field:[0,0,0,"-"],file_io:[0,0,0,"-"],force:[0,0,0,"-"],input_parser:[0,0,0,"-"],integrator:[0,0,0,"-"],thermostat:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0020733":14,"00268976":14,"0083144621":0,"01036426965":4,"014101":[0,14],"02214076":4,"03642696562":4,"03970":6,"08790868":[6,10],"094106":14,"0xd":8,"0xe":8,"100":[4,6,11],"1000":6,"10000":6,"10001":6,"1010":10,"1021":14,"1063":14,"1080":14,"10nm":6,"110":10,"1120":[0,14],"1130":[0,14],"1137":14,"118":14,"120":[3,6,10],"120885887":14,"120ff":0,"123456":11,"1250":[3,6,10],"126":[0,14],"130":14,"1378":14,"138":[0,4],"1385":14,"144":8,"148":8,"1500":6,"153":14,"166":8,"170":6,"1785571":14,"179":0,"180":[3,6,10],"186":8,"197":8,"1974":0,"1981":0,"1990":14,"1992":[3,14],"200":[6,10],"2000":6,"2001":14,"2007":[0,3,14],"2008":[0,14],"2009":14,"201":[0,3],"2013":14,"2018":[0,14],"2020":[5,6,12,14],"2022":14,"20nm":6,"214106":14,"223":0,"224":1,"2408420":14,"2408724":[6,10],"246":0,"251":[6,10],"2531":14,"2543":14,"26434":14,"28103735":0,"298":6,"2_1":0,"2don2d":8,"2nd":0,"300":[6,11],"3000":6,"3142103":14,"3144621":4,"323":6,"449":[6,10],"463137":14,"48626121":[6,10],"4928":14,"4937":14,"502":8,"533":1,"544":[6,10],"550":10,"59427866":[6,10],"602176634":4,"610":[6,10],"6264644":14,"66053906660":4,"7b01160":14,"85418781281":4,"935458":[0,4],"940":10,"96924":6,"980":3,"9918564":[6,10],"boolean":3,"byte":13,"case":[0,3,6,8,10],"class":[0,9],"default":[0,3,7,11,12,13],"export":8,"float":[0,3],"function":[0,3,5,6,7,11,12],"int":[0,5,6,9,12],"long":[5,6],"new":[0,10,13,14],"public":14,"return":[0,8],"short":[6,11],"sigbj\u00e3":14,"static":0,"switch":12,"true":[0,3,6],"while":[0,12],Adding:6,For:[0,11,12,14],The:[0,3,5,6,7,8,9,10,11,12,13,14],Then:10,There:[8,11],These:0,Used:[0,3,11],Using:[6,9],With:[0,6],__file__:8,__init__:[0,8],__main__:8,_gener:0,_hl:8,_kwarg:8,_random_chi_squar:0,_random_gaussian:0,_run_cod:8,_run_module_as_main:8,_set_fapl_mpio:8,_setup:0,about:[3,11,12],abov:[0,6],absent:0,acceler:0,accompani:6,accord:[0,3],accur:14,acid:6,across:[0,3],acs:14,act:[0,10,12],adapt:0,add:[5,6],added:0,adding:6,addison:0,addit:[0,2,5,11],addition:14,additon:0,adher:0,affect:0,affili:[0,2],after:[0,10,12],against:8,aggreg:6,ahren:0,alanin:6,algorithm:[0,3,12],alia:14,all:[0,2,3,4,6,8,10,11,14],all_nam:0,all_rank:0,alloc:0,allow:[11,14],allreduc:0,along:[6,11],alpha3:8,alpha:0,also:[6,8,14],altern:2,alwai:[0,3],amino:6,amphiphil:14,analyt:0,angl:[0,2,3,6,8,10],angle_bond:[0,3,6,10],angular:[0,3,6,10],ani:[0,2,3],anisotrop:0,antonio:14,apart:0,api:8,app:8,appli:[0,3,7,9,12],applic:0,approach:14,approxim:0,apt:8,aqueou:14,architectur:14,arg:[0,8],argument:[0,6,8,11],argv:8,aris:0,around:10,arrai:[0,3,11,13],arriv:6,art:0,aspect:3,assess:0,assign:[0,3,10],associ:[0,9],assum:3,assumpt:12,atom:0,atom_1:0,atom_2:0,atom_3:0,atom_4:0,attach:13,attempt:0,attr:8,attract:3,attribut:0,autom:14,automat:[0,7,8,9],avail:[6,8,14],averag:[0,9],avogadro:4,back:[0,5,8],backbon:[0,2,3,14],backcon:0,backend:14,backmap:0,balanc:0,ballist:6,bar:4,barostat:0,barostat_typ:0,base:[0,14],bath:[0,3],bb_index:0,bc20:14,bdist_wheel:8,bdp07:14,bead:0,becaus:0,becom:0,befor:[0,3,6,8],being:[0,2,3,5,10,11,12],belong:11,below:6,benchmark:10,bend:[0,3,10,14],bern:14,besid:2,best:0,beta:0,better:0,between:[0,3,5,6,9,10,12,13],bia:0,big:12,bin:8,binari:8,bind:14,bindu:14,bio:14,bit:[0,13],blueprint:0,bmc18:14,boltzmann:[0,3,4],bond2_energi:0,bond3_energi:0,bond4_energi:0,bond:[0,2,6,8,11,12,13],bonds_2:0,bonds_2_atom1:0,bonds_2_atom2:0,bonds_2_atom_1:0,bonds_2_atom_2:0,bonds_2_equilibrium:0,bonds_2_strength:0,bonds_3:0,bonds_3_atom_1:0,bonds_3_atom_2:0,bonds_3_atom_3:0,bonds_3_equilibrium:0,bonds_3_strength:0,bonds_4:0,bonds_4_atom_1:0,bonds_4_atom_2:0,bonds_4_atom_3:0,bonds_4_atom_4:0,bonds_4_coeff:0,bonds_4_last:0,bonds_4_typ:0,bool:0,bootstrap:8,bore:[0,5,12,14],both:[0,12],boundari:[0,3],box:[0,3,6,11],box_siz:[0,3,6,11],breviti:6,brew:8,broadcast:0,browser:8,bruce:14,buffer:[0,3],build_extens:8,build_pfft:8,build_pi:8,built:8,bussi:[0,3,14],c213:14,c236:14,c_n:[0,6,10],calcul:[0,3,6,10],calibr:0,call:[0,8],callabl:0,can:[6,8,14],cancel_com_momentum:[0,3,6],canon:[0,3,14],capabl:2,captur:11,carloni:14,carri:6,cascella:[5,8,11,12,14],caval:14,cbt:0,cdot10:4,cdot:[0,4,10],cell:[0,12],cellar:8,center:[0,3],centr:14,certain:[0,2],ceruso:14,chain:[0,14],chang:[0,3],changedin:0,charg:[0,3,4,5,6,13,14],charge_out:0,check:[0,8],check_angl:0,check_bond:0,check_box_s:0,check_cancel_com_momentum:0,check_charg:0,check_charges_types_list:0,check_chi:0,check_config:0,check_dielectr:0,check_dihedr:0,check_domain_decomposit:0,check_hamiltonian:0,check_integr:0,check_m:0,check_mass:0,check_max_molecule_s:0,check_n_b:0,check_n_flush:0,check_n_particl:0,check_n_print:0,check_nam:0,check_npt_condit:0,check_start_and_target_temperatur:0,check_tau:0,check_thermostat_coupling_group:0,chem:[0,14],chemic:14,chemrxiv:14,chi:[0,3,4,6,8],chi_2:0,chi_3:0,chi_:[0,3,6,9,12],chi_m:0,chmod:11,chosen:0,cic:[0,5,12],circ:[3,10],circumv:12,classmethod:0,classvar:0,clean:[0,8],clone:[8,11,14],close:[0,8],close_fil:0,closest:0,cloud:[0,6,12],cncdp08:14,coars:[0,3,7,14],code:[0,1,2,3,6,8,11],coeff:0,coeffici:0,coil:[0,6],colab:8,colaboratori:14,collect:[0,13],com:[0,8,11,14],combin:[0,6,14],comm:0,comm_world:0,command:[8,11],common:9,commuic:0,commun:[0,3,10],communc:0,compar:6,compat:2,compil:[0,8],compiler_so:8,complesfield:0,complet:[0,6,8],complex:[6,13],complexfield:0,compon:0,comprehens:14,compress:[0,3,4,6,9,11],comput:[0,5,10,12,14],compute_angle_forces__plain:0,compute_bond_forces__plain:0,compute_dihedral_forces__plain:0,compute_field_and_kinetic_energi:0,compute_field_energy_q_gp:0,compute_field_forc:0,compute_potenti:0,compute_self_energy_q:0,concret:11,condit:6,config:[0,8],config_simple_1:11,configur:[0,2,5,6,7,8,9,10,11],configuration_four_particle_exampl:10,configuration_three_particle_exampl:10,configuration_two_particle_exampl:10,configure_runtim:8,conform:[6,13,14],connect:0,conserv:1,consid:6,consist:[0,6],consit:6,consitu:0,constant:[0,3,5,6,10],constitut:[0,2,3],construct:[0,10,11],constructor:0,contain:[0,1,2,3,6,11],content:[0,6],contribut:0,control:3,conv_crit:0,conv_fun:0,conveni:11,converg:[0,12],convergence_typ:0,convert:0,coordin:[11,12,13],copi:0,core:8,correct:[0,3],correspond:[0,3],correspondingli:10,cos:[0,6,10],cosin:[0,3,6,10],cost:[3,10],could:8,coulomb:[0,3,4,5],coulomb_const:0,coulombtyp:[0,3,5,6],counter:6,coupl:[0,3,6,11],cprofil:2,cpu:[0,10],crash:3,creat:[0,9],critic:[0,6],cross:0,csvr:[0,3],csvr_thermostat:0,ct800122x:14,ct9002114:14,current:6,cwd:8,cython:[8,14],d_n:0,dal:14,data:[0,6,11,13],dataclass:0,dataset:[0,5,6,11],datatyp:13,date:[0,14],date_format:0,david:14,debug:[0,2],decompos:0,decomposit:[0,3,10],default_level:0,defaultnochi:[0,6,9],defaultnohchi:[0,3],defaultwithchi:[0,3,6,9],defin:[0,6,9,10,12],definit:0,degre:3,delta:[0,12],denot:[0,1,3,9,10,11],dens:14,densiti:[0,3,5,9,12,14],depend:[0,6,10,12,14],deprec:0,deriv:[0,12],design:6,dest_directori:0,detail:[2,3,6,8,11,12],determin:[0,2,7,14],dev:8,devel:8,develop:[6,8],deviat:[0,3],dict:0,dictat:0,dictionari:0,dielectr:[0,3,6],dielectric_const:[0,3,5,6],dielectric_typ:0,dielectric_valu:0,dieter:0,diezemann:14,differ:[0,3,6,11,13],differenti:[0,5,7,9,12],difficult:2,dih_typ:0,dihedr:[0,2,3,5,6,8,10,14],dimens:[0,10,11,13],dimension:11,dipol:[0,2,3,5,6,14],dipole_forces_redistribut:0,direct:[0,3],directori:11,disabl:[2,6,8,11],disable_mpio:0,discard:0,discret:[0,12],discretis:12,disk:[0,3],dispers:6,dist:8,distanc:[0,3,10],distinct:0,distribut:[0,3,5,6,12],distribute_input:0,distutil:8,dnf:8,doc:0,dockerhub:8,dodecyl:6,doe:[0,10],doi:14,domain:[0,3,10],domain_decomposit:[0,3,6],donadio:[0,14],done:[0,6,8,14],dopc:6,dot:0,dot_elec:0,doubl:2,double_out:0,download:8,dppc:6,draw:0,drawn:0,driver:[8,11],dtype:0,due:[0,3],dump:0,dump_per_particl:0,dure:[0,2,3,10,11],dynam:[0,3,11,12,14],e1785571:14,e_k:0,each:[0,3,6,10,11],easiest:14,effect:[0,3],effici:10,eight:13,either:[0,3,8,13],elast:14,elec:0,elec_field:0,elec_field_contrib:0,elec_field_fouri:0,elec_forc:0,elecrostat:0,electr:[0,4,5],electrosat:0,electrostat:[0,6,14],elnedyn:14,elucid:6,embed:6,emit:0,emploi:0,empti:0,enabl:[2,6,11],enclos:0,end:0,energi:[0,1,3,4,6,7,10,11,12],energiesself:0,ensur:[0,3,6,8,12],ensurepip:8,entri:3,environ:14,epsilon:0,equal:[0,3,6],equat:0,equilibr:6,equilibrium:[0,3,6],equilibrum:10,equival:[0,3],error:0,essenti:[0,1,8],etc:[2,3],even:[0,3,6,8],event:0,everi:[0,3,6,10,11],evid:0,ewald:[0,5,6],examin:6,exampl:[3,8,11,13,14],example_structur:11,except:10,exchang:[0,3],exec:8,execut:[0,8,11],exist:0,exit:8,exp:[7,12],expand:0,expans:0,expect:0,expens:[3,12],explicit:[0,6,10,14],express:0,ext:0,extend:6,extens:14,extent:[0,7],extern:0,extract:[0,8],f401:8,f_angl:0,f_bond:0,f_dihedr:0,f_dipol:0,f_on_bead:0,factor:0,factori:0,fail:[0,8],fall:8,fals:[0,3,6],fapl:8,fashion:[0,3],fast:12,fedora:8,fer:14,few:[6,9,10,11],fft:[0,1,2,3,5,6,11,12,14],fftw3:8,fftw:[8,14],field:[2,4,5,6,9,11,12,14],field_energi:0,field_list:0,field_q_energi:0,field_q_self_energi:0,file:[2,5,6,7,8,9,10,11,14],file_io:0,file_nam:0,file_path:0,filter:[0,3,5,6,11,14],find:[0,8],find_all_path:0,fine:8,first:[0,3,6,11],five:0,fix:[0,8,11],flag:[0,13],flat:11,float32:[11,13],float64:13,flori:0,fluctuat:0,flush:[0,3],follow:[0,2,3,4,6,11],forc:[2,3,4,5,6,10,14],force_kernel:8,force_mesh:0,force_mesh_elec:0,force_mesh_elec_fouri:0,force_out:0,forego:2,form:[0,5,10],formal:[5,12],format:[0,2,3,5,11,13,14],formatt:0,fortran:[0,10],forward:0,found:[5,8],four:[0,2,3,6,13],fourier:[0,5,12],fr6nt9m4:8,frac:[0,5,6,7,9,10,12],frame:[0,11,13],framework:8,free:14,frequenc:[0,3],from:[0,2,3,5,6,8,9,10,11,14],full:[0,9,11],fulli:[0,6,8],fundament:11,gamma:0,gamma_0:0,gas:[0,4],gas_const:0,gather:0,gauss:14,gaussian:[0,3,7,12],gener:[0,2,3,6,14],get:8,getattr:8,ghost:0,giovanni:14,git:[8,11,14],github:[6,8,11,14],githubusercont:8,giusepp:14,given:[0,3,6,7],glenn:14,global:0,gnu:14,govern:9,gpe:0,grab:8,gradient:0,grain:[0,3,7,14],graph:0,gregor:14,grid:[0,1,3,5,6,7,11,12],group:[0,3,6,8,11,13,14],guess:0,gyrat:6,h5md:[0,3],h5py:[0,2],h_0:[6,12],half:0,hamiltonian:[3,5,6,7,9,11,14],handl:0,handler:0,happen:10,harmon:[0,3,6,10],has:[0,3,8,13],hat:[7,12],have:[0,6,8],hdf5:[0,2,3,5,6,8,11,13,14],hdf5_dir:8,hdf5_mpi:8,head:6,header:8,heat:[0,3],helic:[0,3,5,6],help:6,helper:0,here:[0,6,8,14],hhpf:14,highli:[8,10,11],hijack:7,hima:14,hire:1,homogen:0,homopolym:1,homopolypeptid:6,how:[3,11,14],howev:6,hpf:[3,5,9,11,12,14],html:0,http:[0,8,11,14],huggin:0,hundr:[6,10],hybrid:[11,12,14],hylleraa:14,hymd:[0,2,3,4,5,6,7,9,10,11,12,13],ideal:10,ideal_chain:[6,8],ideal_ga:[6,11],ident:0,ignor:0,ijk:[5,12],imag:8,impact:0,implement:[0,10],importerror:8,impuls:[0,3],in_fil:[0,8],inam:8,includ:[0,2,3,6,12,14],incompress:[0,3],increas:[0,2,6],indentifi:0,independ:[0,3,7,12],index:[0,11,13,14],indic:[0,2,3,10,11,13],indirect:0,individu:[0,3,6],induc:5,infer:10,info:[0,8],inform:[0,10,14],ingredi:6,initi:0,initial_energi:0,initialis:11,initialize_pm:0,inner:[0,3],input:[2,3,4,5,6,7,8,11,13],input_box:0,input_pars:[0,8],insid:[0,3,6],instal:[2,11],install_pfft:8,instantan:0,int32:[11,13],int64:13,integ:[0,3,6,13],integr:[3,6,11],integrate_posit:0,integrate_veloc:0,intend:8,inter:[0,10],interact:[0,2,3,4,6,7,11,12,14],interaction_energi:0,interfac:0,intergr:0,intermediari:0,intermolecular:[6,14],intern:[0,2,4,10],interpol:[0,5],interpret:11,interv:[0,3],intmathrm:0,intracomm:0,intramolecular:[0,3,6,12,14],intrins:5,introduc:6,investig:0,invok:[2,11],involv:[0,3,10],ion:6,ipynb:6,is_open:0,iter:0,j_k:0,jan:14,jctc:14,join:8,jone:12,journal:14,jupyt:[6,8,14],k_e:0,kappa:[0,3,4,6,11,12],kawakatsu:14,kdnb:14,keep:[0,3],kelvin:[0,3,6,11],ken:14,kernel:[0,10],keyword:[0,5,6,11],kinet:[0,12],kinetic_energi:0,knuth:0,kolli:14,kpa:4,kwd:8,label:[1,10],lambda:0,lamdifi:9,land:14,laplacian:0,larg:[8,11],larger:3,last:[6,8,11,13],last_bb:0,later:[0,6],latest:8,law:10,layout:0,layout_q:0,lbc20:14,leak:8,learn:14,leav:0,ledum:[6,14],left:[0,5,6,7,9,10,12],legend:1,lenght:0,length:[0,3,4,6,7,10,11,13],lennard:12,less:[0,6],lesser:14,let:[0,10],level:[0,2,3,13],liang:14,lib64:8,lib:8,libhdf5:8,libopenmpi:8,librari:[0,2,8,14],libtool:8,libver:8,licens:14,lieu:0,like:[0,6,8,11],limit:[3,8],line:[0,8,11],linear:[0,3],lipid_self_assembl:6,list:0,list_coulomb:0,load:0,local:[0,8,10,11,12],locat:8,log:[0,2,11],log_fil:0,log_out:11,logfil:[2,11],logger:2,logic:0,logrecord:0,look:[6,8,11],loop:0,lost:3,low:[6,8],lower:8,m_j:0,mac:8,machin:[2,14],made:0,mai:[0,2,3,6,8,10,11,13],main:[0,8,11],main_glob:8,maintain:14,make:[6,8],make_fapl:8,manner:6,manual:8,map:[0,11],marco:14,marilisa:14,marrink:14,martini:[6,14],martyna:14,mass:[0,3,4,13],massiv:14,match:0,math:0,mathbf:[0,4,5,6,9,10,12],mathcal:[6,12],mathmr:0,mathrm:[0,5,6,9,10,12],matteo:14,matter:[6,10,14],max_molecule_s:[0,3,6],maximum:[0,3,10,11],maxwel:[0,3],may:2,mbbjm:14,mean:[0,2,3],measur:10,medium:[0,3,6],melt:1,membran:6,memori:[0,8],mesh:[0,1,3,5,6,14],mesh_siz:[0,3,6,11],messag:0,messi:0,meta:6,metadata:0,method:[0,1,6,7],mh_0:12,micellular:6,michael:14,michel:14,might:[0,8],milano:14,mimic:0,minim:6,minuscul:10,mirror:2,mix:[0,6],mk09:14,model:[6,14],modifi:0,modul:[0,3,8,14],mol:[3,4,6,10,11,14],molecul:[0,3,11,12,13],molecular:[2,11,12,14],moment:8,momenta:[0,11],momentum:[0,3,4],monoatom:6,more:[2,3,6,8,11,12,14],mortel:8,morten:14,most:[8,9,11,12],mostli:2,motion:[0,6],move:0,mpi4pi:[0,8,14],mpi:[0,2,3,10,11,14],mpi_num_rank:11,mpicc:8,mpifilteral:0,mpifilterroot:0,mpio:[2,8],mpip:8,mpirun:11,multiarrai:8,multipl:[0,3,6,11,13,14],multipolar:14,multiscal:14,must:[0,3],n_b:0,n_flush:[0,3,6],n_frame:0,n_particl:[0,3],n_print:[0,3,6,11],n_step:[0,3,6,11],n_type:0,nabla:[0,12],name:[0,2,3,6,10,11,13],nanomet:[0,1],nanosecond:6,ndarrai:0,ne5et1y_:8,necessari:[0,6,8],necessit:[8,9],need:[0,6],neg:[0,6],neighbour:0,neri:14,network:[0,10,11,13,14],networkx:0,neutralis:6,never:[0,3],nevertheless:3,newer:8,next:[0,6],nicola:14,non:[0,2,6,8],none:[0,3,8],nongnu:0,noqa:8,normal:[0,2,3,8,12],notabl:11,note:[0,6,8,11,12],notebook:[6,8,14],now:6,nproc:11,npt:0,nq_i:5,number:[0,1,2,3,6,11,12,13],numer:0,numpi:[0,2,9,14],nvt:0,object:[0,9],oblat:6,observ:[0,6],obtain:[0,5,12,14],obviou:8,off:6,omit:6,onc:[3,10],one:[0,2,3,6,13],onli:[0,6,8,10,11],onto:[0,3,5,12],open:[0,8],openmpi:8,oper:[0,3,12,14],oppos:0,optim:[0,10],optimis:[6,10],option:[0,3,6,11],order:[0,3,6,10,11],ordinari:[5,12],org:0,organis:6,origin:0,oslo:14,osx:8,other:[0,11],otherwis:0,out:[8,12],outdataset:0,outer:0,output:[2,3,4,6,8,11],outsid:3,over:0,overlap:[0,9],packag:[8,11,14],page:14,paint:0,paolo:14,paper:0,parallel:[0,2,3,14],paramet:[0,3,6,7,9,14],parent_group:0,parllel:0,parrinello:[0,14],pars:[0,3],parse_config_toml:[0,8],part:[5,6,12],partial:0,particl:[0,2,5,6,7,9,11,12,13,14],particlemesh:0,particular:11,path:[0,2,8,11],pcmc09:14,pdf:1,pencil:0,peptid:[0,2,3,5,14],per:[0,2,3,10,11,13],peraro:14,perfect:0,perform:[0,3,8,10,11,12],periol:14,perman:[10,14],permitt:[0,4],pfft:[0,14],pfft_build_dir:8,phase:[0,10],phase_separ:6,phi:[0,3,6,10,12],phi_0:[6,9,12],phi_:[0,6,9,12],phi_ep:0,phi_eps_fouri:0,phi_eta:0,phi_eta_fouri:0,phi_fouri:0,phi_k:0,phi_l:0,phi_laplacian:0,phi_n:[6,10],phi_pol:0,phi_pol_prev:0,phi_q:0,phi_q_fouri:0,phi_transf:0,phospholipid:6,phy:[0,14],pic_spectr:[0,3,6],pic_spectral_gp:0,piec:6,pip13:14,pip3:8,pip:[8,11,14],pippig:14,pkg:8,place:[0,3],plain:2,plane:[0,6,10],pleas:[8,11],plist:8,plume:0,plumed_bia:0,plumed_out:0,pme:14,pmesh:[0,14],png:1,point:[0,1,10,13],poisson:0,pol_mix:0,polar:0,polym:[6,14],posit:[0,2,3,5,6,11,12],possibl:[0,3,6,14],potenti:[0,3,4,5,7,8,10,14],ppft:14,practic:10,pre:[0,6],precis:[1,2],prefer:3,prepar:0,prepare_bond:0,prepare_bonds_old:0,prepare_index_based_bond:0,prepend:[0,11],present:[0,2,3,6],preserv:3,pressur:[0,4],pretti:8,previou:0,previous:6,prior:[0,3],priovid:0,prng:0,prod_:0,profil:2,program:[0,11],project:5,promot:0,prop:0,propag:[0,3],propens:[0,3,5,6],propensity_potential_coeff:0,properti:3,protein:[0,14],provid:[0,2,3,11,13,14],psi:[0,4,5],psi_:5,psi_fouri:0,pull:8,put:6,pytest:11,python3:[6,8,11,14],python:[0,11,14],q_i:[0,5],q_j:0,quadrat:0,quanit:0,quantiti:[0,4],quantum:14,quartet:10,quess:0,r_0:[0,6,10],r_a:10,r_c:10,rad:[3,10],radial:6,radii:6,radiu:6,rainwoodman:[8,14],rais:[6,8],random:[0,2,11],random_chi_squar:0,random_gaussian:0,randomli:[0,3,6],rang:5,rank0:0,rank:[0,2,3,10,11],rank_rang:0,rankself:0,rare:10,raw:8,rdcc_nbyte:8,rdcc_nslot:8,rdcc_w0:8,read:[0,8,11,14],read_config_toml:[0,8],readout:0,real:13,realfield:0,realist:6,reappli:0,rearrang:0,reason:8,receiv:[0,3],recent:8,reciproc:[0,7],recognis:11,recognit:14,recommend:8,reconstruct:[0,2,5,6,10,14],record:0,recreat:14,recurs:0,redistribut:0,reduc:[3,12],refer:[3,11],regim:6,regul:[0,3],regularli:8,rel:[0,3,6,10],relax:[0,3],releas:[0,6,8,11,14],remain:[0,6],remov:[0,3],remove_center_of_mass_momentum:0,remove_com_momentum:[0,3],replac:[0,8],repositori:[6,11],repres:[0,3,13],represent:7,repuls:3,requir:[0,3,8,10,11,14],rescal:[0,3,14],research:14,respa:[0,3,6],respa_inn:[0,3,6],respect:[0,1,12],restructur:0,result:[0,3,6,9],revers:[0,3,14],rgen:14,rho0:0,rho:[0,5],rho_0:0,rho_:5,right:[0,5,6,7,9,10,12],rightarrow:10,root:[0,11,13],roughi:6,row:11,rrespa:[0,3,6],ruin:0,run:[0,2,3,6,10],run_glob:8,rundown:11,runpi:8,runtimeerror:8,same:[0,3,6],sampl:[0,3,14],scalar:0,scale:[0,3,6,7,8,10,11,14],sch:14,scheme:[0,6],sci:14,scienc:14,script:11,sds:6,search:14,second:[0,11],see:[0,2,3,5,6,8,9,10,11,12,14],seed:[2,11],select:[11,14],self:[0,3,8],self_energi:0,seminumer:0,send:[0,3],sep:14,separ:0,seri:[0,3,6,10],serial:[8,11],serialis:3,set:[0,3,11],set_fapl:8,setup:[0,6,7,8,13],setup_time_dependent_el:0,setuptool:8,sever:0,shape:[0,6,11,13],sheet:0,shift:0,should:[0,2,10],shown:6,siam:14,siewert:14,sigbj:14,sigma:[0,3,6,7,11,12],sim:0,similar:0,simpl:[0,6,11,12],simplest:6,simpli:0,simul:[0,2,6,8,10,12,13,14],simultan:0,sinc:0,singl:[0,3,6],site:8,size:[0,3,6,11,12],slight:0,slowli:12,small:[3,11],smear:5,smooth:[0,12],sodium:6,soft:[6,14],solv:0,solvent:6,some:[0,3,8],sort:0,sort_dielectric_by_type_id:0,sourc:[0,1],space:[0,3,5,7],span:0,spatial:[0,3,11,12],specfi:0,speci:0,special:0,specif:[0,2,3,6,9,10,11,13],specifi:[0,2,3,6,9,10,11,13],spectacularli:0,spectral:6,speed:[0,3],spheric:6,spheroid:6,split:0,spontan:6,spring:[0,10],sqrt:[0,7,12],squar:[0,9],squaredphi:[0,3,9,11],stabil:6,stabl:6,stackoverflow:0,standard:[0,3,12,14],start:[0,3,6,10,13],start_temperatur:[0,3,6],state:0,statu:8,stdout:[0,2],step:[0,3,6,10,11],stiff:3,stochast:0,store:0,store_data:0,store_stat:0,str10:11,str:0,straightforward:[7,9],stream:0,strength:[0,3,6,11],stretch:[0,3,10,14],string:[0,3,8,11,13],structur:[0,2,3,5,6,11,14],style:14,sub:6,subclass:[0,9],subsequ:[0,5,6,10],sudo:8,suitabl:0,sulfat:6,sum:0,sum_:[0,5,9,12],sum_i:0,sum_j:0,sum_k:0,sum_n:[0,6,10],summari:11,superclass:[0,7],support:[0,6,8,14],swap:10,symbol:[0,4,9],sympi:[0,9],sys:8,system:[0,1,2,3,6,9,11,12,14],tag:[0,3,8],take:[0,3,5,9,10,11,12],taken:0,tar:8,target:0,target_pressur:0,target_temperatur:[0,3,6,11],tau:[0,3,6,11],tau_p:0,tbm92:14,temperatur:[0,3,4,6,11],ten:6,term:[0,3,6,9,12],test:[0,1,8],text:[0,2,3,4,5,6,9,10,12],than:[0,3],theori:[0,14],therefor:8,thermalis:[0,3],thermostat:[2,3,6,11],thermostat_coupling_group:[0,3,6],thermostat_work:0,theta:[6,10],theta_0:[0,6,10],thi:[0,2,3,6,8,9,10,11,12],thorough:11,though:6,thousand:[6,10],three:[0,2,3,6],through:[0,3,6,7,8,9,10,14],tild:[0,3,4,5,6,9,12],time:[0,3,4,6,10,11,14],time_step:[0,3,6,11],tmp:8,todo:0,togeth:[0,3,6],token:8,toml:[0,2,3,6,8,10,11],toml_cont:0,tomli:0,too:3,toplog:0,topol:0,topolog:[0,2,3,5,6,11,14],torsion:[0,3,10,14],toshihiro:14,total:[0,3,6,11,12],traceback:8,trajectori:[0,2,3,6,11],trans_matric:0,transfer:[0,10],transform:[0,9,12],travers:0,tri:3,truncat:0,tuckerman:[3,14],turn:6,tutori:[6,8,11,13],two:[0,2,3,6],txt:11,type:[0,2,3,5,6,9,10,11,13],type_arrai:0,type_charg:0,type_to_name_map:0,ubuntu:8,uio:[8,11,14],unchang:0,under:[6,8,12,14],uninstal:8,union:0,uniqu:0,unique_nam:0,unit:[0,3,10],univers:14,unknown:0,unless:[0,3],unset:0,unstabl:3,until:6,updat:[0,8],update_field:0,update_field_force_q:0,update_field_force_q_gp:0,upgrad:[8,14],usag:[0,2],use:[0,3,5,6,8],used:[0,1,2,3,6,7,9,11,12,13],uses:[0,4,12,14],using:[0,2,3,8,12,14],usr:8,usual:11,v_2:[0,6,10],v_3:[0,6,10],v_4:[0,6,10],v_ext:0,v_ext_fouri:0,vacuum:4,valid:[0,3],validated_config:0,valu:[0,3,4,5,6,10],valueerror:8,vanish:0,varepsilon:0,varepsilon_0:[4,5],vari:12,variabl:0,variant:6,variou:[0,13],vbar_elec:0,vbar_elec_fouri:0,vector:10,vectoris:9,veloc:[0,2,3,4,6,11,13,14],velocity_out:0,velocti:0,verbos:[0,2,8,11],veri:[6,8,10],verifi:0,verlet:[0,3,6,11],versa:3,version:[0,6,8,11,12],vert:0,vertex:[0,5],vertic:0,via:[6,14],vice:3,vol:0,volum:0,voxel:0,wai:[8,12],warn:0,weakli:3,weight:0,well:6,were:0,weslei:0,wheel:8,when:[0,3,8,10],where:[0,5,9,10,12],which:[0,2,3,5,6,8,9,10,11],width:[0,3],window:[0,5,12],without:[0,14],work:[0,8],workload:0,would:[0,3],wrap:0,wrapper:0,write:[0,3],written:[0,3],www:0,xavier:14,yield:6,you:[8,10,14],yuan:14,zero:[0,3],zhong:14,zhu:14},titles:["4. API reference","3. Benchmarks","5. Command line arguments","3. Configuration file","6. Constants and Units","3. Electrostatic interactions","1. Examples","2. Filtering","1. Installation","1. Interaction energy functionals","2. Intramolecular bonds","2. Usage overview for HylleraasMD","1. Theory","4. Topology and structure file","HylleraasMD documentation"],titleterms:{"function":9,"import":8,"new":[7,9],"while":8,SDS:6,api:0,argument:2,assembl:6,benchmark:1,bilay:6,bond:[1,3,10],build:8,calcul:12,chain:6,chi:9,code:14,colab:14,colaboratori:8,command:2,common:8,configur:3,constant:4,copolym:6,curl:8,dataset:13,depend:8,develop:14,diblock:6,docker:8,document:14,due:8,electrostat:[3,5],enabl:8,energi:9,error:8,exampl:6,extern:12,field:[0,1,3],file:[0,3,13],filter:[7,12],forc:[0,1,8,12],form:[9,12],fortran:8,four:10,gas:6,googl:[8,14],guid:14,h5py:8,hamiltonian:[0,12],helix:6,hylleraasmd:[11,14],hymd:[8,14],ideal:6,implement:[7,9],incompress:9,indic:14,input:0,instal:[8,14],integr:0,interact:[5,8,9],interpol:12,intramolecular:10,issu:8,kappa:9,kernel:8,keyword:3,line:2,lipid:6,logger:0,metadata:3,miss:8,mpi:8,numpi:8,onli:9,option:[2,13],output:0,overview:11,parallel:[8,11],parser:0,particl:[1,3,10],peptid:6,pfft:8,phase:6,phi:9,potenti:12,python:8,reciproc:12,refer:[0,14],requir:[2,13],rod:6,run:[8,11,14],self:6,separ:6,simul:[3,11],sourc:14,space:12,specifi:5,stiff:6,structur:13,tabl:14,test:11,theori:12,thermostat:0,three:10,topolog:13,two:10,unit:4,usag:11,user:14,wget:8,without:8}}) \ No newline at end of file diff --git a/v1.0.9/.buildinfo b/v1.0.9/.buildinfo new file mode 100644 index 00000000..6daff942 --- /dev/null +++ b/v1.0.9/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: ef32ee97fd3652d5d6b420215dd41bb5 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v1.0.9/.doctrees/doc_pages/api.doctree b/v1.0.9/.doctrees/doc_pages/api.doctree new file mode 100644 index 00000000..b72a8b1e Binary files /dev/null and b/v1.0.9/.doctrees/doc_pages/api.doctree differ diff --git a/v1.0.9/.doctrees/doc_pages/benchmarks.doctree b/v1.0.9/.doctrees/doc_pages/benchmarks.doctree new file mode 100644 index 00000000..4b5fc234 Binary files /dev/null and b/v1.0.9/.doctrees/doc_pages/benchmarks.doctree differ diff --git a/v1.0.9/.doctrees/doc_pages/command_line.doctree b/v1.0.9/.doctrees/doc_pages/command_line.doctree new file mode 100644 index 00000000..6cb75c70 Binary files /dev/null and b/v1.0.9/.doctrees/doc_pages/command_line.doctree differ diff --git a/v1.0.9/.doctrees/doc_pages/config_file.doctree b/v1.0.9/.doctrees/doc_pages/config_file.doctree new file mode 100644 index 00000000..a9c5b4aa Binary files /dev/null and b/v1.0.9/.doctrees/doc_pages/config_file.doctree differ diff --git a/v1.0.9/.doctrees/doc_pages/constants_and_units.doctree b/v1.0.9/.doctrees/doc_pages/constants_and_units.doctree new file mode 100644 index 00000000..1522f49e Binary files /dev/null and b/v1.0.9/.doctrees/doc_pages/constants_and_units.doctree differ diff --git a/v1.0.9/.doctrees/doc_pages/electrostatics.doctree b/v1.0.9/.doctrees/doc_pages/electrostatics.doctree new file mode 100644 index 00000000..aa221278 Binary files /dev/null and b/v1.0.9/.doctrees/doc_pages/electrostatics.doctree differ diff --git a/v1.0.9/.doctrees/doc_pages/examples.doctree b/v1.0.9/.doctrees/doc_pages/examples.doctree new file mode 100644 index 00000000..6acf98f9 Binary files /dev/null and b/v1.0.9/.doctrees/doc_pages/examples.doctree differ diff --git a/v1.0.9/.doctrees/doc_pages/filtering.doctree b/v1.0.9/.doctrees/doc_pages/filtering.doctree new file mode 100644 index 00000000..f7ee62d5 Binary files /dev/null and b/v1.0.9/.doctrees/doc_pages/filtering.doctree differ diff --git a/v1.0.9/.doctrees/doc_pages/installation.doctree b/v1.0.9/.doctrees/doc_pages/installation.doctree new file mode 100644 index 00000000..5ea9f5ca Binary files /dev/null and b/v1.0.9/.doctrees/doc_pages/installation.doctree differ diff --git a/v1.0.9/.doctrees/doc_pages/interaction_energy_functionals.doctree b/v1.0.9/.doctrees/doc_pages/interaction_energy_functionals.doctree new file mode 100644 index 00000000..fff9337a Binary files /dev/null and b/v1.0.9/.doctrees/doc_pages/interaction_energy_functionals.doctree differ diff --git a/v1.0.9/.doctrees/doc_pages/intramolecular_bonds.doctree b/v1.0.9/.doctrees/doc_pages/intramolecular_bonds.doctree new file mode 100644 index 00000000..7eb5ea0d Binary files /dev/null and b/v1.0.9/.doctrees/doc_pages/intramolecular_bonds.doctree differ diff --git a/v1.0.9/.doctrees/doc_pages/overview.doctree b/v1.0.9/.doctrees/doc_pages/overview.doctree new file mode 100644 index 00000000..e7eaac8d Binary files /dev/null and b/v1.0.9/.doctrees/doc_pages/overview.doctree differ diff --git a/v1.0.9/.doctrees/doc_pages/theory.doctree b/v1.0.9/.doctrees/doc_pages/theory.doctree new file mode 100644 index 00000000..6f3876e5 Binary files /dev/null and b/v1.0.9/.doctrees/doc_pages/theory.doctree differ diff --git a/v1.0.9/.doctrees/doc_pages/topology_input.doctree b/v1.0.9/.doctrees/doc_pages/topology_input.doctree new file mode 100644 index 00000000..59b84c30 Binary files /dev/null and b/v1.0.9/.doctrees/doc_pages/topology_input.doctree differ diff --git a/v1.0.9/.doctrees/environment.pickle b/v1.0.9/.doctrees/environment.pickle new file mode 100644 index 00000000..08dd2b80 Binary files /dev/null and b/v1.0.9/.doctrees/environment.pickle differ diff --git a/v1.0.9/.doctrees/index.doctree b/v1.0.9/.doctrees/index.doctree new file mode 100644 index 00000000..cd0a6b68 Binary files /dev/null and b/v1.0.9/.doctrees/index.doctree differ diff --git a/v1.0.9/_downloads/2ed9ec9ba3e665f7f3f260e2ec42adb2/benchmarks-1.py b/v1.0.9/_downloads/2ed9ec9ba3e665f7f3f260e2ec42adb2/benchmarks-1.py new file mode 100644 index 00000000..deb4348f --- /dev/null +++ b/v1.0.9/_downloads/2ed9ec9ba3e665f7f3f260e2ec42adb2/benchmarks-1.py @@ -0,0 +1,38 @@ +import numpy as np +import matplotlib.pyplot as plt +nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) +time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 +], dtype=np.float64) +nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 +], dtype=np.float64,) +time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, +], dtype=np.float64) +nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 +], dtype=np.float64) +time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, +], dtype=np.float64) +plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" +) +plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" +) +plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" +) +plt.xlabel("CPUs", fontsize=15) +plt.ylabel("Time per step, us", fontsize=15) +plt.legend(fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.show() \ No newline at end of file diff --git a/v1.0.9/_downloads/559348e1167fe8768e7e3d42ac4b9181/benchmarks-2.png b/v1.0.9/_downloads/559348e1167fe8768e7e3d42ac4b9181/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v1.0.9/_downloads/559348e1167fe8768e7e3d42ac4b9181/benchmarks-2.png differ diff --git a/v1.0.9/_downloads/780b4bdc9f18d70b0165fc99ff686a33/benchmarks-2.py b/v1.0.9/_downloads/780b4bdc9f18d70b0165fc99ff686a33/benchmarks-2.py new file mode 100644 index 00000000..fd287cbc --- /dev/null +++ b/v1.0.9/_downloads/780b4bdc9f18d70b0165fc99ff686a33/benchmarks-2.py @@ -0,0 +1,33 @@ +import numpy as np +import matplotlib.pyplot as plt + +mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] +mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + +mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + +mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + +mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] +mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + +mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + +mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + +plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") +plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") +plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") +plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") +plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") +plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") +plt.xlabel("CPUs", fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.ylabel("Time per step, s", fontsize=15) +plt.legend(loc="upper left", fontsize=15) +plt.show() \ No newline at end of file diff --git a/v1.0.9/_downloads/86687576292b4689c7b843d31481ec2e/benchmarks-1.hires.png b/v1.0.9/_downloads/86687576292b4689c7b843d31481ec2e/benchmarks-1.hires.png new file mode 100644 index 00000000..173b39f3 Binary files /dev/null and b/v1.0.9/_downloads/86687576292b4689c7b843d31481ec2e/benchmarks-1.hires.png differ diff --git a/v1.0.9/_downloads/8e940ef45858552eb2164425a117ee96/benchmarks-2.hires.png b/v1.0.9/_downloads/8e940ef45858552eb2164425a117ee96/benchmarks-2.hires.png new file mode 100644 index 00000000..82806426 Binary files /dev/null and b/v1.0.9/_downloads/8e940ef45858552eb2164425a117ee96/benchmarks-2.hires.png differ diff --git a/v1.0.9/_downloads/c483d50d418266aa37f59d24727951fb/benchmarks-1.png b/v1.0.9/_downloads/c483d50d418266aa37f59d24727951fb/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.9/_downloads/c483d50d418266aa37f59d24727951fb/benchmarks-1.png differ diff --git a/v1.0.9/_downloads/e1a3dc6c1b566186bc511cb008681488/benchmarks-2.pdf b/v1.0.9/_downloads/e1a3dc6c1b566186bc511cb008681488/benchmarks-2.pdf new file mode 100644 index 00000000..25f92fb8 Binary files /dev/null and b/v1.0.9/_downloads/e1a3dc6c1b566186bc511cb008681488/benchmarks-2.pdf differ diff --git a/v1.0.9/_downloads/fe13d423212f0a355b1d876a3624adc7/benchmarks-1.pdf b/v1.0.9/_downloads/fe13d423212f0a355b1d876a3624adc7/benchmarks-1.pdf new file mode 100644 index 00000000..4c4480d7 Binary files /dev/null and b/v1.0.9/_downloads/fe13d423212f0a355b1d876a3624adc7/benchmarks-1.pdf differ diff --git a/v1.0.9/_images/benchmarks-1.png b/v1.0.9/_images/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v1.0.9/_images/benchmarks-1.png differ diff --git a/v1.0.9/_images/benchmarks-2.png b/v1.0.9/_images/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v1.0.9/_images/benchmarks-2.png differ diff --git a/v1.0.9/_images/hylleraas_centre_logo_black.png b/v1.0.9/_images/hylleraas_centre_logo_black.png new file mode 100644 index 00000000..40826396 Binary files /dev/null and b/v1.0.9/_images/hylleraas_centre_logo_black.png differ diff --git a/v1.0.9/_images/uio_full_logo_eng_pos.png b/v1.0.9/_images/uio_full_logo_eng_pos.png new file mode 100644 index 00000000..6c603139 Binary files /dev/null and b/v1.0.9/_images/uio_full_logo_eng_pos.png differ diff --git a/v1.0.9/_modules/hymd/field.html b/v1.0.9/_modules/hymd/field.html new file mode 100644 index 00000000..c2f92ee4 --- /dev/null +++ b/v1.0.9/_modules/hymd/field.html @@ -0,0 +1,1453 @@ + + + + + + hymd.field — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.field

+"""Forces and energies from the discretized particle-field grid interactions
+"""
+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import warnings
+
+
+
[docs]def initialize_pm(pmesh, config, comm=MPI.COMM_WORLD): + """ + Creates the necessary pmesh objects for pfft operations. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + config : Config + Configuration dataclass containing simulation metadata and parameters. + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm : object 'pmesh.pm.ParticleMesh' + field_list : list[pmesh.pm.RealField], (multiple) + Essential list of pmesh objects required for MD + list_coulomb : list[pmesh.pm.RealField], (multiple) + Additional list of pmesh objects required for electrostatics. + """ + + if config.dtype == np.float64: + pmeshtype = "f8" + else: + pmeshtype = "f4" + # Ignore numpy numpy.VisibleDeprecationWarning: Creating an ndarray from + # ragged nested sequences until it is fixed in pmesh + with warnings.catch_warnings(): + warnings.filterwarnings( + action="ignore", + category=np.VisibleDeprecationWarning, + message=r"Creating an ndarray from ragged nested sequences", + ) + # The first argument of ParticleMesh has to be a tuple + pm = pmesh.ParticleMesh( + config.mesh_size, BoxSize=config.box_size, dtype=pmeshtype, comm=comm + ) + phi = [pm.create("real", value=0.0) for _ in range(config.n_types)] + phi_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] # noqa: E501 + force_on_grid = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + v_ext_fourier = [pm.create("complex", value=0.0) for _ in range(4)] + v_ext = [pm.create("real", value=0.0) for _ in range(config.n_types)] + + phi_transfer = [pm.create("complex", value=0.0) for _ in range(3)] + + phi_laplacian = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + + # Initialize charge density fields + coulomb_list = [] + elec_common_list = [None, None, None, None] + _SPACE_DIM = config.box_size.size + + if config.coulombtype == "PIC_Spectral_GPE" or config.coulombtype == "PIC_Spectral": + phi_q = pm.create("real", value=0.0) + phi_q_fourier = pm.create("complex", value=0.0) + psi = pm.create("real", value=0.0) + elec_field = [pm.create("real", value=0.0) for _ in range(_SPACE_DIM)] + + elec_common_list = [phi_q, phi_q_fourier, psi, elec_field] + + if config.coulombtype == "PIC_Spectral": + elec_field_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] # for force calculation + psi_fourier = pm.create("complex", value=0.0) + + coulomb_list = [ + elec_field_fourier, + psi_fourier, + ] + + if ( + config.coulombtype == "PIC_Spectral_GPE" + ): ## initializing the density mesh #dielectric_flag + phi_eps = pm.create( + "real", value=0.0 + ) ## real contrib of the epsilon dielectric painted to grid + phi_eps_fourier = pm.create("complex", value=0.0) # complex contrib of phi eps + phi_eta = [ + pm.create("real", value=0.0) for _ in range(_SPACE_DIM) + ] ## real contrib of factor in polarization charge density + phi_eta_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] ## fourier of factor in polarization charge density + phi_pol = pm.create( + "real", value=0.0 + ) ## real contrib of the polarization charge + phi_pol_prev = pm.create("real", value=0.0) + elec_dot = pm.create("real", value=0.0) + elec_field_contrib = pm.create( + "real", value=0.0 + ) # needed for pol energies later + + # External potential and force meshes + Vbar_elec = [pm.create("real", value=0.0) for _ in range(config.n_types)] + Vbar_elec_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] + force_mesh_elec = [ + [pm.create("real", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + force_mesh_elec_fourier = [ + [pm.create("complex", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + + coulomb_list = [ + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol, + phi_pol_prev, + elec_dot, + elec_field_contrib, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + ] + + field_list = [ + phi, + phi_fourier, + force_on_grid, + v_ext_fourier, + v_ext, + phi_transfer, + phi_laplacian, + ] + + return (pm, field_list, elec_common_list, coulomb_list)
+ + +
[docs]def compute_field_force(layouts, r, force_mesh, force, types, n_types): + """Interpolate particle-field forces from the grid onto particle positions + + Backmaps the forces calculated on the grid to particle positions using the + window function :math:`P` (by default cloud-in-cell [CIC]). In the + following, let :math:`\\mathbf{F}_j` denote the force acting on the + particle with index :math:`j` and position :math:`\\mathbf{r}_j`. The + interpolated force is + + .. math:: + + \\mathbf{F}_j = -\\sum_k\\nabla V_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`V_{j_k}` is the discretized external potential at grid vertex + :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid vertex + with index :math:`j_k`, and :math:`h^3` is the volume of each grid voxel. + The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + r : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + force : (N,D) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. Local + for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + n_types : int + Number of different unique types present in the simulation system. + :code:`n_types` is global, i.e. the same for all MPI ranks even if some + ranks contain zero particles of certain types. + """ + for t in range(n_types): + ind = types == t + for d in range(3): + force[ind, d] = force_mesh[t][d].readout(r[ind], layout=layouts[t])
+ + +
[docs]def compute_self_energy_q(config, charges, comm=MPI.COMM_WORLD): + """Compute the self energy for the interaction due to the Ewald scheme + used to compute the electrostatics. The energy is stored in :code:`config`. + + The self interaction energy is given by: + + .. math:: + + U_{self} = \\sqrt{\\frac{1}{2\\pi\\sigma^2}} \\sum_{i=1}^{N} q_i^2 + + where :math:`q_i` are the charges and :math:`\\sigma` is the half-width + of the Gaussian filter. + + Parameters + ---------- + config : Config + Configuration object. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + comm : mpi4py.Comm + MPI communicator to use for rank communication. + + Returns + ------- + field_q_self_energy : float + Electrostatic self energy. + """ + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + prefac = elec_conversion_factor * np.sqrt( + 1.0 / (2.0 * np.pi * config.sigma * config.sigma) + ) + _squared_charges = charges * charges + squared_charges_sum = comm.allreduce(np.sum(_squared_charges)) + return prefac * squared_charges_sum
+ + +
[docs]def update_field_force_q( + charges, + phi_q, + phi_q_fourier, + psi, + psi_fourier, + elec_field_fourier, + elec_field, + elec_forces, + layout_q, + hamiltonian, + pm, + positions, + config, +): + """Calculate the electrostatic particle-field forces on the grid + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential is computed in reciprocal space as + + .. math:: + + \\Phi = \\mathrm{FFT}^{-1}\\left[ + \\frac{4\\pi k_e}{\\varepsilon \\vert\\mathbf{k}\\vert^2} + \\mathrm{FFT}(\\rho)\\mathrm{FFT}(H) + \\right], + + with the electric field + + .. math:: + + \\mathbf{E} = \\mathrm{FFT}^{-1}\\left[ + -i\\mathbf{k}\\,\\mathrm{FFT}(\\Psi) + \\right]. + + In the following, let :math:`\\mathbf{F}_j` denote the electrostatic force + acting on the particle with index :math:`j` and position + :math:`\\mathbf{r}_j`. The interpolated electrostatic force is + + .. math:: + + \\mathbf{F}_j = \\sum_k q_j\\mathbf{E}_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`\\mathbf{E}_{j_k}` is the discretized electric field at grid + vertex :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid + vertex with index :math:`j_k`, and :math:`h^3` is the volume of each grid + voxel. The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty; any values in this field + are discarded. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + elec_field_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + electric field values in reciprocal space on the computational grid. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + n_dimensions = config.box_size.size + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + # charges to grid + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) + phi_q /= volume_per_cell + # print("phi_q", np.sum(phi_q)) + phi_q.r2c(out=phi_q_fourier) + + # smear charges with filter + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + + # solve Poisson equation in Fourier space to get electrostatic potential + def poisson_transfer_function(k, v): + return 4.0 * np.pi * elec_conversion_factor * v / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(poisson_transfer_function, out=psi_fourier) + # print("psi_fourier", np.sum(psi_fourier)) + psi_fourier.c2r(out=psi) + # print("phi_q * psi update_field", np.sum(phi_q * psi)) + + # exit() + + # compute electric field directly from smeared charged densities in Fourier + for _d in np.arange(n_dimensions): + + def poisson_transfer_function(k, v, d=_d): + return ( + -1j + * k[d] + * 4.0 + * np.pi + * elec_conversion_factor + * v + / k.normp(p=2, zeromode=1) + ) + + phi_q_fourier.apply(poisson_transfer_function, out=elec_field_fourier[_d]) + elec_field_fourier[_d].c2r(out=elec_field[_d]) + + # get electrostatic force from electric field + for _d in np.arange(n_dimensions): + elec_forces[:, _d] = charges * ( + elec_field[_d].readout(positions, layout=layout_q) + )
+ + +def comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, +): + for t in range(config.n_types): + np.copyto(phi_transfer[0].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[1].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[2].value, phi_fourier[t].value, casting="no", where=True) + + # Evaluate laplacian of phi in fourier space + for d in range(3): + + def laplacian_transfer(k, v, d=d): + return -k[d] ** 2 * v + + phi_transfer[d].apply(laplacian_transfer, out=Ellipsis) + phi_transfer[d].c2r(out=phi_laplacian[t][d]) + + +
[docs]def update_field( + phi, + phi_laplacian, + phi_transfer, + layouts, + force_mesh, + hamiltonian, + pm, + positions, + types, + config, + v_ext, + phi_fourier, + v_ext_fourier, + m, + compute_potential=False, +): + """Calculate the particle-field potential and force density + + If :code:`compute_potential` is :code:`True`, the energy may subsequently + be computed by calling :code:`compute_field_and_kinetic_energy`. + + Computes the particle-field external potential :math:`V_\\text{ext}` from + particle number densities through the smoothed density field, + :math:`\\phi(\\mathbf{r})`. With :math:`P` being the cloud-in-cell (CIC) + window function, the density and filtered densities are computed as + + .. math:: + + \\phi(\\mathbf{r}) = \\sum_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\phi(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\phi(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + external potential is computed in reciprocal space as + + .. math:: + + V_\\text{ext} = \\mathrm{FFT}^{-1}\\left[ + \\mathrm{FFT} + \\left( + \\frac{\\partial w}{\\partial \\tilde\\phi} + \\right) + \\mathrm{FFT}(H) + \\right], + + where :math:`w` is the interaction energy functional. Differentiating + :math:`V_\\text{ext}` is done by simply applying :math:`i\\mathbf{k}` in + Fourier space, and the resulting forces are back-transformed to direct + space and interpolated to particle positions by + + .. math:: + + \\mathbf{F}_j = -\\sum_{j_k} \\nabla V_{j_k} + P(\\mathbf{r}_{j_k} - \\mathbf{r}_j)h^3, + + where :math:`j_k` are the neighbouring vertices of particle :math:`j` at + position :math:`\\mathbf{r}_j`, and :math:`h^3` is the volume of each grid + voxel. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Pre-allocated, but empty; any values + in this field are discarded. Changed in-place. Local for each MPI + rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + config : Config + Configuration object. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Pre-allocated, but empty; any values in this field are + discarded Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + phi_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computational grid is represented by the collective fields of all + MPI ranks. + v_ext_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplesField` objects containing discretized + particle-field external potential values in reciprocal space on the + computational grid; :code:`D+1` fields in D dimensions for each + particle type. :code:`D` copies are made after calculation for later + use in force calculation, because the `force transfer function` + application differentiates the field in-place, ruining the contents + for differentiation in the remaining :code:`D-1` spatial directions. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + m: list[float], (M,) + pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. + Defaults to 1.0 for all particle types. + compute_potential : bool, optional + If :code:`True`, a :code:`D+1`-th copy of the Fourier transformed + external potential field is made to be used later in particle-field + energy calculation. If :code:`False`, only :code:`D` copies are made. + + See also + -------- + compute_field_and_kinetic_energy : + Compute the particle-field energy after the external potential is + calculated. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + for t in range(config.n_types): + pm.paint(positions[types == t], mass=m[t], layout=layouts[t], out=phi[t]) + phi[t] /= volume_per_cell + phi[t].r2c(out=phi_fourier[t]) + phi_fourier[t].apply(hamiltonian.H, out=Ellipsis) + phi_fourier[t].c2r(out=phi[t]) + + # External potential + for t in range(config.n_types): + v = hamiltonian.v_ext[t](phi) + + v.r2c(out=v_ext_fourier[0]) + v_ext_fourier[0].apply(hamiltonian.H, out=Ellipsis) + np.copyto( + v_ext_fourier[1].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + np.copyto( + v_ext_fourier[2].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + if compute_potential: + np.copyto( + v_ext_fourier[3].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + + # Differentiate the external potential in fourier space + for d in range(3): + + def force_transfer_function(k, v, d=d): + return -k[d] * 1j * v + + v_ext_fourier[d].apply(force_transfer_function, out=Ellipsis) + v_ext_fourier[d].c2r(out=force_mesh[t][d]) + + if compute_potential: + v_ext_fourier[3].c2r(out=v_ext[t])
+ + +
[docs]def compute_field_and_kinetic_energy( + phi, + phi_q, + psi, + velocity, + hamiltonian, + positions, + types, + v_ext, + config, + layouts, + comm=MPI.COMM_WORLD, +): + """Compute the particle-field and kinetic energy contributions + + Calculates the kinetic energy through + + .. math:: + + E_k = \\sum_j \\frac{1}{2}m_j\\mathbf{v}_j\\cdot\\mathbf{v}_j, + + and the particle-field energy by + + .. math:: + + E_\\text{field} = \\int\\mathrm{d}\\mathbf{r}\\, + w[\\tilde\\phi], + + where :math:`w` is the interaction energy functional `density`. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + velocity : (N,D) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Local for each MPI rank--the full computational grid is + represented by the collective fields of all MPI ranks. + config : Config + Configuration object. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field : + Computes the up-to-date external potential for use in calculating the + particle-field energy. + """ + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + field_energy = w_0.csum() # w to W + + kinetic_energy = comm.allreduce(0.5 * config.mass * np.sum(velocity**2)) + + if config.coulombtype == "PIC_Spectral": + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + field_q_energy = w_elec.csum() + else: + field_q_energy = 0.0 + + return field_energy, kinetic_energy, field_q_energy
+ + +
[docs]def compute_field_energy_q_GPE( + config, + phi_eps, + field_q_energy, + dot_elec, + comm=MPI.COMM_WORLD, +): + """ + Compute the electrostatic energy after electrosatic forces is + calculated. + + From the definition of the elecrostatic potential :math:`\\Psi`, the energy + is + + W = \\frac{1}{2}\\int\\mathrm{d}\\mathbf{r}\\, + \\epsilon(\\mathbf{r})} \\left(\\mathbf{E}\\cdot \\mathbf{E}\\right), + + where :math:`\\epsilon(\\mathbf{r})}` is the anisotropic, spatially dependent, + relative dielectric of the simulation medium. + + Parameters + ---------- + config : hymd.input_parser.Config + Configuration object. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + field_q_energy : float + Total elecrostatic energy. + dot_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing :math:`|\\mathbf{E(r)}|^{2}` + on the computational grid. Local for each MPI rank -- the full computational + grid is represented by the collective fields of all MPI ranks. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field_force_q_GPE: + Compute the electrosatic force from an anisotropic dielectric general + Poisson equation. + """ + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + # ^ due to integration on local cell before allreduce + + eps_0 = 1.0 / (config.coulomb_constant * 4 * np.pi) + field_q_energy = ( + volume_per_cell * (0.5 * eps_0) * comm.allreduce(np.sum(phi_eps * dot_elec)) + ) + + return field_q_energy
+ + +
[docs]def update_field_force_q_GPE( + conv_fun, + phi, + types, + charges, + phi_q, + phi_q_fourier, + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol_prev, + phi_pol, + elec_field, + elec_forces, + elec_field_contrib, + psi, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + hamiltonian, + layout_q, + layouts, + pm, + positions, + config, + comm=MPI.COMM_WORLD, +): + """ + Calculate the electrostatic particle-field forces on the grid, arising from + a general Poisson equation, i.e. anisotropic permittivity/dielectric. + The function is called when tomli input config.coulombtype = "PIC_Spectral_GPE." + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential for a variable dielectric does not have an + analytical expression, and is computed in reciprocal through an iterative + method. + + The GPE states that + + .. math:: + + \\nabla \\cdot \\left(\\epsilon(\\mathbf{r}) + \\nabla{\\mathbf{\\psi(r)}}\\right) = -\\rho({\\mathbf{r}}). + + where :math:`\\epsilon(\\mathbf{r})` is the relative dielectric function. + + Parameters + ---------- + conv_fun : Convergence function. + Returns a scalar. Depends on MPI allreduce for similar convergence + across MPI ranks. + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_eta : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + gradients of the relative dielectric values on the computational grid. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank--the + full computational grid is represented by the collective fields of all MPI ranks. + phi_eta_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated discretized + Fourier transformed gradient relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol_prev : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charge values on the computational grid. Parameter in + the iterative method.Pre-allocated,but empty. Changedin-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charges on the computational grid. Parameter in the iterative + method, updating the next quess in solving for the electrostatic potential. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all + MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + elec_field_contrib : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing + :math:`|\\mathbf{E(r)}|^2/\\phi_{0}` on the computational grid. + Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + psi : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic potential + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + Vbar_elec : mesh.pm.RealField + Pmesh :code:`RealField` object for storing functional derivatives of + :math:`\\|w(\\{ \\phi \\})_{elec}`on the computational grid. + Pre-allocated, but empty. Changed in-place. Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + Vbar_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated functional + derivatives of :math:`\\|w(\\{ \\phi \\})_{elec}` in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + force_mesh_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic force values + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + force_mesh_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated electrostatic + force values in reciprocal space on the computational grid. Local for + each MPI rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + layouts: list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + comm: mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + compute_field_energy_q_GPE: + Compute the electrostatic energy after electrosatic force is + calculated for a variable (anisotropic) dielectric general Poisson equation. + """ + + ## basic setup + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + ## old protocol in gen_qe_hpf_use_self + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) ## + ## scale and fft + ## old protocol in gen_qe_hpf_use_self + phi_q /= volume_per_cell + phi_q.r2c(out=phi_q_fourier) + + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + ## ^------ use the same gaussian as the \kai interaciton + phi_q_fourier.c2r(out=phi_q) ## this phi_q is after applying the smearing function + + denom_phi_tot = pm.create("real", value=0.0) + num_types = pm.create("real", value=0.0) + ### ^ ----- Calculate the relative dielectric (permittivity) to field + ### ------- from a mean contribution of particle number densities + + for t_ in range(config.n_types): + num_types = num_types + (config.dielectric_type[t_]) * phi[t_] + denom_phi_tot = denom_phi_tot + phi[t_] + + np.divide(num_types, denom_phi_tot, where=np.abs(denom_phi_tot > 1e-6), out=phi_eps) + + phi_eps.r2c(out=phi_eps_fourier) # FFT dielectric + + # phi_q_eps = (phi_q/phi_eps) + np.divide(phi_q, phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_q) + + _SPACE_DIM = 3 + ##^--------- constants needed throughout the calculations + + ### method for finding the gradient (fourier space), using the spatial dimension of k + for _d in np.arange(_SPACE_DIM): + + def gradient_transfer_function(k, x, d=_d): + return 1j * k[d] * x + + phi_eps_fourier.apply(gradient_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=phi_eta[_d]) + np.divide(phi_eta[_d], phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_eta[_d]) + + ### iterative GPE solver ### + ### ---------------------------------------------- + max_iter = 100 + i = 0 + delta = 1.0 + # phi_pol_prev = pm.create("real", value = 0.0) + ### ^------ set to zero before each iterative procedure or soft start + conv_criteria = config.conv_crit # conv. criteria (default 1e-6) + w = config.pol_mixing # polarization mixing param (default 0.6) + while i < max_iter and delta > conv_criteria: + (phi_q + phi_pol_prev).r2c(out=phi_q_fourier) + for _d in np.arange(_SPACE_DIM): + + def iterate_apply_k_vec(k, additive_terms, d=_d): + return additive_terms * (-1j * k[d]) / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(iterate_apply_k_vec, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + + phi_pol = -( + phi_eta[0] * elec_field[0] + + phi_eta[1] * elec_field[1] + + phi_eta[2] * elec_field[2] + ) + ### ^-- Following a negative sign convention (-ik) of the FT, a neg sign is + ### --- mathematically correct by the definition of the GPE (double - -> +) + phi_pol = w * phi_pol + (1.0 - w) * phi_pol_prev + diff = np.abs(phi_pol - phi_pol_prev) + delta = conv_fun(comm, diff) # decided from toml input + phi_pol_prev = phi_pol.copy() + i = i + 1 + # print("Stopping after iteration {:d} with stop crit {:.2e}, delta {:.2e}".format(i,conv_criteria,delta)) + + # compute_potential = True + def k_norm_divide(k, potential): + return potential / k.normp(p=2, zeromode=1) + + ## > Electrostatic potential + eps0_inv = config.coulomb_constant * 4 * np.pi + ## ^ the 1/(4pi eps0)*4*pi = 1/eps0 + ((eps0_inv) * (phi_q + phi_pol)).r2c(out=phi_q_fourier) + phi_q_fourier.apply(k_norm_divide, out=phi_q_fourier) + phi_q_fourier.c2r(out=psi) + ### ^ electrostatic potential for the GPE + + for _d in np.arange(_SPACE_DIM): + + def field_transfer_function(k, x, d=_d): + return ( + -1j * k[d] * x + ) ## negative sign relation, due to E = - nabla psi relation + + phi_q_fourier.apply(field_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + ## ^-------- Method: Obtaining the electric field from electrostatic potential + ## Assuming the electric field is conserved. + ## Assumption holds if no magnetic flux (magnetic induced fields) + + ############## Obtain forces ############## + elec_dot = ( + elec_field[0] * elec_field[0] + + elec_field[1] * elec_field[1] + + elec_field[2] * elec_field[2] + ) + # needed for energy calculations + + np.divide( + elec_dot, + denom_phi_tot, + where=np.abs(denom_phi_tot > 1e-6), + out=elec_field_contrib, + ) + + eps0_inv = config.coulomb_constant * 4 * np.pi + + for t_ in range(config.n_types): + Vbar_elec[t_] = ( + config.type_charges[t_] * psi + - (0.5 / eps0_inv) + * (config.dielectric_type[t_] - phi_eps) + * elec_field_contrib + ) + + # Obtain Vext,k + for t_ in range(config.n_types): + Vbar_elec[t_].r2c(out=Vbar_elec_fourier[t_]) + Vbar_elec_fourier[t_].apply(hamiltonian.H, out=Vbar_elec_fourier[t_]) + + # force terms + # F = - grad Vext + for t_ in range(config.n_types): + for _d in np.arange(_SPACE_DIM): + + def force_transfer_function(k, x, d=_d): + return -1j * k[_d] * x ## negative gradient + + Vbar_elec_fourier[t_].apply( + force_transfer_function, out=force_mesh_elec_fourier[t_][_d] + ) + force_mesh_elec_fourier[t_][_d].c2r(out=force_mesh_elec[t_][_d]) + elec_forces[types == t_, _d] = force_mesh_elec[t_][_d].readout( + positions[types == t_], layout=layouts[t_] + ) + + return Vbar_elec, phi_eps, elec_dot
+ + +
[docs]def domain_decomposition( + positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=MPI.COMM_WORLD +): + """Performs domain decomposition + + Rearranges the MPI rank memory layout into one that better mimics the PFFT + pencil grid 2D decomposition. As molecules are always required to be fully + contained on a single MPI rank, a perfect decomposition is not always + possible. The best decomposition which leaves the center of mass of all + molecules in their respective correct domains is used, with possible + overlap into neighbouring domains if the spatial extent of any molecule + crosses domain boundaries. + + Parameters + ---------- + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + *args + Variable length argument list containing arrays to include in the + domain decomposition. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + bonds : (N,M) numpy.ndarray, optional + Array of :code:`M` bonds originating from each of :code:`N` particles. + verbose : int, optional + Specify the logging event verbosity of this function. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + Domain decomposed :code:`positions` and any array specified in + :code:`*args`, in addition to :code:`bonds` and :code:`molecules` if these + arrays were provided as input. + """ + if molecules is not None: + if not topol: + assert bonds is not None, "bonds must be provided with molecules" + unique_molecules = np.sort(np.unique(molecules)) + molecules_com = np.empty_like(positions) + for m in unique_molecules: + ind = molecules == m + r = positions[ind, :][0, :] + molecules_com[ind, :] = r + layout = pm.decompose(molecules_com, smoothing=0) + if not topol: + args = (*args, bonds, molecules) + else: + args = (*args, molecules) + else: + layout = pm.decompose(positions, smoothing=0) + if verbose > 1: + Logger.rank0.log( + logging.INFO, + "DOMAIN_DECOMP: Total number of particles to be exchanged = %d", + np.sum(layout.get_exchange_cost()), + ) + return layout.exchange(positions, *args)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/_modules/hymd/file_io.html b/v1.0.9/_modules/hymd/file_io.html new file mode 100644 index 00000000..9657e621 --- /dev/null +++ b/v1.0.9/_modules/hymd/file_io.html @@ -0,0 +1,1149 @@ + + + + + + hymd.file_io — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.file_io

+"""Handle file input/output in parllel HDF5 fashion
+"""
+import numpy as np
+import h5py
+import os
+import logging
+import getpass
+from mpi4py import MPI
+from .logger import Logger, get_version
+
+
+
[docs]class OutDataset: + """HDF5 dataset handler for file output""" + + def __init__( + self, + dest_directory, + config, + double_out=False, + disable_mpio=False, + comm=MPI.COMM_WORLD, + ): + """Constructor + + Parameters + ---------- + dest_directory : str + Ouput directory for saving data. + config : Config + Configuration object. + double_out : bool, optional + If :code:`True`, the output HDF5 objects are written in eight byte + floating point representation. Otherwise, four byte single + precision is used. + disable_mpio : bool, optional + If :code:`True`, disables parallel MPI-enabled HDF5 file output. + This is a compatibility option used if HDF5 is not compiled with + MPI support. This makes everything much harder by splitting all + output in one file per MPI rank, and having an MPI-enabled HDF5 + library is **highly recommended**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + """ + self.disable_mpio = disable_mpio + self.config = config + if double_out: + self.float_dtype = "float64" + else: + self.float_dtype = "float32" + + if disable_mpio: + self.file = h5py.File( + os.path.join( + dest_directory, f"sim.hdf5-{comm.rank:6d}-of-{comm.size:6d}" + ), + "w", + ) + else: + self.file = h5py.File( + os.path.join(dest_directory, "sim.H5"), "w", driver="mpio", comm=comm + ) + +
[docs] def is_open(self, comm=MPI.COMM_WORLD): + """Check if HDF5 output file is open + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + return self.file.__bool__()
+ +
[docs] def close_file(self, comm=MPI.COMM_WORLD): + """Closes the HDF5 output file + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + self.file.close()
+ +
[docs] def flush(self): + """Flushes output buffers, forcing file writes""" + self.file.flush()
+ + +
[docs]def setup_time_dependent_element( + name, parent_group, n_frames, shape, dtype, units=None +): + """Helper function for setting up time-dependent HDF5 group datasets + + All output groups must adhere to the H5MD standard, meaning a structure of + + + | ┗━ **group** particle group (e.g. :code:`all`) or :code:`observables` group + | ┗━ **group** time-dependent data + | ┣━ **dataset** :code:`step` :code:`shape=(n_frames,)` + | ┣━ **dataset** :code:`time` :code:`shape=(n_frames,)` + | ┗━ **dataset** :code:`value` :code:`shape=(n_frames, *)` + + is necessary. + + References + ---------- + H5MD specification : + https://www.nongnu.org/h5md/h5md.html + """ # noqa: E501 + group = parent_group.create_group(name) + step = group.create_dataset("step", (n_frames,), "int32") + time = group.create_dataset("time", (n_frames,), "float32") + value = group.create_dataset("value", (n_frames, *shape), dtype) + + if units is not None: + value.attrs["unit"] = units + time.attrs["unit"] = "ps" + return group, step, time, value
+ + +
[docs]def store_static( + h5md, + rank_range, + names, + types, + indices, + config, + bonds_2_atom1, + bonds_2_atom2, + molecules=None, + velocity_out=False, + force_out=False, + charges=False, + dielectrics=False, + plumed_out=False, + comm=MPI.COMM_WORLD, +): + """Outputs all static time-independent quantities to the HDF5 output file + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + rank_range : list[int] + Start and end indices for global arrays for each MPI rank. + names : (N,) numpy.ndarray + Array of names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of type indices for :code:`N` particles. + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + config : Config + Configuration object. + bonds_2_atom1 : (B,) numpy.ndarray + Array of indices of the first particle for :code:`B` total + two-particle bonds. + bonds_2_atom2 : (B,) numpy.ndarray + Array of indices of the second particle for :code:`B` total + two-particle bonds. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. + dielectrics : (N,) numpy.ndarray + Array of particle relative dielectric values for :code:`N` particles. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to output HDF5 file. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + prepare_bonds : + Constructs two-, three-, and four-particle bonds from toplogy input + file and bond configuration information. + distribute_input : + Distributes input arrays onto MPI ranks, attempting load balancing. + """ + dtype = h5md.float_dtype + + h5md_group = h5md.file.create_group("/h5md") + h5md.h5md_group = h5md_group + h5md.observables = h5md.file.create_group("/observables") + h5md.connectivity = h5md.file.create_group("/connectivity") + h5md.parameters = h5md.file.create_group("/parameters") + + h5md_group.attrs["version"] = np.array([1, 1], dtype=int) + author_group = h5md_group.create_group("author") + author_group.attrs["name"] = np.string_(getpass.getuser()) + creator_group = h5md_group.create_group("creator") + creator_group.attrs["name"] = np.string_("Hylleraas MD") + + # Get HyMD version + creator_group.attrs["version"] = np.string_(get_version()) + + h5md.particles_group = h5md.file.create_group("/particles") + h5md.all_particles = h5md.particles_group.create_group("all") + mass = h5md.all_particles.create_dataset("mass", (config.n_particles,), dtype) + mass[...] = config.mass + + if charges is not False: + charge = h5md.all_particles.create_dataset( + "charge", (config.n_particles,), dtype="float32" + ) + charge[indices] = charges + if dielectrics is not False: + dielectric = h5md.all_particles.create_dataset( + "dielectric", (config.n_particles,), dtype="float32" + ) + dielectric[indices] = dielectrics + + box = h5md.all_particles.create_group("box") + box.attrs["dimension"] = 3 + box.attrs["boundary"] = np.array( + [np.string_(s) for s in 3 * ["periodic"]], dtype="S8" + ) + + n_frames = config.n_steps // config.n_print + if np.mod(config.n_steps - 1, config.n_print) != 0: + n_frames += 1 + if np.mod(config.n_steps, config.n_print) == 1: + n_frames += 1 + if n_frames == config.n_steps: + n_frames += 1 + + species = h5md.all_particles.create_dataset( + "species", + (config.n_particles,), + dtype="i", + ) + + ( + _, + h5md.positions_step, + h5md.positions_time, + h5md.positions, + ) = setup_time_dependent_element( + "position", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm", + ) + if velocity_out: + ( + _, + h5md.velocities_step, + h5md.velocities_time, + h5md.velocities, + ) = setup_time_dependent_element( + "velocity", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm ps-1", + ) + if force_out: + ( + _, + h5md.forces_step, + h5md.forces_time, + h5md.forces, + ) = setup_time_dependent_element( + "force", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="kJ mol-1 nm-1", + ) + ( + _, + h5md.total_energy_step, + h5md.total_energy_time, + h5md.total_energy, + ) = setup_time_dependent_element( + "total_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.kinetc_energy_step, + h5md.kinetc_energy_time, + h5md.kinetc_energy, + ) = setup_time_dependent_element( + "kinetic_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.potential_energy_step, + h5md.potential_energy_time, + h5md.potential_energy, + ) = setup_time_dependent_element( + "potential_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.bond_energy_step, + h5md.bond_energy_time, + h5md.bond_energy, + ) = setup_time_dependent_element( + "bond_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.angle_energy_step, + h5md.angle_energy_time, + h5md.angle_energy, + ) = setup_time_dependent_element( + "angle_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.dihedral_energy_step, + h5md.dihedral_energy_time, + h5md.dihedral_energy, + ) = setup_time_dependent_element( + "dihedral_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.field_energy_step, + h5md.field_energy_time, + h5md.field_energy, + ) = setup_time_dependent_element( + "field_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + if charges is not False: + ( + _, + h5md.field_q_energy_step, + h5md.field_q_energy_time, + h5md.field_q_energy, + ) = setup_time_dependent_element( + "field_q_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) # <-------- xinmeng + if plumed_out is not False: + ( + _, + h5md.plumed_bias_step, + h5md.plumed_bias_time, + h5md.plumed_bias, + ) = setup_time_dependent_element( + "plumed_bias", h5md.observables, n_frames, (1,), dtype, units="kJ mol-1" # noqa: E501 + ) + ( + _, + h5md.total_momentum_step, + h5md.total_momentum_time, + h5md.total_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "total_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm g ps-1 mol-1", + ) + ( + _, + h5md.angular_momentum_step, + h5md.angular_momentum_time, + h5md.angular_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "angular_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm+2 g ps-1 mol-1", + ) + ( + _, + h5md.torque_step, + h5md.torque_time, + h5md.torque, + ) = setup_time_dependent_element( # noqa: E501 + "torque", + h5md.observables, + n_frames, + (3,), + dtype, + units="kJ nm+2 mol-1", + ) + ( + _, + h5md.temperature_step, + h5md.temperature_time, + h5md.temperature, + ) = setup_time_dependent_element( + "temperature", h5md.observables, n_frames, (3,), dtype, units="K" + ) + ( + _, + h5md.thermostat_work_step, + h5md.thermostat_work_time, + h5md.thermostat_work, + ) = setup_time_dependent_element( + "thermostat_work", + h5md.observables, + n_frames, + (1,), + "float32", + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.pressure_step, + h5md.pressure_time, + h5md.pressure, + ) = setup_time_dependent_element( + "pressure", h5md.observables, n_frames, (18,), "float32", units="Bar" + ) + (_, h5md.box_step, h5md.box_time, h5md.box_value,) = setup_time_dependent_element( + "edges", box, n_frames, (3, 3), "float32", units="nm" + ) + + ind_sort = np.argsort(indices) + for i in ind_sort: + species[indices[i]] = config.name_to_type_map[names[i].decode("utf-8")] + + h5md.parameters.attrs["config.toml"] = np.string_(str(config)) + vmd_group = h5md.parameters.create_group("vmd_structure") + index_of_species = vmd_group.create_dataset( + "indexOfSpecies", (config.n_types,), "i" + ) + index_of_species[:] = np.array(list(range(config.n_types))) + + # VMD-h5mdplugin maximum name/type name length is 16 characters (for + # whatever reason [VMD internals?]). + name_dataset = vmd_group.create_dataset("name", (config.n_types,), "S16") + type_dataset = vmd_group.create_dataset("type", (config.n_types,), "S16") + if molecules is not None: + resid_dataset = vmd_group.create_dataset( + "resid", + (config.n_particles,), + "i", + ) + + # Change this + for i, n in config.type_to_name_map.items(): + name_dataset[i] = np.string_(n[:16]) + if n == "W": + type_dataset[i] = np.string_("solvent") + else: + type_dataset[i] = np.string_("membrane") + + total_bonds = comm.allreduce(len(bonds_2_atom1), MPI.SUM) + n_bonds_local = len(bonds_2_atom1) + + receive_buffer = comm.gather(n_bonds_local, root=0) + n_bonds_global = None + if comm.Get_rank() == 0: + n_bonds_global = receive_buffer + n_bonds_global = np.array(comm.bcast(n_bonds_global, root=0)) + rank_bond_start = np.sum(n_bonds_global[: comm.Get_rank()]) + + bonds_from = vmd_group.create_dataset("bond_from", (total_bonds,), "i") + bonds_to = vmd_group.create_dataset("bond_to", (total_bonds,), "i") + for i in range(n_bonds_local): + a = bonds_2_atom1[i] + b = bonds_2_atom2[i] + bonds_from[rank_bond_start + i] = indices[a] + 1 + bonds_to[rank_bond_start + i] = indices[b] + 1 + + if molecules is not None: + resid_dataset[indices[ind_sort]] = molecules
+ + +# store data old vs +""" +h5md, step, frame, indices, positions, velocities, forces, box_size, +temperature, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, +field_energy, field_q_energy, time_step, config, velocity_out=False, +force_out=False, charge_out=False, dump_per_particle=False, +""" + + +
[docs]def store_data( + h5md, + step, + frame, + indices, + positions, + velocities, + forces, + box_size, + temperature, + pressure, + kinetic_energy, + bond2_energy, + bond3_energy, + bond4_energy, + field_energy, + field_q_energy, + plumed_bias, + time_step, + config, + velocity_out=False, + force_out=False, + charge_out=False, + plumed_out=False, + dump_per_particle=False, + comm=MPI.COMM_WORLD, +): + """Writes time-step data to HDF5 output file + + Handles all quantities which change during simulation, as opposed to + static quanitities (see :code:`store_static`). + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + step : int + Step number. + frame : int + Output frame number (:code:`step // n_print`). + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + positions : (N,) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + velocities : (N,) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + forces : (N,) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. + box_size : (D,) numpy.ndarray + Array containing the simulation box size. + temperature : float + Calculated instantaneous temperature. + kinetic_energy : float + Calculated instantaneous kinetic energy. + bond2_energy : float + Calculated instantaneous harmonic two-particle bond energy. + bond3_energy : float + Calculated instantaneous harmonic angular three-particle bond energy. + bond4_energy : float + Calculated instantaneous dihedral four-particle torsion energy. + field_energy : float + Calculated instantaneous particle-field energy. + field_q_energy : float + Calculated instantaneous electrostatic energy. + plumed_bias : float + PLUMED instantaneous bias energy. + time_step : float + Value of the time step. + config : Config + Configuration object. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charge_out : bool, optional + If :code:`True`, electrostatic energies are written to the output + HDF5 file. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to the output HDF5 file. + dump_per_particle : bool, optional + If :code:`True`, all quantities are written **per particle**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + store_static : + Outputs all static time-independent quantities to the HDF5 output file + """ + for dset in ( + h5md.positions_step, + h5md.total_energy_step, + h5md.potential_energy_step, + h5md.kinetc_energy_step, + h5md.bond_energy_step, + h5md.angle_energy_step, + h5md.dihedral_energy_step, + h5md.field_energy_step, + h5md.total_momentum_step, + h5md.angular_momentum_step, + h5md.torque_step, + h5md.temperature_step, + h5md.pressure_step, + h5md.box_step, + h5md.thermostat_work_step, + ): + dset[frame] = step + + for dset in ( + h5md.positions_time, + h5md.total_energy_time, + h5md.potential_energy_time, + h5md.kinetc_energy_time, + h5md.bond_energy_time, + h5md.angle_energy_time, + h5md.dihedral_energy_time, + h5md.field_energy_time, + h5md.total_momentum_time, + h5md.angular_momentum_time, + h5md.torque_time, + h5md.temperature_time, + h5md.pressure_time, + h5md.box_time, + h5md.thermostat_work_time, + ): + dset[frame] = step * time_step + + if velocity_out: + h5md.velocities_step[frame] = step + h5md.velocities_time[frame] = step * time_step + if force_out: + h5md.forces_step[frame] = step + h5md.forces_time[frame] = step * time_step + if charge_out: + h5md.field_q_energy_step[frame] = step + h5md.field_q_energy_time[frame] = step * time_step + if plumed_out: + h5md.plumed_bias_step[frame] = step + h5md.plumed_bias_time[frame] = step * time_step + + ind_sort = np.argsort(indices) + h5md.positions[frame, indices[ind_sort]] = positions[ind_sort] + + if velocity_out: + h5md.velocities[frame, indices[ind_sort]] = velocities[ind_sort] + if force_out: + h5md.forces[frame, indices[ind_sort]] = forces[ind_sort] + if charge_out: + h5md.field_q_energy[frame] = field_q_energy + if plumed_out: + h5md.plumed_bias[frame] = plumed_bias + + potential_energy = ( + bond2_energy + bond3_energy + bond4_energy + field_energy + field_q_energy + ) + + total_momentum = config.mass * comm.allreduce(np.sum(velocities, axis=0), MPI.SUM) + angular_momentum = config.mass * comm.allreduce( + np.sum(np.cross(positions, velocities), axis=0), MPI.SUM + ) + torque = config.mass * comm.allreduce( + np.sum(np.cross(positions, forces), axis=0), MPI.SUM + ) + h5md.total_energy[frame] = kinetic_energy + potential_energy + h5md.potential_energy[frame] = potential_energy + h5md.kinetc_energy[frame] = kinetic_energy + h5md.bond_energy[frame] = bond2_energy + h5md.angle_energy[frame] = bond3_energy + h5md.dihedral_energy[frame] = bond4_energy + h5md.field_energy[frame] = field_energy + h5md.total_momentum[frame, :] = total_momentum + h5md.angular_momentum[frame, :] = angular_momentum + h5md.torque[frame, :] = torque + h5md.temperature[frame] = temperature + h5md.pressure[frame] = pressure + for d in range(3): + h5md.box_value[frame, d, d] = box_size[d] + h5md.thermostat_work[frame] = config.thermostat_work + + fmt_ = [ + "step", + "time", + "temp", + "tot E", + "kin E", + "pot E", + "field E", + "elec E", + "bond E", + "ang E", + "dih E", + "bias E", + "Px", + "Py", + "Pz", + "ΔH" if config.target_temperature else "ΔE", + ] + fmt_ = np.array(fmt_) + + # create mask to show only energies != 0 + en_array = np.array([ + field_energy, + field_q_energy, + bond2_energy, + bond3_energy, + bond4_energy, + plumed_bias, + ]) + mask = np.full_like(fmt_, True, dtype=bool) + mask[range(6,12)] = en_array != 0. + + header_ = fmt_[mask].shape[0] * "{:>13}" + if config.initial_energy is None: + fmt_[-1] = "" + + divide_by = 1.0 + if dump_per_particle: + for i in range(3, 9): + fmt_[i] = fmt_[i][:-2] + "E/N" + fmt_[-1] += "/N" + divide_by = config.n_particles + total_energy = kinetic_energy + potential_energy + if config.initial_energy is not None: + if config.target_temperature: + H_tilde = total_energy - config.initial_energy - config.thermostat_work + else: + H_tilde = total_energy - config.initial_energy + else: + H_tilde = 0.0 + + header = header_.format(*fmt_[mask]) + data_fmt = f'{"{:13}"}{(fmt_[mask].shape[0]-1) * "{:13.5g}" }' + all_data = [ + step, + time_step * step, + temperature, + total_energy / divide_by, + kinetic_energy / divide_by, + potential_energy / divide_by, + field_energy / divide_by, + field_q_energy / divide_by, + bond2_energy / divide_by, + bond3_energy / divide_by, + bond4_energy / divide_by, + plumed_bias / divide_by, + total_momentum[0] / divide_by, + total_momentum[1] / divide_by, + total_momentum[2] / divide_by, + H_tilde / divide_by, + ] + data = data_fmt.format(*[val for i, val in enumerate(all_data) if mask[i]]) + Logger.rank0.log(logging.INFO, ("\n" + header + "\n" + data))
+ + +
[docs]def distribute_input( + in_file, rank, size, n_particles, max_molecule_size=201, comm=MPI.COMM_WORLD +): + """Assign global arrays onto MPI ranks, attempting load balancing + + Distributes approximately equal numbers of particles (workload) onto each + independent MPI rank, while respecting the requirement that any molecule + must be fully contained on a single MPI rank only (no splitting molecules + across multiple CPUs). + + Parameters + ---------- + in_file : h5py.File + HDF5 input file object. + rank : int + Local rank number for this MPI rank. + size : int + Global size of the MPI communicator (number of total CPUs). + n_particles : int + Total number of particles. + max_molecule_size : int, optional + Maximum size of any molecule present in the system. Used to initially + guess where the MPI rank boundaries (start/end indices) in the global + arrays should be placed. If molecules of size + :code:`>max_molecule_size` exist in the simulation system, HyMD + **might** work as expected. Or it might fail spectacularly. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + rank_range : + Starting and ending indices in the global arrays for each MPI rank. + """ + if n_particles is None: + n_particles = len(in_file["indices"]) + np_per_MPI = n_particles // size + + molecules_flag = False + if "molecules" in in_file: + molecules_flag = True + + if not molecules_flag: + if rank == size - 1: + np_cum_mpi = [rank * np_per_MPI, n_particles] + else: + np_cum_mpi = [rank * np_per_MPI, (rank + 1) * np_per_MPI] + p_mpi_range = list(range(np_cum_mpi[0], np_cum_mpi[1])) + return p_mpi_range, molecules_flag + + # To avoid splitting molecules across multiple different ranks, we need + # to read in some extra indices before/after the expected break points + # and iterate until we find a molecule break. + # + # Implicitly assuming no molecule is bigger than + # min(max_molecule_size, n_particles // n_MPI_ranks) atoms. + max_molecule_size += 2 + grab_extra = max_molecule_size if np_per_MPI > max_molecule_size else np_per_MPI + if rank == 0: + mpi_range_start = 0 + if size == 1: + mpi_range_end = n_particles + else: + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + elif rank == size - 1: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = n_particles + else: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + + molecules = in_file["molecules"][mpi_range_start:mpi_range_end] + indices = in_file["indices"][mpi_range_start:mpi_range_end] + molecule_end_indices = np.nonzero(np.diff(molecules))[0] + + p_mpi_range = [None, None] + if rank == 0: + p_mpi_range[0] = 0 + if size == 1: + p_mpi_range[1] = n_particles + else: + p_mpi_range[1] = indices[ + molecule_end_indices[molecule_end_indices >= np_per_MPI][0] + 1 + ] + elif rank == size - 1: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = n_particles + else: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = ( + indices[molecule_end_indices[molecule_end_indices > np_per_MPI][0]] + + 1 # noqa: E501 + ) + return list(range(p_mpi_range[0], p_mpi_range[1])), molecules_flag
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/_modules/hymd/force.html b/v1.0.9/_modules/hymd/force.html new file mode 100644 index 00000000..51d70820 --- /dev/null +++ b/v1.0.9/_modules/hymd/force.html @@ -0,0 +1,1152 @@ + + + + + + hymd.force — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.force

+"""Calculates intramolecular forces between bonded particles in molecules
+"""
+import numpy as np
+import networkx as nx
+from dataclasses import dataclass
+
+# Imported here so we can call from force import compute_bond_forces__fortran
+from force_kernels import cbf as compute_bond_forces__fortran  # noqa: F401
+from force_kernels import (  # noqa: F401
+    caf as compute_angle_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cdf as compute_dihedral_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cbf_d as compute_bond_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    caf_d as compute_angle_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    cdf_d as compute_dihedral_forces__fortran__double,
+)
+
+
+
[docs]@dataclass # might not be needed +class Dielectric_type: + atom_1: str + dielectric_value: float
+ + +
[docs]@dataclass +class Bond: + """Dataclass representing a single two-particle bond type + + A `bond type` is a bond strength and equilibrium distance associated with + any bond between particles of specific types :code:`A` and :code:`B` + (where :code:`A` and :code:`B` may be the same or different). Harmonic + two-particle bonds in HyMD take the form + + .. math:: + + V_2(\\mathbf{r}_1, \\mathbf{r}_2) = + \\frac{1}{2}k + \\left( + \\vert \\mathbf{r}_1 - \\mathbf{r}_2 \\vert - r_0 + \\right)^2, + + where :math:`k` is the bond strength (spring constant) and :math:`r_0` is + the equilibrium bond length (at which the energy is zero). + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + equilibrium : float + Equilibrium distance at which the energy associated with the bond + vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient (spring constant). + """ + + atom_1: str + atom_2: str + equilibrium: float + strength: float
+ + +
[docs]@dataclass +class Angle(Bond): + """Dataclass representing a single three-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any three-particle bond between particles of specific types :code:`A`, + :code:`B`, and :code:`C` (where :code:`A`, :code:`B`, and :code:`C` may be + different or the same). Harmonic angular three-particle bonds in HyMD take + the form + + .. math:: + + V_3(\\mathbf{r}_1, \\mathbf{r}_2, \\mathbf{r}_3) = + \\frac{1}{2}k + \\left( + \\cos^{-1} + \\left[ + \\frac{ + (\\mathbf{r}_1-\\mathbf{r}_2) + \\cdot + (\\mathbf{r}_3-\\mathbf{r}_2) + } + { + \\vert\\mathbf{r}_1-\\mathbf{r}_2\\vert + \\vert\\mathbf{r}_3-\\mathbf{r}_2\\vert + } + \\right] - \\theta_0 + \\right)^2 + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + equilibrium : float + Equilibrium angle at which the energy associated with the + three-particle angular bond vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient. + + See also + -------- + Bond : + Two-particle bond type dataclass + """ + + atom_3: str
+ + +
[docs]@dataclass +class Dihedral: + """Dataclass representing a single four-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any four-particle torsional bond between particles of specific types + :code:`A`, :code:`B`, :code:`C`, and :code:`D` (where :code:`A`, :code:`B`, + :code:`C`, and :code:`D` may be different or the same). Dihedral + four-particle bonds in HyMD take different forms depending on the + :code:`dih_type` parameter. + + In the following, let :math:`\\phi` denote the angle between the planes + spanned by the relative positions of atoms :code:`A`-:code:`B`-:code:`C` + and :code:`B`-:code:`C`-:code:`D`. If :code:`dih_type = 0`, then + + .. math:: + + V_4(\\phi) = \\sum_n c_n + \\left( + 1 + \\cos\\left[ + n\\phi - d_n + \\right] + \\right), + + where :math:`c_n` are energy coefficients and :math:`d_n` are propensity + phases. By default, the cosine sum is truncated at five terms. If + :code:`coeffs` provides only a single float, this is used as the coiling + propensity parameter :math:`\\lambda`. In this case, :math:`c_n` and + :math:`d_n` are automatically set to values which promote alpha helical + (:math:`\\lambda=-1`), beta sheet (:math:`\\lambda=1`), or a mixed + (:math:`1>\\lambda>-1`) structure (using values provided by Bore et al. + (2018)). In this case, the full potential takes the form + + .. math:: + + V_4(\\phi;\\lambda) = + \\frac{1}{2}(1-\\lambda) V_{\\text{prop},\\alpha}(\\phi) + + + \\frac{1}{2}(1+\\lambda) V_{\\text{prop},\\beta}(\\phi) + + + (1-\\vert\\lambda\\vert) V_{\\text{prop}, \\text{coil}}(\\phi), + + with each of the :math:`V_{\\mathrm{prop}, X}` being fixed cosine series + potentials with pre-set :math:`c_n` -s and :math:`d_n` -s. + + If :code:`dih_type = 1`, then a combined bending torsional (CBT) potential + is employed, + + .. math:: + + V_4(\\phi,\\gamma;\\lambda) = + V_4(\\phi;\\lambda) + + + \\frac{1}{2}K(\\phi)(\\gamma - \\gamma_0)^2, + + where :math:`V_4(\\phi;\\lambda)` specifies the potential as given by the + coiling propensity parameter above, :math:`K(\\phi)` is a separate cosine + series potential acting as the angular three-particle bond strength, and + :math:`\\gamma_0` is the three-particle bond equilibrium angle. In this + case, the :code:`coeffs` parameter must specify *both* a :math:`\\lambda` + value, in additon to the energy and phases dictating the :math:`K(\\phi)` + potential. + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + atom_4 : str + Type name of particle 4. + coeffs : list[list[float]] or list[float] or numpy.ndarray + Dihedral coefficients defining the series expansion of the dihedral + energy. + dih_type : int + Specifies the type of dihedral used; If :code:`0`, then :code:`coeffs` + must contain **either** two lists of five energy coefficients + :math:`c_n` and five propensity phases :math:`d_n` **or** a single + floating point number defining the :math:`\\lambda` coiling propensity + parameter. If :code:`1`, the combined bending-torsional potential is + used, and :code:`coeffs` must specify :math:`\\lambda` *and* two lists + containing energy coefficients and propensity phases for the + :math:`V_\\text{prop}` propensity potential, defined in terms of cosine + series. + + References + ---------- + Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018. + """ + + atom_1: str + atom_2: str + atom_3: str + atom_4: str + coeffs: np.ndarray + dih_type: int
+ + +
[docs]@dataclass +class Chi: + """Dataclass representing a single :math:`\\chi` mixing interaction type + + An `interaction mixing energy type` is a mixing energy associated with + density overlap between species of types :code:`A` and :code:`B` + (specified as inputs :code:`atom_1` and :code:`atom_2`). A positive mixing + energy promotes phase separation, a negative mixing energy promotes mixing. + The interaction energy density (provided the :code:`DefaultWithChi` + Hamiltonian is used) takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} + \\sum_{k,l}\\chi_{k,l} \\tilde\\phi_k\\tilde\\phi_l, + + where :math:`\\chi_{k,l}` denotes the mixing energy between species + :math:`k` and :math:`l`, with :math:`\\kappa` being the incompressibility. + The value of the interaction mixing energy parameter may be extracted from + `Flory-Huggins theory`_. + + .. _`Flory-Huggins theory`: + https://en.wikipedia.org/wiki/Flory%E2%80%93Huggins_solution_theory + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + interaction_energy : float + Interaction mixing energy. + + See also + -------- + hymd.hamiltonian.DefaultWithChi : + Interaction energy functional using :math:`\\chi`-interactions. + """ + + atom_1: str + atom_2: str + interaction_energy: float
+ + +
[docs]def find_all_paths(G, u, n): + """Helper function that recursively finds all paths of given lenght 'n + 1' inside a network 'G'. + Adapted from https://stackoverflow.com/a/28103735.""" + if n == 0: + return [[u]] + paths = [] + for neighbor in G.neighbors(u): + for path in find_all_paths(G, neighbor, n - 1): + if u not in path: + paths.append([u] + path) + return paths
+ + +
[docs]def propensity_potential_coeffs(x: float): + alpha_coeffs = np.array( + [ + [7.406, -5.298, -2.570, 1.336, 0.739], + [-0.28632126, 1.2099146, 1.18122138, 0.49075168, 0.98495911], + ] + ) + beta_coeffs = np.array( + [ + [3.770, 5.929, -4.151, -0.846, 0.190], + [-0.2300693, -0.0583289, 0.99342396, 1.03237971, 2.90160988], + ] + ) + coil_coeffs = np.array( + [ + [1.416, -0.739, 0.990, -0.397, 0.136], + [1.3495933, 0.45649087, 2.30441057, -0.12274901, -0.26179939], + ] + ) + + zero_add = np.zeros((2, 5)) + if np.isclose(x, -1): + return np.concatenate((alpha_coeffs, zero_add)) + elif np.isclose(x, 0): + return np.concatenate((coil_coeffs, zero_add)) + elif np.isclose(x, 1): + return np.concatenate((beta_coeffs, zero_add)) + + abs_x = np.abs(x) + if abs_x > 1: + err_str = ( + f"The provided value of lambda = {x} is out of lambda definition range, " + f"[-1.0, 1.0]." + ) + Logger.rank0.log(logging.ERROR, err_str) + else: + coil_coeffs[0] *= 1 - abs_x + if x < 0: + alpha_coeffs[0] *= 0.5 * (abs_x - x) + return np.concatenate((alpha_coeffs, coil_coeffs)) + else: + beta_coeffs[0] *= 0.5 * (abs_x + x) + return np.concatenate((beta_coeffs, coil_coeffs))
+ + +
[docs]def prepare_bonds_old(molecules, names, bonds, indices, config): + """Find bonded interactions from connectivity and bond types information + + .. deprecated:: 1.0.0 + :code:`prepare_bonds_old` was replaced by :code:`prepare_bonds` for + use with compiled Fortran kernels prior to 1.0.0 release. + + Prepares the necessary equilibrium and bond strength information needed by + the intramolecular interaction functions. This is performed locally on each + MPI rank, as the domain decomposition ensures that for all molecules *all* + consituent particles are always contained on *the same* MPI rankself. + + This function traverses the bond connectivity information provided in the + structure/topology input file and indentifies any two-, three-, or + four-particle potential bonds. For each connected chain of two, three, or + four particles, a matching to bond types is attempted. If the corresponding + names match, a bond object is initialized. + + In order to investigate the connectivity, a graph is created using + networkx functionality. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2 : list + List of lists containing *local* particle indices, equilibrium + distance, and bond strength coefficient for each reconstructed + two-particle bond. + bonds_3 : + List of lists containing *local* particle indices, equilibrium angle, + and bond strength coefficient for each reconstructed three-particle + bond. + bonds_4 : + List of lists containing *local* particle indices, dihedral type index, + and dihedral coefficients for each reconstructed four-particle + torsional bond. + bb_index : list + List indicating the dihedral type of each four-particle bond in + :code:`bonds_4`. + + See also + -------- + Bond : + Two-particle bond type dataclass. + Angle : + Three-particle angular bond type dataclass. + Dihedral : + Four-particle torsional bond type dataclass. + hymd.input_parser.Config + Configuration dataclass handler. + """ + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + bb_index = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + bb_dihedral = 0 + bond_graph = nx.Graph() + + for local_index, global_index in enumerate(indices): + if molecules[local_index] != mol: + continue + + bond_graph.add_node( + global_index, + name=names[local_index].decode("UTF-8"), + local_index=local_index, + ) + for bond in [b for b in bonds[local_index] if b != -1]: + bond_graph.add_edge(global_index, bond) + + connectivity = nx.all_pairs_shortest_path(bond_graph) + for c in connectivity: + i = c[0] + connected = c[1] + for j, path in connected.items(): + if len(path) == 2 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for b in config.bonds: + match_forward = name_i == b.atom_1 and name_j == b.atom_2 + match_backward = name_i == b.atom_2 and name_j == b.atom_1 + if match_forward or match_backward: + bonds_2.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[j]["local_index"], + b.equilibrium, + b.strength, + ] + ) + + if len(path) == 3 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_mid = bond_graph.nodes()[path[1]]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for a in config.angle_bonds: + match_forward = ( + name_i == a.atom_1 + and name_mid == a.atom_2 + and name_j == a.atom_3 + ) + match_backward = ( + name_i == a.atom_3 + and name_mid == a.atom_2 + and name_j == a.atom_1 + ) + if match_forward or match_backward: + bonds_3.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[path[1]]["local_index"], + bond_graph.nodes()[j]["local_index"], + np.radians(a.equilibrium), + a.strength, + ] + ) + + all_paths_len_four = find_all_paths(bond_graph, i, 3) + for p in all_paths_len_four: + name_i = bond_graph.nodes()[i]["name"] + name_mid_1 = bond_graph.nodes()[p[1]]["name"] + name_mid_2 = bond_graph.nodes()[p[2]]["name"] + name_j = bond_graph.nodes()[p[3]]["name"] + + for a in config.dihedrals: + match_forward = ( + name_i == a.atom_1 + and name_mid_1 == a.atom_2 + and name_mid_2 == a.atom_3 + and name_j == a.atom_4 + ) + if ( + match_forward + and [ + bond_graph.nodes()[p[3]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[i]["local_index"], + a.coeffs, + a.dih_type, + ] + not in bonds_4 + ): + bonds_4.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[3]]["local_index"], + a.coeffs, + a.dih_type, + ] + ) + if a.dih_type == 1: + bb_dihedral = len(bonds_4) + + if bb_dihedral: + bb_index.append(bb_dihedral - 1) + + return bonds_2, bonds_3, bonds_4, bb_index
+ + +
[docs]def prepare_index_based_bonds(molecules, topol): + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + resid = mol + 1 + top_summary = topol["system"]["molecules"] + resname = None + test_mol_number = 0 + for molname in top_summary: + test_mol_number += molname[1] + if resid <= test_mol_number: + resname = molname[0] + break + + if resname is None: + break + + if "bonds" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for bond in topol[resname]["bonds"]: + index_i = bond[0] - 1 + first_id + index_j = bond[1] - 1 + first_id + # bond[2] is the bond type, inherited by the itp format. Not used + equilibrium = bond[3] + strength = bond[4] + bonds_2.append([index_i, index_j, equilibrium, strength]) + + if "angles" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["angles"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + # angle[3] is the angle type, inherited by the itp format. Not used + equilibrium = np.radians(angle[4]) + strength = angle[5] + bonds_3.append([index_i, index_j, index_k, equilibrium, strength]) + + if "dihedrals" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["dihedrals"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + index_l = angle[3] - 1 + first_id + dih_type = angle[4] + coeff = angle[5] + if dih_type == 0 and isinstance(coeff[0], (float, int)): + coeff = propensity_potential_coeffs(coeff[0]) + elif dih_type == 1 and len(coeff) == 3: + coeff = np.array( + propensity_potential_coeffs(coeff[0][0]).tolist() + + coeff[1:] + ) + elif dih_type == 2: + coeff = np.array(coeff) + else: + coeff = np.insert(np.array(coeff), 2, np.zeros((2, 5)), axis=0) + bonds_4.append([index_i, index_j, index_k, index_l, coeff, dih_type, 0]) + return bonds_2, bonds_3, bonds_4
+ + +
[docs]def prepare_bonds(molecules, names, bonds, indices, config, topol=None): + """Rearrange the bond information for usage in compiled Fortran kernels + + Restructures the lists resulting from the execution of + :code:`prepare_bonds_old` into numpy arrays suitable for calls to optimized + Fortran code calculating bonded forces and energiesself. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2_atom_1 : (B,) numpy.ndarray + Local index of particle 1 for each of :code:`B` constructed + two-particle bonds. + bonds_2_atom_2 : (B,) numpy.ndarray + Local index of particle 2 for each of :code:`B` constructed + two-particle bonds. + bonds_2_equilibrium : (B,) numpy.ndarray + Equilibrium distance for each of :code:`B` constructed two-particle + bonds. + bonds_2_strength : (B,) numpy.ndarray + Bond strength for each of :code:`B` constructed two-particle + bonds. + bonds_3_atom_1 : (A,) numpy.ndarray + Local index of particle 1 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_2 : (A,) numpy.ndarray + Local index of particle 2 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_3 : (A,) numpy.ndarray + Local index of particle 3 for each of :code:`A` constructed + three-particle bonds. + bonds_3_equilibrium : (A,) numpy.ndarray + Equilibrium angle for each of :code:`A` constructed three-particle + bonds. + bonds_3_strength : (A,) numpy.ndarray + Bond strength for each of :code:`A` constructed three-particle + bonds. + bonds_4_atom_1 : (D,) numpy.ndarray + Local index of particle 1 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_2 : (D,) numpy.ndarray + Local index of particle 2 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_3 : (D,) numpy.ndarray + Local index of particle 3 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_4 : (D,) numpy.ndarray + Local index of particle 4 for each of :code:`D` constructed + four-particle bonds. + bonds_4_coeff : (D,) numpy.ndarray + Cosine series coefficients for each of :code:`D` constructed + four-particle bonds. + bonds_4_type : (D,) numpy.ndarray + Dihedral type for each of :code:`D` constructed four-particle + bonds. + bonds_4_last : (D,) numpy.ndarray + Flags indicating if :code:`dih_type` is :code:`1` for each of :code:`D` + constructed four-particle bonds. + + See also + -------- + prepare_bonds_old : + Used internally to reconstruct the bonded interactions types from the + connectivity information in the structure/topology input file and the + bonded types specified in the configuration file. + """ + if topol is not None: + bonds_2, bonds_3, bonds_4 = prepare_index_based_bonds( + molecules, topol + ) + else: + bonds_2, bonds_3, bonds_4, bb_index = prepare_bonds_old( + molecules, names, bonds, indices, config + ) + + # Bonds + bonds_2_atom1 = np.empty(len(bonds_2), dtype=int) + bonds_2_atom2 = np.empty(len(bonds_2), dtype=int) + bonds_2_equilibrium = np.empty(len(bonds_2), dtype=np.float64) + bonds_2_strength = np.empty(len(bonds_2), dtype=np.float64) + for i, b in enumerate(bonds_2): + bonds_2_atom1[i] = b[0] + bonds_2_atom2[i] = b[1] + bonds_2_equilibrium[i] = b[2] + bonds_2_strength[i] = b[3] + + # Angles + bonds_3_atom1 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom2 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom3 = np.empty(len(bonds_3), dtype=int) + bonds_3_equilibrium = np.empty(len(bonds_3), dtype=np.float64) + bonds_3_strength = np.empty(len(bonds_3), dtype=np.float64) + for i, b in enumerate(bonds_3): + bonds_3_atom1[i] = b[0] + bonds_3_atom2[i] = b[1] + bonds_3_atom3[i] = b[2] + bonds_3_equilibrium[i] = b[3] + bonds_3_strength[i] = b[4] + # Dihedrals + bonds_4_atom1 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom2 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom3 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom4 = np.empty(len(bonds_4), dtype=int) + number_of_coeff = 6 + len_of_coeff = 5 + bonds_4_coeff = np.empty( + (len(bonds_4), number_of_coeff, len_of_coeff), dtype=np.float64 + ) + bonds_4_type = np.empty(len(bonds_4), dtype=int) + bonds_4_last = np.zeros(len(bonds_4), dtype=int) + for i, b in enumerate(bonds_4): + bonds_4_atom1[i] = b[0] + bonds_4_atom2[i] = b[1] + bonds_4_atom3[i] = b[2] + bonds_4_atom4[i] = b[3] + bonds_4_coeff[i] = np.resize(b[4], (number_of_coeff, len_of_coeff)) + bonds_4_type[i] = b[5] + if topol is not None: + bonds_4_last[i] = b[6] + if topol is None: + bonds_4_last[bb_index] = 1 + + return ( + bonds_2_atom1, + bonds_2_atom2, + bonds_2_equilibrium, + bonds_2_strength, + bonds_3_atom1, + bonds_3_atom2, + bonds_3_atom3, + bonds_3_equilibrium, + bonds_3_strength, # noqa: E501 + bonds_4_atom1, + bonds_4_atom2, + bonds_4_atom3, + bonds_4_atom4, + bonds_4_coeff, + bonds_4_type, + bonds_4_last, # noqa: E501 + )
+ + +
[docs]def compute_bond_forces__plain(f_bonds, r, bonds_2, box_size): + """Computes forces resulting from bonded interactions + + .. deprecated:: 1.0.0 + :code:`compute_bond_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_bonds.fill(0.0) + energy = 0.0 + + for i, j, r0, k in bonds_2: + ri = r[i, :] + rj = r[j, :] + rij = rj - ri + + # Apply periodic boundary conditions to the distance rij + for dim in range(len(rij)): + rij[dim] -= box_size[dim] * np.around(rij[dim] / box_size[dim]) + dr = np.linalg.norm(rij) + df = -k * (dr - r0) + f_bond_vector = df * rij / dr + f_bonds[i, :] -= f_bond_vector + f_bonds[j, :] += f_bond_vector + + energy += 0.5 * k * (dr - r0) ** 2 + return energy
+ + +
[docs]def compute_angle_forces__plain(f_angles, r, bonds_3, box_size): + """Computes forces resulting from angular interactions + + .. deprecated:: 1.0.0 + :code:`compute_angle_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_angles.fill(0.0) + energy = 0.0 + + for a, b, c, theta0, k in bonds_3: + ra = r[a, :] - r[b, :] + rc = r[c, :] - r[b, :] + + for dim in range(len(ra)): + ra[dim] -= box_size[dim] * np.around(ra[dim] / box_size[dim]) + rc[dim] -= box_size[dim] * np.around(rc[dim] / box_size[dim]) + + xra = 1.0 / np.sqrt(np.dot(ra, ra)) + xrc = 1.0 / np.sqrt(np.dot(rc, rc)) + ea = ra * xra + ec = rc * xrc + + cosphi = np.dot(ea, ec) + theta = np.arccos(cosphi) + xsinph = 1.0 / np.sqrt(1.0 - cosphi**2) + + d = theta - theta0 + f = -k * d + + xrasin = xra * xsinph * f + xrcsin = xrc * xsinph * f + + fa = (ea * cosphi - ec) * xrasin + fc = (ec * cosphi - ea) * xrcsin + + f_angles[a, :] += fa + f_angles[c, :] += fc + f_angles[b, :] -= fa + fc + # f_angles[b, :] += -(fa + fc) + + energy -= 0.5 * f * d + + return energy
+ + +
[docs]def compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size): + """Computes forces resulting from dihedral interactions + + .. deprecated:: 1.0.0 + :code:`compute_dihedral_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_dihedrals.fill(0.0) + energy = 0.0 + + for a, b, c, d, coeffs, phase in bonds_4: + f = r[a, :] - r[b, :] + g = r[b, :] - r[c, :] + h = r[d, :] - r[c, :] + + for dim in range(3): + f -= box_size[dim] * np.around(f[dim] / box_size[dim]) + g -= box_size[dim] * np.around(g[dim] / box_size[dim]) + h -= box_size[dim] * np.around(h[dim] / box_size[dim]) + + v = np.cross(f, g) + w = np.cross(h, g) + vv = np.dot(v, v) + ww = np.dot(w, w) + gn = np.linalg.norm(g) + + cosphi = np.dot(v, w) + sinphi = np.dot(np.cross(v, w), g) / gn + phi = np.arctan2(sinphi, cosphi) + + fg = np.dot(f, g) + hg = np.dot(h, g) + sc = v * fg / (vv * gn) - w * hg / (ww * gn) + + df = 0 + + for m in range(len(coeffs[0])): + energy += coeffs[0][m] * (1 + np.cos(m * phi - coeffs[1][m])) + df += m * coeffs[0][m] * np.sin(m * phi - coeffs[1][m]) + + force_on_a = df * gn * v / vv + force_on_d = df * gn * w / ww + + f_dihedrals[a, :] -= force_on_a + f_dihedrals[b, :] += df * sc + force_on_a + f_dihedrals[c, :] -= df * sc + force_on_d + f_dihedrals[d, :] += force_on_d + return energy
+ + +
[docs]def dipole_forces_redistribution( + f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb +): + """Redistribute electrostatic forces calculated from topologically + reconstructed ghost dipole point charges to the backcone atoms of the protein. + """ + f_on_bead.fill(0.0) + for i, j, k, l, fd, matrix, dih_type, is_last in zip( + a, b, c, d, f_dipoles, trans_matrices, type_array, last_bb + ): + if dih_type == 1: + sum_force = fd[0] + fd[1] + diff_force = fd[0] - fd[1] + f_on_bead[i] += matrix[0] @ diff_force # Atom A + f_on_bead[j] += matrix[1] @ diff_force + 0.5 * sum_force # Atom B + f_on_bead[k] += matrix[2] @ diff_force + 0.5 * sum_force # Atom C + + if is_last == 1: + sum_force = fd[2] + fd[3] + diff_force = fd[2] - fd[3] + f_on_bead[j] += matrix[3] @ diff_force + f_on_bead[k] += matrix[4] @ diff_force + 0.5 * sum_force + f_on_bead[l] += matrix[5] @ diff_force + 0.5 * sum_force
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/_modules/hymd/hamiltonian.html b/v1.0.9/_modules/hymd/hamiltonian.html new file mode 100644 index 00000000..51311523 --- /dev/null +++ b/v1.0.9/_modules/hymd/hamiltonian.html @@ -0,0 +1,787 @@ + + + + + + hymd.hamiltonian — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.hamiltonian

+"""Interaction energy functionals.
+
+Implements field--particle interaction energy functionals depending on the
+field configuration. Extending HyMD with a new Hamiltonian is done by
+subclassing the :code:`Hamiltonian` superclass with logic intialized in the
+constructor.
+
+The grid-independent filtering function is defined in the :code:`Hamiltonian`
+superclass constructor. Hijack :code:`self.H` in a subclass to change the
+filter.
+"""
+import numpy as np
+import sympy
+
+
+
[docs]class Hamiltonian: + """Interaction energy functional superclass""" + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + self.config = config + self._setup()
+ +
[docs] def _setup(self): + """Superclass setup + + Sets up the grid-independent filtering function :code:`H`, and the + SymPy logic for symbolically differentiating interaction energy + functionals in Hamiltonian subclasses. + """ + if not hasattr(self.config, "simulation_volume"): + self.config.simulation_volume = np.prod(np.asarray(self.config.box_size)) + if not self.config.barostat: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.config.a = self.config.rho0 + if not self.config.rho0: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.phi = sympy.var("phi:%d" % (self.config.n_types)) + k = sympy.var("k:%d" % (3)) + + # electrostatics variables + self.psi = sympy.var("psi") + self.phi_q = sympy.var("phi_q") + if not self.config.self_energy: + self.config.self_energy = 0.0 + + def fourier_space_window_function(k): + return sympy.functions.elementary.exponential.exp( + -0.5 + * self.config.sigma**2 + * (k0**2 + k1**2 + k2**2) # noqa: F821, E501 + ) + + self.window_function_lambda = sympy.lambdify( + [k], fourier_space_window_function(k) + ) + + def H(k, v): + return v * self.window_function_lambda(k) + + self.H = H
+ + +
[docs]class SquaredPhi(Hamiltonian): + """Simple squared density interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + \\sum_k \\tilde\\phi_k + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`rho_0` is the + average density of the fully homogenous system. Expressing the species + densities in terms of fluctuations from the average, + + .. math:: + + \\mathrm{d}\\tilde\\phi_k = \\rho_0 - \\tilde\\phi_k, + + it is evident that this interaction energy functional is a slight change of + the :code:`DefaultNoChi` Hamiltonian, as the expanded interaction energy + density becomes + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + 6\\rho_0\\left[ + \\sum_k \\mathrm{d}\\tilde\\phi_k + \\right] + + + 9\\rho_0^2 + + + \\sum_k \\mathrm{d}\\tilde\\phi_k^2 + + + \\prod_{k\\not=l} + \\mathrm{d}\\tilde\\phi_k \\mathrm{d}\\tilde\\phi_l + \\right), + + identical to :code:`DefaultNoChi` apart from a constant energy shift + :math:`9\\rho_0^2`(which does not impact dynamics) and the + :math:`\\rho_0`--:math:`\\mathrm{d}\\tilde\\phi_k` cross-terms. These + cross-terms constitute contributions to the energy linear in + :math:`\\mathrm{d}\\tilde\\phi_k` absent in :code:`DefaultNoChi`, which has + only quadratic terms present. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(SquaredPhi, self).__init__(config) + super(SquaredPhi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0): + return 0.5 / (kappa * rho0) * (sum(phi)) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + ): + V_incompressibility = 1 / (kappa * rho0) * sum(phi) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultNoChi(Hamiltonian): + """Incompressibility-only interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. The :code:`SquaredPhi` Hamiltonian implements a similar + functional with an additional linear term component depending on + + .. math:: + + \\mathmr{d}\\tilde\\phi_k = \\tilde\\phi_k - \\rho_0 + + and not :math:`\\mathrm{d}\\tilde\\phi_k^2`. No explicit inter-species + interaction is present apart from the indirect interaction through the + incompressibility. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + hymd.input_parser.Config : + Configuration dataclass handler. + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultNoChi, self).__init__(config) + super(DefaultNoChi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0, a=self.config.a): + return 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultWithChi(Hamiltonian): + """Incompressibility and :math:`\\chi`-interactions energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = + \\frac{1}{2\\rho_0} + \\sum_{k,l}\\chi_{kl} \\tilde\\phi_k \\tilde\\phi_l + + + \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. :math:`\\chi_{ij}` is the Flory-Huggins-like + inter-species mixing energy. + """ + +
[docs] def __init__(self, config, unique_names, type_to_name_map): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultWithChi, self).__init__(config) + super(DefaultWithChi, self)._setup() + self.setup(unique_names, type_to_name_map)
+ +
[docs] def setup(self, unique_names, type_to_name_map): + """Setup the interaction energy potential and the external potential + + Parameters + ---------- + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + """ + self.type_to_name_map = type_to_name_map + self.chi_type_dictionary = { + tuple(sorted([c.atom_1, c.atom_2])): c.interaction_energy + for c in self.config.chi + } + self.phi_laplacian = [ + sympy.var("phi_laplacian%d(0:%d)" % (t, 3)) + for t in range(self.config.n_types) + ] + + def w( + phi, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + interaction = 0.0 + for i in range(self.config.n_types): + for j in range(i + 1, self.config.n_types): + ni = type_to_name_map[i] + nj = type_to_name_map[j] + names = sorted([ni, nj]) + c = chi_type_dictionary[tuple(names)] + + interaction += c * phi[i] * phi[j] / rho0 + incompressibility = 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + return incompressibility + interaction + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + t, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + + V_interaction = 0.0 + nk = type_to_name_map[t] + for i in range(self.config.n_types): + ni = type_to_name_map[i] + names = sorted([nk, ni]) + if ni != nk: + c = chi_type_dictionary[tuple(names)] + else: + c = 0.0 + # uncomment to count diagonal chi terms: + # c = chi_type_dictionary[tuple(names)] + V_interaction += c * phi[i] / rho0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[t])) + for t in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +def get_hamiltonian(config): + """Return appropriate Hamiltonian object based on the + config.hamiltonian string. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ---------- + hamiltonian : Hamiltonian + Hamiltonian object. + """ + if config.hamiltonian.lower() == "defaultnochi": + hamiltonian = DefaultNoChi(config) + elif config.hamiltonian.lower() == "defaultwithchi": + hamiltonian = DefaultWithChi( + config, config.unique_names, config.type_to_name_map + ) + elif config.hamiltonian.lower() == "squaredphi": + hamiltonian = SquaredPhi(config) + + return hamiltonian +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/_modules/hymd/input_parser.html b/v1.0.9/_modules/hymd/input_parser.html new file mode 100644 index 00000000..3f4219f9 --- /dev/null +++ b/v1.0.9/_modules/hymd/input_parser.html @@ -0,0 +1,1625 @@ + + + + + + hymd.input_parser — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.input_parser

+"""Parses and handles the configuration information provided for the simulation
+"""
+import copy
+import tomli
+import datetime
+import logging
+import warnings
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass, field
+from typing import List, Union, ClassVar
+from .force import Bond, Angle, Dihedral, Chi, Dielectric_type, propensity_potential_coeffs
+from .barostat import Target_pressure
+from .logger import Logger
+
+
+
[docs]@dataclass +class Config: + """Configuration object + + Handles and verifies the simulation configuration specified in the + configuration file. + + Attributes + ---------- + gas_constant : float + Constant value of the gas constant, R (equivalently the Boltzmann + constant) in the units used internally in HyMD. + coulomb_constant : float + Constant value of the Coulomb constant which converts electric field + values to forces and electric potential values to energies in the units + used internally in HyMD. + n_steps: int + Number of time steps in the simulation. + time_step: float + *Outer* time step used in the simulation. If the rRESPA intergrator is + used, the *inner* time step (the time step used in the integration of + intramolecular bending, stretching, and torsional forces) is + :code:`time_step / respa_inner`. + box_size : list[float] or (D,) numpy.ndarray + Simulation box size of simulation in :code:`D` dimensions in units of + nanometers. + mesh_size : list[int] or int or numpy.ndarray + Number of grid points used for the discrete density grid. + sigma : float + Filter width representing the effective coarse-graining level of the + particles in the simulation. + kappa : float + Compressibility parameter used in the relaxed incompressibility term in + the interaction energy functional. + n_print : int, optional + Frequency of trajectory/energy output to the H5MD trajectory/energy + output file (in units of number of time steps). + tau : float, optional + The time scale of the CSVR thermostat coupling. + start_temperature : float, optional + Generate starting temperature by assigning all particle velocities + randomly according to the Maxwell-Boltzmann distribution at + :code:`start_temperature` Kelvin prior to starting the simulation. + target_temperature : float, optional + Couple the system to a heat bath at :code:`target_temperature` Kelvin. + mass : float, optional + Mass of the particles in the simulation. + hamiltonian : str, optional + Specifies the interaction energy functional :math:`W[\\tilde\\phi]` + for use with the particle-field interactions. Options: + :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`. + domain_decomposition : int, optional + Specifies the interval (in time steps) of domain decomposition + exchange, involving all MPI ranks sending and receiving particles + according to the particles’ positions in the integration box and the + MPI ranks’ assigned domain. + integrator : str, optional + Specifies the time integrator used in the simulation. Options: + :code:`velocity-verlet` or :code:`respa`. + respa_inner : int, optional + The number of inner time steps in the rRESPA integrator. This denotes + the number of intramolecular force calculations (stretching, bending, + torsional) are performed between each impulse applied from the field + forces. + file_name : str, optional + File path of the parsed configuration file. + name : str, optional + Name for the simulation. + tags : list[str], optional + Tags for the simulation. + bonds : list[Bond], optional + Specifies harmonic stretching potentials between particles in the + same molecule. + angle_bonds : list[Angle], optional + Specifies harmonic angular bending potentials between particles in the + same molecule. + dihedrals : list[Dihedral], optional + Specifies four-particle torsional potentials by cosine series. + chi : list[Chi], optional + Specifies :math:`\\chi`-interaction parameters between particle + species. + n_particles : int, optional + Specifies the total number of particles in the input. Optional keyword + for validation, ensuring the input HDF5 topology has the correct number + of particles and molecules. + max_molecule_size : int, optional + Maximum size of any single molecule in the system. Used to speed up + distribution of particles onto MPI ranks in a parallel fashion. + n_flush : int, optional + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be + written to disk (in units of number of :code:`n_print`). + thermostat_work : float + Work performed by the thermostat on the system. + thermostat_coupling_groups : list[str], optional + Specifies individual groups coupling independently to the CSVR + thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and + :code:`"C"` type particles, + :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would + thermalise types :code:`"A"` and :code:`"B"` together and couple + :code:`"C"` type particles to a different thermostat (all individual + thermostats are at the same temperature, i.e. target_temperature + Kelvin). + initial_energy : float + Value of the total energy prior to the start of the simulation. + cancel_com_momentum : int, optional + If :code:`True`, the total linear momentum of the center of mass is + removed before starting the simulation. If an integer is specifed, the + total linear momentum of the center of mass is removed every + :code:`remove_com_momentum` time steps. If :code:`False`, the linear + momentum is never removed. + coulombtype : str, optional + Specifies the type of electrostatic Coulomb interactions in the system. + The strength of the electrostatic forces is modulated by the relative + dielectric constant of the simulation medium, specified with the + :code:`dielectric_const` keyword. Charges for individual particles are + specified in the structure/topology HDF5 input file, not in the + configuration file. If no charges (or peptide backbone dipoles) are + present, the electrostatic forces will not be calculated even if this + keyword is set to :code:`"PIC_Spectral"`. + dielectric_const : float, optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. When + using helical propensity dihedrals, this keyword must be specified—even + if electrostatics are not included with the :code:`coulombtype` + keyword. + dielectric_type: list[float], optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. The list assigns + relative dielectric values to each bead type, and an anisotropic + dielectric function is obtained from a weighted average. + + + See also + -------- + hymd.input_parser.Bond : + Two-particle bond type dataclass. + hymd.input_parser.Angle : + Three-particle bond type dataclass. + hymd.input_parser.Dihedral : + Four-particle bond type dataclass. + """ + + gas_constant: ClassVar[float] = 0.0083144621 # kJ mol-1 K-1 + coulomb_constant: ClassVar[float] = 138.935458 # kJ nm mol-1 e-2 + + n_steps: int + time_step: float + mesh_size: Union[Union[List[int], np.ndarray], int] + sigma: float + kappa: float + + dtype: np.dtype = None + box_size: Union[List[float], np.ndarray] = None + n_print: int = None + tau: float = None + start_temperature: Union[float, bool] = None + target_temperature: Union[float, bool] = None + mass: float = None + hamiltonian: str = None + domain_decomposition: Union[int, bool] = None + integrator: str = None + respa_inner: int = 1 + file_name: str = "<config file path unknown>" + name: str = None + tags: List[str] = field(default_factory=list) + bonds: List[Bond] = field(default_factory=list) + angle_bonds: List[Angle] = field(default_factory=list) + dihedrals: List[Dihedral] = field(default_factory=list) + chi: List[Chi] = field(default_factory=list) + n_particles: int = None + max_molecule_size: int = None + n_flush: int = None + thermostat_work: float = 0.0 + thermostat_coupling_groups: List[List[str]] = field(default_factory=list) + initial_energy: float = None + cancel_com_momentum: Union[int, bool] = False + coulombtype: str = None + convergence_type: str = None + pol_mixing: float = None + dielectric_const: float = None + conv_crit: float = None + dielectric_type: List[Dielectric_type] = field(default_factory=list) + self_energy: float = None + type_charges: Union[List[float], np.ndarray] = None + + # For NPT runs + rho0: float = None + a: float = None + pressure: bool = False + barostat: str = None + barostat_type: str = None + tau_p: float = None + target_pressure: List[Target_pressure] = field(default_factory=list) + n_b: int = None + m: List[float] = field(default_factory=list) + + def __str__(self): + target_pressure_str = "\ttarget_pressure:\n" + "".join( + "\t\tP_L: " + + f"{self.target_pressure.P_L}\n" + + "\t\tP_N: " + + f"{self.target_pressure.P_N}\n" + ) + bonds_str = "\tbonds:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " f"{k.equilibrium}, {k.strength}\n") + for k in self.bonds + ] + ) + angle_str = "\tangle_bonds:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3}: " + + f"{k.equilibrium}, {k.strength}\n" + ) + for k in self.angle_bonds + ] + ) + dihedrals_str = "\tdihedrals:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: " + # This might need to be fixed/made prettier, probably + # there's an easier way + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ).join( + map( + str, + [ + [round(num, 3) for num in c_in] + if isinstance(c_in, list) + else c_in + for c_in in k.coeffs + ], + ) + ) + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ) + + f"dih_type = {k.dih_type}\n" + ) + for k in self.dihedrals + ] + ) + chi_str = "\tchi:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " + f"{k.interaction_energy}\n") + for k in self.chi + ] + ) + + """ If dielectric wanted as dictionary + dielectric_type_str = "\tdielectric_type:\n" + "".join( + [ + (f"\t\t{k.atom_1}: " + f"{k.dielectric_value}\n") + for k in self.dielectric_type + ] + ) + + """ + + thermostat_coupling_groups_str = "" + if any(self.thermostat_coupling_groups): + thermostat_coupling_groups_str = ( + "\tthermostat_coupling_groups:\n" + + "".join( + [ + "\t\t" + ", ".join([f"{n}" for n in ng]) + "\n" + for ng in self.thermostat_coupling_groups + ] + ) + ) + + ret_str = f'\n\n\tConfig: {self.file_name}\n\t{50 * "-"}\n' + for k, v in self.__dict__.items(): + if k not in ( + "target_pressure", + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "thermostat_coupling_groups", + ): + ret_str += f"\t{k}: {v}\n" + ret_str += ( + target_pressure_str + + bonds_str + + angle_str + + dihedrals_str + + chi_str + + thermostat_coupling_groups_str + ) + return ret_str
+ + +
[docs]def read_config_toml(file_path): + with open(file_path, "r") as in_file: + file_content = in_file.read() + return file_content
+ +
[docs]def parse_config_toml(toml_content, file_path=None, comm=MPI.COMM_WORLD): + config_dict = {} + + # read toml to a dictionary + toml_content = tomli.loads(toml_content) + + # Defaults = None + for n in ( + "box_size", + "n_print", + "tau", + "start_temperature", + "target_temperature", + "mass", + "hamiltonian", + "domain_decomposition", + "integrator", + "name", + "n_particles", + "max_molecule_size", + "coulombtype", + "convergence_type", + "dielectric_const", + "pol_mixing", + "conv_crit", + "dielectric_type", + "n_b", + "box_size", + "n_flush", + "self_energy", + "dtype", + ): + config_dict[n] = None + + # Defaults = [] + + for n in ( + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "tags", + "m", + "dielectric_type", + "target_pressure", + "type_charges", + ): + config_dict[n] = [] + + # Defaults: bool + config_dict["pressure"] = False + + # Flatten the .toml dictionary, ignoring the top level [tag] directives (if + # any). + for k, v in toml_content.items(): + if isinstance(v, dict): + if k == "nn": # Don't parse diff-hymd optimization options + continue + for nested_k, nested_v in v.items(): + config_dict[nested_k] = nested_v + else: + config_dict[k] = v + for k, v in config_dict.items(): + if k == "bonds": + config_dict["bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["bonds"][i] = Bond( + atom_1=b[0], + atom_2=b[1], + equilibrium=b[2], + strength=b[3], + ) + if k == "angle_bonds": + config_dict["angle_bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["angle_bonds"][i] = Angle( + atom_1=b[0], + atom_2=b[1], + atom_3=b[2], + equilibrium=b[3], + strength=b[4], + ) + if k == "dihedrals": + config_dict["dihedrals"] = [None] * len(v) + for i, b in enumerate(v): + try: + dih_type = int(b[2][0]) + except IndexError: + Logger.rank0.log( + logging.WARNING, "Dihedral type not provided, defaulting to 0." + ) + dih_type = 0 + + # Probably it's better to move this in check_dihedrals? + wrong_len = len(b[1]) not in (1, 2) + wrong_type_1 = len(b[1]) == 1 and not isinstance(b[1][0], float) + wrong_type_2 = len(b[1]) == 2 and not isinstance(b[1][0], list) + if wrong_len or wrong_type_1 or wrong_type_2: + err_str = ( + "The coefficients specified for the dihedral type " + "(0) do not match the correct structure. Either " + "use [lambda] or [[cn_prop], [dn_prop]], or select" + " the correct dihedral type." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise RuntimeError(err_str) + + # FIXME: this is messy af, I don't like it + if dih_type == 0 and isinstance(b[1][0], (float, int)): + coeff = propensity_potential_coeffs(b[1][0]) + elif dih_type == 1 and len(b[1]) == 3: + coeff = np.array( + propensity_potential_coeffs(b[1][0][0]).tolist() + + b[1][1:] + ) + elif dih_type == 2: + coeff = np.array(b[1]) + else: + coeff = np.insert(np.array(b[1]), 2, np.zeros((2, 5)), axis=0) + + config_dict["dihedrals"][i] = Dihedral( + atom_1=b[0][0], + atom_2=b[0][1], + atom_3=b[0][2], + atom_4=b[0][3], + coeffs=coeff, + dih_type=dih_type, + ) + if k == "chi": + config_dict["chi"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0], c[1]]) + config_dict["chi"][i] = Chi( + atom_1=c_[0], atom_2=c_[1], interaction_energy=c[2] + ) + + """ + if k == "dielectric_type": + config_dict["dielectric_type"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0][0]]) + config_dict["dielectric_type"][i] = Dielectric_type( + atom_1=c_[0], dielectric_value=c[1][0] + ) + """ + if k == "target_pressure": + if len(v) == 2: + config_dict["target_pressure"] = Target_pressure( + P_L=v[0], + P_N=v[1], # check condition # V array (still read as array?) + ) + elif len(v) == 1: + config_dict["target_pressure"] = Target_pressure(P_L=v[0], P_N=None) + else: + config_dict["target_pressure"] = Target_pressure(P_L=None, P_N=None) + + if file_path is not None: + config_dict["file_name"] = file_path + + for n in ( + "n_steps", "time_step", "mesh_size", "sigma", "kappa" + ): + if n not in config_dict: + err_str = ( + f"No {n} specified in config file {file_path}. Unable to start" + f" simulation." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return Config(**config_dict)
+ + +
[docs]def check_n_particles(config, indices, comm=MPI.COMM_WORLD): + n_particles = comm.allreduce(len(indices), MPI.SUM) + if config.n_particles is None: + config = copy.deepcopy(config) + config.n_particles = n_particles + info_str = ( + f"No n_particles found in toml file {config.file_name}, defaulting" + f" to indices.shape ({n_particles})" + ) + Logger.rank0.log(logging.INFO, info_str) + return config + + if n_particles != config.n_particles: + warn_str = ( + f"n_particles in {config.file_name} ({config.n_particles}) does " + "not match the shape of the indices array in the .HDF5 file " + f"({n_particles}). Defaulting to using indices.shape " + f"({n_particles})" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.n_particles = n_particles + return config
+ + +
[docs]def check_max_molecule_size(config, comm=MPI.COMM_WORLD): + if config.max_molecule_size is None: + info_str = ( + f"No max_molecule_size found in toml file {config.file_name}, " + f"defaulting to 201" + ) + Logger.rank0.log(logging.INFO, info_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + + if config.max_molecule_size < 1: + warn_str = ( + f"max_molecule_size in {config.file_name} must be a positive " + f"integer, not {config.max_molecule_size}, defaulting to 201" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + return config
+ + +def _find_unique_names(config, names, comm=MPI.COMM_WORLD): + unique_names = np.unique(names) + receive_buffer = comm.gather(unique_names, root=0) + + gathered_unique_names = None + if comm.Get_rank() == 0: + gathered_unique_names = np.unique(np.concatenate(receive_buffer)) + unique_names = comm.bcast(gathered_unique_names, root=0) + unique_names = sorted([n.decode("UTF-8") for n in unique_names]) + config.unique_names = unique_names + config.n_types = len(unique_names) + return config + + +def _setup_type_to_name_map(config, names, types, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + name_to_type_ = {} + for n, t in zip(names, types): + n = n.decode("utf-8") + if n not in name_to_type_: + name_to_type_[n] = t + receive_buffer = comm.gather(name_to_type_, root=0) + gathered_dict = None + if comm.Get_rank() == 0: + gathered_dict = {} + for d in receive_buffer: + for k, v in d.items(): + if k not in gathered_dict: + gathered_dict[k] = v + else: + assert v == gathered_dict[k] + name_to_type_map = comm.bcast(gathered_dict, root=0) + config.name_to_type_map = name_to_type_map + config.type_to_name_map = {v: k for k, v in name_to_type_map.items()} + return config + + +
[docs]def check_bonds(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for b in config.bonds: + if b.atom_1 not in unique_names or b.atom_2 not in unique_names: + missing_str = "" + if b.atom_1 not in unique_names: + if b.atom_2 not in unique_names: + if b.atom_1 == b.atom_2: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"neither {b.atom_1}, {b.atom_2} atoms" + else: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"no {b.atom_2} atoms" + + warn_str = ( + f"Bond type {b.atom_1}--{b.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_angles(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for a in config.angle_bonds: + if ( + a.atom_1 not in unique_names + or a.atom_2 not in unique_names + or a.atom_3 not in unique_names + ): + missing = [ + a.atom_1 not in unique_names, + a.atom_2 not in unique_names, + a.atom_3 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([a.atom_1, a.atom_2, a.atom_3]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Angle bond type {a.atom_1}--{a.atom_2}--{a.atom_3} " + f"specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_dihedrals(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for d in config.dihedrals: + if ( + d.atom_1 not in unique_names + or d.atom_2 not in unique_names + or d.atom_3 not in unique_names + or d.atom_4 not in unique_names + ): + missing = [ + d.atom_1 not in unique_names, + d.atom_2 not in unique_names, + d.atom_3 not in unique_names, + d.atom_4 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([d.atom_1, d.atom_2, d.atom_3, d.atom_4]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Dihedral type {d.atom_1}--{d.atom_2}--{d.atom_3}--{d.atom_4}" + f" specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_chi(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for c in config.chi: + if c.atom_1 not in unique_names or c.atom_2 not in unique_names: + missing_str = "" + if c.atom_1 not in unique_names: + if c.atom_2 not in unique_names: + if c.atom_1 == c.atom_2: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"neither {c.atom_1}, {c.atom_2} atoms" + else: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"no {c.atom_2} atoms" + + warn_str = ( + f"Chi interaction {c.atom_1}--{c.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + for i, n in enumerate(unique_names): + for m in unique_names[i + 1 :]: + found = False + for c in config.chi: + if (c.atom_1 == n and c.atom_2 == m) or ( + c.atom_1 == m and c.atom_2 == n + ): + found = True + if not found: + config.chi.append(Chi(atom_1=n, atom_2=m, interaction_energy=0.0)) + warn_str = ( + f"Atom types {n} and {m} found in the " + f"system, but no chi interaction {n}--{m} " + f"specified in {config.file_name}. Defaulting to " + f"chi[{n}, {m}] = 0" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_box_size(config, input_box, comm=MPI.COMM_WORLD): + if config.box_size is not None: + config.box_size = np.array(config.box_size, dtype=np.float32) + if input_box.all() and not np.allclose(config.box_size, input_box, atol=0.009): + err_str = ( + f"Box size specified in {config.file_name}: " + f"{config.box_size} does not match input box:" + f"{input_box}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + else: + if input_box.all(): + config.box_size = input_box + else: + err_str = f"No box information found" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + for b in config.box_size: + if b <= 0.0: + err_str = ( + f"Invalid box size specified in {config.file_name}: " + f"{config.box_size}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return config
+ + +
[docs]def check_integrator(config, comm=MPI.COMM_WORLD): + if config.integrator.lower() not in ("velocity-verlet", "respa"): + err_str = ( + f"Invalid integrator specified in {config.file_name}: " + f'{config.integrator}. Available options "velocity-verlet" or ' + f'"respa".' + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + if config.integrator.lower() == "respa": + if isinstance(config.respa_inner, float): + warn_str = ( + f"Number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner} specified " + f"as float, using {int(config.respa_inner)}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = int(config.respa_inner) + elif not isinstance(config.respa_inner, int): + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + + if config.respa_inner <= 0: + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + if config.integrator.lower() == "velocity-verlet" and config.respa_inner != 1: + warn_str = ( + f"Integrator type Velocity-Verlet specified in {config.file_name} " + f"and inner rRESPA time steps set to {config.respa_inner}. " + f"Using respa_inner = 1" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = 1 + + return config
+ + +
[docs]def check_hamiltonian(config, comm=MPI.COMM_WORLD): + valid_hamiltonians = ["defaultnochi", "defaultwithchi", "squaredphi"] + + if config.hamiltonian is None: + if len(config.chi) == 0: + warn_str = ( + f"No hamiltonian form and no chi interactions specified in " + f"{config.file_name}, defaulting to DefaultNoChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultNoChi" + else: + warn_str = ( + f"No hamiltonian form specified in {config.file_name}, but " + f"chi interactions are specified, defaulting to " + f"DefaultWithChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultWithChi" + elif config.hamiltonian.lower() not in valid_hamiltonians: + err_str = ( + f"The specified Hamiltonian {config.hamiltonian} was not " + f"recognized as a valid Hamiltonian." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise NotImplementedError(err_str) + + return config
+ + +
[docs]def check_n_flush(config, comm=MPI.COMM_WORLD): + if config.n_print: + if config.n_flush is None: + config.n_flush = 10000 // config.n_print + return config
+ + +
[docs]def check_n_print(config, comm=MPI.COMM_WORLD): + if ( + not isinstance(config.n_print, int) + and not isinstance(config.n_print, float) + and config.n_print is not None + ): + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if config.n_print is None or config.n_print <= 0: + config.n_print = False + elif not isinstance(config.n_print, int): + if isinstance(config.n_print, float): + warn_str = ( + f"n_print is a float ({config.n_print}), not int, using " + f"{int(round(config.n_print))}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + config.n_print = int(round(config.n_print)) + else: + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + return config
+ + +
[docs]def check_tau(config, comm=MPI.COMM_WORLD): + if config.tau is None and config.target_temperature is not None: + warn_str = "target temp specified but no tau, defaulting 0.7" + config.tau = 0.7 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_start_and_target_temperature(config, comm=MPI.COMM_WORLD): + """Validate provided starting and target thermostat temperatures + + Assesses the provided temperature target and ensures it is a non-negative + floating point number or :code:`False`. Ensures the starting temperature is + a non-negative floating point number or :code:`False`. + + If the value for either is :code:`None`, the returned configuration object + has the values defaulted to :code:`False` in each case. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ------- + validated_config : Config + Configuration object with validated :code:`target_temperature` and + :code:`start_temperature`. + """ + for t in ("start_temperature", "target_temperature"): + if getattr(config, t) is not None: + try: + if getattr(config, t) < 0: + warn_str = ( + f"{t} set to negative value ({getattr(config, t)}), " + f"defaulting to False" + ) + setattr(config, t, False) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + except TypeError as e: + err_str = ( + f"Could not interpret {t} = {repr(getattr(config, t))} as " + f"a number." + ) + raise TypeError(err_str) from e + + if config.start_temperature is None: + config.start_temperature = False + if config.target_temperature is None: + config.target_temperature = False + return config
+ + +
[docs]def check_mass(config, comm=MPI.COMM_WORLD): + if config.mass is None: + info_str = "no mass specified, defaulting to 72.0" + config.mass = 72.0 + Logger.rank0.log(logging.INFO, info_str) + elif not isinstance(config.mass, int) and not isinstance(config.mass, float): + err_str = ( + f"specified mass is invalid type {config.mass}, " f"({type(config.mass)})" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + elif config.mass < 0: + err_str = f"invalid mass specified, {config.mass}" + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + else: + config.mass = float(config.mass) + + return config
+ + +
[docs]def check_domain_decomposition(config, comm=MPI.COMM_WORLD): + dd = config.domain_decomposition + if dd is None or dd is False: + config.domain_decomposition = False + return config + + if isinstance(dd, int): + if dd < 0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + elif isinstance(dd, float): + if dd < 0.0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + else: + warn_str = ( + f"domain_decomposition ({config.domain_decomposition}) is not " + f"an integer, using {int(round(dd))}" + ) + config.domain_decomposition = int(round(dd)) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + else: + err_str = ( + f"invalid value for domain_decomposition " + f"({config.domain_decomposition}) use an integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + return config
+ + +
[docs]def check_name(config, comm=MPI.COMM_WORLD): + if config.name is None: + root_current_time = "" + if comm.Get_rank() == 0: + root_current_time = datetime.datetime.now().strftime("%m/%d/%Y, %H:%M:%S") + current_time = comm.bcast(root_current_time, root=0) + + if config.name is None: + config.name = "sim" + current_time + else: + config.name = str(config.name) + return config
+ + +
[docs]def check_NPT_conditions(config, comm=MPI.COMM_WORLD): + """ + Check validity of barostat_type, barostat, + a, rho0, target_pressure, tau_p + """ + if config.barostat is None: + if ( + config.tau_p is not None + or (config.target_pressure.P_L and config.target_pressure.P_N) is not None + ): + err_str = ( + "barostat not specified but config.tau_p " + "or config.target_pressure specified, cannot start simulation {config.barostat}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.a: + warn_str = "a specified but no barostat," "setting a to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.rho0: + warn_str = ( + "rho0 specified but no barostat," "setting rho0 to average density" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + if config.barostat is not None: + if not config.barostat_type: + config.barostat_type = "berendsen" + warn_str = "barostat_type not specified," "setting to berendsen" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.barostat != "isotropic" and config.barostat != "semiisotropic": + err_str = "barostat option not recognised. Valid options: isotropic, semiisotropic" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.target_pressure.P_L is None: + config.target_pressure.P_L = 1.0 # bar + config.target_pressure.P_N = None + if config.barostat == "semiisotropic": + config.target_pressure.P_N = 1.0 # bar + warn_str = ( + "barostat specified but no target_pressure, defaulting to 1.0 bar" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.tau_p is None: + if config.tau <= 0.1: + config.tau_p = config.tau * 10.0 + else: + config.tau_p = 1.0 + warn_str = "barostat specified but no tau_p, defaulting to " + str( + config.tau_p + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if not config.a: + err_str = "a not specified; cannot start simulation {config.a}" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if not config.rho0: + warn_str = "rho0 not specified;" "setting rho0 to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + return config
+ + +
[docs]def check_thermostat_coupling_groups(config, comm=MPI.COMM_WORLD): + if any(config.thermostat_coupling_groups): + found = [0 for _ in config.unique_names] + unique_names = [n for n in config.unique_names] + for i, group in enumerate(config.thermostat_coupling_groups): + for species in group: + try: + ind = unique_names.index(species) + found[ind] += 1 + except ValueError as e: + err_str = ( + f"Particle species {species} specified in thermostat " + f"coupling group {i}, but no {species} particles were " + "found in the system." + ) + raise ValueError(err_str) from e + if any([True if f > 1 else False for f in found]): + for i, f in enumerate(found): + if f > 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} specified in multiple " + "thermostat coupling groups; " + f"{config.thermostat_coupling_groups}." + ) + raise ValueError(err_str) + if not all([True if f == 1 else False for f in found]): + for i, f in enumerate(found): + if f != 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} not specified in any " + f"thermostat coupling group, but {species} particles " + "were found in the system" + ) + raise ValueError(err_str) + return config
+ + +
[docs]def check_m(config, comm=MPI.COMM_WORLD): + if config.m == []: + config.m = [1.0 for t in range(config.n_types)] + return config
+ + +
[docs]def check_n_b(config, comm=MPI.COMM_WORLD): + if config.n_b is None: + warn_str = f"config.n_b not specified." "Defaulting to 1" + config.n_b = 1 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_cancel_com_momentum(config, comm=MPI.COMM_WORLD): + if isinstance(config.cancel_com_momentum, int): + if config.cancel_com_momentum == 0 or config.cancel_com_momentum < 0: + config.cancel_com_momentum = False + elif not isinstance(config.cancel_com_momentum, bool): + err_str = ( + f"Could not interpret {config.cancel_com_momentum} as an integer " + f"or boolean." + ) + raise ValueError(err_str) + return config
+ + +
[docs]def sort_dielectric_by_type_id(config, charges, types): + """ + Creates a list of length N CG-particles, sorted after the charges from + the input HDF5 file. Used in file_io.py + """ + dielectric_val = np.zeros(config.n_types) + for j in range(config.n_types): + name = config.dielectric_type[j][0][0] + type_id = config.name_to_type_map[name] + dielectric_val[type_id] = config.dielectric_type[j][1][0] + config.dielectric_type = dielectric_val.copy() + + N = len(charges) + len_list = np.zeros(config.n_types) + dielectric_by_types = np.zeros(N) + for i in range(N): + dielectric_by_types[i] = dielectric_val[types[i]] + # print("types ", types) + # print("diel val", dielectric_by_types) + # print("charges", charges) + # print(config.name_to_type_map) + return dielectric_by_types # by types with each particle id
+ + +
[docs]def check_charges_types_list(config, types, charges, comm=MPI.COMM_WORLD): + """ + Creates a list of charge values of length types. + Charges are sorted according to type ID. Used in field.py. + # TODO: this is messy, we should fix it + """ + if charges is None: + config.type_charges = [0.0] * config.n_types + return config + + check_val = -100.0 # some random value that will never be encountered + charges_list = np.full(config.n_types, check_val) # gatherv cant handle None + rank = comm.Get_rank() + # print(charges_list) + for t_ in range(config.n_types): + if t_ in types: + charges_list[t_] = charges[types == t_][0] + + nprocs = int(comm.Get_size()) + recv_charges = None + if rank == 0: + recv_charges = np.full( + config.n_types * nprocs, check_val + ) # gatherv cant handle None + comm.Gather(charges_list, recv_charges, root=0) + + ## make a charges list + if rank == 0: + config_charges = np.zeros(config.n_types) + test_config = np.full(config.n_types, check_val) + for j in range(nprocs): + for i in range(config.n_types): + if recv_charges[i + j * config.n_types] != check_val: + config_charges[i] = recv_charges[i + j * config.n_types] + if np.any([test_config, config_charges]): + continue + else: + break + + # print(config_charges) + # print(config.name_to_type_map) + # print(charges[types == 0][0],charges[types == 1][0],charges[types == 2][0],charges[types == 3][0], + # charges[types == 4][0]) + else: + config_charges = np.zeros(config.n_types) + + comm.Bcast(config_charges, root=0) + # print("config_charges", config_charges , "rank", rank) + # print(recv_charges) + # rank = comm.Get_rank() + # print(all_charges) + config.type_charges = config_charges + return config
+ + +
[docs]def check_dielectric(config, comm=MPI.COMM_WORLD): + """ + Error handling for electrostatics. + Unit testing of toml/tomli input. + """ + err_str_const = "Dielectric constant not given." + if config.coulombtype == "PIC_Spectral": + assert config.dielectric_const != None, err_str_const + + err_str = "Dielectric list is empty." + if config.coulombtype == "PIC_Spectral_GPE": + assert len(config.dielectric_type) != 0, err_str + # default values + if config.pol_mixing is None: + config.pol_mixing = 0.6 + if config.conv_crit is None: + config.conv_crit = 1e-6 + return config
+ + +
[docs]def check_charges(config, charges, comm=MPI.COMM_WORLD): + """Check if charges across ranks sum to zero. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of floats with charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + """ + total_charge = comm.allreduce(np.sum(charges), MPI.SUM) + + if not np.isclose(total_charge, 0.0): + warn_str = ( + f"Charges in the input file do not sum to zero. " + f"Total charge is {total_charge}." + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + # if charges are ok, compute self energy + if config.coulombtype == "PIC_Spectral": + from .field import compute_self_energy_q + + config.self_energy = compute_self_energy_q(config, charges, comm=comm) + + return config
+ + +
[docs]def check_config( + config, indices, names, types, charges, input_box, comm=MPI.COMM_WORLD +): + """Performs various checks on the specfied config to ensure consistency + + Parameters + ---------- + config : Config + Configuration object. + indices : (N,) numpy.ndarray + Array of integer indices for :code:`N` particles. + names : (N,) numpy.ndarray + Array of string names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of integer type indices for :code:`N` particles. + charges : (N,) numpy.ndarray + Array of floats charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + + Returns + ------- + config : Config + Validated configuration object. + """ + config = _find_unique_names(config, names, comm=comm) + if types is not None: + config = _setup_type_to_name_map(config, names, types, comm=comm) + config = check_box_size(config, input_box, comm=comm) + config = check_integrator(config, comm=comm) + config = check_max_molecule_size(config, comm=comm) + config = check_tau(config, comm=comm) + config = check_start_and_target_temperature(config, comm=comm) + config = check_mass(config, comm=comm) + config = check_domain_decomposition(config, comm=comm) + config = check_name(config, comm=comm) + config = check_n_particles(config, indices, comm=comm) + config = check_chi(config, names, comm=comm) + config = check_bonds(config, names, comm=comm) + config = check_angles(config, names, comm=comm) + config = check_dihedrals(config, names, comm=comm) + config = check_hamiltonian(config, comm=comm) + config = check_NPT_conditions(config, comm=comm) + config = check_n_b(config, comm=comm) + config = check_m(config, comm=comm) + config = check_thermostat_coupling_groups(config, comm=comm) + config = check_cancel_com_momentum(config, comm=comm) + config = check_dielectric(config, comm=comm) + config = check_n_print(config, comm=comm) + config = check_n_flush(config, comm=comm) + config = check_charges_types_list(config, types, charges, comm=comm) + if charges is not None: + config = check_charges(config, charges, comm=comm) + + return config
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/_modules/hymd/integrator.html b/v1.0.9/_modules/hymd/integrator.html new file mode 100644 index 00000000..932017e3 --- /dev/null +++ b/v1.0.9/_modules/hymd/integrator.html @@ -0,0 +1,348 @@ + + + + + + hymd.integrator — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.integrator

+"""Integrates equations of motion.
+
+Implements the Velocity Verlet integrator. The *reversible reference system
+propagator algorithm* (rRESPA) integrator uses the Velocity Verlet functions
+inside the MD loop in the main module.
+"""
+
+
+
[docs]def integrate_velocity(velocities, accelerations, time_step): + """Velocity update step of the Velocity Verlet integration algorithm. + + Computes the velocity update step of the Velocity Verlet algorithm. The + :code:`velocities` argument is **not** changed in place. + + Parameters + ---------- + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + accelerations : (N, D) numpy.ndarray + Array of accelerations of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step + + .. math:: \\mathbf{v}_{\\text{new}} = \\mathbf{v} + \\frac{\\Delta t}{2m} + \\mathbf{f} + + before the positions are moved a full step using the updated half-step + velocities. + + See Also + -------- + integrate_position : The position update step of the Velocity Verlet + algorithm. + """ + return velocities + 0.5 * time_step * accelerations
+ + +
[docs]def integrate_position(positions, velocities, time_step): + """Position update step of the Velocity Verlet integration algorithm. + + Computes the position update step of the Velocity Verlet algorithm. The + :code:`positions` argument is **not** changed in place. + + Parameters + ---------- + positions : (N, D) numpy.ndarray + Array of positions of :code:`N` particles in :code:`D` dimensions. + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step, then the positions are updated a full step using the updated + velocities + + .. math:: \\mathbf{x}_{\\text{new}} = \\mathbf{x} + \\Delta t \\mathbf{v} + + See Also + -------- + integrate_velocity : The velocity update step of the Velocity Verlet + algorithm. + """ + return positions + time_step * velocities
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/_modules/hymd/logger.html b/v1.0.9/_modules/hymd/logger.html new file mode 100644 index 00000000..b0d3701a --- /dev/null +++ b/v1.0.9/_modules/hymd/logger.html @@ -0,0 +1,537 @@ + + + + + + hymd.logger — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.logger

+"""Handles event logging for simulation information, warnings, and errors.
+"""
+import sys
+import os
+import logging
+from mpi4py import MPI
+from .version import __version__
+
+
+
[docs]class MPIFilterRoot(logging.Filter): + """Log output Filter wrapper class for the root MPI rank log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + if self.comm.Get_rank() == 0: + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True + else: + return False
+ + +
[docs]class MPIFilterAll(logging.Filter): + """Log output Filter wrapper class for the all-MPI-ranks log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True
+ + +class MPIFilterStdout(logging.Filter): + """Log output Filter wrapper class for filtering STDOUT log""" + + def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.funcName = "replica 0 " + record.funcName + if MPI.COMM_WORLD.Get_rank() == 0: + record.rank = MPI.COMM_WORLD.Get_rank() + record.size = MPI.COMM_WORLD.Get_size() + return True + else: + return False + + +
[docs]class Logger: + """Log output handler class + + Notes + ----- + This wraps the default python library :code:`logging`, see + `docs.python.org/3/library/logging.html`_. + + .. _`docs.python.org/3/library/logging.html`: + https://docs.python.org/3/library/logging.html + + Attributes + ---------- + level : int + Determines the verbosity level of the log, corresponding to + logging.level. Numerical values :code:`50` (:code:`logging.CRITICAL`), + :code:`40` (:code:`logging.ERROR`), :code:`30` + (:code:`logging.WARNING`), :code:`20` (:code:`logging.INFO`), + :code:`10` (:code:`logging.DEBUG`), and :code:`0` + (:code:`logging.UNSET`) are supported values. Any log event message + less severe than the specified level is ignored. All other event + messages are emitted. + log_file : str + Path to output log file. + format : str + Prepended dump string for each log event. Specifies the log event + level, the module emitting the event, the code line, the enclosing + function name, and the MPI rank writing the message. + date_format : str + Prepends the date before all log event messages. + formatter : logging.Formatter + Formatter handling the prepending of the information in `format` and + `date_format` to each log event message. Used by default for all + loggers. + rank0 : logging.Logger + Default logger object for the root MPI rank. + all_ranks : logging.Logger + Default logger object for messages being emitted from all MPI ranks + simultaneously. + """ + + level = None + log_file = None + format = " %(levelname)-8s [%(filename)s:%(lineno)d] <%(funcName)s> {rank %(rank)d/%(size)d} %(message)s" # noqa: E501 + date_format = "%(asctime)s" + formatter = logging.Formatter(fmt=date_format + format) + rank0 = logging.getLogger("HyMD.rank_0") + all_ranks = logging.getLogger("HyMD.all_ranks") + +
[docs] @classmethod + def setup(cls, default_level=logging.INFO, log_file=None, verbose=False, comm=MPI.COMM_WORLD): + """Sets up the logger object. + + If a :code:`log_file` path is provided, log event messages are output + to it. Otherwise, the logging messages are emitted to stdout. + + Parameters + ---------- + default_level : int, optional + Default verbosity level of the logger. Unless specified, it is + :code:`10` (:code:`logging.INFO`). + log_file : str, optional + Path to output log file. If `None` or not priovided, no log file is + used and all logging is done to stdout. + verbose : bool, optional + Increases the logging level to :code:`30` (:code:`logging.WARNING`) + if True, otherwise leaves the logging level unchanged. + """ + cls.level = default_level + cls.log_file = log_file + + log_to_stdout = False + if verbose: + log_to_stdout = True + + level = default_level + if not verbose: + level = logging.WARNING + cls.rank0.setLevel(level) + cls.all_ranks.setLevel(level) + + root_filter = MPIFilterRoot(comm) + all_filter = MPIFilterAll(comm) + cls.rank0.addFilter(root_filter) + cls.all_ranks.addFilter(all_filter) + + if (not log_file) and (not log_to_stdout): + return + if log_file: + cls.log_file_handler = logging.FileHandler(log_file) + cls.log_file_handler.setLevel(level) + cls.log_file_handler.setFormatter(cls.formatter) + + cls.rank0.addHandler(cls.log_file_handler) + cls.all_ranks.addHandler(cls.log_file_handler) + if log_to_stdout: + cls.log_to_stdout = True + cls.stdout_handler = logging.StreamHandler() + cls.stdout_handler.setLevel(level) + cls.stdout_handler.setStream(sys.stdout) + cls.stdout_handler.setFormatter(cls.formatter) + cls.stdout_handler.addFilter(MPIFilterStdout()) + + cls.rank0.addHandler(cls.stdout_handler) + cls.all_ranks.addHandler(cls.stdout_handler)
+ + +def format_timedelta(timedelta): + days = timedelta.days + hours, rem = divmod(timedelta.seconds, 3600) + minutes, seconds = divmod(rem, 60) + microseconds = timedelta.microseconds + ret_str = "" + if days != 0: + ret_str += f"{days} days " + ret_str += f"{hours:02d}:{minutes:02d}:{seconds:02d}.{microseconds:06d}" + return ret_str + + +def get_version(): + # Check if we are in a git repo and grab the commit hash and the branch if + # we are, append it to the version number in the output specification. + try: + import git + + try: + repo_dir = os.path.abspath( + os.path.join(os.path.dirname(__file__), os.pardir) + ) + repo = git.Repo(repo_dir) + commit = str(repo.head.commit)[:7] + branch = repo.active_branch + version = f"{__version__} [{branch} branch commit {commit}]" + except git.exc.InvalidGitRepositoryError: + version = f"{__version__}" + except ModuleNotFoundError: + version = f"{__version__}" + + return version + + +def print_header(): + banner = r""" + __ __ ____ __ _______ + / / / /_ __/ / /__ _________ _____ ______ / |/ / __ \ + / /_/ / / / / / / _ \/ ___/ __ `/ __ `/ ___/ / /|_/ / / / / + / __ / /_/ / / / __/ / / /_/ / /_/ (__ ) / / / / /_/ / + /_/ /_/\__, /_/_/\___/_/ \__,_/\__,_/____/ /_/ /_/_____/ + /____/ + """ + + refs_set = """ + + [1] Ledum, M.; Sen, S.; Li, X.; Carrer, M.; Feng Y.; Cascella, M.; Bore, S. L. + HylleraasMD: A Domain Decomposition-Based Hybrid Particle-Field Software for Multi-Scale Simulations of Soft Matter. + J. Chem. Theory Comput. 2023. + + [2] Ledum, M.; Carrer, M.; Sen, S.; Li, X.; Cascella, M.; Bore, S. L. + HyMD: Massively parallel hybrid particle-field molecular dynamics in Python. + J. Open Source Softw. 8(84), 4149, 2023. + + [3] Sen, S.; Ledum, M.; Bore, S. L.; Cascella, M. + Soft Matter under Pressure: Pushing Particle–Field Molecular Dynamics to the Isobaric Ensemble. + J Chem Inf Model 2023, 63(7), 1549-9596. + + [4] Bore, S. L.; Cascella, M. + Hamiltonian and alias-free hybrid particle–field molecular dynamics. + J. Chem. Phys. 2020, 153, 094106. + + [5] Pippig, M. PFFT: An extension of FFTW to massively parallel architectures. + SIAM J. Sci. Comput. 2013, 35, C213–C236. + +""" + + version = f"Version {get_version()}" + header = banner + header += version.center(56) + "\n\n" + #header += " Please read and cite the references below:" + header += " PLEASE READ AND CITE THE REFERENCES BELOW:" + header += refs_set + + return header +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/_modules/hymd/thermostat.html b/v1.0.9/_modules/hymd/thermostat.html new file mode 100644 index 00000000..dea7c6fe --- /dev/null +++ b/v1.0.9/_modules/hymd/thermostat.html @@ -0,0 +1,494 @@ + + + + + + hymd.thermostat — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.thermostat

+"""Scales or otherwise modifies the particle velocities during simulation to
+simulate coupling to an external heat bath with temperature T₀.
+"""
+import numpy as np
+import logging
+from mpi4py import MPI
+from typing import Callable
+from .logger import Logger
+from .input_parser import Config
+
+
+def cancel_com_momentum(velocities, config, comm=MPI.COMM_WORLD):
+    com_velocity = comm.allreduce(np.sum(velocities[...], axis=0), MPI.SUM)
+    velocities[...] = velocities[...] - com_velocity / config.n_particles
+    return velocities
+
+
+def generate_initial_velocities(velocities, config, prng, comm=MPI.COMM_WORLD):
+    kT_start = config.gas_constant * config.start_temperature
+    n_particles_ = velocities.shape[0]
+    velocities[...] = prng.normal(
+        loc=0, scale=kT_start / config.mass, size=(n_particles_, 3)
+    )
+    velocities = cancel_com_momentum(velocities, config, comm=comm)
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    start_kinetic_energy_target = (
+        1.5 * config.gas_constant * config.n_particles * config.start_temperature
+    )
+    factor = np.sqrt(1.5 * config.n_particles * kT_start / kinetic_energy)
+    velocities[...] = velocities[...] * factor
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    Logger.rank0.log(
+        logging.INFO,
+        (
+            f"Initialized {config.n_particles} velocities, target kinetic "
+            f"energy: {start_kinetic_energy_target}, actual kinetic energy "
+            f"generated: {kinetic_energy}"
+        ),
+    )
+    return velocities
+
+
+
[docs]def _random_gaussian(prng: np.random.Generator) -> float: + """Draw a single random number from the standard normal distribution + Generate a number from the Gaussian distribution centered at zero with unit + standard deviation, :math:`N(0, 1)`. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + + Returns + ------- + float + A random number drawn from :math:`N(0, 1)`. + """ + return prng.normal()
+ + +
[docs]def _random_chi_squared(prng: np.random.Generator, M: int) -> float: + """Draw the sum of :code:`M` squared normally distributed values + + The value is generated by the Gamma distribution, in lieu of generating + :code:`M` Gaussian distributed numbers and summing their squares. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + M : int + Number of standard normally distributed numbers in the sum. + + Returns + ------- + float + The sum of :code:`M` squared normally distributed values centered at + zero with unit standard deviation. + + Notes + ----- + The sum of the squares of k independent standard normal random variables is + distributed according to a :math:`\\chi^2` distribution. + + .. math:: + + \\chi^2_1 + \\chi_2^2 + \\chi_3^2 + \\dots + \\chi_M^2 + \\sim + \\sigma^2\\chi^2(k) + + This is a special case of the :math:`\\Gamma` distribution, + :math:`\\Gamma(k/2, 2)`, and may be generated by + + .. math:: + + \\chi^2(k) \\sim 2 \\Gamma(k/2, 2) + + References + ---------- + Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of + Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. + J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246. + """ + return prng.chisquare(M)
+ + +
[docs]def csvr_thermostat( + velocity: np.ndarray, + names: np.ndarray, + config: Config, + prng: np.random.Generator, + comm: MPI.Intracomm = MPI.COMM_WORLD, + random_gaussian: Callable[[np.random.Generator], float] = _random_gaussian, + random_chi_squared: Callable[ + [np.random.Generator, int, float], float + ] = _random_chi_squared, + remove_center_of_mass_momentum: bool = True, +) -> np.ndarray: + """Canonical sampling through velocity rescaling thermostat + + Implements the CSVR thermostat. Rescales the system kinetic energy by a + stochastically chosen factor to keep the temperature constant. Requires + communcation of the kinetic energies calculated locally for each MPI rank. + The random numbers sampled through :code:`random_gaussian` and + :code:`random_chi_squared` are broadcast from the root rank to the other + ranks to ensure the scaling is performed with the same stochasticity for + all particles in the full system. + + The velocities are cleaned of center of mass momentum before the thermostat + is applied, and the center of mass momentum is subsequently reapplied. This + is performed for each thermostat coupling group, i.e. the center of mass + momenta of each *group* is separately removed and reapplied after + thermostatting. + + The implementation here is based on the derivation presented in the 2008 + Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper. + + Parameters + ---------- + velocity : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + names : (N,) numpy.ndarray + Array of particle names. + config : Config + Configuration dataclass containing simulation metadata and parameters. + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + random_gaussian : callable, optional + Function for generating standard normally distributed numbers. + random_chi_squared : callable, optional + Function for generating :math:`\\chi^2`-distributed numbers + remove_center_of_mass_momentum : bool, optional + If True, the center of mass of each coupling group is removed before + the thermostat is applied. The center of mass momenta are added back + after the kinetic energy rescaling is complete. + + See Also + -------- + _random_gaussian : + Used to sample Gaussian-distributed numbers. + _random_chi_squared : + Used to sample :math:`\\chi^2`-distributed numbers. + hymd.input_parser.Config : + Configuration dataclass handler. + + References + ---------- + G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). + G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008). + """ + if not any(config.thermostat_coupling_groups): + config.thermostat_coupling_groups = [config.unique_names.copy()] + for i, group in enumerate(config.thermostat_coupling_groups): + ind = np.where( + np.logical_or.reduce(list(names == np.string_(t) for t in group)) + ) + group_n_particles = comm.allreduce(len(ind[0]), MPI.SUM) + + # Clean velocities of center of mass momentum + if remove_center_of_mass_momentum and group_n_particles > 1: + com_velocity = comm.allreduce(np.sum(velocity[ind], axis=0)) + velocity_clean = velocity[ind] - com_velocity / group_n_particles + K = comm.allreduce(0.5 * config.mass * np.sum(velocity_clean[...] ** 2)) + else: + K = comm.allreduce(0.5 * config.mass * np.sum(velocity[...] ** 2)) + K_target = ( + 1.5 * config.gas_constant * group_n_particles * config.target_temperature + ) + N_f = 3 * group_n_particles + c = np.exp(-(config.time_step * config.respa_inner) / config.tau) + + # Random numbers are identical across ranks because all ranks have + # the same prng after the initialization of the velocities + R = random_gaussian(prng) + SNf = random_chi_squared(prng, N_f - 1) + + alpha2 = ( + c + + (1 - c) * (SNf + R**2) * K_target / (N_f * K) + + 2 * R * np.sqrt(c * (1 - c) * K_target / (N_f * K)) + ) + dK = K * (alpha2 - 1) + alpha = np.sqrt(alpha2) + + if remove_center_of_mass_momentum and group_n_particles > 1: + # Assign velocities and reapply the previously removed center + # of mass momentum removed + velocity_clean *= alpha + velocity[ind] = velocity_clean + com_velocity / group_n_particles + else: + velocity *= alpha + config.thermostat_work += dK
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/_modules/index.html b/v1.0.9/_modules/index.html new file mode 100644 index 00000000..e237e7b1 --- /dev/null +++ b/v1.0.9/_modules/index.html @@ -0,0 +1,282 @@ + + + + + + Overview: module code — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+ +
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/v1.0.9/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css new file mode 100644 index 00000000..1b057df2 --- /dev/null +++ b/v1.0.9/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css @@ -0,0 +1 @@ +.badge{border-radius:.25rem;display:inline-block;font-size:75%;font-weight:700;line-height:1;padding:.25em .4em;text-align:center;vertical-align:baseline;white-space:nowrap}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{border-radius:10rem;padding-left:.6em;padding-right:.6em}.badge-primary{background-color:#007bff;color:#fff}.badge-primary[href]:focus,.badge-primary[href]:hover{background-color:#0062cc;color:#fff;text-decoration:none}.badge-secondary{background-color:#6c757d;color:#fff}.badge-secondary[href]:focus,.badge-secondary[href]:hover{background-color:#545b62;color:#fff;text-decoration:none}.badge-success{background-color:#28a745;color:#fff}.badge-success[href]:focus,.badge-success[href]:hover{background-color:#1e7e34;color:#fff;text-decoration:none}.badge-info{background-color:#17a2b8;color:#fff}.badge-info[href]:focus,.badge-info[href]:hover{background-color:#117a8b;color:#fff;text-decoration:none}.badge-warning{background-color:#ffc107;color:#212529}.badge-warning[href]:focus,.badge-warning[href]:hover{background-color:#d39e00;color:#212529;text-decoration:none}.badge-danger{background-color:#dc3545;color:#fff}.badge-danger[href]:focus,.badge-danger[href]:hover{background-color:#bd2130;color:#fff;text-decoration:none}.badge-light{background-color:#f8f9fa;color:#212529}.badge-light[href]:focus,.badge-light[href]:hover{background-color:#dae0e5;color:#212529;text-decoration:none}.badge-dark{background-color:#343a40;color:#fff}.badge-dark[href]:focus,.badge-dark[href]:hover{background-color:#1d2124;color:#fff;text-decoration:none}.border-0{border:0 !important}.border-top-0{border-top:0 !important}.border-right-0{border-right:0 !important}.border-bottom-0{border-bottom:0 !important}.border-left-0{border-left:0 !important}.p-0{padding:0 !important}.pt-0,.py-0{padding-top:0 !important}.pr-0,.px-0{padding-right:0 !important}.pb-0,.py-0{padding-bottom:0 !important}.pl-0,.px-0{padding-left:0 !important}.p-1{padding:.25rem !important}.pt-1,.py-1{padding-top:.25rem !important}.pr-1,.px-1{padding-right:.25rem !important}.pb-1,.py-1{padding-bottom:.25rem !important}.pl-1,.px-1{padding-left:.25rem !important}.p-2{padding:.5rem !important}.pt-2,.py-2{padding-top:.5rem !important}.pr-2,.px-2{padding-right:.5rem !important}.pb-2,.py-2{padding-bottom:.5rem !important}.pl-2,.px-2{padding-left:.5rem !important}.p-3{padding:1rem !important}.pt-3,.py-3{padding-top:1rem !important}.pr-3,.px-3{padding-right:1rem !important}.pb-3,.py-3{padding-bottom:1rem !important}.pl-3,.px-3{padding-left:1rem !important}.p-4{padding:1.5rem !important}.pt-4,.py-4{padding-top:1.5rem !important}.pr-4,.px-4{padding-right:1.5rem !important}.pb-4,.py-4{padding-bottom:1.5rem !important}.pl-4,.px-4{padding-left:1.5rem !important}.p-5{padding:3rem !important}.pt-5,.py-5{padding-top:3rem !important}.pr-5,.px-5{padding-right:3rem !important}.pb-5,.py-5{padding-bottom:3rem !important}.pl-5,.px-5{padding-left:3rem !important}.m-0{margin:0 !important}.mt-0,.my-0{margin-top:0 !important}.mr-0,.mx-0{margin-right:0 !important}.mb-0,.my-0{margin-bottom:0 !important}.ml-0,.mx-0{margin-left:0 !important}.m-1{margin:.25rem !important}.mt-1,.my-1{margin-top:.25rem !important}.mr-1,.mx-1{margin-right:.25rem !important}.mb-1,.my-1{margin-bottom:.25rem !important}.ml-1,.mx-1{margin-left:.25rem !important}.m-2{margin:.5rem !important}.mt-2,.my-2{margin-top:.5rem !important}.mr-2,.mx-2{margin-right:.5rem !important}.mb-2,.my-2{margin-bottom:.5rem !important}.ml-2,.mx-2{margin-left:.5rem !important}.m-3{margin:1rem !important}.mt-3,.my-3{margin-top:1rem !important}.mr-3,.mx-3{margin-right:1rem !important}.mb-3,.my-3{margin-bottom:1rem !important}.ml-3,.mx-3{margin-left:1rem !important}.m-4{margin:1.5rem !important}.mt-4,.my-4{margin-top:1.5rem !important}.mr-4,.mx-4{margin-right:1.5rem !important}.mb-4,.my-4{margin-bottom:1.5rem !important}.ml-4,.mx-4{margin-left:1.5rem !important}.m-5{margin:3rem !important}.mt-5,.my-5{margin-top:3rem !important}.mr-5,.mx-5{margin-right:3rem !important}.mb-5,.my-5{margin-bottom:3rem !important}.ml-5,.mx-5{margin-left:3rem !important}.btn{background-color:transparent;border:1px solid transparent;border-radius:.25rem;color:#212529;cursor:pointer;display:inline-block;font-size:1rem;font-weight:400;line-height:1.5;padding:.375rem .75rem;text-align:center;transition:color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none;vertical-align:middle}.btn:hover{color:#212529;text-decoration:none}.btn:visited{color:#212529}.btn.focus,.btn:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.25);outline:0}.btn.disabled,.btn:disabled{opacity:.65}@media (prefers-reduced-motion: reduce){.btn{transition:none}}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary:visited{color:#fff}.btn-primary:hover{background-color:#0069d9;border-color:#0062cc;color:#fff}.btn-primary.focus,.btn-primary:focus{background-color:#0069d9;border-color:#0062cc;box-shadow:0 0 0 .2rem rgba(0,123,255,0.5);color:#fff}.btn-primary.disabled,.btn-primary:disabled{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary.active:not(:disabled):not(.disabled),.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{background-color:#0062cc;border-color:#005cbf;color:#fff}.btn-primary.active:not(:disabled):not(.disabled):focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-secondary{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary:visited{color:#fff}.btn-secondary:hover{background-color:#5a6268;border-color:#545b62;color:#fff}.btn-secondary.focus,.btn-secondary:focus{background-color:#5a6268;border-color:#545b62;box-shadow:0 0 0 .2rem rgba(108,117,125,0.5);color:#fff}.btn-secondary.disabled,.btn-secondary:disabled{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled),.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{background-color:#545b62;border-color:#4e555b;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled):focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-success{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success:visited{color:#fff}.btn-success:hover{background-color:#218838;border-color:#1e7e34;color:#fff}.btn-success.focus,.btn-success:focus{background-color:#218838;border-color:#1e7e34;box-shadow:0 0 0 .2rem rgba(40,167,69,0.5);color:#fff}.btn-success.disabled,.btn-success:disabled{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success.active:not(:disabled):not(.disabled),.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{background-color:#1e7e34;border-color:#1c7430;color:#fff}.btn-success.active:not(:disabled):not(.disabled):focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-info{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info:visited{color:#fff}.btn-info:hover{background-color:#138496;border-color:#117a8b;color:#fff}.btn-info.focus,.btn-info:focus{background-color:#138496;border-color:#117a8b;box-shadow:0 0 0 .2rem rgba(23,162,184,0.5);color:#fff}.btn-info.disabled,.btn-info:disabled{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info.active:not(:disabled):not(.disabled),.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{background-color:#117a8b;border-color:#10707f;color:#fff}.btn-info.active:not(:disabled):not(.disabled):focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-warning{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning:visited{color:#212529}.btn-warning:hover{background-color:#e0a800;border-color:#d39e00;color:#212529}.btn-warning.focus,.btn-warning:focus{background-color:#e0a800;border-color:#d39e00;box-shadow:0 0 0 .2rem rgba(255,193,7,0.5);color:#212529}.btn-warning.disabled,.btn-warning:disabled{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning.active:not(:disabled):not(.disabled),.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{background-color:#d39e00;border-color:#c69500;color:#212529}.btn-warning.active:not(:disabled):not(.disabled):focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-danger{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger:visited{color:#fff}.btn-danger:hover{background-color:#c82333;border-color:#bd2130;color:#fff}.btn-danger.focus,.btn-danger:focus{background-color:#c82333;border-color:#bd2130;box-shadow:0 0 0 .2rem rgba(220,53,69,0.5);color:#fff}.btn-danger.disabled,.btn-danger:disabled{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger.active:not(:disabled):not(.disabled),.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{background-color:#bd2130;border-color:#b21f2d;color:#fff}.btn-danger.active:not(:disabled):not(.disabled):focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-light{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light:visited{color:#212529}.btn-light:hover{background-color:#e2e6ea;border-color:#dae0e5;color:#212529}.btn-light.focus,.btn-light:focus{background-color:#e2e6ea;border-color:#dae0e5;box-shadow:0 0 0 .2rem rgba(248,249,250,0.5);color:#212529}.btn-light.disabled,.btn-light:disabled{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light.active:not(:disabled):not(.disabled),.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{background-color:#dae0e5;border-color:#d3d9df;color:#212529}.btn-light.active:not(:disabled):not(.disabled):focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-dark{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark:visited{color:#fff}.btn-dark:hover{background-color:#23272b;border-color:#1d2124;color:#fff}.btn-dark.focus,.btn-dark:focus{background-color:#23272b;border-color:#1d2124;box-shadow:0 0 0 .2rem rgba(52,58,64,0.5);color:#fff}.btn-dark.disabled,.btn-dark:disabled{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark.active:not(:disabled):not(.disabled),.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{background-color:#1d2124;border-color:#171a1d;color:#fff}.btn-dark.active:not(:disabled):not(.disabled):focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-primary{border-color:#007bff;color:#007bff}.btn-outline-primary:visited{color:#007bff}.btn-outline-primary:hover{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{background-color:transparent;color:#007bff}.btn-outline-primary.active:not(:disabled):not(.disabled),.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.active:not(:disabled):not(.disabled):focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-secondary{border-color:#6c757d;color:#6c757d}.btn-outline-secondary:visited{color:#6c757d}.btn-outline-secondary:hover{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{background-color:transparent;color:#6c757d}.btn-outline-secondary.active:not(:disabled):not(.disabled),.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.active:not(:disabled):not(.disabled):focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-success{border-color:#28a745;color:#28a745}.btn-outline-success:visited{color:#28a745}.btn-outline-success:hover{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{background-color:transparent;color:#28a745}.btn-outline-success.active:not(:disabled):not(.disabled),.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.active:not(:disabled):not(.disabled):focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-info{border-color:#17a2b8;color:#17a2b8}.btn-outline-info:visited{color:#17a2b8}.btn-outline-info:hover{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{background-color:transparent;color:#17a2b8}.btn-outline-info.active:not(:disabled):not(.disabled),.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.active:not(:disabled):not(.disabled):focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-warning{border-color:#ffc107;color:#ffc107}.btn-outline-warning:visited{color:#ffc107}.btn-outline-warning:hover{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{background-color:transparent;color:#ffc107}.btn-outline-warning.active:not(:disabled):not(.disabled),.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.active:not(:disabled):not(.disabled):focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-danger{border-color:#dc3545;color:#dc3545}.btn-outline-danger:visited{color:#dc3545}.btn-outline-danger:hover{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{background-color:transparent;color:#dc3545}.btn-outline-danger.active:not(:disabled):not(.disabled),.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.active:not(:disabled):not(.disabled):focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-light{border-color:#f8f9fa;color:#f8f9fa}.btn-outline-light:visited{color:#f8f9fa}.btn-outline-light:hover{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{background-color:transparent;color:#f8f9fa}.btn-outline-light.active:not(:disabled):not(.disabled),.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.active:not(:disabled):not(.disabled):focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-dark{border-color:#343a40;color:#343a40}.btn-outline-dark:visited{color:#343a40}.btn-outline-dark:hover{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{background-color:transparent;color:#343a40}.btn-outline-dark.active:not(:disabled):not(.disabled),.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.active:not(:disabled):not(.disabled):focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-link{color:#007bff;font-weight:400;text-decoration:none}.btn-link:hover{color:#0056b3;text-decoration:underline}.btn-link.focus,.btn-link:focus{box-shadow:none;text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{border-radius:.3rem;font-size:1.25rem;line-height:1.5;padding:.5rem 1rem}.btn-group-sm>.btn,.btn-sm{border-radius:.2rem;font-size:.875rem;line-height:1.5;padding:.25rem .5rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input.btn-block[type=button],input.btn-block[type=reset],input.btn-block[type=submit]{width:100%}.stretched-link::after{background-color:rgba(0,0,0,0);bottom:0;content:'';left:0;pointer-events:auto;position:absolute;right:0;top:0;z-index:1}.text-wrap{white-space:normal !important}.card{background-clip:border-box;background-color:#fff;border:1px solid rgba(0,0,0,0.125);border-radius:.25rem;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;min-width:0;position:relative;word-wrap:break-word}.card>hr{margin-left:0;margin-right:0}.card>.list-group:first-child .list-group-item:first-child{border-top-left-radius:.25rem;border-top-right-radius:.25rem}.card>.list-group:last-child .list-group-item:last-child{border-bottom-left-radius:.25rem;border-bottom-right-radius:.25rem}.card-body{-ms-flex:1 1 auto;flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-bottom:0;margin-top:-.375rem}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{background-color:rgba(0,0,0,0.03);border-bottom:1px solid rgba(0,0,0,0.125);margin-bottom:0;padding:.75rem 1.25rem}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-header+.list-group .list-group-item:first-child{border-top:0}.card-footer{background-color:rgba(0,0,0,0.03);border-top:1px solid rgba(0,0,0,0.125);padding:.75rem 1.25rem}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{border-bottom:0;margin-bottom:-.75rem;margin-left:-.625rem;margin-right:-.625rem}.card-header-pills{margin-left:-.625rem;margin-right:-.625rem}.card-img-overlay{bottom:0;left:0;padding:1.25rem;position:absolute;right:0;top:0}.card-img,.card-img-bottom,.card-img-top{-ms-flex-negative:0;flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-left-radius:calc(.25rem - 1px);border-bottom-right-radius:calc(.25rem - 1px)}.w-100{width:100% !important}.shadow{box-shadow:0 0.5rem 1rem rgba(0,0,0,0.15) !important}.bg-primary{background-color:#007bff !important}button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc !important}a.bg-primary:focus,a.bg-primary:hover{background-color:#0062cc !important}a.text-primary:focus,a.text-primary:hover{color:#121416 !important}.bg-secondary{background-color:#6c757d !important}button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62 !important}a.bg-secondary:focus,a.bg-secondary:hover{background-color:#545b62 !important}a.text-secondary:focus,a.text-secondary:hover{color:#121416 !important}.bg-success{background-color:#28a745 !important}button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34 !important}a.bg-success:focus,a.bg-success:hover{background-color:#1e7e34 !important}a.text-success:focus,a.text-success:hover{color:#121416 !important}.bg-info{background-color:#17a2b8 !important}button.bg-info:focus,button.bg-info:hover{background-color:#117a8b !important}a.bg-info:focus,a.bg-info:hover{background-color:#117a8b !important}a.text-info:focus,a.text-info:hover{color:#121416 !important}.bg-warning{background-color:#ffc107 !important}button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00 !important}a.bg-warning:focus,a.bg-warning:hover{background-color:#d39e00 !important}a.text-warning:focus,a.text-warning:hover{color:#121416 !important}.bg-danger{background-color:#dc3545 !important}button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130 !important}a.bg-danger:focus,a.bg-danger:hover{background-color:#bd2130 !important}a.text-danger:focus,a.text-danger:hover{color:#121416 !important}.bg-light{background-color:#f8f9fa !important}button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5 !important}a.bg-light:focus,a.bg-light:hover{background-color:#dae0e5 !important}a.text-light:focus,a.text-light:hover{color:#121416 !important}.bg-dark{background-color:#343a40 !important}button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124 !important}a.bg-dark:focus,a.bg-dark:hover{background-color:#1d2124 !important}a.text-dark:focus,a.text-dark:hover{color:#121416 !important}.bg-white{background-color:#fff !important}button.bg-white:focus,button.bg-white:hover{background-color:#e6e6e6 !important}a.bg-white:focus,a.bg-white:hover{background-color:#e6e6e6 !important}a.text-white:focus,a.text-white:hover{color:#121416 !important}.text-primary{color:#007bff !important}.text-secondary{color:#6c757d !important}.text-success{color:#28a745 !important}.text-info{color:#17a2b8 !important}.text-warning{color:#ffc107 !important}.text-danger{color:#dc3545 !important}.text-light{color:#f8f9fa !important}.text-dark{color:#343a40 !important}.text-white{color:#fff !important}.text-body{color:#212529 !important}.text-muted{color:#6c757d !important}.text-black-50{color:rgba(0,0,0,0.5) !important}.text-white-50{color:rgba(255,255,255,0.5) !important}.bg-transparent{background-color:transparent !important}.text-justify{text-align:justify !important}.text-left{text-align:left !important}.text-right{text-align:right !important}.text-center{text-align:center !important}.font-weight-light{font-weight:300 !important}.font-weight-lighter{font-weight:lighter !important}.font-weight-normal{font-weight:400 !important}.font-weight-bold{font-weight:700 !important}.font-weight-bolder{font-weight:bolder !important}.font-italic{font-style:italic !important}.container{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container{max-width:540px}}@media (min-width: 768px){.container{max-width:720px}}@media (min-width: 992px){.container{max-width:960px}}@media (min-width: 1200px){.container{max-width:1140px}}.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container,.container-sm{max-width:540px}}@media (min-width: 768px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width: 992px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width: 1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1140px}}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;margin-right:-15px}.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{padding-left:15px;padding-right:15px;position:relative;width:100%}@media (min-width: 576px){.col-sm{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-sm-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-sm-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-sm-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-sm-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-sm-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 768px){.col-md{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-md-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-md-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-md-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-md-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-md-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 992px){.col-lg{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-lg-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-lg-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-lg-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-lg-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-lg-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 1200px){.col-xl{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-xl-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-xl-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-xl-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-xl-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-xl-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}.d-flex{display:-ms-flexbox !important;display:flex !important}.sphinx-bs,.sphinx-bs *{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sphinx-bs p{margin-top:0} diff --git a/v1.0.9/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/v1.0.9/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css new file mode 100644 index 00000000..fc14abc8 --- /dev/null +++ b/v1.0.9/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css @@ -0,0 +1 @@ +details.dropdown .summary-title{padding-right:3em !important;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none}details.dropdown:hover{cursor:pointer}details.dropdown .summary-content{cursor:default}details.dropdown summary{list-style:none;padding:1em}details.dropdown summary .octicon.no-title{vertical-align:middle}details.dropdown[open] summary .octicon.no-title{visibility:hidden}details.dropdown summary::-webkit-details-marker{display:none}details.dropdown summary:focus{outline:none}details.dropdown summary:hover .summary-up svg,details.dropdown summary:hover .summary-down svg{opacity:1}details.dropdown .summary-up svg,details.dropdown .summary-down svg{display:block;opacity:.6}details.dropdown .summary-up,details.dropdown .summary-down{pointer-events:none;position:absolute;right:1em;top:.75em}details.dropdown[open] .summary-down{visibility:hidden}details.dropdown:not([open]) .summary-up{visibility:hidden}details.dropdown.fade-in[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out;animation:panels-fade-in .5s ease-in-out}details.dropdown.fade-in-slide-down[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out}@keyframes panels-fade-in{0%{opacity:0}100%{opacity:1}}@keyframes panels-slide-down{0%{transform:translate(0, -10px)}100%{transform:translate(0, 0)}}.octicon{display:inline-block;fill:currentColor;vertical-align:text-top}.tabbed-content{box-shadow:0 -.0625rem var(--tabs-color-overline),0 .0625rem var(--tabs-color-underline);display:none;order:99;padding-bottom:.75rem;padding-top:.75rem;width:100%}.tabbed-content>:first-child{margin-top:0 !important}.tabbed-content>:last-child{margin-bottom:0 !important}.tabbed-content>.tabbed-set{margin:0}.tabbed-set{border-radius:.125rem;display:flex;flex-wrap:wrap;margin:1em 0;position:relative}.tabbed-set>input{opacity:0;position:absolute}.tabbed-set>input:checked+label{border-color:var(--tabs-color-label-active);color:var(--tabs-color-label-active)}.tabbed-set>input:checked+label+.tabbed-content{display:block}.tabbed-set>input:focus+label{outline-style:auto}.tabbed-set>input:not(.focus-visible)+label{outline:none;-webkit-tap-highlight-color:transparent}.tabbed-set>label{border-bottom:.125rem solid transparent;color:var(--tabs-color-label-inactive);cursor:pointer;font-size:var(--tabs-size-label);font-weight:700;padding:1em 1.25em .5em;transition:color 250ms;width:auto;z-index:1}html .tabbed-set>label:hover{color:var(--tabs-color-label-active)} diff --git a/v1.0.9/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css b/v1.0.9/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css new file mode 100644 index 00000000..adc61662 --- /dev/null +++ b/v1.0.9/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css @@ -0,0 +1,7 @@ +:root { +--tabs-color-label-active: hsla(231, 99%, 66%, 1); +--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); +--tabs-color-overline: rgb(207, 236, 238); +--tabs-color-underline: rgb(207, 236, 238); +--tabs-size-label: 1rem; +} \ No newline at end of file diff --git a/v1.0.9/_sources/doc_pages/api.rst.txt b/v1.0.9/_sources/doc_pages/api.rst.txt new file mode 100644 index 00000000..c9f8837b --- /dev/null +++ b/v1.0.9/_sources/doc_pages/api.rst.txt @@ -0,0 +1,90 @@ +.. _api-label: + + +API reference +============= + +Integrator +---------- + +.. automodule:: hymd.integrator + :members: + + +Thermostat +---------- + +.. automodule:: hymd.thermostat + :members: csvr_thermostat, _random_chi_squared, _random_gaussian + :undoc-members: + + +Hamiltonian +----------- + +.. autoclass:: hymd.hamiltonian.Hamiltonian + :members: + + .. automethod:: __init__ + + .. automethod:: _setup + +.. autoclass:: hymd.hamiltonian.SquaredPhi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultNoChi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultWithChi + :members: + + .. automethod:: __init__ + + +Force +----- + +.. automodule:: hymd.force + :members: + :undoc-members: + + +Logger +------ + +.. autoclass:: hymd.logger.Logger + :members: + +.. autoclass:: hymd.logger.MPIFilterRoot + :members: + +.. autoclass:: hymd.logger.MPIFilterAll + :members: + + +Input parser +------------ + +.. automodule:: hymd.input_parser + :members: + :undoc-members: propensity_potential_coeffs + + +Field +----- + +.. automodule:: hymd.field + :members: + + +File input/output +----------------- + +.. automodule:: hymd.file_io + :members: diff --git a/v1.0.9/_sources/doc_pages/benchmarks.rst.txt b/v1.0.9/_sources/doc_pages/benchmarks.rst.txt new file mode 100644 index 00000000..06377a85 --- /dev/null +++ b/v1.0.9/_sources/doc_pages/benchmarks.rst.txt @@ -0,0 +1,93 @@ +.. _benchmarks-label: + +Benchmarks +########## +Homopolymer melt test systems of :math:`30^2`, :math:`40^2`, and :math:`50^2` +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively. + +Bonded forces +^^^^^^^^^^^^^ +Legend label denotes the number of particles in the system. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) + time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 + ], dtype=np.float64) + nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 + ], dtype=np.float64,) + time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, + ], dtype=np.float64) + nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 + ], dtype=np.float64) + time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, + ], dtype=np.float64) + plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" + ) + plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" + ) + plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" + ) + plt.xlabel("CPUs", fontsize=15) + plt.ylabel("Time per step, us", fontsize=15) + plt.legend(fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.show() + + +Particle--field forces +^^^^^^^^^^^^^^^^^^^^^^ +Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + + mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] + mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + + mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + + mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + + mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] + mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + + mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + + mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + + plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") + plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") + plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") + plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") + plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") + plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") + plt.xlabel("CPUs", fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.ylabel("Time per step, s", fontsize=15) + plt.legend(loc="upper left", fontsize=15) + plt.show() diff --git a/v1.0.9/_sources/doc_pages/command_line.rst.txt b/v1.0.9/_sources/doc_pages/command_line.rst.txt new file mode 100644 index 00000000..5233710f --- /dev/null +++ b/v1.0.9/_sources/doc_pages/command_line.rst.txt @@ -0,0 +1,120 @@ +.. _commandline-label: + +Command line arguments +###################### +Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle--field interactions. + + +Required arguments +================== +:configuration file: + :code:`type` positional + + Specifies the :code:`.toml` format configuration file containing simulation details. See :ref:`config-label` for details. + +:structure and topology file: + :code:`type` positional + + Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See :ref:`topology-label` for details. + +Optional arguments +================== +:code:`-v --verbose` + :code:`type` optional + + Number of following arguments: :code:`0` or :code:`1` + + Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying :code:`-v` or :code:`--verbose` with no additional specification. This increases verbosity level by :code:`1`. Alternatively, it maye be specified by :code:`--verbose V` with :code:`V` being :code:`0`, :code:`1`, or :code:`2`. + +:code:`--profile` + :code:`type` optional + + Number of following arguments: :code:`0` + + Enables code profiling using :code:`cProfile`. This will output one profiling file per MPI rank invoked in the simulation. + +:code:`--double-precision` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision internally in HyMD (including in the FFTs). + +:code:`--double-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision in the output trajectory from HyMD. + +:code:`--velocity-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that velocities should be output to the HyMD trajectory. + +:code:`--force-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that forces should be output to the HyMD trajectory. + +:code:`--disable-mpio` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult. + +:code:`--logfile` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the path of a plain text log file in which stdout is mirrored during simulation runs. + +:code:`--seed` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the random seed used in the :code:`numpy` random library to generate velocities, thermostatting, etc. + +:code:`--disable-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any two-particle bonds present in the system. + +:code:`--disable-angle-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any three-particle bonds present in the system. + +:code:`--disable-dihedrals` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any four-particle bonds present in the system. + +:code:`--disable-dipole` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any topological reconstruction of peptide backbone dipoles present in the system. + +:code:`--disable-field` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any particle--field interactions present in the system. diff --git a/v1.0.9/_sources/doc_pages/config_file.rst.txt b/v1.0.9/_sources/doc_pages/config_file.rst.txt new file mode 100644 index 00000000..40ee0479 --- /dev/null +++ b/v1.0.9/_sources/doc_pages/config_file.rst.txt @@ -0,0 +1,194 @@ +.. _config-label: + +Configuration file +################## +The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order. + +The configuration file is a `toml`_ format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs. + +.. _`toml`: + https://github.com/toml-lang/toml + +.. role:: required + +Configuration file keywords +--------------------------- + +The following constitutes every possible keyword specification in HyMD +configuration files: + +Metadata keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying metadata for the H5MD output trajectory. + +:name: + :code:`string` [**optional**, default: :code:`None`] + + Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file. + + +:tags: + :code:`array` [:code:`string`] [**optional**, default: :code:`None`] + + Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file. + + +Particle keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying properties of particles and molecules in the +system. + +:n_particles: + :code:`integer` [**optional**, default: :code:`None`] + + Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules. + +:mass: + :code:`float` [**optional**, default: :code:`72.0`] {units: :math:`\text{u}=\text{g}\,\text{mol}^{-1}`} + + Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal. + +:max_molecule_size: + :code:`integer` [**optional**, default: :code:`201`] + + Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code **will** crash if there are molecules larger than :code:`max_molecule_size` in the topology/structure input file. + + +Simulation keywords +^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying simulation parameters. + +:n_steps: + :code:`integer` [:required:`required`] + + Total number of integration steps to perform for this simulation. + +:n_print: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of *number of time steps*). + +:n_flush: + :code:`integer` [**optional**, default: :code:`None`] + + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of *number of* :code:`n_print`, i.e. :code:`n_print = 13`, :code:`n_flush = 3` would result in the trajectory/energy being written to disk every :code:`13 x 3 = 39` *simulation steps*) + +:time_step: + :code:`float` [:required:`required`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time step per integration step. If the rRESPA multiple time step integrator is used (:code:`integrator = "respa"`), this specifies the **inner** time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is :code:`respa_inner` times the :code:`time_step` , and the total simulation time is :code:`n_steps` times :code:`time_step` times :code:`respa_inner` . + +:box_size: + :code:`array` [:code:`float`] [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable. + +:integrator: + :code:`string` [:required:`required`] (options: :code:`velocity-verlet` or :code:`respa`) + + Specifies the time integrator used in the simulation. If :code:`respa`, the *reversible reference system propagator algorithm (rRESPA)* :cite:`tuckerman1992reversible` integrator is used, with :code:`respa_inner` number of inner (intramolecular force) time steps. If :code:`velocity-verlet`, a normal Velocity Verlet integrator is used. If :code:`respa` and :code:`respa_inner = 1`, the rRESPA integrator is equivalent to the Velocity Verlet. + +:respa_inner: + :code:`integer` [**optional**, default: :code:`1`] + + The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces. + +:domain_decomposition: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Specifies the interval (in time steps) of *domain decomposition exchange*, involving all MPI ranks sending and receiving particles according to the particles' positions in the integration box and the MPI ranks' assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If :code:`True`, the decomposition is performed once (before starting the simulation). If :code:`False`, no decomposition is performed. + +:cancel_com_momentum: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + If :code:`True`, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every :code:`remove_com_momentum` time steps. If :code:`False`, the linear momentum is never removed. + +:start_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at :code:`start_temperature` Kelvin prior to starting the simulation. If :code:`False`, the velocities are not changed before starting the simulation. + +:target_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Couple the system to a heat bath at :code:`target_temperature` Kelvin by applying a *Canonical sampling through velocity rescaling* :cite:`Bussi2007JCP` thermostat with coupling strength :code:`tau`. If :code:`False`, no temperature control is applied. + +:tau: + :code:`float` [**optional**, default: :code:`0.7`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the CSVR thermostat coupling. In the limit of :code:`tau → ∞`, the Hamiltonian dynamics are preserved and no temperature coupling takes place. + +:thermostat_coupling_groups: + :code:`array` [:code:`array` [:code:`string`]] [**optional**, default: :code:`[]`] + + Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and :code:`"C"` type particles, :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would thermalise types :code:`"A"` and :code:`"B"` together and couple :code:`"C"` type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. :code:`target_temperature` Kelvin). +:hamiltonian: + :code:`string` [**optional**, default: :code:`"DefaultNohChi"`] (options: :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`) + + Specifies the interaction energy functional :math:`W[\tilde\phi]` for use with the particle-field interactions. See :ref:`functionals-label` for details. + + +Field keywords +^^^^^^^^^^^^^^ +Configuration keywords specifying field parameters. + +:mesh_size: + :code:`array` [:code:`integer`] or :code:`integer` [:required:`required`] + + Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is :code:`box_size / mesh_size`. + +:kappa: + :code:`float` [:required:`required`] {units: :math:`\text{kJ}^{-1}\text{mol}`} + + Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional :math:`W[\tilde\phi]`. See :ref:`functionals-label` for more details. + +:sigma: + :code:`float` [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See :ref:`filtering-label` for more details. + +:chi: + :code:`array` [:code:`array` [:code:`string`, :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}`} + + Array of :math:`\tilde\chi_\text{AB}`-parameters indicating the strength of the repulsive or attractive interaction between particles of type :code:`"A"` and the number density due to particles of type :code:`"B"`, and vice versa. Example: :code:`chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ]` would specify a repulsive :code:`"A"`--:code:`"B"` type interaction, and a weakly attractive :code:`"C"`--:code:`"D"` interaction. Self-interaction :math:`\tilde\chi`-terms are always zero. See :ref:`functionals-label` for more details. + + +Bond keywords +^^^^^^^^^^^^^ +Configuration keywords specifying bonds and bonds parameters. + +:bonds: + :code:`array` [:code:`array` [2 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{nm}=10^{-9}~\text{m}` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: :code:`bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ]` indicates a :code:`"A"`--:code:`"A"` bond of equilibrium length :code:`0.47` :math:`\text{nm}` with a bond strength of :code:`980.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding bond between :code:`"A"` and :code:`"B"` type particles with equilibrium length :code:`0.31` :math:`\text{nm}` and a strength of :code:`1250.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify stretching bonds. + +:angle_bonds: + :code:`array` [:code:`array` [3 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`{}^\circ` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: :code:`bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ]` indicates a :code:`"A"`--:code:`"A"`--:code:`"A"` angular bond that tries to keep the bond linear at :code:`180` degrees with a bending strength of :code:`55.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding angle bond between :code:`"A"`--:code:`"B"`--:code:`"B"` prefering the angle at :code:`120` degrees and a strength of :code:`25.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify angular bonds. + +:dihedrals: + :code:`array` [:code:`array` [4 :code:`string`, :code:`integer`, :code:`COSINE SERIES` ]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`} + + Specifies four-particle torsional potentials by cosine series. See :ref:`bonds-label` for details about how to specify dihedrals. + + + +Electrostatic keywords +^^^^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying electrostatics and electrostatic parameters. + +:coulombtype: + :code:`string` [**optional**, default: :code:`None`] (options: :code:`PIC_Spectral`) + + Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the :code:`dielectric_const` keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, *not* in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to `PIC_Spectral`. + +:dielectric_const: + :code:`float` [**optional**, default: :code:`None`] + + Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified---even if electrostatics are not included with the :code:`coulombtype` keyword. diff --git a/v1.0.9/_sources/doc_pages/constants_and_units.rst.txt b/v1.0.9/_sources/doc_pages/constants_and_units.rst.txt new file mode 100644 index 00000000..ee429829 --- /dev/null +++ b/v1.0.9/_sources/doc_pages/constants_and_units.rst.txt @@ -0,0 +1,80 @@ +.. _units-label: + +Constants and Units +################### + +HyMD uses the following units and constants internally and in all input and +output: + +.. list-table:: **Units** + :widths: 30 10 75 + :header-rows: 1 + + * - Quantity + - Symbol + - Unit + * - length + - :math:`r` + - :math:`\text{nm}=10^{-9}~\text{m}` + * - time + - :math:`t` + - :math:`\text{ps}=10^{-12}~\text{s}` + * - charge + - :math:`q` + - :math:`e=1.602176634 \cdot 10^{-19}~\text{C}` + * - mass + - :math:`m` + - :math:`\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}` + * - temperature + - :math:`\text{T}` + - :math:`\text{K}` + * - energy + - :math:`E` + - :math:`\text{kJ}\,\text{mol}^{-1}` + * - velocity + - :math:`v` + - :math:`\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}` + * - momentum + - :math:`P` + - :math:`\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}` + * - force + - :math:`\mathbf{F}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}` + * - pressure + - :math:`p` + - :math:`\text{bar}=100~\text{kPa}` + * - electric potential + - :math:`\Psi` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}` + * - electric field + - :math:`\mathbf{E}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}` + * - compressibility + - :math:`\kappa` + - :math:`\text{mol}\,\text{kJ}^{-1}` + * - field-interaction + - :math:`\tilde\chi` + - :math:`\text{kJ}\,\text{mol}^{-1}` + +.. list-table:: **Constants** + :widths: 30 10 75 + :header-rows: 1 + + * - Constant + - Symbol + - Value + * - gas constant + - :math:`R` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Boltzmann’s constant + - :math:`k_\text{B}` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Avogadro's constant + - :math:`N_\text{A}` + - :math:`6.02214076 \cdot 10^23~\text{mol}^{-1}` + * - Vacuum permittivity + - :math:`\varepsilon_0` + - :math:`8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2` + * - Coulomb constant + - :math:`k_\text{e}` + - :math:`138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}` diff --git a/v1.0.9/_sources/doc_pages/electrostatics.rst.txt b/v1.0.9/_sources/doc_pages/electrostatics.rst.txt new file mode 100644 index 00000000..7e11c09d --- /dev/null +++ b/v1.0.9/_sources/doc_pages/electrostatics.rst.txt @@ -0,0 +1,48 @@ +.. _electrostatics-label: + +Electrostatic interactions +########################## +In the filtered Hamiltonian hPF formalism :cite:`bore2020hamiltonian` the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle--mesh Ewald. + +The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered + +.. math:: + + \tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i), + +with :math:`q_i` being the charge of particle :math:`i` and :math:`H` is the +filtering function (see :ref:`filtering-label`). The value of the charge grid at +vertex :math:`(i,j,k)` is found by + +.. math:: + + \tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)] + +and the electrostatic potential :math:`\Psi_{ijk}` + +.. math:: + + \Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right], + +where :math:`k_\text{e}` is the Coulomb constant :math:`1/4\pi\varepsilon_0`. +The *electric field* is obtained by differentiation of the electrostatic +potential in Fourier space, + +.. math:: + + \mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)] + +from which the forces are interpolated back to the particle positions. + +Specifying electrostatics +^^^^^^^^^^^^^^^^^^^^^^^^^ +In HyMD, electrostatics are specified by the :code:`coulombtype` and +:code:`dielectric_const` keywords in the configuration file (see +:ref:`config-label`) and the :code:`/charge` dataset in the HDF5 format +structure/topology input file (see :ref:`topology-label`). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions. diff --git a/v1.0.9/_sources/doc_pages/examples.rst.txt b/v1.0.9/_sources/doc_pages/examples.rst.txt new file mode 100644 index 00000000..9f9c3655 --- /dev/null +++ b/v1.0.9/_sources/doc_pages/examples.rst.txt @@ -0,0 +1,621 @@ +.. _examples-label: + +Examples +######## +The following examples are ordered in *more or less* order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the `HyMD-tutorial`_ github repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Ideal gas +========= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true + :align: right + :width: 200 + +The simplest possible system is one with no interactions at all---intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like: + + +.. code-block:: toml + :caption: **ideal_gas.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = false # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + +A simple input structure/topology file :code:`ideal_gas.HDF5` is available in +the `HyMD-tutorial/ideal_gas`_ github repository (along with the code to +generate it). Run the (very) short simulation by + +.. code:: bash + + python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field \ + --velocity-output \ + --force-output + +with the :code:`--disable-field` argument to completely turn off all +particle--field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook `ideal_gas.ipynb`_ for details. + + +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas +.. _ideal_gas.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.ipynb + + +Ideal chains +============ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true + :align: right + :width: 200 + +The simplest available interaction is the harmonic two-particle bond (see +:ref:`bonds-label`), + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2. + +Extending the configuration file from the ideal gas case, we need to add a +:code:`bonds` specification. Note that the :code:`[bonds]` meta specifier is not +necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **ideal_chain.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + +A simple input structure/topology file :code:`ideal_chain.HDF5` with a few +coiled up ideal chain polymers is available in the +`HyMD-tutorial/ideal_chain`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field + +we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +`ideal_chain.ipynb`_. + + +.. _HyMD-tutorial/ideal_chain: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_chain +.. _ideal_chain.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/ideal_chain.ipynb + + +Stiff rods +========== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true + :align: right + :width: 200 + +Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the :code:`i--j--k` angle :math:`\theta` (see +:ref:`bonds-label`), + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2. + +Extending the configuration file from the ideal chain case, we need to add a +:code:`angle_bonds` specification. Note that the :code:`[bonds]` meta specifier +is not necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **rods.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + + angle_bonds = [ + ["A", "A", "A", 180.0, 100.0], # (i, j, k, equilibrium angle, strength) + ] + + +A simple input structure/topology file :code:`rods.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook `rods.ipynb`_. + + +.. _HyMD-tutorial/rods: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/rods +.. _rods.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.ipynb + + + +Helixes +======= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true + :align: right + :width: 200 + +Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle :math:`\phi` between the +:code:`i--j--k` plane and the :code:`j--k--l` plane (see :ref:`bonds-label`), + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n). + +The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a :code:`dihedrals` keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the :code:`dielectric_const` +keyword even though we are not including electrostatic forces in the current +simulation. Note that the :code:`[bonds]` meta specifier is not necessary, but +may be used to help organise the input file. + +.. code-block:: toml + :caption: **helixes.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + dielectric_const = 15.0 + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.31, 10000.0], # (i name, j name, equilibrium length, strength) + ] + + dihedrals = [ + [ + ["A", "A", "A", "A"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0] + ], + ] + +A simple input structure/topology file :code:`helixes.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook `helixes.ipynb`_. + + +.. _HyMD-tutorial/helixes: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/helixes +.. _helixes.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.ipynb + + +Phase separation +================ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true + :align: right + :width: 200 + +The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types :code:`A` and :code:`B`. Using the Hamiltonian + +.. math:: + + \mathcal{H}=H_0+W + +with :math:`\tilde\chi`--dependent interactions defined by (specified in the +configuration file by :code:`hamiltonian = DefaultWithChi`): + +.. math:: + + W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2. + + +.. code-block:: toml + :caption: **phase_separation.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + + [field] + mesh_size = [20, 20, 20] # FFT grid size + sigma = 1.0 # filtering length scale in nm + kappa = 0.05 # compressibility in mol/kJ + chi = [ + ['A', 'B', 5.0], # (name i, name j, strength) + ] + +A simple input structure/topology file :code:`phase_separation.HDF5` containing +an equal number of :code:`A` type and :code:`B` type particles is available in +the `HyMD-tutorial/phase_separation`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd phase_separation.toml phase_separation.HDF5 + +we may examine the resulting trajectory. In the case of a low interaction +strength :math:`\tilde\chi` of :code:`5.0` (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to :code:`40.0` (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +`phase_separation.ipynb`_. + + +.. _HyMD-tutorial/phase_separation: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/phase_separation +.. _phase_separation.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/phase_separation.ipynb + + +Diblock copolymers +================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true + :align: right + :width: 200 + +Having introduced particle--field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive :math:`\tilde\chi`--interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the :code:`integrator = "respa"` keyword. Putting the pieces together, the +configuration file may look like the following: + +.. code-block:: toml + :caption: **copolymer.toml** + + [simulation] + integrator = "respa" + respa_inner = 15 + n_steps = 2000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [10.0, 10.0, 10.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [50, 50, 50] # FFT grid size + sigma = 0.5 # filtering length scale in nm + chi = [ + ["A", "B", 30.0], # (i, j, strength) + ] + + [bonds] + bonds = [ + ["A", "A", 0.25, 1500.0], # (i, j, equilibrium length, strength) + ["A", "B", 0.25, 1500.0], + ["B", "B", 0.25, 1500.0], + ] + angle_bonds = [ + ["A", "A", "A", 180.0, 25.0], # (i, j, k, equilibrium angle, strength) + ["B", "B", "B", 180.0, 25.0], + ] + +A simple input structure/topology file :code:`copolymer.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/copolymer`_ github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten :code:`A` followed by ten :code:`B` type particles. +Running the simulation with + +.. code:: bash + + python3 -m hymd copolymer.toml copolymer.HDF5 + +the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +`copolymer.ipynb`_. + + +.. _HyMD-tutorial/copolymer: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/copolymer +.. _copolymer.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer.ipynb + + +Lipid bilayer self-assembly +=========================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true + :align: right + :width: 300 + +Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field--particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the :code:`thermostat_coupling_groups` keyword. With parameters +optimised in :cite:`ledum2020automated`, the configuration file looks like: + + +.. code-block:: toml + :caption: **lipid_self_assembly.toml** + + [simulation] + integrator = "respa" + respa_inner = 25 + n_steps = 3000 + n_print = 200 + n_flush = 1 + time_step = 0.01 + box_size = [9.96924, 9.96924, 10.03970] + start_temperature = 323 + target_temperature = 323 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.05 + domain_decomposition = 10001 + cancel_com_momentum = true + max_molecule_size = 15 + thermostat_coupling_groups = [ + ["N", "P", "G", "C"], + ["W"], + ] + + [field] + mesh_size = [25, 25, 25] + sigma = 1.0 + chi = [ + ["C", "W", 42.24], + ["G", "C", 10.47], + ["N", "W", -3.77], + ["G", "W", 4.53], + ["N", "P", -9.34], + ["P", "G", 8.04], + ["N", "G", 1.97], + ["P", "C", 14.72], + ["P", "W", -1.51], + ["N", "C", 13.56], + ] + + [bonds] + bonds = [ + ["N", "P", 0.47, 1250.0], + ["P", "G", 0.47, 1250.0], + ["G", "G", 0.37, 1250.0], + ["G", "C", 0.47, 1250.0], + ["C", "C", 0.47, 1250.0], + ] + angle_bonds = [ + ["P", "G", "G", 120.0, 25.0], + ["P", "G", "C", 180.0, 25.0], + ["G", "C", "C", 180.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +A randomly mixed input structure/topology file +:code:`lipid_self_assembly.HDF5` with a few hundred lipids in a roughy +:code:`10 x 10 x 10nm` box is available in the +`HyMD-tutorial/lipid_self_assembly`_ github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation + +.. code:: bash + + python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5 + +we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook `lipid_self_assembly.ipynb`_. + + +.. _HyMD-tutorial/lipid_self_assembly: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/lipid_self_assembly +.. _lipid_self_assembly.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/lipid_self_assembly.ipynb + + +Peptide in lipid bilayer +======================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true + :align: right + :width: 300 + +Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer. + + +The `configuration file`_ is available in the `HyMD-tutorial/peptide`_ github +repository (omitted here for brevity). + +A pre-equilibrated input structure/topology file :code:`peptide.HDF5` with a +few hundred lipids in a roughy :code:`20 x 20 x 20nm` box is available in the +`HyMD-tutorial/peptide`_ github repository. Running the simulation + +.. code:: bash + + python3 -m hymd peptide.toml peptide.HDF5 + +we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook `peptide.ipynb`_. + + +.. _HyMD-tutorial/peptide: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/peptide +.. _configuration file: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.toml +.. _peptide.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.ipynb + + +SDS +=== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true + :align: right + :width: 300 + +The last part we introduce is explicit electrostatic interactions through +particle--mesh Ewald. Enabling the electrostatic calculations is done via the +:code:`coulombtype` keyword. :code:`"PIC_Spectral"` is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the :code:`dielectric_const` keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge. + + + +.. code-block:: toml + :caption: **sds.toml** + + [simulation] + integrator = "respa" + respa_inner = 10 + n_steps = 3000 + n_print = 1500 + n_flush = + time_step = 0.01 + box_size = [8.3, 8.3, 8.3] + start_temperature = 298 + target_temperature = 298 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.1 + domain_decomposition = 10000 + cancel_com_momentum = true + max_molecule_size = 5 + thermostat_coupling_groups = [ + ["S", "C"], + ["W", "Na"], + ] + dielectric_const = 45.0 # dielectric constant for the simulation medium + coulombtype = "PIC_Spectral" # particle in cloud, spectral method + + [field] + mesh_size = [64, 64, 64] + sigma = 0.5 + chi = [ + ["S", "C", 13.50], + ["S", "Na", 0.00], + ["S", "W", -3.60], + ["C", "Na", 13.50], + ["C", "W", 33.75], + ["W", "Na", 0.00], + ] + + [bonds] + bonds = [ + ["S", "C", 0.50, 1250.0], + ["C", "C", 0.50, 1250.0], + ] + angle_bonds = [ + ["S", "C", "C", 170.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +An input structure/topology file :code:`sds.HDF5` with a couple thousand +randomly dispersed SDS chains is available in the `HyMD-tutorial/sds`_ github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a :code:`/charge` dataset. +Running the simulation with + +.. code:: bash + + python3 -m hymd sds.toml sds.HDF5 + +we observe the aggregation of the SDS into micellular structures---first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook `sds.ipynb`_. + + +.. _HyMD-tutorial/sds: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/sds +.. _sds.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/sds.ipynb diff --git a/v1.0.9/_sources/doc_pages/filtering.rst.txt b/v1.0.9/_sources/doc_pages/filtering.rst.txt new file mode 100644 index 00000000..02af68c6 --- /dev/null +++ b/v1.0.9/_sources/doc_pages/filtering.rst.txt @@ -0,0 +1,30 @@ +.. _filtering-label: + +Filtering +######### +The default grid-independent filter function used in HyMD is a Gaussian + +.. math:: + + H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] + +with reciprocal space representation + +.. math:: + + \hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +The coarse-graining parameter :math:`\sigma` determines a length scale of +particle extent and is given as configuration file input by + +.. code:: toml + + sigma = 0.75 + + +Implementing new filters +^^^^^^^^^^^^^^^^^^^^^^^^ +Implementing new filter functions is straightforward by hijacking +the :code:`setup` method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional. diff --git a/v1.0.9/_sources/doc_pages/installation.rst.txt b/v1.0.9/_sources/doc_pages/installation.rst.txt new file mode 100644 index 00000000..9ab7e59c --- /dev/null +++ b/v1.0.9/_sources/doc_pages/installation.rst.txt @@ -0,0 +1,324 @@ +.. _installation-label: + +Installation +############ + +Dependencies +============ + +.. note:: + HyMD requires Python ≥3.6. Python version 3.9 is most likely fine + to use, but HyMD is only regularly tested with Python3.8 at the moment. + +.. warning:: + MPI-enabled h5py may fail to build under Python3.10. In this case, a + fall-back to Python3.9 or lower may be necessary. + + +**Installing non-Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-openmpi-dev # Install MPI-enabled HDF5 + sudo apt-get install -y pkg-config # Install pkg-config, required for h5py install + sudo apt-get install -y curl wget + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + sudo dnf update -y + sudo dnf install -y python3.9 python3-devel # Install python3 and pip + sudo dnf install -y openmpi-devel # Install MPI development headers + sudo dnf install -y hdf5-openmpi-devel # Install MPI-enabled HDF5 + sudo dnf install -y curl wget + + + The automatic download and building of PFFT has some issues, so we + manually build FFTW and PFFT before calling :code:`pip3 install pfft-python`. + + .. code-block:: bash + + sudo dnf install -y git + sudo dnf install -y libtool + sudo dnf install -y fftw-openmpi-devel fftw-openmpi-libs + export PATH=$PATH:/usr/lib64/openmpi/bin/ # Ensure MPICC is in path + git clone https://github.com/mpip/pfft.git + cd pfft/ + ./bootstrap.sh + ./configure + make + make install + + + .. group-tab:: Mac OSX (brew) + + .. code-block:: bash + + brew update + brew install python # Install python3 and pip + brew install open-mpi # Install MPI development headers + brew install hdf5-mpi # Install MPI-enabled HDF5 + brew install pkg-config # Install pkg-config, required for h5py install + brew install curl wget + +.. warning:: + There might be memory leaks when using HyMD with OpenMPI 4.1.1. + Therefore, using a newer version of OpenMPI is recommended. + See `Issue #186 `_ for more details. + + +**Installing Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + python3 -m pip install --upgrade pip + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + python3.9 -m ensurepip --upgrade + PATH=$PATH:/usr/lib64/openmpi/bin/:/usr/lib64/openmpi/lib/ + python3.9 -m pip install mpi4py numpy cython + export HDF5_DIR="/usr/lib64/openmpi/" + CC="mpicc" HDF5_MPI="ON" python3.9 -m pip install --no-binary=h5py h5py + + .. group-tab:: Mac OSX (brew) + + Find the location of the installed :code:`hdf5-mpi` package by + + .. code-block:: bash + + find /usr -iname "*hdf5.h" + + or + + .. code-block:: bash + + brew info hdf5-mpi + + and extract the path, which will look like for example + :code:`/usr/local/Cellar/hdf5-mpi/1.13.0/`. Export it as :code:`HDF5_DIR` + + .. code-block:: bash + + python3 -m ensurepip --upgrade + export HDF5_DIR="/usr/local/Cellar/hdf5-mpi/1.13.0/" + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + + +.. warning:: + + If MPI-enabled HDF5 and :code:`h5py` can not be installed, limited support + for serial HDF5 is available. Note that having MPI-enabled file IO is + **highly recommended**, and simulation performance under serial HDF5 will + potentially be very low. + + Example dependency install on Ubuntu (apt) using serial HDF5: + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-serial-dev # Install serial HDF5 + sudo apt-get install -y curl wget + + python3 -m pip install h5py mpi4py numpy cython + + Running parallel simulations without a + MPI-enabled HDF5 library available necessitates the use of the + :code:`--disable-mpio` argument to HyMD, see :ref:`commandline-label`. Note that + due to the way HyMD is built, a working MPI compiler is required even if all + intended simulations are serial. + + +Installing HyMD +=============== +HyMD may be installed using :code:`pip` by + +.. code-block:: bash + + python3 -m pip install hymd + + + +Install in docker +================= +A docker image with build essentials setup is available at `dockerhub`_ with tag +:code:`mortele/hymd`, + +.. code-block:: bash + + docker pull mortele/hymd:latest + docker run -it mortele/hymd + /app$ python3 -m pip install hymd + + # Grab example input files + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5 + + # Run simulation + /app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose + +.. _dockerhub: + https://hub.docker.com/repository/docker/mortele/hymd + + +Run interactively in Google Colaboratory +======================================== +A `Google Colaboratory`_ jupyter notebook is setup `here`_ with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Common issues +============= + +Numpy errors while importing the Fortran force kernels +------------------------------------------------------ + +.. code-block:: python + + RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd + + Traceback (most recent call last): + + (...) + + File "/..../HyMD/hymd/__init__.py", line 2, in + from .main import main # noqa: F401 + File "/..../HyMD/hymd/main.py", line 10, in + from .configure_runtime import configure_runtime + File "/..../hymd/configure_runtime.py", line 12, in + from .input_parser import read_config_toml, parse_config_toml + File "/..../HyMD/hymd/input_parser.py", line 12, in + from .force import Bond, Angle, Dihedral, Chi + File "/..../HyMD/hymd/force.py", line 8, in + from force_kernels import ( # noqa: F401 + ImportError: numpy.core.multiarray failed to import + +can normally be fixed by updating numpy versions, + +.. code-block:: bash + + python3 -m pip install -U numpy + + +Error building pfft-python due to missing curl/wget +--------------------------------------------------- + +.. code-block:: python + + Building wheel for pfft-python (setup.py) ... error + ERROR: Command errored out with exit status 1: + command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_ + cwd: /tmp/pip-install-fr6nt9m4/pfft-python/ + Complete output (56 lines): + running bdist_wheel + running build + running build_py + + (...) + + curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found + wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found + Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + Please check curl or wget + You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ + Traceback (most recent call last): + File "", line 1, in + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in + setup( + File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup + return distutils.core.setup(**attrs) + File "/usr/lib/python3.8/distutils/core.py", line 148, in setup + + (...) + + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions + build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:])) + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft + raise ValueError("could not build fftw; check MPICC?") + ValueError: could not build fftw; check MPICC? + ---------------------------------------- + ERROR: Failed building wheel for pfft-python + Running setup.py clean for pfft-python + Failed to build pfft-python + +can be fixed by installing either `curl`_ or `wget`_ + +.. code-block:: bash + + apt-get install -y curl wget + + +.. _`curl`: + https://curl.se/ + +.. _`wget`: + https://www.gnu.org/software/wget/ + + +Error running parallel HyMD without MPI-enabled h5py +---------------------------------------------------- + +.. code-block:: python + + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + main() + File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main + with h5py.File(args.input, "r", **_kwargs) as in_file: + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__ + with h5py.File(args.input, "r", **_kwargs) as in_file: + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + raise ValueError("h5py was built without MPI support, can't use mpio driver") + ValueError: h5py was built without MPI support, can't use mpio driver + +Can be fixed by installing a MPI-enabled :code:`h5py` through + +.. code-block:: bash + + python3 -m pip uninstall -y h5py + HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py diff --git a/v1.0.9/_sources/doc_pages/interaction_energy_functionals.rst.txt b/v1.0.9/_sources/doc_pages/interaction_energy_functionals.rst.txt new file mode 100644 index 00000000..f33c004e --- /dev/null +++ b/v1.0.9/_sources/doc_pages/interaction_energy_functionals.rst.txt @@ -0,0 +1,98 @@ +.. _functionals-label: + +Interaction energy functionals +############################## +A few interaction energy functionals :math:`W` are defined in HyMD through +the :code:`Hamiltonian` class and associated subclasses. + +:math:`\chi`--interaction and :math:`\kappa`--incompressibility +=============================================================== +The most common hPF energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultWithChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where :math:`\tilde\chi_{\text{A}-\text{B}}` is the interaction energy between +overlapping densities of particle types :math:`\text{A}` and :math:`\text{B}`. +The incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\tilde\chi` +and :math:`\kappa` in the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + chi = [ + ["A", "B", 15.85], + ["B", "C", -5.70], + ... + ] + +Only :math:`\kappa`--incompressibility +====================================== +The only :math:`\kappa` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultNoChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where the incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Only :math:`\phi^2` +=================== +The :math:`\phi^2` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "SquaredPhi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2, + +where the :math:`\phi` squared term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Implementing new interaction energy forms +========================================= +Implementing new interaction energy functions is straightforward by subclassing +:code:`Hamiltonian` and applying :code:`sympy` differentiation to the symbolic +field objects. The :code:`sympy.lamdify` function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields. diff --git a/v1.0.9/_sources/doc_pages/intramolecular_bonds.rst.txt b/v1.0.9/_sources/doc_pages/intramolecular_bonds.rst.txt new file mode 100644 index 00000000..820e81bc --- /dev/null +++ b/v1.0.9/_sources/doc_pages/intramolecular_bonds.rst.txt @@ -0,0 +1,142 @@ +.. _bonds-label: + +Intramolecular bonds +#################### + +Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see :ref:`config-label`. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +:ref:`benchmarks-label`), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable. + +All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]). + + +Two-particle bonds +^^^^^^^^^^^^^^^^^^ +Stretching bonds in HyMD are implemented as harmonic spring potentials, + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2, + +where :math:`r=|\mathbf{r}|` is the inter-particle distance, :math:`k` is a +constant of dimension energy (units :math:`\text{kJ}\,\text{mol}^{-1}`), and +:math:`r_0` is the equilibrum length of the bond (units: :math:`\text{nm}`). The +force is calculated as + +.. math:: + + F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r}, + +where :math:`\mathbf{r}` is the vector pointing *from* :math:`i` *to* :math:`j`. + +In the configuration file, two-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_two_particle_example.toml + + [bonds] + bonds = [ + ["A", "A", 0.47, 1250.0], + ["A", "B", 0.37, 940.0], + ["B", "C", 0.50, 1010.0], + ["C", "A", 0.42, 550.0], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Three-particle bonds +^^^^^^^^^^^^^^^^^^^^ +Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle--particle--particle angle :math:`\theta`, + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2, + +where :math:`k` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}`), and :math:`\theta_0` is the equilibrum +angle of the bond (units: :math:`{}^\circ`). Defining the particles with labels +:math:`a`, :math:`b`, and :math:`c`, let :math:`\mathbf{r}_a` denote the vector +pointing from :math:`b` to :math:`a`, and correspondingly let +:math:`\mathbf{r}_c` point from :math:`b` to :math:`c`. The +:math:`a`--:math:`b`--:math:`c` may be computed through the law of Cosines, + +.. math:: + + \theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right] + +Then the force acting on :math:`a` and :math:`c` is + +.. math:: + + \mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a}, + + \mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c}, + +and + +.. math:: + + \mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c + +In the configuration file, three-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_three_particle_example.toml + + [bonds] + angle_bonds = [ + ["A", "A", "A", 180.0, 90.0], + ["A", "B", "A", 120.0, 55.0], + ["B", "C", "C", 30.0, 10.0], + ["C", "A", "B", 110.0, 25.5], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Four-particle bonds +^^^^^^^^^^^^^^^^^^^ +Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle :math:`\phi` between the +:math:`a`--:math:`b`--:math:`c` and :math:`b`--:math:`c`--:math:`d` planes, for +a dihedral bond quartet :math:`a`, :math:`b`, :math:`c`, and :math:`d`. The +potential takes the form + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n), + +where :math:`c_n` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`), and :math:`\phi_n` are +specified phase angles in the cosine series. + +In the configuration file, four-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_four_particle_example.toml + + [bonds] + dihedrals = [ + ["A", "B", "C", "D"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0], + ] diff --git a/v1.0.9/_sources/doc_pages/overview.rst.txt b/v1.0.9/_sources/doc_pages/overview.rst.txt new file mode 100644 index 00000000..0e4d6b65 --- /dev/null +++ b/v1.0.9/_sources/doc_pages/overview.rst.txt @@ -0,0 +1,166 @@ +.. _overview-label: + +================================ + Usage overview for HylleraasMD +================================ + +HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a `toml`_ format configuration file, along with a topology and structure +file specifying the input system in HDF5 format. + +.. _`toml`: + https://github.com/toml-lang/toml + +**Configuration file** + +The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a :code:`[5, 5, 5]` nm simulation box at 300 K may look like +the following: + +.. code-block:: toml + :caption: **config_simple_1.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "SquaredPhi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [30, 30, 30] # FFT grid size + sigma = 0.5 # filtering length scale in nm + +Note that for the version 1.0 release of HyMD, the :code:`[particles]`, +:code:`[simulation]`, and :code:`[field]` groups are optional specifiers for +structuring the configuration file. + +For a full specification of every recognised configuration keyword in HyMD, +please refer to :ref:`config-label`. + +**Topology and structure file** + +The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +:code:`N` particles may look like the following: + +.. code-block:: bash + :caption: **example_structure.HDF5** + + group / + # root group + + dataset /coordinates + # float32, shape (T, N, D,) + # Time steps of N rows of D dimensional coordinate data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /velocities + # float32, shape (T, N, D,) OPTIONAL + # Time steps of N rows of D dimensional velocity data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /bonds + # int32, shape (N, B,) OPTIONAL + # Each row i contains indices of the particles bonds from/to i + # B denotes the maximum bonds per particle + + dataset /indices + # int32, shape (N,) + # Index of each particle, 0--(N-1) + + dataset /molecules + # int32, shape (N,) + # Index of molecule each particle belongs to + # Used to construct bond network locally on MPI ranks + + dataset /names + # str10, shape (N,) + # Fixed size string array containing particle type names + + dataset /types + # int32, shape (N,) OPTIONAL + # Mapping of particle names to type indices + + +For a full specification of the topology and structure input file, see +:ref:`topology-label`. + +**Command line arguments** + +A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the :code:`config_simple_1.toml` and :code:`example_structure.HDF5` +files may look like the following: + +.. code-block:: bash + + mpirun -n ${MPI_NUM_RANKS} python3 -m hymd \ # HyMD executable + config_simple_1.toml \ # configuration file + example_structure.HDF5 \ # structure file + --logfile=log_out.txt \ # set logfile path + --seed 123456 \ # set random seed + --verbose 2 \ # set logging verbosity + --velocity-output # enable velocity in trajectory output + +For a full specification of all command line arguments, see +:ref:`commandline-label`. + +**More examples** + +For more thorough rundown and concrete usage examples, see +:ref:`examples-label`. + +Running parallel simulations +============================ +Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the **only** difference being how the python3 interpreter is +invoked. Prepending :code:`mpirun -n ${NPROCS}` to the usual +:code:`python3 -m hymd` runs the simulation with :code:`${NPROCS}` MPI ranks. + +Inputting + +.. code:: bash + + mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field + +sets up an example simulation of the `HyMD-tutorial/ideal_gas`_ system. For +more details about this system in particular, or other example simulations, see +the `HyMD-tutorial`_ repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas + + +Running tests +============= +Run serial code tests by + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd + cd hymd/ + python3 -m pip install pytest pytest-mpi + python3 -m pytest + +There is a small convenience script in :code:`hymd/` for running the MPI-enabled +tests, + +.. code-block:: bash + + chmod +x pytest-mpi + ./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no diff --git a/v1.0.9/_sources/doc_pages/theory.rst.txt b/v1.0.9/_sources/doc_pages/theory.rst.txt new file mode 100644 index 00000000..95d7842c --- /dev/null +++ b/v1.0.9/_sources/doc_pages/theory.rst.txt @@ -0,0 +1,114 @@ +.. _theory-label: + +Theory +###### +Hybrid particle--field simulations switch out the ordinary particle--particle +`Lennard-Jones`_ interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle--field densities are +defined as + +.. math:: + + \phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i), + +where :math:`\mathbf{r}` is a spatial coordinate, :math:`P` is a window function +used to distribute particle number densities onto a computational grid, and +:math:`\mathbf{r}_i` is the position of particle :math:`i` (of total :math:`N`). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of :math:`N` particles in :math:`M` molecules is + +.. math:: + + \mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})] + +with :math:`H_0` being a standard intramolecular Hamiltonian form (see +:ref:`bonds-label`) including kinetic terms, while :math:`W` is a density +dependent *interaction energy functional*. + +In the Hamiltonian hPF-MD formalism :cite:`bore2020hamiltonian`, the density +field is filtered using a grid-independent filtering function :math:`H`, + +.. math:: + + \tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}). + +The filter smooths the density, ensuring that :math:`\tilde\phi` and +:math:`W[\tilde\phi([\phi])]` both converge as the grid size is reduced. + +External potential +================== +The external potential acting on a particle is defined as the functional +derivative of :math:`W` with respect to :math:`\phi`. In the filtered formalism, +the potential takes the form + +.. math:: + + V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ + &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})}, + +under the assumption of a *local* form of the interaction energy functional, +:math:`W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]`. Note +that + +.. math:: + + \frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}). + +Force interpolation +=================== +The forces on particle :math:`i` are obtained by differentiation of the external +potential, + +.. math:: + + \mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i). + + +Reciprocal space calculations +============================= +The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density :math:`\phi_{ijk}` with CIC, we apply the filtering +and obtain the discrete version of the external potential by + +.. math:: + + \tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big] + +and + +.. math:: + + V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +The forces are obtained by differentiation of :math:`V` in Fourier space as + +.. math:: + + \nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +Filter +====== +By default, the filter used in HyMD is a simple Gaussian of the form + +.. math:: + + H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ + \hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +For more details about the filtering, see :ref:`filtering-label`. + +Hamiltonian form +================ +The default form of the interaction energy functional in HyMD is + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2. + +See :ref:`functionals-label` for details. + + +.. _`Lennard-Jones`: + https://en.wikipedia.org/wiki/Lennard-Jones_potential diff --git a/v1.0.9/_sources/doc_pages/topology_input.rst.txt b/v1.0.9/_sources/doc_pages/topology_input.rst.txt new file mode 100644 index 00000000..adabe129 --- /dev/null +++ b/v1.0.9/_sources/doc_pages/topology_input.rst.txt @@ -0,0 +1,77 @@ +.. _topology-label: + +============================ +Topology and structure file +============================ +The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root :code:`/` group. + +The `HyMD-tutorial`_ has multiple examples of structure files for various levels +of complexity. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Required datasets +================= +:/coordinates: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/indices: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/names: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`string` (:code:`length` between :code:`1` and :code:`16`)] + + The shape represents one particle name per :code:`N` particles. The datatype may be a string of length :code:`=<16`. + + + +Optional datasets +================= +:/velocities: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/types: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle type index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/molecules: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one molecule index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/bonds: + :code:`array` shape [:code:`N`, :code:`B`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents :code:`B` bond specifications (indices of different particles) per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/charge: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents one particle charge per :code:`N` particles. The data type may be either four or eight byte reals. diff --git a/v1.0.9/_sources/index.rst.txt b/v1.0.9/_sources/index.rst.txt new file mode 100644 index 00000000..ff4059ba --- /dev/null +++ b/v1.0.9/_sources/index.rst.txt @@ -0,0 +1,168 @@ +.. hymd documentation master file, created by + sphinx-quickstart on Thu Dec 16 13:31:43 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +############################### +HylleraasMD documentation +############################### + +:Release: + |release| +:Date: + |today| + +**HylleraasMD** (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems. + +HyMD can run canonical hPF-MD simulations :cite:`Milano2009JCP`, or filtered +density Hamiltonian hPF (HhPF-MD) simulations :cite:`bore2020hamiltonian`, with +or without explicit PME electrostatic interactions :cite:`kolli2018JCTC`. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +:cite:`Cascella2008,bore2018hybrid`. Martini +style elastic networks (ElNeDyn) :cite:`periole2009combining` are also +supported. + +HyMD uses the pmesh (`github.com/rainwoodman/pmesh`_) library for particle-mesh +operations, with the PPFT :cite:`pippig2013pfft` backend for FFTs through the +pfft-python bindings (`github.com/rainwoodman/pfft-python`_). File IO is done +via HDF5 formats to allow MPI parallel reads. + +User Guide +========== +The HylleraasMD :doc:`User Guide ` provides comprehensive information on how to run +simulations. Selected :doc:`Examples ` are available to guide new users. + +.. _`github.com/rainwoodman/pmesh`: + https://github.com/rainwoodman/pmesh +.. _`github.com/rainwoodman/pfft-python`: + https://github.com/rainwoodman/pfft-python + +Installing HyMD +=============== +The easiest approach is to install using pip_: + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + +For more information and **required dependencies**, see +:ref:`installation-label`. + +.. _pip: + http://www.pip-installer.org/en/latest/index.html + + +Run in Google colab +------------------- +Run HyMD interactively in `Google Colaboratory`_ jupyter notebook `here`_. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Source Code +=========== +**Source code** is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the `GNU Lesser General Public +License v3.0`_. Obtain the source code with `git`_: + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git + +.. _GNU Lesser General Public License v3.0: + https://www.gnu.org/licenses/lgpl-3.0.html +.. _git: + https://git-scm.com/ + + +Development +=========== +HyMD is developed and maintained by researchers at the `Hylleraas Centre for +Quantum Molecular Sciences`_ at the `University of Oslo`_. + +|pic1| |pic2| + +.. _`Hylleraas Centre for Quantum Molecular Sciences`: + https://www.mn.uio.no/hylleraas/english/ +.. _`University of Oslo`: + https://www.uio.no/ + +.. |pic1| image:: img/hylleraas_centre_logo_black.png + :target: img/hylleraas_centre_logo_black.png + :width: 250 px + +.. |pic2| image:: img/uio_full_logo_eng_pos.png + :target: img/uio_full_logo_eng_pos.png + :width: 325 px + + + +References +========== +.. bibliography:: + :all: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. Contents +.. ======== + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Getting started + + ./doc_pages/installation + ./doc_pages/overview + ./doc_pages/config_file + ./doc_pages/topology_input + ./doc_pages/command_line + ./doc_pages/constants_and_units + + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Examples + + ./doc_pages/examples + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Theory + + ./doc_pages/theory + ./doc_pages/intramolecular_bonds + ./doc_pages/electrostatics + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Developer documentation + + ./doc_pages/interaction_energy_functionals + ./doc_pages/filtering + ./doc_pages/benchmarks + ./doc_pages/api diff --git a/v1.0.9/_static/basic.css b/v1.0.9/_static/basic.css new file mode 100644 index 00000000..be19270e --- /dev/null +++ b/v1.0.9/_static/basic.css @@ -0,0 +1,856 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/v1.0.9/_static/css/badge_only.css b/v1.0.9/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/v1.0.9/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/v1.0.9/_static/css/fonts/Roboto-Slab-Bold.woff b/v1.0.9/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/v1.0.9/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/v1.0.9/_static/css/fonts/Roboto-Slab-Bold.woff2 b/v1.0.9/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/v1.0.9/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/v1.0.9/_static/css/fonts/Roboto-Slab-Regular.woff b/v1.0.9/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/v1.0.9/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/v1.0.9/_static/css/fonts/Roboto-Slab-Regular.woff2 b/v1.0.9/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/v1.0.9/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/v1.0.9/_static/css/fonts/fontawesome-webfont.eot b/v1.0.9/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/v1.0.9/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/v1.0.9/_static/css/fonts/fontawesome-webfont.svg b/v1.0.9/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/v1.0.9/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v1.0.9/_static/css/fonts/fontawesome-webfont.ttf b/v1.0.9/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/v1.0.9/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/v1.0.9/_static/css/fonts/fontawesome-webfont.woff b/v1.0.9/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/v1.0.9/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/v1.0.9/_static/css/fonts/fontawesome-webfont.woff2 b/v1.0.9/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/v1.0.9/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/v1.0.9/_static/css/fonts/lato-bold-italic.woff b/v1.0.9/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/v1.0.9/_static/css/fonts/lato-bold-italic.woff differ diff --git a/v1.0.9/_static/css/fonts/lato-bold-italic.woff2 b/v1.0.9/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/v1.0.9/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/v1.0.9/_static/css/fonts/lato-bold.woff b/v1.0.9/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/v1.0.9/_static/css/fonts/lato-bold.woff differ diff --git a/v1.0.9/_static/css/fonts/lato-bold.woff2 b/v1.0.9/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/v1.0.9/_static/css/fonts/lato-bold.woff2 differ diff --git a/v1.0.9/_static/css/fonts/lato-normal-italic.woff b/v1.0.9/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/v1.0.9/_static/css/fonts/lato-normal-italic.woff differ diff --git a/v1.0.9/_static/css/fonts/lato-normal-italic.woff2 b/v1.0.9/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/v1.0.9/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/v1.0.9/_static/css/fonts/lato-normal.woff b/v1.0.9/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/v1.0.9/_static/css/fonts/lato-normal.woff differ diff --git a/v1.0.9/_static/css/fonts/lato-normal.woff2 b/v1.0.9/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/v1.0.9/_static/css/fonts/lato-normal.woff2 differ diff --git a/v1.0.9/_static/css/theme.css b/v1.0.9/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/v1.0.9/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/v1.0.9/_static/custom.css b/v1.0.9/_static/custom.css new file mode 100644 index 00000000..b20d6282 --- /dev/null +++ b/v1.0.9/_static/custom.css @@ -0,0 +1,91 @@ + +body{ + background: #FFFFFF !important; +} + +.wy-menu-vertical header, .wy-menu-vertical p.caption{ + color: #4EA0AF!important; +} +.wy-menu-vertical li.current{ + background-color: #f4f4f4!important; +} +.wy-menu-vertical li.toctree-l2.current>a{ + background-color: #ebebeb!important; +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{ + background-color: #e3e3e3!important; +} + +.rst-content .sidebar{ + background-color: #fff!important; + border-radius: 6px; + -moz-border-radius: 6px; + -webkit-border-radius: 6px; +} + +h1 > a, h2 > a, h3 > a, h4 > a, h5 > a, h6 > a { + color: #17d9ff; +} + +h1, h2, h3, h4, h5, h6 { + color: black; + font-weight: normal; + padding: 0; +} + +h1, h2, h3 { + margin-top: 30px; + margin-bottom: 20px; +} + +h1 { + color: white; + padding: 20px 20px 20px 45px; + margin: 20px 0 35px -45px; + background: linear-gradient(to left, #fff, #2b38ff)!important; + + width: calc(100% + 90px); + border-bottom: 3px solid #000; +} + +h2 { + padding: .2em 0; + border-bottom: 1px solid #ddd; +} + +h3 { + margin-top: 35px; +} + +h4 { + margin-top: 30px; +} + +h5 { + margin-top: 25px; +} + +.wy-nav-content{ + max-width: none!important; +} + +.wy-side-nav-search{ + background: #2b38ff!important; +} + +.wy-side-nav-search input[type=text]{ + border-color:#4DA0B0!important; +} + +.wy-side-nav-search input[type=text]{ + border-radius: 4px!important; +} + +#caption-api { + background: red !important; +} + +#caption-text-api { + text-color: blue !important; +} diff --git a/v1.0.9/_static/doctools.js b/v1.0.9/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/v1.0.9/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/v1.0.9/_static/documentation_options.js b/v1.0.9/_static/documentation_options.js new file mode 100644 index 00000000..6cdba283 --- /dev/null +++ b/v1.0.9/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '1.0.9', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/v1.0.9/_static/file.png b/v1.0.9/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/v1.0.9/_static/file.png differ diff --git a/v1.0.9/_static/hymd_icon_white.png b/v1.0.9/_static/hymd_icon_white.png new file mode 100644 index 00000000..d0396a17 Binary files /dev/null and b/v1.0.9/_static/hymd_icon_white.png differ diff --git a/v1.0.9/_static/hymd_logl_white_text_abbr.png b/v1.0.9/_static/hymd_logl_white_text_abbr.png new file mode 100644 index 00000000..8c0e50c8 Binary files /dev/null and b/v1.0.9/_static/hymd_logl_white_text_abbr.png differ diff --git a/v1.0.9/_static/jquery-3.5.1.js b/v1.0.9/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/v1.0.9/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. API reference

+
+

4.1. Integrator

+

Integrates equations of motion.

+

Implements the Velocity Verlet integrator. The reversible reference system +propagator algorithm (rRESPA) integrator uses the Velocity Verlet functions +inside the MD loop in the main module.

+
+
+hymd.integrator.integrate_position(positions, velocities, time_step)[source]
+

Position update step of the Velocity Verlet integration algorithm.

+

Computes the position update step of the Velocity Verlet algorithm. The +positions argument is not changed in place.

+
+
Parameters:
+
+
positions(N, D) numpy.ndarray

Array of positions of N particles in D dimensions.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_velocity

The velocity update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step, then the positions are updated a full step using the updated +velocities

+
+\[\mathbf{x}_{\text{new}} = \mathbf{x} + \Delta t \mathbf{v}\]
+
+ +
+
+hymd.integrator.integrate_velocity(velocities, accelerations, time_step)[source]
+

Velocity update step of the Velocity Verlet integration algorithm.

+

Computes the velocity update step of the Velocity Verlet algorithm. The +velocities argument is not changed in place.

+
+
Parameters:
+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
accelerations(N, D) numpy.ndarray

Array of accelerations of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_position

The position update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step

+
+\[\mathbf{v}_{\text{new}} = \mathbf{v} + \frac{\Delta t}{2m} +\mathbf{f}\]
+

before the positions are moved a full step using the updated half-step +velocities.

+
+ +
+
+

4.2. Thermostat

+

Scales or otherwise modifies the particle velocities during simulation to +simulate coupling to an external heat bath with temperature T₀.

+
+
+hymd.thermostat._random_chi_squared(prng: numpy.random._generator.Generator, M: int)float[source]
+

Draw the sum of M squared normally distributed values

+

The value is generated by the Gamma distribution, in lieu of generating +M Gaussian distributed numbers and summing their squares.

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
Mint

Number of standard normally distributed numbers in the sum.

+
+
+
+
Returns:
+
+
float

The sum of M squared normally distributed values centered at +zero with unit standard deviation.

+
+
+
+
+

Notes

+

The sum of the squares of k independent standard normal random variables is +distributed according to a \(\chi^2\) distribution.

+
+\[\chi^2_1 + \chi_2^2 + \chi_3^2 + \dots + \chi_M^2 +\sim +\sigma^2\chi^2(k)\]
+

This is a special case of the \(\Gamma\) distribution, +\(\Gamma(k/2, 2)\), and may be generated by

+
+\[\chi^2(k) \sim 2 \Gamma(k/2, 2)\]
+

References

+

Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of +Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. +J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246.

+
+ +
+
+hymd.thermostat._random_gaussian(prng: numpy.random._generator.Generator)float[source]
+

Draw a single random number from the standard normal distribution +Generate a number from the Gaussian distribution centered at zero with unit +standard deviation, \(N(0, 1)\).

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
+
+
Returns:
+
+
float

A random number drawn from \(N(0, 1)\).

+
+
+
+
+
+ +
+
+hymd.thermostat.csvr_thermostat(velocity: numpy.ndarray, names: numpy.ndarray, config: hymd.input_parser.Config, prng: numpy.random._generator.Generator, comm: mpi4py.MPI.Intracomm = <mpi4py.MPI.Intracomm object>, random_gaussian: Callable[[numpy.random._generator.Generator], float] = <function _random_gaussian>, random_chi_squared: Callable[[numpy.random._generator.Generator, int, float], float] = <function _random_chi_squared>, remove_center_of_mass_momentum: bool = True)numpy.ndarray[source]
+

Canonical sampling through velocity rescaling thermostat

+

Implements the CSVR thermostat. Rescales the system kinetic energy by a +stochastically chosen factor to keep the temperature constant. Requires +communcation of the kinetic energies calculated locally for each MPI rank. +The random numbers sampled through random_gaussian and +random_chi_squared are broadcast from the root rank to the other +ranks to ensure the scaling is performed with the same stochasticity for +all particles in the full system.

+

The velocities are cleaned of center of mass momentum before the thermostat +is applied, and the center of mass momentum is subsequently reapplied. This +is performed for each thermostat coupling group, i.e. the center of mass +momenta of each group is separately removed and reapplied after +thermostatting.

+

The implementation here is based on the derivation presented in the 2008 +Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper.

+
+
Parameters:
+
+
velocity(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
names(N,) numpy.ndarray

Array of particle names.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
random_gaussiancallable, optional

Function for generating standard normally distributed numbers.

+
+
random_chi_squaredcallable, optional

Function for generating \(\chi^2\)-distributed numbers

+
+
remove_center_of_mass_momentumbool, optional

If True, the center of mass of each coupling group is removed before +the thermostat is applied. The center of mass momenta are added back +after the kinetic energy rescaling is complete.

+
+
+
+
+
+

See also

+
+
_random_gaussian

Used to sample Gaussian-distributed numbers.

+
+
_random_chi_squared

Used to sample \(\chi^2\)-distributed numbers.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +

References

+

G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). +G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008).

+
+ +
+
+

4.3. Hamiltonian

+
+
+class hymd.hamiltonian.Hamiltonian(config)[source]
+

Interaction energy functional superclass

+
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+_setup()[source]
+

Superclass setup

+

Sets up the grid-independent filtering function H, and the +SymPy logic for symbolically differentiating interaction energy +functionals in Hamiltonian subclasses.

+
+ +
+ +
+
+class hymd.hamiltonian.SquaredPhi(config)[source]
+

Simple squared density interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + \sum_k \tilde\phi_k + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(rho_0\) is the +average density of the fully homogenous system. Expressing the species +densities in terms of fluctuations from the average,

+
+\[\mathrm{d}\tilde\phi_k = \rho_0 - \tilde\phi_k,\]
+

it is evident that this interaction energy functional is a slight change of +the DefaultNoChi Hamiltonian, as the expanded interaction energy +density becomes

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + 6\rho_0\left[ + \sum_k \mathrm{d}\tilde\phi_k + \right] + + + 9\rho_0^2 + + + \sum_k \mathrm{d}\tilde\phi_k^2 + + + \prod_{k\not=l} + \mathrm{d}\tilde\phi_k \mathrm{d}\tilde\phi_l + \right),\]
+

identical to DefaultNoChi apart from a constant energy shift +\(9\rho_0^2`(which does not impact dynamics) and the +:math:\)rho_0`–\(\mathrm{d}\tilde\phi_k\) cross-terms. These +cross-terms constitute contributions to the energy linear in +\(\mathrm{d}\tilde\phi_k\) absent in DefaultNoChi, which has +only quadratic terms present.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultNoChi(config)[source]
+

Incompressibility-only interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a +\right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. The SquaredPhi Hamiltonian implements a similar +functional with an additional linear term component depending on

+
+\[\mathmr{d}\tilde\phi_k = \tilde\phi_k - \rho_0\]
+

and not \(\mathrm{d}\tilde\phi_k^2\). No explicit inter-species +interaction is present apart from the indirect interaction through the +incompressibility.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultWithChi(config, unique_names, type_to_name_map)[source]
+

Incompressibility and \(\chi\)-interactions energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = + \frac{1}{2\rho_0} + \sum_{k,l}\chi_{kl} \tilde\phi_k \tilde\phi_l + + + \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. \(\chi_{ij}\) is the Flory-Huggins-like +inter-species mixing energy.

+
+
+__init__(config, unique_names, type_to_name_map)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup(unique_names, type_to_name_map)[source]
+

Setup the interaction energy potential and the external potential

+
+
Parameters:
+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+ +
+ +
+
+

4.4. Force

+

Calculates intramolecular forces between bonded particles in molecules

+
+
+class hymd.force.Angle(atom_1: str, atom_2: str, equilibrium: float, strength: float, atom_3: str)[source]
+

Dataclass representing a single three-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any three-particle bond between particles of specific types A, +B, and C (where A, B, and C may be +different or the same). Harmonic angular three-particle bonds in HyMD take +the form

+
+\[V_3(\mathbf{r}_1, \mathbf{r}_2, \mathbf{r}_3) = + \frac{1}{2}k + \left( + \cos^{-1} + \left[ + \frac{ + (\mathbf{r}_1-\mathbf{r}_2) + \cdot + (\mathbf{r}_3-\mathbf{r}_2) + } + { + \vert\mathbf{r}_1-\mathbf{r}_2\vert + \vert\mathbf{r}_3-\mathbf{r}_2\vert + } + \right] - \theta_0 + \right)^2\]
+
+

See also

+
+
Bond

Two-particle bond type dataclass

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
equilibriumfloat

Equilibrium angle at which the energy associated with the +three-particle angular bond vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient.

+
+
+
+
+
+
+atom_3: str
+
+ +
+ +
+
+class hymd.force.Bond(atom_1: str, atom_2: str, equilibrium: float, strength: float)[source]
+

Dataclass representing a single two-particle bond type

+

A bond type is a bond strength and equilibrium distance associated with +any bond between particles of specific types A and B +(where A and B may be the same or different). Harmonic +two-particle bonds in HyMD take the form

+
+\[V_2(\mathbf{r}_1, \mathbf{r}_2) = + \frac{1}{2}k + \left( + \vert \mathbf{r}_1 - \mathbf{r}_2 \vert - r_0 + \right)^2,\]
+

where \(k\) is the bond strength (spring constant) and \(r_0\) is +the equilibrium bond length (at which the energy is zero).

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
equilibriumfloat

Equilibrium distance at which the energy associated with the bond +vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient (spring constant).

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+equilibrium: float
+
+ +
+
+strength: float
+
+ +
+ +
+
+class hymd.force.Chi(atom_1: str, atom_2: str, interaction_energy: float)[source]
+

Dataclass representing a single \(\chi\) mixing interaction type

+

An interaction mixing energy type is a mixing energy associated with +density overlap between species of types A and B +(specified as inputs atom_1 and atom_2). A positive mixing +energy promotes phase separation, a negative mixing energy promotes mixing. +The interaction energy density (provided the DefaultWithChi +Hamiltonian is used) takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} + \sum_{k,l}\chi_{k,l} \tilde\phi_k\tilde\phi_l,\]
+

where \(\chi_{k,l}\) denotes the mixing energy between species +\(k\) and \(l\), with \(\kappa\) being the incompressibility. +The value of the interaction mixing energy parameter may be extracted from +Flory-Huggins theory.

+
+

See also

+
+
hymd.hamiltonian.DefaultWithChi

Interaction energy functional using \(\chi\)-interactions.

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
interaction_energyfloat

Interaction mixing energy.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+interaction_energy: float
+
+ +
+ +
+
+class hymd.force.Dielectric_type(atom_1: str, dielectric_value: float)[source]
+
+
+atom_1: str
+
+ +
+
+dielectric_value: float
+
+ +
+ +
+
+class hymd.force.Dihedral(atom_1: str, atom_2: str, atom_3: str, atom_4: str, coeffs: numpy.ndarray, dih_type: int)[source]
+

Dataclass representing a single four-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any four-particle torsional bond between particles of specific types +A, B, C, and D (where A, B, +C, and D may be different or the same). Dihedral +four-particle bonds in HyMD take different forms depending on the +dih_type parameter.

+

In the following, let \(\phi\) denote the angle between the planes +spanned by the relative positions of atoms A-B-C +and B-C-D. If dih_type = 0, then

+
+\[V_4(\phi) = \sum_n c_n + \left( + 1 + \cos\left[ + n\phi - d_n + \right] + \right),\]
+

where \(c_n\) are energy coefficients and \(d_n\) are propensity +phases. By default, the cosine sum is truncated at five terms. If +coeffs provides only a single float, this is used as the coiling +propensity parameter \(\lambda\). In this case, \(c_n\) and +\(d_n\) are automatically set to values which promote alpha helical +(\(\lambda=-1\)), beta sheet (\(\lambda=1\)), or a mixed +(\(1>\lambda>-1\)) structure (using values provided by Bore et al. +(2018)). In this case, the full potential takes the form

+
+\[V_4(\phi;\lambda) = + \frac{1}{2}(1-\lambda) V_{\text{prop},\alpha}(\phi) + + + \frac{1}{2}(1+\lambda) V_{\text{prop},\beta}(\phi) + + + (1-\vert\lambda\vert) V_{\text{prop}, \text{coil}}(\phi),\]
+

with each of the \(V_{\mathrm{prop}, X}\) being fixed cosine series +potentials with pre-set \(c_n\) -s and \(d_n\) -s.

+

If dih_type = 1, then a combined bending torsional (CBT) potential +is employed,

+
+\[V_4(\phi,\gamma;\lambda) = + V_4(\phi;\lambda) + + + \frac{1}{2}K(\phi)(\gamma - \gamma_0)^2,\]
+

where \(V_4(\phi;\lambda)\) specifies the potential as given by the +coiling propensity parameter above, \(K(\phi)\) is a separate cosine +series potential acting as the angular three-particle bond strength, and +\(\gamma_0\) is the three-particle bond equilibrium angle. In this +case, the coeffs parameter must specify both a \(\lambda\) +value, in additon to the energy and phases dictating the \(K(\phi)\) +potential.

+

References

+

Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018.

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
atom_4str

Type name of particle 4.

+
+
coeffslist[list[float]] or list[float] or numpy.ndarray

Dihedral coefficients defining the series expansion of the dihedral +energy.

+
+
dih_typeint

Specifies the type of dihedral used; If 0, then coeffs +must contain either two lists of five energy coefficients +\(c_n\) and five propensity phases \(d_n\) or a single +floating point number defining the \(\lambda\) coiling propensity +parameter. If 1, the combined bending-torsional potential is +used, and coeffs must specify \(\lambda\) and two lists +containing energy coefficients and propensity phases for the +\(V_\text{prop}\) propensity potential, defined in terms of cosine +series.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+atom_3: str
+
+ +
+
+atom_4: str
+
+ +
+
+coeffs: numpy.ndarray
+
+ +
+
+dih_type: int
+
+ +
+ +
+
+hymd.force.compute_angle_forces__plain(f_angles, r, bonds_3, box_size)[source]
+

Computes forces resulting from angular interactions

+
+

Deprecated since version 1.0.0: compute_angle_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_bond_forces__plain(f_bonds, r, bonds_2, box_size)[source]
+

Computes forces resulting from bonded interactions

+
+

Deprecated since version 1.0.0: compute_bond_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size)[source]
+

Computes forces resulting from dihedral interactions

+
+

Deprecated since version 1.0.0: compute_dihedral_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.dipole_forces_redistribution(f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb)[source]
+

Redistribute electrostatic forces calculated from topologically +reconstructed ghost dipole point charges to the backcone atoms of the protein.

+
+ +
+
+hymd.force.find_all_paths(G, u, n)[source]
+

Helper function that recursively finds all paths of given lenght ‘n + 1’ inside a network ‘G’. +Adapted from https://stackoverflow.com/a/28103735.

+
+ +
+
+hymd.force.prepare_bonds(molecules, names, bonds, indices, config, topol=None)[source]
+

Rearrange the bond information for usage in compiled Fortran kernels

+

Restructures the lists resulting from the execution of +prepare_bonds_old into numpy arrays suitable for calls to optimized +Fortran code calculating bonded forces and energiesself.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2_atom_1(B,) numpy.ndarray

Local index of particle 1 for each of B constructed +two-particle bonds.

+
+
bonds_2_atom_2(B,) numpy.ndarray

Local index of particle 2 for each of B constructed +two-particle bonds.

+
+
bonds_2_equilibrium(B,) numpy.ndarray

Equilibrium distance for each of B constructed two-particle +bonds.

+
+
bonds_2_strength(B,) numpy.ndarray

Bond strength for each of B constructed two-particle +bonds.

+
+
bonds_3_atom_1(A,) numpy.ndarray

Local index of particle 1 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_2(A,) numpy.ndarray

Local index of particle 2 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_3(A,) numpy.ndarray

Local index of particle 3 for each of A constructed +three-particle bonds.

+
+
bonds_3_equilibrium(A,) numpy.ndarray

Equilibrium angle for each of A constructed three-particle +bonds.

+
+
bonds_3_strength(A,) numpy.ndarray

Bond strength for each of A constructed three-particle +bonds.

+
+
bonds_4_atom_1(D,) numpy.ndarray

Local index of particle 1 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_2(D,) numpy.ndarray

Local index of particle 2 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_3(D,) numpy.ndarray

Local index of particle 3 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_4(D,) numpy.ndarray

Local index of particle 4 for each of D constructed +four-particle bonds.

+
+
bonds_4_coeff(D,) numpy.ndarray

Cosine series coefficients for each of D constructed +four-particle bonds.

+
+
bonds_4_type(D,) numpy.ndarray

Dihedral type for each of D constructed four-particle +bonds.

+
+
bonds_4_last(D,) numpy.ndarray

Flags indicating if dih_type is 1 for each of D +constructed four-particle bonds.

+
+
+
+
+
+

See also

+
+
prepare_bonds_old

Used internally to reconstruct the bonded interactions types from the connectivity information in the structure/topology input file and the bonded types specified in the configuration file.

+
+
+ +
+ +
+
+hymd.force.prepare_bonds_old(molecules, names, bonds, indices, config)[source]
+

Find bonded interactions from connectivity and bond types information

+
+

Deprecated since version 1.0.0: prepare_bonds_old was replaced by prepare_bonds for +use with compiled Fortran kernels prior to 1.0.0 release.

+
+

Prepares the necessary equilibrium and bond strength information needed by +the intramolecular interaction functions. This is performed locally on each +MPI rank, as the domain decomposition ensures that for all molecules all +consituent particles are always contained on the same MPI rankself.

+

This function traverses the bond connectivity information provided in the +structure/topology input file and indentifies any two-, three-, or +four-particle potential bonds. For each connected chain of two, three, or +four particles, a matching to bond types is attempted. If the corresponding +names match, a bond object is initialized.

+

In order to investigate the connectivity, a graph is created using +networkx functionality.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2list

List of lists containing local particle indices, equilibrium +distance, and bond strength coefficient for each reconstructed +two-particle bond.

+
+
bonds_3

List of lists containing local particle indices, equilibrium angle, +and bond strength coefficient for each reconstructed three-particle +bond.

+
+
bonds_4

List of lists containing local particle indices, dihedral type index, +and dihedral coefficients for each reconstructed four-particle +torsional bond.

+
+
bb_indexlist

List indicating the dihedral type of each four-particle bond in +bonds_4.

+
+
+
+
+
+

See also

+
+
Bond

Two-particle bond type dataclass.

+
+
Angle

Three-particle angular bond type dataclass.

+
+
Dihedral

Four-particle torsional bond type dataclass.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+hymd.force.prepare_index_based_bonds(molecules, topol)[source]
+
+ +
+
+hymd.force.propensity_potential_coeffs(x: float)[source]
+
+ +
+
+

4.5. Logger

+
+
+class hymd.logger.Logger[source]
+

Log output handler class

+

Notes

+

This wraps the default python library logging, see +docs.python.org/3/library/logging.html.

+
+
Attributes:
+
+
levelint

Determines the verbosity level of the log, corresponding to +logging.level. Numerical values 50 (logging.CRITICAL), +40 (logging.ERROR), 30 +(logging.WARNING), 20 (logging.INFO), +10 (logging.DEBUG), and 0 +(logging.UNSET) are supported values. Any log event message +less severe than the specified level is ignored. All other event +messages are emitted.

+
+
log_filestr

Path to output log file.

+
+
formatstr

Prepended dump string for each log event. Specifies the log event +level, the module emitting the event, the code line, the enclosing +function name, and the MPI rank writing the message.

+
+
date_formatstr

Prepends the date before all log event messages.

+
+
formatterlogging.Formatter

Formatter handling the prepending of the information in format and +date_format to each log event message. Used by default for all +loggers.

+
+
rank0logging.Logger

Default logger object for the root MPI rank.

+
+
all_rankslogging.Logger

Default logger object for messages being emitted from all MPI ranks +simultaneously.

+
+
+
+
+
+
+classmethod setup(default_level=20, log_file=None, verbose=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Sets up the logger object.

+

If a log_file path is provided, log event messages are output +to it. Otherwise, the logging messages are emitted to stdout.

+
+
Parameters:
+
+
default_levelint, optional

Default verbosity level of the logger. Unless specified, it is +10 (logging.INFO).

+
+
log_filestr, optional

Path to output log file. If None or not priovided, no log file is +used and all logging is done to stdout.

+
+
verbosebool, optional

Increases the logging level to 30 (logging.WARNING) +if True, otherwise leaves the logging level unchanged.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterRoot(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the root MPI rank log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterAll(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the all-MPI-ranks log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+

4.6. Input parser

+

Parses and handles the configuration information provided for the simulation

+
+
+class hymd.input_parser.Config(n_steps: int, time_step: float, mesh_size: Union[List[int], numpy.ndarray, int], sigma: float, kappa: float, dtype: Optional[numpy.dtype] = None, box_size: Optional[Union[List[float], numpy.ndarray]] = None, n_print: Optional[int] = None, tau: Optional[float] = None, start_temperature: Optional[Union[float, bool]] = None, target_temperature: Optional[Union[float, bool]] = None, mass: Optional[float] = None, hamiltonian: Optional[str] = None, domain_decomposition: Optional[Union[int, bool]] = None, integrator: Optional[str] = None, respa_inner: int = 1, file_name: str = '<config file path unknown>', name: Optional[str] = None, tags: List[str] = <factory>, bonds: List[hymd.force.Bond] = <factory>, angle_bonds: List[hymd.force.Angle] = <factory>, dihedrals: List[hymd.force.Dihedral] = <factory>, chi: List[hymd.force.Chi] = <factory>, n_particles: Optional[int] = None, max_molecule_size: Optional[int] = None, n_flush: Optional[int] = None, thermostat_work: float = 0.0, thermostat_coupling_groups: List[List[str]] = <factory>, initial_energy: Optional[float] = None, cancel_com_momentum: Union[int, bool] = False, coulombtype: Optional[str] = None, convergence_type: Optional[str] = None, pol_mixing: Optional[float] = None, dielectric_const: Optional[float] = None, conv_crit: Optional[float] = None, dielectric_type: List[hymd.force.Dielectric_type] = <factory>, self_energy: Optional[float] = None, type_charges: Optional[Union[List[float], numpy.ndarray]] = None, rho0: Optional[float] = None, a: Optional[float] = None, pressure: bool = False, barostat: Optional[str] = None, barostat_type: Optional[str] = None, tau_p: Optional[float] = None, target_pressure: List[hymd.barostat.Target_pressure] = <factory>, n_b: Optional[int] = None, m: List[float] = <factory>)[source]
+

Configuration object

+

Handles and verifies the simulation configuration specified in the +configuration file.

+
+

See also

+
+
hymd.input_parser.Bond

Two-particle bond type dataclass.

+
+
hymd.input_parser.Angle

Three-particle bond type dataclass.

+
+
hymd.input_parser.Dihedral

Four-particle bond type dataclass.

+
+
+ +
+
Attributes:
+
+
gas_constantfloat

Constant value of the gas constant, R (equivalently the Boltzmann +constant) in the units used internally in HyMD.

+
+
coulomb_constantfloat

Constant value of the Coulomb constant which converts electric field +values to forces and electric potential values to energies in the units +used internally in HyMD.

+
+
n_steps: int

Number of time steps in the simulation.

+
+
time_step: float

Outer time step used in the simulation. If the rRESPA intergrator is +used, the inner time step (the time step used in the integration of +intramolecular bending, stretching, and torsional forces) is +time_step / respa_inner.

+
+
box_sizelist[float] or (D,) numpy.ndarray

Simulation box size of simulation in D dimensions in units of +nanometers.

+
+
mesh_sizelist[int] or int or numpy.ndarray

Number of grid points used for the discrete density grid.

+
+
sigmafloat

Filter width representing the effective coarse-graining level of the +particles in the simulation.

+
+
kappafloat

Compressibility parameter used in the relaxed incompressibility term in +the interaction energy functional.

+
+
n_printint, optional

Frequency of trajectory/energy output to the H5MD trajectory/energy +output file (in units of number of time steps).

+
+
taufloat, optional

The time scale of the CSVR thermostat coupling.

+
+
start_temperaturefloat, optional

Generate starting temperature by assigning all particle velocities +randomly according to the Maxwell-Boltzmann distribution at +start_temperature Kelvin prior to starting the simulation.

+
+
target_temperaturefloat, optional

Couple the system to a heat bath at target_temperature Kelvin.

+
+
massfloat, optional

Mass of the particles in the simulation.

+
+
hamiltonianstr, optional

Specifies the interaction energy functional \(W[\tilde\phi]\) +for use with the particle-field interactions. Options: +SquaredPhi, DefaultNohChi, or DefaultWithChi.

+
+
domain_decompositionint, optional

Specifies the interval (in time steps) of domain decomposition +exchange, involving all MPI ranks sending and receiving particles +according to the particles’ positions in the integration box and the +MPI ranks’ assigned domain.

+
+
integratorstr, optional

Specifies the time integrator used in the simulation. Options: +velocity-verlet or respa.

+
+
respa_innerint, optional

The number of inner time steps in the rRESPA integrator. This denotes +the number of intramolecular force calculations (stretching, bending, +torsional) are performed between each impulse applied from the field +forces.

+
+
file_namestr, optional

File path of the parsed configuration file.

+
+
namestr, optional

Name for the simulation.

+
+
tagslist[str], optional

Tags for the simulation.

+
+
bondslist[Bond], optional

Specifies harmonic stretching potentials between particles in the +same molecule.

+
+
angle_bondslist[Angle], optional

Specifies harmonic angular bending potentials between particles in the +same molecule.

+
+
dihedralslist[Dihedral], optional

Specifies four-particle torsional potentials by cosine series.

+
+
chilist[Chi], optional

Specifies \(\chi\)-interaction parameters between particle +species.

+
+
n_particlesint, optional

Specifies the total number of particles in the input. Optional keyword +for validation, ensuring the input HDF5 topology has the correct number +of particles and molecules.

+
+
max_molecule_sizeint, optional

Maximum size of any single molecule in the system. Used to speed up +distribution of particles onto MPI ranks in a parallel fashion.

+
+
n_flushint, optional

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be +written to disk (in units of number of n_print).

+
+
thermostat_workfloat

Work performed by the thermostat on the system.

+
+
thermostat_coupling_groupslist[str], optional

Specifies individual groups coupling independently to the CSVR +thermostat. E.g. in a system containing "A", "B", and +"C" type particles, +thermostat_coupling_groups = [["A", "B"], ["C"],] would +thermalise types "A" and "B" together and couple +"C" type particles to a different thermostat (all individual +thermostats are at the same temperature, i.e. target_temperature +Kelvin).

+
+
initial_energyfloat

Value of the total energy prior to the start of the simulation.

+
+
cancel_com_momentumint, optional

If True, the total linear momentum of the center of mass is +removed before starting the simulation. If an integer is specifed, the +total linear momentum of the center of mass is removed every +remove_com_momentum time steps. If False, the linear +momentum is never removed.

+
+
coulombtypestr, optional

Specifies the type of electrostatic Coulomb interactions in the system. +The strength of the electrostatic forces is modulated by the relative +dielectric constant of the simulation medium, specified with the +dielectric_const keyword. Charges for individual particles are +specified in the structure/topology HDF5 input file, not in the +configuration file. If no charges (or peptide backbone dipoles) are +present, the electrostatic forces will not be calculated even if this +keyword is set to "PIC_Spectral".

+
+
dielectric_constfloat, optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. When +using helical propensity dihedrals, this keyword must be specified—even +if electrostatics are not included with the coulombtype +keyword.

+
+
dielectric_type: list[float], optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. The list assigns +relative dielectric values to each bead type, and an anisotropic +dielectric function is obtained from a weighted average.

+
+
+
+
+
+
+a: float = None
+
+ +
+
+angle_bonds: List[hymd.force.Angle]
+
+ +
+
+barostat: str = None
+
+ +
+
+barostat_type: str = None
+
+ +
+
+bonds: List[hymd.force.Bond]
+
+ +
+
+box_size: Union[List[float], numpy.ndarray] = None
+
+ +
+
+cancel_com_momentum: Union[int, bool] = False
+
+ +
+
+chi: List[hymd.force.Chi]
+
+ +
+
+conv_crit: float = None
+
+ +
+
+convergence_type: str = None
+
+ +
+
+coulomb_constant: ClassVar[float] = 138.935458
+
+ +
+
+coulombtype: str = None
+
+ +
+
+dielectric_const: float = None
+
+ +
+
+dielectric_type: List[hymd.force.Dielectric_type]
+
+ +
+
+dihedrals: List[hymd.force.Dihedral]
+
+ +
+
+domain_decomposition: Union[int, bool] = None
+
+ +
+
+dtype: numpy.dtype = None
+
+ +
+
+file_name: str = '<config file path unknown>'
+
+ +
+
+gas_constant: ClassVar[float] = 0.0083144621
+
+ +
+
+hamiltonian: str = None
+
+ +
+
+initial_energy: float = None
+
+ +
+
+integrator: str = None
+
+ +
+
+kappa: float
+
+ +
+
+m: List[float]
+
+ +
+
+mass: float = None
+
+ +
+
+max_molecule_size: int = None
+
+ +
+
+mesh_size: Union[List[int], numpy.ndarray, int]
+
+ +
+
+n_b: int = None
+
+ +
+
+n_flush: int = None
+
+ +
+
+n_particles: int = None
+
+ +
+
+n_print: int = None
+
+ +
+
+n_steps: int
+
+ +
+
+name: str = None
+
+ +
+
+pol_mixing: float = None
+
+ +
+
+pressure: bool = False
+
+ +
+
+respa_inner: int = 1
+
+ +
+
+rho0: float = None
+
+ +
+
+self_energy: float = None
+
+ +
+
+sigma: float
+
+ +
+
+start_temperature: Union[float, bool] = None
+
+ +
+
+tags: List[str]
+
+ +
+
+target_pressure: List[hymd.barostat.Target_pressure]
+
+ +
+
+target_temperature: Union[float, bool] = None
+
+ +
+
+tau: float = None
+
+ +
+
+tau_p: float = None
+
+ +
+
+thermostat_coupling_groups: List[List[str]]
+
+ +
+
+thermostat_work: float = 0.0
+
+ +
+
+time_step: float
+
+ +
+
+type_charges: Union[List[float], numpy.ndarray] = None
+
+ +
+ +
+
+hymd.input_parser.check_NPT_conditions(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check validity of barostat_type, barostat, +a, rho0, target_pressure, tau_p

+
+ +
+
+hymd.input_parser.check_angles(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_bonds(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_box_size(config, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_cancel_com_momentum(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_charges(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if charges across ranks sum to zero.

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of floats with charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_charges_types_list(config, types, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates a list of charge values of length types. +Charges are sorted according to type ID. Used in field.py. +# TODO: this is messy, we should fix it

+
+ +
+
+hymd.input_parser.check_chi(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_config(config, indices, names, types, charges, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs various checks on the specfied config to ensure consistency

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
indices(N,) numpy.ndarray

Array of integer indices for N particles.

+
+
names(N,) numpy.ndarray

Array of string names for N particles.

+
+
types(N,) numpy.ndarray

Array of integer type indices for N particles.

+
+
charges(N,) numpy.ndarray

Array of floats charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
Returns:
+
+
configConfig

Validated configuration object.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_dielectric(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Error handling for electrostatics. +Unit testing of toml/tomli input.

+
+ +
+
+hymd.input_parser.check_dihedrals(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_domain_decomposition(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_hamiltonian(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_integrator(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_m(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_mass(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_max_molecule_size(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_b(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_flush(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_particles(config, indices, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_print(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_name(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_start_and_target_temperature(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Validate provided starting and target thermostat temperatures

+

Assesses the provided temperature target and ensures it is a non-negative +floating point number or False. Ensures the starting temperature is +a non-negative floating point number or False.

+

If the value for either is None, the returned configuration object +has the values defaulted to False in each case.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
validated_configConfig

Configuration object with validated target_temperature and +start_temperature.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_tau(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_thermostat_coupling_groups(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.parse_config_toml(toml_content, file_path=None, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.read_config_toml(file_path)[source]
+
+ +
+
+hymd.input_parser.sort_dielectric_by_type_id(config, charges, types)[source]
+

Creates a list of length N CG-particles, sorted after the charges from +the input HDF5 file. Used in file_io.py

+
+ +
+
+

4.7. Field

+

Forces and energies from the discretized particle-field grid interactions

+
+
+hymd.field.compute_field_and_kinetic_energy(phi, phi_q, psi, velocity, hamiltonian, positions, types, v_ext, config, layouts, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the particle-field and kinetic energy contributions

+

Calculates the kinetic energy through

+
+\[E_k = \sum_j \frac{1}{2}m_j\mathbf{v}_j\cdot\mathbf{v}_j,\]
+

and the particle-field energy by

+
+\[E_\text{field} = \int\mathrm{d}\mathbf{r}\, + w[\tilde\phi],\]
+

where \(w\) is the interaction energy functional density.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
velocity(N,D) numpy.ndarray

Array of velocities for N particles in D dimensions. +Local for each MPI rank.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Local for each MPI rank–the full computational grid is +represented by the collective fields of all MPI ranks.

+
+
configConfig

Configuration object.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field

Computes the up-to-date external potential for use in calculating the particle-field energy.

+
+
+ +
+ +
+
+hymd.field.compute_field_energy_q_GPE(config, phi_eps, field_q_energy, dot_elec, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the electrostatic energy after electrosatic forces is +calculated.

+

From the definition of the elecrostatic potential \(\Psi\), the energy +is

+
+
+
W = frac{1}{2}intmathrm{d}mathbf{r},

epsilon(mathbf{r})} left(mathbf{E}cdot mathbf{E}right),

+
+
+
+

where \(\epsilon(\mathbf{r})}\) is the anisotropic, spatially dependent, +relative dielectric of the simulation medium.

+
+
Parameters:
+
+
confighymd.input_parser.Config

Configuration object.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
field_q_energyfloat

Total elecrostatic energy.

+
+
dot_elecpmesh.pm.RealField

Pmesh RealField object for storing \(|\mathbf{E(r)}|^{2}\) +on the computational grid. Local for each MPI rank – the full computational +grid is represented by the collective fields of all MPI ranks.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field_force_q_GPE

Compute the electrosatic force from an anisotropic dielectric general Poisson equation.

+
+
+ +
+ +
+
+hymd.field.compute_field_force(layouts, r, force_mesh, force, types, n_types)[source]
+

Interpolate particle-field forces from the grid onto particle positions

+

Backmaps the forces calculated on the grid to particle positions using the +window function \(P\) (by default cloud-in-cell [CIC]). In the +following, let \(\mathbf{F}_j\) denote the force acting on the +particle with index \(j\) and position \(\mathbf{r}_j\). The +interpolated force is

+
+\[\mathbf{F}_j = -\sum_k\nabla V_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(V_{j_k}\) is the discretized external potential at grid vertex +\(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid vertex +with index \(j_k\), and \(h^3\) is the volume of each grid voxel. +The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
r(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
force(N,D) numpy.ndarray

Array of forces for N particles in D dimensions. Local +for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
n_typesint

Number of different unique types present in the simulation system. +n_types is global, i.e. the same for all MPI ranks even if some +ranks contain zero particles of certain types.

+
+
+
+
+
+ +
+
+hymd.field.compute_self_energy_q(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the self energy for the interaction due to the Ewald scheme +used to compute the electrostatics. The energy is stored in config.

+

The self interaction energy is given by:

+
+\[U_{self} = \sqrt{\frac{1}{2\pi\sigma^2}} \sum_{i=1}^{N} q_i^2\]
+

where \(q_i\) are the charges and \(\sigma\) is the half-width +of the Gaussian filter.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
Returns:
+
+
field_q_self_energyfloat

Electrostatic self energy.

+
+
+
+
+
+ +
+
+hymd.field.domain_decomposition(positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs domain decomposition

+

Rearranges the MPI rank memory layout into one that better mimics the PFFT +pencil grid 2D decomposition. As molecules are always required to be fully +contained on a single MPI rank, a perfect decomposition is not always +possible. The best decomposition which leaves the center of mass of all +molecules in their respective correct domains is used, with possible +overlap into neighbouring domains if the spatial extent of any molecule +crosses domain boundaries.

+
+
Parameters:
+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
*args

Variable length argument list containing arrays to include in the +domain decomposition.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
bonds(N,M) numpy.ndarray, optional

Array of M bonds originating from each of N particles.

+
+
verboseint, optional

Specify the logging event verbosity of this function.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
Domain decomposedcode:positions and any array specified in
+
:code:`*args`, in addition tocode:bonds and molecules if these
+
arrays were provided as input.
+
+
+
+
+ +
+
+hymd.field.initialize_pm(pmesh, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates the necessary pmesh objects for pfft operations.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pmobject ‘pmesh.pm.ParticleMesh’
+
field_listlist[pmesh.pm.RealField], (multiple)

Essential list of pmesh objects required for MD

+
+
list_coulomblist[pmesh.pm.RealField], (multiple)

Additional list of pmesh objects required for electrostatics.

+
+
+
+
+
+ +
+
+hymd.field.update_field(phi, phi_laplacian, phi_transfer, layouts, force_mesh, hamiltonian, pm, positions, types, config, v_ext, phi_fourier, v_ext_fourier, m, compute_potential=False)[source]
+

Calculate the particle-field potential and force density

+

If compute_potential is True, the energy may subsequently +be computed by calling compute_field_and_kinetic_energy.

+

Computes the particle-field external potential \(V_\text{ext}\) from +particle number densities through the smoothed density field, +\(\phi(\mathbf{r})\). With \(P\) being the cloud-in-cell (CIC) +window function, the density and filtered densities are computed as

+
+\[\phi(\mathbf{r}) = \sum_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\phi(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +external potential is computed in reciprocal space as

+
+\[V_\text{ext} = \mathrm{FFT}^{-1}\left[ + \mathrm{FFT} + \left( + \frac{\partial w}{\partial \tilde\phi} + \right) + \mathrm{FFT}(H) +\right],\]
+

where \(w\) is the interaction energy functional. Differentiating +\(V_\text{ext}\) is done by simply applying \(i\mathbf{k}\) in +Fourier space, and the resulting forces are back-transformed to direct +space and interpolated to particle positions by

+
+\[\mathbf{F}_j = -\sum_{j_k} \nabla V_{j_k} + P(\mathbf{r}_{j_k} - \mathbf{r}_j)h^3,\]
+

where \(j_k\) are the neighbouring vertices of particle \(j\) at +position \(\mathbf{r}_j\), and \(h^3\) is the volume of each grid +voxel.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Pre-allocated, but empty; any values +in this field are discarded. Changed in-place. Local for each MPI +rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
configConfig

Configuration object.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Pre-allocated, but empty; any values in this field are +discarded Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
phi_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computational grid is represented by the collective fields of all +MPI ranks.

+
+
v_ext_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplesField objects containing discretized +particle-field external potential values in reciprocal space on the +computational grid; D+1 fields in D dimensions for each +particle type. D copies are made after calculation for later +use in force calculation, because the force transfer function +application differentiates the field in-place, ruining the contents +for differentiation in the remaining D-1 spatial directions. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
m: list[float], (M,)

pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. +Defaults to 1.0 for all particle types.

+
+
compute_potentialbool, optional

If True, a D+1-th copy of the Fourier transformed +external potential field is made to be used later in particle-field +energy calculation. If False, only D copies are made.

+
+
+
+
+
+

See also

+
+
compute_field_and_kinetic_energy

Compute the particle-field energy after the external potential is calculated.

+
+
+ +
+ +
+
+hymd.field.update_field_force_q(charges, phi_q, phi_q_fourier, psi, psi_fourier, elec_field_fourier, elec_field, elec_forces, layout_q, hamiltonian, pm, positions, config)[source]
+

Calculate the electrostatic particle-field forces on the grid

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential is computed in reciprocal space as

+
+\[\Phi = \mathrm{FFT}^{-1}\left[ + \frac{4\pi k_e}{\varepsilon \vert\mathbf{k}\vert^2} + \mathrm{FFT}(\rho)\mathrm{FFT}(H) +\right],\]
+

with the electric field

+
+\[\mathbf{E} = \mathrm{FFT}^{-1}\left[ + -i\mathbf{k}\,\mathrm{FFT}(\Psi) +\right].\]
+

In the following, let \(\mathbf{F}_j\) denote the electrostatic force +acting on the particle with index \(j\) and position +\(\mathbf{r}_j\). The interpolated electrostatic force is

+
+\[\mathbf{F}_j = \sum_k q_j\mathbf{E}_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(\mathbf{E}_{j_k}\) is the discretized electric field at grid +vertex \(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid +vertex with index \(j_k\), and \(h^3\) is the volume of each grid +voxel. The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty; any values in this field +are discarded. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
elec_field_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +electric field values in reciprocal space on the computational grid. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
+
+
+
+ +
+
+hymd.field.update_field_force_q_GPE(conv_fun, phi, types, charges, phi_q, phi_q_fourier, phi_eps, phi_eps_fourier, phi_eta, phi_eta_fourier, phi_pol_prev, phi_pol, elec_field, elec_forces, elec_field_contrib, psi, Vbar_elec, Vbar_elec_fourier, force_mesh_elec, force_mesh_elec_fourier, hamiltonian, layout_q, layouts, pm, positions, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Calculate the electrostatic particle-field forces on the grid, arising from +a general Poisson equation, i.e. anisotropic permittivity/dielectric. +The function is called when tomli input config.coulombtype = “PIC_Spectral_GPE.”

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential for a variable dielectric does not have an +analytical expression, and is computed in reciprocal through an iterative +method.

+

The GPE states that

+
+\[\nabla \cdot \left(\epsilon(\mathbf{r}) +\nabla{\mathbf{\psi(r)}}\right) = -\rho({\mathbf{r}}).\]
+

where \(\epsilon(\mathbf{r})\) is the relative dielectric function.

+
+
Parameters:
+
+
conv_funConvergence function.

Returns a scalar. Depends on MPI allreduce for similar convergence +across MPI ranks.

+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_eps_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_etapmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +gradients of the relative dielectric values on the computational grid. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank–the +full computational grid is represented by the collective fields of all MPI ranks.

+
+
phi_eta_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated discretized +Fourier transformed gradient relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_pol_prevpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charge values on the computational grid. Parameter in +the iterative method.Pre-allocated,but empty. Changedin-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_polpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charges on the computational grid. Parameter in the iterative +method, updating the next quess in solving for the electrostatic potential. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank– +the full computational grid is represented by the collective fields of +all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all +MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
elec_field_contribpmesh.pm.RealField

Pmesh RealField object for storing +\(|\mathbf{E(r)}|^2/\phi_{0}\) on the computational grid. +Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
psipmesh.pm.RealField

Pmesh RealField object for storing electrostatic potential +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
Vbar_elecmesh.pm.RealField

Pmesh RealField object for storing functional derivatives of +:math:`|w({ phi })_{elec}`on the computational grid. +Pre-allocated, but empty. Changed in-place. Local for each MPI rank– +the full computational grid is represented by the collective fields of

+
+

all MPI ranks.

+
+
+
Vbar_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated functional +derivatives of \(\|w(\{ \phi \})_{elec}\) in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
force_mesh_elecpmesh.pm.RealField

Pmesh RealField object for storing electrostatic force values +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
force_mesh_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated electrostatic +force values in reciprocal space on the computational grid. Local for +each MPI rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
layouts: list[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
comm: mpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
compute_field_energy_q_GPE

Compute the electrostatic energy after electrosatic force is calculated for a variable (anisotropic) dielectric general Poisson equation.

+
+
+ +
+ +
+
+

4.8. File input/output

+

Handle file input/output in parllel HDF5 fashion

+
+
+class hymd.file_io.OutDataset(dest_directory, config, double_out=False, disable_mpio=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

HDF5 dataset handler for file output

+
+
+close_file(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Closes the HDF5 output file

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+
+flush()[source]
+

Flushes output buffers, forcing file writes

+
+ +
+
+is_open(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if HDF5 output file is open

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+ +
+
+hymd.file_io.distribute_input(in_file, rank, size, n_particles, max_molecule_size=201, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Assign global arrays onto MPI ranks, attempting load balancing

+

Distributes approximately equal numbers of particles (workload) onto each +independent MPI rank, while respecting the requirement that any molecule +must be fully contained on a single MPI rank only (no splitting molecules +across multiple CPUs).

+
+
Parameters:
+
+
in_fileh5py.File

HDF5 input file object.

+
+
rankint

Local rank number for this MPI rank.

+
+
sizeint

Global size of the MPI communicator (number of total CPUs).

+
+
n_particlesint

Total number of particles.

+
+
max_molecule_sizeint, optional

Maximum size of any molecule present in the system. Used to initially +guess where the MPI rank boundaries (start/end indices) in the global +arrays should be placed. If molecules of size +>max_molecule_size exist in the simulation system, HyMD +might work as expected. Or it might fail spectacularly.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
rank_range

Starting and ending indices in the global arrays for each MPI rank.

+
+
+
+
+
+ +
+
+hymd.file_io.setup_time_dependent_element(name, parent_group, n_frames, shape, dtype, units=None)[source]
+

Helper function for setting up time-dependent HDF5 group datasets

+

All output groups must adhere to the H5MD standard, meaning a structure of

+
+
┗━ group particle group (e.g. all) or observables group
+
+
┗━ group time-dependent data
+
+
┣━ dataset step shape=(n_frames,)
+
┣━ dataset time shape=(n_frames,)
+
┗━ dataset value shape=(n_frames, *)
+
+
+
+

is necessary.

+

References

+
+
H5MD specification :

https://www.nongnu.org/h5md/h5md.html

+
+
+
+ +
+
+hymd.file_io.store_data(h5md, step, frame, indices, positions, velocities, forces, box_size, temperature, pressure, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, field_energy, field_q_energy, plumed_bias, time_step, config, velocity_out=False, force_out=False, charge_out=False, plumed_out=False, dump_per_particle=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Writes time-step data to HDF5 output file

+

Handles all quantities which change during simulation, as opposed to +static quanitities (see store_static).

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
stepint

Step number.

+
+
frameint

Output frame number (step // n_print).

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
positions(N,) numpy.ndarray

Array of positions for N particles in D dimensions.

+
+
velocities(N,) numpy.ndarray

Array of velocities for N particles in D dimensions.

+
+
forces(N,) numpy.ndarray

Array of forces for N particles in D dimensions.

+
+
box_size(D,) numpy.ndarray

Array containing the simulation box size.

+
+
temperaturefloat

Calculated instantaneous temperature.

+
+
kinetic_energyfloat

Calculated instantaneous kinetic energy.

+
+
bond2_energyfloat

Calculated instantaneous harmonic two-particle bond energy.

+
+
bond3_energyfloat

Calculated instantaneous harmonic angular three-particle bond energy.

+
+
bond4_energyfloat

Calculated instantaneous dihedral four-particle torsion energy.

+
+
field_energyfloat

Calculated instantaneous particle-field energy.

+
+
field_q_energyfloat

Calculated instantaneous electrostatic energy.

+
+
plumed_biasfloat

PLUMED instantaneous bias energy.

+
+
time_stepfloat

Value of the time step.

+
+
configConfig

Configuration object.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charge_outbool, optional

If True, electrostatic energies are written to the output +HDF5 file.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to the output HDF5 file.

+
+
dump_per_particlebool, optional

If True, all quantities are written per particle.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
store_static

Outputs all static time-independent quantities to the HDF5 output file

+
+
+ +
+ +
+
+hymd.file_io.store_static(h5md, rank_range, names, types, indices, config, bonds_2_atom1, bonds_2_atom2, molecules=None, velocity_out=False, force_out=False, charges=False, dielectrics=False, plumed_out=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Outputs all static time-independent quantities to the HDF5 output file

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
rank_rangelist[int]

Start and end indices for global arrays for each MPI rank.

+
+
names(N,) numpy.ndarray

Array of names for N particles.

+
+
types(N,) numpy.ndarray

Array of type indices for N particles.

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
configConfig

Configuration object.

+
+
bonds_2_atom1(B,) numpy.ndarray

Array of indices of the first particle for B total +two-particle bonds.

+
+
bonds_2_atom2(B,) numpy.ndarray

Array of indices of the second particle for B total +two-particle bonds.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles.

+
+
dielectrics(N,) numpy.ndarray

Array of particle relative dielectric values for N particles.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to output HDF5 file.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
prepare_bonds

Constructs two-, three-, and four-particle bonds from toplogy input file and bond configuration information.

+
+
distribute_input

Distributes input arrays onto MPI ranks, attempting load balancing.

+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/doc_pages/benchmarks.html b/v1.0.9/doc_pages/benchmarks.html new file mode 100644 index 00000000..e0667a23 --- /dev/null +++ b/v1.0.9/doc_pages/benchmarks.html @@ -0,0 +1,302 @@ + + + + + + + 3. Benchmarks — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Benchmarks

+

Homopolymer melt test systems of \(30^2\), \(40^2\), and \(50^2\) +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively.

+
+

3.1. Bonded forces

+

Legend label denotes the number of particles in the system.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-1.png +
+
+
+

3.2. Particle–field forces

+

Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-2.png +
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/doc_pages/command_line.html b/v1.0.9/doc_pages/command_line.html new file mode 100644 index 00000000..c0b02d48 --- /dev/null +++ b/v1.0.9/doc_pages/command_line.html @@ -0,0 +1,359 @@ + + + + + + + 5. Command line arguments — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. Command line arguments

+

Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle–field interactions.

+
+

5.1. Required arguments

+
+
configuration file:
+

type positional

+

Specifies the .toml format configuration file containing simulation details. See Configuration file for details.

+
+
structure and topology file:
+

type positional

+

Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See Topology and structure file for details.

+
+
+
+
+

5.2. Optional arguments

+
+
-v  --verbose

type optional

+

Number of following arguments: 0 or 1

+

Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying -v or --verbose with no additional specification. This increases verbosity level by 1. Alternatively, it maye be specified by --verbose V with V being 0, 1, or 2.

+
+
--profile

type optional

+

Number of following arguments: 0

+

Enables code profiling using cProfile. This will output one profiling file per MPI rank invoked in the simulation.

+
+
--double-precision

type optional

+

Number of following arguments: 0

+

Specify usage of double precision internally in HyMD (including in the FFTs).

+
+
--double-output

type optional

+

Number of following arguments: 0

+

Specify usage of double precision in the output trajectory from HyMD.

+
+
--velocity-output

type optional

+

Number of following arguments: 0

+

Specify that velocities should be output to the HyMD trajectory.

+
+
--force-output

type optional

+

Number of following arguments: 0

+

Specify that forces should be output to the HyMD trajectory.

+
+
--disable-mpio

type optional

+

Number of following arguments: 0

+

Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult.

+
+
--logfile

type optional

+

Number of following arguments: 1

+

Specifies the path of a plain text log file in which stdout is mirrored during simulation runs.

+
+
--seed

type optional

+

Number of following arguments: 1

+

Specifies the random seed used in the numpy random library to generate velocities, thermostatting, etc.

+
+
--disable-bonds

type optional

+

Number of following arguments: 0

+

Disable any two-particle bonds present in the system.

+
+
--disable-angle-bonds

type optional

+

Number of following arguments: 0

+

Disable any three-particle bonds present in the system.

+
+
--disable-dihedrals

type optional

+

Number of following arguments: 0

+

Disable any four-particle bonds present in the system.

+
+
--disable-dipole

type optional

+

Number of following arguments: 0

+

Disable any topological reconstruction of peptide backbone dipoles present in the system.

+
+
--disable-field

type optional

+

Number of following arguments: 0

+

Disable any particle–field interactions present in the system.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/doc_pages/config_file.html b/v1.0.9/doc_pages/config_file.html new file mode 100644 index 00000000..87f1c86c --- /dev/null +++ b/v1.0.9/doc_pages/config_file.html @@ -0,0 +1,446 @@ + + + + + + + 3. Configuration file — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Configuration file

+

The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order.

+

The configuration file is a toml format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs.

+
+

3.1. Configuration file keywords

+

The following constitutes every possible keyword specification in HyMD +configuration files:

+
+

3.1.1. Metadata keywords

+

Configuration keywords specifying metadata for the H5MD output trajectory.

+
+
name:
+

string [optional, default: None]

+

Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file.

+
+
tags:
+

array [string] [optional, default: None]

+

Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file.

+
+
+
+
+

3.1.2. Particle keywords

+

Configuration keywords specifying properties of particles and molecules in the +system.

+
+
n_particles:
+

integer [optional, default: None]

+

Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules.

+
+
mass:
+

float [optional, default: 72.0] {units: \(\text{u}=\text{g}\,\text{mol}^{-1}\)}

+

Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal.

+
+
max_molecule_size:
+

integer [optional, default: 201]

+

Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code will crash if there are molecules larger than max_molecule_size in the topology/structure input file.

+
+
+
+
+

3.1.3. Simulation keywords

+

Configuration keywords specifying simulation parameters.

+
+
n_steps:
+

integer [required]

+

Total number of integration steps to perform for this simulation.

+
+
n_print:
+

integer or boolean [optional, default: False]

+

Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of number of time steps).

+
+
n_flush:
+

integer [optional, default: None]

+

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of number of n_print, i.e. n_print = 13, n_flush = 3 would result in the trajectory/energy being written to disk every 13 x 3 = 39 simulation steps)

+
+
time_step:
+

float [required] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time step per integration step. If the rRESPA multiple time step integrator is used (integrator = "respa"), this specifies the inner time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is respa_inner times the time_step , and the total simulation time is n_steps times time_step times respa_inner .

+
+
box_size:
+

array [float] [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable.

+
+
integrator:
+

string [required] (options: velocity-verlet or respa)

+

Specifies the time integrator used in the simulation. If respa, the reversible reference system propagator algorithm (rRESPA) [Tuckerman et al., 1992] integrator is used, with respa_inner number of inner (intramolecular force) time steps. If velocity-verlet, a normal Velocity Verlet integrator is used. If respa and respa_inner = 1, the rRESPA integrator is equivalent to the Velocity Verlet.

+
+
respa_inner:
+

integer [optional, default: 1]

+

The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces.

+
+
domain_decomposition:
+

integer or boolean [optional, default: False]

+

Specifies the interval (in time steps) of domain decomposition exchange, involving all MPI ranks sending and receiving particles according to the particles’ positions in the integration box and the MPI ranks’ assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If True, the decomposition is performed once (before starting the simulation). If False, no decomposition is performed.

+
+
cancel_com_momentum:
+

integer or boolean [optional, default: False]

+

If True, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every remove_com_momentum time steps. If False, the linear momentum is never removed.

+
+
start_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at start_temperature Kelvin prior to starting the simulation. If False, the velocities are not changed before starting the simulation.

+
+
target_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Couple the system to a heat bath at target_temperature Kelvin by applying a Canonical sampling through velocity rescaling [Bussi et al., 2007] thermostat with coupling strength tau. If False, no temperature control is applied.

+
+
tau:
+

float [optional, default: 0.7] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the CSVR thermostat coupling. In the limit of tau , the Hamiltonian dynamics are preserved and no temperature coupling takes place.

+
+
thermostat_coupling_groups:
+

array [array [string]] [optional, default: []]

+

Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing "A", "B", and "C" type particles, thermostat_coupling_groups = [["A", "B"], ["C"],] would thermalise types "A" and "B" together and couple "C" type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. target_temperature Kelvin).

+
+
hamiltonian:
+

string [optional, default: "DefaultNohChi"] (options: SquaredPhi, DefaultNohChi, or DefaultWithChi)

+

Specifies the interaction energy functional \(W[\tilde\phi]\) for use with the particle-field interactions. See Interaction energy functionals for details.

+
+
+
+
+

3.1.4. Field keywords

+

Configuration keywords specifying field parameters.

+
+
mesh_size:
+

array [integer] or integer [required]

+

Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is box_size / mesh_size.

+
+
kappa:
+

float [required] {units: \(\text{kJ}^{-1}\text{mol}\)}

+

Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional \(W[\tilde\phi]\). See Interaction energy functionals for more details.

+
+
sigma:
+

float [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See Filtering for more details.

+
+
chi:
+

array [array [string, float]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\)}

+

Array of \(\tilde\chi_\text{AB}\)-parameters indicating the strength of the repulsive or attractive interaction between particles of type "A" and the number density due to particles of type "B", and vice versa. Example: chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ] would specify a repulsive "A""B" type interaction, and a weakly attractive "C""D" interaction. Self-interaction \(\tilde\chi\)-terms are always zero. See Interaction energy functionals for more details.

+
+
+
+
+

3.1.5. Bond keywords

+

Configuration keywords specifying bonds and bonds parameters.

+
+
bonds:
+

array [array [2 string, 2 float]] [optional, default: []] {units: \(\text{nm}=10^{-9}~\text{m}\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+

Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ] indicates a "A""A" bond of equilibrium length 0.47 \(\text{nm}\) with a bond strength of 980.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding bond between "A" and "B" type particles with equilibrium length 0.31 \(\text{nm}\) and a strength of 1250.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify stretching bonds.

+
+
angle_bonds:
+

array [array [3 string, 2 float]] [optional, default: []] {units: \({}^\circ\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+
+

Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ] indicates a "A""A""A" angular bond that tries to keep the bond linear at 180 degrees with a bending strength of 55.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding angle bond between "A""B""B" prefering the angle at 120 degrees and a strength of 25.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify angular bonds.

+
+
+
dihedrals:
+

array [array [4 string, integer, COSINE SERIES ]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)}

+

Specifies four-particle torsional potentials by cosine series. See Intramolecular bonds for details about how to specify dihedrals.

+
+
+
+
+

3.1.6. Electrostatic keywords

+

Configuration keywords specifying electrostatics and electrostatic parameters.

+
+
coulombtype:
+

string [optional, default: None] (options: PIC_Spectral)

+

Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the dielectric_const keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, not in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to PIC_Spectral.

+
+
dielectric_const:
+

float [optional, default: None]

+

Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified—even if electrostatics are not included with the coulombtype keyword.

+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/doc_pages/constants_and_units.html b/v1.0.9/doc_pages/constants_and_units.html new file mode 100644 index 00000000..5877eaa2 --- /dev/null +++ b/v1.0.9/doc_pages/constants_and_units.html @@ -0,0 +1,393 @@ + + + + + + + 6. Constants and Units — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

6. Constants and Units

+

HyMD uses the following units and constants internally and in all input and +output:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Units

Quantity

Symbol

Unit

length

\(r\)

\(\text{nm}=10^{-9}~\text{m}\)

time

\(t\)

\(\text{ps}=10^{-12}~\text{s}\)

charge

\(q\)

\(e=1.602176634 \cdot 10^{-19}~\text{C}\)

mass

\(m\)

\(\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}\)

temperature

\(\text{T}\)

\(\text{K}\)

energy

\(E\)

\(\text{kJ}\,\text{mol}^{-1}\)

velocity

\(v\)

\(\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}\)

momentum

\(P\)

\(\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}\)

force

\(\mathbf{F}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}\)

pressure

\(p\)

\(\text{bar}=100~\text{kPa}\)

electric potential

\(\Psi\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}\)

electric field

\(\mathbf{E}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}\)

compressibility

\(\kappa\)

\(\text{mol}\,\text{kJ}^{-1}\)

field-interaction

\(\tilde\chi\)

\(\text{kJ}\,\text{mol}^{-1}\)

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants

Constant

Symbol

Value

gas constant

\(R\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Boltzmann’s constant

\(k_\text{B}\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Avogadro’s constant

\(N_\text{A}\)

\(6.02214076 \cdot 10^23~\text{mol}^{-1}\)

Vacuum permittivity

\(\varepsilon_0\)

\(8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2\)

Coulomb constant

\(k_\text{e}\)

\(138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}\)

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/doc_pages/electrostatics.html b/v1.0.9/doc_pages/electrostatics.html new file mode 100644 index 00000000..e5533f77 --- /dev/null +++ b/v1.0.9/doc_pages/electrostatics.html @@ -0,0 +1,314 @@ + + + + + + + 3. Electrostatic interactions — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Electrostatic interactions

+

In the filtered Hamiltonian hPF formalism [Bore and Cascella, 2020] the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle–mesh Ewald.

+

The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered

+
+\[\tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i),\]
+

with \(q_i\) being the charge of particle \(i\) and \(H\) is the +filtering function (see Filtering). The value of the charge grid at +vertex \((i,j,k)\) is found by

+
+\[\tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)]\]
+

and the electrostatic potential \(\Psi_{ijk}\)

+
+\[\Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right],\]
+

where \(k_\text{e}\) is the Coulomb constant \(1/4\pi\varepsilon_0\). +The electric field is obtained by differentiation of the electrostatic +potential in Fourier space,

+
+\[\mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)]\]
+

from which the forces are interpolated back to the particle positions.

+
+

3.1. Specifying electrostatics

+

In HyMD, electrostatics are specified by the coulombtype and +dielectric_const keywords in the configuration file (see +Configuration file) and the /charge dataset in the HDF5 format +structure/topology input file (see Topology and structure file). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/doc_pages/examples.html b/v1.0.9/doc_pages/examples.html new file mode 100644 index 00000000..c0a72c97 --- /dev/null +++ b/v1.0.9/doc_pages/examples.html @@ -0,0 +1,762 @@ + + + + + + + 1. Examples — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Examples

+

The following examples are ordered in more or less order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the HyMD-tutorial github repository.

+
+

1.1. Ideal gas

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true +

The simplest possible system is one with no interactions at all—intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like:

+
+
ideal_gas.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = false         # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+
+
+

A simple input structure/topology file ideal_gas.HDF5 is available in +the HyMD-tutorial/ideal_gas github repository (along with the code to +generate it). Run the (very) short simulation by

+
python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field   \
+                                              --velocity-output \
+                                              --force-output
+
+
+

with the --disable-field argument to completely turn off all +particle–field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook ideal_gas.ipynb for details.

+
+
+

1.2. Ideal chains

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true +

The simplest available interaction is the harmonic two-particle bond (see +Intramolecular bonds),

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2.\]
+

Extending the configuration file from the ideal gas case, we need to add a +bonds specification. Note that the [bonds] meta specifier is not +necessary, but may be used to help organise the input file.

+
+
ideal_chain.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+
+
+

A simple input structure/topology file ideal_chain.HDF5 with a few +coiled up ideal chain polymers is available in the +HyMD-tutorial/ideal_chain github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field
+
+
+

we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +ideal_chain.ipynb.

+
+
+

1.3. Stiff rods

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true +

Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the i--j--k angle \(\theta\) (see +Intramolecular bonds),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2.\]
+

Extending the configuration file from the ideal chain case, we need to add a +angle_bonds specification. Note that the [bonds] meta specifier +is not necessary, but may be used to help organise the input file.

+
+
rods.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+angle_bonds = [
+  ["A", "A", "A", 180.0, 100.0],   # (i, j, k, equilibrium angle, strength)
+]
+
+
+
+

A simple input structure/topology file rods.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook rods.ipynb.

+
+
+

1.4. Helixes

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true +

Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle \(\phi\) between the +i--j--k plane and the j--k--l plane (see Intramolecular bonds),

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n).\]
+

The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a dihedrals keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the dielectric_const +keyword even though we are not including electrostatic forces in the current +simulation. Note that the [bonds] meta specifier is not necessary, but +may be used to help organise the input file.

+
+
helixes.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+dielectric_const = 15.0
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.31, 10000.0],       # (i name, j name, equilibrium length, strength)
+]
+
+dihedrals = [
+  [
+    ["A", "A", "A", "A"],
+    [
+      [-1],
+      [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+      [0.08, 0.46, 1.65, -0.96, 0.38],
+    ],
+    [1.0]
+  ],
+]
+
+
+
+

A simple input structure/topology file helixes.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook helixes.ipynb.

+
+
+

1.5. Phase separation

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true +

The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types A and B. Using the Hamiltonian

+
+\[\mathcal{H}=H_0+W\]
+

with \(\tilde\chi\)–dependent interactions defined by (specified in the +configuration file by hamiltonian = DefaultWithChi):

+
+\[W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2.\]
+
+
phase_separation.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+
+[field]
+mesh_size = [20, 20, 20]           # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+kappa = 0.05                       # compressibility in mol/kJ
+chi = [
+  ['A', 'B', 5.0],                 # (name i, name j, strength)
+]
+
+
+
+

A simple input structure/topology file phase_separation.HDF5 containing +an equal number of A type and B type particles is available in +the HyMD-tutorial/phase_separation github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd phase_separation.toml phase_separation.HDF5
+
+
+

we may examine the resulting trajectory. In the case of a low interaction +strength \(\tilde\chi\) of 5.0 (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to 40.0 (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +phase_separation.ipynb.

+
+
+

1.6. Diblock copolymers

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true +

Having introduced particle–field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive \(\tilde\chi\)–interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the integrator = "respa" keyword. Putting the pieces together, the +configuration file may look like the following:

+
+
copolymer.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 15
+n_steps = 2000                     # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [10.0, 10.0, 10.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [50, 50, 50]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+chi = [
+  ["A", "B", 30.0],                # (i, j, strength)
+]
+
+[bonds]
+bonds = [
+  ["A", "A", 0.25, 1500.0],        # (i, j, equilibrium length, strength)
+  ["A", "B", 0.25, 1500.0],
+  ["B", "B", 0.25, 1500.0],
+]
+angle_bonds = [
+  ["A", "A", "A", 180.0, 25.0],    # (i, j, k, equilibrium angle, strength)
+  ["B", "B", "B", 180.0, 25.0],
+]
+
+
+
+

A simple input structure/topology file copolymer.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/copolymer github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten A followed by ten B type particles. +Running the simulation with

+
python3 -m hymd copolymer.toml copolymer.HDF5
+
+
+

the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +copolymer.ipynb.

+
+
+

1.7. Lipid bilayer self-assembly

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true +

Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field–particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the thermostat_coupling_groups keyword. With parameters +optimised in [Ledum et al., 2020], the configuration file looks like:

+
+
lipid_self_assembly.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 25
+n_steps = 3000
+n_print = 200
+n_flush = 1
+time_step = 0.01
+box_size = [9.96924, 9.96924, 10.03970]
+start_temperature = 323
+target_temperature = 323
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.05
+domain_decomposition = 10001
+cancel_com_momentum = true
+max_molecule_size = 15
+thermostat_coupling_groups = [
+  ["N", "P", "G", "C"],
+  ["W"],
+]
+
+[field]
+mesh_size = [25, 25, 25]
+sigma = 1.0
+chi = [
+  ["C", "W", 42.24],
+  ["G", "C", 10.47],
+  ["N", "W", -3.77],
+  ["G", "W", 4.53],
+  ["N", "P", -9.34],
+  ["P", "G", 8.04],
+  ["N", "G", 1.97],
+  ["P", "C", 14.72],
+  ["P", "W", -1.51],
+  ["N", "C", 13.56],
+]
+
+[bonds]
+bonds = [
+  ["N", "P", 0.47, 1250.0],
+  ["P", "G", 0.47, 1250.0],
+  ["G", "G", 0.37, 1250.0],
+  ["G", "C", 0.47, 1250.0],
+  ["C", "C", 0.47, 1250.0],
+]
+angle_bonds = [
+  ["P", "G", "G", 120.0, 25.0],
+  ["P", "G", "C", 180.0, 25.0],
+  ["G", "C", "C", 180.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

A randomly mixed input structure/topology file +lipid_self_assembly.HDF5 with a few hundred lipids in a roughy +10 x 10 x 10nm box is available in the +HyMD-tutorial/lipid_self_assembly github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation

+
python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5
+
+
+

we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook lipid_self_assembly.ipynb.

+
+
+

1.8. Peptide in lipid bilayer

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true +

Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer.

+

The configuration file is available in the HyMD-tutorial/peptide github +repository (omitted here for brevity).

+

A pre-equilibrated input structure/topology file peptide.HDF5 with a +few hundred lipids in a roughy 20 x 20 x 20nm box is available in the +HyMD-tutorial/peptide github repository. Running the simulation

+
python3 -m hymd peptide.toml peptide.HDF5
+
+
+

we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook peptide.ipynb.

+
+
+

1.9. SDS

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true +

The last part we introduce is explicit electrostatic interactions through +particle–mesh Ewald. Enabling the electrostatic calculations is done via the +coulombtype keyword. "PIC_Spectral" is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the dielectric_const keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge.

+
+
sds.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 10
+n_steps = 3000
+n_print = 1500
+n_flush =
+time_step = 0.01
+box_size = [8.3, 8.3, 8.3]
+start_temperature = 298
+target_temperature = 298
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.1
+domain_decomposition = 10000
+cancel_com_momentum = true
+max_molecule_size = 5
+thermostat_coupling_groups = [
+  ["S", "C"],
+  ["W", "Na"],
+]
+dielectric_const = 45.0              # dielectric constant for the simulation medium
+coulombtype = "PIC_Spectral"         # particle in cloud, spectral method
+
+[field]
+mesh_size = [64, 64, 64]
+sigma = 0.5
+chi = [
+  ["S", "C",  13.50],
+  ["S", "Na",  0.00],
+  ["S", "W",  -3.60],
+  ["C", "Na", 13.50],
+  ["C", "W",  33.75],
+  ["W", "Na",  0.00],
+]
+
+[bonds]
+bonds = [
+  ["S",   "C",   0.50, 1250.0],
+  ["C",   "C",   0.50, 1250.0],
+]
+angle_bonds = [
+  ["S", "C", "C", 170.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

An input structure/topology file sds.HDF5 with a couple thousand +randomly dispersed SDS chains is available in the HyMD-tutorial/sds github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a /charge dataset. +Running the simulation with

+
python3 -m hymd sds.toml sds.HDF5
+
+
+

we observe the aggregation of the SDS into micellular structures—first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook sds.ipynb.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/doc_pages/filtering.html b/v1.0.9/doc_pages/filtering.html new file mode 100644 index 00000000..a5eba304 --- /dev/null +++ b/v1.0.9/doc_pages/filtering.html @@ -0,0 +1,301 @@ + + + + + + + 2. Filtering — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Filtering

+

The default grid-independent filter function used in HyMD is a Gaussian

+
+\[H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right]\]
+

with reciprocal space representation

+
+\[\hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right].\]
+

The coarse-graining parameter \(\sigma\) determines a length scale of +particle extent and is given as configuration file input by

+
sigma = 0.75
+
+
+
+

2.1. Implementing new filters

+

Implementing new filter functions is straightforward by hijacking +the setup method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/doc_pages/installation.html b/v1.0.9/doc_pages/installation.html new file mode 100644 index 00000000..abf7117c --- /dev/null +++ b/v1.0.9/doc_pages/installation.html @@ -0,0 +1,543 @@ + + + + + + + 1. Installation — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Installation

+
+

1.1. Dependencies

+
+

Note

+

HyMD requires Python ≥3.6. Python version 3.9 is most likely fine +to use, but HyMD is only regularly tested with Python3.8 at the moment.

+ +
+

Warning

+

MPI-enabled h5py may fail to build under Python3.10. In this case, a +fall-back to Python3.9 or lower may be necessary.

+ +

Installing non-Python dependencies may be done by

+
+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-openmpi-dev  # Install MPI-enabled HDF5
+sudo apt-get install -y pkg-config           # Install pkg-config, required for h5py install
+sudo apt-get install -y curl wget
+
+
+
+
+

Warning

+

There might be memory leaks when using HyMD with OpenMPI 4.1.1. +Therefore, using a newer version of OpenMPI is recommended. +See Issue #186 for more details.

+ +

Installing Python dependencies may be done by

+
+
python3 -m pip install --upgrade pip
+CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+python3 -m pip install mpi4py numpy cython
+
+
+
+
+

Warning

+

If MPI-enabled HDF5 and h5py can not be installed, limited support +for serial HDF5 is available. Note that having MPI-enabled file IO is +highly recommended, and simulation performance under serial HDF5 will +potentially be very low.

+

Example dependency install on Ubuntu (apt) using serial HDF5:

+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-serial-dev   # Install serial HDF5
+sudo apt-get install -y curl wget
+
+python3 -m pip install h5py mpi4py numpy cython
+
+
+

Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +--disable-mpio argument to HyMD, see Command line arguments. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial.

+ +
+
+

1.2. Installing HyMD

+

HyMD may be installed using pip by

+
python3 -m pip install hymd
+
+
+
+
+

1.3. Install in docker

+

A docker image with build essentials setup is available at dockerhub with tag +mortele/hymd,

+
docker pull mortele/hymd:latest
+docker run -it mortele/hymd
+/app$ python3 -m pip install hymd
+
+# Grab example input files
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5
+
+# Run simulation
+/app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose
+
+
+
+
+

1.4. Run interactively in Google Colaboratory

+

A Google Colaboratory jupyter notebook is setup here with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons.

+
+
+

1.5. Common issues

+
+

1.5.1. Numpy errors while importing the Fortran force kernels

+
RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd
+
+Traceback (most recent call last):
+
+  (...)
+
+File "/..../HyMD/hymd/__init__.py", line 2, in <module>
+  from .main import main  # noqa: F401
+File "/..../HyMD/hymd/main.py", line 10, in <module>
+  from .configure_runtime import configure_runtime
+File "/..../hymd/configure_runtime.py", line 12, in <module>
+  from .input_parser import read_config_toml, parse_config_toml
+File "/..../HyMD/hymd/input_parser.py", line 12, in <module>
+  from .force import Bond, Angle, Dihedral, Chi
+File "/..../HyMD/hymd/force.py", line 8, in <module>
+  from force_kernels import (  # noqa: F401
+ImportError: numpy.core.multiarray failed to import
+
+
+

can normally be fixed by updating numpy versions,

+
python3 -m pip install -U numpy
+
+
+
+
+

1.5.2. Error building pfft-python due to missing curl/wget

+
Building wheel for pfft-python (setup.py) ... error
+ERROR: Command errored out with exit status 1:
+command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_
+cwd: /tmp/pip-install-fr6nt9m4/pfft-python/
+Complete output (56 lines):
+running bdist_wheel
+running build
+running build_py
+
+  (...)
+
+curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found
+wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found
+Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+Please check curl or wget
+You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/
+Traceback (most recent call last):
+  File "<string>", line 1, in <module>
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in <module>
+    setup(
+  File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup
+    return distutils.core.setup(**attrs)
+  File "/usr/lib/python3.8/distutils/core.py", line 148, in setup
+
+  (...)
+
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions
+    build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:]))
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft
+    raise ValueError("could not build fftw; check MPICC?")
+ValueError: could not build fftw; check MPICC?
+----------------------------------------
+ERROR: Failed building wheel for pfft-python
+Running setup.py clean for pfft-python
+Failed to build pfft-python
+
+
+

can be fixed by installing either curl or wget

+
apt-get install -y curl wget
+
+
+
+
+

1.5.3. Error running parallel HyMD without MPI-enabled h5py

+
Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    main()
+  File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    raise ValueError("h5py was built without MPI support, can't use mpio driver")
+ValueError: h5py was built without MPI support, can't use mpio driver
+
+
+

Can be fixed by installing a MPI-enabled h5py through

+
python3 -m pip uninstall -y h5py
+HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/doc_pages/interaction_energy_functionals.html b/v1.0.9/doc_pages/interaction_energy_functionals.html new file mode 100644 index 00000000..4f841b81 --- /dev/null +++ b/v1.0.9/doc_pages/interaction_energy_functionals.html @@ -0,0 +1,354 @@ + + + + + + + 1. Interaction energy functionals — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Interaction energy functionals

+

A few interaction energy functionals \(W\) are defined in HyMD through +the Hamiltonian class and associated subclasses.

+
+

1.1. \(\chi\)–interaction and \(\kappa\)–incompressibility

+

The most common hPF energy functional is specified by

+
hamiltonian = "DefaultWithChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where \(\tilde\chi_{\text{A}-\text{B}}\) is the interaction energy between +overlapping densities of particle types \(\text{A}\) and \(\text{B}\). +The incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\tilde\chi\) +and \(\kappa\) in the configuration file (see Configuration file)

+
kappa = 0.05
+chi = [
+   ["A", "B", 15.85],
+   ["B", "C", -5.70],
+   ...
+]
+
+
+
+
+

1.2. Only \(\kappa\)–incompressibility

+

The only \(\kappa\) interactions energy functional is specified by

+
hamiltonian = "DefaultNoChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where the incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.3. Only \(\phi^2\)

+

The \(\phi^2\) interactions energy functional is specified by

+
hamiltonian = "SquaredPhi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2,\]
+

where the \(\phi\) squared term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.4. Implementing new interaction energy forms

+

Implementing new interaction energy functions is straightforward by subclassing +Hamiltonian and applying sympy differentiation to the symbolic +field objects. The sympy.lamdify function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/doc_pages/intramolecular_bonds.html b/v1.0.9/doc_pages/intramolecular_bonds.html new file mode 100644 index 00000000..864f174b --- /dev/null +++ b/v1.0.9/doc_pages/intramolecular_bonds.html @@ -0,0 +1,394 @@ + + + + + + + 2. Intramolecular bonds — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Intramolecular bonds

+

Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see Configuration file. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +Benchmarks), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable.

+

All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]).

+
+

2.1. Two-particle bonds

+

Stretching bonds in HyMD are implemented as harmonic spring potentials,

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2,\]
+

where \(r=|\mathbf{r}|\) is the inter-particle distance, \(k\) is a +constant of dimension energy (units \(\text{kJ}\,\text{mol}^{-1}\)), and +\(r_0\) is the equilibrum length of the bond (units: \(\text{nm}\)). The +force is calculated as

+
+\[F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r},\]
+

where \(\mathbf{r}\) is the vector pointing from \(i\) to \(j\).

+

In the configuration file, two-particle bonds are specified per particle type:

+
+
configuration_two_particle_example.toml
+
[bonds]
+bonds = [
+   ["A", "A", 0.47, 1250.0],
+   ["A", "B", 0.37,  940.0],
+   ["B", "C", 0.50, 1010.0],
+   ["C", "A", 0.42,  550.0],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.2. Three-particle bonds

+

Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle–particle–particle angle \(\theta\),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2,\]
+

where \(k\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\)), and \(\theta_0\) is the equilibrum +angle of the bond (units: \({}^\circ\)). Defining the particles with labels +\(a\), \(b\), and \(c\), let \(\mathbf{r}_a\) denote the vector +pointing from \(b\) to \(a\), and correspondingly let +\(\mathbf{r}_c\) point from \(b\) to \(c\). The +\(a\)\(b\)\(c\) may be computed through the law of Cosines,

+
+\[\theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right]\]
+

Then the force acting on \(a\) and \(c\) is

+
+\[ \begin{align}\begin{aligned}\mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a},\\\mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c},\end{aligned}\end{align} \]
+

and

+
+\[\mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c\]
+

In the configuration file, three-particle bonds are specified per particle type:

+
+
configuration_three_particle_example.toml
+
[bonds]
+angle_bonds = [
+   ["A", "A", "A", 180.0, 90.0],
+   ["A", "B", "A", 120.0, 55.0],
+   ["B", "C", "C",  30.0, 10.0],
+   ["C", "A", "B", 110.0, 25.5],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.3. Four-particle bonds

+

Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle \(\phi\) between the +\(a\)\(b\)\(c\) and \(b\)\(c\)\(d\) planes, for +a dihedral bond quartet \(a\), \(b\), \(c\), and \(d\). The +potential takes the form

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n),\]
+

where \(c_n\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)), and \(\phi_n\) are +specified phase angles in the cosine series.

+

In the configuration file, four-particle bonds are specified per particle type:

+
+
configuration_four_particle_example.toml
+
[bonds]
+dihedrals = [
+   ["A", "B", "C", "D"],
+   [
+     [-1],
+     [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+     [0.08, 0.46, 1.65, -0.96, 0.38],
+   ],
+   [1.0],
+]
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/doc_pages/overview.html b/v1.0.9/doc_pages/overview.html new file mode 100644 index 00000000..e5ca3422 --- /dev/null +++ b/v1.0.9/doc_pages/overview.html @@ -0,0 +1,415 @@ + + + + + + + 2. Usage overview for HylleraasMD — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Usage overview for HylleraasMD

+

HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a toml format configuration file, along with a topology and structure +file specifying the input system in HDF5 format.

+

Configuration file

+

The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a [5, 5, 5] nm simulation box at 300 K may look like +the following:

+
+
config_simple_1.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "SquaredPhi"         # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [30, 30, 30]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+
+
+
+

Note that for the version 1.0 release of HyMD, the [particles], +[simulation], and [field] groups are optional specifiers for +structuring the configuration file.

+

For a full specification of every recognised configuration keyword in HyMD, +please refer to Configuration file.

+

Topology and structure file

+

The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +N particles may look like the following:

+
+
example_structure.HDF5
+
group   /
+   # root group
+
+dataset /coordinates
+   # float32, shape (T, N, D,)
+   # Time steps of N rows of D dimensional coordinate data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /velocities
+   # float32, shape (T, N, D,) OPTIONAL
+   # Time steps of N rows of D dimensional velocity data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /bonds
+   # int32,   shape (N, B,)    OPTIONAL
+   # Each row i contains indices of the particles bonds from/to i
+   # B denotes the maximum bonds per particle
+
+dataset /indices
+   # int32,   shape (N,)
+   # Index of each particle, 0--(N-1)
+
+dataset /molecules
+   # int32,   shape (N,)
+   # Index of molecule each particle belongs to
+   # Used to construct bond network locally on MPI ranks
+
+dataset /names
+   # str10,   shape (N,)
+   # Fixed size string array containing particle type names
+
+dataset /types
+   # int32,   shape (N,)       OPTIONAL
+   # Mapping of particle names to type indices
+
+
+
+

For a full specification of the topology and structure input file, see +Topology and structure file.

+

Command line arguments

+

A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the config_simple_1.toml and example_structure.HDF5 +files may look like the following:

+
mpirun -n ${MPI_NUM_RANKS} python3 -m hymd         \  # HyMD executable
+                           config_simple_1.toml    \  # configuration file
+                           example_structure.HDF5  \  # structure file
+                           --logfile=log_out.txt   \  # set logfile path
+                           --seed 123456           \  # set random seed
+                           --verbose 2             \  # set logging verbosity
+                           --velocity-output          # enable velocity in trajectory output
+
+
+

For a full specification of all command line arguments, see +Command line arguments.

+

More examples

+

For more thorough rundown and concrete usage examples, see +Examples.

+
+

2.1. Running parallel simulations

+

Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the only difference being how the python3 interpreter is +invoked. Prepending mpirun -n ${NPROCS} to the usual +python3 -m hymd runs the simulation with ${NPROCS} MPI ranks.

+

Inputting

+
mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field
+
+
+

sets up an example simulation of the HyMD-tutorial/ideal_gas system. For +more details about this system in particular, or other example simulations, see +the HyMD-tutorial repository.

+
+
+

2.2. Running tests

+

Run serial code tests by

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd
+cd hymd/
+python3 -m pip install pytest pytest-mpi
+python3 -m pytest
+
+
+

There is a small convenience script in hymd/ for running the MPI-enabled +tests,

+
chmod +x pytest-mpi
+./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/doc_pages/theory.html b/v1.0.9/doc_pages/theory.html new file mode 100644 index 00000000..8523e4b4 --- /dev/null +++ b/v1.0.9/doc_pages/theory.html @@ -0,0 +1,357 @@ + + + + + + + 1. Theory — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Theory

+

Hybrid particle–field simulations switch out the ordinary particle–particle +Lennard-Jones interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle–field densities are +defined as

+
+\[\phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i),\]
+

where \(\mathbf{r}\) is a spatial coordinate, \(P\) is a window function +used to distribute particle number densities onto a computational grid, and +\(\mathbf{r}_i\) is the position of particle \(i\) (of total \(N\)). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of \(N\) particles in \(M\) molecules is

+
+\[\mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})]\]
+

with \(H_0\) being a standard intramolecular Hamiltonian form (see +Intramolecular bonds) including kinetic terms, while \(W\) is a density +dependent interaction energy functional.

+

In the Hamiltonian hPF-MD formalism [Bore and Cascella, 2020], the density +field is filtered using a grid-independent filtering function \(H\),

+
+\[\tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}).\]
+

The filter smooths the density, ensuring that \(\tilde\phi\) and +\(W[\tilde\phi([\phi])]\) both converge as the grid size is reduced.

+
+

1.1. External potential

+

The external potential acting on a particle is defined as the functional +derivative of \(W\) with respect to \(\phi\). In the filtered formalism, +the potential takes the form

+
+\[\begin{split}V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ +&= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})},\end{split}\]
+

under the assumption of a local form of the interaction energy functional, +\(W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]\). Note +that

+
+\[\frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}).\]
+
+
+

1.2. Force interpolation

+

The forces on particle \(i\) are obtained by differentiation of the external +potential,

+
+\[\mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i).\]
+
+
+

1.3. Reciprocal space calculations

+

The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density \(\phi_{ijk}\) with CIC, we apply the filtering +and obtain the discrete version of the external potential by

+
+\[\tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big]\]
+

and

+
+\[V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+

The forces are obtained by differentiation of \(V\) in Fourier space as

+
+\[\nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+
+
+

1.4. Filter

+

By default, the filter used in HyMD is a simple Gaussian of the form

+
+\[\begin{split}H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ +\hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right].\end{split}\]
+

For more details about the filtering, see Filtering.

+
+
+

1.5. Hamiltonian form

+

The default form of the interaction energy functional in HyMD is

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2.\]
+

See Interaction energy functionals for details.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/doc_pages/topology_input.html b/v1.0.9/doc_pages/topology_input.html new file mode 100644 index 00000000..3282f571 --- /dev/null +++ b/v1.0.9/doc_pages/topology_input.html @@ -0,0 +1,338 @@ + + + + + + + 4. Topology and structure file — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Topology and structure file

+

The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root / group.

+

The HyMD-tutorial has multiple examples of structure files for various levels +of complexity.

+
+

4.1. Required datasets

+
+
/coordinates:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/indices:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/names:
+

array shape [N,]

+

datatype [string (length between 1 and 16)]

+

The shape represents one particle name per N particles. The datatype may be a string of length =<16.

+
+
+
+
+

4.2. Optional datasets

+
+
/velocities:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/types:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle type index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/molecules:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one molecule index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/bonds:
+

array shape [N, B,]

+

datatype [int32 or int64]

+

The shape represents B bond specifications (indices of different particles) per N particles. The data type may be either 32 or 64 bit integers.

+
+
/charge:
+

array shape [N,]

+

datatype [float32 or float64]

+

The shape represents one particle charge per N particles. The data type may be either four or eight byte reals.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/genindex.html b/v1.0.9/genindex.html new file mode 100644 index 00000000..b5ab5582 --- /dev/null +++ b/v1.0.9/genindex.html @@ -0,0 +1,816 @@ + + + + + + Index — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + +
+ +

F

+ + + +
+ +

G

+ + +
+ +

H

+ + + +
    +
  • + hymd.input_parser + +
  • +
  • + hymd.integrator + +
  • +
  • + hymd.thermostat + +
  • +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/index.html b/v1.0.9/index.html new file mode 100644 index 00000000..ac3d4c34 --- /dev/null +++ b/v1.0.9/index.html @@ -0,0 +1,402 @@ + + + + + + + HylleraasMD documentation — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

HylleraasMD documentation

+
+
Release:
+

1.0.9

+
+
Date:
+

Apr 18, 2023

+
+
+

HylleraasMD (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems.

+

HyMD can run canonical hPF-MD simulations [Milano and Kawakatsu, 2009], or filtered +density Hamiltonian hPF (HhPF-MD) simulations [Bore and Cascella, 2020], with +or without explicit PME electrostatic interactions [Kolli et al., 2018]. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +[Bore et al., 2018, Cascella et al., 2008]. Martini +style elastic networks (ElNeDyn) [Periole et al., 2009] are also +supported.

+

HyMD uses the pmesh (github.com/rainwoodman/pmesh) library for particle-mesh +operations, with the PPFT [Pippig, 2013] backend for FFTs through the +pfft-python bindings (github.com/rainwoodman/pfft-python). File IO is done +via HDF5 formats to allow MPI parallel reads.

+
+

User Guide

+

The HylleraasMD User Guide provides comprehensive information on how to run +simulations. Selected Examples are available to guide new users.

+
+
+

Installing HyMD

+

The easiest approach is to install using pip:

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+

For more information and required dependencies, see +Installation.

+
+

Run in Google colab

+

Run HyMD interactively in Google Colaboratory jupyter notebook here.

+
+
+
+

Source Code

+

Source code is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the GNU Lesser General Public +License v3.0. Obtain the source code with git:

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git
+
+
+
+
+

Development

+

HyMD is developed and maintained by researchers at the Hylleraas Centre for +Quantum Molecular Sciences at the University of Oslo.

+

pic1 pic2

+
+
+

References

+
+
+[BC20] +

Sigbjørn Løland Bore and Michele Cascella. Hamiltonian and alias-free hybrid particle–field molecular dynamics. J. Chem. Phys., 153(9):094106, 2020. doi:10.1063/5.0020733.

+
+
+[BMC18] +

Sigbjørn Løland Bore, Giuseppe Milano, and Michele Cascella. Hybrid particle-field model for conformational dynamics of peptide chains. J. Chem. Theory Comput., 14(2):1120–1130, 2018. doi:10.1021/acs.jctc.7b01160.

+
+
+[BDP07] +

Giovanni Bussi, Davide Donadio, and Michele Parrinello. Canonical sampling through velocity rescaling. J. Chem. Phys., 126(1):014101, 2007. doi:10.1063/1.2408420.

+
+
+[CNCDP08] +

Michele Cascella, Marilisa A. Neri, Paolo Carloni, and Matteo Dal Peraro. Topologically based multipolar reconstruction of electrostatic interactions in multiscale simulations of proteins. J. Chem. Theory Comput., 4(8):1378–1385, 2008. doi:10.1021/ct800122x.

+
+
+[KDNB+18] +

Hima Bindu Kolli, Antonio De Nicola, Sigbjørn Løland Bore, Ken Schäfer, Gregor Diezemann, Jürgen Gauss, Toshihiro Kawakatsu, Zhong-Yuan Lu, You-Liang Zhu, Giuseppe Milano, and Michele Cascella. Hybrid particle-field molecular dynamics simulations of charged amphiphiles in an aqueous environment. J. Chem. Theory Comput., 14(9):4928–4937, 2018. doi:10.26434/chemrxiv.6264644.v1.

+
+
+[LBC20] +

Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Automated determination of hybrid particle-field parameters by machine learning. Mol. Phys., 118(19-20):e1785571, 2020. doi:10.1080/00268976.2020.1785571.

+
+
+[MK09] +

Giuseppe Milano and Toshihiro Kawakatsu. Hybrid particle-field molecular dynamics simulations for dense polymer systems. J. Chem. Phys., 130(21):214106, 2009. doi:10.1063/1.3142103.

+
+
+[PCMC09] +

Xavier Periole, Marco Cavalli, Siewert-Jan Marrink, and Marco A Ceruso. Combining an elastic network with a coarse-grained molecular force field: structure, dynamics, and intermolecular recognition. Journal of chemical theory and computation, 5(9):2531–2543, 2009. doi:10.1021/ct9002114.

+
+
+[Pip13] +

Michael Pippig. Pfft: an extension of fftw to massively parallel architectures. SIAM J. Sci. Comput., 35(3):C213–C236, 2013. doi:10.1137/120885887.

+
+
+[TBM92] +

MBBJM Tuckerman, Bruce J Berne, and Glenn J Martyna. Reversible multiple time scale molecular dynamics. J. Chem. Phys., 97(3):1990–2001, 1992. doi:10.1063/1.463137.

+
+
+
+
+
+

Indices and tables

+ +
+
+
+
+
+
+
+
+
+ + + +
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+ + + + + +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/objects.inv b/v1.0.9/objects.inv new file mode 100644 index 00000000..a821d72f Binary files /dev/null and b/v1.0.9/objects.inv differ diff --git a/v1.0.9/py-modindex.html b/v1.0.9/py-modindex.html new file mode 100644 index 00000000..b6ce17ac --- /dev/null +++ b/v1.0.9/py-modindex.html @@ -0,0 +1,324 @@ + + + + + + Python Module Index — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ h +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ h
+ hymd +
    + hymd.field +
    + hymd.file_io +
    + hymd.force +
    + hymd.input_parser +
    + hymd.integrator +
    + hymd.thermostat +
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v1.0.9/search.html b/v1.0.9/search.html new file mode 100644 index 00000000..c38633fc --- /dev/null +++ b/v1.0.9/search.html @@ -0,0 +1,294 @@ + + + + + + Search — hymd 1.0.9 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v1.0.9 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v1.0.9/searchindex.js b/v1.0.9/searchindex.js new file mode 100644 index 00000000..69607cf8 --- /dev/null +++ b/v1.0.9/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["doc_pages/api","doc_pages/benchmarks","doc_pages/command_line","doc_pages/config_file","doc_pages/constants_and_units","doc_pages/electrostatics","doc_pages/examples","doc_pages/filtering","doc_pages/installation","doc_pages/interaction_energy_functionals","doc_pages/intramolecular_bonds","doc_pages/overview","doc_pages/theory","doc_pages/topology_input","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,"sphinxcontrib.bibtex":9,sphinx:56},filenames:["doc_pages/api.rst","doc_pages/benchmarks.rst","doc_pages/command_line.rst","doc_pages/config_file.rst","doc_pages/constants_and_units.rst","doc_pages/electrostatics.rst","doc_pages/examples.rst","doc_pages/filtering.rst","doc_pages/installation.rst","doc_pages/interaction_energy_functionals.rst","doc_pages/intramolecular_bonds.rst","doc_pages/overview.rst","doc_pages/theory.rst","doc_pages/topology_input.rst","index.rst"],objects:{"hymd.field":{compute_field_and_kinetic_energy:[0,1,1,""],compute_field_energy_q_GPE:[0,1,1,""],compute_field_force:[0,1,1,""],compute_self_energy_q:[0,1,1,""],domain_decomposition:[0,1,1,""],initialize_pm:[0,1,1,""],update_field:[0,1,1,""],update_field_force_q:[0,1,1,""],update_field_force_q_GPE:[0,1,1,""]},"hymd.file_io":{OutDataset:[0,2,1,""],distribute_input:[0,1,1,""],setup_time_dependent_element:[0,1,1,""],store_data:[0,1,1,""],store_static:[0,1,1,""]},"hymd.file_io.OutDataset":{close_file:[0,3,1,""],flush:[0,3,1,""],is_open:[0,3,1,""]},"hymd.force":{Angle:[0,2,1,""],Bond:[0,2,1,""],Chi:[0,2,1,""],Dielectric_type:[0,2,1,""],Dihedral:[0,2,1,""],compute_angle_forces__plain:[0,1,1,""],compute_bond_forces__plain:[0,1,1,""],compute_dihedral_forces__plain:[0,1,1,""],dipole_forces_redistribution:[0,1,1,""],find_all_paths:[0,1,1,""],prepare_bonds:[0,1,1,""],prepare_bonds_old:[0,1,1,""],prepare_index_based_bonds:[0,1,1,""],propensity_potential_coeffs:[0,1,1,""]},"hymd.force.Angle":{atom_3:[0,4,1,""]},"hymd.force.Bond":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],equilibrium:[0,4,1,""],strength:[0,4,1,""]},"hymd.force.Chi":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],interaction_energy:[0,4,1,""]},"hymd.force.Dielectric_type":{atom_1:[0,4,1,""],dielectric_value:[0,4,1,""]},"hymd.force.Dihedral":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],atom_3:[0,4,1,""],atom_4:[0,4,1,""],coeffs:[0,4,1,""],dih_type:[0,4,1,""]},"hymd.hamiltonian":{DefaultNoChi:[0,2,1,""],DefaultWithChi:[0,2,1,""],Hamiltonian:[0,2,1,""],SquaredPhi:[0,2,1,""]},"hymd.hamiltonian.DefaultNoChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.DefaultWithChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.Hamiltonian":{__init__:[0,3,1,""],_setup:[0,3,1,""]},"hymd.hamiltonian.SquaredPhi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.input_parser":{Config:[0,2,1,""],check_NPT_conditions:[0,1,1,""],check_angles:[0,1,1,""],check_bonds:[0,1,1,""],check_box_size:[0,1,1,""],check_cancel_com_momentum:[0,1,1,""],check_charges:[0,1,1,""],check_charges_types_list:[0,1,1,""],check_chi:[0,1,1,""],check_config:[0,1,1,""],check_dielectric:[0,1,1,""],check_dihedrals:[0,1,1,""],check_domain_decomposition:[0,1,1,""],check_hamiltonian:[0,1,1,""],check_integrator:[0,1,1,""],check_m:[0,1,1,""],check_mass:[0,1,1,""],check_max_molecule_size:[0,1,1,""],check_n_b:[0,1,1,""],check_n_flush:[0,1,1,""],check_n_particles:[0,1,1,""],check_n_print:[0,1,1,""],check_name:[0,1,1,""],check_start_and_target_temperature:[0,1,1,""],check_tau:[0,1,1,""],check_thermostat_coupling_groups:[0,1,1,""],parse_config_toml:[0,1,1,""],read_config_toml:[0,1,1,""],sort_dielectric_by_type_id:[0,1,1,""]},"hymd.input_parser.Config":{a:[0,4,1,""],angle_bonds:[0,4,1,""],barostat:[0,4,1,""],barostat_type:[0,4,1,""],bonds:[0,4,1,""],box_size:[0,4,1,""],cancel_com_momentum:[0,4,1,""],chi:[0,4,1,""],conv_crit:[0,4,1,""],convergence_type:[0,4,1,""],coulomb_constant:[0,4,1,""],coulombtype:[0,4,1,""],dielectric_const:[0,4,1,""],dielectric_type:[0,4,1,""],dihedrals:[0,4,1,""],domain_decomposition:[0,4,1,""],dtype:[0,4,1,""],file_name:[0,4,1,""],gas_constant:[0,4,1,""],hamiltonian:[0,4,1,""],initial_energy:[0,4,1,""],integrator:[0,4,1,""],kappa:[0,4,1,""],m:[0,4,1,""],mass:[0,4,1,""],max_molecule_size:[0,4,1,""],mesh_size:[0,4,1,""],n_b:[0,4,1,""],n_flush:[0,4,1,""],n_particles:[0,4,1,""],n_print:[0,4,1,""],n_steps:[0,4,1,""],name:[0,4,1,""],pol_mixing:[0,4,1,""],pressure:[0,4,1,""],respa_inner:[0,4,1,""],rho0:[0,4,1,""],self_energy:[0,4,1,""],sigma:[0,4,1,""],start_temperature:[0,4,1,""],tags:[0,4,1,""],target_pressure:[0,4,1,""],target_temperature:[0,4,1,""],tau:[0,4,1,""],tau_p:[0,4,1,""],thermostat_coupling_groups:[0,4,1,""],thermostat_work:[0,4,1,""],time_step:[0,4,1,""],type_charges:[0,4,1,""]},"hymd.integrator":{integrate_position:[0,1,1,""],integrate_velocity:[0,1,1,""]},"hymd.logger":{Logger:[0,2,1,""],MPIFilterAll:[0,2,1,""],MPIFilterRoot:[0,2,1,""]},"hymd.logger.Logger":{setup:[0,3,1,""]},"hymd.logger.MPIFilterAll":{filter:[0,3,1,""]},"hymd.logger.MPIFilterRoot":{filter:[0,3,1,""]},"hymd.thermostat":{_random_chi_squared:[0,1,1,""],_random_gaussian:[0,1,1,""],csvr_thermostat:[0,1,1,""]},hymd:{field:[0,0,0,"-"],file_io:[0,0,0,"-"],force:[0,0,0,"-"],input_parser:[0,0,0,"-"],integrator:[0,0,0,"-"],thermostat:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0020733":14,"00268976":14,"0083144621":0,"01036426965":4,"014101":[0,14],"02214076":4,"03642696562":4,"03970":6,"08790868":[6,10],"094106":14,"0xd":8,"0xe":8,"100":[4,6,11],"1000":6,"10000":6,"10001":6,"1010":10,"1021":14,"1063":14,"1080":14,"10nm":6,"110":10,"1120":[0,14],"1130":[0,14],"1137":14,"118":14,"120":[3,6,10],"120885887":14,"120ff":0,"123456":11,"1250":[3,6,10],"126":[0,14],"130":14,"1378":14,"138":[0,4],"1385":14,"144":8,"148":8,"1500":6,"153":14,"166":8,"170":6,"1785571":14,"179":0,"180":[3,6,10],"186":8,"197":8,"1974":0,"1981":0,"1990":14,"1992":[3,14],"200":[6,10],"2000":6,"2001":14,"2007":[0,3,14],"2008":[0,14],"2009":14,"201":[0,3],"2013":14,"2018":[0,14],"2020":[5,6,12,14],"2023":14,"20nm":6,"214106":14,"223":0,"224":1,"2408420":14,"2408724":[6,10],"246":0,"251":[6,10],"2531":14,"2543":14,"26434":14,"28103735":0,"298":6,"2_1":0,"2don2d":8,"2nd":0,"300":[6,11],"3000":6,"3142103":14,"3144621":4,"323":6,"449":[6,10],"463137":14,"48626121":[6,10],"4928":14,"4937":14,"502":8,"533":1,"544":[6,10],"550":10,"59427866":[6,10],"602176634":4,"610":[6,10],"6264644":14,"66053906660":4,"7b01160":14,"85418781281":4,"935458":[0,4],"940":10,"96924":6,"980":3,"9918564":[6,10],"boolean":3,"byte":13,"case":[0,3,6,8,10],"class":[0,9],"default":[0,3,7,11,12,13],"export":8,"float":[0,3],"function":[0,3,5,6,7,11,12],"int":[0,5,6,9,12],"long":[5,6],"new":[0,10,13,14],"public":14,"return":[0,8],"short":[6,11],"sigbj\u00e3":14,"static":0,"switch":12,"true":[0,3,6],"while":[0,12],Adding:6,For:[0,11,12,14],The:[0,3,5,6,7,8,9,10,11,12,13,14],Then:10,There:[8,11],These:0,Used:[0,3,11],Using:[6,9],With:[0,6],__file__:8,__init__:[0,8],__main__:8,_gener:0,_hl:8,_kwarg:8,_random_chi_squar:0,_random_gaussian:0,_run_cod:8,_run_module_as_main:8,_set_fapl_mpio:8,_setup:0,about:[3,11,12],abov:[0,6],absent:0,acceler:0,accompani:6,accord:[0,3],accur:14,acid:6,across:[0,3],acs:14,act:[0,10,12],adapt:0,add:[5,6],added:0,adding:6,addison:0,addit:[0,2,5,11],addition:14,additon:0,adher:0,affect:0,affili:[0,2],after:[0,10,12],against:8,aggreg:6,ahren:0,alanin:6,algorithm:[0,3,12],alia:14,all:[0,2,3,4,6,8,10,11,14],all_nam:0,all_rank:0,alloc:0,allow:[11,14],allreduc:0,along:[6,11],alpha3:8,alpha:0,also:[6,8,14],altern:2,alwai:[0,3],amino:6,amphiphil:14,analyt:0,angl:[0,2,3,6,8,10],angle_bond:[0,3,6,10],angular:[0,3,6,10],ani:[0,2,3],anisotrop:0,antonio:14,apart:0,api:8,app:8,appli:[0,3,7,9,12],applic:0,approach:14,approxim:0,apr:14,apt:8,aqueou:14,architectur:14,arg:[0,8],argument:[0,6,8,11],argv:8,aris:0,around:10,arrai:[0,3,11,13],arriv:6,art:0,aspect:3,assess:0,assign:[0,3,10],associ:[0,9],assum:3,assumpt:12,atom:0,atom_1:0,atom_2:0,atom_3:0,atom_4:0,attach:13,attempt:0,attr:8,attract:3,attribut:0,autom:14,automat:[0,7,8,9],avail:[6,8,14],averag:[0,9],avogadro:4,back:[0,5,8],backbon:[0,2,3,14],backcon:0,backend:14,backmap:0,balanc:0,ballist:6,bar:4,barostat:0,barostat_typ:0,base:[0,14],bath:[0,3],bb_index:0,bc20:14,bdist_wheel:8,bdp07:14,bead:0,becaus:0,becom:0,befor:[0,3,6,8],being:[0,2,3,5,10,11,12],belong:11,below:6,benchmark:10,bend:[0,3,10,14],bern:14,besid:2,best:0,beta:0,better:0,between:[0,3,5,6,9,10,12,13],bia:0,big:12,bin:8,binari:8,bind:14,bindu:14,bio:14,bit:[0,13],blueprint:0,bmc18:14,boltzmann:[0,3,4],bond2_energi:0,bond3_energi:0,bond4_energi:0,bond:[0,2,6,8,11,12,13],bonds_2:0,bonds_2_atom1:0,bonds_2_atom2:0,bonds_2_atom_1:0,bonds_2_atom_2:0,bonds_2_equilibrium:0,bonds_2_strength:0,bonds_3:0,bonds_3_atom_1:0,bonds_3_atom_2:0,bonds_3_atom_3:0,bonds_3_equilibrium:0,bonds_3_strength:0,bonds_4:0,bonds_4_atom_1:0,bonds_4_atom_2:0,bonds_4_atom_3:0,bonds_4_atom_4:0,bonds_4_coeff:0,bonds_4_last:0,bonds_4_typ:0,bool:0,bootstrap:8,bore:[0,5,12,14],both:[0,12],boundari:[0,3],box:[0,3,6,11],box_siz:[0,3,6,11],breviti:6,brew:8,broadcast:0,browser:8,bruce:14,buffer:[0,3],build_extens:8,build_pfft:8,build_pi:8,built:8,bussi:[0,3,14],c213:14,c236:14,c_n:[0,6,10],calcul:[0,3,6,10],calibr:0,call:[0,8],callabl:0,can:[6,8,14],cancel_com_momentum:[0,3,6],canon:[0,3,14],capabl:2,captur:11,carloni:14,carri:6,cascella:[5,8,11,12,14],caval:14,cbt:0,cdot10:4,cdot:[0,4,10],cell:[0,12],cellar:8,center:[0,3],centr:14,certain:[0,2],ceruso:14,chain:[0,14],chang:[0,3],changedin:0,charg:[0,3,4,5,6,13,14],charge_out:0,check:[0,8],check_angl:0,check_bond:0,check_box_s:0,check_cancel_com_momentum:0,check_charg:0,check_charges_types_list:0,check_chi:0,check_config:0,check_dielectr:0,check_dihedr:0,check_domain_decomposit:0,check_hamiltonian:0,check_integr:0,check_m:0,check_mass:0,check_max_molecule_s:0,check_n_b:0,check_n_flush:0,check_n_particl:0,check_n_print:0,check_nam:0,check_npt_condit:0,check_start_and_target_temperatur:0,check_tau:0,check_thermostat_coupling_group:0,chem:[0,14],chemic:14,chemrxiv:14,chi:[0,3,4,6,8],chi_2:0,chi_3:0,chi_:[0,3,6,9,12],chi_m:0,chmod:11,chosen:0,cic:[0,5,12],circ:[3,10],circumv:12,classmethod:0,classvar:0,clean:[0,8],clone:[8,11,14],close:[0,8],close_fil:0,closest:0,cloud:[0,6,12],cncdp08:14,coars:[0,3,7,14],code:[0,1,2,3,6,8,11],coeff:0,coeffici:0,coil:[0,6],colab:8,colaboratori:14,collect:[0,13],com:[0,8,11,14],combin:[0,6,14],comm:0,comm_world:0,command:[8,11],common:9,commuic:0,commun:[0,3,10],communc:0,compar:6,compat:2,compil:[0,8],compiler_so:8,complesfield:0,complet:[0,6,8],complex:[6,13],complexfield:0,compon:0,comprehens:14,compress:[0,3,4,6,9,11],comput:[0,5,10,12,14],compute_angle_forces__plain:0,compute_bond_forces__plain:0,compute_dihedral_forces__plain:0,compute_field_and_kinetic_energi:0,compute_field_energy_q_gp:0,compute_field_forc:0,compute_potenti:0,compute_self_energy_q:0,concret:11,condit:6,config:[0,8],config_simple_1:11,configur:[0,2,5,6,7,8,9,10,11],configuration_four_particle_exampl:10,configuration_three_particle_exampl:10,configuration_two_particle_exampl:10,configure_runtim:8,conform:[6,13,14],connect:0,conserv:1,consid:6,consist:[0,6],consit:6,consitu:0,constant:[0,3,5,6,10],constitut:[0,2,3],construct:[0,10,11],constructor:0,contain:[0,1,2,3,6,11],content:[0,6],contribut:0,control:3,conv_crit:0,conv_fun:0,conveni:11,converg:[0,12],convergence_typ:0,convert:0,coordin:[11,12,13],copi:0,core:8,correct:[0,3],correspond:[0,3],correspondingli:10,cos:[0,6,10],cosin:[0,3,6,10],cost:[3,10],could:8,coulomb:[0,3,4,5],coulomb_const:0,coulombtyp:[0,3,5,6],counter:6,coupl:[0,3,6,11],cprofil:2,cpu:[0,10],crash:3,creat:[0,9],critic:[0,6],cross:0,csvr:[0,3],csvr_thermostat:0,ct800122x:14,ct9002114:14,current:6,cwd:8,cython:[8,14],d_n:0,dal:14,data:[0,6,11,13],dataclass:0,dataset:[0,5,6,11],datatyp:13,date:[0,14],date_format:0,david:14,debug:[0,2],decompos:0,decomposit:[0,3,10],default_level:0,defaultnochi:[0,6,9],defaultnohchi:[0,3],defaultwithchi:[0,3,6,9],defin:[0,6,9,10,12],definit:0,degre:3,delta:[0,12],denot:[0,1,3,9,10,11],dens:14,densiti:[0,3,5,9,12,14],depend:[0,6,10,12,14],deprec:0,deriv:[0,12],design:6,dest_directori:0,detail:[2,3,6,8,11,12],determin:[0,2,7,14],dev:8,devel:8,develop:[6,8],deviat:[0,3],dict:0,dictat:0,dictionari:0,dielectr:[0,3,6],dielectric_const:[0,3,5,6],dielectric_typ:0,dielectric_valu:0,dieter:0,diezemann:14,differ:[0,3,6,11,13],differenti:[0,5,7,9,12],difficult:2,dih_typ:0,dihedr:[0,2,3,5,6,8,10,14],dimens:[0,10,11,13],dimension:11,dipol:[0,2,3,5,6,14],dipole_forces_redistribut:0,direct:[0,3],directori:11,disabl:[2,6,8,11],disable_mpio:0,discard:0,discret:[0,12],discretis:12,disk:[0,3],dispers:6,dist:8,distanc:[0,3,10],distinct:0,distribut:[0,3,5,6,12],distribute_input:0,distutil:8,dnf:8,doc:0,dockerhub:8,dodecyl:6,doe:[0,10],doi:14,domain:[0,3,10],domain_decomposit:[0,3,6],donadio:[0,14],done:[0,6,8,14],dopc:6,dot:0,dot_elec:0,doubl:2,double_out:0,download:8,dppc:6,draw:0,drawn:0,driver:[8,11],dtype:0,due:[0,3],dump:0,dump_per_particl:0,dure:[0,2,3,10,11],dynam:[0,3,11,12,14],e1785571:14,e_k:0,each:[0,3,6,10,11],easiest:14,effect:[0,3],effici:10,eight:13,either:[0,3,8,13],elast:14,elec:0,elec_field:0,elec_field_contrib:0,elec_field_fouri:0,elec_forc:0,elecrostat:0,electr:[0,4,5],electrosat:0,electrostat:[0,6,14],elnedyn:14,elucid:6,embed:6,emit:0,emploi:0,empti:0,enabl:[2,6,11],enclos:0,end:0,energi:[0,1,3,4,6,7,10,11,12],energiesself:0,ensur:[0,3,6,8,12],ensurepip:8,entri:3,environ:14,epsilon:0,equal:[0,3,6],equat:0,equilibr:6,equilibrium:[0,3,6],equilibrum:10,equival:[0,3],error:0,essenti:[0,1,8],etc:[2,3],even:[0,3,6,8],event:0,everi:[0,3,6,10,11],evid:0,ewald:[0,5,6],examin:6,exampl:[3,8,11,13,14],example_structur:11,except:10,exchang:[0,3],exec:8,execut:[0,8,11],exist:0,exit:8,exp:[7,12],expand:0,expans:0,expect:0,expens:[3,12],explicit:[0,6,10,14],express:0,ext:0,extend:6,extens:14,extent:[0,7],extern:0,extract:[0,8],f401:8,f_angl:0,f_bond:0,f_dihedr:0,f_dipol:0,f_on_bead:0,factor:0,factori:0,fail:[0,8],fall:8,fals:[0,3,6],fapl:8,fashion:[0,3],fast:12,fedora:8,fer:14,few:[6,9,10,11],fft:[0,1,2,3,5,6,11,12,14],fftw3:8,fftw:[8,14],field:[2,4,5,6,9,11,12,14],field_energi:0,field_list:0,field_q_energi:0,field_q_self_energi:0,file:[2,5,6,7,8,9,10,11,14],file_io:0,file_nam:0,file_path:0,filter:[0,3,5,6,11,14],find:[0,8],find_all_path:0,fine:8,first:[0,3,6,11],five:0,fix:[0,8,11],flag:[0,13],flat:11,float32:[11,13],float64:13,flori:0,fluctuat:0,flush:[0,3],follow:[0,2,3,4,6,11],forc:[2,3,4,5,6,10,14],force_kernel:8,force_mesh:0,force_mesh_elec:0,force_mesh_elec_fouri:0,force_out:0,forego:2,form:[0,5,10],formal:[5,12],format:[0,2,3,5,11,13,14],formatt:0,fortran:[0,10],forward:0,found:[5,8],four:[0,2,3,6,13],fourier:[0,5,12],fr6nt9m4:8,frac:[0,5,6,7,9,10,12],frame:[0,11,13],framework:8,free:14,frequenc:[0,3],from:[0,2,3,5,6,8,9,10,11,14],full:[0,9,11],fulli:[0,6,8],fundament:11,gamma:0,gamma_0:0,gas:[0,4],gas_const:0,gather:0,gauss:14,gaussian:[0,3,7,12],gener:[0,2,3,6,14],get:8,getattr:8,ghost:0,giovanni:14,git:[8,11,14],github:[6,8,11,14],githubusercont:8,giusepp:14,given:[0,3,6,7],glenn:14,global:0,gnu:14,govern:9,gpe:0,grab:8,gradient:0,grain:[0,3,7,14],graph:0,gregor:14,grid:[0,1,3,5,6,7,11,12],group:[0,3,6,8,11,13,14],guess:0,gyrat:6,h5md:[0,3],h5py:[0,2],h_0:[6,12],half:0,hamiltonian:[3,5,6,7,9,11,14],handl:0,handler:0,happen:10,harmon:[0,3,6,10],has:[0,3,8,13],hat:[7,12],have:[0,6,8],hdf5:[0,2,3,5,6,8,11,13,14],hdf5_dir:8,hdf5_mpi:8,head:6,header:8,heat:[0,3],helic:[0,3,5,6],help:6,helper:0,here:[0,6,8,14],hhpf:14,highli:[8,10,11],hijack:7,hima:14,hire:1,homogen:0,homopolym:1,homopolypeptid:6,how:[3,11,14],howev:6,hpf:[3,5,9,11,12,14],html:0,http:[0,8,11,14],huggin:0,hundr:[6,10],hybrid:[11,12,14],hylleraa:14,hymd:[0,2,3,4,5,6,7,9,10,11,12,13],ideal:10,ideal_chain:[6,8],ideal_ga:[6,11],ident:0,ignor:0,ijk:[5,12],imag:8,impact:0,implement:[0,10],importerror:8,impuls:[0,3],in_fil:[0,8],inam:8,includ:[0,2,3,6,12,14],incompress:[0,3],increas:[0,2,6],indentifi:0,independ:[0,3,7,12],index:[0,11,13,14],indic:[0,2,3,10,11,13],indirect:0,individu:[0,3,6],induc:5,infer:10,info:[0,8],inform:[0,10,14],ingredi:6,initi:0,initial_energi:0,initialis:11,initialize_pm:0,inner:[0,3],input:[2,3,4,5,6,7,8,11,13],input_box:0,input_pars:[0,8],insid:[0,3,6],instal:[2,11],install_pfft:8,instantan:0,int32:[11,13],int64:13,integ:[0,3,6,13],integr:[3,6,11],integrate_posit:0,integrate_veloc:0,intend:8,inter:[0,10],interact:[0,2,3,4,6,7,11,12,14],interaction_energi:0,interfac:0,intergr:0,intermediari:0,intermolecular:[6,14],intern:[0,2,4,10],interpol:[0,5],interpret:11,interv:[0,3],intmathrm:0,intracomm:0,intramolecular:[0,3,6,12,14],intrins:5,introduc:6,investig:0,invok:[2,11],involv:[0,3,10],ion:6,ipynb:6,is_open:0,iter:0,j_k:0,jan:14,jctc:14,join:8,jone:12,journal:14,jupyt:[6,8,14],k_e:0,kappa:[0,3,4,6,11,12],kawakatsu:14,kdnb:14,keep:[0,3],kelvin:[0,3,6,11],ken:14,kernel:[0,10],keyword:[0,5,6,11],kinet:[0,12],kinetic_energi:0,knuth:0,kolli:14,kpa:4,kwd:8,label:[1,10],lambda:0,lamdifi:9,land:14,laplacian:0,larg:[8,11],larger:3,last:[6,8,11,13],last_bb:0,later:[0,6],latest:8,law:10,layout:0,layout_q:0,lbc20:14,leak:8,learn:14,leav:0,ledum:[6,14],left:[0,5,6,7,9,10,12],legend:1,lenght:0,length:[0,3,4,6,7,10,11,13],lennard:12,less:[0,6],lesser:14,let:[0,10],level:[0,2,3,13],liang:14,lib64:8,lib:8,libhdf5:8,libopenmpi:8,librari:[0,2,8,14],libtool:8,libver:8,licens:14,lieu:0,like:[0,6,8,11],limit:[3,8],line:[0,8,11],linear:[0,3],lipid_self_assembl:6,list:0,list_coulomb:0,load:0,local:[0,8,10,11,12],locat:8,log:[0,2,11],log_fil:0,log_out:11,logfil:[2,11],logger:2,logic:0,logrecord:0,look:[6,8,11],loop:0,lost:3,low:[6,8],lower:8,m_j:0,mac:8,machin:[2,14],made:0,mai:[0,2,3,6,8,10,11,13],main:[0,8,11],main_glob:8,maintain:14,make:[6,8],make_fapl:8,manner:6,manual:8,map:[0,11],marco:14,marilisa:14,marrink:14,martini:[6,14],martyna:14,mass:[0,3,4,13],massiv:14,match:0,math:0,mathbf:[0,4,5,6,9,10,12],mathcal:[6,12],mathmr:0,mathrm:[0,5,6,9,10,12],matteo:14,matter:[6,10,14],max_molecule_s:[0,3,6],maximum:[0,3,10,11],maxwel:[0,3],may:2,mbbjm:14,mean:[0,2,3],measur:10,medium:[0,3,6],melt:1,membran:6,memori:[0,8],mesh:[0,1,3,5,6,14],mesh_siz:[0,3,6,11],messag:0,messi:0,meta:6,metadata:0,method:[0,1,6,7],mh_0:12,micellular:6,michael:14,michel:14,might:[0,8],milano:14,mimic:0,minim:6,minuscul:10,mirror:2,mix:[0,6],mk09:14,model:[6,14],modifi:0,modul:[0,3,8,14],mol:[3,4,6,10,11,14],molecul:[0,3,11,12,13],molecular:[2,11,12,14],moment:8,momenta:[0,11],momentum:[0,3,4],monoatom:6,more:[2,3,6,8,11,12,14],mortel:8,morten:14,most:[8,9,11,12],mostli:2,motion:[0,6],move:0,mpi4pi:[0,8,14],mpi:[0,2,3,10,11,14],mpi_num_rank:11,mpicc:8,mpifilteral:0,mpifilterroot:0,mpio:[2,8],mpip:8,mpirun:11,multiarrai:8,multipl:[0,3,6,11,13,14],multipolar:14,multiscal:14,must:[0,3],n_b:0,n_flush:[0,3,6],n_frame:0,n_particl:[0,3],n_print:[0,3,6,11],n_step:[0,3,6,11],n_type:0,nabla:[0,12],name:[0,2,3,6,10,11,13],nanomet:[0,1],nanosecond:6,ndarrai:0,ne5et1y_:8,necessari:[0,6,8],necessit:[8,9],need:[0,6],neg:[0,6],neighbour:0,neri:14,network:[0,10,11,13,14],networkx:0,neutralis:6,never:[0,3],nevertheless:3,newer:8,next:[0,6],nicola:14,non:[0,2,6,8],none:[0,3,8],nongnu:0,noqa:8,normal:[0,2,3,8,12],notabl:11,note:[0,6,8,11,12],notebook:[6,8,14],now:6,nproc:11,npt:0,nq_i:5,number:[0,1,2,3,6,11,12,13],numer:0,numpi:[0,2,9,14],nvt:0,object:[0,9],oblat:6,observ:[0,6],obtain:[0,5,12,14],obviou:8,off:6,omit:6,onc:[3,10],one:[0,2,3,6,13],onli:[0,6,8,10,11],onto:[0,3,5,12],open:[0,8],openmpi:8,oper:[0,3,12,14],oppos:0,optim:[0,10],optimis:[6,10],option:[0,3,6,11],order:[0,3,6,10,11],ordinari:[5,12],org:0,organis:6,origin:0,oslo:14,osx:8,other:[0,11],otherwis:0,out:[8,12],outdataset:0,outer:0,output:[2,3,4,6,8,11],outsid:3,over:0,overlap:[0,9],packag:[8,11,14],page:14,paint:0,paolo:14,paper:0,parallel:[0,2,3,14],paramet:[0,3,6,7,9,14],parent_group:0,parllel:0,parrinello:[0,14],pars:[0,3],parse_config_toml:[0,8],part:[5,6,12],partial:0,particl:[0,2,5,6,7,9,11,12,13,14],particlemesh:0,particular:11,path:[0,2,8,11],pcmc09:14,pdf:1,pencil:0,peptid:[0,2,3,5,14],per:[0,2,3,10,11,13],peraro:14,perfect:0,perform:[0,3,8,10,11,12],periol:14,perman:[10,14],permitt:[0,4],pfft:[0,14],pfft_build_dir:8,phase:[0,10],phase_separ:6,phi:[0,3,6,10,12],phi_0:[6,9,12],phi_:[0,6,9,12],phi_ep:0,phi_eps_fouri:0,phi_eta:0,phi_eta_fouri:0,phi_fouri:0,phi_k:0,phi_l:0,phi_laplacian:0,phi_n:[6,10],phi_pol:0,phi_pol_prev:0,phi_q:0,phi_q_fouri:0,phi_transf:0,phospholipid:6,phy:[0,14],pic_spectr:[0,3,6],pic_spectral_gp:0,piec:6,pip13:14,pip3:8,pip:[8,11,14],pippig:14,pkg:8,place:[0,3],plain:2,plane:[0,6,10],pleas:[8,11],plist:8,plume:0,plumed_bia:0,plumed_out:0,pme:14,pmesh:[0,14],png:1,point:[0,1,10,13],poisson:0,pol_mix:0,polar:0,polym:[6,14],posit:[0,2,3,5,6,11,12],possibl:[0,3,6,14],potenti:[0,3,4,5,7,8,10,14],ppft:14,practic:10,pre:[0,6],precis:[1,2],prefer:3,prepar:0,prepare_bond:0,prepare_bonds_old:0,prepare_index_based_bond:0,prepend:[0,11],present:[0,2,3,6],preserv:3,pressur:[0,4],pretti:8,previou:0,previous:6,prior:[0,3],priovid:0,prng:0,prod_:0,profil:2,program:[0,11],project:5,promot:0,prop:0,propag:[0,3],propens:[0,3,5,6],propensity_potential_coeff:0,properti:3,protein:[0,14],provid:[0,2,3,11,13,14],psi:[0,4,5],psi_:5,psi_fouri:0,pull:8,put:6,pytest:11,python3:[6,8,11,14],python:[0,11,14],q_i:[0,5],q_j:0,quadrat:0,quanit:0,quantiti:[0,4],quantum:14,quartet:10,quess:0,r_0:[0,6,10],r_a:10,r_c:10,rad:[3,10],radial:6,radii:6,radiu:6,rainwoodman:[8,14],rais:[6,8],random:[0,2,11],random_chi_squar:0,random_gaussian:0,randomli:[0,3,6],rang:5,rank0:0,rank:[0,2,3,10,11],rank_rang:0,rankself:0,rare:10,raw:8,rdcc_nbyte:8,rdcc_nslot:8,rdcc_w0:8,read:[0,8,11,14],read_config_toml:[0,8],readout:0,real:13,realfield:0,realist:6,reappli:0,rearrang:0,reason:8,receiv:[0,3],recent:8,reciproc:[0,7],recognis:11,recognit:14,recommend:8,reconstruct:[0,2,5,6,10,14],record:0,recreat:14,recurs:0,redistribut:0,reduc:[3,12],refer:[3,11],regim:6,regul:[0,3],regularli:8,rel:[0,3,6,10],relax:[0,3],releas:[0,6,8,11,14],remain:[0,6],remov:[0,3],remove_center_of_mass_momentum:0,remove_com_momentum:[0,3],replac:[0,8],repositori:[6,11],repres:[0,3,13],represent:7,repuls:3,requir:[0,3,8,10,11,14],rescal:[0,3,14],research:14,respa:[0,3,6],respa_inn:[0,3,6],respect:[0,1,12],restructur:0,result:[0,3,6,9],revers:[0,3,14],rgen:14,rho0:0,rho:[0,5],rho_0:0,rho_:5,right:[0,5,6,7,9,10,12],rightarrow:10,root:[0,11,13],roughi:6,row:11,rrespa:[0,3,6],ruin:0,run:[0,2,3,6,10],run_glob:8,rundown:11,runpi:8,runtimeerror:8,same:[0,3,6],sampl:[0,3,14],scalar:0,scale:[0,3,6,7,8,10,11,14],sch:14,scheme:[0,6],sci:14,scienc:14,script:11,sds:6,search:14,second:[0,11],see:[0,2,3,5,6,8,9,10,11,12,14],seed:[2,11],select:[11,14],self:[0,3,8],self_energi:0,seminumer:0,send:[0,3],separ:0,seri:[0,3,6,10],serial:[8,11],serialis:3,set:[0,3,11],set_fapl:8,setup:[0,6,7,8,13],setup_time_dependent_el:0,setuptool:8,sever:0,shape:[0,6,11,13],sheet:0,shift:0,should:[0,2,10],shown:6,siam:14,siewert:14,sigbj:14,sigma:[0,3,6,7,11,12],sim:0,similar:0,simpl:[0,6,11,12],simplest:6,simpli:0,simul:[0,2,6,8,10,12,13,14],simultan:0,sinc:0,singl:[0,3,6],site:8,size:[0,3,6,11,12],slight:0,slowli:12,small:[3,11],smear:5,smooth:[0,12],sodium:6,soft:[6,14],solv:0,solvent:6,some:[0,3,8],sort:0,sort_dielectric_by_type_id:0,sourc:[0,1],space:[0,3,5,7],span:0,spatial:[0,3,11,12],specfi:0,speci:0,special:0,specif:[0,2,3,6,9,10,11,13],specifi:[0,2,3,6,9,10,11,13],spectacularli:0,spectral:6,speed:[0,3],spheric:6,spheroid:6,split:0,spontan:6,spring:[0,10],sqrt:[0,7,12],squar:[0,9],squaredphi:[0,3,9,11],stabil:6,stabl:6,stackoverflow:0,standard:[0,3,12,14],start:[0,3,6,10,13],start_temperatur:[0,3,6],state:0,statu:8,stdout:[0,2],step:[0,3,6,10,11],stiff:3,stochast:0,store:0,store_data:0,store_stat:0,str10:11,str:0,straightforward:[7,9],stream:0,strength:[0,3,6,11],stretch:[0,3,10,14],string:[0,3,8,11,13],structur:[0,2,3,5,6,11,14],style:14,sub:6,subclass:[0,9],subsequ:[0,5,6,10],sudo:8,suitabl:0,sulfat:6,sum:0,sum_:[0,5,9,12],sum_i:0,sum_j:0,sum_k:0,sum_n:[0,6,10],summari:11,superclass:[0,7],support:[0,6,8,14],swap:10,symbol:[0,4,9],sympi:[0,9],sys:8,system:[0,1,2,3,6,9,11,12,14],tag:[0,3,8],take:[0,3,5,9,10,11,12],taken:0,tar:8,target:0,target_pressur:0,target_temperatur:[0,3,6,11],tau:[0,3,6,11],tau_p:0,tbm92:14,temperatur:[0,3,4,6,11],ten:6,term:[0,3,6,9,12],test:[0,1,8],text:[0,2,3,4,5,6,9,10,12],than:[0,3],theori:[0,14],therefor:8,thermalis:[0,3],thermostat:[2,3,6,11],thermostat_coupling_group:[0,3,6],thermostat_work:0,theta:[6,10],theta_0:[0,6,10],thi:[0,2,3,6,8,9,10,11,12],thorough:11,though:6,thousand:[6,10],three:[0,2,3,6],through:[0,3,6,7,8,9,10,14],tild:[0,3,4,5,6,9,12],time:[0,3,4,6,10,11,14],time_step:[0,3,6,11],tmp:8,todo:0,togeth:[0,3,6],token:8,toml:[0,2,3,6,8,10,11],toml_cont:0,tomli:0,too:3,toplog:0,topol:0,topolog:[0,2,3,5,6,11,14],torsion:[0,3,10,14],toshihiro:14,total:[0,3,6,11,12],traceback:8,trajectori:[0,2,3,6,11],trans_matric:0,transfer:[0,10],transform:[0,9,12],travers:0,tri:3,truncat:0,tuckerman:[3,14],turn:6,tutori:[6,8,11,13],two:[0,2,3,6],txt:11,type:[0,2,3,5,6,9,10,11,13],type_arrai:0,type_charg:0,type_to_name_map:0,ubuntu:8,uio:[8,11,14],unchang:0,under:[6,8,12,14],uninstal:8,union:0,uniqu:0,unique_nam:0,unit:[0,3,10],univers:14,unknown:0,unless:[0,3],unset:0,unstabl:3,until:6,updat:[0,8],update_field:0,update_field_force_q:0,update_field_force_q_gp:0,upgrad:[8,14],usag:[0,2],use:[0,3,5,6,8],used:[0,1,2,3,6,7,9,11,12,13],uses:[0,4,12,14],using:[0,2,3,8,12,14],usr:8,usual:11,v_2:[0,6,10],v_3:[0,6,10],v_4:[0,6,10],v_ext:0,v_ext_fouri:0,vacuum:4,valid:[0,3],validated_config:0,valu:[0,3,4,5,6,10],valueerror:8,vanish:0,varepsilon:0,varepsilon_0:[4,5],vari:12,variabl:0,variant:6,variou:[0,13],vbar_elec:0,vbar_elec_fouri:0,vector:10,vectoris:9,veloc:[0,2,3,4,6,11,13,14],velocity_out:0,velocti:0,verbos:[0,2,8,11],veri:[6,8,10],verifi:0,verlet:[0,3,6,11],versa:3,version:[0,6,8,11,12],vert:0,vertex:[0,5],vertic:0,via:[6,14],vice:3,vol:0,volum:0,voxel:0,wai:[8,12],warn:0,weakli:3,weight:0,well:6,were:0,weslei:0,wheel:8,when:[0,3,8,10],where:[0,5,9,10,12],which:[0,2,3,5,6,8,9,10,11],width:[0,3],window:[0,5,12],without:[0,14],work:[0,8],workload:0,would:[0,3],wrap:0,wrapper:0,write:[0,3],written:[0,3],www:0,xavier:14,yield:6,you:[8,10,14],yuan:14,zero:[0,3],zhong:14,zhu:14},titles:["4. API reference","3. Benchmarks","5. Command line arguments","3. Configuration file","6. Constants and Units","3. Electrostatic interactions","1. Examples","2. Filtering","1. Installation","1. Interaction energy functionals","2. Intramolecular bonds","2. Usage overview for HylleraasMD","1. Theory","4. Topology and structure file","HylleraasMD documentation"],titleterms:{"function":9,"import":8,"new":[7,9],"while":8,SDS:6,api:0,argument:2,assembl:6,benchmark:1,bilay:6,bond:[1,3,10],build:8,calcul:12,chain:6,chi:9,code:14,colab:14,colaboratori:8,command:2,common:8,configur:3,constant:4,copolym:6,curl:8,dataset:13,depend:8,develop:14,diblock:6,docker:8,document:14,due:8,electrostat:[3,5],enabl:8,energi:9,error:8,exampl:6,extern:12,field:[0,1,3],file:[0,3,13],filter:[7,12],forc:[0,1,8,12],form:[9,12],fortran:8,four:10,gas:6,googl:[8,14],guid:14,h5py:8,hamiltonian:[0,12],helix:6,hylleraasmd:[11,14],hymd:[8,14],ideal:6,implement:[7,9],incompress:9,indic:14,input:0,instal:[8,14],integr:0,interact:[5,8,9],interpol:12,intramolecular:10,issu:8,kappa:9,kernel:8,keyword:3,line:2,lipid:6,logger:0,metadata:3,miss:8,mpi:8,numpi:8,onli:9,option:[2,13],output:0,overview:11,parallel:[8,11],parser:0,particl:[1,3,10],peptid:6,pfft:8,phase:6,phi:9,potenti:12,python:8,reciproc:12,refer:[0,14],requir:[2,13],rod:6,run:[8,11,14],self:6,separ:6,simul:[3,11],sourc:14,space:12,specifi:5,stiff:6,structur:13,tabl:14,test:11,theori:12,thermostat:0,three:10,topolog:13,two:10,unit:4,usag:11,user:14,wget:8,without:8}}) \ No newline at end of file diff --git a/v2.0.0/.buildinfo b/v2.0.0/.buildinfo new file mode 100644 index 00000000..df1baff7 --- /dev/null +++ b/v2.0.0/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: b74ec8d4dd6034faef61113edfb3222c +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v2.0.0/.doctrees/doc_pages/api.doctree b/v2.0.0/.doctrees/doc_pages/api.doctree new file mode 100644 index 00000000..fbfe628c Binary files /dev/null and b/v2.0.0/.doctrees/doc_pages/api.doctree differ diff --git a/v2.0.0/.doctrees/doc_pages/benchmarks.doctree b/v2.0.0/.doctrees/doc_pages/benchmarks.doctree new file mode 100644 index 00000000..47fd21a5 Binary files /dev/null and b/v2.0.0/.doctrees/doc_pages/benchmarks.doctree differ diff --git a/v2.0.0/.doctrees/doc_pages/command_line.doctree b/v2.0.0/.doctrees/doc_pages/command_line.doctree new file mode 100644 index 00000000..5ee2b047 Binary files /dev/null and b/v2.0.0/.doctrees/doc_pages/command_line.doctree differ diff --git a/v2.0.0/.doctrees/doc_pages/config_file.doctree b/v2.0.0/.doctrees/doc_pages/config_file.doctree new file mode 100644 index 00000000..ae89c08d Binary files /dev/null and b/v2.0.0/.doctrees/doc_pages/config_file.doctree differ diff --git a/v2.0.0/.doctrees/doc_pages/constants_and_units.doctree b/v2.0.0/.doctrees/doc_pages/constants_and_units.doctree new file mode 100644 index 00000000..45ebf800 Binary files /dev/null and b/v2.0.0/.doctrees/doc_pages/constants_and_units.doctree differ diff --git a/v2.0.0/.doctrees/doc_pages/electrostatics.doctree b/v2.0.0/.doctrees/doc_pages/electrostatics.doctree new file mode 100644 index 00000000..e884fb68 Binary files /dev/null and b/v2.0.0/.doctrees/doc_pages/electrostatics.doctree differ diff --git a/v2.0.0/.doctrees/doc_pages/examples.doctree b/v2.0.0/.doctrees/doc_pages/examples.doctree new file mode 100644 index 00000000..b19e2a1d Binary files /dev/null and b/v2.0.0/.doctrees/doc_pages/examples.doctree differ diff --git a/v2.0.0/.doctrees/doc_pages/filtering.doctree b/v2.0.0/.doctrees/doc_pages/filtering.doctree new file mode 100644 index 00000000..baca07c9 Binary files /dev/null and b/v2.0.0/.doctrees/doc_pages/filtering.doctree differ diff --git a/v2.0.0/.doctrees/doc_pages/installation.doctree b/v2.0.0/.doctrees/doc_pages/installation.doctree new file mode 100644 index 00000000..833122fc Binary files /dev/null and b/v2.0.0/.doctrees/doc_pages/installation.doctree differ diff --git a/v2.0.0/.doctrees/doc_pages/interaction_energy_functionals.doctree b/v2.0.0/.doctrees/doc_pages/interaction_energy_functionals.doctree new file mode 100644 index 00000000..bb97ddfe Binary files /dev/null and b/v2.0.0/.doctrees/doc_pages/interaction_energy_functionals.doctree differ diff --git a/v2.0.0/.doctrees/doc_pages/intramolecular_bonds.doctree b/v2.0.0/.doctrees/doc_pages/intramolecular_bonds.doctree new file mode 100644 index 00000000..5e6add14 Binary files /dev/null and b/v2.0.0/.doctrees/doc_pages/intramolecular_bonds.doctree differ diff --git a/v2.0.0/.doctrees/doc_pages/overview.doctree b/v2.0.0/.doctrees/doc_pages/overview.doctree new file mode 100644 index 00000000..d75abe1f Binary files /dev/null and b/v2.0.0/.doctrees/doc_pages/overview.doctree differ diff --git a/v2.0.0/.doctrees/doc_pages/pressure.doctree b/v2.0.0/.doctrees/doc_pages/pressure.doctree new file mode 100644 index 00000000..fd18042c Binary files /dev/null and b/v2.0.0/.doctrees/doc_pages/pressure.doctree differ diff --git a/v2.0.0/.doctrees/doc_pages/theory.doctree b/v2.0.0/.doctrees/doc_pages/theory.doctree new file mode 100644 index 00000000..a25eb1f6 Binary files /dev/null and b/v2.0.0/.doctrees/doc_pages/theory.doctree differ diff --git a/v2.0.0/.doctrees/doc_pages/topology_input.doctree b/v2.0.0/.doctrees/doc_pages/topology_input.doctree new file mode 100644 index 00000000..a94de9c0 Binary files /dev/null and b/v2.0.0/.doctrees/doc_pages/topology_input.doctree differ diff --git a/v2.0.0/.doctrees/environment.pickle b/v2.0.0/.doctrees/environment.pickle new file mode 100644 index 00000000..adcf929d Binary files /dev/null and b/v2.0.0/.doctrees/environment.pickle differ diff --git a/v2.0.0/.doctrees/index.doctree b/v2.0.0/.doctrees/index.doctree new file mode 100644 index 00000000..8fae39a8 Binary files /dev/null and b/v2.0.0/.doctrees/index.doctree differ diff --git a/v2.0.0/_downloads/14bc11783ef5a6940ea1deff6f828616/benchmarks-1.png b/v2.0.0/_downloads/14bc11783ef5a6940ea1deff6f828616/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v2.0.0/_downloads/14bc11783ef5a6940ea1deff6f828616/benchmarks-1.png differ diff --git a/v2.0.0/_downloads/18eb12de0f08a459ba0138de30f61941/benchmarks-1.pdf b/v2.0.0/_downloads/18eb12de0f08a459ba0138de30f61941/benchmarks-1.pdf new file mode 100644 index 00000000..81dfc25e Binary files /dev/null and b/v2.0.0/_downloads/18eb12de0f08a459ba0138de30f61941/benchmarks-1.pdf differ diff --git a/v2.0.0/_downloads/42572eafeb7877eca97cdedb4c07a90c/benchmarks-2.py b/v2.0.0/_downloads/42572eafeb7877eca97cdedb4c07a90c/benchmarks-2.py new file mode 100644 index 00000000..fd287cbc --- /dev/null +++ b/v2.0.0/_downloads/42572eafeb7877eca97cdedb4c07a90c/benchmarks-2.py @@ -0,0 +1,33 @@ +import numpy as np +import matplotlib.pyplot as plt + +mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] +mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + +mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + +mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + +mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] +mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + +mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + +mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + +plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") +plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") +plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") +plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") +plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") +plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") +plt.xlabel("CPUs", fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.ylabel("Time per step, s", fontsize=15) +plt.legend(loc="upper left", fontsize=15) +plt.show() \ No newline at end of file diff --git a/v2.0.0/_downloads/744a8a4bb972391547d58f4a792fbf7e/benchmarks-2.pdf b/v2.0.0/_downloads/744a8a4bb972391547d58f4a792fbf7e/benchmarks-2.pdf new file mode 100644 index 00000000..f5ec5dd0 Binary files /dev/null and b/v2.0.0/_downloads/744a8a4bb972391547d58f4a792fbf7e/benchmarks-2.pdf differ diff --git a/v2.0.0/_downloads/7ee8db4a2dce624ff723d31c5fc1706c/benchmarks-2.hires.png b/v2.0.0/_downloads/7ee8db4a2dce624ff723d31c5fc1706c/benchmarks-2.hires.png new file mode 100644 index 00000000..82806426 Binary files /dev/null and b/v2.0.0/_downloads/7ee8db4a2dce624ff723d31c5fc1706c/benchmarks-2.hires.png differ diff --git a/v2.0.0/_downloads/ba83c96159b03bf3b496d9bfc464988d/benchmarks-2.png b/v2.0.0/_downloads/ba83c96159b03bf3b496d9bfc464988d/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v2.0.0/_downloads/ba83c96159b03bf3b496d9bfc464988d/benchmarks-2.png differ diff --git a/v2.0.0/_downloads/de415af2ec71d1c7cd98ac611537be5e/benchmarks-1.hires.png b/v2.0.0/_downloads/de415af2ec71d1c7cd98ac611537be5e/benchmarks-1.hires.png new file mode 100644 index 00000000..173b39f3 Binary files /dev/null and b/v2.0.0/_downloads/de415af2ec71d1c7cd98ac611537be5e/benchmarks-1.hires.png differ diff --git a/v2.0.0/_downloads/f8c56c910406855e25e690dccef9dae3/benchmarks-1.py b/v2.0.0/_downloads/f8c56c910406855e25e690dccef9dae3/benchmarks-1.py new file mode 100644 index 00000000..deb4348f --- /dev/null +++ b/v2.0.0/_downloads/f8c56c910406855e25e690dccef9dae3/benchmarks-1.py @@ -0,0 +1,38 @@ +import numpy as np +import matplotlib.pyplot as plt +nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) +time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 +], dtype=np.float64) +nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 +], dtype=np.float64,) +time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, +], dtype=np.float64) +nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 +], dtype=np.float64) +time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, +], dtype=np.float64) +plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" +) +plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" +) +plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" +) +plt.xlabel("CPUs", fontsize=15) +plt.ylabel("Time per step, us", fontsize=15) +plt.legend(fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.show() \ No newline at end of file diff --git a/v2.0.0/_images/benchmarks-1.png b/v2.0.0/_images/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v2.0.0/_images/benchmarks-1.png differ diff --git a/v2.0.0/_images/benchmarks-2.png b/v2.0.0/_images/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v2.0.0/_images/benchmarks-2.png differ diff --git a/v2.0.0/_images/hylleraas_centre_logo_black.png b/v2.0.0/_images/hylleraas_centre_logo_black.png new file mode 100644 index 00000000..40826396 Binary files /dev/null and b/v2.0.0/_images/hylleraas_centre_logo_black.png differ diff --git a/v2.0.0/_images/uio_full_logo_eng_pos.png b/v2.0.0/_images/uio_full_logo_eng_pos.png new file mode 100644 index 00000000..6c603139 Binary files /dev/null and b/v2.0.0/_images/uio_full_logo_eng_pos.png differ diff --git a/v2.0.0/_modules/hymd/barostat.html b/v2.0.0/_modules/hymd/barostat.html new file mode 100644 index 00000000..9e35c9d3 --- /dev/null +++ b/v2.0.0/_modules/hymd/barostat.html @@ -0,0 +1,599 @@ + + + + + + hymd.barostat — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.barostat

+"""Implements the Berendsen barostat.
+Scales the box and particle positions during simulation to
+simulate coupling to an external pressure bath set at a
+target pressure.
+
+It calculates the scaling factor according to:
+.. math::
+
+    \\alpha_{L,N} = 1 - \\frac{dt n_b}{\\tau_p}\\β(P_{L,N}^t - P_{L,N})
+
+where :math:`dt` is the outer rRESPA time-step, :math:`n_b` is the frequency
+of barostat calls, :math:`\\tau_p` is the pressure coupling time constant,
+:math:`\\beta` is the isothermal compressibility, :math:`P_{L,N}^t` and 
+:math:`P_{L,N}` is the target and instantaneous internal pressure in the 
+lateral (L) and normal (N) directions respectively. Convention: Cartesian
+z-direction is considered normal.
+
+The box and particle positions are scaled in the L and N directions according
+to the nature of the barostat (see functions `isotropic` and `semiisotropic`
+below by an amount :math:`\α^{\\frac{1}{3}}`.
+
+The updated system information is passed on to the pmesh objects.
+
+References
+----------
+H. J. C. Berendsen, J. P. M. Postma, W. F. van Gunsteren,
+A. DiNola, and J. R. Haak , "Molecular dynamics with coupling
+to an external bath", J. Chem. Phys. 81, 3684-3690 (1984)
+"""
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass
+from typing import Union
+from .pressure import comp_pressure
+from .field import initialize_pm
+
+
+@dataclass
+class Target_pressure:
+    P_L: Union[bool, float]
+    P_N: Union[bool, float]
+
+
+
[docs]def isotropic( + pmesh, + pm_stuff, + phi, + phi_q, + psi, + hamiltonian, + positions, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + bond_pr, + angle_pr, + step, + prng, + comm=MPI.COMM_WORLD, +): + """ + Implements an isotropic Berendsen barostat. + The box and particle positions are scaled uniformly + in the L and N directions. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of pmesh objects. + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fft : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds. + step : integer + MD step number + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of modified/unmodified pmesh objects. + change : Boolean + Indicates whether or not any pmesh objects were reinitialized. + """ + rank = comm.Get_rank() + beta = 4.6 * 10 ** (-5) # bar^(-1) #isothermal compressibility of water + change = False + + if np.mod(step, config.n_b) == 0: + change = True + # compute pressure + pressure = comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=comm, + ) + + # Total pressure across all ranks + P = np.average(pressure[-3:-1]) # kJ/(mol nm^3) + P = P * 16.61 # bar + + # scaling factor + alpha = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_L - P) + ) ** (1 / 3) + + # length scaling + config.box_size *= alpha + + # position coordinates scaling + positions *= alpha + + # pmesh re-initialize + pm_stuff = initialize_pm(pmesh, config, comm) + return (pm_stuff, change)
+ + +
[docs]def semiisotropic( + pmesh, + pm_stuff, + phi, + phi_q, + psi, + hamiltonian, + positions, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + bond_pr, + angle_pr, + step, + prng, + comm=MPI.COMM_WORLD, +): + """ + Implements a semiisotropic Berendsen barostat. + The box and particle positions are scaled by :math:`\\alpha_L^{\\frac{1}{3}}` + in the L direction and by :math:`\\alpha_N^{\\frac{1}{3}}` in the N direction. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of pmesh objects. + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fft : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds. + step : integer + MD step number + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of modified/unmodified pmesh objects. + change : Boolean + Indicates whether or not any pmesh objects were reinitialized. + """ + rank = comm.Get_rank() + beta = 4.6 * 10 ** (-5) # bar^(-1) #isothermal compressibility of water + change = False + if np.mod(step, config.n_b) == 0: + change = True + + # compute pressure + pressure = comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=comm, + ) + + # Total pressure across all ranks + # L: Lateral; N: Normal + [PL, PN] = [0, 0] + PL = (pressure[-3] + pressure[-2]) / 2 # kJ/(mol nm^3) + PN = pressure[-1] # kJ/(mol nm^3) + PL = PL * 16.61 # bar + PN = PN * 16.61 # bar + alphaL = 1.0 + alphaN = 1.0 + + if config.target_pressure.P_L: + # scaling factor + alphaL = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_L - PL) + ) ** (1 / 3) + # length scaling + config.box_size[0:2] *= alphaL + + positions[:][0:2] *= alphaL + + if config.target_pressure.P_N: + # scaling factor + alphaN = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_N - PN) + ) ** (1 / 3) + # length scaling + config.box_size[2] *= alphaN + + positions[:][2] *= alphaN + + # pmesh re-initialize + pm_stuff = initialize_pm(pmesh, config, comm) + return (pm_stuff, change)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/_modules/hymd/field.html b/v2.0.0/_modules/hymd/field.html new file mode 100644 index 00000000..a55aeea8 --- /dev/null +++ b/v2.0.0/_modules/hymd/field.html @@ -0,0 +1,1468 @@ + + + + + + hymd.field — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.field

+"""Forces and energies from the discretized particle-field grid interactions
+"""
+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import warnings
+
+
+
[docs]def initialize_pm(pmesh, config, comm=MPI.COMM_WORLD): + """ + Creates the necessary pmesh objects for pfft operations. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + config : Config + Configuration dataclass containing simulation metadata and parameters. + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm : object 'pmesh.pm.ParticleMesh' + field_list : list[pmesh.pm.RealField], (multiple) + Essential list of pmesh objects required for MD + list_coulomb : list[pmesh.pm.RealField], (multiple) + Additional list of pmesh objects required for electrostatics. + """ + + if config.dtype == np.float64: + pmeshtype = "f8" + else: + pmeshtype = "f4" + # Ignore numpy numpy.VisibleDeprecationWarning: Creating an ndarray from + # ragged nested sequences until it is fixed in pmesh + with warnings.catch_warnings(): + warnings.filterwarnings( + action="ignore", + category=np.VisibleDeprecationWarning, + message=r"Creating an ndarray from ragged nested sequences", + ) + # The first argument of ParticleMesh has to be a tuple + pm = pmesh.ParticleMesh( + config.mesh_size, BoxSize=config.box_size, dtype=pmeshtype, comm=comm + ) + phi = [pm.create("real", value=0.0) for _ in range(config.n_types)] + phi_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] # noqa: E501 + force_on_grid = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + v_ext_fourier = [pm.create("complex", value=0.0) for _ in range(4)] + v_ext = [pm.create("real", value=0.0) for _ in range(config.n_types)] + + phi_transfer = [pm.create("complex", value=0.0) for _ in range(3)] + + phi_laplacian = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + + # Initialize charge density fields + coulomb_list = [] + elec_common_list = [None, None, None, None] + _SPACE_DIM = config.box_size.size + + if config.coulombtype == "PIC_Spectral_GPE" or config.coulombtype == "PIC_Spectral": + phi_q = pm.create("real", value=0.0) + phi_q_fourier = pm.create("complex", value=0.0) + psi = pm.create("real", value=0.0) + elec_field = [pm.create("real", value=0.0) for _ in range(_SPACE_DIM)] + + elec_common_list = [phi_q, phi_q_fourier, psi, elec_field] + + if config.coulombtype == "PIC_Spectral": + elec_field_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] # for force calculation + psi_fourier = pm.create("complex", value=0.0) + + coulomb_list = [ + elec_field_fourier, + psi_fourier, + ] + + if ( + config.coulombtype == "PIC_Spectral_GPE" + ): ## initializing the density mesh #dielectric_flag + phi_eps = pm.create( + "real", value=0.0 + ) ## real contrib of the epsilon dielectric painted to grid + phi_eps_fourier = pm.create("complex", value=0.0) # complex contrib of phi eps + phi_eta = [ + pm.create("real", value=0.0) for _ in range(_SPACE_DIM) + ] ## real contrib of factor in polarization charge density + phi_eta_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] ## fourier of factor in polarization charge density + phi_pol = pm.create( + "real", value=0.0 + ) ## real contrib of the polarization charge + phi_pol_prev = pm.create("real", value=0.0) + elec_dot = pm.create("real", value=0.0) + elec_field_contrib = pm.create( + "real", value=0.0 + ) # needed for pol energies later + + # External potential and force meshes + Vbar_elec = [pm.create("real", value=0.0) for _ in range(config.n_types)] + Vbar_elec_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] + force_mesh_elec = [ + [pm.create("real", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + force_mesh_elec_fourier = [ + [pm.create("complex", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + + coulomb_list = [ + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol, + phi_pol_prev, + elec_dot, + elec_field_contrib, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + ] + + field_list = [ + phi, + phi_fourier, + force_on_grid, + v_ext_fourier, + v_ext, + phi_transfer, + phi_laplacian, + ] + + return (pm, field_list, elec_common_list, coulomb_list)
+ + +
[docs]def compute_field_force(layouts, r, force_mesh, force, types, n_types): + """Interpolate particle-field forces from the grid onto particle positions + + Backmaps the forces calculated on the grid to particle positions using the + window function :math:`P` (by default cloud-in-cell [CIC]). In the + following, let :math:`\\mathbf{F}_j` denote the force acting on the + particle with index :math:`j` and position :math:`\\mathbf{r}_j`. The + interpolated force is + + .. math:: + + \\mathbf{F}_j = -\\sum_k\\nabla V_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`V_{j_k}` is the discretized external potential at grid vertex + :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid vertex + with index :math:`j_k`, and :math:`h^3` is the volume of each grid voxel. + The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + r : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + force : (N,D) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. Local + for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + n_types : int + Number of different unique types present in the simulation system. + :code:`n_types` is global, i.e. the same for all MPI ranks even if some + ranks contain zero particles of certain types. + """ + for t in range(n_types): + ind = types == t + for d in range(3): + force[ind, d] = force_mesh[t][d].readout(r[ind], layout=layouts[t])
+ + +
[docs]def compute_self_energy_q(config, charges, comm=MPI.COMM_WORLD): + """Compute the self energy for the interaction due to the Ewald scheme + used to compute the electrostatics. The energy is stored in :code:`config`. + + The self interaction energy is given by: + + .. math:: + + U_{self} = \\sqrt{\\frac{1}{2\\pi\\sigma^2}} \\sum_{i=1}^{N} q_i^2 + + where :math:`q_i` are the charges and :math:`\\sigma` is the half-width + of the Gaussian filter. + + Parameters + ---------- + config : Config + Configuration object. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + comm : mpi4py.Comm + MPI communicator to use for rank communication. + + Returns + ------- + field_q_self_energy : float + Electrostatic self energy. + """ + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + prefac = elec_conversion_factor * np.sqrt( + 1.0 / (2.0 * np.pi * config.sigma * config.sigma) + ) + _squared_charges = charges * charges + squared_charges_sum = comm.allreduce(np.sum(_squared_charges)) + return prefac * squared_charges_sum
+ + +
[docs]def update_field_force_q( + charges, + phi_q, + phi_q_fourier, + psi, + psi_fourier, + elec_field_fourier, + elec_field, + elec_forces, + layout_q, + hamiltonian, + pm, + positions, + config, +): + """Calculate the electrostatic particle-field forces on the grid + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential is computed in reciprocal space as + + .. math:: + + \\Phi = \\mathrm{FFT}^{-1}\\left[ + \\frac{4\\pi k_e}{\\varepsilon \\vert\\mathbf{k}\\vert^2} + \\mathrm{FFT}(\\rho)\\mathrm{FFT}(H) + \\right], + + with the electric field + + .. math:: + + \\mathbf{E} = \\mathrm{FFT}^{-1}\\left[ + -i\\mathbf{k}\\,\\mathrm{FFT}(\\Psi) + \\right]. + + In the following, let :math:`\\mathbf{F}_j` denote the electrostatic force + acting on the particle with index :math:`j` and position + :math:`\\mathbf{r}_j`. The interpolated electrostatic force is + + .. math:: + + \\mathbf{F}_j = \\sum_k q_j\\mathbf{E}_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`\\mathbf{E}_{j_k}` is the discretized electric field at grid + vertex :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid + vertex with index :math:`j_k`, and :math:`h^3` is the volume of each grid + voxel. The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty; any values in this field + are discarded. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + elec_field_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + electric field values in reciprocal space on the computational grid. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + n_dimensions = config.box_size.size + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + # charges to grid + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) + phi_q /= volume_per_cell + # print("phi_q", np.sum(phi_q)) + phi_q.r2c(out=phi_q_fourier) + + # smear charges with filter + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + + # solve Poisson equation in Fourier space to get electrostatic potential + def poisson_transfer_function(k, v): + return 4.0 * np.pi * elec_conversion_factor * v / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(poisson_transfer_function, out=psi_fourier) + # print("psi_fourier", np.sum(psi_fourier)) + psi_fourier.c2r(out=psi) + # print("phi_q * psi update_field", np.sum(phi_q * psi)) + + # exit() + + # compute electric field directly from smeared charged densities in Fourier + for _d in np.arange(n_dimensions): + + def poisson_transfer_function(k, v, d=_d): + return ( + -1j + * k[d] + * 4.0 + * np.pi + * elec_conversion_factor + * v + / k.normp(p=2, zeromode=1) + ) + + phi_q_fourier.apply(poisson_transfer_function, out=elec_field_fourier[_d]) + elec_field_fourier[_d].c2r(out=elec_field[_d]) + + # get electrostatic force from electric field + for _d in np.arange(n_dimensions): + elec_forces[:, _d] = charges * ( + elec_field[_d].readout(positions, layout=layout_q) + )
+ + +def comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, +): + for t in range(config.n_types): + np.copyto(phi_transfer[0].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[1].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[2].value, phi_fourier[t].value, casting="no", where=True) + + # Evaluate laplacian of phi in fourier space + for d in range(3): + + def laplacian_transfer(k, v, d=d): + return -k[d] ** 2 * v + + phi_transfer[d].apply(laplacian_transfer, out=Ellipsis) + phi_transfer[d].c2r(out=phi_laplacian[t][d]) + + +
[docs]def update_field( + phi, + phi_laplacian, + phi_transfer, + layouts, + force_mesh, + hamiltonian, + pm, + positions, + types, + config, + v_ext, + phi_fourier, + v_ext_fourier, + m, + compute_potential=False, +): + """Calculate the particle-field potential and force density + + If :code:`compute_potential` is :code:`True`, the energy may subsequently + be computed by calling :code:`compute_field_and_kinetic_energy`. + + Computes the particle-field external potential :math:`V_\\text{ext}` from + particle number densities through the smoothed density field, + :math:`\\phi(\\mathbf{r})`. With :math:`P` being the cloud-in-cell (CIC) + window function, the density and filtered densities are computed as + + .. math:: + + \\phi(\\mathbf{r}) = \\sum_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\phi(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\phi(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + external potential is computed in reciprocal space as + + .. math:: + + V_\\text{ext} = \\mathrm{FFT}^{-1}\\left[ + \\mathrm{FFT} + \\left( + \\frac{\\partial w}{\\partial \\tilde\\phi} + \\right) + \\mathrm{FFT}(H) + \\right], + + where :math:`w` is the interaction energy functional. Differentiating + :math:`V_\\text{ext}` is done by simply applying :math:`i\\mathbf{k}` in + Fourier space, and the resulting forces are back-transformed to direct + space and interpolated to particle positions by + + .. math:: + + \\mathbf{F}_j = -\\sum_{j_k} \\nabla V_{j_k} + P(\\mathbf{r}_{j_k} - \\mathbf{r}_j)h^3, + + where :math:`j_k` are the neighbouring vertices of particle :math:`j` at + position :math:`\\mathbf{r}_j`, and :math:`h^3` is the volume of each grid + voxel. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Pre-allocated, but empty; any values + in this field are discarded. Changed in-place. Local for each MPI + rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + config : Config + Configuration object. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Pre-allocated, but empty; any values in this field are + discarded Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + phi_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computational grid is represented by the collective fields of all + MPI ranks. + v_ext_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplesField` objects containing discretized + particle-field external potential values in reciprocal space on the + computational grid; :code:`D+1` fields in D dimensions for each + particle type. :code:`D` copies are made after calculation for later + use in force calculation, because the `force transfer function` + application differentiates the field in-place, ruining the contents + for differentiation in the remaining :code:`D-1` spatial directions. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + m: list[float], (M,) + pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. + Defaults to 1.0 for all particle types. + compute_potential : bool, optional + If :code:`True`, a :code:`D+1`-th copy of the Fourier transformed + external potential field is made to be used later in particle-field + energy calculation. If :code:`False`, only :code:`D` copies are made. + + See also + -------- + compute_field_and_kinetic_energy : + Compute the particle-field energy after the external potential is + calculated. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + for t in range(config.n_types): + pm.paint(positions[types == t], mass=m[t], layout=layouts[t], out=phi[t]) + phi[t] /= volume_per_cell + phi[t].r2c(out=phi_fourier[t]) + phi_fourier[t].apply(hamiltonian.H, out=Ellipsis) + phi_fourier[t].c2r(out=phi[t]) + + # External potential + for t in range(config.n_types): + v = hamiltonian.v_ext[t](phi) + + v.r2c(out=v_ext_fourier[0]) + v_ext_fourier[0].apply(hamiltonian.H, out=Ellipsis) + np.copyto( + v_ext_fourier[1].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + np.copyto( + v_ext_fourier[2].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + if compute_potential: + np.copyto( + v_ext_fourier[3].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + + # Differentiate the external potential in fourier space + for d in range(3): + + def force_transfer_function(k, v, d=d): + return -k[d] * 1j * v + + v_ext_fourier[d].apply(force_transfer_function, out=Ellipsis) + v_ext_fourier[d].c2r(out=force_mesh[t][d]) + + if compute_potential: + v_ext_fourier[3].c2r(out=v_ext[t])
+ + +
[docs]def compute_field_and_kinetic_energy( + phi, + phi_q, + psi, + velocity, + hamiltonian, + positions, + types, + v_ext, + config, + layouts, + comm=MPI.COMM_WORLD, +): + """Compute the particle-field and kinetic energy contributions + + Calculates the kinetic energy through + + .. math:: + + E_k = \\sum_j \\frac{1}{2}m_j\\mathbf{v}_j\\cdot\\mathbf{v}_j, + + and the particle-field energy by + + .. math:: + + E_\\text{field} = \\int\\mathrm{d}\\mathbf{r}\\, + w[\\tilde\\phi], + + where :math:`w` is the interaction energy functional `density`. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + velocity : (N,D) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Local for each MPI rank--the full computational grid is + represented by the collective fields of all MPI ranks. + config : Config + Configuration object. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field : + Computes the up-to-date external potential for use in calculating the + particle-field energy. + """ + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + field_energy = w_0.csum() # w to W + + kinetic_energy = comm.allreduce(0.5 * config.mass * np.sum(velocity**2)) + + if config.coulombtype == "PIC_Spectral": + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + field_q_energy = w_elec.csum() + else: + field_q_energy = 0.0 + + return field_energy, kinetic_energy, field_q_energy
+ + +
[docs]def compute_field_energy_q_GPE( + config, + phi_eps, + field_q_energy, + dot_elec, + comm=MPI.COMM_WORLD, +): + """ + Compute the electrostatic energy after electrosatic forces is + calculated. + + From the definition of the elecrostatic potential :math:`\\Psi`, the energy + is + + W = \\frac{1}{2}\\int\\mathrm{d}\\mathbf{r}\\, + \\epsilon(\\mathbf{r})} \\left(\\mathbf{E}\\cdot \\mathbf{E}\\right), + + where :math:`\\epsilon(\\mathbf{r})}` is the anisotropic, spatially dependent, + relative dielectric of the simulation medium. + + Parameters + ---------- + config : hymd.input_parser.Config + Configuration object. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + field_q_energy : float + Total elecrostatic energy. + dot_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing :math:`|\\mathbf{E(r)}|^{2}` + on the computational grid. Local for each MPI rank -- the full computational + grid is represented by the collective fields of all MPI ranks. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field_force_q_GPE: + Compute the electrosatic force from an anisotropic dielectric general + Poisson equation. + """ + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + # ^ due to integration on local cell before allreduce + + eps_0 = 1.0 / (config.coulomb_constant * 4 * np.pi) + field_q_energy = ( + volume_per_cell * (0.5 * eps_0) * comm.allreduce(np.sum(phi_eps * dot_elec)) + ) + + return field_q_energy
+ + +
[docs]def update_field_force_q_GPE( + conv_fun, + phi, + types, + charges, + phi_q, + phi_q_fourier, + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol_prev, + phi_pol, + elec_field, + elec_forces, + elec_field_contrib, + psi, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + hamiltonian, + layout_q, + layouts, + pm, + positions, + config, + comm=MPI.COMM_WORLD, +): + """ + Calculate the electrostatic particle-field forces on the grid, arising from + a general Poisson equation, i.e. anisotropic permittivity/dielectric. + The function is called when tomli input config.coulombtype = "PIC_Spectral_GPE." + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential for a variable dielectric does not have an + analytical expression, and is computed in reciprocal through an iterative + method. + + The GPE states that + + .. math:: + + \\nabla \\cdot \\left(\\epsilon(\\mathbf{r}) + \\nabla{\\mathbf{\\psi(r)}}\\right) = -\\rho({\\mathbf{r}}). + + where :math:`\\epsilon(\\mathbf{r})` is the relative dielectric function. + + Parameters + ---------- + conv_fun : Convergence function. + Returns a scalar. Depends on MPI allreduce for similar convergence + across MPI ranks. + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_eta : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + gradients of the relative dielectric values on the computational grid. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank--the + full computational grid is represented by the collective fields of all MPI ranks. + phi_eta_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated discretized + Fourier transformed gradient relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol_prev : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charge values on the computational grid. Parameter in + the iterative method.Pre-allocated,but empty. Changedin-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charges on the computational grid. Parameter in the iterative + method, updating the next quess in solving for the electrostatic potential. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all + MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + elec_field_contrib : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing + :math:`|\\mathbf{E(r)}|^2/\\phi_{0}` on the computational grid. + Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + psi : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic potential + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + Vbar_elec : mesh.pm.RealField + Pmesh :code:`RealField` object for storing functional derivatives of + :math:`\\|w(\\{ \\phi \\})_{elec}`on the computational grid. + Pre-allocated, but empty. Changed in-place. Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + Vbar_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated functional + derivatives of :math:`\\|w(\\{ \\phi \\})_{elec}` in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + force_mesh_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic force values + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + force_mesh_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated electrostatic + force values in reciprocal space on the computational grid. Local for + each MPI rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + layouts: list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + comm: mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + compute_field_energy_q_GPE: + Compute the electrostatic energy after electrosatic force is + calculated for a variable (anisotropic) dielectric general Poisson equation. + """ + + ## basic setup + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + ## old protocol in gen_qe_hpf_use_self + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) ## + ## scale and fft + ## old protocol in gen_qe_hpf_use_self + phi_q /= volume_per_cell + phi_q.r2c(out=phi_q_fourier) + + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + ## ^------ use the same gaussian as the \kai interaciton + phi_q_fourier.c2r(out=phi_q) ## this phi_q is after applying the smearing function + + denom_phi_tot = pm.create("real", value=0.0) + num_types = pm.create("real", value=0.0) + ### ^ ----- Calculate the relative dielectric (permittivity) to field + ### ------- from a mean contribution of particle number densities + + for t_ in range(config.n_types): + num_types = num_types + (config.dielectric_type[t_]) * phi[t_] + denom_phi_tot = denom_phi_tot + phi[t_] + + np.divide(num_types, denom_phi_tot, where=np.abs(denom_phi_tot > 1e-6), out=phi_eps) + + phi_eps.r2c(out=phi_eps_fourier) # FFT dielectric + + # phi_q_eps = (phi_q/phi_eps) + np.divide(phi_q, phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_q) + + _SPACE_DIM = 3 + ##^--------- constants needed throughout the calculations + + ### method for finding the gradient (fourier space), using the spatial dimension of k + for _d in np.arange(_SPACE_DIM): + + def gradient_transfer_function(k, x, d=_d): + return 1j * k[d] * x + + phi_eps_fourier.apply(gradient_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=phi_eta[_d]) + np.divide(phi_eta[_d], phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_eta[_d]) + + ### iterative GPE solver ### + ### ---------------------------------------------- + max_iter = 100 + i = 0 + delta = 1.0 + # phi_pol_prev = pm.create("real", value = 0.0) + ### ^------ set to zero before each iterative procedure or soft start + conv_criteria = config.conv_crit # conv. criteria (default 1e-6) + w = config.pol_mixing # polarization mixing param (default 0.6) + while i < max_iter and delta > conv_criteria: + (phi_q + phi_pol_prev).r2c(out=phi_q_fourier) + for _d in np.arange(_SPACE_DIM): + + def iterate_apply_k_vec(k, additive_terms, d=_d): + return additive_terms * (-1j * k[d]) / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(iterate_apply_k_vec, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + + phi_pol = -( + phi_eta[0] * elec_field[0] + + phi_eta[1] * elec_field[1] + + phi_eta[2] * elec_field[2] + ) + ### ^-- Following a negative sign convention (-ik) of the FT, a neg sign is + ### --- mathematically correct by the definition of the GPE (double - -> +) + phi_pol = w * phi_pol + (1.0 - w) * phi_pol_prev + diff = np.abs(phi_pol - phi_pol_prev) + delta = conv_fun(comm, diff) # decided from toml input + phi_pol_prev = phi_pol.copy() + i = i + 1 + # print("Stopping after iteration {:d} with stop crit {:.2e}, delta {:.2e}".format(i,conv_criteria,delta)) + + # compute_potential = True + def k_norm_divide(k, potential): + return potential / k.normp(p=2, zeromode=1) + + ## > Electrostatic potential + eps0_inv = config.coulomb_constant * 4 * np.pi + ## ^ the 1/(4pi eps0)*4*pi = 1/eps0 + ((eps0_inv) * (phi_q + phi_pol)).r2c(out=phi_q_fourier) + phi_q_fourier.apply(k_norm_divide, out=phi_q_fourier) + phi_q_fourier.c2r(out=psi) + ### ^ electrostatic potential for the GPE + + for _d in np.arange(_SPACE_DIM): + + def field_transfer_function(k, x, d=_d): + return ( + -1j * k[d] * x + ) ## negative sign relation, due to E = - nabla psi relation + + phi_q_fourier.apply(field_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + ## ^-------- Method: Obtaining the electric field from electrostatic potential + ## Assuming the electric field is conserved. + ## Assumption holds if no magnetic flux (magnetic induced fields) + + ############## Obtain forces ############## + elec_dot = ( + elec_field[0] * elec_field[0] + + elec_field[1] * elec_field[1] + + elec_field[2] * elec_field[2] + ) + # needed for energy calculations + + np.divide( + elec_dot, + denom_phi_tot, + where=np.abs(denom_phi_tot > 1e-6), + out=elec_field_contrib, + ) + + eps0_inv = config.coulomb_constant * 4 * np.pi + + for t_ in range(config.n_types): + Vbar_elec[t_] = ( + config.type_charges[t_] * psi + - (0.5 / eps0_inv) + * (config.dielectric_type[t_] - phi_eps) + * elec_field_contrib + ) + + # Obtain Vext,k + for t_ in range(config.n_types): + Vbar_elec[t_].r2c(out=Vbar_elec_fourier[t_]) + Vbar_elec_fourier[t_].apply(hamiltonian.H, out=Vbar_elec_fourier[t_]) + + # force terms + # F = - grad Vext + for t_ in range(config.n_types): + for _d in np.arange(_SPACE_DIM): + + def force_transfer_function(k, x, d=_d): + return -1j * k[_d] * x ## negative gradient + + Vbar_elec_fourier[t_].apply( + force_transfer_function, out=force_mesh_elec_fourier[t_][_d] + ) + force_mesh_elec_fourier[t_][_d].c2r(out=force_mesh_elec[t_][_d]) + elec_forces[types == t_, _d] = force_mesh_elec[t_][_d].readout( + positions[types == t_], layout=layouts[t_] + ) + + return Vbar_elec, phi_eps, elec_dot
+ + +
[docs]def domain_decomposition( + positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=MPI.COMM_WORLD +): + """Performs domain decomposition + + Rearranges the MPI rank memory layout into one that better mimics the PFFT + pencil grid 2D decomposition. As molecules are always required to be fully + contained on a single MPI rank, a perfect decomposition is not always + possible. The best decomposition which leaves the center of mass of all + molecules in their respective correct domains is used, with possible + overlap into neighbouring domains if the spatial extent of any molecule + crosses domain boundaries. + + Parameters + ---------- + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + *args + Variable length argument list containing arrays to include in the + domain decomposition. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + bonds : (N,M) numpy.ndarray, optional + Array of :code:`M` bonds originating from each of :code:`N` particles. + verbose : int, optional + Specify the logging event verbosity of this function. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + Domain decomposed :code:`positions` and any array specified in + :code:`*args`, in addition to :code:`bonds` and :code:`molecules` if these + arrays were provided as input. + """ + if molecules is not None: + if not topol: + assert bonds is not None, "bonds must be provided with molecules" + unique_molecules = np.sort(np.unique(molecules)) + molecules_com = np.empty_like(positions) + for m in unique_molecules: + ind = molecules == m + r = positions[ind, :][0, :] + molecules_com[ind, :] = r + layout = pm.decompose(molecules_com, smoothing=0) + if not topol: + args = (*args, bonds, molecules) + else: + args = (*args, molecules) + else: + layout = pm.decompose(positions, smoothing=0) + if verbose > 1: + Logger.rank0.log( + logging.INFO, + "DOMAIN_DECOMP: Total number of particles to be exchanged = %d", + np.sum(layout.get_exchange_cost()), + ) + return layout.exchange(positions, *args)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/_modules/hymd/file_io.html b/v2.0.0/_modules/hymd/file_io.html new file mode 100644 index 00000000..3e913599 --- /dev/null +++ b/v2.0.0/_modules/hymd/file_io.html @@ -0,0 +1,1164 @@ + + + + + + hymd.file_io — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.file_io

+"""Handle file input/output in parllel HDF5 fashion
+"""
+import numpy as np
+import h5py
+import os
+import logging
+import getpass
+from mpi4py import MPI
+from .logger import Logger, get_version
+
+
+
[docs]class OutDataset: + """HDF5 dataset handler for file output""" + + def __init__( + self, + dest_directory, + config, + double_out=False, + disable_mpio=False, + comm=MPI.COMM_WORLD, + ): + """Constructor + + Parameters + ---------- + dest_directory : str + Ouput directory for saving data. + config : Config + Configuration object. + double_out : bool, optional + If :code:`True`, the output HDF5 objects are written in eight byte + floating point representation. Otherwise, four byte single + precision is used. + disable_mpio : bool, optional + If :code:`True`, disables parallel MPI-enabled HDF5 file output. + This is a compatibility option used if HDF5 is not compiled with + MPI support. This makes everything much harder by splitting all + output in one file per MPI rank, and having an MPI-enabled HDF5 + library is **highly recommended**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + """ + self.disable_mpio = disable_mpio + self.config = config + if double_out: + self.float_dtype = "float64" + else: + self.float_dtype = "float32" + + if disable_mpio: + self.file = h5py.File( + os.path.join( + dest_directory, f"sim.hdf5-{comm.rank:6d}-of-{comm.size:6d}" + ), + "w", + ) + else: + self.file = h5py.File( + os.path.join(dest_directory, "sim.H5"), "w", driver="mpio", comm=comm + ) + +
[docs] def is_open(self, comm=MPI.COMM_WORLD): + """Check if HDF5 output file is open + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + return self.file.__bool__()
+ +
[docs] def close_file(self, comm=MPI.COMM_WORLD): + """Closes the HDF5 output file + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + self.file.close()
+ +
[docs] def flush(self): + """Flushes output buffers, forcing file writes""" + self.file.flush()
+ + +
[docs]def setup_time_dependent_element( + name, parent_group, n_frames, shape, dtype, units=None +): + """Helper function for setting up time-dependent HDF5 group datasets + + All output groups must adhere to the H5MD standard, meaning a structure of + + + | ┗━ **group** particle group (e.g. :code:`all`) or :code:`observables` group + | ┗━ **group** time-dependent data + | ┣━ **dataset** :code:`step` :code:`shape=(n_frames,)` + | ┣━ **dataset** :code:`time` :code:`shape=(n_frames,)` + | ┗━ **dataset** :code:`value` :code:`shape=(n_frames, *)` + + is necessary. + + References + ---------- + H5MD specification : + https://www.nongnu.org/h5md/h5md.html + """ # noqa: E501 + group = parent_group.create_group(name) + step = group.create_dataset("step", (n_frames,), "int32") + time = group.create_dataset("time", (n_frames,), "float32") + value = group.create_dataset("value", (n_frames, *shape), dtype) + + if units is not None: + value.attrs["unit"] = units + time.attrs["unit"] = "ps" + return group, step, time, value
+ + +
[docs]def store_static( + h5md, + rank_range, + names, + types, + indices, + config, + bonds_2_atom1, + bonds_2_atom2, + molecules=None, + velocity_out=False, + force_out=False, + charges=False, + dielectrics=False, + plumed_out=False, + comm=MPI.COMM_WORLD, +): + """Outputs all static time-independent quantities to the HDF5 output file + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + rank_range : list[int] + Start and end indices for global arrays for each MPI rank. + names : (N,) numpy.ndarray + Array of names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of type indices for :code:`N` particles. + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + config : Config + Configuration object. + bonds_2_atom1 : (B,) numpy.ndarray + Array of indices of the first particle for :code:`B` total + two-particle bonds. + bonds_2_atom2 : (B,) numpy.ndarray + Array of indices of the second particle for :code:`B` total + two-particle bonds. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. + dielectrics : (N,) numpy.ndarray + Array of particle relative dielectric values for :code:`N` particles. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to output HDF5 file. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + prepare_bonds : + Constructs two-, three-, and four-particle bonds from toplogy input + file and bond configuration information. + distribute_input : + Distributes input arrays onto MPI ranks, attempting load balancing. + """ + dtype = h5md.float_dtype + + h5md_group = h5md.file.create_group("/h5md") + h5md.h5md_group = h5md_group + h5md.observables = h5md.file.create_group("/observables") + h5md.connectivity = h5md.file.create_group("/connectivity") + h5md.parameters = h5md.file.create_group("/parameters") + + h5md_group.attrs["version"] = np.array([1, 1], dtype=int) + author_group = h5md_group.create_group("author") + author_group.attrs["name"] = np.string_(getpass.getuser()) + creator_group = h5md_group.create_group("creator") + creator_group.attrs["name"] = np.string_("Hylleraas MD") + + # Get HyMD version + creator_group.attrs["version"] = np.string_(get_version()) + + h5md.particles_group = h5md.file.create_group("/particles") + h5md.all_particles = h5md.particles_group.create_group("all") + mass = h5md.all_particles.create_dataset("mass", (config.n_particles,), dtype) + mass[...] = config.mass + + if charges is not False: + charge = h5md.all_particles.create_dataset( + "charge", (config.n_particles,), dtype="float32" + ) + charge[indices] = charges + if dielectrics is not False: + dielectric = h5md.all_particles.create_dataset( + "dielectric", (config.n_particles,), dtype="float32" + ) + dielectric[indices] = dielectrics + + box = h5md.all_particles.create_group("box") + box.attrs["dimension"] = 3 + box.attrs["boundary"] = np.array( + [np.string_(s) for s in 3 * ["periodic"]], dtype="S8" + ) + + n_frames = config.n_steps // config.n_print + if np.mod(config.n_steps - 1, config.n_print) != 0: + n_frames += 1 + if np.mod(config.n_steps, config.n_print) == 1: + n_frames += 1 + if n_frames == config.n_steps: + n_frames += 1 + + species = h5md.all_particles.create_dataset( + "species", + (config.n_particles,), + dtype="i", + ) + + ( + _, + h5md.positions_step, + h5md.positions_time, + h5md.positions, + ) = setup_time_dependent_element( + "position", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm", + ) + if velocity_out: + ( + _, + h5md.velocities_step, + h5md.velocities_time, + h5md.velocities, + ) = setup_time_dependent_element( + "velocity", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm ps-1", + ) + if force_out: + ( + _, + h5md.forces_step, + h5md.forces_time, + h5md.forces, + ) = setup_time_dependent_element( + "force", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="kJ mol-1 nm-1", + ) + ( + _, + h5md.total_energy_step, + h5md.total_energy_time, + h5md.total_energy, + ) = setup_time_dependent_element( + "total_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.kinetc_energy_step, + h5md.kinetc_energy_time, + h5md.kinetc_energy, + ) = setup_time_dependent_element( + "kinetic_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.potential_energy_step, + h5md.potential_energy_time, + h5md.potential_energy, + ) = setup_time_dependent_element( + "potential_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.bond_energy_step, + h5md.bond_energy_time, + h5md.bond_energy, + ) = setup_time_dependent_element( + "bond_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.angle_energy_step, + h5md.angle_energy_time, + h5md.angle_energy, + ) = setup_time_dependent_element( + "angle_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.dihedral_energy_step, + h5md.dihedral_energy_time, + h5md.dihedral_energy, + ) = setup_time_dependent_element( + "dihedral_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.field_energy_step, + h5md.field_energy_time, + h5md.field_energy, + ) = setup_time_dependent_element( + "field_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + if charges is not False: + ( + _, + h5md.field_q_energy_step, + h5md.field_q_energy_time, + h5md.field_q_energy, + ) = setup_time_dependent_element( + "field_q_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) # <-------- xinmeng + if plumed_out is not False: + ( + _, + h5md.plumed_bias_step, + h5md.plumed_bias_time, + h5md.plumed_bias, + ) = setup_time_dependent_element( + "plumed_bias", h5md.observables, n_frames, (1,), dtype, units="kJ mol-1" # noqa: E501 + ) + ( + _, + h5md.total_momentum_step, + h5md.total_momentum_time, + h5md.total_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "total_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm g ps-1 mol-1", + ) + ( + _, + h5md.angular_momentum_step, + h5md.angular_momentum_time, + h5md.angular_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "angular_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm+2 g ps-1 mol-1", + ) + ( + _, + h5md.torque_step, + h5md.torque_time, + h5md.torque, + ) = setup_time_dependent_element( # noqa: E501 + "torque", + h5md.observables, + n_frames, + (3,), + dtype, + units="kJ nm+2 mol-1", + ) + ( + _, + h5md.temperature_step, + h5md.temperature_time, + h5md.temperature, + ) = setup_time_dependent_element( + "temperature", h5md.observables, n_frames, (3,), dtype, units="K" + ) + ( + _, + h5md.thermostat_work_step, + h5md.thermostat_work_time, + h5md.thermostat_work, + ) = setup_time_dependent_element( + "thermostat_work", + h5md.observables, + n_frames, + (1,), + "float32", + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.pressure_step, + h5md.pressure_time, + h5md.pressure, + ) = setup_time_dependent_element( + "pressure", h5md.observables, n_frames, (18,), "float32", units="Bar" + ) + (_, h5md.box_step, h5md.box_time, h5md.box_value,) = setup_time_dependent_element( + "edges", box, n_frames, (3, 3), "float32", units="nm" + ) + + ind_sort = np.argsort(indices) + for i in ind_sort: + species[indices[i]] = config.name_to_type_map[names[i].decode("utf-8")] + + h5md.parameters.attrs["config.toml"] = np.string_(str(config)) + vmd_group = h5md.parameters.create_group("vmd_structure") + index_of_species = vmd_group.create_dataset( + "indexOfSpecies", (config.n_types,), "i" + ) + index_of_species[:] = np.array(list(range(config.n_types))) + + # VMD-h5mdplugin maximum name/type name length is 16 characters (for + # whatever reason [VMD internals?]). + name_dataset = vmd_group.create_dataset("name", (config.n_types,), "S16") + type_dataset = vmd_group.create_dataset("type", (config.n_types,), "S16") + if molecules is not None: + resid_dataset = vmd_group.create_dataset( + "resid", + (config.n_particles,), + "i", + ) + + # Change this + for i, n in config.type_to_name_map.items(): + name_dataset[i] = np.string_(n[:16]) + if n == "W": + type_dataset[i] = np.string_("solvent") + else: + type_dataset[i] = np.string_("membrane") + + total_bonds = comm.allreduce(len(bonds_2_atom1), MPI.SUM) + n_bonds_local = len(bonds_2_atom1) + + receive_buffer = comm.gather(n_bonds_local, root=0) + n_bonds_global = None + if comm.Get_rank() == 0: + n_bonds_global = receive_buffer + n_bonds_global = np.array(comm.bcast(n_bonds_global, root=0)) + rank_bond_start = np.sum(n_bonds_global[: comm.Get_rank()]) + + bonds_from = vmd_group.create_dataset("bond_from", (total_bonds,), "i") + bonds_to = vmd_group.create_dataset("bond_to", (total_bonds,), "i") + for i in range(n_bonds_local): + a = bonds_2_atom1[i] + b = bonds_2_atom2[i] + bonds_from[rank_bond_start + i] = indices[a] + 1 + bonds_to[rank_bond_start + i] = indices[b] + 1 + + if molecules is not None: + resid_dataset[indices[ind_sort]] = molecules
+ + +# store data old vs +""" +h5md, step, frame, indices, positions, velocities, forces, box_size, +temperature, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, +field_energy, field_q_energy, time_step, config, velocity_out=False, +force_out=False, charge_out=False, dump_per_particle=False, +""" + + +
[docs]def store_data( + h5md, + step, + frame, + indices, + positions, + velocities, + forces, + box_size, + temperature, + pressure, + kinetic_energy, + bond2_energy, + bond3_energy, + bond4_energy, + field_energy, + field_q_energy, + plumed_bias, + time_step, + config, + velocity_out=False, + force_out=False, + charge_out=False, + plumed_out=False, + dump_per_particle=False, + comm=MPI.COMM_WORLD, +): + """Writes time-step data to HDF5 output file + + Handles all quantities which change during simulation, as opposed to + static quanitities (see :code:`store_static`). + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + step : int + Step number. + frame : int + Output frame number (:code:`step // n_print`). + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + positions : (N,) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + velocities : (N,) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + forces : (N,) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. + box_size : (D,) numpy.ndarray + Array containing the simulation box size. + temperature : float + Calculated instantaneous temperature. + kinetic_energy : float + Calculated instantaneous kinetic energy. + bond2_energy : float + Calculated instantaneous harmonic two-particle bond energy. + bond3_energy : float + Calculated instantaneous harmonic angular three-particle bond energy. + bond4_energy : float + Calculated instantaneous dihedral four-particle torsion energy. + field_energy : float + Calculated instantaneous particle-field energy. + field_q_energy : float + Calculated instantaneous electrostatic energy. + plumed_bias : float + PLUMED instantaneous bias energy. + time_step : float + Value of the time step. + config : Config + Configuration object. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charge_out : bool, optional + If :code:`True`, electrostatic energies are written to the output + HDF5 file. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to the output HDF5 file. + dump_per_particle : bool, optional + If :code:`True`, all quantities are written **per particle**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + store_static : + Outputs all static time-independent quantities to the HDF5 output file + """ + for dset in ( + h5md.positions_step, + h5md.total_energy_step, + h5md.potential_energy_step, + h5md.kinetc_energy_step, + h5md.bond_energy_step, + h5md.angle_energy_step, + h5md.dihedral_energy_step, + h5md.field_energy_step, + h5md.total_momentum_step, + h5md.angular_momentum_step, + h5md.torque_step, + h5md.temperature_step, + h5md.pressure_step, + h5md.box_step, + h5md.thermostat_work_step, + ): + dset[frame] = step + + for dset in ( + h5md.positions_time, + h5md.total_energy_time, + h5md.potential_energy_time, + h5md.kinetc_energy_time, + h5md.bond_energy_time, + h5md.angle_energy_time, + h5md.dihedral_energy_time, + h5md.field_energy_time, + h5md.total_momentum_time, + h5md.angular_momentum_time, + h5md.torque_time, + h5md.temperature_time, + h5md.pressure_time, + h5md.box_time, + h5md.thermostat_work_time, + ): + dset[frame] = step * time_step + + if velocity_out: + h5md.velocities_step[frame] = step + h5md.velocities_time[frame] = step * time_step + if force_out: + h5md.forces_step[frame] = step + h5md.forces_time[frame] = step * time_step + if charge_out: + h5md.field_q_energy_step[frame] = step + h5md.field_q_energy_time[frame] = step * time_step + if plumed_out: + h5md.plumed_bias_step[frame] = step + h5md.plumed_bias_time[frame] = step * time_step + + ind_sort = np.argsort(indices) + h5md.positions[frame, indices[ind_sort]] = positions[ind_sort] + + if velocity_out: + h5md.velocities[frame, indices[ind_sort]] = velocities[ind_sort] + if force_out: + h5md.forces[frame, indices[ind_sort]] = forces[ind_sort] + if charge_out: + h5md.field_q_energy[frame] = field_q_energy + if plumed_out: + h5md.plumed_bias[frame] = plumed_bias + + potential_energy = ( + bond2_energy + bond3_energy + bond4_energy + field_energy + field_q_energy + ) + + total_momentum = config.mass * comm.allreduce(np.sum(velocities, axis=0), MPI.SUM) + angular_momentum = config.mass * comm.allreduce( + np.sum(np.cross(positions, velocities), axis=0), MPI.SUM + ) + torque = config.mass * comm.allreduce( + np.sum(np.cross(positions, forces), axis=0), MPI.SUM + ) + h5md.total_energy[frame] = kinetic_energy + potential_energy + h5md.potential_energy[frame] = potential_energy + h5md.kinetc_energy[frame] = kinetic_energy + h5md.bond_energy[frame] = bond2_energy + h5md.angle_energy[frame] = bond3_energy + h5md.dihedral_energy[frame] = bond4_energy + h5md.field_energy[frame] = field_energy + h5md.total_momentum[frame, :] = total_momentum + h5md.angular_momentum[frame, :] = angular_momentum + h5md.torque[frame, :] = torque + h5md.temperature[frame] = temperature + h5md.pressure[frame] = pressure + for d in range(3): + h5md.box_value[frame, d, d] = box_size[d] + h5md.thermostat_work[frame] = config.thermostat_work + + fmt_ = [ + "step", + "time", + "temp", + "tot E", + "kin E", + "pot E", + "field E", + "elec E", + "bond E", + "ang E", + "dih E", + "bias E", + "Px", + "Py", + "Pz", + "ΔH" if config.target_temperature else "ΔE", + ] + fmt_ = np.array(fmt_) + + # create mask to show only energies != 0 + en_array = np.array([ + field_energy, + field_q_energy, + bond2_energy, + bond3_energy, + bond4_energy, + plumed_bias, + ]) + mask = np.full_like(fmt_, True, dtype=bool) + mask[range(6,12)] = en_array != 0. + + header_ = fmt_[mask].shape[0] * "{:>13}" + if config.initial_energy is None: + fmt_[-1] = "" + + divide_by = 1.0 + if dump_per_particle: + for i in range(3, 9): + fmt_[i] = fmt_[i][:-2] + "E/N" + fmt_[-1] += "/N" + divide_by = config.n_particles + total_energy = kinetic_energy + potential_energy + if config.initial_energy is not None: + if config.target_temperature: + H_tilde = total_energy - config.initial_energy - config.thermostat_work + else: + H_tilde = total_energy - config.initial_energy + else: + H_tilde = 0.0 + + header = header_.format(*fmt_[mask]) + data_fmt = f'{"{:13}"}{(fmt_[mask].shape[0]-1) * "{:13.5g}" }' + all_data = [ + step, + time_step * step, + temperature, + total_energy / divide_by, + kinetic_energy / divide_by, + potential_energy / divide_by, + field_energy / divide_by, + field_q_energy / divide_by, + bond2_energy / divide_by, + bond3_energy / divide_by, + bond4_energy / divide_by, + plumed_bias / divide_by, + total_momentum[0] / divide_by, + total_momentum[1] / divide_by, + total_momentum[2] / divide_by, + H_tilde / divide_by, + ] + data = data_fmt.format(*[val for i, val in enumerate(all_data) if mask[i]]) + Logger.rank0.log(logging.INFO, ("\n" + header + "\n" + data))
+ + +
[docs]def distribute_input( + in_file, rank, size, n_particles, max_molecule_size=201, comm=MPI.COMM_WORLD +): + """Assign global arrays onto MPI ranks, attempting load balancing + + Distributes approximately equal numbers of particles (workload) onto each + independent MPI rank, while respecting the requirement that any molecule + must be fully contained on a single MPI rank only (no splitting molecules + across multiple CPUs). + + Parameters + ---------- + in_file : h5py.File + HDF5 input file object. + rank : int + Local rank number for this MPI rank. + size : int + Global size of the MPI communicator (number of total CPUs). + n_particles : int + Total number of particles. + max_molecule_size : int, optional + Maximum size of any molecule present in the system. Used to initially + guess where the MPI rank boundaries (start/end indices) in the global + arrays should be placed. If molecules of size + :code:`>max_molecule_size` exist in the simulation system, HyMD + **might** work as expected. Or it might fail spectacularly. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + rank_range : + Starting and ending indices in the global arrays for each MPI rank. + """ + if n_particles is None: + n_particles = len(in_file["indices"]) + np_per_MPI = n_particles // size + + molecules_flag = False + if "molecules" in in_file: + molecules_flag = True + + if not molecules_flag: + if rank == size - 1: + np_cum_mpi = [rank * np_per_MPI, n_particles] + else: + np_cum_mpi = [rank * np_per_MPI, (rank + 1) * np_per_MPI] + p_mpi_range = list(range(np_cum_mpi[0], np_cum_mpi[1])) + return p_mpi_range, molecules_flag + + # To avoid splitting molecules across multiple different ranks, we need + # to read in some extra indices before/after the expected break points + # and iterate until we find a molecule break. + # + # Implicitly assuming no molecule is bigger than + # min(max_molecule_size, n_particles // n_MPI_ranks) atoms. + max_molecule_size += 2 + grab_extra = max_molecule_size if np_per_MPI > max_molecule_size else np_per_MPI + if rank == 0: + mpi_range_start = 0 + if size == 1: + mpi_range_end = n_particles + else: + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + elif rank == size - 1: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = n_particles + else: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + + molecules = in_file["molecules"][mpi_range_start:mpi_range_end] + indices = in_file["indices"][mpi_range_start:mpi_range_end] + molecule_end_indices = np.nonzero(np.diff(molecules))[0] + + p_mpi_range = [None, None] + if rank == 0: + p_mpi_range[0] = 0 + if size == 1: + p_mpi_range[1] = n_particles + else: + p_mpi_range[1] = indices[ + molecule_end_indices[molecule_end_indices >= np_per_MPI][0] + 1 + ] + elif rank == size - 1: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = n_particles + else: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = ( + indices[molecule_end_indices[molecule_end_indices > np_per_MPI][0]] + + 1 # noqa: E501 + ) + return list(range(p_mpi_range[0], p_mpi_range[1])), molecules_flag
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/_modules/hymd/force.html b/v2.0.0/_modules/hymd/force.html new file mode 100644 index 00000000..4916ff59 --- /dev/null +++ b/v2.0.0/_modules/hymd/force.html @@ -0,0 +1,1167 @@ + + + + + + hymd.force — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.force

+"""Calculates intramolecular forces between bonded particles in molecules
+"""
+import numpy as np
+import networkx as nx
+from dataclasses import dataclass
+
+# Imported here so we can call from force import compute_bond_forces__fortran
+from force_kernels import cbf as compute_bond_forces__fortran  # noqa: F401
+from force_kernels import (  # noqa: F401
+    caf as compute_angle_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cdf as compute_dihedral_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cbf_d as compute_bond_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    caf_d as compute_angle_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    cdf_d as compute_dihedral_forces__fortran__double,
+)
+
+
+
[docs]@dataclass # might not be needed +class Dielectric_type: + atom_1: str + dielectric_value: float
+ + +
[docs]@dataclass +class Bond: + """Dataclass representing a single two-particle bond type + + A `bond type` is a bond strength and equilibrium distance associated with + any bond between particles of specific types :code:`A` and :code:`B` + (where :code:`A` and :code:`B` may be the same or different). Harmonic + two-particle bonds in HyMD take the form + + .. math:: + + V_2(\\mathbf{r}_1, \\mathbf{r}_2) = + \\frac{1}{2}k + \\left( + \\vert \\mathbf{r}_1 - \\mathbf{r}_2 \\vert - r_0 + \\right)^2, + + where :math:`k` is the bond strength (spring constant) and :math:`r_0` is + the equilibrium bond length (at which the energy is zero). + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + equilibrium : float + Equilibrium distance at which the energy associated with the bond + vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient (spring constant). + """ + + atom_1: str + atom_2: str + equilibrium: float + strength: float
+ + +
[docs]@dataclass +class Angle(Bond): + """Dataclass representing a single three-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any three-particle bond between particles of specific types :code:`A`, + :code:`B`, and :code:`C` (where :code:`A`, :code:`B`, and :code:`C` may be + different or the same). Harmonic angular three-particle bonds in HyMD take + the form + + .. math:: + + V_3(\\mathbf{r}_1, \\mathbf{r}_2, \\mathbf{r}_3) = + \\frac{1}{2}k + \\left( + \\cos^{-1} + \\left[ + \\frac{ + (\\mathbf{r}_1-\\mathbf{r}_2) + \\cdot + (\\mathbf{r}_3-\\mathbf{r}_2) + } + { + \\vert\\mathbf{r}_1-\\mathbf{r}_2\\vert + \\vert\\mathbf{r}_3-\\mathbf{r}_2\\vert + } + \\right] - \\theta_0 + \\right)^2 + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + equilibrium : float + Equilibrium angle at which the energy associated with the + three-particle angular bond vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient. + + See also + -------- + Bond : + Two-particle bond type dataclass + """ + + atom_3: str
+ + +
[docs]@dataclass +class Dihedral: + """Dataclass representing a single four-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any four-particle torsional bond between particles of specific types + :code:`A`, :code:`B`, :code:`C`, and :code:`D` (where :code:`A`, :code:`B`, + :code:`C`, and :code:`D` may be different or the same). Dihedral + four-particle bonds in HyMD take different forms depending on the + :code:`dih_type` parameter. + + In the following, let :math:`\\phi` denote the angle between the planes + spanned by the relative positions of atoms :code:`A`-:code:`B`-:code:`C` + and :code:`B`-:code:`C`-:code:`D`. If :code:`dih_type = 0`, then + + .. math:: + + V_4(\\phi) = \\sum_n c_n + \\left( + 1 + \\cos\\left[ + n\\phi - d_n + \\right] + \\right), + + where :math:`c_n` are energy coefficients and :math:`d_n` are propensity + phases. By default, the cosine sum is truncated at five terms. If + :code:`coeffs` provides only a single float, this is used as the coiling + propensity parameter :math:`\\lambda`. In this case, :math:`c_n` and + :math:`d_n` are automatically set to values which promote alpha helical + (:math:`\\lambda=-1`), beta sheet (:math:`\\lambda=1`), or a mixed + (:math:`1>\\lambda>-1`) structure (using values provided by Bore et al. + (2018)). In this case, the full potential takes the form + + .. math:: + + V_4(\\phi;\\lambda) = + \\frac{1}{2}(1-\\lambda) V_{\\text{prop},\\alpha}(\\phi) + + + \\frac{1}{2}(1+\\lambda) V_{\\text{prop},\\beta}(\\phi) + + + (1-\\vert\\lambda\\vert) V_{\\text{prop}, \\text{coil}}(\\phi), + + with each of the :math:`V_{\\mathrm{prop}, X}` being fixed cosine series + potentials with pre-set :math:`c_n` -s and :math:`d_n` -s. + + If :code:`dih_type = 1`, then a combined bending torsional (CBT) potential + is employed, + + .. math:: + + V_4(\\phi,\\gamma;\\lambda) = + V_4(\\phi;\\lambda) + + + \\frac{1}{2}K(\\phi)(\\gamma - \\gamma_0)^2, + + where :math:`V_4(\\phi;\\lambda)` specifies the potential as given by the + coiling propensity parameter above, :math:`K(\\phi)` is a separate cosine + series potential acting as the angular three-particle bond strength, and + :math:`\\gamma_0` is the three-particle bond equilibrium angle. In this + case, the :code:`coeffs` parameter must specify *both* a :math:`\\lambda` + value, in additon to the energy and phases dictating the :math:`K(\\phi)` + potential. + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + atom_4 : str + Type name of particle 4. + coeffs : list[list[float]] or list[float] or numpy.ndarray + Dihedral coefficients defining the series expansion of the dihedral + energy. + dih_type : int + Specifies the type of dihedral used; If :code:`0`, then :code:`coeffs` + must contain **either** two lists of five energy coefficients + :math:`c_n` and five propensity phases :math:`d_n` **or** a single + floating point number defining the :math:`\\lambda` coiling propensity + parameter. If :code:`1`, the combined bending-torsional potential is + used, and :code:`coeffs` must specify :math:`\\lambda` *and* two lists + containing energy coefficients and propensity phases for the + :math:`V_\\text{prop}` propensity potential, defined in terms of cosine + series. + + References + ---------- + Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018. + """ + + atom_1: str + atom_2: str + atom_3: str + atom_4: str + coeffs: np.ndarray + dih_type: int
+ + +
[docs]@dataclass +class Chi: + """Dataclass representing a single :math:`\\chi` mixing interaction type + + An `interaction mixing energy type` is a mixing energy associated with + density overlap between species of types :code:`A` and :code:`B` + (specified as inputs :code:`atom_1` and :code:`atom_2`). A positive mixing + energy promotes phase separation, a negative mixing energy promotes mixing. + The interaction energy density (provided the :code:`DefaultWithChi` + Hamiltonian is used) takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} + \\sum_{k,l}\\chi_{k,l} \\tilde\\phi_k\\tilde\\phi_l, + + where :math:`\\chi_{k,l}` denotes the mixing energy between species + :math:`k` and :math:`l`, with :math:`\\kappa` being the incompressibility. + The value of the interaction mixing energy parameter may be extracted from + `Flory-Huggins theory`_. + + .. _`Flory-Huggins theory`: + https://en.wikipedia.org/wiki/Flory%E2%80%93Huggins_solution_theory + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + interaction_energy : float + Interaction mixing energy. + + See also + -------- + hymd.hamiltonian.DefaultWithChi : + Interaction energy functional using :math:`\\chi`-interactions. + """ + + atom_1: str + atom_2: str + interaction_energy: float
+ + +
[docs]def find_all_paths(G, u, n): + """Helper function that recursively finds all paths of given lenght 'n + 1' inside a network 'G'. + Adapted from https://stackoverflow.com/a/28103735.""" + if n == 0: + return [[u]] + paths = [] + for neighbor in G.neighbors(u): + for path in find_all_paths(G, neighbor, n - 1): + if u not in path: + paths.append([u] + path) + return paths
+ + +
[docs]def propensity_potential_coeffs(x: float): + alpha_coeffs = np.array( + [ + [7.406, -5.298, -2.570, 1.336, 0.739], + [-0.28632126, 1.2099146, 1.18122138, 0.49075168, 0.98495911], + ] + ) + beta_coeffs = np.array( + [ + [3.770, 5.929, -4.151, -0.846, 0.190], + [-0.2300693, -0.0583289, 0.99342396, 1.03237971, 2.90160988], + ] + ) + coil_coeffs = np.array( + [ + [1.416, -0.739, 0.990, -0.397, 0.136], + [1.3495933, 0.45649087, 2.30441057, -0.12274901, -0.26179939], + ] + ) + + zero_add = np.zeros((2, 5)) + if np.isclose(x, -1): + return np.concatenate((alpha_coeffs, zero_add)) + elif np.isclose(x, 0): + return np.concatenate((coil_coeffs, zero_add)) + elif np.isclose(x, 1): + return np.concatenate((beta_coeffs, zero_add)) + + abs_x = np.abs(x) + if abs_x > 1: + err_str = ( + f"The provided value of lambda = {x} is out of lambda definition range, " + f"[-1.0, 1.0]." + ) + Logger.rank0.log(logging.ERROR, err_str) + else: + coil_coeffs[0] *= 1 - abs_x + if x < 0: + alpha_coeffs[0] *= 0.5 * (abs_x - x) + return np.concatenate((alpha_coeffs, coil_coeffs)) + else: + beta_coeffs[0] *= 0.5 * (abs_x + x) + return np.concatenate((beta_coeffs, coil_coeffs))
+ + +
[docs]def prepare_bonds_old(molecules, names, bonds, indices, config): + """Find bonded interactions from connectivity and bond types information + + .. deprecated:: 1.0.0 + :code:`prepare_bonds_old` was replaced by :code:`prepare_bonds` for + use with compiled Fortran kernels prior to 1.0.0 release. + + Prepares the necessary equilibrium and bond strength information needed by + the intramolecular interaction functions. This is performed locally on each + MPI rank, as the domain decomposition ensures that for all molecules *all* + consituent particles are always contained on *the same* MPI rankself. + + This function traverses the bond connectivity information provided in the + structure/topology input file and indentifies any two-, three-, or + four-particle potential bonds. For each connected chain of two, three, or + four particles, a matching to bond types is attempted. If the corresponding + names match, a bond object is initialized. + + In order to investigate the connectivity, a graph is created using + networkx functionality. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2 : list + List of lists containing *local* particle indices, equilibrium + distance, and bond strength coefficient for each reconstructed + two-particle bond. + bonds_3 : + List of lists containing *local* particle indices, equilibrium angle, + and bond strength coefficient for each reconstructed three-particle + bond. + bonds_4 : + List of lists containing *local* particle indices, dihedral type index, + and dihedral coefficients for each reconstructed four-particle + torsional bond. + bb_index : list + List indicating the dihedral type of each four-particle bond in + :code:`bonds_4`. + + See also + -------- + Bond : + Two-particle bond type dataclass. + Angle : + Three-particle angular bond type dataclass. + Dihedral : + Four-particle torsional bond type dataclass. + hymd.input_parser.Config + Configuration dataclass handler. + """ + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + bb_index = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + bb_dihedral = 0 + bond_graph = nx.Graph() + + for local_index, global_index in enumerate(indices): + if molecules[local_index] != mol: + continue + + bond_graph.add_node( + global_index, + name=names[local_index].decode("UTF-8"), + local_index=local_index, + ) + for bond in [b for b in bonds[local_index] if b != -1]: + bond_graph.add_edge(global_index, bond) + + connectivity = nx.all_pairs_shortest_path(bond_graph) + for c in connectivity: + i = c[0] + connected = c[1] + for j, path in connected.items(): + if len(path) == 2 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for b in config.bonds: + match_forward = name_i == b.atom_1 and name_j == b.atom_2 + match_backward = name_i == b.atom_2 and name_j == b.atom_1 + if match_forward or match_backward: + bonds_2.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[j]["local_index"], + b.equilibrium, + b.strength, + ] + ) + + if len(path) == 3 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_mid = bond_graph.nodes()[path[1]]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for a in config.angle_bonds: + match_forward = ( + name_i == a.atom_1 + and name_mid == a.atom_2 + and name_j == a.atom_3 + ) + match_backward = ( + name_i == a.atom_3 + and name_mid == a.atom_2 + and name_j == a.atom_1 + ) + if match_forward or match_backward: + bonds_3.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[path[1]]["local_index"], + bond_graph.nodes()[j]["local_index"], + np.radians(a.equilibrium), + a.strength, + ] + ) + + all_paths_len_four = find_all_paths(bond_graph, i, 3) + for p in all_paths_len_four: + name_i = bond_graph.nodes()[i]["name"] + name_mid_1 = bond_graph.nodes()[p[1]]["name"] + name_mid_2 = bond_graph.nodes()[p[2]]["name"] + name_j = bond_graph.nodes()[p[3]]["name"] + + for a in config.dihedrals: + match_forward = ( + name_i == a.atom_1 + and name_mid_1 == a.atom_2 + and name_mid_2 == a.atom_3 + and name_j == a.atom_4 + ) + if ( + match_forward + and [ + bond_graph.nodes()[p[3]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[i]["local_index"], + a.coeffs, + a.dih_type, + ] + not in bonds_4 + ): + bonds_4.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[3]]["local_index"], + a.coeffs, + a.dih_type, + ] + ) + if a.dih_type == 1: + bb_dihedral = len(bonds_4) + + if bb_dihedral: + bb_index.append(bb_dihedral - 1) + + return bonds_2, bonds_3, bonds_4, bb_index
+ + +
[docs]def prepare_index_based_bonds(molecules, topol): + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + resid = mol + 1 + top_summary = topol["system"]["molecules"] + resname = None + test_mol_number = 0 + for molname in top_summary: + test_mol_number += molname[1] + if resid <= test_mol_number: + resname = molname[0] + break + + if resname is None: + break + + if "bonds" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for bond in topol[resname]["bonds"]: + index_i = bond[0] - 1 + first_id + index_j = bond[1] - 1 + first_id + # bond[2] is the bond type, inherited by the itp format. Not used + equilibrium = bond[3] + strength = bond[4] + bonds_2.append([index_i, index_j, equilibrium, strength]) + + if "angles" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["angles"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + # angle[3] is the angle type, inherited by the itp format. Not used + equilibrium = np.radians(angle[4]) + strength = angle[5] + bonds_3.append([index_i, index_j, index_k, equilibrium, strength]) + + if "dihedrals" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["dihedrals"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + index_l = angle[3] - 1 + first_id + dih_type = angle[4] + coeff = angle[5] + if dih_type == 0 and isinstance(coeff[0], (float, int)): + coeff = propensity_potential_coeffs(coeff[0]) + elif dih_type == 1 and len(coeff) == 3: + coeff = np.array( + propensity_potential_coeffs(coeff[0][0]).tolist() + + coeff[1:] + ) + elif dih_type == 2: + coeff = np.array(coeff) + else: + coeff = np.insert(np.array(coeff), 2, np.zeros((2, 5)), axis=0) + bonds_4.append([index_i, index_j, index_k, index_l, coeff, dih_type, 0]) + return bonds_2, bonds_3, bonds_4
+ + +
[docs]def prepare_bonds(molecules, names, bonds, indices, config, topol=None): + """Rearrange the bond information for usage in compiled Fortran kernels + + Restructures the lists resulting from the execution of + :code:`prepare_bonds_old` into numpy arrays suitable for calls to optimized + Fortran code calculating bonded forces and energiesself. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2_atom_1 : (B,) numpy.ndarray + Local index of particle 1 for each of :code:`B` constructed + two-particle bonds. + bonds_2_atom_2 : (B,) numpy.ndarray + Local index of particle 2 for each of :code:`B` constructed + two-particle bonds. + bonds_2_equilibrium : (B,) numpy.ndarray + Equilibrium distance for each of :code:`B` constructed two-particle + bonds. + bonds_2_strength : (B,) numpy.ndarray + Bond strength for each of :code:`B` constructed two-particle + bonds. + bonds_3_atom_1 : (A,) numpy.ndarray + Local index of particle 1 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_2 : (A,) numpy.ndarray + Local index of particle 2 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_3 : (A,) numpy.ndarray + Local index of particle 3 for each of :code:`A` constructed + three-particle bonds. + bonds_3_equilibrium : (A,) numpy.ndarray + Equilibrium angle for each of :code:`A` constructed three-particle + bonds. + bonds_3_strength : (A,) numpy.ndarray + Bond strength for each of :code:`A` constructed three-particle + bonds. + bonds_4_atom_1 : (D,) numpy.ndarray + Local index of particle 1 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_2 : (D,) numpy.ndarray + Local index of particle 2 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_3 : (D,) numpy.ndarray + Local index of particle 3 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_4 : (D,) numpy.ndarray + Local index of particle 4 for each of :code:`D` constructed + four-particle bonds. + bonds_4_coeff : (D,) numpy.ndarray + Cosine series coefficients for each of :code:`D` constructed + four-particle bonds. + bonds_4_type : (D,) numpy.ndarray + Dihedral type for each of :code:`D` constructed four-particle + bonds. + bonds_4_last : (D,) numpy.ndarray + Flags indicating if :code:`dih_type` is :code:`1` for each of :code:`D` + constructed four-particle bonds. + + See also + -------- + prepare_bonds_old : + Used internally to reconstruct the bonded interactions types from the + connectivity information in the structure/topology input file and the + bonded types specified in the configuration file. + """ + if topol is not None: + bonds_2, bonds_3, bonds_4 = prepare_index_based_bonds( + molecules, topol + ) + else: + bonds_2, bonds_3, bonds_4, bb_index = prepare_bonds_old( + molecules, names, bonds, indices, config + ) + + # Bonds + bonds_2_atom1 = np.empty(len(bonds_2), dtype=int) + bonds_2_atom2 = np.empty(len(bonds_2), dtype=int) + bonds_2_equilibrium = np.empty(len(bonds_2), dtype=np.float64) + bonds_2_strength = np.empty(len(bonds_2), dtype=np.float64) + for i, b in enumerate(bonds_2): + bonds_2_atom1[i] = b[0] + bonds_2_atom2[i] = b[1] + bonds_2_equilibrium[i] = b[2] + bonds_2_strength[i] = b[3] + + # Angles + bonds_3_atom1 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom2 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom3 = np.empty(len(bonds_3), dtype=int) + bonds_3_equilibrium = np.empty(len(bonds_3), dtype=np.float64) + bonds_3_strength = np.empty(len(bonds_3), dtype=np.float64) + for i, b in enumerate(bonds_3): + bonds_3_atom1[i] = b[0] + bonds_3_atom2[i] = b[1] + bonds_3_atom3[i] = b[2] + bonds_3_equilibrium[i] = b[3] + bonds_3_strength[i] = b[4] + # Dihedrals + bonds_4_atom1 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom2 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom3 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom4 = np.empty(len(bonds_4), dtype=int) + number_of_coeff = 6 + len_of_coeff = 5 + bonds_4_coeff = np.empty( + (len(bonds_4), number_of_coeff, len_of_coeff), dtype=np.float64 + ) + bonds_4_type = np.empty(len(bonds_4), dtype=int) + bonds_4_last = np.zeros(len(bonds_4), dtype=int) + for i, b in enumerate(bonds_4): + bonds_4_atom1[i] = b[0] + bonds_4_atom2[i] = b[1] + bonds_4_atom3[i] = b[2] + bonds_4_atom4[i] = b[3] + bonds_4_coeff[i] = np.resize(b[4], (number_of_coeff, len_of_coeff)) + bonds_4_type[i] = b[5] + if topol is not None: + bonds_4_last[i] = b[6] + if topol is None: + bonds_4_last[bb_index] = 1 + + return ( + bonds_2_atom1, + bonds_2_atom2, + bonds_2_equilibrium, + bonds_2_strength, + bonds_3_atom1, + bonds_3_atom2, + bonds_3_atom3, + bonds_3_equilibrium, + bonds_3_strength, # noqa: E501 + bonds_4_atom1, + bonds_4_atom2, + bonds_4_atom3, + bonds_4_atom4, + bonds_4_coeff, + bonds_4_type, + bonds_4_last, # noqa: E501 + )
+ + +
[docs]def compute_bond_forces__plain(f_bonds, r, bonds_2, box_size): + """Computes forces resulting from bonded interactions + + .. deprecated:: 1.0.0 + :code:`compute_bond_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_bonds.fill(0.0) + energy = 0.0 + + for i, j, r0, k in bonds_2: + ri = r[i, :] + rj = r[j, :] + rij = rj - ri + + # Apply periodic boundary conditions to the distance rij + for dim in range(len(rij)): + rij[dim] -= box_size[dim] * np.around(rij[dim] / box_size[dim]) + dr = np.linalg.norm(rij) + df = -k * (dr - r0) + f_bond_vector = df * rij / dr + f_bonds[i, :] -= f_bond_vector + f_bonds[j, :] += f_bond_vector + + energy += 0.5 * k * (dr - r0) ** 2 + return energy
+ + +
[docs]def compute_angle_forces__plain(f_angles, r, bonds_3, box_size): + """Computes forces resulting from angular interactions + + .. deprecated:: 1.0.0 + :code:`compute_angle_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_angles.fill(0.0) + energy = 0.0 + + for a, b, c, theta0, k in bonds_3: + ra = r[a, :] - r[b, :] + rc = r[c, :] - r[b, :] + + for dim in range(len(ra)): + ra[dim] -= box_size[dim] * np.around(ra[dim] / box_size[dim]) + rc[dim] -= box_size[dim] * np.around(rc[dim] / box_size[dim]) + + xra = 1.0 / np.sqrt(np.dot(ra, ra)) + xrc = 1.0 / np.sqrt(np.dot(rc, rc)) + ea = ra * xra + ec = rc * xrc + + cosphi = np.dot(ea, ec) + theta = np.arccos(cosphi) + xsinph = 1.0 / np.sqrt(1.0 - cosphi**2) + + d = theta - theta0 + f = -k * d + + xrasin = xra * xsinph * f + xrcsin = xrc * xsinph * f + + fa = (ea * cosphi - ec) * xrasin + fc = (ec * cosphi - ea) * xrcsin + + f_angles[a, :] += fa + f_angles[c, :] += fc + f_angles[b, :] -= fa + fc + # f_angles[b, :] += -(fa + fc) + + energy -= 0.5 * f * d + + return energy
+ + +
[docs]def compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size): + """Computes forces resulting from dihedral interactions + + .. deprecated:: 1.0.0 + :code:`compute_dihedral_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_dihedrals.fill(0.0) + energy = 0.0 + + for a, b, c, d, coeffs, phase in bonds_4: + f = r[a, :] - r[b, :] + g = r[b, :] - r[c, :] + h = r[d, :] - r[c, :] + + for dim in range(3): + f -= box_size[dim] * np.around(f[dim] / box_size[dim]) + g -= box_size[dim] * np.around(g[dim] / box_size[dim]) + h -= box_size[dim] * np.around(h[dim] / box_size[dim]) + + v = np.cross(f, g) + w = np.cross(h, g) + vv = np.dot(v, v) + ww = np.dot(w, w) + gn = np.linalg.norm(g) + + cosphi = np.dot(v, w) + sinphi = np.dot(np.cross(v, w), g) / gn + phi = np.arctan2(sinphi, cosphi) + + fg = np.dot(f, g) + hg = np.dot(h, g) + sc = v * fg / (vv * gn) - w * hg / (ww * gn) + + df = 0 + + for m in range(len(coeffs[0])): + energy += coeffs[0][m] * (1 + np.cos(m * phi - coeffs[1][m])) + df += m * coeffs[0][m] * np.sin(m * phi - coeffs[1][m]) + + force_on_a = df * gn * v / vv + force_on_d = df * gn * w / ww + + f_dihedrals[a, :] -= force_on_a + f_dihedrals[b, :] += df * sc + force_on_a + f_dihedrals[c, :] -= df * sc + force_on_d + f_dihedrals[d, :] += force_on_d + return energy
+ + +
[docs]def dipole_forces_redistribution( + f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb +): + """Redistribute electrostatic forces calculated from topologically + reconstructed ghost dipole point charges to the backcone atoms of the protein. + """ + f_on_bead.fill(0.0) + for i, j, k, l, fd, matrix, dih_type, is_last in zip( + a, b, c, d, f_dipoles, trans_matrices, type_array, last_bb + ): + if dih_type == 1: + sum_force = fd[0] + fd[1] + diff_force = fd[0] - fd[1] + f_on_bead[i] += matrix[0] @ diff_force # Atom A + f_on_bead[j] += matrix[1] @ diff_force + 0.5 * sum_force # Atom B + f_on_bead[k] += matrix[2] @ diff_force + 0.5 * sum_force # Atom C + + if is_last == 1: + sum_force = fd[2] + fd[3] + diff_force = fd[2] - fd[3] + f_on_bead[j] += matrix[3] @ diff_force + f_on_bead[k] += matrix[4] @ diff_force + 0.5 * sum_force + f_on_bead[l] += matrix[5] @ diff_force + 0.5 * sum_force
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/_modules/hymd/hamiltonian.html b/v2.0.0/_modules/hymd/hamiltonian.html new file mode 100644 index 00000000..e3da8f16 --- /dev/null +++ b/v2.0.0/_modules/hymd/hamiltonian.html @@ -0,0 +1,802 @@ + + + + + + hymd.hamiltonian — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.hamiltonian

+"""Interaction energy functionals.
+
+Implements field--particle interaction energy functionals depending on the
+field configuration. Extending HyMD with a new Hamiltonian is done by
+subclassing the :code:`Hamiltonian` superclass with logic intialized in the
+constructor.
+
+The grid-independent filtering function is defined in the :code:`Hamiltonian`
+superclass constructor. Hijack :code:`self.H` in a subclass to change the
+filter.
+"""
+import numpy as np
+import sympy
+
+
+
[docs]class Hamiltonian: + """Interaction energy functional superclass""" + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + self.config = config + self._setup()
+ +
[docs] def _setup(self): + """Superclass setup + + Sets up the grid-independent filtering function :code:`H`, and the + SymPy logic for symbolically differentiating interaction energy + functionals in Hamiltonian subclasses. + """ + if not hasattr(self.config, "simulation_volume"): + self.config.simulation_volume = np.prod(np.asarray(self.config.box_size)) + if not self.config.barostat: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.config.a = self.config.rho0 + if not self.config.rho0: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.phi = sympy.var("phi:%d" % (self.config.n_types)) + k = sympy.var("k:%d" % (3)) + + # electrostatics variables + self.psi = sympy.var("psi") + self.phi_q = sympy.var("phi_q") + if not self.config.self_energy: + self.config.self_energy = 0.0 + + def fourier_space_window_function(k): + return sympy.functions.elementary.exponential.exp( + -0.5 + * self.config.sigma**2 + * (k0**2 + k1**2 + k2**2) # noqa: F821, E501 + ) + + self.window_function_lambda = sympy.lambdify( + [k], fourier_space_window_function(k) + ) + + def H(k, v): + return v * self.window_function_lambda(k) + + self.H = H
+ + +
[docs]class SquaredPhi(Hamiltonian): + """Simple squared density interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + \\sum_k \\tilde\\phi_k + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`rho_0` is the + average density of the fully homogenous system. Expressing the species + densities in terms of fluctuations from the average, + + .. math:: + + \\mathrm{d}\\tilde\\phi_k = \\rho_0 - \\tilde\\phi_k, + + it is evident that this interaction energy functional is a slight change of + the :code:`DefaultNoChi` Hamiltonian, as the expanded interaction energy + density becomes + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + 6\\rho_0\\left[ + \\sum_k \\mathrm{d}\\tilde\\phi_k + \\right] + + + 9\\rho_0^2 + + + \\sum_k \\mathrm{d}\\tilde\\phi_k^2 + + + \\prod_{k\\not=l} + \\mathrm{d}\\tilde\\phi_k \\mathrm{d}\\tilde\\phi_l + \\right), + + identical to :code:`DefaultNoChi` apart from a constant energy shift + :math:`9\\rho_0^2`(which does not impact dynamics) and the + :math:`\\rho_0`--:math:`\\mathrm{d}\\tilde\\phi_k` cross-terms. These + cross-terms constitute contributions to the energy linear in + :math:`\\mathrm{d}\\tilde\\phi_k` absent in :code:`DefaultNoChi`, which has + only quadratic terms present. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(SquaredPhi, self).__init__(config) + super(SquaredPhi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0): + return 0.5 / (kappa * rho0) * (sum(phi)) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + ): + V_incompressibility = 1 / (kappa * rho0) * sum(phi) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultNoChi(Hamiltonian): + """Incompressibility-only interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. The :code:`SquaredPhi` Hamiltonian implements a similar + functional with an additional linear term component depending on + + .. math:: + + \\mathmr{d}\\tilde\\phi_k = \\tilde\\phi_k - \\rho_0 + + and not :math:`\\mathrm{d}\\tilde\\phi_k^2`. No explicit inter-species + interaction is present apart from the indirect interaction through the + incompressibility. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + hymd.input_parser.Config : + Configuration dataclass handler. + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultNoChi, self).__init__(config) + super(DefaultNoChi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0, a=self.config.a): + return 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultWithChi(Hamiltonian): + """Incompressibility and :math:`\\chi`-interactions energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = + \\frac{1}{2\\rho_0} + \\sum_{k,l}\\chi_{kl} \\tilde\\phi_k \\tilde\\phi_l + + + \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. :math:`\\chi_{ij}` is the Flory-Huggins-like + inter-species mixing energy. + """ + +
[docs] def __init__(self, config, unique_names, type_to_name_map): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultWithChi, self).__init__(config) + super(DefaultWithChi, self)._setup() + self.setup(unique_names, type_to_name_map)
+ +
[docs] def setup(self, unique_names, type_to_name_map): + """Setup the interaction energy potential and the external potential + + Parameters + ---------- + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + """ + self.type_to_name_map = type_to_name_map + self.chi_type_dictionary = { + tuple(sorted([c.atom_1, c.atom_2])): c.interaction_energy + for c in self.config.chi + } + self.phi_laplacian = [ + sympy.var("phi_laplacian%d(0:%d)" % (t, 3)) + for t in range(self.config.n_types) + ] + + def w( + phi, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + interaction = 0.0 + for i in range(self.config.n_types): + for j in range(i + 1, self.config.n_types): + ni = type_to_name_map[i] + nj = type_to_name_map[j] + names = sorted([ni, nj]) + c = chi_type_dictionary[tuple(names)] + + interaction += c * phi[i] * phi[j] / rho0 + incompressibility = 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + return incompressibility + interaction + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + t, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + + V_interaction = 0.0 + nk = type_to_name_map[t] + for i in range(self.config.n_types): + ni = type_to_name_map[i] + names = sorted([nk, ni]) + if ni != nk: + c = chi_type_dictionary[tuple(names)] + else: + c = 0.0 + # uncomment to count diagonal chi terms: + # c = chi_type_dictionary[tuple(names)] + V_interaction += c * phi[i] / rho0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[t])) + for t in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +def get_hamiltonian(config): + """Return appropriate Hamiltonian object based on the + config.hamiltonian string. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ---------- + hamiltonian : Hamiltonian + Hamiltonian object. + """ + if config.hamiltonian.lower() == "defaultnochi": + hamiltonian = DefaultNoChi(config) + elif config.hamiltonian.lower() == "defaultwithchi": + hamiltonian = DefaultWithChi( + config, config.unique_names, config.type_to_name_map + ) + elif config.hamiltonian.lower() == "squaredphi": + hamiltonian = SquaredPhi(config) + + return hamiltonian +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/_modules/hymd/input_parser.html b/v2.0.0/_modules/hymd/input_parser.html new file mode 100644 index 00000000..2ba01953 --- /dev/null +++ b/v2.0.0/_modules/hymd/input_parser.html @@ -0,0 +1,1640 @@ + + + + + + hymd.input_parser — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.input_parser

+"""Parses and handles the configuration information provided for the simulation
+"""
+import copy
+import tomli
+import datetime
+import logging
+import warnings
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass, field
+from typing import List, Union, ClassVar
+from .force import Bond, Angle, Dihedral, Chi, Dielectric_type, propensity_potential_coeffs
+from .barostat import Target_pressure
+from .logger import Logger
+
+
+
[docs]@dataclass +class Config: + """Configuration object + + Handles and verifies the simulation configuration specified in the + configuration file. + + Attributes + ---------- + gas_constant : float + Constant value of the gas constant, R (equivalently the Boltzmann + constant) in the units used internally in HyMD. + coulomb_constant : float + Constant value of the Coulomb constant which converts electric field + values to forces and electric potential values to energies in the units + used internally in HyMD. + n_steps: int + Number of time steps in the simulation. + time_step: float + *Outer* time step used in the simulation. If the rRESPA intergrator is + used, the *inner* time step (the time step used in the integration of + intramolecular bending, stretching, and torsional forces) is + :code:`time_step / respa_inner`. + box_size : list[float] or (D,) numpy.ndarray + Simulation box size of simulation in :code:`D` dimensions in units of + nanometers. + mesh_size : list[int] or int or numpy.ndarray + Number of grid points used for the discrete density grid. + sigma : float + Filter width representing the effective coarse-graining level of the + particles in the simulation. + kappa : float + Compressibility parameter used in the relaxed incompressibility term in + the interaction energy functional. + n_print : int, optional + Frequency of trajectory/energy output to the H5MD trajectory/energy + output file (in units of number of time steps). + tau : float, optional + The time scale of the CSVR thermostat coupling. + start_temperature : float, optional + Generate starting temperature by assigning all particle velocities + randomly according to the Maxwell-Boltzmann distribution at + :code:`start_temperature` Kelvin prior to starting the simulation. + target_temperature : float, optional + Couple the system to a heat bath at :code:`target_temperature` Kelvin. + mass : float, optional + Mass of the particles in the simulation. + hamiltonian : str, optional + Specifies the interaction energy functional :math:`W[\\tilde\\phi]` + for use with the particle-field interactions. Options: + :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`. + domain_decomposition : int, optional + Specifies the interval (in time steps) of domain decomposition + exchange, involving all MPI ranks sending and receiving particles + according to the particles’ positions in the integration box and the + MPI ranks’ assigned domain. + integrator : str, optional + Specifies the time integrator used in the simulation. Options: + :code:`velocity-verlet` or :code:`respa`. + respa_inner : int, optional + The number of inner time steps in the rRESPA integrator. This denotes + the number of intramolecular force calculations (stretching, bending, + torsional) are performed between each impulse applied from the field + forces. + file_name : str, optional + File path of the parsed configuration file. + name : str, optional + Name for the simulation. + tags : list[str], optional + Tags for the simulation. + bonds : list[Bond], optional + Specifies harmonic stretching potentials between particles in the + same molecule. + angle_bonds : list[Angle], optional + Specifies harmonic angular bending potentials between particles in the + same molecule. + dihedrals : list[Dihedral], optional + Specifies four-particle torsional potentials by cosine series. + chi : list[Chi], optional + Specifies :math:`\\chi`-interaction parameters between particle + species. + n_particles : int, optional + Specifies the total number of particles in the input. Optional keyword + for validation, ensuring the input HDF5 topology has the correct number + of particles and molecules. + max_molecule_size : int, optional + Maximum size of any single molecule in the system. Used to speed up + distribution of particles onto MPI ranks in a parallel fashion. + n_flush : int, optional + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be + written to disk (in units of number of :code:`n_print`). + thermostat_work : float + Work performed by the thermostat on the system. + thermostat_coupling_groups : list[str], optional + Specifies individual groups coupling independently to the CSVR + thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and + :code:`"C"` type particles, + :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would + thermalise types :code:`"A"` and :code:`"B"` together and couple + :code:`"C"` type particles to a different thermostat (all individual + thermostats are at the same temperature, i.e. target_temperature + Kelvin). + initial_energy : float + Value of the total energy prior to the start of the simulation. + cancel_com_momentum : int, optional + If :code:`True`, the total linear momentum of the center of mass is + removed before starting the simulation. If an integer is specifed, the + total linear momentum of the center of mass is removed every + :code:`remove_com_momentum` time steps. If :code:`False`, the linear + momentum is never removed. + coulombtype : str, optional + Specifies the type of electrostatic Coulomb interactions in the system. + The strength of the electrostatic forces is modulated by the relative + dielectric constant of the simulation medium, specified with the + :code:`dielectric_const` keyword. Charges for individual particles are + specified in the structure/topology HDF5 input file, not in the + configuration file. If no charges (or peptide backbone dipoles) are + present, the electrostatic forces will not be calculated even if this + keyword is set to :code:`"PIC_Spectral"`. + dielectric_const : float, optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. When + using helical propensity dihedrals, this keyword must be specified—even + if electrostatics are not included with the :code:`coulombtype` + keyword. + dielectric_type: list[float], optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. The list assigns + relative dielectric values to each bead type, and an anisotropic + dielectric function is obtained from a weighted average. + + + See also + -------- + hymd.input_parser.Bond : + Two-particle bond type dataclass. + hymd.input_parser.Angle : + Three-particle bond type dataclass. + hymd.input_parser.Dihedral : + Four-particle bond type dataclass. + """ + + gas_constant: ClassVar[float] = 0.0083144621 # kJ mol-1 K-1 + coulomb_constant: ClassVar[float] = 138.935458 # kJ nm mol-1 e-2 + + n_steps: int + time_step: float + mesh_size: Union[Union[List[int], np.ndarray], int] + sigma: float + kappa: float + + dtype: np.dtype = None + box_size: Union[List[float], np.ndarray] = None + n_print: int = None + tau: float = None + start_temperature: Union[float, bool] = None + target_temperature: Union[float, bool] = None + mass: float = None + hamiltonian: str = None + domain_decomposition: Union[int, bool] = None + integrator: str = None + respa_inner: int = 1 + file_name: str = "<config file path unknown>" + name: str = None + tags: List[str] = field(default_factory=list) + bonds: List[Bond] = field(default_factory=list) + angle_bonds: List[Angle] = field(default_factory=list) + dihedrals: List[Dihedral] = field(default_factory=list) + chi: List[Chi] = field(default_factory=list) + n_particles: int = None + max_molecule_size: int = None + n_flush: int = None + thermostat_work: float = 0.0 + thermostat_coupling_groups: List[List[str]] = field(default_factory=list) + initial_energy: float = None + cancel_com_momentum: Union[int, bool] = False + coulombtype: str = None + convergence_type: str = None + pol_mixing: float = None + dielectric_const: float = None + conv_crit: float = None + dielectric_type: List[Dielectric_type] = field(default_factory=list) + self_energy: float = None + type_charges: Union[List[float], np.ndarray] = None + + # For NPT runs + rho0: float = None + a: float = None + pressure: bool = False + barostat: str = None + barostat_type: str = None + tau_p: float = None + target_pressure: List[Target_pressure] = field(default_factory=list) + n_b: int = None + m: List[float] = field(default_factory=list) + + def __str__(self): + target_pressure_str = "\ttarget_pressure:\n" + "".join( + "\t\tP_L: " + + f"{self.target_pressure.P_L}\n" + + "\t\tP_N: " + + f"{self.target_pressure.P_N}\n" + ) + bonds_str = "\tbonds:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " f"{k.equilibrium}, {k.strength}\n") + for k in self.bonds + ] + ) + angle_str = "\tangle_bonds:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3}: " + + f"{k.equilibrium}, {k.strength}\n" + ) + for k in self.angle_bonds + ] + ) + dihedrals_str = "\tdihedrals:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: " + # This might need to be fixed/made prettier, probably + # there's an easier way + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ).join( + map( + str, + [ + [round(num, 3) for num in c_in] + if isinstance(c_in, list) + else c_in + for c_in in k.coeffs + ], + ) + ) + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ) + + f"dih_type = {k.dih_type}\n" + ) + for k in self.dihedrals + ] + ) + chi_str = "\tchi:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " + f"{k.interaction_energy}\n") + for k in self.chi + ] + ) + + """ If dielectric wanted as dictionary + dielectric_type_str = "\tdielectric_type:\n" + "".join( + [ + (f"\t\t{k.atom_1}: " + f"{k.dielectric_value}\n") + for k in self.dielectric_type + ] + ) + + """ + + thermostat_coupling_groups_str = "" + if any(self.thermostat_coupling_groups): + thermostat_coupling_groups_str = ( + "\tthermostat_coupling_groups:\n" + + "".join( + [ + "\t\t" + ", ".join([f"{n}" for n in ng]) + "\n" + for ng in self.thermostat_coupling_groups + ] + ) + ) + + ret_str = f'\n\n\tConfig: {self.file_name}\n\t{50 * "-"}\n' + for k, v in self.__dict__.items(): + if k not in ( + "target_pressure", + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "thermostat_coupling_groups", + ): + ret_str += f"\t{k}: {v}\n" + ret_str += ( + target_pressure_str + + bonds_str + + angle_str + + dihedrals_str + + chi_str + + thermostat_coupling_groups_str + ) + return ret_str
+ + +
[docs]def read_config_toml(file_path): + with open(file_path, "r") as in_file: + file_content = in_file.read() + return file_content
+ +
[docs]def parse_config_toml(toml_content, file_path=None, comm=MPI.COMM_WORLD): + config_dict = {} + + # read toml to a dictionary + toml_content = tomli.loads(toml_content) + + # Defaults = None + for n in ( + "box_size", + "n_print", + "tau", + "start_temperature", + "target_temperature", + "mass", + "hamiltonian", + "domain_decomposition", + "integrator", + "name", + "n_particles", + "max_molecule_size", + "coulombtype", + "convergence_type", + "dielectric_const", + "pol_mixing", + "conv_crit", + "dielectric_type", + "n_b", + "box_size", + "n_flush", + "self_energy", + "dtype", + ): + config_dict[n] = None + + # Defaults = [] + + for n in ( + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "tags", + "m", + "dielectric_type", + "target_pressure", + "type_charges", + ): + config_dict[n] = [] + + # Defaults: bool + config_dict["pressure"] = False + + # Flatten the .toml dictionary, ignoring the top level [tag] directives (if + # any). + for k, v in toml_content.items(): + if isinstance(v, dict): + if k == "nn": # Don't parse diff-hymd optimization options + continue + for nested_k, nested_v in v.items(): + config_dict[nested_k] = nested_v + else: + config_dict[k] = v + for k, v in config_dict.items(): + if k == "bonds": + config_dict["bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["bonds"][i] = Bond( + atom_1=b[0], + atom_2=b[1], + equilibrium=b[2], + strength=b[3], + ) + if k == "angle_bonds": + config_dict["angle_bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["angle_bonds"][i] = Angle( + atom_1=b[0], + atom_2=b[1], + atom_3=b[2], + equilibrium=b[3], + strength=b[4], + ) + if k == "dihedrals": + config_dict["dihedrals"] = [None] * len(v) + for i, b in enumerate(v): + try: + dih_type = int(b[2][0]) + except IndexError: + Logger.rank0.log( + logging.WARNING, "Dihedral type not provided, defaulting to 0." + ) + dih_type = 0 + + # Probably it's better to move this in check_dihedrals? + wrong_len = len(b[1]) not in (1, 2) + wrong_type_1 = len(b[1]) == 1 and not isinstance(b[1][0], float) + wrong_type_2 = len(b[1]) == 2 and not isinstance(b[1][0], list) + if wrong_len or wrong_type_1 or wrong_type_2: + err_str = ( + "The coefficients specified for the dihedral type " + "(0) do not match the correct structure. Either " + "use [lambda] or [[cn_prop], [dn_prop]], or select" + " the correct dihedral type." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise RuntimeError(err_str) + + # FIXME: this is messy af, I don't like it + if dih_type == 0 and isinstance(b[1][0], (float, int)): + coeff = propensity_potential_coeffs(b[1][0]) + elif dih_type == 1 and len(b[1]) == 3: + coeff = np.array( + propensity_potential_coeffs(b[1][0][0]).tolist() + + b[1][1:] + ) + elif dih_type == 2: + coeff = np.array(b[1]) + else: + coeff = np.insert(np.array(b[1]), 2, np.zeros((2, 5)), axis=0) + + config_dict["dihedrals"][i] = Dihedral( + atom_1=b[0][0], + atom_2=b[0][1], + atom_3=b[0][2], + atom_4=b[0][3], + coeffs=coeff, + dih_type=dih_type, + ) + if k == "chi": + config_dict["chi"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0], c[1]]) + config_dict["chi"][i] = Chi( + atom_1=c_[0], atom_2=c_[1], interaction_energy=c[2] + ) + + """ + if k == "dielectric_type": + config_dict["dielectric_type"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0][0]]) + config_dict["dielectric_type"][i] = Dielectric_type( + atom_1=c_[0], dielectric_value=c[1][0] + ) + """ + if k == "target_pressure": + if len(v) == 2: + config_dict["target_pressure"] = Target_pressure( + P_L=v[0], + P_N=v[1], # check condition # V array (still read as array?) + ) + elif len(v) == 1: + config_dict["target_pressure"] = Target_pressure(P_L=v[0], P_N=None) + else: + config_dict["target_pressure"] = Target_pressure(P_L=None, P_N=None) + + if file_path is not None: + config_dict["file_name"] = file_path + + for n in ( + "n_steps", "time_step", "mesh_size", "sigma", "kappa" + ): + if n not in config_dict: + err_str = ( + f"No {n} specified in config file {file_path}. Unable to start" + f" simulation." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return Config(**config_dict)
+ + +
[docs]def check_n_particles(config, indices, comm=MPI.COMM_WORLD): + n_particles = comm.allreduce(len(indices), MPI.SUM) + if config.n_particles is None: + config = copy.deepcopy(config) + config.n_particles = n_particles + info_str = ( + f"No n_particles found in toml file {config.file_name}, defaulting" + f" to indices.shape ({n_particles})" + ) + Logger.rank0.log(logging.INFO, info_str) + return config + + if n_particles != config.n_particles: + warn_str = ( + f"n_particles in {config.file_name} ({config.n_particles}) does " + "not match the shape of the indices array in the .HDF5 file " + f"({n_particles}). Defaulting to using indices.shape " + f"({n_particles})" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.n_particles = n_particles + return config
+ + +
[docs]def check_max_molecule_size(config, comm=MPI.COMM_WORLD): + if config.max_molecule_size is None: + info_str = ( + f"No max_molecule_size found in toml file {config.file_name}, " + f"defaulting to 201" + ) + Logger.rank0.log(logging.INFO, info_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + + if config.max_molecule_size < 1: + warn_str = ( + f"max_molecule_size in {config.file_name} must be a positive " + f"integer, not {config.max_molecule_size}, defaulting to 201" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + return config
+ + +def _find_unique_names(config, names, comm=MPI.COMM_WORLD): + unique_names = np.unique(names) + receive_buffer = comm.gather(unique_names, root=0) + + gathered_unique_names = None + if comm.Get_rank() == 0: + gathered_unique_names = np.unique(np.concatenate(receive_buffer)) + unique_names = comm.bcast(gathered_unique_names, root=0) + unique_names = sorted([n.decode("UTF-8") for n in unique_names]) + config.unique_names = unique_names + config.n_types = len(unique_names) + return config + + +def _setup_type_to_name_map(config, names, types, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + name_to_type_ = {} + for n, t in zip(names, types): + n = n.decode("utf-8") + if n not in name_to_type_: + name_to_type_[n] = t + receive_buffer = comm.gather(name_to_type_, root=0) + gathered_dict = None + if comm.Get_rank() == 0: + gathered_dict = {} + for d in receive_buffer: + for k, v in d.items(): + if k not in gathered_dict: + gathered_dict[k] = v + else: + assert v == gathered_dict[k] + name_to_type_map = comm.bcast(gathered_dict, root=0) + config.name_to_type_map = name_to_type_map + config.type_to_name_map = {v: k for k, v in name_to_type_map.items()} + return config + + +
[docs]def check_bonds(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for b in config.bonds: + if b.atom_1 not in unique_names or b.atom_2 not in unique_names: + missing_str = "" + if b.atom_1 not in unique_names: + if b.atom_2 not in unique_names: + if b.atom_1 == b.atom_2: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"neither {b.atom_1}, {b.atom_2} atoms" + else: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"no {b.atom_2} atoms" + + warn_str = ( + f"Bond type {b.atom_1}--{b.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_angles(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for a in config.angle_bonds: + if ( + a.atom_1 not in unique_names + or a.atom_2 not in unique_names + or a.atom_3 not in unique_names + ): + missing = [ + a.atom_1 not in unique_names, + a.atom_2 not in unique_names, + a.atom_3 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([a.atom_1, a.atom_2, a.atom_3]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Angle bond type {a.atom_1}--{a.atom_2}--{a.atom_3} " + f"specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_dihedrals(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for d in config.dihedrals: + if ( + d.atom_1 not in unique_names + or d.atom_2 not in unique_names + or d.atom_3 not in unique_names + or d.atom_4 not in unique_names + ): + missing = [ + d.atom_1 not in unique_names, + d.atom_2 not in unique_names, + d.atom_3 not in unique_names, + d.atom_4 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([d.atom_1, d.atom_2, d.atom_3, d.atom_4]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Dihedral type {d.atom_1}--{d.atom_2}--{d.atom_3}--{d.atom_4}" + f" specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_chi(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for c in config.chi: + if c.atom_1 not in unique_names or c.atom_2 not in unique_names: + missing_str = "" + if c.atom_1 not in unique_names: + if c.atom_2 not in unique_names: + if c.atom_1 == c.atom_2: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"neither {c.atom_1}, {c.atom_2} atoms" + else: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"no {c.atom_2} atoms" + + warn_str = ( + f"Chi interaction {c.atom_1}--{c.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + for i, n in enumerate(unique_names): + for m in unique_names[i + 1 :]: + found = False + for c in config.chi: + if (c.atom_1 == n and c.atom_2 == m) or ( + c.atom_1 == m and c.atom_2 == n + ): + found = True + if not found: + config.chi.append(Chi(atom_1=n, atom_2=m, interaction_energy=0.0)) + warn_str = ( + f"Atom types {n} and {m} found in the " + f"system, but no chi interaction {n}--{m} " + f"specified in {config.file_name}. Defaulting to " + f"chi[{n}, {m}] = 0" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_box_size(config, input_box, comm=MPI.COMM_WORLD): + if config.box_size is not None: + config.box_size = np.array(config.box_size, dtype=np.float32) + if input_box.all() and not np.allclose(config.box_size, input_box, atol=0.009): + err_str = ( + f"Box size specified in {config.file_name}: " + f"{config.box_size} does not match input box:" + f"{input_box}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + else: + if input_box.all(): + config.box_size = input_box + else: + err_str = f"No box information found" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + for b in config.box_size: + if b <= 0.0: + err_str = ( + f"Invalid box size specified in {config.file_name}: " + f"{config.box_size}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return config
+ + +
[docs]def check_integrator(config, comm=MPI.COMM_WORLD): + if config.integrator.lower() not in ("velocity-verlet", "respa"): + err_str = ( + f"Invalid integrator specified in {config.file_name}: " + f'{config.integrator}. Available options "velocity-verlet" or ' + f'"respa".' + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + if config.integrator.lower() == "respa": + if isinstance(config.respa_inner, float): + warn_str = ( + f"Number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner} specified " + f"as float, using {int(config.respa_inner)}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = int(config.respa_inner) + elif not isinstance(config.respa_inner, int): + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + + if config.respa_inner <= 0: + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + if config.integrator.lower() == "velocity-verlet" and config.respa_inner != 1: + warn_str = ( + f"Integrator type Velocity-Verlet specified in {config.file_name} " + f"and inner rRESPA time steps set to {config.respa_inner}. " + f"Using respa_inner = 1" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = 1 + + return config
+ + +
[docs]def check_hamiltonian(config, comm=MPI.COMM_WORLD): + valid_hamiltonians = ["defaultnochi", "defaultwithchi", "squaredphi"] + + if config.hamiltonian is None: + if len(config.chi) == 0: + warn_str = ( + f"No hamiltonian form and no chi interactions specified in " + f"{config.file_name}, defaulting to DefaultNoChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultNoChi" + else: + warn_str = ( + f"No hamiltonian form specified in {config.file_name}, but " + f"chi interactions are specified, defaulting to " + f"DefaultWithChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultWithChi" + elif config.hamiltonian.lower() not in valid_hamiltonians: + err_str = ( + f"The specified Hamiltonian {config.hamiltonian} was not " + f"recognized as a valid Hamiltonian." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise NotImplementedError(err_str) + + return config
+ + +
[docs]def check_n_flush(config, comm=MPI.COMM_WORLD): + if config.n_print: + if config.n_flush is None: + config.n_flush = 10000 // config.n_print + return config
+ + +
[docs]def check_n_print(config, comm=MPI.COMM_WORLD): + if ( + not isinstance(config.n_print, int) + and not isinstance(config.n_print, float) + and config.n_print is not None + ): + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if config.n_print is None or config.n_print <= 0: + config.n_print = False + elif not isinstance(config.n_print, int): + if isinstance(config.n_print, float): + warn_str = ( + f"n_print is a float ({config.n_print}), not int, using " + f"{int(round(config.n_print))}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + config.n_print = int(round(config.n_print)) + else: + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + return config
+ + +
[docs]def check_tau(config, comm=MPI.COMM_WORLD): + if config.tau is None and config.target_temperature is not None: + warn_str = "target temp specified but no tau, defaulting 0.7" + config.tau = 0.7 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_start_and_target_temperature(config, comm=MPI.COMM_WORLD): + """Validate provided starting and target thermostat temperatures + + Assesses the provided temperature target and ensures it is a non-negative + floating point number or :code:`False`. Ensures the starting temperature is + a non-negative floating point number or :code:`False`. + + If the value for either is :code:`None`, the returned configuration object + has the values defaulted to :code:`False` in each case. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ------- + validated_config : Config + Configuration object with validated :code:`target_temperature` and + :code:`start_temperature`. + """ + for t in ("start_temperature", "target_temperature"): + if getattr(config, t) is not None: + try: + if getattr(config, t) < 0: + warn_str = ( + f"{t} set to negative value ({getattr(config, t)}), " + f"defaulting to False" + ) + setattr(config, t, False) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + except TypeError as e: + err_str = ( + f"Could not interpret {t} = {repr(getattr(config, t))} as " + f"a number." + ) + raise TypeError(err_str) from e + + if config.start_temperature is None: + config.start_temperature = False + if config.target_temperature is None: + config.target_temperature = False + return config
+ + +
[docs]def check_mass(config, comm=MPI.COMM_WORLD): + if config.mass is None: + info_str = "no mass specified, defaulting to 72.0" + config.mass = 72.0 + Logger.rank0.log(logging.INFO, info_str) + elif not isinstance(config.mass, int) and not isinstance(config.mass, float): + err_str = ( + f"specified mass is invalid type {config.mass}, " f"({type(config.mass)})" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + elif config.mass < 0: + err_str = f"invalid mass specified, {config.mass}" + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + else: + config.mass = float(config.mass) + + return config
+ + +
[docs]def check_domain_decomposition(config, comm=MPI.COMM_WORLD): + dd = config.domain_decomposition + if dd is None or dd is False: + config.domain_decomposition = False + return config + + if isinstance(dd, int): + if dd < 0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + elif isinstance(dd, float): + if dd < 0.0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + else: + warn_str = ( + f"domain_decomposition ({config.domain_decomposition}) is not " + f"an integer, using {int(round(dd))}" + ) + config.domain_decomposition = int(round(dd)) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + else: + err_str = ( + f"invalid value for domain_decomposition " + f"({config.domain_decomposition}) use an integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + return config
+ + +
[docs]def check_name(config, comm=MPI.COMM_WORLD): + if config.name is None: + root_current_time = "" + if comm.Get_rank() == 0: + root_current_time = datetime.datetime.now().strftime("%m/%d/%Y, %H:%M:%S") + current_time = comm.bcast(root_current_time, root=0) + + if config.name is None: + config.name = "sim" + current_time + else: + config.name = str(config.name) + return config
+ + +
[docs]def check_NPT_conditions(config, comm=MPI.COMM_WORLD): + """ + Check validity of barostat_type, barostat, + a, rho0, target_pressure, tau_p + """ + if config.barostat is None: + if ( + config.tau_p is not None + or (config.target_pressure.P_L and config.target_pressure.P_N) is not None + ): + err_str = ( + "barostat not specified but config.tau_p " + "or config.target_pressure specified, cannot start simulation {config.barostat}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.a: + warn_str = "a specified but no barostat," "setting a to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.rho0: + warn_str = ( + "rho0 specified but no barostat," "setting rho0 to average density" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + if config.barostat is not None: + if not config.barostat_type: + config.barostat_type = "berendsen" + warn_str = "barostat_type not specified," "setting to berendsen" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.barostat != "isotropic" and config.barostat != "semiisotropic": + err_str = "barostat option not recognised. Valid options: isotropic, semiisotropic" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.target_pressure.P_L is None: + config.target_pressure.P_L = 1.0 # bar + config.target_pressure.P_N = None + if config.barostat == "semiisotropic": + config.target_pressure.P_N = 1.0 # bar + warn_str = ( + "barostat specified but no target_pressure, defaulting to 1.0 bar" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.tau_p is None: + if config.tau <= 0.1: + config.tau_p = config.tau * 10.0 + else: + config.tau_p = 1.0 + warn_str = "barostat specified but no tau_p, defaulting to " + str( + config.tau_p + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if not config.a: + err_str = "a not specified; cannot start simulation {config.a}" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if not config.rho0: + warn_str = "rho0 not specified;" "setting rho0 to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + return config
+ + +
[docs]def check_thermostat_coupling_groups(config, comm=MPI.COMM_WORLD): + if any(config.thermostat_coupling_groups): + found = [0 for _ in config.unique_names] + unique_names = [n for n in config.unique_names] + for i, group in enumerate(config.thermostat_coupling_groups): + for species in group: + try: + ind = unique_names.index(species) + found[ind] += 1 + except ValueError as e: + err_str = ( + f"Particle species {species} specified in thermostat " + f"coupling group {i}, but no {species} particles were " + "found in the system." + ) + raise ValueError(err_str) from e + if any([True if f > 1 else False for f in found]): + for i, f in enumerate(found): + if f > 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} specified in multiple " + "thermostat coupling groups; " + f"{config.thermostat_coupling_groups}." + ) + raise ValueError(err_str) + if not all([True if f == 1 else False for f in found]): + for i, f in enumerate(found): + if f != 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} not specified in any " + f"thermostat coupling group, but {species} particles " + "were found in the system" + ) + raise ValueError(err_str) + return config
+ + +
[docs]def check_m(config, comm=MPI.COMM_WORLD): + if config.m == []: + config.m = [1.0 for t in range(config.n_types)] + return config
+ + +
[docs]def check_n_b(config, comm=MPI.COMM_WORLD): + if config.n_b is None: + warn_str = f"config.n_b not specified." "Defaulting to 1" + config.n_b = 1 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_cancel_com_momentum(config, comm=MPI.COMM_WORLD): + if isinstance(config.cancel_com_momentum, int): + if config.cancel_com_momentum == 0 or config.cancel_com_momentum < 0: + config.cancel_com_momentum = False + elif not isinstance(config.cancel_com_momentum, bool): + err_str = ( + f"Could not interpret {config.cancel_com_momentum} as an integer " + f"or boolean." + ) + raise ValueError(err_str) + return config
+ + +
[docs]def sort_dielectric_by_type_id(config, charges, types): + """ + Creates a list of length N CG-particles, sorted after the charges from + the input HDF5 file. Used in file_io.py + """ + dielectric_val = np.zeros(config.n_types) + for j in range(config.n_types): + name = config.dielectric_type[j][0][0] + type_id = config.name_to_type_map[name] + dielectric_val[type_id] = config.dielectric_type[j][1][0] + config.dielectric_type = dielectric_val.copy() + + N = len(charges) + len_list = np.zeros(config.n_types) + dielectric_by_types = np.zeros(N) + for i in range(N): + dielectric_by_types[i] = dielectric_val[types[i]] + # print("types ", types) + # print("diel val", dielectric_by_types) + # print("charges", charges) + # print(config.name_to_type_map) + return dielectric_by_types # by types with each particle id
+ + +
[docs]def check_charges_types_list(config, types, charges, comm=MPI.COMM_WORLD): + """ + Creates a list of charge values of length types. + Charges are sorted according to type ID. Used in field.py. + # TODO: this is messy, we should fix it + """ + if charges is None: + config.type_charges = [0.0] * config.n_types + return config + + check_val = -100.0 # some random value that will never be encountered + charges_list = np.full(config.n_types, check_val) # gatherv cant handle None + rank = comm.Get_rank() + # print(charges_list) + for t_ in range(config.n_types): + if t_ in types: + charges_list[t_] = charges[types == t_][0] + + nprocs = int(comm.Get_size()) + recv_charges = None + if rank == 0: + recv_charges = np.full( + config.n_types * nprocs, check_val + ) # gatherv cant handle None + comm.Gather(charges_list, recv_charges, root=0) + + ## make a charges list + if rank == 0: + config_charges = np.zeros(config.n_types) + test_config = np.full(config.n_types, check_val) + for j in range(nprocs): + for i in range(config.n_types): + if recv_charges[i + j * config.n_types] != check_val: + config_charges[i] = recv_charges[i + j * config.n_types] + if np.any([test_config, config_charges]): + continue + else: + break + + # print(config_charges) + # print(config.name_to_type_map) + # print(charges[types == 0][0],charges[types == 1][0],charges[types == 2][0],charges[types == 3][0], + # charges[types == 4][0]) + else: + config_charges = np.zeros(config.n_types) + + comm.Bcast(config_charges, root=0) + # print("config_charges", config_charges , "rank", rank) + # print(recv_charges) + # rank = comm.Get_rank() + # print(all_charges) + config.type_charges = config_charges + return config
+ + +
[docs]def check_dielectric(config, comm=MPI.COMM_WORLD): + """ + Error handling for electrostatics. + Unit testing of toml/tomli input. + """ + err_str_const = "Dielectric constant not given." + if config.coulombtype == "PIC_Spectral": + assert config.dielectric_const != None, err_str_const + + err_str = "Dielectric list is empty." + if config.coulombtype == "PIC_Spectral_GPE": + assert len(config.dielectric_type) != 0, err_str + # default values + if config.pol_mixing is None: + config.pol_mixing = 0.6 + if config.conv_crit is None: + config.conv_crit = 1e-6 + return config
+ + +
[docs]def check_charges(config, charges, comm=MPI.COMM_WORLD): + """Check if charges across ranks sum to zero. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of floats with charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + """ + total_charge = comm.allreduce(np.sum(charges), MPI.SUM) + + if not np.isclose(total_charge, 0.0): + warn_str = ( + f"Charges in the input file do not sum to zero. " + f"Total charge is {total_charge}." + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + # if charges are ok, compute self energy + if config.coulombtype == "PIC_Spectral": + from .field import compute_self_energy_q + + config.self_energy = compute_self_energy_q(config, charges, comm=comm) + + return config
+ + +
[docs]def check_config( + config, indices, names, types, charges, input_box, comm=MPI.COMM_WORLD +): + """Performs various checks on the specfied config to ensure consistency + + Parameters + ---------- + config : Config + Configuration object. + indices : (N,) numpy.ndarray + Array of integer indices for :code:`N` particles. + names : (N,) numpy.ndarray + Array of string names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of integer type indices for :code:`N` particles. + charges : (N,) numpy.ndarray + Array of floats charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + + Returns + ------- + config : Config + Validated configuration object. + """ + config = _find_unique_names(config, names, comm=comm) + if types is not None: + config = _setup_type_to_name_map(config, names, types, comm=comm) + config = check_box_size(config, input_box, comm=comm) + config = check_integrator(config, comm=comm) + config = check_max_molecule_size(config, comm=comm) + config = check_tau(config, comm=comm) + config = check_start_and_target_temperature(config, comm=comm) + config = check_mass(config, comm=comm) + config = check_domain_decomposition(config, comm=comm) + config = check_name(config, comm=comm) + config = check_n_particles(config, indices, comm=comm) + config = check_chi(config, names, comm=comm) + config = check_bonds(config, names, comm=comm) + config = check_angles(config, names, comm=comm) + config = check_dihedrals(config, names, comm=comm) + config = check_hamiltonian(config, comm=comm) + config = check_NPT_conditions(config, comm=comm) + config = check_n_b(config, comm=comm) + config = check_m(config, comm=comm) + config = check_thermostat_coupling_groups(config, comm=comm) + config = check_cancel_com_momentum(config, comm=comm) + config = check_dielectric(config, comm=comm) + config = check_n_print(config, comm=comm) + config = check_n_flush(config, comm=comm) + config = check_charges_types_list(config, types, charges, comm=comm) + if charges is not None: + config = check_charges(config, charges, comm=comm) + + return config
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/_modules/hymd/integrator.html b/v2.0.0/_modules/hymd/integrator.html new file mode 100644 index 00000000..eb1c8939 --- /dev/null +++ b/v2.0.0/_modules/hymd/integrator.html @@ -0,0 +1,363 @@ + + + + + + hymd.integrator — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.integrator

+"""Integrates equations of motion.
+
+Implements the Velocity Verlet integrator. The *reversible reference system
+propagator algorithm* (rRESPA) integrator uses the Velocity Verlet functions
+inside the MD loop in the main module.
+"""
+
+
+
[docs]def integrate_velocity(velocities, accelerations, time_step): + """Velocity update step of the Velocity Verlet integration algorithm. + + Computes the velocity update step of the Velocity Verlet algorithm. The + :code:`velocities` argument is **not** changed in place. + + Parameters + ---------- + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + accelerations : (N, D) numpy.ndarray + Array of accelerations of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step + + .. math:: \\mathbf{v}_{\\text{new}} = \\mathbf{v} + \\frac{\\Delta t}{2m} + \\mathbf{f} + + before the positions are moved a full step using the updated half-step + velocities. + + See Also + -------- + integrate_position : The position update step of the Velocity Verlet + algorithm. + """ + return velocities + 0.5 * time_step * accelerations
+ + +
[docs]def integrate_position(positions, velocities, time_step): + """Position update step of the Velocity Verlet integration algorithm. + + Computes the position update step of the Velocity Verlet algorithm. The + :code:`positions` argument is **not** changed in place. + + Parameters + ---------- + positions : (N, D) numpy.ndarray + Array of positions of :code:`N` particles in :code:`D` dimensions. + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step, then the positions are updated a full step using the updated + velocities + + .. math:: \\mathbf{x}_{\\text{new}} = \\mathbf{x} + \\Delta t \\mathbf{v} + + See Also + -------- + integrate_velocity : The velocity update step of the Velocity Verlet + algorithm. + """ + return positions + time_step * velocities
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/_modules/hymd/logger.html b/v2.0.0/_modules/hymd/logger.html new file mode 100644 index 00000000..ff9d4538 --- /dev/null +++ b/v2.0.0/_modules/hymd/logger.html @@ -0,0 +1,552 @@ + + + + + + hymd.logger — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.logger

+"""Handles event logging for simulation information, warnings, and errors.
+"""
+import sys
+import os
+import logging
+from mpi4py import MPI
+from .version import __version__
+
+
+
[docs]class MPIFilterRoot(logging.Filter): + """Log output Filter wrapper class for the root MPI rank log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + if self.comm.Get_rank() == 0: + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True + else: + return False
+ + +
[docs]class MPIFilterAll(logging.Filter): + """Log output Filter wrapper class for the all-MPI-ranks log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True
+ + +class MPIFilterStdout(logging.Filter): + """Log output Filter wrapper class for filtering STDOUT log""" + + def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.funcName = "replica 0 " + record.funcName + if MPI.COMM_WORLD.Get_rank() == 0: + record.rank = MPI.COMM_WORLD.Get_rank() + record.size = MPI.COMM_WORLD.Get_size() + return True + else: + return False + + +
[docs]class Logger: + """Log output handler class + + Notes + ----- + This wraps the default python library :code:`logging`, see + `docs.python.org/3/library/logging.html`_. + + .. _`docs.python.org/3/library/logging.html`: + https://docs.python.org/3/library/logging.html + + Attributes + ---------- + level : int + Determines the verbosity level of the log, corresponding to + logging.level. Numerical values :code:`50` (:code:`logging.CRITICAL`), + :code:`40` (:code:`logging.ERROR`), :code:`30` + (:code:`logging.WARNING`), :code:`20` (:code:`logging.INFO`), + :code:`10` (:code:`logging.DEBUG`), and :code:`0` + (:code:`logging.UNSET`) are supported values. Any log event message + less severe than the specified level is ignored. All other event + messages are emitted. + log_file : str + Path to output log file. + format : str + Prepended dump string for each log event. Specifies the log event + level, the module emitting the event, the code line, the enclosing + function name, and the MPI rank writing the message. + date_format : str + Prepends the date before all log event messages. + formatter : logging.Formatter + Formatter handling the prepending of the information in `format` and + `date_format` to each log event message. Used by default for all + loggers. + rank0 : logging.Logger + Default logger object for the root MPI rank. + all_ranks : logging.Logger + Default logger object for messages being emitted from all MPI ranks + simultaneously. + """ + + level = None + log_file = None + format = " %(levelname)-8s [%(filename)s:%(lineno)d] <%(funcName)s> {rank %(rank)d/%(size)d} %(message)s" # noqa: E501 + date_format = "%(asctime)s" + formatter = logging.Formatter(fmt=date_format + format) + rank0 = logging.getLogger("HyMD.rank_0") + all_ranks = logging.getLogger("HyMD.all_ranks") + +
[docs] @classmethod + def setup(cls, default_level=logging.INFO, log_file=None, verbose=False, comm=MPI.COMM_WORLD): + """Sets up the logger object. + + If a :code:`log_file` path is provided, log event messages are output + to it. Otherwise, the logging messages are emitted to stdout. + + Parameters + ---------- + default_level : int, optional + Default verbosity level of the logger. Unless specified, it is + :code:`10` (:code:`logging.INFO`). + log_file : str, optional + Path to output log file. If `None` or not priovided, no log file is + used and all logging is done to stdout. + verbose : bool, optional + Increases the logging level to :code:`30` (:code:`logging.WARNING`) + if True, otherwise leaves the logging level unchanged. + """ + cls.level = default_level + cls.log_file = log_file + + log_to_stdout = False + if verbose: + log_to_stdout = True + + level = default_level + if not verbose: + level = logging.WARNING + cls.rank0.setLevel(level) + cls.all_ranks.setLevel(level) + + root_filter = MPIFilterRoot(comm) + all_filter = MPIFilterAll(comm) + cls.rank0.addFilter(root_filter) + cls.all_ranks.addFilter(all_filter) + + if (not log_file) and (not log_to_stdout): + return + if log_file: + cls.log_file_handler = logging.FileHandler(log_file) + cls.log_file_handler.setLevel(level) + cls.log_file_handler.setFormatter(cls.formatter) + + cls.rank0.addHandler(cls.log_file_handler) + cls.all_ranks.addHandler(cls.log_file_handler) + if log_to_stdout: + cls.log_to_stdout = True + cls.stdout_handler = logging.StreamHandler() + cls.stdout_handler.setLevel(level) + cls.stdout_handler.setStream(sys.stdout) + cls.stdout_handler.setFormatter(cls.formatter) + cls.stdout_handler.addFilter(MPIFilterStdout()) + + cls.rank0.addHandler(cls.stdout_handler) + cls.all_ranks.addHandler(cls.stdout_handler)
+ + +def format_timedelta(timedelta): + days = timedelta.days + hours, rem = divmod(timedelta.seconds, 3600) + minutes, seconds = divmod(rem, 60) + microseconds = timedelta.microseconds + ret_str = "" + if days != 0: + ret_str += f"{days} days " + ret_str += f"{hours:02d}:{minutes:02d}:{seconds:02d}.{microseconds:06d}" + return ret_str + + +def get_version(): + # Check if we are in a git repo and grab the commit hash and the branch if + # we are, append it to the version number in the output specification. + try: + import git + + try: + repo_dir = os.path.abspath( + os.path.join(os.path.dirname(__file__), os.pardir) + ) + repo = git.Repo(repo_dir) + commit = str(repo.head.commit)[:7] + branch = repo.active_branch + version = f"{__version__} [{branch} branch commit {commit}]" + except git.exc.InvalidGitRepositoryError: + version = f"{__version__}" + except ModuleNotFoundError: + version = f"{__version__}" + + return version + + +def print_header(): + banner = r""" + __ __ ____ __ _______ + / / / /_ __/ / /__ _________ _____ ______ / |/ / __ \ + / /_/ / / / / / / _ \/ ___/ __ `/ __ `/ ___/ / /|_/ / / / / + / __ / /_/ / / / __/ / / /_/ / /_/ (__ ) / / / / /_/ / + /_/ /_/\__, /_/_/\___/_/ \__,_/\__,_/____/ /_/ /_/_____/ + /____/ + """ + + refs_set = """ + + [1] Ledum, M.; Sen, S.; Li, X.; Carrer, M.; Feng Y.; Cascella, M.; Bore, S. L. + HylleraasMD: A Domain Decomposition-Based Hybrid Particle-Field Software for Multi-Scale Simulations of Soft Matter. + J. Chem. Theory Comput. 2023. + + [2] Ledum, M.; Carrer, M.; Sen, S.; Li, X.; Cascella, M.; Bore, S. L. + HyMD: Massively parallel hybrid particle-field molecular dynamics in Python. + J. Open Source Softw. 8(84), 4149, 2023. + + [3] Sen, S.; Ledum, M.; Bore, S. L.; Cascella, M. + Soft Matter under Pressure: Pushing Particle–Field Molecular Dynamics to the Isobaric Ensemble. + J Chem Inf Model 2023, 63(7), 1549-9596. + + [4] Bore, S. L.; Cascella, M. + Hamiltonian and alias-free hybrid particle–field molecular dynamics. + J. Chem. Phys. 2020, 153, 094106. + + [5] Pippig, M. PFFT: An extension of FFTW to massively parallel architectures. + SIAM J. Sci. Comput. 2013, 35, C213–C236. + +""" + + version = f"Version {get_version()}" + header = banner + header += version.center(56) + "\n\n" + #header += " Please read and cite the references below:" + header += " PLEASE READ AND CITE THE REFERENCES BELOW:" + header += refs_set + + return header +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/_modules/hymd/pressure.html b/v2.0.0/_modules/hymd/pressure.html new file mode 100644 index 00000000..23f593cc --- /dev/null +++ b/v2.0.0/_modules/hymd/pressure.html @@ -0,0 +1,469 @@ + + + + + + hymd.pressure — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.pressure

+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import sympy
+from .field import comp_laplacian
+
+
+
[docs]def comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fourier, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=MPI.COMM_WORLD, +): + """ + Computes total internal pressure of the system. + Kinetic pressure is trivially calculated from the kinetic energy. + Already computed bond and angle pressure terms are inserted into the + total internal pressure. + The field pressure equation is implemented. + + Parameters + ---------- + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fourier : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pressure : (18,) numpy.ndarray + Pressure contributions from various energy terms. + 0: due to kinetic energy + 1-5: due to field energy + 6-8: due to two-particle bonded terms + 9-11: due to three-particle bonded terms (called angle terms) + 12-14: due to four-particle bonded terms (called dihedral terms) + (defaults to 0 currently. Yet to be implemented) + 15-17: total pressure in x,y,z directions. + """ + rank = comm.Get_rank() + size = comm.Get_size() + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + w_elec = 0.0 + if (config.coulombtype == "PIC_Spectral_GPE") or ( + config.coulombtype == "PIC_Spectral" + ): + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + w = w_0 + w_elec + + # Kinetic term + kinetic_energy = 0.5 * config.mass * np.sum(velocities**2) + p_kin = 2 / (3 * V) * kinetic_energy + + # Term 1 + p0 = -1 / V * np.sum(w) + + # Term 2 + if psi is not None: # if using electrostatics + V_bar = np.array([hamiltonian.V_bar[k]([phi, psi]) for k in range(config.n_types)]) + else: + V_bar = np.array([hamiltonian.V_bar_0[k](phi) for k in range(config.n_types)]) + + p1 = np.sum((volume_per_cell / V) * V_bar * phi) + + # Term 3 + comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, + ) + + p2 = np.sum( + volume_per_cell + / V + * config.sigma**2 + * np.repeat(V_bar[:, np.newaxis, :, :, :], 3, axis=1) + * phi_laplacian, + axis=(0, 2, 3, 4), + ) + + # Bonded force term: linking 2 particles + p_bond = bond_pr / V + + # Angle force term: linking 3 particles + p_angle = angle_pr / V + + # TODO: Dihedral angle force term: linking 4 atoms + p_dihedral = np.zeros(3) + + # Add formal parameter dihedral_forces as: comp_pressure(..., dihedral_forces) + # Define dictionary: + # forces = { + # 'x': dihedral_forces[:,0], + # 'y': dihedral_forces[:,1], + # 'z': dihedral_forces[:,2] + # } + # Compute the pressure due to dihedrals as: + # p_dihedral = { + # 'x': np.sum( np.multiply(forces['x'],positions[:,0]) )*(1/V), + # 'y': np.sum( np.multiply(forces['y'],positions[:,1]) )*(1/V), + # 'z': np.sum( np.multiply(forces['z'],positions[:,2]) )*(1/V) + # } + + # Total pressure in x, y, z + p_tot = p_kin + p0 + p1 + p2 + p_bond + p_angle + p_dihedral + + return_value = np.array( + [ + p_kin, + p0, + p1, + p2[0], + p2[1], + p2[2], + p_bond[0], + p_bond[1], + p_bond[2], + p_angle[0], + p_angle[1], + p_angle[2], + p_dihedral[0], + p_dihedral[1], + p_dihedral[2], + p_tot[0], + p_tot[1], + p_tot[2], + ] + ) + return_value = comm.allreduce(return_value, MPI.SUM) + + return return_value
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/_modules/hymd/thermostat.html b/v2.0.0/_modules/hymd/thermostat.html new file mode 100644 index 00000000..cbed71c9 --- /dev/null +++ b/v2.0.0/_modules/hymd/thermostat.html @@ -0,0 +1,509 @@ + + + + + + hymd.thermostat — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.thermostat

+"""Scales or otherwise modifies the particle velocities during simulation to
+simulate coupling to an external heat bath with temperature T₀.
+"""
+import numpy as np
+import logging
+from mpi4py import MPI
+from typing import Callable
+from .logger import Logger
+from .input_parser import Config
+
+
+def cancel_com_momentum(velocities, config, comm=MPI.COMM_WORLD):
+    com_velocity = comm.allreduce(np.sum(velocities[...], axis=0), MPI.SUM)
+    velocities[...] = velocities[...] - com_velocity / config.n_particles
+    return velocities
+
+
+def generate_initial_velocities(velocities, config, prng, comm=MPI.COMM_WORLD):
+    kT_start = config.gas_constant * config.start_temperature
+    n_particles_ = velocities.shape[0]
+    velocities[...] = prng.normal(
+        loc=0, scale=kT_start / config.mass, size=(n_particles_, 3)
+    )
+    velocities = cancel_com_momentum(velocities, config, comm=comm)
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    start_kinetic_energy_target = (
+        1.5 * config.gas_constant * config.n_particles * config.start_temperature
+    )
+    factor = np.sqrt(1.5 * config.n_particles * kT_start / kinetic_energy)
+    velocities[...] = velocities[...] * factor
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    Logger.rank0.log(
+        logging.INFO,
+        (
+            f"Initialized {config.n_particles} velocities, target kinetic "
+            f"energy: {start_kinetic_energy_target}, actual kinetic energy "
+            f"generated: {kinetic_energy}"
+        ),
+    )
+    return velocities
+
+
+
[docs]def _random_gaussian(prng: np.random.Generator) -> float: + """Draw a single random number from the standard normal distribution + Generate a number from the Gaussian distribution centered at zero with unit + standard deviation, :math:`N(0, 1)`. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + + Returns + ------- + float + A random number drawn from :math:`N(0, 1)`. + """ + return prng.normal()
+ + +
[docs]def _random_chi_squared(prng: np.random.Generator, M: int) -> float: + """Draw the sum of :code:`M` squared normally distributed values + + The value is generated by the Gamma distribution, in lieu of generating + :code:`M` Gaussian distributed numbers and summing their squares. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + M : int + Number of standard normally distributed numbers in the sum. + + Returns + ------- + float + The sum of :code:`M` squared normally distributed values centered at + zero with unit standard deviation. + + Notes + ----- + The sum of the squares of k independent standard normal random variables is + distributed according to a :math:`\\chi^2` distribution. + + .. math:: + + \\chi^2_1 + \\chi_2^2 + \\chi_3^2 + \\dots + \\chi_M^2 + \\sim + \\sigma^2\\chi^2(k) + + This is a special case of the :math:`\\Gamma` distribution, + :math:`\\Gamma(k/2, 2)`, and may be generated by + + .. math:: + + \\chi^2(k) \\sim 2 \\Gamma(k/2, 2) + + References + ---------- + Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of + Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. + J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246. + """ + return prng.chisquare(M)
+ + +
[docs]def csvr_thermostat( + velocity: np.ndarray, + names: np.ndarray, + config: Config, + prng: np.random.Generator, + comm: MPI.Intracomm = MPI.COMM_WORLD, + random_gaussian: Callable[[np.random.Generator], float] = _random_gaussian, + random_chi_squared: Callable[ + [np.random.Generator, int, float], float + ] = _random_chi_squared, + remove_center_of_mass_momentum: bool = True, +) -> np.ndarray: + """Canonical sampling through velocity rescaling thermostat + + Implements the CSVR thermostat. Rescales the system kinetic energy by a + stochastically chosen factor to keep the temperature constant. Requires + communcation of the kinetic energies calculated locally for each MPI rank. + The random numbers sampled through :code:`random_gaussian` and + :code:`random_chi_squared` are broadcast from the root rank to the other + ranks to ensure the scaling is performed with the same stochasticity for + all particles in the full system. + + The velocities are cleaned of center of mass momentum before the thermostat + is applied, and the center of mass momentum is subsequently reapplied. This + is performed for each thermostat coupling group, i.e. the center of mass + momenta of each *group* is separately removed and reapplied after + thermostatting. + + The implementation here is based on the derivation presented in the 2008 + Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper. + + Parameters + ---------- + velocity : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + names : (N,) numpy.ndarray + Array of particle names. + config : Config + Configuration dataclass containing simulation metadata and parameters. + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + random_gaussian : callable, optional + Function for generating standard normally distributed numbers. + random_chi_squared : callable, optional + Function for generating :math:`\\chi^2`-distributed numbers + remove_center_of_mass_momentum : bool, optional + If True, the center of mass of each coupling group is removed before + the thermostat is applied. The center of mass momenta are added back + after the kinetic energy rescaling is complete. + + See Also + -------- + _random_gaussian : + Used to sample Gaussian-distributed numbers. + _random_chi_squared : + Used to sample :math:`\\chi^2`-distributed numbers. + hymd.input_parser.Config : + Configuration dataclass handler. + + References + ---------- + G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). + G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008). + """ + if not any(config.thermostat_coupling_groups): + config.thermostat_coupling_groups = [config.unique_names.copy()] + for i, group in enumerate(config.thermostat_coupling_groups): + ind = np.where( + np.logical_or.reduce(list(names == np.string_(t) for t in group)) + ) + group_n_particles = comm.allreduce(len(ind[0]), MPI.SUM) + + # Clean velocities of center of mass momentum + if remove_center_of_mass_momentum and group_n_particles > 1: + com_velocity = comm.allreduce(np.sum(velocity[ind], axis=0)) + velocity_clean = velocity[ind] - com_velocity / group_n_particles + K = comm.allreduce(0.5 * config.mass * np.sum(velocity_clean[...] ** 2)) + else: + K = comm.allreduce(0.5 * config.mass * np.sum(velocity[...] ** 2)) + K_target = ( + 1.5 * config.gas_constant * group_n_particles * config.target_temperature + ) + N_f = 3 * group_n_particles + c = np.exp(-(config.time_step * config.respa_inner) / config.tau) + + # Random numbers are identical across ranks because all ranks have + # the same prng after the initialization of the velocities + R = random_gaussian(prng) + SNf = random_chi_squared(prng, N_f - 1) + + alpha2 = ( + c + + (1 - c) * (SNf + R**2) * K_target / (N_f * K) + + 2 * R * np.sqrt(c * (1 - c) * K_target / (N_f * K)) + ) + dK = K * (alpha2 - 1) + alpha = np.sqrt(alpha2) + + if remove_center_of_mass_momentum and group_n_particles > 1: + # Assign velocities and reapply the previously removed center + # of mass momentum removed + velocity_clean *= alpha + velocity[ind] = velocity_clean + com_velocity / group_n_particles + else: + velocity *= alpha + config.thermostat_work += dK
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/_modules/index.html b/v2.0.0/_modules/index.html new file mode 100644 index 00000000..6c928798 --- /dev/null +++ b/v2.0.0/_modules/index.html @@ -0,0 +1,299 @@ + + + + + + Overview: module code — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/v2.0.0/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css new file mode 100644 index 00000000..1b057df2 --- /dev/null +++ b/v2.0.0/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css @@ -0,0 +1 @@ +.badge{border-radius:.25rem;display:inline-block;font-size:75%;font-weight:700;line-height:1;padding:.25em .4em;text-align:center;vertical-align:baseline;white-space:nowrap}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{border-radius:10rem;padding-left:.6em;padding-right:.6em}.badge-primary{background-color:#007bff;color:#fff}.badge-primary[href]:focus,.badge-primary[href]:hover{background-color:#0062cc;color:#fff;text-decoration:none}.badge-secondary{background-color:#6c757d;color:#fff}.badge-secondary[href]:focus,.badge-secondary[href]:hover{background-color:#545b62;color:#fff;text-decoration:none}.badge-success{background-color:#28a745;color:#fff}.badge-success[href]:focus,.badge-success[href]:hover{background-color:#1e7e34;color:#fff;text-decoration:none}.badge-info{background-color:#17a2b8;color:#fff}.badge-info[href]:focus,.badge-info[href]:hover{background-color:#117a8b;color:#fff;text-decoration:none}.badge-warning{background-color:#ffc107;color:#212529}.badge-warning[href]:focus,.badge-warning[href]:hover{background-color:#d39e00;color:#212529;text-decoration:none}.badge-danger{background-color:#dc3545;color:#fff}.badge-danger[href]:focus,.badge-danger[href]:hover{background-color:#bd2130;color:#fff;text-decoration:none}.badge-light{background-color:#f8f9fa;color:#212529}.badge-light[href]:focus,.badge-light[href]:hover{background-color:#dae0e5;color:#212529;text-decoration:none}.badge-dark{background-color:#343a40;color:#fff}.badge-dark[href]:focus,.badge-dark[href]:hover{background-color:#1d2124;color:#fff;text-decoration:none}.border-0{border:0 !important}.border-top-0{border-top:0 !important}.border-right-0{border-right:0 !important}.border-bottom-0{border-bottom:0 !important}.border-left-0{border-left:0 !important}.p-0{padding:0 !important}.pt-0,.py-0{padding-top:0 !important}.pr-0,.px-0{padding-right:0 !important}.pb-0,.py-0{padding-bottom:0 !important}.pl-0,.px-0{padding-left:0 !important}.p-1{padding:.25rem !important}.pt-1,.py-1{padding-top:.25rem !important}.pr-1,.px-1{padding-right:.25rem !important}.pb-1,.py-1{padding-bottom:.25rem !important}.pl-1,.px-1{padding-left:.25rem !important}.p-2{padding:.5rem !important}.pt-2,.py-2{padding-top:.5rem !important}.pr-2,.px-2{padding-right:.5rem !important}.pb-2,.py-2{padding-bottom:.5rem !important}.pl-2,.px-2{padding-left:.5rem !important}.p-3{padding:1rem !important}.pt-3,.py-3{padding-top:1rem !important}.pr-3,.px-3{padding-right:1rem !important}.pb-3,.py-3{padding-bottom:1rem !important}.pl-3,.px-3{padding-left:1rem !important}.p-4{padding:1.5rem !important}.pt-4,.py-4{padding-top:1.5rem !important}.pr-4,.px-4{padding-right:1.5rem !important}.pb-4,.py-4{padding-bottom:1.5rem !important}.pl-4,.px-4{padding-left:1.5rem !important}.p-5{padding:3rem !important}.pt-5,.py-5{padding-top:3rem !important}.pr-5,.px-5{padding-right:3rem !important}.pb-5,.py-5{padding-bottom:3rem !important}.pl-5,.px-5{padding-left:3rem !important}.m-0{margin:0 !important}.mt-0,.my-0{margin-top:0 !important}.mr-0,.mx-0{margin-right:0 !important}.mb-0,.my-0{margin-bottom:0 !important}.ml-0,.mx-0{margin-left:0 !important}.m-1{margin:.25rem !important}.mt-1,.my-1{margin-top:.25rem !important}.mr-1,.mx-1{margin-right:.25rem !important}.mb-1,.my-1{margin-bottom:.25rem !important}.ml-1,.mx-1{margin-left:.25rem !important}.m-2{margin:.5rem !important}.mt-2,.my-2{margin-top:.5rem !important}.mr-2,.mx-2{margin-right:.5rem !important}.mb-2,.my-2{margin-bottom:.5rem !important}.ml-2,.mx-2{margin-left:.5rem !important}.m-3{margin:1rem !important}.mt-3,.my-3{margin-top:1rem !important}.mr-3,.mx-3{margin-right:1rem !important}.mb-3,.my-3{margin-bottom:1rem !important}.ml-3,.mx-3{margin-left:1rem !important}.m-4{margin:1.5rem !important}.mt-4,.my-4{margin-top:1.5rem !important}.mr-4,.mx-4{margin-right:1.5rem !important}.mb-4,.my-4{margin-bottom:1.5rem !important}.ml-4,.mx-4{margin-left:1.5rem !important}.m-5{margin:3rem !important}.mt-5,.my-5{margin-top:3rem !important}.mr-5,.mx-5{margin-right:3rem !important}.mb-5,.my-5{margin-bottom:3rem !important}.ml-5,.mx-5{margin-left:3rem !important}.btn{background-color:transparent;border:1px solid transparent;border-radius:.25rem;color:#212529;cursor:pointer;display:inline-block;font-size:1rem;font-weight:400;line-height:1.5;padding:.375rem .75rem;text-align:center;transition:color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none;vertical-align:middle}.btn:hover{color:#212529;text-decoration:none}.btn:visited{color:#212529}.btn.focus,.btn:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.25);outline:0}.btn.disabled,.btn:disabled{opacity:.65}@media (prefers-reduced-motion: reduce){.btn{transition:none}}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary:visited{color:#fff}.btn-primary:hover{background-color:#0069d9;border-color:#0062cc;color:#fff}.btn-primary.focus,.btn-primary:focus{background-color:#0069d9;border-color:#0062cc;box-shadow:0 0 0 .2rem rgba(0,123,255,0.5);color:#fff}.btn-primary.disabled,.btn-primary:disabled{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary.active:not(:disabled):not(.disabled),.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{background-color:#0062cc;border-color:#005cbf;color:#fff}.btn-primary.active:not(:disabled):not(.disabled):focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-secondary{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary:visited{color:#fff}.btn-secondary:hover{background-color:#5a6268;border-color:#545b62;color:#fff}.btn-secondary.focus,.btn-secondary:focus{background-color:#5a6268;border-color:#545b62;box-shadow:0 0 0 .2rem rgba(108,117,125,0.5);color:#fff}.btn-secondary.disabled,.btn-secondary:disabled{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled),.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{background-color:#545b62;border-color:#4e555b;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled):focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-success{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success:visited{color:#fff}.btn-success:hover{background-color:#218838;border-color:#1e7e34;color:#fff}.btn-success.focus,.btn-success:focus{background-color:#218838;border-color:#1e7e34;box-shadow:0 0 0 .2rem rgba(40,167,69,0.5);color:#fff}.btn-success.disabled,.btn-success:disabled{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success.active:not(:disabled):not(.disabled),.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{background-color:#1e7e34;border-color:#1c7430;color:#fff}.btn-success.active:not(:disabled):not(.disabled):focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-info{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info:visited{color:#fff}.btn-info:hover{background-color:#138496;border-color:#117a8b;color:#fff}.btn-info.focus,.btn-info:focus{background-color:#138496;border-color:#117a8b;box-shadow:0 0 0 .2rem rgba(23,162,184,0.5);color:#fff}.btn-info.disabled,.btn-info:disabled{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info.active:not(:disabled):not(.disabled),.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{background-color:#117a8b;border-color:#10707f;color:#fff}.btn-info.active:not(:disabled):not(.disabled):focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-warning{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning:visited{color:#212529}.btn-warning:hover{background-color:#e0a800;border-color:#d39e00;color:#212529}.btn-warning.focus,.btn-warning:focus{background-color:#e0a800;border-color:#d39e00;box-shadow:0 0 0 .2rem rgba(255,193,7,0.5);color:#212529}.btn-warning.disabled,.btn-warning:disabled{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning.active:not(:disabled):not(.disabled),.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{background-color:#d39e00;border-color:#c69500;color:#212529}.btn-warning.active:not(:disabled):not(.disabled):focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-danger{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger:visited{color:#fff}.btn-danger:hover{background-color:#c82333;border-color:#bd2130;color:#fff}.btn-danger.focus,.btn-danger:focus{background-color:#c82333;border-color:#bd2130;box-shadow:0 0 0 .2rem rgba(220,53,69,0.5);color:#fff}.btn-danger.disabled,.btn-danger:disabled{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger.active:not(:disabled):not(.disabled),.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{background-color:#bd2130;border-color:#b21f2d;color:#fff}.btn-danger.active:not(:disabled):not(.disabled):focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-light{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light:visited{color:#212529}.btn-light:hover{background-color:#e2e6ea;border-color:#dae0e5;color:#212529}.btn-light.focus,.btn-light:focus{background-color:#e2e6ea;border-color:#dae0e5;box-shadow:0 0 0 .2rem rgba(248,249,250,0.5);color:#212529}.btn-light.disabled,.btn-light:disabled{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light.active:not(:disabled):not(.disabled),.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{background-color:#dae0e5;border-color:#d3d9df;color:#212529}.btn-light.active:not(:disabled):not(.disabled):focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-dark{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark:visited{color:#fff}.btn-dark:hover{background-color:#23272b;border-color:#1d2124;color:#fff}.btn-dark.focus,.btn-dark:focus{background-color:#23272b;border-color:#1d2124;box-shadow:0 0 0 .2rem rgba(52,58,64,0.5);color:#fff}.btn-dark.disabled,.btn-dark:disabled{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark.active:not(:disabled):not(.disabled),.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{background-color:#1d2124;border-color:#171a1d;color:#fff}.btn-dark.active:not(:disabled):not(.disabled):focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-primary{border-color:#007bff;color:#007bff}.btn-outline-primary:visited{color:#007bff}.btn-outline-primary:hover{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{background-color:transparent;color:#007bff}.btn-outline-primary.active:not(:disabled):not(.disabled),.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.active:not(:disabled):not(.disabled):focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-secondary{border-color:#6c757d;color:#6c757d}.btn-outline-secondary:visited{color:#6c757d}.btn-outline-secondary:hover{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{background-color:transparent;color:#6c757d}.btn-outline-secondary.active:not(:disabled):not(.disabled),.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.active:not(:disabled):not(.disabled):focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-success{border-color:#28a745;color:#28a745}.btn-outline-success:visited{color:#28a745}.btn-outline-success:hover{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{background-color:transparent;color:#28a745}.btn-outline-success.active:not(:disabled):not(.disabled),.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.active:not(:disabled):not(.disabled):focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-info{border-color:#17a2b8;color:#17a2b8}.btn-outline-info:visited{color:#17a2b8}.btn-outline-info:hover{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{background-color:transparent;color:#17a2b8}.btn-outline-info.active:not(:disabled):not(.disabled),.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.active:not(:disabled):not(.disabled):focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-warning{border-color:#ffc107;color:#ffc107}.btn-outline-warning:visited{color:#ffc107}.btn-outline-warning:hover{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{background-color:transparent;color:#ffc107}.btn-outline-warning.active:not(:disabled):not(.disabled),.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.active:not(:disabled):not(.disabled):focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-danger{border-color:#dc3545;color:#dc3545}.btn-outline-danger:visited{color:#dc3545}.btn-outline-danger:hover{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{background-color:transparent;color:#dc3545}.btn-outline-danger.active:not(:disabled):not(.disabled),.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.active:not(:disabled):not(.disabled):focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-light{border-color:#f8f9fa;color:#f8f9fa}.btn-outline-light:visited{color:#f8f9fa}.btn-outline-light:hover{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{background-color:transparent;color:#f8f9fa}.btn-outline-light.active:not(:disabled):not(.disabled),.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.active:not(:disabled):not(.disabled):focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-dark{border-color:#343a40;color:#343a40}.btn-outline-dark:visited{color:#343a40}.btn-outline-dark:hover{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{background-color:transparent;color:#343a40}.btn-outline-dark.active:not(:disabled):not(.disabled),.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.active:not(:disabled):not(.disabled):focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-link{color:#007bff;font-weight:400;text-decoration:none}.btn-link:hover{color:#0056b3;text-decoration:underline}.btn-link.focus,.btn-link:focus{box-shadow:none;text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{border-radius:.3rem;font-size:1.25rem;line-height:1.5;padding:.5rem 1rem}.btn-group-sm>.btn,.btn-sm{border-radius:.2rem;font-size:.875rem;line-height:1.5;padding:.25rem .5rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input.btn-block[type=button],input.btn-block[type=reset],input.btn-block[type=submit]{width:100%}.stretched-link::after{background-color:rgba(0,0,0,0);bottom:0;content:'';left:0;pointer-events:auto;position:absolute;right:0;top:0;z-index:1}.text-wrap{white-space:normal !important}.card{background-clip:border-box;background-color:#fff;border:1px solid rgba(0,0,0,0.125);border-radius:.25rem;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;min-width:0;position:relative;word-wrap:break-word}.card>hr{margin-left:0;margin-right:0}.card>.list-group:first-child .list-group-item:first-child{border-top-left-radius:.25rem;border-top-right-radius:.25rem}.card>.list-group:last-child .list-group-item:last-child{border-bottom-left-radius:.25rem;border-bottom-right-radius:.25rem}.card-body{-ms-flex:1 1 auto;flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-bottom:0;margin-top:-.375rem}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{background-color:rgba(0,0,0,0.03);border-bottom:1px solid rgba(0,0,0,0.125);margin-bottom:0;padding:.75rem 1.25rem}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-header+.list-group .list-group-item:first-child{border-top:0}.card-footer{background-color:rgba(0,0,0,0.03);border-top:1px solid rgba(0,0,0,0.125);padding:.75rem 1.25rem}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{border-bottom:0;margin-bottom:-.75rem;margin-left:-.625rem;margin-right:-.625rem}.card-header-pills{margin-left:-.625rem;margin-right:-.625rem}.card-img-overlay{bottom:0;left:0;padding:1.25rem;position:absolute;right:0;top:0}.card-img,.card-img-bottom,.card-img-top{-ms-flex-negative:0;flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-left-radius:calc(.25rem - 1px);border-bottom-right-radius:calc(.25rem - 1px)}.w-100{width:100% !important}.shadow{box-shadow:0 0.5rem 1rem rgba(0,0,0,0.15) !important}.bg-primary{background-color:#007bff !important}button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc !important}a.bg-primary:focus,a.bg-primary:hover{background-color:#0062cc !important}a.text-primary:focus,a.text-primary:hover{color:#121416 !important}.bg-secondary{background-color:#6c757d !important}button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62 !important}a.bg-secondary:focus,a.bg-secondary:hover{background-color:#545b62 !important}a.text-secondary:focus,a.text-secondary:hover{color:#121416 !important}.bg-success{background-color:#28a745 !important}button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34 !important}a.bg-success:focus,a.bg-success:hover{background-color:#1e7e34 !important}a.text-success:focus,a.text-success:hover{color:#121416 !important}.bg-info{background-color:#17a2b8 !important}button.bg-info:focus,button.bg-info:hover{background-color:#117a8b !important}a.bg-info:focus,a.bg-info:hover{background-color:#117a8b !important}a.text-info:focus,a.text-info:hover{color:#121416 !important}.bg-warning{background-color:#ffc107 !important}button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00 !important}a.bg-warning:focus,a.bg-warning:hover{background-color:#d39e00 !important}a.text-warning:focus,a.text-warning:hover{color:#121416 !important}.bg-danger{background-color:#dc3545 !important}button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130 !important}a.bg-danger:focus,a.bg-danger:hover{background-color:#bd2130 !important}a.text-danger:focus,a.text-danger:hover{color:#121416 !important}.bg-light{background-color:#f8f9fa !important}button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5 !important}a.bg-light:focus,a.bg-light:hover{background-color:#dae0e5 !important}a.text-light:focus,a.text-light:hover{color:#121416 !important}.bg-dark{background-color:#343a40 !important}button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124 !important}a.bg-dark:focus,a.bg-dark:hover{background-color:#1d2124 !important}a.text-dark:focus,a.text-dark:hover{color:#121416 !important}.bg-white{background-color:#fff !important}button.bg-white:focus,button.bg-white:hover{background-color:#e6e6e6 !important}a.bg-white:focus,a.bg-white:hover{background-color:#e6e6e6 !important}a.text-white:focus,a.text-white:hover{color:#121416 !important}.text-primary{color:#007bff !important}.text-secondary{color:#6c757d !important}.text-success{color:#28a745 !important}.text-info{color:#17a2b8 !important}.text-warning{color:#ffc107 !important}.text-danger{color:#dc3545 !important}.text-light{color:#f8f9fa !important}.text-dark{color:#343a40 !important}.text-white{color:#fff !important}.text-body{color:#212529 !important}.text-muted{color:#6c757d !important}.text-black-50{color:rgba(0,0,0,0.5) !important}.text-white-50{color:rgba(255,255,255,0.5) !important}.bg-transparent{background-color:transparent !important}.text-justify{text-align:justify !important}.text-left{text-align:left !important}.text-right{text-align:right !important}.text-center{text-align:center !important}.font-weight-light{font-weight:300 !important}.font-weight-lighter{font-weight:lighter !important}.font-weight-normal{font-weight:400 !important}.font-weight-bold{font-weight:700 !important}.font-weight-bolder{font-weight:bolder !important}.font-italic{font-style:italic !important}.container{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container{max-width:540px}}@media (min-width: 768px){.container{max-width:720px}}@media (min-width: 992px){.container{max-width:960px}}@media (min-width: 1200px){.container{max-width:1140px}}.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container,.container-sm{max-width:540px}}@media (min-width: 768px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width: 992px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width: 1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1140px}}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;margin-right:-15px}.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{padding-left:15px;padding-right:15px;position:relative;width:100%}@media (min-width: 576px){.col-sm{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-sm-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-sm-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-sm-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-sm-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-sm-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 768px){.col-md{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-md-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-md-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-md-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-md-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-md-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 992px){.col-lg{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-lg-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-lg-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-lg-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-lg-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-lg-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 1200px){.col-xl{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-xl-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-xl-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-xl-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-xl-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-xl-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}.d-flex{display:-ms-flexbox !important;display:flex !important}.sphinx-bs,.sphinx-bs *{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sphinx-bs p{margin-top:0} diff --git a/v2.0.0/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/v2.0.0/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css new file mode 100644 index 00000000..fc14abc8 --- /dev/null +++ b/v2.0.0/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css @@ -0,0 +1 @@ +details.dropdown .summary-title{padding-right:3em !important;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none}details.dropdown:hover{cursor:pointer}details.dropdown .summary-content{cursor:default}details.dropdown summary{list-style:none;padding:1em}details.dropdown summary .octicon.no-title{vertical-align:middle}details.dropdown[open] summary .octicon.no-title{visibility:hidden}details.dropdown summary::-webkit-details-marker{display:none}details.dropdown summary:focus{outline:none}details.dropdown summary:hover .summary-up svg,details.dropdown summary:hover .summary-down svg{opacity:1}details.dropdown .summary-up svg,details.dropdown .summary-down svg{display:block;opacity:.6}details.dropdown .summary-up,details.dropdown .summary-down{pointer-events:none;position:absolute;right:1em;top:.75em}details.dropdown[open] .summary-down{visibility:hidden}details.dropdown:not([open]) .summary-up{visibility:hidden}details.dropdown.fade-in[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out;animation:panels-fade-in .5s ease-in-out}details.dropdown.fade-in-slide-down[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out}@keyframes panels-fade-in{0%{opacity:0}100%{opacity:1}}@keyframes panels-slide-down{0%{transform:translate(0, -10px)}100%{transform:translate(0, 0)}}.octicon{display:inline-block;fill:currentColor;vertical-align:text-top}.tabbed-content{box-shadow:0 -.0625rem var(--tabs-color-overline),0 .0625rem var(--tabs-color-underline);display:none;order:99;padding-bottom:.75rem;padding-top:.75rem;width:100%}.tabbed-content>:first-child{margin-top:0 !important}.tabbed-content>:last-child{margin-bottom:0 !important}.tabbed-content>.tabbed-set{margin:0}.tabbed-set{border-radius:.125rem;display:flex;flex-wrap:wrap;margin:1em 0;position:relative}.tabbed-set>input{opacity:0;position:absolute}.tabbed-set>input:checked+label{border-color:var(--tabs-color-label-active);color:var(--tabs-color-label-active)}.tabbed-set>input:checked+label+.tabbed-content{display:block}.tabbed-set>input:focus+label{outline-style:auto}.tabbed-set>input:not(.focus-visible)+label{outline:none;-webkit-tap-highlight-color:transparent}.tabbed-set>label{border-bottom:.125rem solid transparent;color:var(--tabs-color-label-inactive);cursor:pointer;font-size:var(--tabs-size-label);font-weight:700;padding:1em 1.25em .5em;transition:color 250ms;width:auto;z-index:1}html .tabbed-set>label:hover{color:var(--tabs-color-label-active)} diff --git a/v2.0.0/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css b/v2.0.0/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css new file mode 100644 index 00000000..adc61662 --- /dev/null +++ b/v2.0.0/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css @@ -0,0 +1,7 @@ +:root { +--tabs-color-label-active: hsla(231, 99%, 66%, 1); +--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); +--tabs-color-overline: rgb(207, 236, 238); +--tabs-color-underline: rgb(207, 236, 238); +--tabs-size-label: 1rem; +} \ No newline at end of file diff --git a/v2.0.0/_sources/doc_pages/api.rst.txt b/v2.0.0/_sources/doc_pages/api.rst.txt new file mode 100644 index 00000000..40f0838c --- /dev/null +++ b/v2.0.0/_sources/doc_pages/api.rst.txt @@ -0,0 +1,116 @@ +.. _api-label: + + +API reference +============= + +Integrator +---------- + +.. automodule:: hymd.integrator + :members: + + +Thermostat +---------- + +.. automodule:: hymd.thermostat + :members: csvr_thermostat, _random_chi_squared, _random_gaussian + :undoc-members: + + +Barostat +-------- + +Berendsen Barostat +^^^^^^^^^^^^^^^^^^ + +.. automodule:: hymd.barostat + :members: isotropic, semiisotropic + :undoc-members: + +SCR Barostat +^^^^^^^^^^^^^^^^^^ + +.. automodule:: hymd.barostat_bussi + :members: isotropic, semiisotropic + :undoc-members: + + +Hamiltonian +----------- + +.. autoclass:: hymd.hamiltonian.Hamiltonian + :members: + + .. automethod:: __init__ + + .. automethod:: _setup + +.. autoclass:: hymd.hamiltonian.SquaredPhi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultNoChi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultWithChi + :members: + + .. automethod:: __init__ + + +Force +----- + +.. automodule:: hymd.force + :members: + :undoc-members: + + +Pressure +-------- + +.. automodule:: hymd.pressure + :members: comp_pressure + :undoc-members: + + +Logger +------ + +.. autoclass:: hymd.logger.Logger + :members: + +.. autoclass:: hymd.logger.MPIFilterRoot + :members: + +.. autoclass:: hymd.logger.MPIFilterAll + :members: + + +Input parser +------------ + +.. automodule:: hymd.input_parser + :members: + :undoc-members: propensity_potential_coeffs + + +Field +----- + +.. automodule:: hymd.field + :members: + + +File input/output +----------------- + +.. automodule:: hymd.file_io + :members: diff --git a/v2.0.0/_sources/doc_pages/benchmarks.rst.txt b/v2.0.0/_sources/doc_pages/benchmarks.rst.txt new file mode 100644 index 00000000..06377a85 --- /dev/null +++ b/v2.0.0/_sources/doc_pages/benchmarks.rst.txt @@ -0,0 +1,93 @@ +.. _benchmarks-label: + +Benchmarks +########## +Homopolymer melt test systems of :math:`30^2`, :math:`40^2`, and :math:`50^2` +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively. + +Bonded forces +^^^^^^^^^^^^^ +Legend label denotes the number of particles in the system. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) + time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 + ], dtype=np.float64) + nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 + ], dtype=np.float64,) + time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, + ], dtype=np.float64) + nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 + ], dtype=np.float64) + time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, + ], dtype=np.float64) + plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" + ) + plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" + ) + plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" + ) + plt.xlabel("CPUs", fontsize=15) + plt.ylabel("Time per step, us", fontsize=15) + plt.legend(fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.show() + + +Particle--field forces +^^^^^^^^^^^^^^^^^^^^^^ +Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + + mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] + mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + + mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + + mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + + mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] + mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + + mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + + mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + + plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") + plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") + plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") + plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") + plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") + plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") + plt.xlabel("CPUs", fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.ylabel("Time per step, s", fontsize=15) + plt.legend(loc="upper left", fontsize=15) + plt.show() diff --git a/v2.0.0/_sources/doc_pages/command_line.rst.txt b/v2.0.0/_sources/doc_pages/command_line.rst.txt new file mode 100644 index 00000000..5233710f --- /dev/null +++ b/v2.0.0/_sources/doc_pages/command_line.rst.txt @@ -0,0 +1,120 @@ +.. _commandline-label: + +Command line arguments +###################### +Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle--field interactions. + + +Required arguments +================== +:configuration file: + :code:`type` positional + + Specifies the :code:`.toml` format configuration file containing simulation details. See :ref:`config-label` for details. + +:structure and topology file: + :code:`type` positional + + Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See :ref:`topology-label` for details. + +Optional arguments +================== +:code:`-v --verbose` + :code:`type` optional + + Number of following arguments: :code:`0` or :code:`1` + + Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying :code:`-v` or :code:`--verbose` with no additional specification. This increases verbosity level by :code:`1`. Alternatively, it maye be specified by :code:`--verbose V` with :code:`V` being :code:`0`, :code:`1`, or :code:`2`. + +:code:`--profile` + :code:`type` optional + + Number of following arguments: :code:`0` + + Enables code profiling using :code:`cProfile`. This will output one profiling file per MPI rank invoked in the simulation. + +:code:`--double-precision` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision internally in HyMD (including in the FFTs). + +:code:`--double-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision in the output trajectory from HyMD. + +:code:`--velocity-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that velocities should be output to the HyMD trajectory. + +:code:`--force-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that forces should be output to the HyMD trajectory. + +:code:`--disable-mpio` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult. + +:code:`--logfile` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the path of a plain text log file in which stdout is mirrored during simulation runs. + +:code:`--seed` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the random seed used in the :code:`numpy` random library to generate velocities, thermostatting, etc. + +:code:`--disable-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any two-particle bonds present in the system. + +:code:`--disable-angle-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any three-particle bonds present in the system. + +:code:`--disable-dihedrals` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any four-particle bonds present in the system. + +:code:`--disable-dipole` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any topological reconstruction of peptide backbone dipoles present in the system. + +:code:`--disable-field` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any particle--field interactions present in the system. diff --git a/v2.0.0/_sources/doc_pages/config_file.rst.txt b/v2.0.0/_sources/doc_pages/config_file.rst.txt new file mode 100644 index 00000000..2ee880b7 --- /dev/null +++ b/v2.0.0/_sources/doc_pages/config_file.rst.txt @@ -0,0 +1,244 @@ +.. _config-label: + +Configuration file +################## +The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order. + +The configuration file is a `toml`_ format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs. + +.. _`toml`: + https://github.com/toml-lang/toml + +.. role:: required + +Configuration file keywords +--------------------------- + +The following constitutes every possible keyword specification in HyMD +configuration files: + +Metadata keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying metadata for the H5MD output trajectory. + +:name: + :code:`string` [**optional**, default: :code:`None`] + + Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file. + + +:tags: + :code:`array` [:code:`string`] [**optional**, default: :code:`None`] + + Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file. + + +Particle keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying properties of particles and molecules in the +system. + +:n_particles: + :code:`integer` [**optional**, default: :code:`None`] + + Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules. + +:mass: + :code:`float` [**optional**, default: :code:`72.0`] {units: :math:`\text{u}=\text{g}\,\text{mol}^{-1}`} + + Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal. + +:max_molecule_size: + :code:`integer` [**optional**, default: :code:`201`] + + Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code **will** crash if there are molecules larger than :code:`max_molecule_size` in the topology/structure input file. + + +Simulation keywords +^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying simulation parameters. + +:n_steps: + :code:`integer` [:required:`required`] + + Total number of integration steps to perform for this simulation. + +:n_print: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of *number of time steps*). + +:n_flush: + :code:`integer` [**optional**, default: :code:`None`] + + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of *number of* :code:`n_print`, i.e. :code:`n_print = 13`, :code:`n_flush = 3` would result in the trajectory/energy being written to disk every :code:`13 x 3 = 39` *simulation steps*) + +:time_step: + :code:`float` [:required:`required`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time step per integration step. If the rRESPA multiple time step integrator is used (:code:`integrator = "respa"`), this specifies the **inner** time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is :code:`respa_inner` times the :code:`time_step` , and the total simulation time is :code:`n_steps` times :code:`time_step` times :code:`respa_inner` . + +:box_size: + :code:`array` [:code:`float`] [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable. + +:integrator: + :code:`string` [:required:`required`] (options: :code:`velocity-verlet` or :code:`respa`) + + Specifies the time integrator used in the simulation. If :code:`respa`, the *reversible reference system propagator algorithm (rRESPA)* :cite:`tuckerman1992reversible` integrator is used, with :code:`respa_inner` number of inner (intramolecular force) time steps. If :code:`velocity-verlet`, a normal Velocity Verlet integrator is used. If :code:`respa` and :code:`respa_inner = 1`, the rRESPA integrator is equivalent to the Velocity Verlet. + +:respa_inner: + :code:`integer` [**optional**, default: :code:`1`] + + The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces. + +:domain_decomposition: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Specifies the interval (in time steps) of *domain decomposition exchange*, involving all MPI ranks sending and receiving particles according to the particles' positions in the integration box and the MPI ranks' assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If :code:`True`, the decomposition is performed once (before starting the simulation). If :code:`False`, no decomposition is performed. + +:cancel_com_momentum: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + If :code:`True`, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every :code:`remove_com_momentum` time steps. If :code:`False`, the linear momentum is never removed. + +:start_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at :code:`start_temperature` Kelvin prior to starting the simulation. If :code:`False`, the velocities are not changed before starting the simulation. + +:target_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Couple the system to a heat bath at :code:`target_temperature` Kelvin by applying a *Canonical sampling through velocity rescaling* :cite:`Bussi2007JCP` thermostat with coupling strength :code:`tau`. If :code:`False`, no temperature control is applied. + +:tau: + :code:`float` [**optional**, default: :code:`0.7`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the CSVR thermostat coupling. In the limit of :code:`tau → ∞`, the Hamiltonian dynamics are preserved and no temperature coupling takes place. + +:thermostat_coupling_groups: + :code:`array` [:code:`array` [:code:`string`]] [**optional**, default: :code:`[]`] + + Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and :code:`"C"` type particles, :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would thermalise types :code:`"A"` and :code:`"B"` together and couple :code:`"C"` type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. :code:`target_temperature` Kelvin). +:hamiltonian: + :code:`string` [**optional**, default: :code:`"DefaultNohChi"`] (options: :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`) + + Specifies the interaction energy functional :math:`W[\tilde\phi]` for use with the particle-field interactions. See :ref:`functionals-label` for details. + + +Field keywords +^^^^^^^^^^^^^^ +Configuration keywords specifying field parameters. + +:mesh_size: + :code:`array` [:code:`integer`] or :code:`integer` [:required:`required`] + + Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is :code:`box_size / mesh_size`. + +:kappa: + :code:`float` [:required:`required`] {units: :math:`\text{kJ}^{-1}\text{mol}`} + + Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional :math:`W[\tilde\phi]`. See :ref:`functionals-label` for more details. + +:sigma: + :code:`float` [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See :ref:`filtering-label` for more details. + +:chi: + :code:`array` [:code:`array` [:code:`string`, :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}`} + + Array of :math:`\tilde\chi_\text{AB}`-parameters indicating the strength of the repulsive or attractive interaction between particles of type :code:`"A"` and the number density due to particles of type :code:`"B"`, and vice versa. Example: :code:`chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ]` would specify a repulsive :code:`"A"`--:code:`"B"` type interaction, and a weakly attractive :code:`"C"`--:code:`"D"` interaction. Self-interaction :math:`\tilde\chi`-terms are always zero. See :ref:`functionals-label` for more details. + + +Bond keywords +^^^^^^^^^^^^^ +Configuration keywords specifying bonds and bonds parameters. + +:bonds: + :code:`array` [:code:`array` [2 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{nm}=10^{-9}~\text{m}` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: :code:`bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ]` indicates a :code:`"A"`--:code:`"A"` bond of equilibrium length :code:`0.47` :math:`\text{nm}` with a bond strength of :code:`980.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding bond between :code:`"A"` and :code:`"B"` type particles with equilibrium length :code:`0.31` :math:`\text{nm}` and a strength of :code:`1250.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify stretching bonds. + +:angle_bonds: + :code:`array` [:code:`array` [3 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`{}^\circ` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: :code:`bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ]` indicates a :code:`"A"`--:code:`"A"`--:code:`"A"` angular bond that tries to keep the bond linear at :code:`180` degrees with a bending strength of :code:`55.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding angle bond between :code:`"A"`--:code:`"B"`--:code:`"B"` prefering the angle at :code:`120` degrees and a strength of :code:`25.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify angular bonds. + +:dihedrals: + :code:`array` [:code:`array` [4 :code:`string`, :code:`integer`, :code:`COSINE SERIES` ]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`} + + Specifies four-particle torsional potentials by cosine series. See :ref:`bonds-label` for details about how to specify dihedrals. + + + +Electrostatic keywords +^^^^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying electrostatics and electrostatic parameters. + +:coulombtype: + :code:`string` [**optional**, default: :code:`None`] (options: :code:`PIC_Spectral`) + + Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the :code:`dielectric_const` keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, *not* in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to `PIC_Spectral`. + +:dielectric_const: + :code:`float` [**optional**, default: :code:`None`] + + Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified---even if electrostatics are not included with the :code:`coulombtype` keyword. + +Pressure keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying pressure and barostat parameters. + +Simulation keywords +========================================= + +:pressure: + :code:`boolean` [**optional**, default: :code:`False`] + + Specifies whether or not to calculate total internal pressure vector. + +:barostat: + :code:`string` [**optional**, default: :code:`None`](options: :code:`isotropic` or :code:`semiisotropic`) + + Specifies whether to apply pressure constraints equally in all 3 Cartesian directions (`isotropic`) or equally in xy and different in z (`semiisotropic`). + +:barostat_type: + :code:`string` [**optional**, default: :code:`berendsen`](options: :code:`berendsen` or :code:`scr`) + + Specifies the type of barostat to use. :code:`berendsen` is more suitable for equilibration and :code:`scr` for equilibrium data collection. + +:n_b: + :code:`integer` [**optional**, default: :code:`1`] + + Frequency of barostat call in number of outer rRESPA steps. + +:tau_p: + :code:`float` [**optional**, default: :code:`10 tau` if :code:`tau < 0.1` else :code:`1.0`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the barostat coupling. + +:target_pressure: + :code:`array` [:code:`float`] [**optional**, default: :code:1] {units: `bar`} + + Couples the system to an external pressure set to `target_pressure`. + +Field keywords +========================================= + +:rho0: + :code:`float` [**optional**, default: :code:average density] {units: :math:`\text{nm}^{-3}`} + + Intrinsic parameter corresponding to the specific volume of a coarse-grained particle. Typically: `8.66` + +:a: + :code:`float` [:required:`required`] {units: :math:`\text{nm}^{-3}`} + + Calibrated parameter to obtain the correct average density at the target temperature and pressure. Typically: `9.21` diff --git a/v2.0.0/_sources/doc_pages/constants_and_units.rst.txt b/v2.0.0/_sources/doc_pages/constants_and_units.rst.txt new file mode 100644 index 00000000..ee429829 --- /dev/null +++ b/v2.0.0/_sources/doc_pages/constants_and_units.rst.txt @@ -0,0 +1,80 @@ +.. _units-label: + +Constants and Units +################### + +HyMD uses the following units and constants internally and in all input and +output: + +.. list-table:: **Units** + :widths: 30 10 75 + :header-rows: 1 + + * - Quantity + - Symbol + - Unit + * - length + - :math:`r` + - :math:`\text{nm}=10^{-9}~\text{m}` + * - time + - :math:`t` + - :math:`\text{ps}=10^{-12}~\text{s}` + * - charge + - :math:`q` + - :math:`e=1.602176634 \cdot 10^{-19}~\text{C}` + * - mass + - :math:`m` + - :math:`\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}` + * - temperature + - :math:`\text{T}` + - :math:`\text{K}` + * - energy + - :math:`E` + - :math:`\text{kJ}\,\text{mol}^{-1}` + * - velocity + - :math:`v` + - :math:`\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}` + * - momentum + - :math:`P` + - :math:`\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}` + * - force + - :math:`\mathbf{F}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}` + * - pressure + - :math:`p` + - :math:`\text{bar}=100~\text{kPa}` + * - electric potential + - :math:`\Psi` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}` + * - electric field + - :math:`\mathbf{E}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}` + * - compressibility + - :math:`\kappa` + - :math:`\text{mol}\,\text{kJ}^{-1}` + * - field-interaction + - :math:`\tilde\chi` + - :math:`\text{kJ}\,\text{mol}^{-1}` + +.. list-table:: **Constants** + :widths: 30 10 75 + :header-rows: 1 + + * - Constant + - Symbol + - Value + * - gas constant + - :math:`R` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Boltzmann’s constant + - :math:`k_\text{B}` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Avogadro's constant + - :math:`N_\text{A}` + - :math:`6.02214076 \cdot 10^23~\text{mol}^{-1}` + * - Vacuum permittivity + - :math:`\varepsilon_0` + - :math:`8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2` + * - Coulomb constant + - :math:`k_\text{e}` + - :math:`138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}` diff --git a/v2.0.0/_sources/doc_pages/electrostatics.rst.txt b/v2.0.0/_sources/doc_pages/electrostatics.rst.txt new file mode 100644 index 00000000..7e11c09d --- /dev/null +++ b/v2.0.0/_sources/doc_pages/electrostatics.rst.txt @@ -0,0 +1,48 @@ +.. _electrostatics-label: + +Electrostatic interactions +########################## +In the filtered Hamiltonian hPF formalism :cite:`bore2020hamiltonian` the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle--mesh Ewald. + +The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered + +.. math:: + + \tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i), + +with :math:`q_i` being the charge of particle :math:`i` and :math:`H` is the +filtering function (see :ref:`filtering-label`). The value of the charge grid at +vertex :math:`(i,j,k)` is found by + +.. math:: + + \tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)] + +and the electrostatic potential :math:`\Psi_{ijk}` + +.. math:: + + \Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right], + +where :math:`k_\text{e}` is the Coulomb constant :math:`1/4\pi\varepsilon_0`. +The *electric field* is obtained by differentiation of the electrostatic +potential in Fourier space, + +.. math:: + + \mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)] + +from which the forces are interpolated back to the particle positions. + +Specifying electrostatics +^^^^^^^^^^^^^^^^^^^^^^^^^ +In HyMD, electrostatics are specified by the :code:`coulombtype` and +:code:`dielectric_const` keywords in the configuration file (see +:ref:`config-label`) and the :code:`/charge` dataset in the HDF5 format +structure/topology input file (see :ref:`topology-label`). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions. diff --git a/v2.0.0/_sources/doc_pages/examples.rst.txt b/v2.0.0/_sources/doc_pages/examples.rst.txt new file mode 100644 index 00000000..9f9c3655 --- /dev/null +++ b/v2.0.0/_sources/doc_pages/examples.rst.txt @@ -0,0 +1,621 @@ +.. _examples-label: + +Examples +######## +The following examples are ordered in *more or less* order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the `HyMD-tutorial`_ github repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Ideal gas +========= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true + :align: right + :width: 200 + +The simplest possible system is one with no interactions at all---intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like: + + +.. code-block:: toml + :caption: **ideal_gas.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = false # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + +A simple input structure/topology file :code:`ideal_gas.HDF5` is available in +the `HyMD-tutorial/ideal_gas`_ github repository (along with the code to +generate it). Run the (very) short simulation by + +.. code:: bash + + python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field \ + --velocity-output \ + --force-output + +with the :code:`--disable-field` argument to completely turn off all +particle--field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook `ideal_gas.ipynb`_ for details. + + +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas +.. _ideal_gas.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.ipynb + + +Ideal chains +============ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true + :align: right + :width: 200 + +The simplest available interaction is the harmonic two-particle bond (see +:ref:`bonds-label`), + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2. + +Extending the configuration file from the ideal gas case, we need to add a +:code:`bonds` specification. Note that the :code:`[bonds]` meta specifier is not +necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **ideal_chain.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + +A simple input structure/topology file :code:`ideal_chain.HDF5` with a few +coiled up ideal chain polymers is available in the +`HyMD-tutorial/ideal_chain`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field + +we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +`ideal_chain.ipynb`_. + + +.. _HyMD-tutorial/ideal_chain: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_chain +.. _ideal_chain.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/ideal_chain.ipynb + + +Stiff rods +========== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true + :align: right + :width: 200 + +Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the :code:`i--j--k` angle :math:`\theta` (see +:ref:`bonds-label`), + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2. + +Extending the configuration file from the ideal chain case, we need to add a +:code:`angle_bonds` specification. Note that the :code:`[bonds]` meta specifier +is not necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **rods.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + + angle_bonds = [ + ["A", "A", "A", 180.0, 100.0], # (i, j, k, equilibrium angle, strength) + ] + + +A simple input structure/topology file :code:`rods.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook `rods.ipynb`_. + + +.. _HyMD-tutorial/rods: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/rods +.. _rods.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.ipynb + + + +Helixes +======= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true + :align: right + :width: 200 + +Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle :math:`\phi` between the +:code:`i--j--k` plane and the :code:`j--k--l` plane (see :ref:`bonds-label`), + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n). + +The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a :code:`dihedrals` keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the :code:`dielectric_const` +keyword even though we are not including electrostatic forces in the current +simulation. Note that the :code:`[bonds]` meta specifier is not necessary, but +may be used to help organise the input file. + +.. code-block:: toml + :caption: **helixes.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + dielectric_const = 15.0 + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.31, 10000.0], # (i name, j name, equilibrium length, strength) + ] + + dihedrals = [ + [ + ["A", "A", "A", "A"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0] + ], + ] + +A simple input structure/topology file :code:`helixes.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook `helixes.ipynb`_. + + +.. _HyMD-tutorial/helixes: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/helixes +.. _helixes.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.ipynb + + +Phase separation +================ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true + :align: right + :width: 200 + +The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types :code:`A` and :code:`B`. Using the Hamiltonian + +.. math:: + + \mathcal{H}=H_0+W + +with :math:`\tilde\chi`--dependent interactions defined by (specified in the +configuration file by :code:`hamiltonian = DefaultWithChi`): + +.. math:: + + W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2. + + +.. code-block:: toml + :caption: **phase_separation.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + + [field] + mesh_size = [20, 20, 20] # FFT grid size + sigma = 1.0 # filtering length scale in nm + kappa = 0.05 # compressibility in mol/kJ + chi = [ + ['A', 'B', 5.0], # (name i, name j, strength) + ] + +A simple input structure/topology file :code:`phase_separation.HDF5` containing +an equal number of :code:`A` type and :code:`B` type particles is available in +the `HyMD-tutorial/phase_separation`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd phase_separation.toml phase_separation.HDF5 + +we may examine the resulting trajectory. In the case of a low interaction +strength :math:`\tilde\chi` of :code:`5.0` (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to :code:`40.0` (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +`phase_separation.ipynb`_. + + +.. _HyMD-tutorial/phase_separation: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/phase_separation +.. _phase_separation.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/phase_separation.ipynb + + +Diblock copolymers +================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true + :align: right + :width: 200 + +Having introduced particle--field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive :math:`\tilde\chi`--interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the :code:`integrator = "respa"` keyword. Putting the pieces together, the +configuration file may look like the following: + +.. code-block:: toml + :caption: **copolymer.toml** + + [simulation] + integrator = "respa" + respa_inner = 15 + n_steps = 2000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [10.0, 10.0, 10.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [50, 50, 50] # FFT grid size + sigma = 0.5 # filtering length scale in nm + chi = [ + ["A", "B", 30.0], # (i, j, strength) + ] + + [bonds] + bonds = [ + ["A", "A", 0.25, 1500.0], # (i, j, equilibrium length, strength) + ["A", "B", 0.25, 1500.0], + ["B", "B", 0.25, 1500.0], + ] + angle_bonds = [ + ["A", "A", "A", 180.0, 25.0], # (i, j, k, equilibrium angle, strength) + ["B", "B", "B", 180.0, 25.0], + ] + +A simple input structure/topology file :code:`copolymer.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/copolymer`_ github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten :code:`A` followed by ten :code:`B` type particles. +Running the simulation with + +.. code:: bash + + python3 -m hymd copolymer.toml copolymer.HDF5 + +the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +`copolymer.ipynb`_. + + +.. _HyMD-tutorial/copolymer: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/copolymer +.. _copolymer.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer.ipynb + + +Lipid bilayer self-assembly +=========================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true + :align: right + :width: 300 + +Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field--particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the :code:`thermostat_coupling_groups` keyword. With parameters +optimised in :cite:`ledum2020automated`, the configuration file looks like: + + +.. code-block:: toml + :caption: **lipid_self_assembly.toml** + + [simulation] + integrator = "respa" + respa_inner = 25 + n_steps = 3000 + n_print = 200 + n_flush = 1 + time_step = 0.01 + box_size = [9.96924, 9.96924, 10.03970] + start_temperature = 323 + target_temperature = 323 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.05 + domain_decomposition = 10001 + cancel_com_momentum = true + max_molecule_size = 15 + thermostat_coupling_groups = [ + ["N", "P", "G", "C"], + ["W"], + ] + + [field] + mesh_size = [25, 25, 25] + sigma = 1.0 + chi = [ + ["C", "W", 42.24], + ["G", "C", 10.47], + ["N", "W", -3.77], + ["G", "W", 4.53], + ["N", "P", -9.34], + ["P", "G", 8.04], + ["N", "G", 1.97], + ["P", "C", 14.72], + ["P", "W", -1.51], + ["N", "C", 13.56], + ] + + [bonds] + bonds = [ + ["N", "P", 0.47, 1250.0], + ["P", "G", 0.47, 1250.0], + ["G", "G", 0.37, 1250.0], + ["G", "C", 0.47, 1250.0], + ["C", "C", 0.47, 1250.0], + ] + angle_bonds = [ + ["P", "G", "G", 120.0, 25.0], + ["P", "G", "C", 180.0, 25.0], + ["G", "C", "C", 180.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +A randomly mixed input structure/topology file +:code:`lipid_self_assembly.HDF5` with a few hundred lipids in a roughy +:code:`10 x 10 x 10nm` box is available in the +`HyMD-tutorial/lipid_self_assembly`_ github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation + +.. code:: bash + + python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5 + +we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook `lipid_self_assembly.ipynb`_. + + +.. _HyMD-tutorial/lipid_self_assembly: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/lipid_self_assembly +.. _lipid_self_assembly.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/lipid_self_assembly.ipynb + + +Peptide in lipid bilayer +======================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true + :align: right + :width: 300 + +Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer. + + +The `configuration file`_ is available in the `HyMD-tutorial/peptide`_ github +repository (omitted here for brevity). + +A pre-equilibrated input structure/topology file :code:`peptide.HDF5` with a +few hundred lipids in a roughy :code:`20 x 20 x 20nm` box is available in the +`HyMD-tutorial/peptide`_ github repository. Running the simulation + +.. code:: bash + + python3 -m hymd peptide.toml peptide.HDF5 + +we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook `peptide.ipynb`_. + + +.. _HyMD-tutorial/peptide: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/peptide +.. _configuration file: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.toml +.. _peptide.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.ipynb + + +SDS +=== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true + :align: right + :width: 300 + +The last part we introduce is explicit electrostatic interactions through +particle--mesh Ewald. Enabling the electrostatic calculations is done via the +:code:`coulombtype` keyword. :code:`"PIC_Spectral"` is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the :code:`dielectric_const` keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge. + + + +.. code-block:: toml + :caption: **sds.toml** + + [simulation] + integrator = "respa" + respa_inner = 10 + n_steps = 3000 + n_print = 1500 + n_flush = + time_step = 0.01 + box_size = [8.3, 8.3, 8.3] + start_temperature = 298 + target_temperature = 298 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.1 + domain_decomposition = 10000 + cancel_com_momentum = true + max_molecule_size = 5 + thermostat_coupling_groups = [ + ["S", "C"], + ["W", "Na"], + ] + dielectric_const = 45.0 # dielectric constant for the simulation medium + coulombtype = "PIC_Spectral" # particle in cloud, spectral method + + [field] + mesh_size = [64, 64, 64] + sigma = 0.5 + chi = [ + ["S", "C", 13.50], + ["S", "Na", 0.00], + ["S", "W", -3.60], + ["C", "Na", 13.50], + ["C", "W", 33.75], + ["W", "Na", 0.00], + ] + + [bonds] + bonds = [ + ["S", "C", 0.50, 1250.0], + ["C", "C", 0.50, 1250.0], + ] + angle_bonds = [ + ["S", "C", "C", 170.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +An input structure/topology file :code:`sds.HDF5` with a couple thousand +randomly dispersed SDS chains is available in the `HyMD-tutorial/sds`_ github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a :code:`/charge` dataset. +Running the simulation with + +.. code:: bash + + python3 -m hymd sds.toml sds.HDF5 + +we observe the aggregation of the SDS into micellular structures---first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook `sds.ipynb`_. + + +.. _HyMD-tutorial/sds: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/sds +.. _sds.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/sds.ipynb diff --git a/v2.0.0/_sources/doc_pages/filtering.rst.txt b/v2.0.0/_sources/doc_pages/filtering.rst.txt new file mode 100644 index 00000000..02af68c6 --- /dev/null +++ b/v2.0.0/_sources/doc_pages/filtering.rst.txt @@ -0,0 +1,30 @@ +.. _filtering-label: + +Filtering +######### +The default grid-independent filter function used in HyMD is a Gaussian + +.. math:: + + H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] + +with reciprocal space representation + +.. math:: + + \hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +The coarse-graining parameter :math:`\sigma` determines a length scale of +particle extent and is given as configuration file input by + +.. code:: toml + + sigma = 0.75 + + +Implementing new filters +^^^^^^^^^^^^^^^^^^^^^^^^ +Implementing new filter functions is straightforward by hijacking +the :code:`setup` method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional. diff --git a/v2.0.0/_sources/doc_pages/installation.rst.txt b/v2.0.0/_sources/doc_pages/installation.rst.txt new file mode 100644 index 00000000..9ab7e59c --- /dev/null +++ b/v2.0.0/_sources/doc_pages/installation.rst.txt @@ -0,0 +1,324 @@ +.. _installation-label: + +Installation +############ + +Dependencies +============ + +.. note:: + HyMD requires Python ≥3.6. Python version 3.9 is most likely fine + to use, but HyMD is only regularly tested with Python3.8 at the moment. + +.. warning:: + MPI-enabled h5py may fail to build under Python3.10. In this case, a + fall-back to Python3.9 or lower may be necessary. + + +**Installing non-Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-openmpi-dev # Install MPI-enabled HDF5 + sudo apt-get install -y pkg-config # Install pkg-config, required for h5py install + sudo apt-get install -y curl wget + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + sudo dnf update -y + sudo dnf install -y python3.9 python3-devel # Install python3 and pip + sudo dnf install -y openmpi-devel # Install MPI development headers + sudo dnf install -y hdf5-openmpi-devel # Install MPI-enabled HDF5 + sudo dnf install -y curl wget + + + The automatic download and building of PFFT has some issues, so we + manually build FFTW and PFFT before calling :code:`pip3 install pfft-python`. + + .. code-block:: bash + + sudo dnf install -y git + sudo dnf install -y libtool + sudo dnf install -y fftw-openmpi-devel fftw-openmpi-libs + export PATH=$PATH:/usr/lib64/openmpi/bin/ # Ensure MPICC is in path + git clone https://github.com/mpip/pfft.git + cd pfft/ + ./bootstrap.sh + ./configure + make + make install + + + .. group-tab:: Mac OSX (brew) + + .. code-block:: bash + + brew update + brew install python # Install python3 and pip + brew install open-mpi # Install MPI development headers + brew install hdf5-mpi # Install MPI-enabled HDF5 + brew install pkg-config # Install pkg-config, required for h5py install + brew install curl wget + +.. warning:: + There might be memory leaks when using HyMD with OpenMPI 4.1.1. + Therefore, using a newer version of OpenMPI is recommended. + See `Issue #186 `_ for more details. + + +**Installing Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + python3 -m pip install --upgrade pip + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + python3.9 -m ensurepip --upgrade + PATH=$PATH:/usr/lib64/openmpi/bin/:/usr/lib64/openmpi/lib/ + python3.9 -m pip install mpi4py numpy cython + export HDF5_DIR="/usr/lib64/openmpi/" + CC="mpicc" HDF5_MPI="ON" python3.9 -m pip install --no-binary=h5py h5py + + .. group-tab:: Mac OSX (brew) + + Find the location of the installed :code:`hdf5-mpi` package by + + .. code-block:: bash + + find /usr -iname "*hdf5.h" + + or + + .. code-block:: bash + + brew info hdf5-mpi + + and extract the path, which will look like for example + :code:`/usr/local/Cellar/hdf5-mpi/1.13.0/`. Export it as :code:`HDF5_DIR` + + .. code-block:: bash + + python3 -m ensurepip --upgrade + export HDF5_DIR="/usr/local/Cellar/hdf5-mpi/1.13.0/" + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + + +.. warning:: + + If MPI-enabled HDF5 and :code:`h5py` can not be installed, limited support + for serial HDF5 is available. Note that having MPI-enabled file IO is + **highly recommended**, and simulation performance under serial HDF5 will + potentially be very low. + + Example dependency install on Ubuntu (apt) using serial HDF5: + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-serial-dev # Install serial HDF5 + sudo apt-get install -y curl wget + + python3 -m pip install h5py mpi4py numpy cython + + Running parallel simulations without a + MPI-enabled HDF5 library available necessitates the use of the + :code:`--disable-mpio` argument to HyMD, see :ref:`commandline-label`. Note that + due to the way HyMD is built, a working MPI compiler is required even if all + intended simulations are serial. + + +Installing HyMD +=============== +HyMD may be installed using :code:`pip` by + +.. code-block:: bash + + python3 -m pip install hymd + + + +Install in docker +================= +A docker image with build essentials setup is available at `dockerhub`_ with tag +:code:`mortele/hymd`, + +.. code-block:: bash + + docker pull mortele/hymd:latest + docker run -it mortele/hymd + /app$ python3 -m pip install hymd + + # Grab example input files + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5 + + # Run simulation + /app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose + +.. _dockerhub: + https://hub.docker.com/repository/docker/mortele/hymd + + +Run interactively in Google Colaboratory +======================================== +A `Google Colaboratory`_ jupyter notebook is setup `here`_ with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Common issues +============= + +Numpy errors while importing the Fortran force kernels +------------------------------------------------------ + +.. code-block:: python + + RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd + + Traceback (most recent call last): + + (...) + + File "/..../HyMD/hymd/__init__.py", line 2, in + from .main import main # noqa: F401 + File "/..../HyMD/hymd/main.py", line 10, in + from .configure_runtime import configure_runtime + File "/..../hymd/configure_runtime.py", line 12, in + from .input_parser import read_config_toml, parse_config_toml + File "/..../HyMD/hymd/input_parser.py", line 12, in + from .force import Bond, Angle, Dihedral, Chi + File "/..../HyMD/hymd/force.py", line 8, in + from force_kernels import ( # noqa: F401 + ImportError: numpy.core.multiarray failed to import + +can normally be fixed by updating numpy versions, + +.. code-block:: bash + + python3 -m pip install -U numpy + + +Error building pfft-python due to missing curl/wget +--------------------------------------------------- + +.. code-block:: python + + Building wheel for pfft-python (setup.py) ... error + ERROR: Command errored out with exit status 1: + command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_ + cwd: /tmp/pip-install-fr6nt9m4/pfft-python/ + Complete output (56 lines): + running bdist_wheel + running build + running build_py + + (...) + + curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found + wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found + Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + Please check curl or wget + You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ + Traceback (most recent call last): + File "", line 1, in + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in + setup( + File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup + return distutils.core.setup(**attrs) + File "/usr/lib/python3.8/distutils/core.py", line 148, in setup + + (...) + + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions + build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:])) + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft + raise ValueError("could not build fftw; check MPICC?") + ValueError: could not build fftw; check MPICC? + ---------------------------------------- + ERROR: Failed building wheel for pfft-python + Running setup.py clean for pfft-python + Failed to build pfft-python + +can be fixed by installing either `curl`_ or `wget`_ + +.. code-block:: bash + + apt-get install -y curl wget + + +.. _`curl`: + https://curl.se/ + +.. _`wget`: + https://www.gnu.org/software/wget/ + + +Error running parallel HyMD without MPI-enabled h5py +---------------------------------------------------- + +.. code-block:: python + + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + main() + File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main + with h5py.File(args.input, "r", **_kwargs) as in_file: + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__ + with h5py.File(args.input, "r", **_kwargs) as in_file: + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + raise ValueError("h5py was built without MPI support, can't use mpio driver") + ValueError: h5py was built without MPI support, can't use mpio driver + +Can be fixed by installing a MPI-enabled :code:`h5py` through + +.. code-block:: bash + + python3 -m pip uninstall -y h5py + HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py diff --git a/v2.0.0/_sources/doc_pages/interaction_energy_functionals.rst.txt b/v2.0.0/_sources/doc_pages/interaction_energy_functionals.rst.txt new file mode 100644 index 00000000..f33c004e --- /dev/null +++ b/v2.0.0/_sources/doc_pages/interaction_energy_functionals.rst.txt @@ -0,0 +1,98 @@ +.. _functionals-label: + +Interaction energy functionals +############################## +A few interaction energy functionals :math:`W` are defined in HyMD through +the :code:`Hamiltonian` class and associated subclasses. + +:math:`\chi`--interaction and :math:`\kappa`--incompressibility +=============================================================== +The most common hPF energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultWithChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where :math:`\tilde\chi_{\text{A}-\text{B}}` is the interaction energy between +overlapping densities of particle types :math:`\text{A}` and :math:`\text{B}`. +The incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\tilde\chi` +and :math:`\kappa` in the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + chi = [ + ["A", "B", 15.85], + ["B", "C", -5.70], + ... + ] + +Only :math:`\kappa`--incompressibility +====================================== +The only :math:`\kappa` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultNoChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where the incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Only :math:`\phi^2` +=================== +The :math:`\phi^2` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "SquaredPhi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2, + +where the :math:`\phi` squared term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Implementing new interaction energy forms +========================================= +Implementing new interaction energy functions is straightforward by subclassing +:code:`Hamiltonian` and applying :code:`sympy` differentiation to the symbolic +field objects. The :code:`sympy.lamdify` function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields. diff --git a/v2.0.0/_sources/doc_pages/intramolecular_bonds.rst.txt b/v2.0.0/_sources/doc_pages/intramolecular_bonds.rst.txt new file mode 100644 index 00000000..820e81bc --- /dev/null +++ b/v2.0.0/_sources/doc_pages/intramolecular_bonds.rst.txt @@ -0,0 +1,142 @@ +.. _bonds-label: + +Intramolecular bonds +#################### + +Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see :ref:`config-label`. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +:ref:`benchmarks-label`), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable. + +All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]). + + +Two-particle bonds +^^^^^^^^^^^^^^^^^^ +Stretching bonds in HyMD are implemented as harmonic spring potentials, + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2, + +where :math:`r=|\mathbf{r}|` is the inter-particle distance, :math:`k` is a +constant of dimension energy (units :math:`\text{kJ}\,\text{mol}^{-1}`), and +:math:`r_0` is the equilibrum length of the bond (units: :math:`\text{nm}`). The +force is calculated as + +.. math:: + + F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r}, + +where :math:`\mathbf{r}` is the vector pointing *from* :math:`i` *to* :math:`j`. + +In the configuration file, two-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_two_particle_example.toml + + [bonds] + bonds = [ + ["A", "A", 0.47, 1250.0], + ["A", "B", 0.37, 940.0], + ["B", "C", 0.50, 1010.0], + ["C", "A", 0.42, 550.0], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Three-particle bonds +^^^^^^^^^^^^^^^^^^^^ +Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle--particle--particle angle :math:`\theta`, + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2, + +where :math:`k` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}`), and :math:`\theta_0` is the equilibrum +angle of the bond (units: :math:`{}^\circ`). Defining the particles with labels +:math:`a`, :math:`b`, and :math:`c`, let :math:`\mathbf{r}_a` denote the vector +pointing from :math:`b` to :math:`a`, and correspondingly let +:math:`\mathbf{r}_c` point from :math:`b` to :math:`c`. The +:math:`a`--:math:`b`--:math:`c` may be computed through the law of Cosines, + +.. math:: + + \theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right] + +Then the force acting on :math:`a` and :math:`c` is + +.. math:: + + \mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a}, + + \mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c}, + +and + +.. math:: + + \mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c + +In the configuration file, three-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_three_particle_example.toml + + [bonds] + angle_bonds = [ + ["A", "A", "A", 180.0, 90.0], + ["A", "B", "A", 120.0, 55.0], + ["B", "C", "C", 30.0, 10.0], + ["C", "A", "B", 110.0, 25.5], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Four-particle bonds +^^^^^^^^^^^^^^^^^^^ +Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle :math:`\phi` between the +:math:`a`--:math:`b`--:math:`c` and :math:`b`--:math:`c`--:math:`d` planes, for +a dihedral bond quartet :math:`a`, :math:`b`, :math:`c`, and :math:`d`. The +potential takes the form + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n), + +where :math:`c_n` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`), and :math:`\phi_n` are +specified phase angles in the cosine series. + +In the configuration file, four-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_four_particle_example.toml + + [bonds] + dihedrals = [ + ["A", "B", "C", "D"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0], + ] diff --git a/v2.0.0/_sources/doc_pages/overview.rst.txt b/v2.0.0/_sources/doc_pages/overview.rst.txt new file mode 100644 index 00000000..0e4d6b65 --- /dev/null +++ b/v2.0.0/_sources/doc_pages/overview.rst.txt @@ -0,0 +1,166 @@ +.. _overview-label: + +================================ + Usage overview for HylleraasMD +================================ + +HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a `toml`_ format configuration file, along with a topology and structure +file specifying the input system in HDF5 format. + +.. _`toml`: + https://github.com/toml-lang/toml + +**Configuration file** + +The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a :code:`[5, 5, 5]` nm simulation box at 300 K may look like +the following: + +.. code-block:: toml + :caption: **config_simple_1.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "SquaredPhi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [30, 30, 30] # FFT grid size + sigma = 0.5 # filtering length scale in nm + +Note that for the version 1.0 release of HyMD, the :code:`[particles]`, +:code:`[simulation]`, and :code:`[field]` groups are optional specifiers for +structuring the configuration file. + +For a full specification of every recognised configuration keyword in HyMD, +please refer to :ref:`config-label`. + +**Topology and structure file** + +The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +:code:`N` particles may look like the following: + +.. code-block:: bash + :caption: **example_structure.HDF5** + + group / + # root group + + dataset /coordinates + # float32, shape (T, N, D,) + # Time steps of N rows of D dimensional coordinate data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /velocities + # float32, shape (T, N, D,) OPTIONAL + # Time steps of N rows of D dimensional velocity data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /bonds + # int32, shape (N, B,) OPTIONAL + # Each row i contains indices of the particles bonds from/to i + # B denotes the maximum bonds per particle + + dataset /indices + # int32, shape (N,) + # Index of each particle, 0--(N-1) + + dataset /molecules + # int32, shape (N,) + # Index of molecule each particle belongs to + # Used to construct bond network locally on MPI ranks + + dataset /names + # str10, shape (N,) + # Fixed size string array containing particle type names + + dataset /types + # int32, shape (N,) OPTIONAL + # Mapping of particle names to type indices + + +For a full specification of the topology and structure input file, see +:ref:`topology-label`. + +**Command line arguments** + +A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the :code:`config_simple_1.toml` and :code:`example_structure.HDF5` +files may look like the following: + +.. code-block:: bash + + mpirun -n ${MPI_NUM_RANKS} python3 -m hymd \ # HyMD executable + config_simple_1.toml \ # configuration file + example_structure.HDF5 \ # structure file + --logfile=log_out.txt \ # set logfile path + --seed 123456 \ # set random seed + --verbose 2 \ # set logging verbosity + --velocity-output # enable velocity in trajectory output + +For a full specification of all command line arguments, see +:ref:`commandline-label`. + +**More examples** + +For more thorough rundown and concrete usage examples, see +:ref:`examples-label`. + +Running parallel simulations +============================ +Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the **only** difference being how the python3 interpreter is +invoked. Prepending :code:`mpirun -n ${NPROCS}` to the usual +:code:`python3 -m hymd` runs the simulation with :code:`${NPROCS}` MPI ranks. + +Inputting + +.. code:: bash + + mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field + +sets up an example simulation of the `HyMD-tutorial/ideal_gas`_ system. For +more details about this system in particular, or other example simulations, see +the `HyMD-tutorial`_ repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas + + +Running tests +============= +Run serial code tests by + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd + cd hymd/ + python3 -m pip install pytest pytest-mpi + python3 -m pytest + +There is a small convenience script in :code:`hymd/` for running the MPI-enabled +tests, + +.. code-block:: bash + + chmod +x pytest-mpi + ./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no diff --git a/v2.0.0/_sources/doc_pages/pressure.rst.txt b/v2.0.0/_sources/doc_pages/pressure.rst.txt new file mode 100644 index 00000000..be9c7cda --- /dev/null +++ b/v2.0.0/_sources/doc_pages/pressure.rst.txt @@ -0,0 +1,37 @@ +.. _pressure-label: + +Pressure +######## +Internal pressure is calculated from internal energy according to + +.. math:: + + P_a = \frac{1}{\mathcal{V}} \left( 2T_a - \text{Vir}_a \right) \\ + \text{Vir}_a = L_a \frac{\partial \mathcal{U}}{\partial L_a} \\ + \mathcal{U} = \sum_{i=1}^M \mathcal{U}_0( \{ \mathbf{r}\}_i ) + W[\{ \tilde\phi \} ] + +where +:math:`\mathcal{V}` is the simulation volume, +:math:`{T_a}` is the kinetic energy +and :math:`L_a` the length of the box in the Cartesian direction :math:`a`, +Vir is the virial of the total interaction energy :math:`\mathcal{U}`. + +:math:`\mathcal{U}` comprises intramolecular bonded terms :math:`\mathcal{U}_0` (see :ref:`bonds-label` for details), +and field terms :math:`W[\{ \tilde\phi \} ]` (see :ref:`theory-label` for details). + +Using the above expressions, the following form for internal pressure is obtained: + +.. math:: + + P_a = \frac{2 T_a}{\mathcal{V}} -\frac{L_a}{\mathcal{V}} \sum_{i=1}^N \frac{\partial \mathcal{U}_{0i}}{\partial L_a} + P^{(3)}_a \\ + +.. P^{(3)}_a = - \frac{L_a}{\mathcal{V}} \frac{\partial W[\{ \tilde\phi \} ]}{\partial L_a} \\ + +.. math:: + + P^{(3)}_a = \frac{1}{\mathcal{V}}\left ( -W[\{ \tilde\phi(\mathbf{r}) \}] + \int \sum_t \bar{V}_t(\mathbf{r})\tilde\phi_t(\mathbf{r})d\mathbf{r} + + \int \sum_t \sigma^2\bar{V}_t(\mathbf{r})\nabla_a^2\tilde\phi_t(\mathbf{r}) d\mathbf{r} \right) + +where :math:`\bar{V}_t(\mathbf{r}) = \frac{\partial w(\{\tilde\phi\})}{\partial\tilde\phi_t}` +and :math:`σ` is a coarse-graining parameter (see :ref:`filtering-label` for details). +Note that the above expression is obtained for a Gaussian filter which is the most natural choice in HhPF theory. diff --git a/v2.0.0/_sources/doc_pages/theory.rst.txt b/v2.0.0/_sources/doc_pages/theory.rst.txt new file mode 100644 index 00000000..2429bc0d --- /dev/null +++ b/v2.0.0/_sources/doc_pages/theory.rst.txt @@ -0,0 +1,122 @@ +.. _theory-label: + +Theory +###### +Hybrid particle--field simulations switch out the ordinary particle--particle +`Lennard-Jones`_ interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle--field densities are +defined as + +.. math:: + + \phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i), + +where :math:`\mathbf{r}` is a spatial coordinate, :math:`P` is a window function +used to distribute particle number densities onto a computational grid, and +:math:`\mathbf{r}_i` is the position of particle :math:`i` (of total :math:`N`). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of :math:`N` particles in :math:`M` molecules is + +.. math:: + + \mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})] + +with :math:`H_0` being a standard intramolecular Hamiltonian form (see +:ref:`bonds-label`) including kinetic terms, while :math:`W` is a density +dependent *interaction energy functional*. + +In the Hamiltonian hPF-MD formalism :cite:`bore2020hamiltonian`, the density +field is filtered using a grid-independent filtering function :math:`H`, + +.. math:: + + \tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}). + +The filter smooths the density, ensuring that :math:`\tilde\phi` and +:math:`W[\tilde\phi([\phi])]` both converge as the grid size is reduced. + +External potential +================== +The external potential acting on a particle is defined as the functional +derivative of :math:`W` with respect to :math:`\phi`. In the filtered formalism, +the potential takes the form + +.. math:: + + V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ + &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})}, + +under the assumption of a *local* form of the interaction energy functional, +:math:`W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]`. Note +that + +.. math:: + + \frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}). + +Force interpolation +=================== +The forces on particle :math:`i` are obtained by differentiation of the external +potential, + +.. math:: + + \mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i). + + +Reciprocal space calculations +============================= +The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density :math:`\phi_{ijk}` with CIC, we apply the filtering +and obtain the discrete version of the external potential by + +.. math:: + + \tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big] + +and + +.. math:: + + V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +The forces are obtained by differentiation of :math:`V` in Fourier space as + +.. math:: + + \nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +Filter +====== +By default, the filter used in HyMD is a simple Gaussian of the form + +.. math:: + + H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ + \hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +For more details about the filtering, see :ref:`filtering-label`. + +Hamiltonian form +================ +The default form of the interaction energy functional in HyMD is + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2. + +In the case of constant pressure simulations (NPT), the interaction energy functional becomes + +.. math:: + + W=\frac{1}{2\rho_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-a\right)^2. + +where, :math:`\rho_0= 1 / ν` is an intrinsic parameter corresponding to the specific volume :math:`(ν)` of a coarse-grained particle, +:math:`a` is a calibrated parameter to obtain the correct average density at the target temperature and pressure. +See :ref:`functionals-label` for details. + + +.. _`Lennard-Jones`: + https://en.wikipedia.org/wiki/Lennard-Jones_potential diff --git a/v2.0.0/_sources/doc_pages/topology_input.rst.txt b/v2.0.0/_sources/doc_pages/topology_input.rst.txt new file mode 100644 index 00000000..02faa501 --- /dev/null +++ b/v2.0.0/_sources/doc_pages/topology_input.rst.txt @@ -0,0 +1,84 @@ +.. _topology-label: + +============================ +Topology and structure file +============================ +The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root :code:`/` group. + +The `HyMD-tutorial`_ has multiple examples of structure files for various levels +of complexity. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Required datasets +================= +:/coordinates: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/indices: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/names: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`string` (:code:`length` between :code:`1` and :code:`16`)] + + The shape represents one particle name per :code:`N` particles. The datatype may be a string of length :code:`=<16`. + + + +Optional datasets +================= +:/velocities: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/types: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle type index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/molecules: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one molecule index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/bonds: + :code:`array` shape [:code:`N`, :code:`B`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents :code:`B` bond specifications (indices of different particles) per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/charge: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents one particle charge per :code:`N` particles. The data type may be either four or eight byte reals. + +:/box: + :code:`array` shape [:code:`3`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents the initial box dimensions in Cartesian coordinates. diff --git a/v2.0.0/_sources/index.rst.txt b/v2.0.0/_sources/index.rst.txt new file mode 100644 index 00000000..cfac690d --- /dev/null +++ b/v2.0.0/_sources/index.rst.txt @@ -0,0 +1,169 @@ +.. hymd documentation master file, created by + sphinx-quickstart on Thu Dec 16 13:31:43 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +############################### +HylleraasMD documentation +############################### + +:Release: + |release| +:Date: + |today| + +**HylleraasMD** (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems. + +HyMD can run canonical hPF-MD simulations :cite:`Milano2009JCP`, or filtered +density Hamiltonian hPF (HhPF-MD) simulations :cite:`bore2020hamiltonian`, with +or without explicit PME electrostatic interactions :cite:`kolli2018JCTC`. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +:cite:`Cascella2008,bore2018hybrid`. Martini +style elastic networks (ElNeDyn) :cite:`periole2009combining` are also +supported. + +HyMD uses the pmesh (`github.com/rainwoodman/pmesh`_) library for particle-mesh +operations, with the PPFT :cite:`pippig2013pfft` backend for FFTs through the +pfft-python bindings (`github.com/rainwoodman/pfft-python`_). File IO is done +via HDF5 formats to allow MPI parallel reads. + +User Guide +========== +The HylleraasMD :doc:`User Guide ` provides comprehensive information on how to run +simulations. Selected :doc:`Examples ` are available to guide new users. + +.. _`github.com/rainwoodman/pmesh`: + https://github.com/rainwoodman/pmesh +.. _`github.com/rainwoodman/pfft-python`: + https://github.com/rainwoodman/pfft-python + +Installing HyMD +=============== +The easiest approach is to install using pip_: + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + +For more information and **required dependencies**, see +:ref:`installation-label`. + +.. _pip: + http://www.pip-installer.org/en/latest/index.html + + +Run in Google colab +------------------- +Run HyMD interactively in `Google Colaboratory`_ jupyter notebook `here`_. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Source Code +=========== +**Source code** is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the `GNU Lesser General Public +License v3.0`_. Obtain the source code with `git`_: + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git + +.. _GNU Lesser General Public License v3.0: + https://www.gnu.org/licenses/lgpl-3.0.html +.. _git: + https://git-scm.com/ + + +Development +=========== +HyMD is developed and maintained by researchers at the `Hylleraas Centre for +Quantum Molecular Sciences`_ at the `University of Oslo`_. + +|pic1| |pic2| + +.. _`Hylleraas Centre for Quantum Molecular Sciences`: + https://www.mn.uio.no/hylleraas/english/ +.. _`University of Oslo`: + https://www.uio.no/ + +.. |pic1| image:: img/hylleraas_centre_logo_black.png + :target: img/hylleraas_centre_logo_black.png + :width: 250 px + +.. |pic2| image:: img/uio_full_logo_eng_pos.png + :target: img/uio_full_logo_eng_pos.png + :width: 325 px + + + +References +========== +.. bibliography:: + :all: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. Contents +.. ======== + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Getting started + + ./doc_pages/installation + ./doc_pages/overview + ./doc_pages/config_file + ./doc_pages/topology_input + ./doc_pages/command_line + ./doc_pages/constants_and_units + + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Examples + + ./doc_pages/examples + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Theory + + ./doc_pages/theory + ./doc_pages/intramolecular_bonds + ./doc_pages/electrostatics + ./doc_pages/pressure + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Developer documentation + + ./doc_pages/interaction_energy_functionals + ./doc_pages/filtering + ./doc_pages/benchmarks + ./doc_pages/api diff --git a/v2.0.0/_static/basic.css b/v2.0.0/_static/basic.css new file mode 100644 index 00000000..be19270e --- /dev/null +++ b/v2.0.0/_static/basic.css @@ -0,0 +1,856 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/v2.0.0/_static/css/badge_only.css b/v2.0.0/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/v2.0.0/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/v2.0.0/_static/css/fonts/Roboto-Slab-Bold.woff b/v2.0.0/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/v2.0.0/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/v2.0.0/_static/css/fonts/Roboto-Slab-Bold.woff2 b/v2.0.0/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/v2.0.0/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/v2.0.0/_static/css/fonts/Roboto-Slab-Regular.woff b/v2.0.0/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/v2.0.0/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/v2.0.0/_static/css/fonts/Roboto-Slab-Regular.woff2 b/v2.0.0/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/v2.0.0/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/v2.0.0/_static/css/fonts/fontawesome-webfont.eot b/v2.0.0/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/v2.0.0/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/v2.0.0/_static/css/fonts/fontawesome-webfont.svg b/v2.0.0/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/v2.0.0/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v2.0.0/_static/css/fonts/fontawesome-webfont.ttf b/v2.0.0/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/v2.0.0/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/v2.0.0/_static/css/fonts/fontawesome-webfont.woff b/v2.0.0/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/v2.0.0/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/v2.0.0/_static/css/fonts/fontawesome-webfont.woff2 b/v2.0.0/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/v2.0.0/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/v2.0.0/_static/css/fonts/lato-bold-italic.woff b/v2.0.0/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/v2.0.0/_static/css/fonts/lato-bold-italic.woff differ diff --git a/v2.0.0/_static/css/fonts/lato-bold-italic.woff2 b/v2.0.0/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/v2.0.0/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/v2.0.0/_static/css/fonts/lato-bold.woff b/v2.0.0/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/v2.0.0/_static/css/fonts/lato-bold.woff differ diff --git a/v2.0.0/_static/css/fonts/lato-bold.woff2 b/v2.0.0/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/v2.0.0/_static/css/fonts/lato-bold.woff2 differ diff --git a/v2.0.0/_static/css/fonts/lato-normal-italic.woff b/v2.0.0/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/v2.0.0/_static/css/fonts/lato-normal-italic.woff differ diff --git a/v2.0.0/_static/css/fonts/lato-normal-italic.woff2 b/v2.0.0/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/v2.0.0/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/v2.0.0/_static/css/fonts/lato-normal.woff b/v2.0.0/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/v2.0.0/_static/css/fonts/lato-normal.woff differ diff --git a/v2.0.0/_static/css/fonts/lato-normal.woff2 b/v2.0.0/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/v2.0.0/_static/css/fonts/lato-normal.woff2 differ diff --git a/v2.0.0/_static/css/theme.css b/v2.0.0/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/v2.0.0/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/v2.0.0/_static/custom.css b/v2.0.0/_static/custom.css new file mode 100644 index 00000000..b20d6282 --- /dev/null +++ b/v2.0.0/_static/custom.css @@ -0,0 +1,91 @@ + +body{ + background: #FFFFFF !important; +} + +.wy-menu-vertical header, .wy-menu-vertical p.caption{ + color: #4EA0AF!important; +} +.wy-menu-vertical li.current{ + background-color: #f4f4f4!important; +} +.wy-menu-vertical li.toctree-l2.current>a{ + background-color: #ebebeb!important; +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{ + background-color: #e3e3e3!important; +} + +.rst-content .sidebar{ + background-color: #fff!important; + border-radius: 6px; + -moz-border-radius: 6px; + -webkit-border-radius: 6px; +} + +h1 > a, h2 > a, h3 > a, h4 > a, h5 > a, h6 > a { + color: #17d9ff; +} + +h1, h2, h3, h4, h5, h6 { + color: black; + font-weight: normal; + padding: 0; +} + +h1, h2, h3 { + margin-top: 30px; + margin-bottom: 20px; +} + +h1 { + color: white; + padding: 20px 20px 20px 45px; + margin: 20px 0 35px -45px; + background: linear-gradient(to left, #fff, #2b38ff)!important; + + width: calc(100% + 90px); + border-bottom: 3px solid #000; +} + +h2 { + padding: .2em 0; + border-bottom: 1px solid #ddd; +} + +h3 { + margin-top: 35px; +} + +h4 { + margin-top: 30px; +} + +h5 { + margin-top: 25px; +} + +.wy-nav-content{ + max-width: none!important; +} + +.wy-side-nav-search{ + background: #2b38ff!important; +} + +.wy-side-nav-search input[type=text]{ + border-color:#4DA0B0!important; +} + +.wy-side-nav-search input[type=text]{ + border-radius: 4px!important; +} + +#caption-api { + background: red !important; +} + +#caption-text-api { + text-color: blue !important; +} diff --git a/v2.0.0/_static/doctools.js b/v2.0.0/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/v2.0.0/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/v2.0.0/_static/documentation_options.js b/v2.0.0/_static/documentation_options.js new file mode 100644 index 00000000..f998574c --- /dev/null +++ b/v2.0.0/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '1.0.8', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/v2.0.0/_static/file.png b/v2.0.0/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/v2.0.0/_static/file.png differ diff --git a/v2.0.0/_static/hymd_icon_white.png b/v2.0.0/_static/hymd_icon_white.png new file mode 100644 index 00000000..d0396a17 Binary files /dev/null and b/v2.0.0/_static/hymd_icon_white.png differ diff --git a/v2.0.0/_static/hymd_logl_white_text_abbr.png b/v2.0.0/_static/hymd_logl_white_text_abbr.png new file mode 100644 index 00000000..8c0e50c8 Binary files /dev/null and b/v2.0.0/_static/hymd_logl_white_text_abbr.png differ diff --git a/v2.0.0/_static/jquery-3.5.1.js b/v2.0.0/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/v2.0.0/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. API reference

+
+

4.1. Integrator

+

Integrates equations of motion.

+

Implements the Velocity Verlet integrator. The reversible reference system +propagator algorithm (rRESPA) integrator uses the Velocity Verlet functions +inside the MD loop in the main module.

+
+
+hymd.integrator.integrate_position(positions, velocities, time_step)[source]
+

Position update step of the Velocity Verlet integration algorithm.

+

Computes the position update step of the Velocity Verlet algorithm. The +positions argument is not changed in place.

+
+
Parameters:
+
+
positions(N, D) numpy.ndarray

Array of positions of N particles in D dimensions.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_velocity

The velocity update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step, then the positions are updated a full step using the updated +velocities

+
+\[\mathbf{x}_{\text{new}} = \mathbf{x} + \Delta t \mathbf{v}\]
+
+ +
+
+hymd.integrator.integrate_velocity(velocities, accelerations, time_step)[source]
+

Velocity update step of the Velocity Verlet integration algorithm.

+

Computes the velocity update step of the Velocity Verlet algorithm. The +velocities argument is not changed in place.

+
+
Parameters:
+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
accelerations(N, D) numpy.ndarray

Array of accelerations of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_position

The position update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step

+
+\[\mathbf{v}_{\text{new}} = \mathbf{v} + \frac{\Delta t}{2m} +\mathbf{f}\]
+

before the positions are moved a full step using the updated half-step +velocities.

+
+ +
+
+

4.2. Thermostat

+

Scales or otherwise modifies the particle velocities during simulation to +simulate coupling to an external heat bath with temperature T₀.

+
+
+hymd.thermostat._random_chi_squared(prng: numpy.random._generator.Generator, M: int)float[source]
+

Draw the sum of M squared normally distributed values

+

The value is generated by the Gamma distribution, in lieu of generating +M Gaussian distributed numbers and summing their squares.

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
Mint

Number of standard normally distributed numbers in the sum.

+
+
+
+
Returns:
+
+
float

The sum of M squared normally distributed values centered at +zero with unit standard deviation.

+
+
+
+
+

Notes

+

The sum of the squares of k independent standard normal random variables is +distributed according to a \(\chi^2\) distribution.

+
+\[\chi^2_1 + \chi_2^2 + \chi_3^2 + \dots + \chi_M^2 +\sim +\sigma^2\chi^2(k)\]
+

This is a special case of the \(\Gamma\) distribution, +\(\Gamma(k/2, 2)\), and may be generated by

+
+\[\chi^2(k) \sim 2 \Gamma(k/2, 2)\]
+

References

+

Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of +Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. +J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246.

+
+ +
+
+hymd.thermostat._random_gaussian(prng: numpy.random._generator.Generator)float[source]
+

Draw a single random number from the standard normal distribution +Generate a number from the Gaussian distribution centered at zero with unit +standard deviation, \(N(0, 1)\).

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
+
+
Returns:
+
+
float

A random number drawn from \(N(0, 1)\).

+
+
+
+
+
+ +
+
+hymd.thermostat.csvr_thermostat(velocity: numpy.ndarray, names: numpy.ndarray, config: hymd.input_parser.Config, prng: numpy.random._generator.Generator, comm: mpi4py.MPI.Intracomm = <mpi4py.MPI.Intracomm object>, random_gaussian: Callable[[numpy.random._generator.Generator], float] = <function _random_gaussian>, random_chi_squared: Callable[[numpy.random._generator.Generator, int, float], float] = <function _random_chi_squared>, remove_center_of_mass_momentum: bool = True)numpy.ndarray[source]
+

Canonical sampling through velocity rescaling thermostat

+

Implements the CSVR thermostat. Rescales the system kinetic energy by a +stochastically chosen factor to keep the temperature constant. Requires +communcation of the kinetic energies calculated locally for each MPI rank. +The random numbers sampled through random_gaussian and +random_chi_squared are broadcast from the root rank to the other +ranks to ensure the scaling is performed with the same stochasticity for +all particles in the full system.

+

The velocities are cleaned of center of mass momentum before the thermostat +is applied, and the center of mass momentum is subsequently reapplied. This +is performed for each thermostat coupling group, i.e. the center of mass +momenta of each group is separately removed and reapplied after +thermostatting.

+

The implementation here is based on the derivation presented in the 2008 +Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper.

+
+
Parameters:
+
+
velocity(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
names(N,) numpy.ndarray

Array of particle names.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
random_gaussiancallable, optional

Function for generating standard normally distributed numbers.

+
+
random_chi_squaredcallable, optional

Function for generating \(\chi^2\)-distributed numbers

+
+
remove_center_of_mass_momentumbool, optional

If True, the center of mass of each coupling group is removed before +the thermostat is applied. The center of mass momenta are added back +after the kinetic energy rescaling is complete.

+
+
+
+
+
+

See also

+
+
_random_gaussian

Used to sample Gaussian-distributed numbers.

+
+
_random_chi_squared

Used to sample \(\chi^2\)-distributed numbers.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +

References

+

G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). +G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008).

+
+ +
+
+

4.3. Barostat

+
+

4.3.1. Berendsen Barostat

+

Implements the Berendsen barostat. +Scales the box and particle positions during simulation to +simulate coupling to an external pressure bath set at a +target pressure.

+

It calculates the scaling factor according to: +.. math:

+
\alpha_{L,N} = 1 - \frac{dt n_b}{\tau_p}\β(P_{L,N}^t - P_{L,N})
+
+
+

where \(dt\) is the outer rRESPA time-step, \(n_b\) is the frequency +of barostat calls, \(\tau_p\) is the pressure coupling time constant, +\(\beta\) is the isothermal compressibility, \(P_{L,N}^t\) and +\(P_{L,N}\) is the target and instantaneous internal pressure in the +lateral (L) and normal (N) directions respectively. Convention: Cartesian +z-direction is considered normal.

+

The box and particle positions are scaled in the L and N directions according +to the nature of the barostat (see functions isotropic and semiisotropic +below by an amount \(\α^{\frac{1}{3}}\).

+

The updated system information is passed on to the pmesh objects.

+
+

4.3.1.1. References

+

H. J. C. Berendsen, J. P. M. Postma, W. F. van Gunsteren, +A. DiNola, and J. R. Haak , “Molecular dynamics with coupling +to an external bath”, J. Chem. Phys. 81, 3684-3690 (1984)

+
+
+hymd.barostat.isotropic(pmesh, pm_stuff, phi, phi_q, psi, hamiltonian, positions, velocities, config, phi_fft, phi_laplacian, phi_transfer, bond_pr, angle_pr, step, prng, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Implements an isotropic Berendsen barostat. +The box and particle positions are scaled uniformly +in the L and N directions.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of pmesh objects.

+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fftlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds.

+
+
stepinteger

MD step number

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of modified/unmodified pmesh objects.

+
+
changeBoolean

Indicates whether or not any pmesh objects were reinitialized.

+
+
+
+
+
+ +
+
+hymd.barostat.semiisotropic(pmesh, pm_stuff, phi, phi_q, psi, hamiltonian, positions, velocities, config, phi_fft, phi_laplacian, phi_transfer, bond_pr, angle_pr, step, prng, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Implements a semiisotropic Berendsen barostat. +The box and particle positions are scaled by \(\alpha_L^{\frac{1}{3}}\) +in the L direction and by \(\alpha_N^{\frac{1}{3}}\) in the N direction.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of pmesh objects.

+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fftlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds.

+
+
stepinteger

MD step number

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of modified/unmodified pmesh objects.

+
+
changeBoolean

Indicates whether or not any pmesh objects were reinitialized.

+
+
+
+
+
+ +
+
+
+

4.3.2. SCR Barostat

+
+
+
+

4.4. Hamiltonian

+
+
+class hymd.hamiltonian.Hamiltonian(config)[source]
+

Interaction energy functional superclass

+
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+_setup()[source]
+

Superclass setup

+

Sets up the grid-independent filtering function H, and the +SymPy logic for symbolically differentiating interaction energy +functionals in Hamiltonian subclasses.

+
+ +
+ +
+
+class hymd.hamiltonian.SquaredPhi(config)[source]
+

Simple squared density interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + \sum_k \tilde\phi_k + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(rho_0\) is the +average density of the fully homogenous system. Expressing the species +densities in terms of fluctuations from the average,

+
+\[\mathrm{d}\tilde\phi_k = \rho_0 - \tilde\phi_k,\]
+

it is evident that this interaction energy functional is a slight change of +the DefaultNoChi Hamiltonian, as the expanded interaction energy +density becomes

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + 6\rho_0\left[ + \sum_k \mathrm{d}\tilde\phi_k + \right] + + + 9\rho_0^2 + + + \sum_k \mathrm{d}\tilde\phi_k^2 + + + \prod_{k\not=l} + \mathrm{d}\tilde\phi_k \mathrm{d}\tilde\phi_l + \right),\]
+

identical to DefaultNoChi apart from a constant energy shift +\(9\rho_0^2`(which does not impact dynamics) and the +:math:\)rho_0`–\(\mathrm{d}\tilde\phi_k\) cross-terms. These +cross-terms constitute contributions to the energy linear in +\(\mathrm{d}\tilde\phi_k\) absent in DefaultNoChi, which has +only quadratic terms present.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultNoChi(config)[source]
+

Incompressibility-only interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a +\right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. The SquaredPhi Hamiltonian implements a similar +functional with an additional linear term component depending on

+
+\[\mathmr{d}\tilde\phi_k = \tilde\phi_k - \rho_0\]
+

and not \(\mathrm{d}\tilde\phi_k^2\). No explicit inter-species +interaction is present apart from the indirect interaction through the +incompressibility.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultWithChi(config, unique_names, type_to_name_map)[source]
+

Incompressibility and \(\chi\)-interactions energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = + \frac{1}{2\rho_0} + \sum_{k,l}\chi_{kl} \tilde\phi_k \tilde\phi_l + + + \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. \(\chi_{ij}\) is the Flory-Huggins-like +inter-species mixing energy.

+
+
+__init__(config, unique_names, type_to_name_map)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup(unique_names, type_to_name_map)[source]
+

Setup the interaction energy potential and the external potential

+
+
Parameters:
+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+ +
+ +
+
+

4.5. Force

+

Calculates intramolecular forces between bonded particles in molecules

+
+
+class hymd.force.Angle(atom_1: str, atom_2: str, equilibrium: float, strength: float, atom_3: str)[source]
+

Dataclass representing a single three-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any three-particle bond between particles of specific types A, +B, and C (where A, B, and C may be +different or the same). Harmonic angular three-particle bonds in HyMD take +the form

+
+\[V_3(\mathbf{r}_1, \mathbf{r}_2, \mathbf{r}_3) = + \frac{1}{2}k + \left( + \cos^{-1} + \left[ + \frac{ + (\mathbf{r}_1-\mathbf{r}_2) + \cdot + (\mathbf{r}_3-\mathbf{r}_2) + } + { + \vert\mathbf{r}_1-\mathbf{r}_2\vert + \vert\mathbf{r}_3-\mathbf{r}_2\vert + } + \right] - \theta_0 + \right)^2\]
+
+

See also

+
+
Bond

Two-particle bond type dataclass

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
equilibriumfloat

Equilibrium angle at which the energy associated with the +three-particle angular bond vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient.

+
+
+
+
+
+
+atom_3: str
+
+ +
+ +
+
+class hymd.force.Bond(atom_1: str, atom_2: str, equilibrium: float, strength: float)[source]
+

Dataclass representing a single two-particle bond type

+

A bond type is a bond strength and equilibrium distance associated with +any bond between particles of specific types A and B +(where A and B may be the same or different). Harmonic +two-particle bonds in HyMD take the form

+
+\[V_2(\mathbf{r}_1, \mathbf{r}_2) = + \frac{1}{2}k + \left( + \vert \mathbf{r}_1 - \mathbf{r}_2 \vert - r_0 + \right)^2,\]
+

where \(k\) is the bond strength (spring constant) and \(r_0\) is +the equilibrium bond length (at which the energy is zero).

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
equilibriumfloat

Equilibrium distance at which the energy associated with the bond +vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient (spring constant).

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+equilibrium: float
+
+ +
+
+strength: float
+
+ +
+ +
+
+class hymd.force.Chi(atom_1: str, atom_2: str, interaction_energy: float)[source]
+

Dataclass representing a single \(\chi\) mixing interaction type

+

An interaction mixing energy type is a mixing energy associated with +density overlap between species of types A and B +(specified as inputs atom_1 and atom_2). A positive mixing +energy promotes phase separation, a negative mixing energy promotes mixing. +The interaction energy density (provided the DefaultWithChi +Hamiltonian is used) takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} + \sum_{k,l}\chi_{k,l} \tilde\phi_k\tilde\phi_l,\]
+

where \(\chi_{k,l}\) denotes the mixing energy between species +\(k\) and \(l\), with \(\kappa\) being the incompressibility. +The value of the interaction mixing energy parameter may be extracted from +Flory-Huggins theory.

+
+

See also

+
+
hymd.hamiltonian.DefaultWithChi

Interaction energy functional using \(\chi\)-interactions.

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
interaction_energyfloat

Interaction mixing energy.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+interaction_energy: float
+
+ +
+ +
+
+class hymd.force.Dielectric_type(atom_1: str, dielectric_value: float)[source]
+
+
+atom_1: str
+
+ +
+
+dielectric_value: float
+
+ +
+ +
+
+class hymd.force.Dihedral(atom_1: str, atom_2: str, atom_3: str, atom_4: str, coeffs: numpy.ndarray, dih_type: int)[source]
+

Dataclass representing a single four-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any four-particle torsional bond between particles of specific types +A, B, C, and D (where A, B, +C, and D may be different or the same). Dihedral +four-particle bonds in HyMD take different forms depending on the +dih_type parameter.

+

In the following, let \(\phi\) denote the angle between the planes +spanned by the relative positions of atoms A-B-C +and B-C-D. If dih_type = 0, then

+
+\[V_4(\phi) = \sum_n c_n + \left( + 1 + \cos\left[ + n\phi - d_n + \right] + \right),\]
+

where \(c_n\) are energy coefficients and \(d_n\) are propensity +phases. By default, the cosine sum is truncated at five terms. If +coeffs provides only a single float, this is used as the coiling +propensity parameter \(\lambda\). In this case, \(c_n\) and +\(d_n\) are automatically set to values which promote alpha helical +(\(\lambda=-1\)), beta sheet (\(\lambda=1\)), or a mixed +(\(1>\lambda>-1\)) structure (using values provided by Bore et al. +(2018)). In this case, the full potential takes the form

+
+\[V_4(\phi;\lambda) = + \frac{1}{2}(1-\lambda) V_{\text{prop},\alpha}(\phi) + + + \frac{1}{2}(1+\lambda) V_{\text{prop},\beta}(\phi) + + + (1-\vert\lambda\vert) V_{\text{prop}, \text{coil}}(\phi),\]
+

with each of the \(V_{\mathrm{prop}, X}\) being fixed cosine series +potentials with pre-set \(c_n\) -s and \(d_n\) -s.

+

If dih_type = 1, then a combined bending torsional (CBT) potential +is employed,

+
+\[V_4(\phi,\gamma;\lambda) = + V_4(\phi;\lambda) + + + \frac{1}{2}K(\phi)(\gamma - \gamma_0)^2,\]
+

where \(V_4(\phi;\lambda)\) specifies the potential as given by the +coiling propensity parameter above, \(K(\phi)\) is a separate cosine +series potential acting as the angular three-particle bond strength, and +\(\gamma_0\) is the three-particle bond equilibrium angle. In this +case, the coeffs parameter must specify both a \(\lambda\) +value, in additon to the energy and phases dictating the \(K(\phi)\) +potential.

+

References

+

Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018.

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
atom_4str

Type name of particle 4.

+
+
coeffslist[list[float]] or list[float] or numpy.ndarray

Dihedral coefficients defining the series expansion of the dihedral +energy.

+
+
dih_typeint

Specifies the type of dihedral used; If 0, then coeffs +must contain either two lists of five energy coefficients +\(c_n\) and five propensity phases \(d_n\) or a single +floating point number defining the \(\lambda\) coiling propensity +parameter. If 1, the combined bending-torsional potential is +used, and coeffs must specify \(\lambda\) and two lists +containing energy coefficients and propensity phases for the +\(V_\text{prop}\) propensity potential, defined in terms of cosine +series.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+atom_3: str
+
+ +
+
+atom_4: str
+
+ +
+
+coeffs: numpy.ndarray
+
+ +
+
+dih_type: int
+
+ +
+ +
+
+hymd.force.compute_angle_forces__plain(f_angles, r, bonds_3, box_size)[source]
+

Computes forces resulting from angular interactions

+
+

Deprecated since version 1.0.0: compute_angle_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_bond_forces__plain(f_bonds, r, bonds_2, box_size)[source]
+

Computes forces resulting from bonded interactions

+
+

Deprecated since version 1.0.0: compute_bond_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size)[source]
+

Computes forces resulting from dihedral interactions

+
+

Deprecated since version 1.0.0: compute_dihedral_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.dipole_forces_redistribution(f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb)[source]
+

Redistribute electrostatic forces calculated from topologically +reconstructed ghost dipole point charges to the backcone atoms of the protein.

+
+ +
+
+hymd.force.find_all_paths(G, u, n)[source]
+

Helper function that recursively finds all paths of given lenght ‘n + 1’ inside a network ‘G’. +Adapted from https://stackoverflow.com/a/28103735.

+
+ +
+
+hymd.force.prepare_bonds(molecules, names, bonds, indices, config, topol=None)[source]
+

Rearrange the bond information for usage in compiled Fortran kernels

+

Restructures the lists resulting from the execution of +prepare_bonds_old into numpy arrays suitable for calls to optimized +Fortran code calculating bonded forces and energiesself.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2_atom_1(B,) numpy.ndarray

Local index of particle 1 for each of B constructed +two-particle bonds.

+
+
bonds_2_atom_2(B,) numpy.ndarray

Local index of particle 2 for each of B constructed +two-particle bonds.

+
+
bonds_2_equilibrium(B,) numpy.ndarray

Equilibrium distance for each of B constructed two-particle +bonds.

+
+
bonds_2_strength(B,) numpy.ndarray

Bond strength for each of B constructed two-particle +bonds.

+
+
bonds_3_atom_1(A,) numpy.ndarray

Local index of particle 1 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_2(A,) numpy.ndarray

Local index of particle 2 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_3(A,) numpy.ndarray

Local index of particle 3 for each of A constructed +three-particle bonds.

+
+
bonds_3_equilibrium(A,) numpy.ndarray

Equilibrium angle for each of A constructed three-particle +bonds.

+
+
bonds_3_strength(A,) numpy.ndarray

Bond strength for each of A constructed three-particle +bonds.

+
+
bonds_4_atom_1(D,) numpy.ndarray

Local index of particle 1 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_2(D,) numpy.ndarray

Local index of particle 2 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_3(D,) numpy.ndarray

Local index of particle 3 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_4(D,) numpy.ndarray

Local index of particle 4 for each of D constructed +four-particle bonds.

+
+
bonds_4_coeff(D,) numpy.ndarray

Cosine series coefficients for each of D constructed +four-particle bonds.

+
+
bonds_4_type(D,) numpy.ndarray

Dihedral type for each of D constructed four-particle +bonds.

+
+
bonds_4_last(D,) numpy.ndarray

Flags indicating if dih_type is 1 for each of D +constructed four-particle bonds.

+
+
+
+
+
+

See also

+
+
prepare_bonds_old

Used internally to reconstruct the bonded interactions types from the connectivity information in the structure/topology input file and the bonded types specified in the configuration file.

+
+
+ +
+ +
+
+hymd.force.prepare_bonds_old(molecules, names, bonds, indices, config)[source]
+

Find bonded interactions from connectivity and bond types information

+
+

Deprecated since version 1.0.0: prepare_bonds_old was replaced by prepare_bonds for +use with compiled Fortran kernels prior to 1.0.0 release.

+
+

Prepares the necessary equilibrium and bond strength information needed by +the intramolecular interaction functions. This is performed locally on each +MPI rank, as the domain decomposition ensures that for all molecules all +consituent particles are always contained on the same MPI rankself.

+

This function traverses the bond connectivity information provided in the +structure/topology input file and indentifies any two-, three-, or +four-particle potential bonds. For each connected chain of two, three, or +four particles, a matching to bond types is attempted. If the corresponding +names match, a bond object is initialized.

+

In order to investigate the connectivity, a graph is created using +networkx functionality.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2list

List of lists containing local particle indices, equilibrium +distance, and bond strength coefficient for each reconstructed +two-particle bond.

+
+
bonds_3

List of lists containing local particle indices, equilibrium angle, +and bond strength coefficient for each reconstructed three-particle +bond.

+
+
bonds_4

List of lists containing local particle indices, dihedral type index, +and dihedral coefficients for each reconstructed four-particle +torsional bond.

+
+
bb_indexlist

List indicating the dihedral type of each four-particle bond in +bonds_4.

+
+
+
+
+
+

See also

+
+
Bond

Two-particle bond type dataclass.

+
+
Angle

Three-particle angular bond type dataclass.

+
+
Dihedral

Four-particle torsional bond type dataclass.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+hymd.force.prepare_index_based_bonds(molecules, topol)[source]
+
+ +
+
+hymd.force.propensity_potential_coeffs(x: float)[source]
+
+ +
+
+

4.6. Pressure

+
+
+hymd.pressure.comp_pressure(phi, phi_q, psi, hamiltonian, velocities, config, phi_fourier, phi_laplacian, phi_transfer, positions, bond_pr, angle_pr, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Computes total internal pressure of the system. +Kinetic pressure is trivially calculated from the kinetic energy. +Already computed bond and angle pressure terms are inserted into the +total internal pressure. +The field pressure equation is implemented.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fourierlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pressure(18,) numpy.ndarray

Pressure contributions from various energy terms. +0: due to kinetic energy +1-5: due to field energy +6-8: due to two-particle bonded terms +9-11: due to three-particle bonded terms (called angle terms) +12-14: due to four-particle bonded terms (called dihedral terms) +(defaults to 0 currently. Yet to be implemented) +15-17: total pressure in x,y,z directions.

+
+
+
+
+
+ +
+
+

4.7. Logger

+
+
+class hymd.logger.Logger[source]
+

Log output handler class

+

Notes

+

This wraps the default python library logging, see +docs.python.org/3/library/logging.html.

+
+
Attributes:
+
+
levelint

Determines the verbosity level of the log, corresponding to +logging.level. Numerical values 50 (logging.CRITICAL), +40 (logging.ERROR), 30 +(logging.WARNING), 20 (logging.INFO), +10 (logging.DEBUG), and 0 +(logging.UNSET) are supported values. Any log event message +less severe than the specified level is ignored. All other event +messages are emitted.

+
+
log_filestr

Path to output log file.

+
+
formatstr

Prepended dump string for each log event. Specifies the log event +level, the module emitting the event, the code line, the enclosing +function name, and the MPI rank writing the message.

+
+
date_formatstr

Prepends the date before all log event messages.

+
+
formatterlogging.Formatter

Formatter handling the prepending of the information in format and +date_format to each log event message. Used by default for all +loggers.

+
+
rank0logging.Logger

Default logger object for the root MPI rank.

+
+
all_rankslogging.Logger

Default logger object for messages being emitted from all MPI ranks +simultaneously.

+
+
+
+
+
+
+classmethod setup(default_level=20, log_file=None, verbose=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Sets up the logger object.

+

If a log_file path is provided, log event messages are output +to it. Otherwise, the logging messages are emitted to stdout.

+
+
Parameters:
+
+
default_levelint, optional

Default verbosity level of the logger. Unless specified, it is +10 (logging.INFO).

+
+
log_filestr, optional

Path to output log file. If None or not priovided, no log file is +used and all logging is done to stdout.

+
+
verbosebool, optional

Increases the logging level to 30 (logging.WARNING) +if True, otherwise leaves the logging level unchanged.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterRoot(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the root MPI rank log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterAll(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the all-MPI-ranks log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+

4.8. Input parser

+

Parses and handles the configuration information provided for the simulation

+
+
+class hymd.input_parser.Config(n_steps: int, time_step: float, mesh_size: Union[List[int], numpy.ndarray, int], sigma: float, kappa: float, dtype: Optional[numpy.dtype] = None, box_size: Optional[Union[List[float], numpy.ndarray]] = None, n_print: Optional[int] = None, tau: Optional[float] = None, start_temperature: Optional[Union[float, bool]] = None, target_temperature: Optional[Union[float, bool]] = None, mass: Optional[float] = None, hamiltonian: Optional[str] = None, domain_decomposition: Optional[Union[int, bool]] = None, integrator: Optional[str] = None, respa_inner: int = 1, file_name: str = '<config file path unknown>', name: Optional[str] = None, tags: List[str] = <factory>, bonds: List[hymd.force.Bond] = <factory>, angle_bonds: List[hymd.force.Angle] = <factory>, dihedrals: List[hymd.force.Dihedral] = <factory>, chi: List[hymd.force.Chi] = <factory>, n_particles: Optional[int] = None, max_molecule_size: Optional[int] = None, n_flush: Optional[int] = None, thermostat_work: float = 0.0, thermostat_coupling_groups: List[List[str]] = <factory>, initial_energy: Optional[float] = None, cancel_com_momentum: Union[int, bool] = False, coulombtype: Optional[str] = None, convergence_type: Optional[str] = None, pol_mixing: Optional[float] = None, dielectric_const: Optional[float] = None, conv_crit: Optional[float] = None, dielectric_type: List[hymd.force.Dielectric_type] = <factory>, self_energy: Optional[float] = None, type_charges: Optional[Union[List[float], numpy.ndarray]] = None, rho0: Optional[float] = None, a: Optional[float] = None, pressure: bool = False, barostat: Optional[str] = None, barostat_type: Optional[str] = None, tau_p: Optional[float] = None, target_pressure: List[hymd.barostat.Target_pressure] = <factory>, n_b: Optional[int] = None, m: List[float] = <factory>)[source]
+

Configuration object

+

Handles and verifies the simulation configuration specified in the +configuration file.

+
+

See also

+
+
hymd.input_parser.Bond

Two-particle bond type dataclass.

+
+
hymd.input_parser.Angle

Three-particle bond type dataclass.

+
+
hymd.input_parser.Dihedral

Four-particle bond type dataclass.

+
+
+ +
+
Attributes:
+
+
gas_constantfloat

Constant value of the gas constant, R (equivalently the Boltzmann +constant) in the units used internally in HyMD.

+
+
coulomb_constantfloat

Constant value of the Coulomb constant which converts electric field +values to forces and electric potential values to energies in the units +used internally in HyMD.

+
+
n_steps: int

Number of time steps in the simulation.

+
+
time_step: float

Outer time step used in the simulation. If the rRESPA intergrator is +used, the inner time step (the time step used in the integration of +intramolecular bending, stretching, and torsional forces) is +time_step / respa_inner.

+
+
box_sizelist[float] or (D,) numpy.ndarray

Simulation box size of simulation in D dimensions in units of +nanometers.

+
+
mesh_sizelist[int] or int or numpy.ndarray

Number of grid points used for the discrete density grid.

+
+
sigmafloat

Filter width representing the effective coarse-graining level of the +particles in the simulation.

+
+
kappafloat

Compressibility parameter used in the relaxed incompressibility term in +the interaction energy functional.

+
+
n_printint, optional

Frequency of trajectory/energy output to the H5MD trajectory/energy +output file (in units of number of time steps).

+
+
taufloat, optional

The time scale of the CSVR thermostat coupling.

+
+
start_temperaturefloat, optional

Generate starting temperature by assigning all particle velocities +randomly according to the Maxwell-Boltzmann distribution at +start_temperature Kelvin prior to starting the simulation.

+
+
target_temperaturefloat, optional

Couple the system to a heat bath at target_temperature Kelvin.

+
+
massfloat, optional

Mass of the particles in the simulation.

+
+
hamiltonianstr, optional

Specifies the interaction energy functional \(W[\tilde\phi]\) +for use with the particle-field interactions. Options: +SquaredPhi, DefaultNohChi, or DefaultWithChi.

+
+
domain_decompositionint, optional

Specifies the interval (in time steps) of domain decomposition +exchange, involving all MPI ranks sending and receiving particles +according to the particles’ positions in the integration box and the +MPI ranks’ assigned domain.

+
+
integratorstr, optional

Specifies the time integrator used in the simulation. Options: +velocity-verlet or respa.

+
+
respa_innerint, optional

The number of inner time steps in the rRESPA integrator. This denotes +the number of intramolecular force calculations (stretching, bending, +torsional) are performed between each impulse applied from the field +forces.

+
+
file_namestr, optional

File path of the parsed configuration file.

+
+
namestr, optional

Name for the simulation.

+
+
tagslist[str], optional

Tags for the simulation.

+
+
bondslist[Bond], optional

Specifies harmonic stretching potentials between particles in the +same molecule.

+
+
angle_bondslist[Angle], optional

Specifies harmonic angular bending potentials between particles in the +same molecule.

+
+
dihedralslist[Dihedral], optional

Specifies four-particle torsional potentials by cosine series.

+
+
chilist[Chi], optional

Specifies \(\chi\)-interaction parameters between particle +species.

+
+
n_particlesint, optional

Specifies the total number of particles in the input. Optional keyword +for validation, ensuring the input HDF5 topology has the correct number +of particles and molecules.

+
+
max_molecule_sizeint, optional

Maximum size of any single molecule in the system. Used to speed up +distribution of particles onto MPI ranks in a parallel fashion.

+
+
n_flushint, optional

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be +written to disk (in units of number of n_print).

+
+
thermostat_workfloat

Work performed by the thermostat on the system.

+
+
thermostat_coupling_groupslist[str], optional

Specifies individual groups coupling independently to the CSVR +thermostat. E.g. in a system containing "A", "B", and +"C" type particles, +thermostat_coupling_groups = [["A", "B"], ["C"],] would +thermalise types "A" and "B" together and couple +"C" type particles to a different thermostat (all individual +thermostats are at the same temperature, i.e. target_temperature +Kelvin).

+
+
initial_energyfloat

Value of the total energy prior to the start of the simulation.

+
+
cancel_com_momentumint, optional

If True, the total linear momentum of the center of mass is +removed before starting the simulation. If an integer is specifed, the +total linear momentum of the center of mass is removed every +remove_com_momentum time steps. If False, the linear +momentum is never removed.

+
+
coulombtypestr, optional

Specifies the type of electrostatic Coulomb interactions in the system. +The strength of the electrostatic forces is modulated by the relative +dielectric constant of the simulation medium, specified with the +dielectric_const keyword. Charges for individual particles are +specified in the structure/topology HDF5 input file, not in the +configuration file. If no charges (or peptide backbone dipoles) are +present, the electrostatic forces will not be calculated even if this +keyword is set to "PIC_Spectral".

+
+
dielectric_constfloat, optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. When +using helical propensity dihedrals, this keyword must be specified—even +if electrostatics are not included with the coulombtype +keyword.

+
+
dielectric_type: list[float], optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. The list assigns +relative dielectric values to each bead type, and an anisotropic +dielectric function is obtained from a weighted average.

+
+
+
+
+
+
+a: float = None
+
+ +
+
+angle_bonds: List[hymd.force.Angle]
+
+ +
+
+barostat: str = None
+
+ +
+
+barostat_type: str = None
+
+ +
+
+bonds: List[hymd.force.Bond]
+
+ +
+
+box_size: Union[List[float], numpy.ndarray] = None
+
+ +
+
+cancel_com_momentum: Union[int, bool] = False
+
+ +
+
+chi: List[hymd.force.Chi]
+
+ +
+
+conv_crit: float = None
+
+ +
+
+convergence_type: str = None
+
+ +
+
+coulomb_constant: ClassVar[float] = 138.935458
+
+ +
+
+coulombtype: str = None
+
+ +
+
+dielectric_const: float = None
+
+ +
+
+dielectric_type: List[hymd.force.Dielectric_type]
+
+ +
+
+dihedrals: List[hymd.force.Dihedral]
+
+ +
+
+domain_decomposition: Union[int, bool] = None
+
+ +
+
+dtype: numpy.dtype = None
+
+ +
+
+file_name: str = '<config file path unknown>'
+
+ +
+
+gas_constant: ClassVar[float] = 0.0083144621
+
+ +
+
+hamiltonian: str = None
+
+ +
+
+initial_energy: float = None
+
+ +
+
+integrator: str = None
+
+ +
+
+kappa: float
+
+ +
+
+m: List[float]
+
+ +
+
+mass: float = None
+
+ +
+
+max_molecule_size: int = None
+
+ +
+
+mesh_size: Union[List[int], numpy.ndarray, int]
+
+ +
+
+n_b: int = None
+
+ +
+
+n_flush: int = None
+
+ +
+
+n_particles: int = None
+
+ +
+
+n_print: int = None
+
+ +
+
+n_steps: int
+
+ +
+
+name: str = None
+
+ +
+
+pol_mixing: float = None
+
+ +
+
+pressure: bool = False
+
+ +
+
+respa_inner: int = 1
+
+ +
+
+rho0: float = None
+
+ +
+
+self_energy: float = None
+
+ +
+
+sigma: float
+
+ +
+
+start_temperature: Union[float, bool] = None
+
+ +
+
+tags: List[str]
+
+ +
+
+target_pressure: List[hymd.barostat.Target_pressure]
+
+ +
+
+target_temperature: Union[float, bool] = None
+
+ +
+
+tau: float = None
+
+ +
+
+tau_p: float = None
+
+ +
+
+thermostat_coupling_groups: List[List[str]]
+
+ +
+
+thermostat_work: float = 0.0
+
+ +
+
+time_step: float
+
+ +
+
+type_charges: Union[List[float], numpy.ndarray] = None
+
+ +
+ +
+
+hymd.input_parser.check_NPT_conditions(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check validity of barostat_type, barostat, +a, rho0, target_pressure, tau_p

+
+ +
+
+hymd.input_parser.check_angles(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_bonds(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_box_size(config, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_cancel_com_momentum(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_charges(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if charges across ranks sum to zero.

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of floats with charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_charges_types_list(config, types, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates a list of charge values of length types. +Charges are sorted according to type ID. Used in field.py. +# TODO: this is messy, we should fix it

+
+ +
+
+hymd.input_parser.check_chi(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_config(config, indices, names, types, charges, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs various checks on the specfied config to ensure consistency

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
indices(N,) numpy.ndarray

Array of integer indices for N particles.

+
+
names(N,) numpy.ndarray

Array of string names for N particles.

+
+
types(N,) numpy.ndarray

Array of integer type indices for N particles.

+
+
charges(N,) numpy.ndarray

Array of floats charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
Returns:
+
+
configConfig

Validated configuration object.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_dielectric(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Error handling for electrostatics. +Unit testing of toml/tomli input.

+
+ +
+
+hymd.input_parser.check_dihedrals(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_domain_decomposition(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_hamiltonian(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_integrator(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_m(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_mass(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_max_molecule_size(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_b(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_flush(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_particles(config, indices, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_print(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_name(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_start_and_target_temperature(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Validate provided starting and target thermostat temperatures

+

Assesses the provided temperature target and ensures it is a non-negative +floating point number or False. Ensures the starting temperature is +a non-negative floating point number or False.

+

If the value for either is None, the returned configuration object +has the values defaulted to False in each case.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
validated_configConfig

Configuration object with validated target_temperature and +start_temperature.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_tau(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_thermostat_coupling_groups(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.parse_config_toml(toml_content, file_path=None, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.read_config_toml(file_path)[source]
+
+ +
+
+hymd.input_parser.sort_dielectric_by_type_id(config, charges, types)[source]
+

Creates a list of length N CG-particles, sorted after the charges from +the input HDF5 file. Used in file_io.py

+
+ +
+
+

4.9. Field

+

Forces and energies from the discretized particle-field grid interactions

+
+
+hymd.field.compute_field_and_kinetic_energy(phi, phi_q, psi, velocity, hamiltonian, positions, types, v_ext, config, layouts, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the particle-field and kinetic energy contributions

+

Calculates the kinetic energy through

+
+\[E_k = \sum_j \frac{1}{2}m_j\mathbf{v}_j\cdot\mathbf{v}_j,\]
+

and the particle-field energy by

+
+\[E_\text{field} = \int\mathrm{d}\mathbf{r}\, + w[\tilde\phi],\]
+

where \(w\) is the interaction energy functional density.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
velocity(N,D) numpy.ndarray

Array of velocities for N particles in D dimensions. +Local for each MPI rank.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Local for each MPI rank–the full computational grid is +represented by the collective fields of all MPI ranks.

+
+
configConfig

Configuration object.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field

Computes the up-to-date external potential for use in calculating the particle-field energy.

+
+
+ +
+ +
+
+hymd.field.compute_field_energy_q_GPE(config, phi_eps, field_q_energy, dot_elec, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the electrostatic energy after electrosatic forces is +calculated.

+

From the definition of the elecrostatic potential \(\Psi\), the energy +is

+
+
+
W = frac{1}{2}intmathrm{d}mathbf{r},

epsilon(mathbf{r})} left(mathbf{E}cdot mathbf{E}right),

+
+
+
+

where \(\epsilon(\mathbf{r})}\) is the anisotropic, spatially dependent, +relative dielectric of the simulation medium.

+
+
Parameters:
+
+
confighymd.input_parser.Config

Configuration object.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
field_q_energyfloat

Total elecrostatic energy.

+
+
dot_elecpmesh.pm.RealField

Pmesh RealField object for storing \(|\mathbf{E(r)}|^{2}\) +on the computational grid. Local for each MPI rank – the full computational +grid is represented by the collective fields of all MPI ranks.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field_force_q_GPE

Compute the electrosatic force from an anisotropic dielectric general Poisson equation.

+
+
+ +
+ +
+
+hymd.field.compute_field_force(layouts, r, force_mesh, force, types, n_types)[source]
+

Interpolate particle-field forces from the grid onto particle positions

+

Backmaps the forces calculated on the grid to particle positions using the +window function \(P\) (by default cloud-in-cell [CIC]). In the +following, let \(\mathbf{F}_j\) denote the force acting on the +particle with index \(j\) and position \(\mathbf{r}_j\). The +interpolated force is

+
+\[\mathbf{F}_j = -\sum_k\nabla V_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(V_{j_k}\) is the discretized external potential at grid vertex +\(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid vertex +with index \(j_k\), and \(h^3\) is the volume of each grid voxel. +The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
r(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
force(N,D) numpy.ndarray

Array of forces for N particles in D dimensions. Local +for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
n_typesint

Number of different unique types present in the simulation system. +n_types is global, i.e. the same for all MPI ranks even if some +ranks contain zero particles of certain types.

+
+
+
+
+
+ +
+
+hymd.field.compute_self_energy_q(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the self energy for the interaction due to the Ewald scheme +used to compute the electrostatics. The energy is stored in config.

+

The self interaction energy is given by:

+
+\[U_{self} = \sqrt{\frac{1}{2\pi\sigma^2}} \sum_{i=1}^{N} q_i^2\]
+

where \(q_i\) are the charges and \(\sigma\) is the half-width +of the Gaussian filter.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
Returns:
+
+
field_q_self_energyfloat

Electrostatic self energy.

+
+
+
+
+
+ +
+
+hymd.field.domain_decomposition(positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs domain decomposition

+

Rearranges the MPI rank memory layout into one that better mimics the PFFT +pencil grid 2D decomposition. As molecules are always required to be fully +contained on a single MPI rank, a perfect decomposition is not always +possible. The best decomposition which leaves the center of mass of all +molecules in their respective correct domains is used, with possible +overlap into neighbouring domains if the spatial extent of any molecule +crosses domain boundaries.

+
+
Parameters:
+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
*args

Variable length argument list containing arrays to include in the +domain decomposition.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
bonds(N,M) numpy.ndarray, optional

Array of M bonds originating from each of N particles.

+
+
verboseint, optional

Specify the logging event verbosity of this function.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
Domain decomposedcode:positions and any array specified in
+
:code:`*args`, in addition tocode:bonds and molecules if these
+
arrays were provided as input.
+
+
+
+
+ +
+
+hymd.field.initialize_pm(pmesh, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates the necessary pmesh objects for pfft operations.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pmobject ‘pmesh.pm.ParticleMesh’
+
field_listlist[pmesh.pm.RealField], (multiple)

Essential list of pmesh objects required for MD

+
+
list_coulomblist[pmesh.pm.RealField], (multiple)

Additional list of pmesh objects required for electrostatics.

+
+
+
+
+
+ +
+
+hymd.field.update_field(phi, phi_laplacian, phi_transfer, layouts, force_mesh, hamiltonian, pm, positions, types, config, v_ext, phi_fourier, v_ext_fourier, m, compute_potential=False)[source]
+

Calculate the particle-field potential and force density

+

If compute_potential is True, the energy may subsequently +be computed by calling compute_field_and_kinetic_energy.

+

Computes the particle-field external potential \(V_\text{ext}\) from +particle number densities through the smoothed density field, +\(\phi(\mathbf{r})\). With \(P\) being the cloud-in-cell (CIC) +window function, the density and filtered densities are computed as

+
+\[\phi(\mathbf{r}) = \sum_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\phi(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +external potential is computed in reciprocal space as

+
+\[V_\text{ext} = \mathrm{FFT}^{-1}\left[ + \mathrm{FFT} + \left( + \frac{\partial w}{\partial \tilde\phi} + \right) + \mathrm{FFT}(H) +\right],\]
+

where \(w\) is the interaction energy functional. Differentiating +\(V_\text{ext}\) is done by simply applying \(i\mathbf{k}\) in +Fourier space, and the resulting forces are back-transformed to direct +space and interpolated to particle positions by

+
+\[\mathbf{F}_j = -\sum_{j_k} \nabla V_{j_k} + P(\mathbf{r}_{j_k} - \mathbf{r}_j)h^3,\]
+

where \(j_k\) are the neighbouring vertices of particle \(j\) at +position \(\mathbf{r}_j\), and \(h^3\) is the volume of each grid +voxel.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Pre-allocated, but empty; any values +in this field are discarded. Changed in-place. Local for each MPI +rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
configConfig

Configuration object.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Pre-allocated, but empty; any values in this field are +discarded Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
phi_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computational grid is represented by the collective fields of all +MPI ranks.

+
+
v_ext_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplesField objects containing discretized +particle-field external potential values in reciprocal space on the +computational grid; D+1 fields in D dimensions for each +particle type. D copies are made after calculation for later +use in force calculation, because the force transfer function +application differentiates the field in-place, ruining the contents +for differentiation in the remaining D-1 spatial directions. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
m: list[float], (M,)

pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. +Defaults to 1.0 for all particle types.

+
+
compute_potentialbool, optional

If True, a D+1-th copy of the Fourier transformed +external potential field is made to be used later in particle-field +energy calculation. If False, only D copies are made.

+
+
+
+
+
+

See also

+
+
compute_field_and_kinetic_energy

Compute the particle-field energy after the external potential is calculated.

+
+
+ +
+ +
+
+hymd.field.update_field_force_q(charges, phi_q, phi_q_fourier, psi, psi_fourier, elec_field_fourier, elec_field, elec_forces, layout_q, hamiltonian, pm, positions, config)[source]
+

Calculate the electrostatic particle-field forces on the grid

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential is computed in reciprocal space as

+
+\[\Phi = \mathrm{FFT}^{-1}\left[ + \frac{4\pi k_e}{\varepsilon \vert\mathbf{k}\vert^2} + \mathrm{FFT}(\rho)\mathrm{FFT}(H) +\right],\]
+

with the electric field

+
+\[\mathbf{E} = \mathrm{FFT}^{-1}\left[ + -i\mathbf{k}\,\mathrm{FFT}(\Psi) +\right].\]
+

In the following, let \(\mathbf{F}_j\) denote the electrostatic force +acting on the particle with index \(j\) and position +\(\mathbf{r}_j\). The interpolated electrostatic force is

+
+\[\mathbf{F}_j = \sum_k q_j\mathbf{E}_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(\mathbf{E}_{j_k}\) is the discretized electric field at grid +vertex \(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid +vertex with index \(j_k\), and \(h^3\) is the volume of each grid +voxel. The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty; any values in this field +are discarded. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
elec_field_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +electric field values in reciprocal space on the computational grid. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
+
+
+
+ +
+
+hymd.field.update_field_force_q_GPE(conv_fun, phi, types, charges, phi_q, phi_q_fourier, phi_eps, phi_eps_fourier, phi_eta, phi_eta_fourier, phi_pol_prev, phi_pol, elec_field, elec_forces, elec_field_contrib, psi, Vbar_elec, Vbar_elec_fourier, force_mesh_elec, force_mesh_elec_fourier, hamiltonian, layout_q, layouts, pm, positions, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Calculate the electrostatic particle-field forces on the grid, arising from +a general Poisson equation, i.e. anisotropic permittivity/dielectric. +The function is called when tomli input config.coulombtype = “PIC_Spectral_GPE.”

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential for a variable dielectric does not have an +analytical expression, and is computed in reciprocal through an iterative +method.

+

The GPE states that

+
+\[\nabla \cdot \left(\epsilon(\mathbf{r}) +\nabla{\mathbf{\psi(r)}}\right) = -\rho({\mathbf{r}}).\]
+

where \(\epsilon(\mathbf{r})\) is the relative dielectric function.

+
+
Parameters:
+
+
conv_funConvergence function.

Returns a scalar. Depends on MPI allreduce for similar convergence +across MPI ranks.

+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_eps_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_etapmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +gradients of the relative dielectric values on the computational grid. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank–the +full computational grid is represented by the collective fields of all MPI ranks.

+
+
phi_eta_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated discretized +Fourier transformed gradient relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_pol_prevpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charge values on the computational grid. Parameter in +the iterative method.Pre-allocated,but empty. Changedin-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_polpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charges on the computational grid. Parameter in the iterative +method, updating the next quess in solving for the electrostatic potential. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank– +the full computational grid is represented by the collective fields of +all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all +MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
elec_field_contribpmesh.pm.RealField

Pmesh RealField object for storing +\(|\mathbf{E(r)}|^2/\phi_{0}\) on the computational grid. +Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
psipmesh.pm.RealField

Pmesh RealField object for storing electrostatic potential +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
Vbar_elecmesh.pm.RealField

Pmesh RealField object for storing functional derivatives of +:math:`|w({ phi })_{elec}`on the computational grid. +Pre-allocated, but empty. Changed in-place. Local for each MPI rank– +the full computational grid is represented by the collective fields of

+
+

all MPI ranks.

+
+
+
Vbar_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated functional +derivatives of \(\|w(\{ \phi \})_{elec}\) in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
force_mesh_elecpmesh.pm.RealField

Pmesh RealField object for storing electrostatic force values +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
force_mesh_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated electrostatic +force values in reciprocal space on the computational grid. Local for +each MPI rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
layouts: list[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
comm: mpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
compute_field_energy_q_GPE

Compute the electrostatic energy after electrosatic force is calculated for a variable (anisotropic) dielectric general Poisson equation.

+
+
+ +
+ +
+
+

4.10. File input/output

+

Handle file input/output in parllel HDF5 fashion

+
+
+class hymd.file_io.OutDataset(dest_directory, config, double_out=False, disable_mpio=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

HDF5 dataset handler for file output

+
+
+close_file(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Closes the HDF5 output file

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+
+flush()[source]
+

Flushes output buffers, forcing file writes

+
+ +
+
+is_open(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if HDF5 output file is open

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+ +
+
+hymd.file_io.distribute_input(in_file, rank, size, n_particles, max_molecule_size=201, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Assign global arrays onto MPI ranks, attempting load balancing

+

Distributes approximately equal numbers of particles (workload) onto each +independent MPI rank, while respecting the requirement that any molecule +must be fully contained on a single MPI rank only (no splitting molecules +across multiple CPUs).

+
+
Parameters:
+
+
in_fileh5py.File

HDF5 input file object.

+
+
rankint

Local rank number for this MPI rank.

+
+
sizeint

Global size of the MPI communicator (number of total CPUs).

+
+
n_particlesint

Total number of particles.

+
+
max_molecule_sizeint, optional

Maximum size of any molecule present in the system. Used to initially +guess where the MPI rank boundaries (start/end indices) in the global +arrays should be placed. If molecules of size +>max_molecule_size exist in the simulation system, HyMD +might work as expected. Or it might fail spectacularly.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
rank_range

Starting and ending indices in the global arrays for each MPI rank.

+
+
+
+
+
+ +
+
+hymd.file_io.setup_time_dependent_element(name, parent_group, n_frames, shape, dtype, units=None)[source]
+

Helper function for setting up time-dependent HDF5 group datasets

+

All output groups must adhere to the H5MD standard, meaning a structure of

+
+
┗━ group particle group (e.g. all) or observables group
+
+
┗━ group time-dependent data
+
+
┣━ dataset step shape=(n_frames,)
+
┣━ dataset time shape=(n_frames,)
+
┗━ dataset value shape=(n_frames, *)
+
+
+
+

is necessary.

+

References

+
+
H5MD specification :

https://www.nongnu.org/h5md/h5md.html

+
+
+
+ +
+
+hymd.file_io.store_data(h5md, step, frame, indices, positions, velocities, forces, box_size, temperature, pressure, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, field_energy, field_q_energy, plumed_bias, time_step, config, velocity_out=False, force_out=False, charge_out=False, plumed_out=False, dump_per_particle=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Writes time-step data to HDF5 output file

+

Handles all quantities which change during simulation, as opposed to +static quanitities (see store_static).

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
stepint

Step number.

+
+
frameint

Output frame number (step // n_print).

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
positions(N,) numpy.ndarray

Array of positions for N particles in D dimensions.

+
+
velocities(N,) numpy.ndarray

Array of velocities for N particles in D dimensions.

+
+
forces(N,) numpy.ndarray

Array of forces for N particles in D dimensions.

+
+
box_size(D,) numpy.ndarray

Array containing the simulation box size.

+
+
temperaturefloat

Calculated instantaneous temperature.

+
+
kinetic_energyfloat

Calculated instantaneous kinetic energy.

+
+
bond2_energyfloat

Calculated instantaneous harmonic two-particle bond energy.

+
+
bond3_energyfloat

Calculated instantaneous harmonic angular three-particle bond energy.

+
+
bond4_energyfloat

Calculated instantaneous dihedral four-particle torsion energy.

+
+
field_energyfloat

Calculated instantaneous particle-field energy.

+
+
field_q_energyfloat

Calculated instantaneous electrostatic energy.

+
+
plumed_biasfloat

PLUMED instantaneous bias energy.

+
+
time_stepfloat

Value of the time step.

+
+
configConfig

Configuration object.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charge_outbool, optional

If True, electrostatic energies are written to the output +HDF5 file.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to the output HDF5 file.

+
+
dump_per_particlebool, optional

If True, all quantities are written per particle.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
store_static

Outputs all static time-independent quantities to the HDF5 output file

+
+
+ +
+ +
+
+hymd.file_io.store_static(h5md, rank_range, names, types, indices, config, bonds_2_atom1, bonds_2_atom2, molecules=None, velocity_out=False, force_out=False, charges=False, dielectrics=False, plumed_out=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Outputs all static time-independent quantities to the HDF5 output file

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
rank_rangelist[int]

Start and end indices for global arrays for each MPI rank.

+
+
names(N,) numpy.ndarray

Array of names for N particles.

+
+
types(N,) numpy.ndarray

Array of type indices for N particles.

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
configConfig

Configuration object.

+
+
bonds_2_atom1(B,) numpy.ndarray

Array of indices of the first particle for B total +two-particle bonds.

+
+
bonds_2_atom2(B,) numpy.ndarray

Array of indices of the second particle for B total +two-particle bonds.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles.

+
+
dielectrics(N,) numpy.ndarray

Array of particle relative dielectric values for N particles.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to output HDF5 file.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
prepare_bonds

Constructs two-, three-, and four-particle bonds from toplogy input file and bond configuration information.

+
+
distribute_input

Distributes input arrays onto MPI ranks, attempting load balancing.

+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/doc_pages/benchmarks.html b/v2.0.0/doc_pages/benchmarks.html new file mode 100644 index 00000000..62916ec9 --- /dev/null +++ b/v2.0.0/doc_pages/benchmarks.html @@ -0,0 +1,317 @@ + + + + + + + 3. Benchmarks — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Benchmarks

+

Homopolymer melt test systems of \(30^2\), \(40^2\), and \(50^2\) +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively.

+
+

3.1. Bonded forces

+

Legend label denotes the number of particles in the system.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-1.png +
+
+
+

3.2. Particle–field forces

+

Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-2.png +
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/doc_pages/command_line.html b/v2.0.0/doc_pages/command_line.html new file mode 100644 index 00000000..bc7b6592 --- /dev/null +++ b/v2.0.0/doc_pages/command_line.html @@ -0,0 +1,374 @@ + + + + + + + 5. Command line arguments — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. Command line arguments

+

Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle–field interactions.

+
+

5.1. Required arguments

+
+
configuration file:
+

type positional

+

Specifies the .toml format configuration file containing simulation details. See Configuration file for details.

+
+
structure and topology file:
+

type positional

+

Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See Topology and structure file for details.

+
+
+
+
+

5.2. Optional arguments

+
+
-v  --verbose

type optional

+

Number of following arguments: 0 or 1

+

Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying -v or --verbose with no additional specification. This increases verbosity level by 1. Alternatively, it maye be specified by --verbose V with V being 0, 1, or 2.

+
+
--profile

type optional

+

Number of following arguments: 0

+

Enables code profiling using cProfile. This will output one profiling file per MPI rank invoked in the simulation.

+
+
--double-precision

type optional

+

Number of following arguments: 0

+

Specify usage of double precision internally in HyMD (including in the FFTs).

+
+
--double-output

type optional

+

Number of following arguments: 0

+

Specify usage of double precision in the output trajectory from HyMD.

+
+
--velocity-output

type optional

+

Number of following arguments: 0

+

Specify that velocities should be output to the HyMD trajectory.

+
+
--force-output

type optional

+

Number of following arguments: 0

+

Specify that forces should be output to the HyMD trajectory.

+
+
--disable-mpio

type optional

+

Number of following arguments: 0

+

Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult.

+
+
--logfile

type optional

+

Number of following arguments: 1

+

Specifies the path of a plain text log file in which stdout is mirrored during simulation runs.

+
+
--seed

type optional

+

Number of following arguments: 1

+

Specifies the random seed used in the numpy random library to generate velocities, thermostatting, etc.

+
+
--disable-bonds

type optional

+

Number of following arguments: 0

+

Disable any two-particle bonds present in the system.

+
+
--disable-angle-bonds

type optional

+

Number of following arguments: 0

+

Disable any three-particle bonds present in the system.

+
+
--disable-dihedrals

type optional

+

Number of following arguments: 0

+

Disable any four-particle bonds present in the system.

+
+
--disable-dipole

type optional

+

Number of following arguments: 0

+

Disable any topological reconstruction of peptide backbone dipoles present in the system.

+
+
--disable-field

type optional

+

Number of following arguments: 0

+

Disable any particle–field interactions present in the system.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/doc_pages/config_file.html b/v2.0.0/doc_pages/config_file.html new file mode 100644 index 00000000..0d53b3ed --- /dev/null +++ b/v2.0.0/doc_pages/config_file.html @@ -0,0 +1,507 @@ + + + + + + + 3. Configuration file — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Configuration file

+

The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order.

+

The configuration file is a toml format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs.

+
+

3.1. Configuration file keywords

+

The following constitutes every possible keyword specification in HyMD +configuration files:

+
+

3.1.1. Metadata keywords

+

Configuration keywords specifying metadata for the H5MD output trajectory.

+
+
name:
+

string [optional, default: None]

+

Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file.

+
+
tags:
+

array [string] [optional, default: None]

+

Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file.

+
+
+
+
+

3.1.2. Particle keywords

+

Configuration keywords specifying properties of particles and molecules in the +system.

+
+
n_particles:
+

integer [optional, default: None]

+

Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules.

+
+
mass:
+

float [optional, default: 72.0] {units: \(\text{u}=\text{g}\,\text{mol}^{-1}\)}

+

Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal.

+
+
max_molecule_size:
+

integer [optional, default: 201]

+

Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code will crash if there are molecules larger than max_molecule_size in the topology/structure input file.

+
+
+
+
+

3.1.3. Simulation keywords

+

Configuration keywords specifying simulation parameters.

+
+
n_steps:
+

integer [required]

+

Total number of integration steps to perform for this simulation.

+
+
n_print:
+

integer or boolean [optional, default: False]

+

Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of number of time steps).

+
+
n_flush:
+

integer [optional, default: None]

+

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of number of n_print, i.e. n_print = 13, n_flush = 3 would result in the trajectory/energy being written to disk every 13 x 3 = 39 simulation steps)

+
+
time_step:
+

float [required] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time step per integration step. If the rRESPA multiple time step integrator is used (integrator = "respa"), this specifies the inner time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is respa_inner times the time_step , and the total simulation time is n_steps times time_step times respa_inner .

+
+
box_size:
+

array [float] [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable.

+
+
integrator:
+

string [required] (options: velocity-verlet or respa)

+

Specifies the time integrator used in the simulation. If respa, the reversible reference system propagator algorithm (rRESPA) [Tuckerman et al., 1992] integrator is used, with respa_inner number of inner (intramolecular force) time steps. If velocity-verlet, a normal Velocity Verlet integrator is used. If respa and respa_inner = 1, the rRESPA integrator is equivalent to the Velocity Verlet.

+
+
respa_inner:
+

integer [optional, default: 1]

+

The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces.

+
+
domain_decomposition:
+

integer or boolean [optional, default: False]

+

Specifies the interval (in time steps) of domain decomposition exchange, involving all MPI ranks sending and receiving particles according to the particles’ positions in the integration box and the MPI ranks’ assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If True, the decomposition is performed once (before starting the simulation). If False, no decomposition is performed.

+
+
cancel_com_momentum:
+

integer or boolean [optional, default: False]

+

If True, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every remove_com_momentum time steps. If False, the linear momentum is never removed.

+
+
start_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at start_temperature Kelvin prior to starting the simulation. If False, the velocities are not changed before starting the simulation.

+
+
target_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Couple the system to a heat bath at target_temperature Kelvin by applying a Canonical sampling through velocity rescaling [Bussi et al., 2007] thermostat with coupling strength tau. If False, no temperature control is applied.

+
+
tau:
+

float [optional, default: 0.7] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the CSVR thermostat coupling. In the limit of tau , the Hamiltonian dynamics are preserved and no temperature coupling takes place.

+
+
thermostat_coupling_groups:
+

array [array [string]] [optional, default: []]

+

Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing "A", "B", and "C" type particles, thermostat_coupling_groups = [["A", "B"], ["C"],] would thermalise types "A" and "B" together and couple "C" type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. target_temperature Kelvin).

+
+
hamiltonian:
+

string [optional, default: "DefaultNohChi"] (options: SquaredPhi, DefaultNohChi, or DefaultWithChi)

+

Specifies the interaction energy functional \(W[\tilde\phi]\) for use with the particle-field interactions. See Interaction energy functionals for details.

+
+
+
+
+

3.1.4. Field keywords

+

Configuration keywords specifying field parameters.

+
+
mesh_size:
+

array [integer] or integer [required]

+

Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is box_size / mesh_size.

+
+
kappa:
+

float [required] {units: \(\text{kJ}^{-1}\text{mol}\)}

+

Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional \(W[\tilde\phi]\). See Interaction energy functionals for more details.

+
+
sigma:
+

float [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See Filtering for more details.

+
+
chi:
+

array [array [string, float]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\)}

+

Array of \(\tilde\chi_\text{AB}\)-parameters indicating the strength of the repulsive or attractive interaction between particles of type "A" and the number density due to particles of type "B", and vice versa. Example: chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ] would specify a repulsive "A""B" type interaction, and a weakly attractive "C""D" interaction. Self-interaction \(\tilde\chi\)-terms are always zero. See Interaction energy functionals for more details.

+
+
+
+
+

3.1.5. Bond keywords

+

Configuration keywords specifying bonds and bonds parameters.

+
+
bonds:
+

array [array [2 string, 2 float]] [optional, default: []] {units: \(\text{nm}=10^{-9}~\text{m}\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+

Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ] indicates a "A""A" bond of equilibrium length 0.47 \(\text{nm}\) with a bond strength of 980.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding bond between "A" and "B" type particles with equilibrium length 0.31 \(\text{nm}\) and a strength of 1250.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify stretching bonds.

+
+
angle_bonds:
+

array [array [3 string, 2 float]] [optional, default: []] {units: \({}^\circ\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+
+

Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ] indicates a "A""A""A" angular bond that tries to keep the bond linear at 180 degrees with a bending strength of 55.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding angle bond between "A""B""B" prefering the angle at 120 degrees and a strength of 25.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify angular bonds.

+
+
+
dihedrals:
+

array [array [4 string, integer, COSINE SERIES ]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)}

+

Specifies four-particle torsional potentials by cosine series. See Intramolecular bonds for details about how to specify dihedrals.

+
+
+
+
+

3.1.6. Electrostatic keywords

+

Configuration keywords specifying electrostatics and electrostatic parameters.

+
+
coulombtype:
+

string [optional, default: None] (options: PIC_Spectral)

+

Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the dielectric_const keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, not in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to PIC_Spectral.

+
+
dielectric_const:
+

float [optional, default: None]

+

Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified—even if electrostatics are not included with the coulombtype keyword.

+
+
+
+
+

3.1.7. Pressure keywords

+

Configuration keywords specifying pressure and barostat parameters.

+
+

3.1.7.1. Simulation keywords

+
+
pressure:
+

boolean [optional, default: False]

+

Specifies whether or not to calculate total internal pressure vector.

+
+
barostat:
+

string [optional, default: None](options: isotropic or semiisotropic)

+

Specifies whether to apply pressure constraints equally in all 3 Cartesian directions (isotropic) or equally in xy and different in z (semiisotropic).

+
+
barostat_type:
+

string [optional, default: berendsen](options: berendsen or scr)

+

Specifies the type of barostat to use. berendsen is more suitable for equilibration and scr for equilibrium data collection.

+
+
n_b:
+

integer [optional, default: 1]

+

Frequency of barostat call in number of outer rRESPA steps.

+
+
tau_p:
+

float [optional, default: 10 tau if tau < 0.1 else 1.0] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the barostat coupling.

+
+
target_pressure:
+

array [float] [optional, default: :code:1] {units: bar}

+

Couples the system to an external pressure set to target_pressure.

+
+
+
+
+

3.1.7.2. Field keywords

+
+
rho0:
+

float [optional, default: :code:average density] {units: \(\text{nm}^{-3}\)}

+

Intrinsic parameter corresponding to the specific volume of a coarse-grained particle. Typically: 8.66

+
+
a:
+

float [required] {units: \(\text{nm}^{-3}\)}

+

Calibrated parameter to obtain the correct average density at the target temperature and pressure. Typically: 9.21

+
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/doc_pages/constants_and_units.html b/v2.0.0/doc_pages/constants_and_units.html new file mode 100644 index 00000000..bed88e9d --- /dev/null +++ b/v2.0.0/doc_pages/constants_and_units.html @@ -0,0 +1,408 @@ + + + + + + + 6. Constants and Units — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

6. Constants and Units

+

HyMD uses the following units and constants internally and in all input and +output:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Units

Quantity

Symbol

Unit

length

\(r\)

\(\text{nm}=10^{-9}~\text{m}\)

time

\(t\)

\(\text{ps}=10^{-12}~\text{s}\)

charge

\(q\)

\(e=1.602176634 \cdot 10^{-19}~\text{C}\)

mass

\(m\)

\(\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}\)

temperature

\(\text{T}\)

\(\text{K}\)

energy

\(E\)

\(\text{kJ}\,\text{mol}^{-1}\)

velocity

\(v\)

\(\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}\)

momentum

\(P\)

\(\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}\)

force

\(\mathbf{F}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}\)

pressure

\(p\)

\(\text{bar}=100~\text{kPa}\)

electric potential

\(\Psi\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}\)

electric field

\(\mathbf{E}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}\)

compressibility

\(\kappa\)

\(\text{mol}\,\text{kJ}^{-1}\)

field-interaction

\(\tilde\chi\)

\(\text{kJ}\,\text{mol}^{-1}\)

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants

Constant

Symbol

Value

gas constant

\(R\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Boltzmann’s constant

\(k_\text{B}\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Avogadro’s constant

\(N_\text{A}\)

\(6.02214076 \cdot 10^23~\text{mol}^{-1}\)

Vacuum permittivity

\(\varepsilon_0\)

\(8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2\)

Coulomb constant

\(k_\text{e}\)

\(138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}\)

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/doc_pages/electrostatics.html b/v2.0.0/doc_pages/electrostatics.html new file mode 100644 index 00000000..7f7e9978 --- /dev/null +++ b/v2.0.0/doc_pages/electrostatics.html @@ -0,0 +1,329 @@ + + + + + + + 3. Electrostatic interactions — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Electrostatic interactions

+

In the filtered Hamiltonian hPF formalism [Bore and Cascella, 2020] the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle–mesh Ewald.

+

The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered

+
+\[\tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i),\]
+

with \(q_i\) being the charge of particle \(i\) and \(H\) is the +filtering function (see Filtering). The value of the charge grid at +vertex \((i,j,k)\) is found by

+
+\[\tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)]\]
+

and the electrostatic potential \(\Psi_{ijk}\)

+
+\[\Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right],\]
+

where \(k_\text{e}\) is the Coulomb constant \(1/4\pi\varepsilon_0\). +The electric field is obtained by differentiation of the electrostatic +potential in Fourier space,

+
+\[\mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)]\]
+

from which the forces are interpolated back to the particle positions.

+
+

3.1. Specifying electrostatics

+

In HyMD, electrostatics are specified by the coulombtype and +dielectric_const keywords in the configuration file (see +Configuration file) and the /charge dataset in the HDF5 format +structure/topology input file (see Topology and structure file). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/doc_pages/examples.html b/v2.0.0/doc_pages/examples.html new file mode 100644 index 00000000..cfbcf72a --- /dev/null +++ b/v2.0.0/doc_pages/examples.html @@ -0,0 +1,777 @@ + + + + + + + 1. Examples — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Examples

+

The following examples are ordered in more or less order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the HyMD-tutorial github repository.

+
+

1.1. Ideal gas

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true +

The simplest possible system is one with no interactions at all—intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like:

+
+
ideal_gas.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = false         # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+
+
+

A simple input structure/topology file ideal_gas.HDF5 is available in +the HyMD-tutorial/ideal_gas github repository (along with the code to +generate it). Run the (very) short simulation by

+
python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field   \
+                                              --velocity-output \
+                                              --force-output
+
+
+

with the --disable-field argument to completely turn off all +particle–field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook ideal_gas.ipynb for details.

+
+
+

1.2. Ideal chains

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true +

The simplest available interaction is the harmonic two-particle bond (see +Intramolecular bonds),

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2.\]
+

Extending the configuration file from the ideal gas case, we need to add a +bonds specification. Note that the [bonds] meta specifier is not +necessary, but may be used to help organise the input file.

+
+
ideal_chain.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+
+
+

A simple input structure/topology file ideal_chain.HDF5 with a few +coiled up ideal chain polymers is available in the +HyMD-tutorial/ideal_chain github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field
+
+
+

we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +ideal_chain.ipynb.

+
+
+

1.3. Stiff rods

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true +

Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the i--j--k angle \(\theta\) (see +Intramolecular bonds),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2.\]
+

Extending the configuration file from the ideal chain case, we need to add a +angle_bonds specification. Note that the [bonds] meta specifier +is not necessary, but may be used to help organise the input file.

+
+
rods.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+angle_bonds = [
+  ["A", "A", "A", 180.0, 100.0],   # (i, j, k, equilibrium angle, strength)
+]
+
+
+
+

A simple input structure/topology file rods.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook rods.ipynb.

+
+
+

1.4. Helixes

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true +

Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle \(\phi\) between the +i--j--k plane and the j--k--l plane (see Intramolecular bonds),

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n).\]
+

The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a dihedrals keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the dielectric_const +keyword even though we are not including electrostatic forces in the current +simulation. Note that the [bonds] meta specifier is not necessary, but +may be used to help organise the input file.

+
+
helixes.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+dielectric_const = 15.0
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.31, 10000.0],       # (i name, j name, equilibrium length, strength)
+]
+
+dihedrals = [
+  [
+    ["A", "A", "A", "A"],
+    [
+      [-1],
+      [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+      [0.08, 0.46, 1.65, -0.96, 0.38],
+    ],
+    [1.0]
+  ],
+]
+
+
+
+

A simple input structure/topology file helixes.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook helixes.ipynb.

+
+
+

1.5. Phase separation

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true +

The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types A and B. Using the Hamiltonian

+
+\[\mathcal{H}=H_0+W\]
+

with \(\tilde\chi\)–dependent interactions defined by (specified in the +configuration file by hamiltonian = DefaultWithChi):

+
+\[W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2.\]
+
+
phase_separation.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+
+[field]
+mesh_size = [20, 20, 20]           # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+kappa = 0.05                       # compressibility in mol/kJ
+chi = [
+  ['A', 'B', 5.0],                 # (name i, name j, strength)
+]
+
+
+
+

A simple input structure/topology file phase_separation.HDF5 containing +an equal number of A type and B type particles is available in +the HyMD-tutorial/phase_separation github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd phase_separation.toml phase_separation.HDF5
+
+
+

we may examine the resulting trajectory. In the case of a low interaction +strength \(\tilde\chi\) of 5.0 (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to 40.0 (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +phase_separation.ipynb.

+
+
+

1.6. Diblock copolymers

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true +

Having introduced particle–field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive \(\tilde\chi\)–interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the integrator = "respa" keyword. Putting the pieces together, the +configuration file may look like the following:

+
+
copolymer.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 15
+n_steps = 2000                     # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [10.0, 10.0, 10.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [50, 50, 50]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+chi = [
+  ["A", "B", 30.0],                # (i, j, strength)
+]
+
+[bonds]
+bonds = [
+  ["A", "A", 0.25, 1500.0],        # (i, j, equilibrium length, strength)
+  ["A", "B", 0.25, 1500.0],
+  ["B", "B", 0.25, 1500.0],
+]
+angle_bonds = [
+  ["A", "A", "A", 180.0, 25.0],    # (i, j, k, equilibrium angle, strength)
+  ["B", "B", "B", 180.0, 25.0],
+]
+
+
+
+

A simple input structure/topology file copolymer.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/copolymer github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten A followed by ten B type particles. +Running the simulation with

+
python3 -m hymd copolymer.toml copolymer.HDF5
+
+
+

the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +copolymer.ipynb.

+
+
+

1.7. Lipid bilayer self-assembly

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true +

Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field–particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the thermostat_coupling_groups keyword. With parameters +optimised in [Ledum et al., 2020], the configuration file looks like:

+
+
lipid_self_assembly.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 25
+n_steps = 3000
+n_print = 200
+n_flush = 1
+time_step = 0.01
+box_size = [9.96924, 9.96924, 10.03970]
+start_temperature = 323
+target_temperature = 323
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.05
+domain_decomposition = 10001
+cancel_com_momentum = true
+max_molecule_size = 15
+thermostat_coupling_groups = [
+  ["N", "P", "G", "C"],
+  ["W"],
+]
+
+[field]
+mesh_size = [25, 25, 25]
+sigma = 1.0
+chi = [
+  ["C", "W", 42.24],
+  ["G", "C", 10.47],
+  ["N", "W", -3.77],
+  ["G", "W", 4.53],
+  ["N", "P", -9.34],
+  ["P", "G", 8.04],
+  ["N", "G", 1.97],
+  ["P", "C", 14.72],
+  ["P", "W", -1.51],
+  ["N", "C", 13.56],
+]
+
+[bonds]
+bonds = [
+  ["N", "P", 0.47, 1250.0],
+  ["P", "G", 0.47, 1250.0],
+  ["G", "G", 0.37, 1250.0],
+  ["G", "C", 0.47, 1250.0],
+  ["C", "C", 0.47, 1250.0],
+]
+angle_bonds = [
+  ["P", "G", "G", 120.0, 25.0],
+  ["P", "G", "C", 180.0, 25.0],
+  ["G", "C", "C", 180.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

A randomly mixed input structure/topology file +lipid_self_assembly.HDF5 with a few hundred lipids in a roughy +10 x 10 x 10nm box is available in the +HyMD-tutorial/lipid_self_assembly github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation

+
python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5
+
+
+

we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook lipid_self_assembly.ipynb.

+
+
+

1.8. Peptide in lipid bilayer

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true +

Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer.

+

The configuration file is available in the HyMD-tutorial/peptide github +repository (omitted here for brevity).

+

A pre-equilibrated input structure/topology file peptide.HDF5 with a +few hundred lipids in a roughy 20 x 20 x 20nm box is available in the +HyMD-tutorial/peptide github repository. Running the simulation

+
python3 -m hymd peptide.toml peptide.HDF5
+
+
+

we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook peptide.ipynb.

+
+
+

1.9. SDS

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true +

The last part we introduce is explicit electrostatic interactions through +particle–mesh Ewald. Enabling the electrostatic calculations is done via the +coulombtype keyword. "PIC_Spectral" is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the dielectric_const keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge.

+
+
sds.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 10
+n_steps = 3000
+n_print = 1500
+n_flush =
+time_step = 0.01
+box_size = [8.3, 8.3, 8.3]
+start_temperature = 298
+target_temperature = 298
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.1
+domain_decomposition = 10000
+cancel_com_momentum = true
+max_molecule_size = 5
+thermostat_coupling_groups = [
+  ["S", "C"],
+  ["W", "Na"],
+]
+dielectric_const = 45.0              # dielectric constant for the simulation medium
+coulombtype = "PIC_Spectral"         # particle in cloud, spectral method
+
+[field]
+mesh_size = [64, 64, 64]
+sigma = 0.5
+chi = [
+  ["S", "C",  13.50],
+  ["S", "Na",  0.00],
+  ["S", "W",  -3.60],
+  ["C", "Na", 13.50],
+  ["C", "W",  33.75],
+  ["W", "Na",  0.00],
+]
+
+[bonds]
+bonds = [
+  ["S",   "C",   0.50, 1250.0],
+  ["C",   "C",   0.50, 1250.0],
+]
+angle_bonds = [
+  ["S", "C", "C", 170.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

An input structure/topology file sds.HDF5 with a couple thousand +randomly dispersed SDS chains is available in the HyMD-tutorial/sds github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a /charge dataset. +Running the simulation with

+
python3 -m hymd sds.toml sds.HDF5
+
+
+

we observe the aggregation of the SDS into micellular structures—first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook sds.ipynb.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/doc_pages/filtering.html b/v2.0.0/doc_pages/filtering.html new file mode 100644 index 00000000..c28cc39d --- /dev/null +++ b/v2.0.0/doc_pages/filtering.html @@ -0,0 +1,316 @@ + + + + + + + 2. Filtering — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Filtering

+

The default grid-independent filter function used in HyMD is a Gaussian

+
+\[H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right]\]
+

with reciprocal space representation

+
+\[\hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right].\]
+

The coarse-graining parameter \(\sigma\) determines a length scale of +particle extent and is given as configuration file input by

+
sigma = 0.75
+
+
+
+

2.1. Implementing new filters

+

Implementing new filter functions is straightforward by hijacking +the setup method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/doc_pages/installation.html b/v2.0.0/doc_pages/installation.html new file mode 100644 index 00000000..5cd9bab4 --- /dev/null +++ b/v2.0.0/doc_pages/installation.html @@ -0,0 +1,558 @@ + + + + + + + 1. Installation — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Installation

+
+

1.1. Dependencies

+
+

Note

+

HyMD requires Python ≥3.6. Python version 3.9 is most likely fine +to use, but HyMD is only regularly tested with Python3.8 at the moment.

+ +
+

Warning

+

MPI-enabled h5py may fail to build under Python3.10. In this case, a +fall-back to Python3.9 or lower may be necessary.

+ +

Installing non-Python dependencies may be done by

+
+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-openmpi-dev  # Install MPI-enabled HDF5
+sudo apt-get install -y pkg-config           # Install pkg-config, required for h5py install
+sudo apt-get install -y curl wget
+
+
+
+
+

Warning

+

There might be memory leaks when using HyMD with OpenMPI 4.1.1. +Therefore, using a newer version of OpenMPI is recommended. +See Issue #186 for more details.

+ +

Installing Python dependencies may be done by

+
+
python3 -m pip install --upgrade pip
+CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+python3 -m pip install mpi4py numpy cython
+
+
+
+
+

Warning

+

If MPI-enabled HDF5 and h5py can not be installed, limited support +for serial HDF5 is available. Note that having MPI-enabled file IO is +highly recommended, and simulation performance under serial HDF5 will +potentially be very low.

+

Example dependency install on Ubuntu (apt) using serial HDF5:

+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-serial-dev   # Install serial HDF5
+sudo apt-get install -y curl wget
+
+python3 -m pip install h5py mpi4py numpy cython
+
+
+

Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +--disable-mpio argument to HyMD, see Command line arguments. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial.

+ +
+
+

1.2. Installing HyMD

+

HyMD may be installed using pip by

+
python3 -m pip install hymd
+
+
+
+
+

1.3. Install in docker

+

A docker image with build essentials setup is available at dockerhub with tag +mortele/hymd,

+
docker pull mortele/hymd:latest
+docker run -it mortele/hymd
+/app$ python3 -m pip install hymd
+
+# Grab example input files
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5
+
+# Run simulation
+/app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose
+
+
+
+
+

1.4. Run interactively in Google Colaboratory

+

A Google Colaboratory jupyter notebook is setup here with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons.

+
+
+

1.5. Common issues

+
+

1.5.1. Numpy errors while importing the Fortran force kernels

+
RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd
+
+Traceback (most recent call last):
+
+  (...)
+
+File "/..../HyMD/hymd/__init__.py", line 2, in <module>
+  from .main import main  # noqa: F401
+File "/..../HyMD/hymd/main.py", line 10, in <module>
+  from .configure_runtime import configure_runtime
+File "/..../hymd/configure_runtime.py", line 12, in <module>
+  from .input_parser import read_config_toml, parse_config_toml
+File "/..../HyMD/hymd/input_parser.py", line 12, in <module>
+  from .force import Bond, Angle, Dihedral, Chi
+File "/..../HyMD/hymd/force.py", line 8, in <module>
+  from force_kernels import (  # noqa: F401
+ImportError: numpy.core.multiarray failed to import
+
+
+

can normally be fixed by updating numpy versions,

+
python3 -m pip install -U numpy
+
+
+
+
+

1.5.2. Error building pfft-python due to missing curl/wget

+
Building wheel for pfft-python (setup.py) ... error
+ERROR: Command errored out with exit status 1:
+command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_
+cwd: /tmp/pip-install-fr6nt9m4/pfft-python/
+Complete output (56 lines):
+running bdist_wheel
+running build
+running build_py
+
+  (...)
+
+curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found
+wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found
+Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+Please check curl or wget
+You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/
+Traceback (most recent call last):
+  File "<string>", line 1, in <module>
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in <module>
+    setup(
+  File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup
+    return distutils.core.setup(**attrs)
+  File "/usr/lib/python3.8/distutils/core.py", line 148, in setup
+
+  (...)
+
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions
+    build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:]))
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft
+    raise ValueError("could not build fftw; check MPICC?")
+ValueError: could not build fftw; check MPICC?
+----------------------------------------
+ERROR: Failed building wheel for pfft-python
+Running setup.py clean for pfft-python
+Failed to build pfft-python
+
+
+

can be fixed by installing either curl or wget

+
apt-get install -y curl wget
+
+
+
+
+

1.5.3. Error running parallel HyMD without MPI-enabled h5py

+
Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    main()
+  File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    raise ValueError("h5py was built without MPI support, can't use mpio driver")
+ValueError: h5py was built without MPI support, can't use mpio driver
+
+
+

Can be fixed by installing a MPI-enabled h5py through

+
python3 -m pip uninstall -y h5py
+HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/doc_pages/interaction_energy_functionals.html b/v2.0.0/doc_pages/interaction_energy_functionals.html new file mode 100644 index 00000000..d2dd2f78 --- /dev/null +++ b/v2.0.0/doc_pages/interaction_energy_functionals.html @@ -0,0 +1,369 @@ + + + + + + + 1. Interaction energy functionals — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Interaction energy functionals

+

A few interaction energy functionals \(W\) are defined in HyMD through +the Hamiltonian class and associated subclasses.

+
+

1.1. \(\chi\)–interaction and \(\kappa\)–incompressibility

+

The most common hPF energy functional is specified by

+
hamiltonian = "DefaultWithChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where \(\tilde\chi_{\text{A}-\text{B}}\) is the interaction energy between +overlapping densities of particle types \(\text{A}\) and \(\text{B}\). +The incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\tilde\chi\) +and \(\kappa\) in the configuration file (see Configuration file)

+
kappa = 0.05
+chi = [
+   ["A", "B", 15.85],
+   ["B", "C", -5.70],
+   ...
+]
+
+
+
+
+

1.2. Only \(\kappa\)–incompressibility

+

The only \(\kappa\) interactions energy functional is specified by

+
hamiltonian = "DefaultNoChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where the incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.3. Only \(\phi^2\)

+

The \(\phi^2\) interactions energy functional is specified by

+
hamiltonian = "SquaredPhi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2,\]
+

where the \(\phi\) squared term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.4. Implementing new interaction energy forms

+

Implementing new interaction energy functions is straightforward by subclassing +Hamiltonian and applying sympy differentiation to the symbolic +field objects. The sympy.lamdify function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/doc_pages/intramolecular_bonds.html b/v2.0.0/doc_pages/intramolecular_bonds.html new file mode 100644 index 00000000..4512a587 --- /dev/null +++ b/v2.0.0/doc_pages/intramolecular_bonds.html @@ -0,0 +1,409 @@ + + + + + + + 2. Intramolecular bonds — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Intramolecular bonds

+

Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see Configuration file. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +Benchmarks), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable.

+

All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]).

+
+

2.1. Two-particle bonds

+

Stretching bonds in HyMD are implemented as harmonic spring potentials,

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2,\]
+

where \(r=|\mathbf{r}|\) is the inter-particle distance, \(k\) is a +constant of dimension energy (units \(\text{kJ}\,\text{mol}^{-1}\)), and +\(r_0\) is the equilibrum length of the bond (units: \(\text{nm}\)). The +force is calculated as

+
+\[F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r},\]
+

where \(\mathbf{r}\) is the vector pointing from \(i\) to \(j\).

+

In the configuration file, two-particle bonds are specified per particle type:

+
+
configuration_two_particle_example.toml
+
[bonds]
+bonds = [
+   ["A", "A", 0.47, 1250.0],
+   ["A", "B", 0.37,  940.0],
+   ["B", "C", 0.50, 1010.0],
+   ["C", "A", 0.42,  550.0],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.2. Three-particle bonds

+

Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle–particle–particle angle \(\theta\),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2,\]
+

where \(k\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\)), and \(\theta_0\) is the equilibrum +angle of the bond (units: \({}^\circ\)). Defining the particles with labels +\(a\), \(b\), and \(c\), let \(\mathbf{r}_a\) denote the vector +pointing from \(b\) to \(a\), and correspondingly let +\(\mathbf{r}_c\) point from \(b\) to \(c\). The +\(a\)\(b\)\(c\) may be computed through the law of Cosines,

+
+\[\theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right]\]
+

Then the force acting on \(a\) and \(c\) is

+
+\[ \begin{align}\begin{aligned}\mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a},\\\mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c},\end{aligned}\end{align} \]
+

and

+
+\[\mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c\]
+

In the configuration file, three-particle bonds are specified per particle type:

+
+
configuration_three_particle_example.toml
+
[bonds]
+angle_bonds = [
+   ["A", "A", "A", 180.0, 90.0],
+   ["A", "B", "A", 120.0, 55.0],
+   ["B", "C", "C",  30.0, 10.0],
+   ["C", "A", "B", 110.0, 25.5],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.3. Four-particle bonds

+

Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle \(\phi\) between the +\(a\)\(b\)\(c\) and \(b\)\(c\)\(d\) planes, for +a dihedral bond quartet \(a\), \(b\), \(c\), and \(d\). The +potential takes the form

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n),\]
+

where \(c_n\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)), and \(\phi_n\) are +specified phase angles in the cosine series.

+

In the configuration file, four-particle bonds are specified per particle type:

+
+
configuration_four_particle_example.toml
+
[bonds]
+dihedrals = [
+   ["A", "B", "C", "D"],
+   [
+     [-1],
+     [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+     [0.08, 0.46, 1.65, -0.96, 0.38],
+   ],
+   [1.0],
+]
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/doc_pages/overview.html b/v2.0.0/doc_pages/overview.html new file mode 100644 index 00000000..1a200c99 --- /dev/null +++ b/v2.0.0/doc_pages/overview.html @@ -0,0 +1,430 @@ + + + + + + + 2. Usage overview for HylleraasMD — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Usage overview for HylleraasMD

+

HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a toml format configuration file, along with a topology and structure +file specifying the input system in HDF5 format.

+

Configuration file

+

The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a [5, 5, 5] nm simulation box at 300 K may look like +the following:

+
+
config_simple_1.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "SquaredPhi"         # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [30, 30, 30]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+
+
+
+

Note that for the version 1.0 release of HyMD, the [particles], +[simulation], and [field] groups are optional specifiers for +structuring the configuration file.

+

For a full specification of every recognised configuration keyword in HyMD, +please refer to Configuration file.

+

Topology and structure file

+

The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +N particles may look like the following:

+
+
example_structure.HDF5
+
group   /
+   # root group
+
+dataset /coordinates
+   # float32, shape (T, N, D,)
+   # Time steps of N rows of D dimensional coordinate data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /velocities
+   # float32, shape (T, N, D,) OPTIONAL
+   # Time steps of N rows of D dimensional velocity data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /bonds
+   # int32,   shape (N, B,)    OPTIONAL
+   # Each row i contains indices of the particles bonds from/to i
+   # B denotes the maximum bonds per particle
+
+dataset /indices
+   # int32,   shape (N,)
+   # Index of each particle, 0--(N-1)
+
+dataset /molecules
+   # int32,   shape (N,)
+   # Index of molecule each particle belongs to
+   # Used to construct bond network locally on MPI ranks
+
+dataset /names
+   # str10,   shape (N,)
+   # Fixed size string array containing particle type names
+
+dataset /types
+   # int32,   shape (N,)       OPTIONAL
+   # Mapping of particle names to type indices
+
+
+
+

For a full specification of the topology and structure input file, see +Topology and structure file.

+

Command line arguments

+

A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the config_simple_1.toml and example_structure.HDF5 +files may look like the following:

+
mpirun -n ${MPI_NUM_RANKS} python3 -m hymd         \  # HyMD executable
+                           config_simple_1.toml    \  # configuration file
+                           example_structure.HDF5  \  # structure file
+                           --logfile=log_out.txt   \  # set logfile path
+                           --seed 123456           \  # set random seed
+                           --verbose 2             \  # set logging verbosity
+                           --velocity-output          # enable velocity in trajectory output
+
+
+

For a full specification of all command line arguments, see +Command line arguments.

+

More examples

+

For more thorough rundown and concrete usage examples, see +Examples.

+
+

2.1. Running parallel simulations

+

Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the only difference being how the python3 interpreter is +invoked. Prepending mpirun -n ${NPROCS} to the usual +python3 -m hymd runs the simulation with ${NPROCS} MPI ranks.

+

Inputting

+
mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field
+
+
+

sets up an example simulation of the HyMD-tutorial/ideal_gas system. For +more details about this system in particular, or other example simulations, see +the HyMD-tutorial repository.

+
+
+

2.2. Running tests

+

Run serial code tests by

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd
+cd hymd/
+python3 -m pip install pytest pytest-mpi
+python3 -m pytest
+
+
+

There is a small convenience script in hymd/ for running the MPI-enabled +tests,

+
chmod +x pytest-mpi
+./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/doc_pages/pressure.html b/v2.0.0/doc_pages/pressure.html new file mode 100644 index 00000000..6663a448 --- /dev/null +++ b/v2.0.0/doc_pages/pressure.html @@ -0,0 +1,319 @@ + + + + + + + 4. Pressure — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Pressure

+

Internal pressure is calculated from internal energy according to

+
+\[\begin{split}P_a = \frac{1}{\mathcal{V}} \left( 2T_a - \text{Vir}_a \right) \\ +\text{Vir}_a = L_a \frac{\partial \mathcal{U}}{\partial L_a} \\ +\mathcal{U} = \sum_{i=1}^M \mathcal{U}_0( \{ \mathbf{r}\}_i ) + W[\{ \tilde\phi \} ]\end{split}\]
+

where +\(\mathcal{V}\) is the simulation volume, +\({T_a}\) is the kinetic energy +and \(L_a\) the length of the box in the Cartesian direction \(a\), +Vir is the virial of the total interaction energy \(\mathcal{U}\).

+

\(\mathcal{U}\) comprises intramolecular bonded terms \(\mathcal{U}_0\) (see Intramolecular bonds for details), +and field terms \(W[\{ \tilde\phi \} ]\) (see Theory for details).

+

Using the above expressions, the following form for internal pressure is obtained:

+
+\[\begin{split}P_a = \frac{2 T_a}{\mathcal{V}} -\frac{L_a}{\mathcal{V}} \sum_{i=1}^N \frac{\partial \mathcal{U}_{0i}}{\partial L_a} + P^{(3)}_a \\\end{split}\]
+
+\[P^{(3)}_a = \frac{1}{\mathcal{V}}\left ( -W[\{ \tilde\phi(\mathbf{r}) \}] + \int \sum_t \bar{V}_t(\mathbf{r})\tilde\phi_t(\mathbf{r})d\mathbf{r} + + \int \sum_t \sigma^2\bar{V}_t(\mathbf{r})\nabla_a^2\tilde\phi_t(\mathbf{r}) d\mathbf{r} \right)\]
+

where \(\bar{V}_t(\mathbf{r}) = \frac{\partial w(\{\tilde\phi\})}{\partial\tilde\phi_t}\) +and \(σ\) is a coarse-graining parameter (see Filtering for details). +Note that the above expression is obtained for a Gaussian filter which is the most natural choice in HhPF theory.

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/doc_pages/theory.html b/v2.0.0/doc_pages/theory.html new file mode 100644 index 00000000..cd557cc4 --- /dev/null +++ b/v2.0.0/doc_pages/theory.html @@ -0,0 +1,377 @@ + + + + + + + 1. Theory — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Theory

+

Hybrid particle–field simulations switch out the ordinary particle–particle +Lennard-Jones interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle–field densities are +defined as

+
+\[\phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i),\]
+

where \(\mathbf{r}\) is a spatial coordinate, \(P\) is a window function +used to distribute particle number densities onto a computational grid, and +\(\mathbf{r}_i\) is the position of particle \(i\) (of total \(N\)). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of \(N\) particles in \(M\) molecules is

+
+\[\mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})]\]
+

with \(H_0\) being a standard intramolecular Hamiltonian form (see +Intramolecular bonds) including kinetic terms, while \(W\) is a density +dependent interaction energy functional.

+

In the Hamiltonian hPF-MD formalism [Bore and Cascella, 2020], the density +field is filtered using a grid-independent filtering function \(H\),

+
+\[\tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}).\]
+

The filter smooths the density, ensuring that \(\tilde\phi\) and +\(W[\tilde\phi([\phi])]\) both converge as the grid size is reduced.

+
+

1.1. External potential

+

The external potential acting on a particle is defined as the functional +derivative of \(W\) with respect to \(\phi\). In the filtered formalism, +the potential takes the form

+
+\[\begin{split}V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ +&= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})},\end{split}\]
+

under the assumption of a local form of the interaction energy functional, +\(W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]\). Note +that

+
+\[\frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}).\]
+
+
+

1.2. Force interpolation

+

The forces on particle \(i\) are obtained by differentiation of the external +potential,

+
+\[\mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i).\]
+
+
+

1.3. Reciprocal space calculations

+

The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density \(\phi_{ijk}\) with CIC, we apply the filtering +and obtain the discrete version of the external potential by

+
+\[\tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big]\]
+

and

+
+\[V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+

The forces are obtained by differentiation of \(V\) in Fourier space as

+
+\[\nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+
+
+

1.4. Filter

+

By default, the filter used in HyMD is a simple Gaussian of the form

+
+\[\begin{split}H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ +\hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right].\end{split}\]
+

For more details about the filtering, see Filtering.

+
+
+

1.5. Hamiltonian form

+

The default form of the interaction energy functional in HyMD is

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2.\]
+

In the case of constant pressure simulations (NPT), the interaction energy functional becomes

+
+\[W=\frac{1}{2\rho_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-a\right)^2.\]
+

where, \(\rho_0= 1 / ν\) is an intrinsic parameter corresponding to the specific volume \((ν)\) of a coarse-grained particle, +\(a\) is a calibrated parameter to obtain the correct average density at the target temperature and pressure. +See Interaction energy functionals for details.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/doc_pages/topology_input.html b/v2.0.0/doc_pages/topology_input.html new file mode 100644 index 00000000..a648108b --- /dev/null +++ b/v2.0.0/doc_pages/topology_input.html @@ -0,0 +1,358 @@ + + + + + + + 4. Topology and structure file — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Topology and structure file

+

The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root / group.

+

The HyMD-tutorial has multiple examples of structure files for various levels +of complexity.

+
+

4.1. Required datasets

+
+
/coordinates:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/indices:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/names:
+

array shape [N,]

+

datatype [string (length between 1 and 16)]

+

The shape represents one particle name per N particles. The datatype may be a string of length =<16.

+
+
+
+
+

4.2. Optional datasets

+
+
/velocities:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/types:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle type index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/molecules:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one molecule index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/bonds:
+

array shape [N, B,]

+

datatype [int32 or int64]

+

The shape represents B bond specifications (indices of different particles) per N particles. The data type may be either 32 or 64 bit integers.

+
+
/charge:
+

array shape [N,]

+

datatype [float32 or float64]

+

The shape represents one particle charge per N particles. The data type may be either four or eight byte reals.

+
+
/box:
+

array shape [3,]

+

datatype [float32 or float64]

+

The shape represents the initial box dimensions in Cartesian coordinates.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/genindex.html b/v2.0.0/genindex.html new file mode 100644 index 00000000..b745952c --- /dev/null +++ b/v2.0.0/genindex.html @@ -0,0 +1,855 @@ + + + + + + Index — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + +
+ +

F

+ + + +
+ +

G

+ + +
+ +

H

+ + + +
    +
  • + hymd.input_parser + +
  • +
  • + hymd.integrator + +
  • +
  • + hymd.pressure + +
  • +
  • + hymd.thermostat + +
  • +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/index.html b/v2.0.0/index.html new file mode 100644 index 00000000..80703bcb --- /dev/null +++ b/v2.0.0/index.html @@ -0,0 +1,417 @@ + + + + + + + HylleraasMD documentation — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

HylleraasMD documentation

+
+
Release:
+

1.0.8

+
+
Date:
+

Mar 22, 2023

+
+
+

HylleraasMD (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems.

+

HyMD can run canonical hPF-MD simulations [Milano and Kawakatsu, 2009], or filtered +density Hamiltonian hPF (HhPF-MD) simulations [Bore and Cascella, 2020], with +or without explicit PME electrostatic interactions [Kolli et al., 2018]. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +[Bore et al., 2018, Cascella et al., 2008]. Martini +style elastic networks (ElNeDyn) [Periole et al., 2009] are also +supported.

+

HyMD uses the pmesh (github.com/rainwoodman/pmesh) library for particle-mesh +operations, with the PPFT [Pippig, 2013] backend for FFTs through the +pfft-python bindings (github.com/rainwoodman/pfft-python). File IO is done +via HDF5 formats to allow MPI parallel reads.

+
+

User Guide

+

The HylleraasMD User Guide provides comprehensive information on how to run +simulations. Selected Examples are available to guide new users.

+
+
+

Installing HyMD

+

The easiest approach is to install using pip:

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+

For more information and required dependencies, see +Installation.

+
+

Run in Google colab

+

Run HyMD interactively in Google Colaboratory jupyter notebook here.

+
+
+
+

Source Code

+

Source code is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the GNU Lesser General Public +License v3.0. Obtain the source code with git:

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git
+
+
+
+
+

Development

+

HyMD is developed and maintained by researchers at the Hylleraas Centre for +Quantum Molecular Sciences at the University of Oslo.

+

pic1 pic2

+
+
+

References

+
+
+[BC20] +

Sigbjørn Løland Bore and Michele Cascella. Hamiltonian and alias-free hybrid particle–field molecular dynamics. J. Chem. Phys., 153(9):094106, 2020. doi:10.1063/5.0020733.

+
+
+[BMC18] +

Sigbjørn Løland Bore, Giuseppe Milano, and Michele Cascella. Hybrid particle-field model for conformational dynamics of peptide chains. J. Chem. Theory Comput., 14(2):1120–1130, 2018. doi:10.1021/acs.jctc.7b01160.

+
+
+[BDP07] +

Giovanni Bussi, Davide Donadio, and Michele Parrinello. Canonical sampling through velocity rescaling. J. Chem. Phys., 126(1):014101, 2007. doi:10.1063/1.2408420.

+
+
+[CNCDP08] +

Michele Cascella, Marilisa A. Neri, Paolo Carloni, and Matteo Dal Peraro. Topologically based multipolar reconstruction of electrostatic interactions in multiscale simulations of proteins. J. Chem. Theory Comput., 4(8):1378–1385, 2008. doi:10.1021/ct800122x.

+
+
+[KDNB+18] +

Hima Bindu Kolli, Antonio De Nicola, Sigbjørn Løland Bore, Ken Schäfer, Gregor Diezemann, Jürgen Gauss, Toshihiro Kawakatsu, Zhong-Yuan Lu, You-Liang Zhu, Giuseppe Milano, and Michele Cascella. Hybrid particle-field molecular dynamics simulations of charged amphiphiles in an aqueous environment. J. Chem. Theory Comput., 14(9):4928–4937, 2018. doi:10.26434/chemrxiv.6264644.v1.

+
+
+[LBC20] +

Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Automated determination of hybrid particle-field parameters by machine learning. Mol. Phys., 118(19-20):e1785571, 2020. doi:10.1080/00268976.2020.1785571.

+
+
+[MK09] +

Giuseppe Milano and Toshihiro Kawakatsu. Hybrid particle-field molecular dynamics simulations for dense polymer systems. J. Chem. Phys., 130(21):214106, 2009. doi:10.1063/1.3142103.

+
+
+[PCMC09] +

Xavier Periole, Marco Cavalli, Siewert-Jan Marrink, and Marco A Ceruso. Combining an elastic network with a coarse-grained molecular force field: structure, dynamics, and intermolecular recognition. Journal of chemical theory and computation, 5(9):2531–2543, 2009. doi:10.1021/ct9002114.

+
+
+[Pip13] +

Michael Pippig. Pfft: an extension of fftw to massively parallel architectures. SIAM J. Sci. Comput., 35(3):C213–C236, 2013. doi:10.1137/120885887.

+
+
+[TBM92] +

MBBJM Tuckerman, Bruce J Berne, and Glenn J Martyna. Reversible multiple time scale molecular dynamics. J. Chem. Phys., 97(3):1990–2001, 1992. doi:10.1063/1.463137.

+
+
+
+
+
+

Indices and tables

+ +
+
+
+
+
+
+
+
+
+ + + +
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+ + + + + +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/objects.inv b/v2.0.0/objects.inv new file mode 100644 index 00000000..6880e1b5 Binary files /dev/null and b/v2.0.0/objects.inv differ diff --git a/v2.0.0/py-modindex.html b/v2.0.0/py-modindex.html new file mode 100644 index 00000000..847eafc2 --- /dev/null +++ b/v2.0.0/py-modindex.html @@ -0,0 +1,349 @@ + + + + + + Python Module Index — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ h +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ h
+ hymd +
    + hymd.barostat +
    + hymd.field +
    + hymd.file_io +
    + hymd.force +
    + hymd.input_parser +
    + hymd.integrator +
    + hymd.pressure +
    + hymd.thermostat +
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.0/search.html b/v2.0.0/search.html new file mode 100644 index 00000000..8a416a02 --- /dev/null +++ b/v2.0.0/search.html @@ -0,0 +1,309 @@ + + + + + + Search — hymd 1.0.8 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v2.0.0/searchindex.js b/v2.0.0/searchindex.js new file mode 100644 index 00000000..28b22a71 --- /dev/null +++ b/v2.0.0/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["doc_pages/api","doc_pages/benchmarks","doc_pages/command_line","doc_pages/config_file","doc_pages/constants_and_units","doc_pages/electrostatics","doc_pages/examples","doc_pages/filtering","doc_pages/installation","doc_pages/interaction_energy_functionals","doc_pages/intramolecular_bonds","doc_pages/overview","doc_pages/pressure","doc_pages/theory","doc_pages/topology_input","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,"sphinxcontrib.bibtex":9,sphinx:56},filenames:["doc_pages/api.rst","doc_pages/benchmarks.rst","doc_pages/command_line.rst","doc_pages/config_file.rst","doc_pages/constants_and_units.rst","doc_pages/electrostatics.rst","doc_pages/examples.rst","doc_pages/filtering.rst","doc_pages/installation.rst","doc_pages/interaction_energy_functionals.rst","doc_pages/intramolecular_bonds.rst","doc_pages/overview.rst","doc_pages/pressure.rst","doc_pages/theory.rst","doc_pages/topology_input.rst","index.rst"],objects:{"hymd.barostat":{isotropic:[0,1,1,""],semiisotropic:[0,1,1,""]},"hymd.field":{compute_field_and_kinetic_energy:[0,1,1,""],compute_field_energy_q_GPE:[0,1,1,""],compute_field_force:[0,1,1,""],compute_self_energy_q:[0,1,1,""],domain_decomposition:[0,1,1,""],initialize_pm:[0,1,1,""],update_field:[0,1,1,""],update_field_force_q:[0,1,1,""],update_field_force_q_GPE:[0,1,1,""]},"hymd.file_io":{OutDataset:[0,2,1,""],distribute_input:[0,1,1,""],setup_time_dependent_element:[0,1,1,""],store_data:[0,1,1,""],store_static:[0,1,1,""]},"hymd.file_io.OutDataset":{close_file:[0,3,1,""],flush:[0,3,1,""],is_open:[0,3,1,""]},"hymd.force":{Angle:[0,2,1,""],Bond:[0,2,1,""],Chi:[0,2,1,""],Dielectric_type:[0,2,1,""],Dihedral:[0,2,1,""],compute_angle_forces__plain:[0,1,1,""],compute_bond_forces__plain:[0,1,1,""],compute_dihedral_forces__plain:[0,1,1,""],dipole_forces_redistribution:[0,1,1,""],find_all_paths:[0,1,1,""],prepare_bonds:[0,1,1,""],prepare_bonds_old:[0,1,1,""],prepare_index_based_bonds:[0,1,1,""],propensity_potential_coeffs:[0,1,1,""]},"hymd.force.Angle":{atom_3:[0,4,1,""]},"hymd.force.Bond":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],equilibrium:[0,4,1,""],strength:[0,4,1,""]},"hymd.force.Chi":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],interaction_energy:[0,4,1,""]},"hymd.force.Dielectric_type":{atom_1:[0,4,1,""],dielectric_value:[0,4,1,""]},"hymd.force.Dihedral":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],atom_3:[0,4,1,""],atom_4:[0,4,1,""],coeffs:[0,4,1,""],dih_type:[0,4,1,""]},"hymd.hamiltonian":{DefaultNoChi:[0,2,1,""],DefaultWithChi:[0,2,1,""],Hamiltonian:[0,2,1,""],SquaredPhi:[0,2,1,""]},"hymd.hamiltonian.DefaultNoChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.DefaultWithChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.Hamiltonian":{__init__:[0,3,1,""],_setup:[0,3,1,""]},"hymd.hamiltonian.SquaredPhi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.input_parser":{Config:[0,2,1,""],check_NPT_conditions:[0,1,1,""],check_angles:[0,1,1,""],check_bonds:[0,1,1,""],check_box_size:[0,1,1,""],check_cancel_com_momentum:[0,1,1,""],check_charges:[0,1,1,""],check_charges_types_list:[0,1,1,""],check_chi:[0,1,1,""],check_config:[0,1,1,""],check_dielectric:[0,1,1,""],check_dihedrals:[0,1,1,""],check_domain_decomposition:[0,1,1,""],check_hamiltonian:[0,1,1,""],check_integrator:[0,1,1,""],check_m:[0,1,1,""],check_mass:[0,1,1,""],check_max_molecule_size:[0,1,1,""],check_n_b:[0,1,1,""],check_n_flush:[0,1,1,""],check_n_particles:[0,1,1,""],check_n_print:[0,1,1,""],check_name:[0,1,1,""],check_start_and_target_temperature:[0,1,1,""],check_tau:[0,1,1,""],check_thermostat_coupling_groups:[0,1,1,""],parse_config_toml:[0,1,1,""],read_config_toml:[0,1,1,""],sort_dielectric_by_type_id:[0,1,1,""]},"hymd.input_parser.Config":{a:[0,4,1,""],angle_bonds:[0,4,1,""],barostat:[0,4,1,""],barostat_type:[0,4,1,""],bonds:[0,4,1,""],box_size:[0,4,1,""],cancel_com_momentum:[0,4,1,""],chi:[0,4,1,""],conv_crit:[0,4,1,""],convergence_type:[0,4,1,""],coulomb_constant:[0,4,1,""],coulombtype:[0,4,1,""],dielectric_const:[0,4,1,""],dielectric_type:[0,4,1,""],dihedrals:[0,4,1,""],domain_decomposition:[0,4,1,""],dtype:[0,4,1,""],file_name:[0,4,1,""],gas_constant:[0,4,1,""],hamiltonian:[0,4,1,""],initial_energy:[0,4,1,""],integrator:[0,4,1,""],kappa:[0,4,1,""],m:[0,4,1,""],mass:[0,4,1,""],max_molecule_size:[0,4,1,""],mesh_size:[0,4,1,""],n_b:[0,4,1,""],n_flush:[0,4,1,""],n_particles:[0,4,1,""],n_print:[0,4,1,""],n_steps:[0,4,1,""],name:[0,4,1,""],pol_mixing:[0,4,1,""],pressure:[0,4,1,""],respa_inner:[0,4,1,""],rho0:[0,4,1,""],self_energy:[0,4,1,""],sigma:[0,4,1,""],start_temperature:[0,4,1,""],tags:[0,4,1,""],target_pressure:[0,4,1,""],target_temperature:[0,4,1,""],tau:[0,4,1,""],tau_p:[0,4,1,""],thermostat_coupling_groups:[0,4,1,""],thermostat_work:[0,4,1,""],time_step:[0,4,1,""],type_charges:[0,4,1,""]},"hymd.integrator":{integrate_position:[0,1,1,""],integrate_velocity:[0,1,1,""]},"hymd.logger":{Logger:[0,2,1,""],MPIFilterAll:[0,2,1,""],MPIFilterRoot:[0,2,1,""]},"hymd.logger.Logger":{setup:[0,3,1,""]},"hymd.logger.MPIFilterAll":{filter:[0,3,1,""]},"hymd.logger.MPIFilterRoot":{filter:[0,3,1,""]},"hymd.pressure":{comp_pressure:[0,1,1,""]},"hymd.thermostat":{_random_chi_squared:[0,1,1,""],_random_gaussian:[0,1,1,""],csvr_thermostat:[0,1,1,""]},hymd:{barostat:[0,0,0,"-"],field:[0,0,0,"-"],file_io:[0,0,0,"-"],force:[0,0,0,"-"],input_parser:[0,0,0,"-"],integrator:[0,0,0,"-"],pressure:[0,0,0,"-"],thermostat:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0020733":15,"00268976":15,"0083144621":0,"01036426965":4,"014101":[0,15],"02214076":4,"03642696562":4,"03970":6,"08790868":[6,10],"094106":15,"0xd":8,"0xe":8,"100":[4,6,11],"1000":6,"10000":6,"10001":6,"1010":10,"1021":15,"1063":15,"1080":15,"10nm":6,"110":10,"1120":[0,15],"1130":[0,15],"1137":15,"118":15,"120":[3,6,10],"120885887":15,"120ff":0,"123456":11,"1250":[3,6,10],"126":[0,15],"130":15,"1378":15,"138":[0,4],"1385":15,"144":8,"148":8,"1500":6,"153":15,"166":8,"170":6,"1785571":15,"179":0,"180":[3,6,10],"186":8,"197":8,"1974":0,"1981":0,"1984":0,"1990":15,"1992":[3,15],"200":[6,10],"2000":6,"2001":15,"2007":[0,3,15],"2008":[0,15],"2009":15,"201":[0,3],"2013":15,"2018":[0,15],"2020":[5,6,13,15],"2023":15,"20nm":6,"214106":15,"223":0,"224":1,"2408420":15,"2408724":[6,10],"246":0,"251":[6,10],"2531":15,"2543":15,"26434":15,"28103735":0,"298":6,"2_1":0,"2don2d":8,"2nd":0,"2t_a":12,"300":[6,11],"3000":6,"3142103":15,"3144621":4,"323":6,"3684":0,"3690":0,"449":[6,10],"463137":15,"48626121":[6,10],"4928":15,"4937":15,"502":8,"533":1,"544":[6,10],"550":10,"59427866":[6,10],"602176634":4,"610":[6,10],"6264644":15,"66053906660":4,"7b01160":15,"85418781281":4,"935458":[0,4],"940":10,"96924":6,"980":3,"9918564":[6,10],"\u03b1":0,"\u03b2":0,"\u03bd":13,"\u03c3":12,"boolean":[0,3],"byte":14,"case":[0,3,6,8,10,13],"class":[0,9],"default":[0,3,7,11,13,14],"export":8,"float":[0,3],"function":[0,3,5,6,7,11,13],"int":[0,5,6,9,12,13],"long":[5,6],"new":[0,10,14,15],"public":15,"return":[0,8],"short":[6,11],"sigbj\u00e3":15,"static":0,"switch":13,"true":[0,3,6],"while":[0,13],Adding:6,For:[0,11,13,15],The:[0,3,5,6,7,8,9,10,11,13,14,15],Then:10,There:[8,11],These:0,Used:[0,3,11],Using:[6,9,12],With:[0,6],__file__:8,__init__:[0,8],__main__:8,_gener:0,_hl:8,_kwarg:8,_random_chi_squar:0,_random_gaussian:0,_run_cod:8,_run_module_as_main:8,_set_fapl_mpio:8,_setup:0,about:[3,11,13],abov:[0,6,12],absent:0,acceler:0,accompani:6,accord:[0,3,12],accur:15,acid:6,across:[0,3],acs:15,act:[0,10,13],adapt:0,add:[5,6],added:0,adding:6,addison:0,addit:[0,2,5,11],addition:15,additon:0,adher:0,affect:0,affili:[0,2],after:[0,10,13],against:8,aggreg:6,ahren:0,alanin:6,algorithm:[0,3,13],alia:15,all:[0,2,3,4,6,8,10,11,15],all_nam:0,all_rank:0,alloc:0,allow:[11,15],allreduc:0,along:[6,11],alpha3:8,alpha:0,alpha_:0,alpha_l:0,alpha_n:0,alreadi:0,also:[6,8,15],altern:2,alwai:[0,3],amino:6,amount:0,amphiphil:15,analyt:0,angl:[0,2,3,6,8,10],angle_bond:[0,3,6,10],angle_pr:0,angular:[0,3,6,10],ani:[0,2,3],anisotrop:0,antonio:15,apart:0,api:8,app:8,appli:[0,3,7,9,13],applic:0,approach:15,approxim:0,apt:8,aqueou:15,architectur:15,arg:[0,8],argument:[0,6,8,11],argv:8,aris:0,around:10,arrai:[0,3,11,14],arriv:6,art:0,aspect:3,assess:0,assign:[0,3,10],associ:[0,9],assum:3,assumpt:13,atom:0,atom_1:0,atom_2:0,atom_3:0,atom_4:0,attach:14,attempt:0,attr:8,attract:3,attribut:0,autom:15,automat:[0,7,8,9],avail:[6,8,15],averag:[0,3,9,13],avogadro:4,back:[0,5,8],backbon:[0,2,3,15],backcon:0,backend:15,backmap:0,balanc:0,ballist:6,bar:[3,4,12],barostat:3,barostat_typ:[0,3],base:[0,15],bath:[0,3],bb_index:0,bc20:15,bdist_wheel:8,bdp07:15,bead:0,becaus:0,becom:[0,13],befor:[0,3,6,8],being:[0,2,3,5,10,11,13],belong:11,below:[0,6],benchmark:10,bend:[0,3,10,15],berendsen:3,bern:15,besid:2,best:0,beta:0,better:0,between:[0,3,5,6,9,10,13,14],bia:0,big:13,bin:8,binari:8,bind:15,bindu:15,bio:15,bit:[0,14],blueprint:0,bmc18:15,boltzmann:[0,3,4],bond2_energi:0,bond3_energi:0,bond4_energi:0,bond:[0,2,6,8,11,12,13,14],bond_pr:0,bonds_2:0,bonds_2_atom1:0,bonds_2_atom2:0,bonds_2_atom_1:0,bonds_2_atom_2:0,bonds_2_equilibrium:0,bonds_2_strength:0,bonds_3:0,bonds_3_atom_1:0,bonds_3_atom_2:0,bonds_3_atom_3:0,bonds_3_equilibrium:0,bonds_3_strength:0,bonds_4:0,bonds_4_atom_1:0,bonds_4_atom_2:0,bonds_4_atom_3:0,bonds_4_atom_4:0,bonds_4_coeff:0,bonds_4_last:0,bonds_4_typ:0,bool:0,bootstrap:8,bore:[0,5,13,15],both:[0,13],boundari:[0,3],box:[0,3,6,11,12,14],box_siz:[0,3,6,11],breviti:6,brew:8,broadcast:0,browser:8,bruce:15,buffer:[0,3],build_extens:8,build_pfft:8,build_pi:8,built:8,bussi:[0,3,15],c213:15,c236:15,c_n:[0,6,10],calcul:[0,3,6,10,12],calibr:[0,3,13],call:[0,3,8],callabl:0,can:[6,8,15],cancel_com_momentum:[0,3,6],canon:[0,3,15],capabl:2,captur:11,carloni:15,carri:6,cartesian:[0,3,12,14],cascella:[5,8,11,13,15],caval:15,cbt:0,cdot10:4,cdot:[0,4,10],cell:[0,13],cellar:8,center:[0,3],centr:15,certain:[0,2],ceruso:15,chain:[0,15],chang:[0,3],changedin:0,charg:[0,3,4,5,6,14,15],charge_out:0,check:[0,8],check_angl:0,check_bond:0,check_box_s:0,check_cancel_com_momentum:0,check_charg:0,check_charges_types_list:0,check_chi:0,check_config:0,check_dielectr:0,check_dihedr:0,check_domain_decomposit:0,check_hamiltonian:0,check_integr:0,check_m:0,check_mass:0,check_max_molecule_s:0,check_n_b:0,check_n_flush:0,check_n_particl:0,check_n_print:0,check_nam:0,check_npt_condit:0,check_start_and_target_temperatur:0,check_tau:0,check_thermostat_coupling_group:0,chem:[0,15],chemic:15,chemrxiv:15,chi:[0,3,4,6,8],chi_2:0,chi_3:0,chi_:[0,3,6,9,13],chi_m:0,chmod:11,choic:12,chosen:0,cic:[0,5,13],circ:[3,10],circumv:13,classmethod:0,classvar:0,clean:[0,8],clone:[8,11,15],close:[0,8],close_fil:0,closest:0,cloud:[0,6,13],cncdp08:15,coars:[0,3,7,12,13,15],code:[0,1,2,3,6,8,11],coeff:0,coeffici:0,coil:[0,6],colab:8,colaboratori:15,collect:[0,3,14],com:[0,8,11,15],combin:[0,6,15],comm:0,comm_world:0,command:[8,11],common:9,commuic:0,commun:[0,3,10],communc:0,comp_pressur:0,compar:6,compat:2,compil:[0,8],compiler_so:8,complesfield:0,complet:[0,6,8],complex:[6,14],complexfield:0,compon:0,comprehens:15,compress:[0,3,4,6,9,11],compris:12,comput:[0,5,10,13,15],computaion:0,compute_angle_forces__plain:0,compute_bond_forces__plain:0,compute_dihedral_forces__plain:0,compute_field_and_kinetic_energi:0,compute_field_energy_q_gp:0,compute_field_forc:0,compute_potenti:0,compute_self_energy_q:0,concret:11,condit:6,config:[0,8],config_simple_1:11,configur:[0,2,5,6,7,8,9,10,11],configuration_four_particle_exampl:10,configuration_three_particle_exampl:10,configuration_two_particle_exampl:10,configure_runtim:8,conform:[6,14,15],connect:0,conserv:1,consid:[0,6],consist:[0,6],consit:6,consitu:0,constant:[0,3,5,6,10,13],constitut:[0,2,3],constraint:3,construct:[0,10,11],constructor:0,contain:[0,1,2,3,6,11],content:[0,6],contribut:0,control:3,conv_crit:0,conv_fun:0,conveni:11,convent:0,converg:[0,13],convergence_typ:0,convert:0,coordin:[11,13,14],copi:0,core:8,correct:[0,3,13],correspond:[0,3,13],correspondingli:10,cos:[0,6,10],cosin:[0,3,6,10],cost:[3,10],could:8,coulomb:[0,3,4,5],coulomb_const:0,coulombtyp:[0,3,5,6],counter:6,coupl:[0,3,6,11],cprofil:2,cpu:[0,10],crash:3,creat:[0,9],critic:[0,6],cross:0,csvr:[0,3],csvr_thermostat:0,ct800122x:15,ct9002114:15,current:[0,6],cwd:8,cython:[8,15],d_n:0,dal:15,data:[0,3,6,11,14],dataclass:0,dataset:[0,5,6,11],datatyp:14,date:[0,15],date_format:0,david:15,debug:[0,2],decompos:0,decomposit:[0,3,10],default_level:0,defaultnochi:[0,6,9],defaultnohchi:[0,3],defaultwithchi:[0,3,6,9],defin:[0,6,9,10,13],definit:0,degre:3,delta:[0,13],denot:[0,1,3,9,10,11],dens:15,densiti:[0,3,5,9,13,15],depend:[0,6,10,13,15],deprec:0,deriv:[0,13],design:6,dest_directori:0,detail:[2,3,6,8,11,12,13],determin:[0,2,7,15],dev:8,devel:8,develop:[6,8],deviat:[0,3],dict:0,dictat:0,dictionari:0,dielectr:[0,3,6],dielectric_const:[0,3,5,6],dielectric_typ:0,dielectric_valu:0,dieter:0,diezemann:15,differ:[0,3,6,11,14],differenti:[0,5,7,9,13],difficult:2,dih_typ:0,dihedr:[0,2,3,5,6,8,10,15],dimens:[0,10,11,14],dimension:11,dinola:0,dipol:[0,2,3,5,6,15],dipole_forces_redistribut:0,direct:[0,3,12],directori:11,disabl:[2,6,8,11],disable_mpio:0,discard:0,discret:[0,13],discretis:13,disk:[0,3],dispers:6,dist:8,distanc:[0,3,10],distinct:0,distribut:[0,3,5,6,13],distribute_input:0,distutil:8,dnf:8,doc:0,dockerhub:8,dodecyl:6,doe:[0,10],doi:15,domain:[0,3,10],domain_decomposit:[0,3,6],donadio:[0,15],done:[0,6,8,15],dopc:6,dot:0,dot_elec:0,doubl:2,double_out:0,download:8,dppc:6,draw:0,drawn:0,driver:[8,11],dtype:0,due:[0,3],dump:0,dump_per_particl:0,dure:[0,2,3,10,11],dynam:[0,3,11,13,15],e1785571:15,e_k:0,each:[0,3,6,10,11],easiest:15,effect:[0,3],effici:10,eight:14,either:[0,3,8,14],elast:15,elec:0,elec_field:0,elec_field_contrib:0,elec_field_fouri:0,elec_forc:0,elecrostat:0,electr:[0,4,5],electrosat:0,electrostat:[0,6,15],elnedyn:15,els:3,elucid:6,embed:6,emit:0,emploi:0,empti:0,enabl:[2,6,11],enclos:0,end:0,energi:[0,1,3,4,6,7,10,11,12,13],energiesself:0,ensur:[0,3,6,8,13],ensurepip:8,entri:3,environ:15,epsilon:0,equal:[0,3,6],equat:0,equilibr:[3,6],equilibrium:[0,3,6],equilibrum:10,equival:[0,3],error:0,essenti:[0,1,8],etc:[2,3],even:[0,3,6,8],event:0,everi:[0,3,6,10,11],evid:0,ewald:[0,5,6],examin:6,exampl:[3,8,11,14,15],example_structur:11,except:10,exchang:[0,3],exec:8,execut:[0,8,11],exist:0,exit:8,exp:[7,13],expand:0,expans:0,expect:0,expens:[3,13],explicit:[0,6,10,15],express:[0,12],ext:0,extend:6,extens:15,extent:[0,7],extern:[0,3],extract:[0,8],f401:8,f_angl:0,f_bond:0,f_dihedr:0,f_dipol:0,f_on_bead:0,factor:0,factori:0,fail:[0,8],fall:8,fals:[0,3,6],fapl:8,fashion:[0,3],fast:13,fedora:8,fer:15,few:[6,9,10,11],fft:[0,1,2,3,5,6,11,13,15],fftw3:8,fftw:[8,15],field:[2,4,5,6,9,11,12,13,15],field_energi:0,field_list:0,field_q_energi:0,field_q_self_energi:0,file:[2,5,6,7,8,9,10,11,15],file_io:0,file_nam:0,file_path:0,filter:[0,3,5,6,11,12,15],find:[0,8],find_all_path:0,fine:8,first:[0,3,6,11],five:0,fix:[0,8,11],flag:[0,14],flat:11,float32:[11,14],float64:14,flori:0,fluctuat:0,flush:[0,3],follow:[0,2,3,4,6,11,12],forc:[2,3,4,5,6,10,15],force_kernel:8,force_mesh:0,force_mesh_elec:0,force_mesh_elec_fouri:0,force_out:0,forego:2,form:[0,5,10,12],formal:[5,13],format:[0,2,3,5,11,14,15],formatt:0,fortran:[0,10],forward:0,found:[5,8],four:[0,2,3,6,14],fourier:[0,5,13],fr6nt9m4:8,frac:[0,5,6,7,9,10,12,13],frame:[0,11,14],framework:8,free:15,frequenc:[0,3],from:[0,2,3,5,6,8,9,10,11,12,15],full:[0,9,11],fulli:[0,6,8],fundament:11,gamma:0,gamma_0:0,gas:[0,4],gas_const:0,gather:0,gauss:15,gaussian:[0,3,7,12,13],gener:[0,2,3,6,15],get:8,getattr:8,ghost:0,giovanni:15,git:[8,11,15],github:[6,8,11,15],githubusercont:8,giusepp:15,given:[0,3,6,7],glenn:15,global:0,gnu:15,govern:9,gpe:0,grab:8,gradient:0,grain:[0,3,7,12,13,15],graph:0,gregor:15,grid:[0,1,3,5,6,7,11,13],group:[0,3,6,8,11,14,15],guess:0,gunsteren:0,gyrat:6,h5md:[0,3],h5py:[0,2],h_0:[6,13],haak:0,half:0,hamiltonian:[3,5,6,7,9,11,15],handl:0,handler:0,happen:10,harmon:[0,3,6,10],has:[0,3,8,14],hat:[7,13],have:[0,6,8],hdf5:[0,2,3,5,6,8,11,14,15],hdf5_dir:8,hdf5_mpi:8,head:6,header:8,heat:[0,3],helic:[0,3,5,6],help:6,helper:0,here:[0,6,8,15],hhpf:[12,15],highli:[8,10,11],hijack:7,hima:15,hire:1,homogen:0,homopolym:1,homopolypeptid:6,how:[3,11,15],howev:6,hpf:[3,5,9,11,13,15],html:0,http:[0,8,11,15],huggin:0,hundr:[6,10],hybrid:[11,13,15],hylleraa:15,hymd:[0,2,3,4,5,6,7,9,10,11,13,14],ideal:10,ideal_chain:[6,8],ideal_ga:[6,11],ident:0,ignor:0,ijk:[5,13],imag:8,impact:0,implement:[0,10],importerror:8,impuls:[0,3],in_fil:[0,8],inam:8,includ:[0,2,3,6,13,15],incompress:[0,3],increas:[0,2,6],indentifi:0,independ:[0,3,7,13],index:[0,11,14,15],indic:[0,2,3,10,11,14],indirect:0,individu:[0,3,6],induc:5,infer:10,info:[0,8],inform:[0,10,15],ingredi:6,initi:[0,14],initial_energi:0,initialis:11,initialize_pm:0,inner:[0,3],input:[2,3,4,5,6,7,8,11,14],input_box:0,input_pars:[0,8],insert:0,insid:[0,3,6],instal:[2,11],install_pfft:8,instantan:0,int32:[11,14],int64:14,integ:[0,3,6,14],integr:[3,6,11],integrate_posit:0,integrate_veloc:0,intend:8,inter:[0,10],interact:[0,2,3,4,6,7,11,12,13,15],interaction_energi:0,interfac:0,intergr:0,intermediari:0,intermolecular:[6,15],intern:[0,2,3,4,10,12],interpol:[0,5],interpret:11,interv:[0,3],intmathrm:0,intracomm:0,intramolecular:[0,3,6,12,13,15],intrins:[3,5,13],introduc:6,investig:0,invok:[2,11],involv:[0,3,10],ion:6,ipynb:6,is_open:0,isotherm:0,isotrop:[0,3],iter:0,j_k:0,jan:15,jctc:15,join:8,jone:13,journal:15,jupyt:[6,8,15],k_e:0,kappa:[0,3,4,6,11,13],kawakatsu:15,kdnb:15,keep:[0,3],kelvin:[0,3,6,11],ken:15,kernel:[0,10],keyword:[0,5,6,11],kinet:[0,12,13],kinetic_energi:0,knuth:0,kolli:15,kpa:4,kwd:8,l_a:12,label:[1,10],lambda:0,lamdifi:9,land:15,laplacian:0,larg:[8,11],larger:3,last:[6,8,11,14],last_bb:0,later:[0,6],latest:8,law:10,layout:0,layout_q:0,lbc20:15,leak:8,learn:15,leav:0,ledum:[6,15],left:[0,5,6,7,9,10,12,13],legend:1,lenght:0,length:[0,3,4,6,7,10,11,12,14],lennard:13,less:[0,6],lesser:15,let:[0,10],level:[0,2,3,14],liang:15,lib64:8,lib:8,libhdf5:8,libopenmpi:8,librari:[0,2,8,15],libtool:8,libver:8,licens:15,lieu:0,like:[0,6,8,11],limit:[3,8],line:[0,8,11],linear:[0,3],lipid_self_assembl:6,list:0,list_coulomb:0,load:0,local:[0,8,10,11,13],locat:8,log:[0,2,11],log_fil:0,log_out:11,logfil:[2,11],logger:2,logic:0,logrecord:0,look:[6,8,11],loop:0,lost:3,low:[6,8],lower:8,m_j:0,mac:8,machin:[2,15],made:0,mai:[0,2,3,6,8,10,11,14],main:[0,8,11],main_glob:8,maintain:15,make:[6,8],make_fapl:8,manner:6,manual:8,map:[0,11],mar:15,marco:15,marilisa:15,marrink:15,martini:[6,15],martyna:15,mass:[0,3,4,14],massiv:15,match:0,math:0,mathbf:[0,4,5,6,9,10,12,13],mathcal:[6,12,13],mathmr:0,mathrm:[0,5,6,9,10,13],matteo:15,matter:[6,10,15],max_molecule_s:[0,3,6],maximum:[0,3,10,11],maxwel:[0,3],may:2,mbbjm:15,mean:[0,2,3],measur:10,medium:[0,3,6],melt:1,membran:6,memori:[0,8],mesh:[0,1,3,5,6,15],mesh_siz:[0,3,6,11],messag:0,messi:0,meta:6,metadata:0,method:[0,1,6,7],mh_0:13,micellular:6,michael:15,michel:15,might:[0,8],milano:15,mimic:0,minim:6,minuscul:10,mirror:2,mix:[0,6],mk09:15,model:[6,15],modifi:0,modul:[0,3,8,15],mol:[3,4,6,10,11,15],molecul:[0,3,11,13,14],molecular:[0,2,11,13,15],moment:8,momenta:[0,11],momentum:[0,3,4],monoatom:6,more:[2,3,6,8,11,13,15],mortel:8,morten:15,most:[8,9,11,12,13],mostli:2,motion:[0,6],move:0,mpi4pi:[0,8,15],mpi:[0,2,3,10,11,15],mpi_num_rank:11,mpicc:8,mpifilteral:0,mpifilterroot:0,mpio:[2,8],mpip:8,mpirun:11,multiarrai:8,multipl:[0,3,6,11,14,15],multipolar:15,multiscal:15,must:[0,3],n_b:[0,3],n_flush:[0,3,6],n_frame:0,n_particl:[0,3],n_print:[0,3,6,11],n_step:[0,3,6,11],n_type:0,nabla:[0,13],nabla_a:12,name:[0,2,3,6,10,11,14],nanomet:[0,1],nanosecond:6,natur:[0,12],ndarrai:0,ne5et1y_:8,necessari:[0,6,8],necessit:[8,9],need:[0,6],neg:[0,6],neighbour:0,neri:15,network:[0,10,11,14,15],networkx:0,neutralis:6,never:[0,3],nevertheless:3,newer:8,next:[0,6],nicola:15,non:[0,2,6,8],none:[0,3,8],nongnu:0,noqa:8,normal:[0,2,3,8,13],notabl:11,note:[0,6,8,11,12,13],notebook:[6,8,15],now:6,nproc:11,npt:[0,13],nq_i:5,number:[0,1,2,3,6,11,13,14],numer:0,numpi:[0,2,9,15],nvt:0,object:[0,9],oblat:6,observ:[0,6],obtain:[0,3,5,12,13,15],obviou:8,off:6,omit:6,onc:[3,10],one:[0,2,3,6,14],onli:[0,6,8,10,11],onto:[0,3,5,13],open:[0,8],openmpi:8,oper:[0,3,13,15],oppos:0,optim:[0,10],optimis:[6,10],option:[0,3,6,11],order:[0,3,6,10,11],ordinari:[5,13],org:0,organis:6,origin:0,oslo:15,osx:8,other:[0,11],otherwis:0,out:[8,13],outdataset:0,outer:[0,3],output:[2,3,4,6,8,11],outsid:3,over:0,overlap:[0,9],p_a:12,packag:[8,11,15],page:15,paint:0,paolo:15,paper:0,parallel:[0,2,3,15],paramet:[0,3,6,7,9,12,13,15],parent_group:0,parllel:0,parrinello:[0,15],pars:[0,3],parse_config_toml:[0,8],part:[5,6,13],partial:[0,12],particl:[0,2,5,6,7,9,11,13,14,15],particlemesh:0,particular:11,pass:0,path:[0,2,8,11],pcmc09:15,pdf:1,pencil:0,peptid:[0,2,3,5,15],per:[0,2,3,10,11,14],peraro:15,perfect:0,perform:[0,3,8,10,11,13],periol:15,perman:[10,15],permitt:[0,4],pfft:[0,15],pfft_build_dir:8,phase:[0,10],phase_separ:6,phi:[0,3,6,10,12,13],phi_0:[6,9,13],phi_:[0,6,9,13],phi_ep:0,phi_eps_fouri:0,phi_eta:0,phi_eta_fouri:0,phi_fft:0,phi_fouri:0,phi_k:0,phi_l:0,phi_laplacian:0,phi_n:[6,10],phi_pol:0,phi_pol_prev:0,phi_q:0,phi_q_fouri:0,phi_t:12,phi_transf:0,phospholipid:6,phy:[0,15],pic_spectr:[0,3,6],pic_spectral_gp:0,piec:6,pip13:15,pip3:8,pip:[8,11,15],pippig:15,pkg:8,place:[0,3],plain:2,plane:[0,6,10],pleas:[8,11],plist:8,plume:0,plumed_bia:0,plumed_out:0,pm_stuff:0,pme:15,pmesh:[0,15],png:1,point:[0,1,10,14],poisson:0,pol_mix:0,polar:0,polym:[6,15],posit:[0,2,3,5,6,11,13],possibl:[0,3,6,15],postma:0,potenti:[0,3,4,5,7,8,10,15],ppft:15,practic:10,pre:[0,6],precis:[1,2],prefer:3,prepar:0,prepare_bond:0,prepare_bonds_old:0,prepare_index_based_bond:0,prepend:[0,11],present:[0,2,3,6],preserv:3,pressur:[4,13],pretti:8,previou:0,previous:6,prior:[0,3],priovid:0,prng:0,prod_:0,profil:2,program:[0,11],project:5,promot:0,prop:0,propag:[0,3],propens:[0,3,5,6],propensity_potential_coeff:0,properti:3,protein:[0,15],provid:[0,2,3,11,14,15],psi:[0,4,5],psi_:5,psi_fouri:0,pull:8,put:6,pytest:11,python3:[6,8,11,15],python:[0,11,15],q_i:[0,5],q_j:0,quadrat:0,quanit:0,quantiti:[0,4],quantum:15,quartet:10,quess:0,r_0:[0,6,10],r_a:10,r_c:10,rad:[3,10],radial:6,radii:6,radiu:6,rainwoodman:[8,15],rais:[6,8],random:[0,2,11],random_chi_squar:0,random_gaussian:0,randomli:[0,3,6],rang:5,rank0:0,rank:[0,2,3,10,11],rank_rang:0,rankself:0,rare:10,raw:8,rdcc_nbyte:8,rdcc_nslot:8,rdcc_w0:8,read:[0,8,11,15],read_config_toml:[0,8],readout:0,real:14,realfield:0,realist:6,reappli:0,rearrang:0,reason:8,receiv:[0,3],recent:8,reciproc:[0,7],recognis:11,recognit:15,recommend:8,reconstruct:[0,2,5,6,10,15],record:0,recreat:15,recurs:0,redistribut:0,reduc:[3,13],refer:[3,11],regim:6,regul:[0,3],regularli:8,reiniti:0,rel:[0,3,6,10],relax:[0,3],releas:[0,6,8,11,15],remain:[0,6],remov:[0,3],remove_center_of_mass_momentum:0,remove_com_momentum:[0,3],replac:[0,8],repositori:[6,11],repres:[0,3,14],represent:7,repuls:3,requir:[0,3,8,10,11,15],rescal:[0,3,15],research:15,respa:[0,3,6],respa_inn:[0,3,6],respect:[0,1,13],restructur:0,result:[0,3,6,9],revers:[0,3,15],rgen:15,rho0:[0,3],rho:[0,5],rho_0:[0,13],rho_:5,right:[0,5,6,7,9,10,12,13],rightarrow:10,root:[0,11,14],roughi:6,row:11,rrespa:[0,3,6],ruin:0,run:[0,2,3,6,10],run_glob:8,rundown:11,runpi:8,runtimeerror:8,same:[0,3,6],sampl:[0,3,15],scalar:0,scale:[0,3,6,7,8,10,11,15],sch:15,scheme:[0,6],sci:15,scienc:15,scr:3,script:11,sds:6,search:15,second:[0,11],see:[0,2,3,5,6,8,9,10,11,12,13,15],seed:[2,11],select:[11,15],self:[0,3,8],self_energi:0,semiisotrop:[0,3],seminumer:0,send:[0,3],separ:0,seri:[0,3,6,10],serial:[8,11],serialis:3,set:[0,3,11],set_fapl:8,setup:[0,6,7,8,14],setup_time_dependent_el:0,setuptool:8,sever:0,shape:[0,6,11,14],sheet:0,shift:0,should:[0,2,10],shown:6,siam:15,siewert:15,sigbj:15,sigma:[0,3,6,7,11,12,13],sim:0,similar:0,simpl:[0,6,11,13],simplest:6,simpli:0,simul:[0,2,6,8,10,12,13,14,15],simultan:0,sinc:0,singl:[0,3,6],site:8,size:[0,3,6,11,13],slight:0,slowli:13,small:[3,11],smear:5,smooth:[0,13],sodium:6,soft:[6,15],solv:0,solvent:6,some:[0,3,8],sort:0,sort_dielectric_by_type_id:0,sourc:[0,1],space:[0,3,5,7],span:0,spatial:[0,3,11,13],specfi:0,speci:0,special:0,specif:[0,2,3,6,9,10,11,13,14],specifi:[0,2,3,6,9,10,11,14],spectacularli:0,spectral:6,speed:[0,3],spheric:6,spheroid:6,split:0,spontan:6,spring:[0,10],sqrt:[0,7,13],squar:[0,9],squaredphi:[0,3,9,11],stabil:6,stabl:6,stackoverflow:0,standard:[0,3,13,15],start:[0,3,6,10,14],start_temperatur:[0,3,6],state:0,statu:8,stdout:[0,2],step:[0,3,6,10,11],stiff:3,stochast:0,store:0,store_data:0,store_stat:0,str10:11,str:0,straightforward:[7,9],stream:0,strength:[0,3,6,11],stretch:[0,3,10,15],string:[0,3,8,11,14],structur:[0,2,3,5,6,11,15],style:15,sub:6,subclass:[0,9],subsequ:[0,5,6,10],sudo:8,suitabl:[0,3],sulfat:6,sum:0,sum_:[0,5,9,12,13],sum_i:0,sum_j:0,sum_k:0,sum_n:[0,6,10],sum_t:12,summari:11,superclass:[0,7],support:[0,6,8,15],swap:10,symbol:[0,4,9],sympi:[0,9],sys:8,system:[0,1,2,3,6,9,11,13,15],t_a:12,tag:[0,3,8],take:[0,3,5,9,10,11,13],taken:0,tar:8,target:[0,3,13],target_pressur:[0,3],target_temperatur:[0,3,6,11],tau:[0,3,6,11],tau_p:[0,3],tbm92:15,temperatur:[0,3,4,6,11,13],ten:6,term:[0,3,6,9,12,13],test:[0,1,8],text:[0,2,3,4,5,6,9,10,12,13],than:[0,3],theori:[0,12,15],therefor:8,thermalis:[0,3],thermostat:[2,3,6,11],thermostat_coupling_group:[0,3,6],thermostat_work:0,theta:[6,10],theta_0:[0,6,10],thi:[0,2,3,6,8,9,10,11,13],thorough:11,though:6,thousand:[6,10],three:[0,2,3,6],through:[0,3,6,7,8,9,10,15],tild:[0,3,4,5,6,9,12,13],time:[0,3,4,6,10,11,15],time_step:[0,3,6,11],tmp:8,todo:0,togeth:[0,3,6],token:8,toml:[0,2,3,6,8,10,11],toml_cont:0,tomli:0,too:3,toplog:0,topol:0,topolog:[0,2,3,5,6,11,15],torsion:[0,3,10,15],toshihiro:15,total:[0,3,6,11,12,13],traceback:8,trajectori:[0,2,3,6,11],trans_matric:0,transfer:[0,10],transform:[0,9,13],travers:0,tri:3,trivial:0,truncat:0,tuckerman:[3,15],turn:6,tutori:[6,8,11,14],two:[0,2,3,6],txt:11,type:[0,2,3,5,6,9,10,11,14],type_arrai:0,type_charg:0,type_to_name_map:0,typic:3,ubuntu:8,uio:[8,11,15],unchang:0,under:[6,8,13,15],uniformli:0,uninstal:8,union:0,uniqu:0,unique_nam:0,unit:[0,3,10],univers:15,unknown:0,unless:[0,3],unmodifi:0,unset:0,unstabl:3,until:6,updat:[0,8],update_field:0,update_field_force_q:0,update_field_force_q_gp:0,upgrad:[8,15],usag:[0,2],use:[0,3,5,6,8],used:[0,1,2,3,6,7,9,11,13,14],uses:[0,4,13,15],using:[0,2,3,8,13,15],usr:8,usual:11,v_2:[0,6,10],v_3:[0,6,10],v_4:[0,6,10],v_ext:0,v_ext_fouri:0,vacuum:4,valid:[0,3],validated_config:0,valu:[0,3,4,5,6,10],valueerror:8,van:0,vanish:0,varepsilon:0,varepsilon_0:[4,5],vari:13,variabl:0,variant:6,variou:[0,14],vbar_elec:0,vbar_elec_fouri:0,vector:[3,10],vectoris:9,veloc:[0,2,3,4,6,11,14,15],velocity_out:0,velocti:0,verbos:[0,2,8,11],veri:[6,8,10],verifi:0,verlet:[0,3,6,11],versa:3,version:[0,6,8,11,13],vert:0,vertex:[0,5],vertic:0,via:[6,15],vice:3,vir:12,virial:12,vol:0,volum:[0,3,12,13],voxel:0,wai:[8,13],warn:0,weakli:3,weight:0,well:6,were:0,weslei:0,wheel:8,when:[0,3,8,10],where:[0,5,9,10,12,13],whether:[0,3],which:[0,2,3,5,6,8,9,10,11,12],width:[0,3],window:[0,5,13],without:[0,15],work:[0,8],workload:0,would:[0,3],wrap:0,wrapper:0,write:[0,3],written:[0,3],www:0,xavier:15,yet:0,yield:6,you:[8,10,15],yuan:15,zero:[0,3],zhong:15,zhu:15},titles:["4. API reference","3. Benchmarks","5. Command line arguments","3. Configuration file","6. Constants and Units","3. Electrostatic interactions","1. Examples","2. Filtering","1. Installation","1. Interaction energy functionals","2. Intramolecular bonds","2. Usage overview for HylleraasMD","4. Pressure","1. Theory","4. Topology and structure file","HylleraasMD documentation"],titleterms:{"function":9,"import":8,"new":[7,9],"while":8,SDS:6,api:0,argument:2,assembl:6,barostat:0,benchmark:1,berendsen:0,bilay:6,bond:[1,3,10],build:8,calcul:13,chain:6,chi:9,code:15,colab:15,colaboratori:8,command:2,common:8,configur:3,constant:4,copolym:6,curl:8,dataset:14,depend:8,develop:15,diblock:6,docker:8,document:15,due:8,electrostat:[3,5],enabl:8,energi:9,error:8,exampl:6,extern:13,field:[0,1,3],file:[0,3,14],filter:[7,13],forc:[0,1,8,13],form:[9,13],fortran:8,four:10,gas:6,googl:[8,15],guid:15,h5py:8,hamiltonian:[0,13],helix:6,hylleraasmd:[11,15],hymd:[8,15],ideal:6,implement:[7,9],incompress:9,indic:15,input:0,instal:[8,15],integr:0,interact:[5,8,9],interpol:13,intramolecular:10,issu:8,kappa:9,kernel:8,keyword:3,line:2,lipid:6,logger:0,metadata:3,miss:8,mpi:8,numpi:8,onli:9,option:[2,14],output:0,overview:11,parallel:[8,11],parser:0,particl:[1,3,10],peptid:6,pfft:8,phase:6,phi:9,potenti:13,pressur:[0,3,12],python:8,reciproc:13,refer:[0,15],requir:[2,14],rod:6,run:[8,11,15],scr:0,self:6,separ:6,simul:[3,11],sourc:15,space:13,specifi:5,stiff:6,structur:14,tabl:15,test:11,theori:13,thermostat:0,three:10,topolog:14,two:10,unit:4,usag:11,user:15,wget:8,without:8}}) \ No newline at end of file diff --git a/v2.0.1/.buildinfo b/v2.0.1/.buildinfo new file mode 100644 index 00000000..a5741881 --- /dev/null +++ b/v2.0.1/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 7cc54a27619a6fea8f22f23185f41c1e +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v2.0.1/.doctrees/doc_pages/api.doctree b/v2.0.1/.doctrees/doc_pages/api.doctree new file mode 100644 index 00000000..9ba005cb Binary files /dev/null and b/v2.0.1/.doctrees/doc_pages/api.doctree differ diff --git a/v2.0.1/.doctrees/doc_pages/benchmarks.doctree b/v2.0.1/.doctrees/doc_pages/benchmarks.doctree new file mode 100644 index 00000000..8cfcdb72 Binary files /dev/null and b/v2.0.1/.doctrees/doc_pages/benchmarks.doctree differ diff --git a/v2.0.1/.doctrees/doc_pages/command_line.doctree b/v2.0.1/.doctrees/doc_pages/command_line.doctree new file mode 100644 index 00000000..97862439 Binary files /dev/null and b/v2.0.1/.doctrees/doc_pages/command_line.doctree differ diff --git a/v2.0.1/.doctrees/doc_pages/config_file.doctree b/v2.0.1/.doctrees/doc_pages/config_file.doctree new file mode 100644 index 00000000..d9dcb31f Binary files /dev/null and b/v2.0.1/.doctrees/doc_pages/config_file.doctree differ diff --git a/v2.0.1/.doctrees/doc_pages/constants_and_units.doctree b/v2.0.1/.doctrees/doc_pages/constants_and_units.doctree new file mode 100644 index 00000000..3b377067 Binary files /dev/null and b/v2.0.1/.doctrees/doc_pages/constants_and_units.doctree differ diff --git a/v2.0.1/.doctrees/doc_pages/electrostatics.doctree b/v2.0.1/.doctrees/doc_pages/electrostatics.doctree new file mode 100644 index 00000000..9fc6098b Binary files /dev/null and b/v2.0.1/.doctrees/doc_pages/electrostatics.doctree differ diff --git a/v2.0.1/.doctrees/doc_pages/examples.doctree b/v2.0.1/.doctrees/doc_pages/examples.doctree new file mode 100644 index 00000000..a1658b08 Binary files /dev/null and b/v2.0.1/.doctrees/doc_pages/examples.doctree differ diff --git a/v2.0.1/.doctrees/doc_pages/filtering.doctree b/v2.0.1/.doctrees/doc_pages/filtering.doctree new file mode 100644 index 00000000..4ca9dbdf Binary files /dev/null and b/v2.0.1/.doctrees/doc_pages/filtering.doctree differ diff --git a/v2.0.1/.doctrees/doc_pages/installation.doctree b/v2.0.1/.doctrees/doc_pages/installation.doctree new file mode 100644 index 00000000..d43d6587 Binary files /dev/null and b/v2.0.1/.doctrees/doc_pages/installation.doctree differ diff --git a/v2.0.1/.doctrees/doc_pages/interaction_energy_functionals.doctree b/v2.0.1/.doctrees/doc_pages/interaction_energy_functionals.doctree new file mode 100644 index 00000000..334033ee Binary files /dev/null and b/v2.0.1/.doctrees/doc_pages/interaction_energy_functionals.doctree differ diff --git a/v2.0.1/.doctrees/doc_pages/intramolecular_bonds.doctree b/v2.0.1/.doctrees/doc_pages/intramolecular_bonds.doctree new file mode 100644 index 00000000..ea48e02c Binary files /dev/null and b/v2.0.1/.doctrees/doc_pages/intramolecular_bonds.doctree differ diff --git a/v2.0.1/.doctrees/doc_pages/overview.doctree b/v2.0.1/.doctrees/doc_pages/overview.doctree new file mode 100644 index 00000000..6fd848cd Binary files /dev/null and b/v2.0.1/.doctrees/doc_pages/overview.doctree differ diff --git a/v2.0.1/.doctrees/doc_pages/pressure.doctree b/v2.0.1/.doctrees/doc_pages/pressure.doctree new file mode 100644 index 00000000..f0f157ef Binary files /dev/null and b/v2.0.1/.doctrees/doc_pages/pressure.doctree differ diff --git a/v2.0.1/.doctrees/doc_pages/theory.doctree b/v2.0.1/.doctrees/doc_pages/theory.doctree new file mode 100644 index 00000000..d289e44b Binary files /dev/null and b/v2.0.1/.doctrees/doc_pages/theory.doctree differ diff --git a/v2.0.1/.doctrees/doc_pages/topology_input.doctree b/v2.0.1/.doctrees/doc_pages/topology_input.doctree new file mode 100644 index 00000000..44e7c99b Binary files /dev/null and b/v2.0.1/.doctrees/doc_pages/topology_input.doctree differ diff --git a/v2.0.1/.doctrees/environment.pickle b/v2.0.1/.doctrees/environment.pickle new file mode 100644 index 00000000..3be81a55 Binary files /dev/null and b/v2.0.1/.doctrees/environment.pickle differ diff --git a/v2.0.1/.doctrees/index.doctree b/v2.0.1/.doctrees/index.doctree new file mode 100644 index 00000000..77c615a1 Binary files /dev/null and b/v2.0.1/.doctrees/index.doctree differ diff --git a/v2.0.1/_downloads/308874d37ecfb47c7da8fb1ef64f793d/benchmarks-1.hires.png b/v2.0.1/_downloads/308874d37ecfb47c7da8fb1ef64f793d/benchmarks-1.hires.png new file mode 100644 index 00000000..173b39f3 Binary files /dev/null and b/v2.0.1/_downloads/308874d37ecfb47c7da8fb1ef64f793d/benchmarks-1.hires.png differ diff --git a/v2.0.1/_downloads/32757cb763ff07c05fc502336a2c05a5/benchmarks-2.py b/v2.0.1/_downloads/32757cb763ff07c05fc502336a2c05a5/benchmarks-2.py new file mode 100644 index 00000000..fd287cbc --- /dev/null +++ b/v2.0.1/_downloads/32757cb763ff07c05fc502336a2c05a5/benchmarks-2.py @@ -0,0 +1,33 @@ +import numpy as np +import matplotlib.pyplot as plt + +mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] +mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + +mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + +mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + +mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] +mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + +mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + +mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + +plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") +plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") +plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") +plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") +plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") +plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") +plt.xlabel("CPUs", fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.ylabel("Time per step, s", fontsize=15) +plt.legend(loc="upper left", fontsize=15) +plt.show() \ No newline at end of file diff --git a/v2.0.1/_downloads/56c00aa7a1ca68b8229449415fcc90d4/benchmarks-1.png b/v2.0.1/_downloads/56c00aa7a1ca68b8229449415fcc90d4/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v2.0.1/_downloads/56c00aa7a1ca68b8229449415fcc90d4/benchmarks-1.png differ diff --git a/v2.0.1/_downloads/af6ea732b8d8f9ddc50365f8907c38e1/benchmarks-2.pdf b/v2.0.1/_downloads/af6ea732b8d8f9ddc50365f8907c38e1/benchmarks-2.pdf new file mode 100644 index 00000000..a6be713b Binary files /dev/null and b/v2.0.1/_downloads/af6ea732b8d8f9ddc50365f8907c38e1/benchmarks-2.pdf differ diff --git a/v2.0.1/_downloads/b7c7abb0b2ddb150004682ec43061485/benchmarks-1.py b/v2.0.1/_downloads/b7c7abb0b2ddb150004682ec43061485/benchmarks-1.py new file mode 100644 index 00000000..deb4348f --- /dev/null +++ b/v2.0.1/_downloads/b7c7abb0b2ddb150004682ec43061485/benchmarks-1.py @@ -0,0 +1,38 @@ +import numpy as np +import matplotlib.pyplot as plt +nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) +time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 +], dtype=np.float64) +nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 +], dtype=np.float64,) +time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, +], dtype=np.float64) +nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 +], dtype=np.float64) +time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, +], dtype=np.float64) +plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" +) +plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" +) +plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" +) +plt.xlabel("CPUs", fontsize=15) +plt.ylabel("Time per step, us", fontsize=15) +plt.legend(fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.show() \ No newline at end of file diff --git a/v2.0.1/_downloads/bb2fd395f24ebee86d61b44315bdfac1/benchmarks-1.pdf b/v2.0.1/_downloads/bb2fd395f24ebee86d61b44315bdfac1/benchmarks-1.pdf new file mode 100644 index 00000000..c425a492 Binary files /dev/null and b/v2.0.1/_downloads/bb2fd395f24ebee86d61b44315bdfac1/benchmarks-1.pdf differ diff --git a/v2.0.1/_downloads/e5b58692f8d697892bfa3ecc054d673f/benchmarks-2.png b/v2.0.1/_downloads/e5b58692f8d697892bfa3ecc054d673f/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v2.0.1/_downloads/e5b58692f8d697892bfa3ecc054d673f/benchmarks-2.png differ diff --git a/v2.0.1/_downloads/ed9da8f11da71f7a51c1c910fe07da01/benchmarks-2.hires.png b/v2.0.1/_downloads/ed9da8f11da71f7a51c1c910fe07da01/benchmarks-2.hires.png new file mode 100644 index 00000000..82806426 Binary files /dev/null and b/v2.0.1/_downloads/ed9da8f11da71f7a51c1c910fe07da01/benchmarks-2.hires.png differ diff --git a/v2.0.1/_images/benchmarks-1.png b/v2.0.1/_images/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v2.0.1/_images/benchmarks-1.png differ diff --git a/v2.0.1/_images/benchmarks-2.png b/v2.0.1/_images/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v2.0.1/_images/benchmarks-2.png differ diff --git a/v2.0.1/_images/hylleraas_centre_logo_black.png b/v2.0.1/_images/hylleraas_centre_logo_black.png new file mode 100644 index 00000000..40826396 Binary files /dev/null and b/v2.0.1/_images/hylleraas_centre_logo_black.png differ diff --git a/v2.0.1/_images/uio_full_logo_eng_pos.png b/v2.0.1/_images/uio_full_logo_eng_pos.png new file mode 100644 index 00000000..6c603139 Binary files /dev/null and b/v2.0.1/_images/uio_full_logo_eng_pos.png differ diff --git a/v2.0.1/_modules/hymd/barostat.html b/v2.0.1/_modules/hymd/barostat.html new file mode 100644 index 00000000..bd196424 --- /dev/null +++ b/v2.0.1/_modules/hymd/barostat.html @@ -0,0 +1,599 @@ + + + + + + hymd.barostat — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.barostat

+"""Implements the Berendsen barostat.
+Scales the box and particle positions during simulation to
+simulate coupling to an external pressure bath set at a
+target pressure.
+
+It calculates the scaling factor according to:
+.. math::
+
+    \\alpha_{L,N} = 1 - \\frac{dt n_b}{\\tau_p}\\β(P_{L,N}^t - P_{L,N})
+
+where :math:`dt` is the outer rRESPA time-step, :math:`n_b` is the frequency
+of barostat calls, :math:`\\tau_p` is the pressure coupling time constant,
+:math:`\\beta` is the isothermal compressibility, :math:`P_{L,N}^t` and 
+:math:`P_{L,N}` is the target and instantaneous internal pressure in the 
+lateral (L) and normal (N) directions respectively. Convention: Cartesian
+z-direction is considered normal.
+
+The box and particle positions are scaled in the L and N directions according
+to the nature of the barostat (see functions `isotropic` and `semiisotropic`
+below by an amount :math:`\α^{\\frac{1}{3}}`.
+
+The updated system information is passed on to the pmesh objects.
+
+References
+----------
+H. J. C. Berendsen, J. P. M. Postma, W. F. van Gunsteren,
+A. DiNola, and J. R. Haak , "Molecular dynamics with coupling
+to an external bath", J. Chem. Phys. 81, 3684-3690 (1984)
+"""
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass
+from typing import Union
+from .pressure import comp_pressure
+from .field import initialize_pm
+
+
+@dataclass
+class Target_pressure:
+    P_L: Union[bool, float]
+    P_N: Union[bool, float]
+
+
+
[docs]def isotropic( + pmesh, + pm_stuff, + phi, + phi_q, + psi, + hamiltonian, + positions, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + bond_pr, + angle_pr, + step, + prng, + comm=MPI.COMM_WORLD, +): + """ + Implements an isotropic Berendsen barostat. + The box and particle positions are scaled uniformly + in the L and N directions. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of pmesh objects. + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fft : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds. + step : integer + MD step number + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of modified/unmodified pmesh objects. + change : Boolean + Indicates whether or not any pmesh objects were reinitialized. + """ + rank = comm.Get_rank() + beta = 4.6 * 10 ** (-5) # bar^(-1) #isothermal compressibility of water + change = False + + if np.mod(step, config.n_b) == 0: + change = True + # compute pressure + pressure = comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=comm, + ) + + # Total pressure across all ranks + P = np.average(pressure[-3:-1]) # kJ/(mol nm^3) + P = P * 16.61 # bar + + # scaling factor + alpha = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_L - P) + ) ** (1 / 3) + + # length scaling + config.box_size *= alpha + + # position coordinates scaling + positions *= alpha + + # pmesh re-initialize + pm_stuff = initialize_pm(pmesh, config, comm) + return (pm_stuff, change)
+ + +
[docs]def semiisotropic( + pmesh, + pm_stuff, + phi, + phi_q, + psi, + hamiltonian, + positions, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + bond_pr, + angle_pr, + step, + prng, + comm=MPI.COMM_WORLD, +): + """ + Implements a semiisotropic Berendsen barostat. + The box and particle positions are scaled by :math:`\\alpha_L^{\\frac{1}{3}}` + in the L direction and by :math:`\\alpha_N^{\\frac{1}{3}}` in the N direction. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of pmesh objects. + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fft : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds. + step : integer + MD step number + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of modified/unmodified pmesh objects. + change : Boolean + Indicates whether or not any pmesh objects were reinitialized. + """ + rank = comm.Get_rank() + beta = 4.6 * 10 ** (-5) # bar^(-1) #isothermal compressibility of water + change = False + if np.mod(step, config.n_b) == 0: + change = True + + # compute pressure + pressure = comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=comm, + ) + + # Total pressure across all ranks + # L: Lateral; N: Normal + [PL, PN] = [0, 0] + PL = (pressure[-3] + pressure[-2]) / 2 # kJ/(mol nm^3) + PN = pressure[-1] # kJ/(mol nm^3) + PL = PL * 16.61 # bar + PN = PN * 16.61 # bar + alphaL = 1.0 + alphaN = 1.0 + + if config.target_pressure.P_L: + # scaling factor + alphaL = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_L - PL) + ) ** (1 / 3) + # length scaling + config.box_size[0:2] *= alphaL + + positions[:][0:2] *= alphaL + + if config.target_pressure.P_N: + # scaling factor + alphaN = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_N - PN) + ) ** (1 / 3) + # length scaling + config.box_size[2] *= alphaN + + positions[:][2] *= alphaN + + # pmesh re-initialize + pm_stuff = initialize_pm(pmesh, config, comm) + return (pm_stuff, change)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/_modules/hymd/field.html b/v2.0.1/_modules/hymd/field.html new file mode 100644 index 00000000..73f5b2ee --- /dev/null +++ b/v2.0.1/_modules/hymd/field.html @@ -0,0 +1,1468 @@ + + + + + + hymd.field — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.field

+"""Forces and energies from the discretized particle-field grid interactions
+"""
+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import warnings
+
+
+
[docs]def initialize_pm(pmesh, config, comm=MPI.COMM_WORLD): + """ + Creates the necessary pmesh objects for pfft operations. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + config : Config + Configuration dataclass containing simulation metadata and parameters. + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm : object 'pmesh.pm.ParticleMesh' + field_list : list[pmesh.pm.RealField], (multiple) + Essential list of pmesh objects required for MD + list_coulomb : list[pmesh.pm.RealField], (multiple) + Additional list of pmesh objects required for electrostatics. + """ + + if config.dtype == np.float64: + pmeshtype = "f8" + else: + pmeshtype = "f4" + # Ignore numpy numpy.VisibleDeprecationWarning: Creating an ndarray from + # ragged nested sequences until it is fixed in pmesh + with warnings.catch_warnings(): + warnings.filterwarnings( + action="ignore", + category=np.VisibleDeprecationWarning, + message=r"Creating an ndarray from ragged nested sequences", + ) + # The first argument of ParticleMesh has to be a tuple + pm = pmesh.ParticleMesh( + config.mesh_size, BoxSize=config.box_size, dtype=pmeshtype, comm=comm + ) + phi = [pm.create("real", value=0.0) for _ in range(config.n_types)] + phi_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] # noqa: E501 + force_on_grid = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + v_ext_fourier = [pm.create("complex", value=0.0) for _ in range(4)] + v_ext = [pm.create("real", value=0.0) for _ in range(config.n_types)] + + phi_transfer = [pm.create("complex", value=0.0) for _ in range(3)] + + phi_laplacian = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + + # Initialize charge density fields + coulomb_list = [] + elec_common_list = [None, None, None, None] + _SPACE_DIM = config.box_size.size + + if config.coulombtype == "PIC_Spectral_GPE" or config.coulombtype == "PIC_Spectral": + phi_q = pm.create("real", value=0.0) + phi_q_fourier = pm.create("complex", value=0.0) + psi = pm.create("real", value=0.0) + elec_field = [pm.create("real", value=0.0) for _ in range(_SPACE_DIM)] + + elec_common_list = [phi_q, phi_q_fourier, psi, elec_field] + + if config.coulombtype == "PIC_Spectral": + elec_field_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] # for force calculation + psi_fourier = pm.create("complex", value=0.0) + + coulomb_list = [ + elec_field_fourier, + psi_fourier, + ] + + if ( + config.coulombtype == "PIC_Spectral_GPE" + ): ## initializing the density mesh #dielectric_flag + phi_eps = pm.create( + "real", value=0.0 + ) ## real contrib of the epsilon dielectric painted to grid + phi_eps_fourier = pm.create("complex", value=0.0) # complex contrib of phi eps + phi_eta = [ + pm.create("real", value=0.0) for _ in range(_SPACE_DIM) + ] ## real contrib of factor in polarization charge density + phi_eta_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] ## fourier of factor in polarization charge density + phi_pol = pm.create( + "real", value=0.0 + ) ## real contrib of the polarization charge + phi_pol_prev = pm.create("real", value=0.0) + elec_dot = pm.create("real", value=0.0) + elec_field_contrib = pm.create( + "real", value=0.0 + ) # needed for pol energies later + + # External potential and force meshes + Vbar_elec = [pm.create("real", value=0.0) for _ in range(config.n_types)] + Vbar_elec_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] + force_mesh_elec = [ + [pm.create("real", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + force_mesh_elec_fourier = [ + [pm.create("complex", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + + coulomb_list = [ + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol, + phi_pol_prev, + elec_dot, + elec_field_contrib, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + ] + + field_list = [ + phi, + phi_fourier, + force_on_grid, + v_ext_fourier, + v_ext, + phi_transfer, + phi_laplacian, + ] + + return (pm, field_list, elec_common_list, coulomb_list)
+ + +
[docs]def compute_field_force(layouts, r, force_mesh, force, types, n_types): + """Interpolate particle-field forces from the grid onto particle positions + + Backmaps the forces calculated on the grid to particle positions using the + window function :math:`P` (by default cloud-in-cell [CIC]). In the + following, let :math:`\\mathbf{F}_j` denote the force acting on the + particle with index :math:`j` and position :math:`\\mathbf{r}_j`. The + interpolated force is + + .. math:: + + \\mathbf{F}_j = -\\sum_k\\nabla V_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`V_{j_k}` is the discretized external potential at grid vertex + :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid vertex + with index :math:`j_k`, and :math:`h^3` is the volume of each grid voxel. + The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + r : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + force : (N,D) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. Local + for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + n_types : int + Number of different unique types present in the simulation system. + :code:`n_types` is global, i.e. the same for all MPI ranks even if some + ranks contain zero particles of certain types. + """ + for t in range(n_types): + ind = types == t + for d in range(3): + force[ind, d] = force_mesh[t][d].readout(r[ind], layout=layouts[t])
+ + +
[docs]def compute_self_energy_q(config, charges, comm=MPI.COMM_WORLD): + """Compute the self energy for the interaction due to the Ewald scheme + used to compute the electrostatics. The energy is stored in :code:`config`. + + The self interaction energy is given by: + + .. math:: + + U_{self} = \\sqrt{\\frac{1}{2\\pi\\sigma^2}} \\sum_{i=1}^{N} q_i^2 + + where :math:`q_i` are the charges and :math:`\\sigma` is the half-width + of the Gaussian filter. + + Parameters + ---------- + config : Config + Configuration object. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + comm : mpi4py.Comm + MPI communicator to use for rank communication. + + Returns + ------- + field_q_self_energy : float + Electrostatic self energy. + """ + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + prefac = elec_conversion_factor * np.sqrt( + 1.0 / (2.0 * np.pi * config.sigma * config.sigma) + ) + _squared_charges = charges * charges + squared_charges_sum = comm.allreduce(np.sum(_squared_charges)) + return prefac * squared_charges_sum
+ + +
[docs]def update_field_force_q( + charges, + phi_q, + phi_q_fourier, + psi, + psi_fourier, + elec_field_fourier, + elec_field, + elec_forces, + layout_q, + hamiltonian, + pm, + positions, + config, +): + """Calculate the electrostatic particle-field forces on the grid + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential is computed in reciprocal space as + + .. math:: + + \\Phi = \\mathrm{FFT}^{-1}\\left[ + \\frac{4\\pi k_e}{\\varepsilon \\vert\\mathbf{k}\\vert^2} + \\mathrm{FFT}(\\rho)\\mathrm{FFT}(H) + \\right], + + with the electric field + + .. math:: + + \\mathbf{E} = \\mathrm{FFT}^{-1}\\left[ + -i\\mathbf{k}\\,\\mathrm{FFT}(\\Psi) + \\right]. + + In the following, let :math:`\\mathbf{F}_j` denote the electrostatic force + acting on the particle with index :math:`j` and position + :math:`\\mathbf{r}_j`. The interpolated electrostatic force is + + .. math:: + + \\mathbf{F}_j = \\sum_k q_j\\mathbf{E}_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`\\mathbf{E}_{j_k}` is the discretized electric field at grid + vertex :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid + vertex with index :math:`j_k`, and :math:`h^3` is the volume of each grid + voxel. The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty; any values in this field + are discarded. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + elec_field_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + electric field values in reciprocal space on the computational grid. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + n_dimensions = config.box_size.size + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + # charges to grid + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) + phi_q /= volume_per_cell + # print("phi_q", np.sum(phi_q)) + phi_q.r2c(out=phi_q_fourier) + + # smear charges with filter + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + + # solve Poisson equation in Fourier space to get electrostatic potential + def poisson_transfer_function(k, v): + return 4.0 * np.pi * elec_conversion_factor * v / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(poisson_transfer_function, out=psi_fourier) + # print("psi_fourier", np.sum(psi_fourier)) + psi_fourier.c2r(out=psi) + # print("phi_q * psi update_field", np.sum(phi_q * psi)) + + # exit() + + # compute electric field directly from smeared charged densities in Fourier + for _d in np.arange(n_dimensions): + + def poisson_transfer_function(k, v, d=_d): + return ( + -1j + * k[d] + * 4.0 + * np.pi + * elec_conversion_factor + * v + / k.normp(p=2, zeromode=1) + ) + + phi_q_fourier.apply(poisson_transfer_function, out=elec_field_fourier[_d]) + elec_field_fourier[_d].c2r(out=elec_field[_d]) + + # get electrostatic force from electric field + for _d in np.arange(n_dimensions): + elec_forces[:, _d] = charges * ( + elec_field[_d].readout(positions, layout=layout_q) + )
+ + +def comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, +): + for t in range(config.n_types): + np.copyto(phi_transfer[0].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[1].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[2].value, phi_fourier[t].value, casting="no", where=True) + + # Evaluate laplacian of phi in fourier space + for d in range(3): + + def laplacian_transfer(k, v, d=d): + return -k[d] ** 2 * v + + phi_transfer[d].apply(laplacian_transfer, out=Ellipsis) + phi_transfer[d].c2r(out=phi_laplacian[t][d]) + + +
[docs]def update_field( + phi, + phi_laplacian, + phi_transfer, + layouts, + force_mesh, + hamiltonian, + pm, + positions, + types, + config, + v_ext, + phi_fourier, + v_ext_fourier, + m, + compute_potential=False, +): + """Calculate the particle-field potential and force density + + If :code:`compute_potential` is :code:`True`, the energy may subsequently + be computed by calling :code:`compute_field_and_kinetic_energy`. + + Computes the particle-field external potential :math:`V_\\text{ext}` from + particle number densities through the smoothed density field, + :math:`\\phi(\\mathbf{r})`. With :math:`P` being the cloud-in-cell (CIC) + window function, the density and filtered densities are computed as + + .. math:: + + \\phi(\\mathbf{r}) = \\sum_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\phi(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\phi(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + external potential is computed in reciprocal space as + + .. math:: + + V_\\text{ext} = \\mathrm{FFT}^{-1}\\left[ + \\mathrm{FFT} + \\left( + \\frac{\\partial w}{\\partial \\tilde\\phi} + \\right) + \\mathrm{FFT}(H) + \\right], + + where :math:`w` is the interaction energy functional. Differentiating + :math:`V_\\text{ext}` is done by simply applying :math:`i\\mathbf{k}` in + Fourier space, and the resulting forces are back-transformed to direct + space and interpolated to particle positions by + + .. math:: + + \\mathbf{F}_j = -\\sum_{j_k} \\nabla V_{j_k} + P(\\mathbf{r}_{j_k} - \\mathbf{r}_j)h^3, + + where :math:`j_k` are the neighbouring vertices of particle :math:`j` at + position :math:`\\mathbf{r}_j`, and :math:`h^3` is the volume of each grid + voxel. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Pre-allocated, but empty; any values + in this field are discarded. Changed in-place. Local for each MPI + rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + config : Config + Configuration object. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Pre-allocated, but empty; any values in this field are + discarded Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + phi_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computational grid is represented by the collective fields of all + MPI ranks. + v_ext_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplesField` objects containing discretized + particle-field external potential values in reciprocal space on the + computational grid; :code:`D+1` fields in D dimensions for each + particle type. :code:`D` copies are made after calculation for later + use in force calculation, because the `force transfer function` + application differentiates the field in-place, ruining the contents + for differentiation in the remaining :code:`D-1` spatial directions. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + m: list[float], (M,) + pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. + Defaults to 1.0 for all particle types. + compute_potential : bool, optional + If :code:`True`, a :code:`D+1`-th copy of the Fourier transformed + external potential field is made to be used later in particle-field + energy calculation. If :code:`False`, only :code:`D` copies are made. + + See also + -------- + compute_field_and_kinetic_energy : + Compute the particle-field energy after the external potential is + calculated. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + for t in range(config.n_types): + pm.paint(positions[types == t], mass=m[t], layout=layouts[t], out=phi[t]) + phi[t] /= volume_per_cell + phi[t].r2c(out=phi_fourier[t]) + phi_fourier[t].apply(hamiltonian.H, out=Ellipsis) + phi_fourier[t].c2r(out=phi[t]) + + # External potential + for t in range(config.n_types): + v = hamiltonian.v_ext[t](phi) + + v.r2c(out=v_ext_fourier[0]) + v_ext_fourier[0].apply(hamiltonian.H, out=Ellipsis) + np.copyto( + v_ext_fourier[1].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + np.copyto( + v_ext_fourier[2].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + if compute_potential: + np.copyto( + v_ext_fourier[3].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + + # Differentiate the external potential in fourier space + for d in range(3): + + def force_transfer_function(k, v, d=d): + return -k[d] * 1j * v + + v_ext_fourier[d].apply(force_transfer_function, out=Ellipsis) + v_ext_fourier[d].c2r(out=force_mesh[t][d]) + + if compute_potential: + v_ext_fourier[3].c2r(out=v_ext[t])
+ + +
[docs]def compute_field_and_kinetic_energy( + phi, + phi_q, + psi, + velocity, + hamiltonian, + positions, + types, + v_ext, + config, + layouts, + comm=MPI.COMM_WORLD, +): + """Compute the particle-field and kinetic energy contributions + + Calculates the kinetic energy through + + .. math:: + + E_k = \\sum_j \\frac{1}{2}m_j\\mathbf{v}_j\\cdot\\mathbf{v}_j, + + and the particle-field energy by + + .. math:: + + E_\\text{field} = \\int\\mathrm{d}\\mathbf{r}\\, + w[\\tilde\\phi], + + where :math:`w` is the interaction energy functional `density`. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + velocity : (N,D) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Local for each MPI rank--the full computational grid is + represented by the collective fields of all MPI ranks. + config : Config + Configuration object. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field : + Computes the up-to-date external potential for use in calculating the + particle-field energy. + """ + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + field_energy = w_0.csum() # w to W + + kinetic_energy = comm.allreduce(0.5 * config.mass * np.sum(velocity**2)) + + if config.coulombtype == "PIC_Spectral": + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + field_q_energy = w_elec.csum() + else: + field_q_energy = 0.0 + + return field_energy, kinetic_energy, field_q_energy
+ + +
[docs]def compute_field_energy_q_GPE( + config, + phi_eps, + field_q_energy, + dot_elec, + comm=MPI.COMM_WORLD, +): + """ + Compute the electrostatic energy after electrosatic forces is + calculated. + + From the definition of the elecrostatic potential :math:`\\Psi`, the energy + is + + W = \\frac{1}{2}\\int\\mathrm{d}\\mathbf{r}\\, + \\epsilon(\\mathbf{r})} \\left(\\mathbf{E}\\cdot \\mathbf{E}\\right), + + where :math:`\\epsilon(\\mathbf{r})}` is the anisotropic, spatially dependent, + relative dielectric of the simulation medium. + + Parameters + ---------- + config : hymd.input_parser.Config + Configuration object. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + field_q_energy : float + Total elecrostatic energy. + dot_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing :math:`|\\mathbf{E(r)}|^{2}` + on the computational grid. Local for each MPI rank -- the full computational + grid is represented by the collective fields of all MPI ranks. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field_force_q_GPE: + Compute the electrosatic force from an anisotropic dielectric general + Poisson equation. + """ + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + # ^ due to integration on local cell before allreduce + + eps_0 = 1.0 / (config.coulomb_constant * 4 * np.pi) + field_q_energy = ( + volume_per_cell * (0.5 * eps_0) * comm.allreduce(np.sum(phi_eps * dot_elec)) + ) + + return field_q_energy
+ + +
[docs]def update_field_force_q_GPE( + conv_fun, + phi, + types, + charges, + phi_q, + phi_q_fourier, + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol_prev, + phi_pol, + elec_field, + elec_forces, + elec_field_contrib, + psi, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + hamiltonian, + layout_q, + layouts, + pm, + positions, + config, + comm=MPI.COMM_WORLD, +): + """ + Calculate the electrostatic particle-field forces on the grid, arising from + a general Poisson equation, i.e. anisotropic permittivity/dielectric. + The function is called when tomli input config.coulombtype = "PIC_Spectral_GPE." + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential for a variable dielectric does not have an + analytical expression, and is computed in reciprocal through an iterative + method. + + The GPE states that + + .. math:: + + \\nabla \\cdot \\left(\\epsilon(\\mathbf{r}) + \\nabla{\\mathbf{\\psi(r)}}\\right) = -\\rho({\\mathbf{r}}). + + where :math:`\\epsilon(\\mathbf{r})` is the relative dielectric function. + + Parameters + ---------- + conv_fun : Convergence function. + Returns a scalar. Depends on MPI allreduce for similar convergence + across MPI ranks. + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_eta : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + gradients of the relative dielectric values on the computational grid. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank--the + full computational grid is represented by the collective fields of all MPI ranks. + phi_eta_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated discretized + Fourier transformed gradient relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol_prev : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charge values on the computational grid. Parameter in + the iterative method.Pre-allocated,but empty. Changedin-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charges on the computational grid. Parameter in the iterative + method, updating the next quess in solving for the electrostatic potential. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all + MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + elec_field_contrib : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing + :math:`|\\mathbf{E(r)}|^2/\\phi_{0}` on the computational grid. + Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + psi : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic potential + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + Vbar_elec : mesh.pm.RealField + Pmesh :code:`RealField` object for storing functional derivatives of + :math:`\\|w(\\{ \\phi \\})_{elec}`on the computational grid. + Pre-allocated, but empty. Changed in-place. Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + Vbar_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated functional + derivatives of :math:`\\|w(\\{ \\phi \\})_{elec}` in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + force_mesh_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic force values + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + force_mesh_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated electrostatic + force values in reciprocal space on the computational grid. Local for + each MPI rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + layouts: list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + comm: mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + compute_field_energy_q_GPE: + Compute the electrostatic energy after electrosatic force is + calculated for a variable (anisotropic) dielectric general Poisson equation. + """ + + ## basic setup + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + ## old protocol in gen_qe_hpf_use_self + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) ## + ## scale and fft + ## old protocol in gen_qe_hpf_use_self + phi_q /= volume_per_cell + phi_q.r2c(out=phi_q_fourier) + + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + ## ^------ use the same gaussian as the \kai interaciton + phi_q_fourier.c2r(out=phi_q) ## this phi_q is after applying the smearing function + + denom_phi_tot = pm.create("real", value=0.0) + num_types = pm.create("real", value=0.0) + ### ^ ----- Calculate the relative dielectric (permittivity) to field + ### ------- from a mean contribution of particle number densities + + for t_ in range(config.n_types): + num_types = num_types + (config.dielectric_type[t_]) * phi[t_] + denom_phi_tot = denom_phi_tot + phi[t_] + + np.divide(num_types, denom_phi_tot, where=np.abs(denom_phi_tot > 1e-6), out=phi_eps) + + phi_eps.r2c(out=phi_eps_fourier) # FFT dielectric + + # phi_q_eps = (phi_q/phi_eps) + np.divide(phi_q, phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_q) + + _SPACE_DIM = 3 + ##^--------- constants needed throughout the calculations + + ### method for finding the gradient (fourier space), using the spatial dimension of k + for _d in np.arange(_SPACE_DIM): + + def gradient_transfer_function(k, x, d=_d): + return 1j * k[d] * x + + phi_eps_fourier.apply(gradient_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=phi_eta[_d]) + np.divide(phi_eta[_d], phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_eta[_d]) + + ### iterative GPE solver ### + ### ---------------------------------------------- + max_iter = 100 + i = 0 + delta = 1.0 + # phi_pol_prev = pm.create("real", value = 0.0) + ### ^------ set to zero before each iterative procedure or soft start + conv_criteria = config.conv_crit # conv. criteria (default 1e-6) + w = config.pol_mixing # polarization mixing param (default 0.6) + while i < max_iter and delta > conv_criteria: + (phi_q + phi_pol_prev).r2c(out=phi_q_fourier) + for _d in np.arange(_SPACE_DIM): + + def iterate_apply_k_vec(k, additive_terms, d=_d): + return additive_terms * (-1j * k[d]) / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(iterate_apply_k_vec, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + + phi_pol = -( + phi_eta[0] * elec_field[0] + + phi_eta[1] * elec_field[1] + + phi_eta[2] * elec_field[2] + ) + ### ^-- Following a negative sign convention (-ik) of the FT, a neg sign is + ### --- mathematically correct by the definition of the GPE (double - -> +) + phi_pol = w * phi_pol + (1.0 - w) * phi_pol_prev + diff = np.abs(phi_pol - phi_pol_prev) + delta = conv_fun(comm, diff) # decided from toml input + phi_pol_prev = phi_pol.copy() + i = i + 1 + # print("Stopping after iteration {:d} with stop crit {:.2e}, delta {:.2e}".format(i,conv_criteria,delta)) + + # compute_potential = True + def k_norm_divide(k, potential): + return potential / k.normp(p=2, zeromode=1) + + ## > Electrostatic potential + eps0_inv = config.coulomb_constant * 4 * np.pi + ## ^ the 1/(4pi eps0)*4*pi = 1/eps0 + ((eps0_inv) * (phi_q + phi_pol)).r2c(out=phi_q_fourier) + phi_q_fourier.apply(k_norm_divide, out=phi_q_fourier) + phi_q_fourier.c2r(out=psi) + ### ^ electrostatic potential for the GPE + + for _d in np.arange(_SPACE_DIM): + + def field_transfer_function(k, x, d=_d): + return ( + -1j * k[d] * x + ) ## negative sign relation, due to E = - nabla psi relation + + phi_q_fourier.apply(field_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + ## ^-------- Method: Obtaining the electric field from electrostatic potential + ## Assuming the electric field is conserved. + ## Assumption holds if no magnetic flux (magnetic induced fields) + + ############## Obtain forces ############## + elec_dot = ( + elec_field[0] * elec_field[0] + + elec_field[1] * elec_field[1] + + elec_field[2] * elec_field[2] + ) + # needed for energy calculations + + np.divide( + elec_dot, + denom_phi_tot, + where=np.abs(denom_phi_tot > 1e-6), + out=elec_field_contrib, + ) + + eps0_inv = config.coulomb_constant * 4 * np.pi + + for t_ in range(config.n_types): + Vbar_elec[t_] = ( + config.type_charges[t_] * psi + - (0.5 / eps0_inv) + * (config.dielectric_type[t_] - phi_eps) + * elec_field_contrib + ) + + # Obtain Vext,k + for t_ in range(config.n_types): + Vbar_elec[t_].r2c(out=Vbar_elec_fourier[t_]) + Vbar_elec_fourier[t_].apply(hamiltonian.H, out=Vbar_elec_fourier[t_]) + + # force terms + # F = - grad Vext + for t_ in range(config.n_types): + for _d in np.arange(_SPACE_DIM): + + def force_transfer_function(k, x, d=_d): + return -1j * k[_d] * x ## negative gradient + + Vbar_elec_fourier[t_].apply( + force_transfer_function, out=force_mesh_elec_fourier[t_][_d] + ) + force_mesh_elec_fourier[t_][_d].c2r(out=force_mesh_elec[t_][_d]) + elec_forces[types == t_, _d] = force_mesh_elec[t_][_d].readout( + positions[types == t_], layout=layouts[t_] + ) + + return Vbar_elec, phi_eps, elec_dot
+ + +
[docs]def domain_decomposition( + positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=MPI.COMM_WORLD +): + """Performs domain decomposition + + Rearranges the MPI rank memory layout into one that better mimics the PFFT + pencil grid 2D decomposition. As molecules are always required to be fully + contained on a single MPI rank, a perfect decomposition is not always + possible. The best decomposition which leaves the center of mass of all + molecules in their respective correct domains is used, with possible + overlap into neighbouring domains if the spatial extent of any molecule + crosses domain boundaries. + + Parameters + ---------- + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + *args + Variable length argument list containing arrays to include in the + domain decomposition. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + bonds : (N,M) numpy.ndarray, optional + Array of :code:`M` bonds originating from each of :code:`N` particles. + verbose : int, optional + Specify the logging event verbosity of this function. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + Domain decomposed :code:`positions` and any array specified in + :code:`*args`, in addition to :code:`bonds` and :code:`molecules` if these + arrays were provided as input. + """ + if molecules is not None: + if not topol: + assert bonds is not None, "bonds must be provided with molecules" + unique_molecules = np.sort(np.unique(molecules)) + molecules_com = np.empty_like(positions) + for m in unique_molecules: + ind = molecules == m + r = positions[ind, :][0, :] + molecules_com[ind, :] = r + layout = pm.decompose(molecules_com, smoothing=0) + if not topol: + args = (*args, bonds, molecules) + else: + args = (*args, molecules) + else: + layout = pm.decompose(positions, smoothing=0) + if verbose > 1: + Logger.rank0.log( + logging.INFO, + "DOMAIN_DECOMP: Total number of particles to be exchanged = %d", + np.sum(layout.get_exchange_cost()), + ) + return layout.exchange(positions, *args)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/_modules/hymd/file_io.html b/v2.0.1/_modules/hymd/file_io.html new file mode 100644 index 00000000..739c9ba6 --- /dev/null +++ b/v2.0.1/_modules/hymd/file_io.html @@ -0,0 +1,1164 @@ + + + + + + hymd.file_io — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.file_io

+"""Handle file input/output in parllel HDF5 fashion
+"""
+import numpy as np
+import h5py
+import os
+import logging
+import getpass
+from mpi4py import MPI
+from .logger import Logger, get_version
+
+
+
[docs]class OutDataset: + """HDF5 dataset handler for file output""" + + def __init__( + self, + dest_directory, + config, + double_out=False, + disable_mpio=False, + comm=MPI.COMM_WORLD, + ): + """Constructor + + Parameters + ---------- + dest_directory : str + Ouput directory for saving data. + config : Config + Configuration object. + double_out : bool, optional + If :code:`True`, the output HDF5 objects are written in eight byte + floating point representation. Otherwise, four byte single + precision is used. + disable_mpio : bool, optional + If :code:`True`, disables parallel MPI-enabled HDF5 file output. + This is a compatibility option used if HDF5 is not compiled with + MPI support. This makes everything much harder by splitting all + output in one file per MPI rank, and having an MPI-enabled HDF5 + library is **highly recommended**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + """ + self.disable_mpio = disable_mpio + self.config = config + if double_out: + self.float_dtype = "float64" + else: + self.float_dtype = "float32" + + if disable_mpio: + self.file = h5py.File( + os.path.join( + dest_directory, f"sim.hdf5-{comm.rank:6d}-of-{comm.size:6d}" + ), + "w", + ) + else: + self.file = h5py.File( + os.path.join(dest_directory, "sim.H5"), "w", driver="mpio", comm=comm + ) + +
[docs] def is_open(self, comm=MPI.COMM_WORLD): + """Check if HDF5 output file is open + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + return self.file.__bool__()
+ +
[docs] def close_file(self, comm=MPI.COMM_WORLD): + """Closes the HDF5 output file + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + self.file.close()
+ +
[docs] def flush(self): + """Flushes output buffers, forcing file writes""" + self.file.flush()
+ + +
[docs]def setup_time_dependent_element( + name, parent_group, n_frames, shape, dtype, units=None +): + """Helper function for setting up time-dependent HDF5 group datasets + + All output groups must adhere to the H5MD standard, meaning a structure of + + + | ┗━ **group** particle group (e.g. :code:`all`) or :code:`observables` group + | ┗━ **group** time-dependent data + | ┣━ **dataset** :code:`step` :code:`shape=(n_frames,)` + | ┣━ **dataset** :code:`time` :code:`shape=(n_frames,)` + | ┗━ **dataset** :code:`value` :code:`shape=(n_frames, *)` + + is necessary. + + References + ---------- + H5MD specification : + https://www.nongnu.org/h5md/h5md.html + """ # noqa: E501 + group = parent_group.create_group(name) + step = group.create_dataset("step", (n_frames,), "int32") + time = group.create_dataset("time", (n_frames,), "float32") + value = group.create_dataset("value", (n_frames, *shape), dtype) + + if units is not None: + value.attrs["unit"] = units + time.attrs["unit"] = "ps" + return group, step, time, value
+ + +
[docs]def store_static( + h5md, + rank_range, + names, + types, + indices, + config, + bonds_2_atom1, + bonds_2_atom2, + molecules=None, + velocity_out=False, + force_out=False, + charges=False, + dielectrics=False, + plumed_out=False, + comm=MPI.COMM_WORLD, +): + """Outputs all static time-independent quantities to the HDF5 output file + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + rank_range : list[int] + Start and end indices for global arrays for each MPI rank. + names : (N,) numpy.ndarray + Array of names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of type indices for :code:`N` particles. + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + config : Config + Configuration object. + bonds_2_atom1 : (B,) numpy.ndarray + Array of indices of the first particle for :code:`B` total + two-particle bonds. + bonds_2_atom2 : (B,) numpy.ndarray + Array of indices of the second particle for :code:`B` total + two-particle bonds. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. + dielectrics : (N,) numpy.ndarray + Array of particle relative dielectric values for :code:`N` particles. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to output HDF5 file. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + prepare_bonds : + Constructs two-, three-, and four-particle bonds from toplogy input + file and bond configuration information. + distribute_input : + Distributes input arrays onto MPI ranks, attempting load balancing. + """ + dtype = h5md.float_dtype + + h5md_group = h5md.file.create_group("/h5md") + h5md.h5md_group = h5md_group + h5md.observables = h5md.file.create_group("/observables") + h5md.connectivity = h5md.file.create_group("/connectivity") + h5md.parameters = h5md.file.create_group("/parameters") + + h5md_group.attrs["version"] = np.array([1, 1], dtype=int) + author_group = h5md_group.create_group("author") + author_group.attrs["name"] = np.string_(getpass.getuser()) + creator_group = h5md_group.create_group("creator") + creator_group.attrs["name"] = np.string_("Hylleraas MD") + + # Get HyMD version + creator_group.attrs["version"] = np.string_(get_version()) + + h5md.particles_group = h5md.file.create_group("/particles") + h5md.all_particles = h5md.particles_group.create_group("all") + mass = h5md.all_particles.create_dataset("mass", (config.n_particles,), dtype) + mass[...] = config.mass + + if charges is not False: + charge = h5md.all_particles.create_dataset( + "charge", (config.n_particles,), dtype="float32" + ) + charge[indices] = charges + if dielectrics is not False: + dielectric = h5md.all_particles.create_dataset( + "dielectric", (config.n_particles,), dtype="float32" + ) + dielectric[indices] = dielectrics + + box = h5md.all_particles.create_group("box") + box.attrs["dimension"] = 3 + box.attrs["boundary"] = np.array( + [np.string_(s) for s in 3 * ["periodic"]], dtype="S8" + ) + + n_frames = config.n_steps // config.n_print + if np.mod(config.n_steps - 1, config.n_print) != 0: + n_frames += 1 + if np.mod(config.n_steps, config.n_print) == 1: + n_frames += 1 + if n_frames == config.n_steps: + n_frames += 1 + + species = h5md.all_particles.create_dataset( + "species", + (config.n_particles,), + dtype="i", + ) + + ( + _, + h5md.positions_step, + h5md.positions_time, + h5md.positions, + ) = setup_time_dependent_element( + "position", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm", + ) + if velocity_out: + ( + _, + h5md.velocities_step, + h5md.velocities_time, + h5md.velocities, + ) = setup_time_dependent_element( + "velocity", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm ps-1", + ) + if force_out: + ( + _, + h5md.forces_step, + h5md.forces_time, + h5md.forces, + ) = setup_time_dependent_element( + "force", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="kJ mol-1 nm-1", + ) + ( + _, + h5md.total_energy_step, + h5md.total_energy_time, + h5md.total_energy, + ) = setup_time_dependent_element( + "total_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.kinetc_energy_step, + h5md.kinetc_energy_time, + h5md.kinetc_energy, + ) = setup_time_dependent_element( + "kinetic_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.potential_energy_step, + h5md.potential_energy_time, + h5md.potential_energy, + ) = setup_time_dependent_element( + "potential_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.bond_energy_step, + h5md.bond_energy_time, + h5md.bond_energy, + ) = setup_time_dependent_element( + "bond_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.angle_energy_step, + h5md.angle_energy_time, + h5md.angle_energy, + ) = setup_time_dependent_element( + "angle_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.dihedral_energy_step, + h5md.dihedral_energy_time, + h5md.dihedral_energy, + ) = setup_time_dependent_element( + "dihedral_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.field_energy_step, + h5md.field_energy_time, + h5md.field_energy, + ) = setup_time_dependent_element( + "field_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + if charges is not False: + ( + _, + h5md.field_q_energy_step, + h5md.field_q_energy_time, + h5md.field_q_energy, + ) = setup_time_dependent_element( + "field_q_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) # <-------- xinmeng + if plumed_out is not False: + ( + _, + h5md.plumed_bias_step, + h5md.plumed_bias_time, + h5md.plumed_bias, + ) = setup_time_dependent_element( + "plumed_bias", h5md.observables, n_frames, (1,), dtype, units="kJ mol-1" # noqa: E501 + ) + ( + _, + h5md.total_momentum_step, + h5md.total_momentum_time, + h5md.total_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "total_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm g ps-1 mol-1", + ) + ( + _, + h5md.angular_momentum_step, + h5md.angular_momentum_time, + h5md.angular_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "angular_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm+2 g ps-1 mol-1", + ) + ( + _, + h5md.torque_step, + h5md.torque_time, + h5md.torque, + ) = setup_time_dependent_element( # noqa: E501 + "torque", + h5md.observables, + n_frames, + (3,), + dtype, + units="kJ nm+2 mol-1", + ) + ( + _, + h5md.temperature_step, + h5md.temperature_time, + h5md.temperature, + ) = setup_time_dependent_element( + "temperature", h5md.observables, n_frames, (3,), dtype, units="K" + ) + ( + _, + h5md.thermostat_work_step, + h5md.thermostat_work_time, + h5md.thermostat_work, + ) = setup_time_dependent_element( + "thermostat_work", + h5md.observables, + n_frames, + (1,), + "float32", + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.pressure_step, + h5md.pressure_time, + h5md.pressure, + ) = setup_time_dependent_element( + "pressure", h5md.observables, n_frames, (18,), "float32", units="Bar" + ) + (_, h5md.box_step, h5md.box_time, h5md.box_value,) = setup_time_dependent_element( + "edges", box, n_frames, (3, 3), "float32", units="nm" + ) + + ind_sort = np.argsort(indices) + for i in ind_sort: + species[indices[i]] = config.name_to_type_map[names[i].decode("utf-8")] + + h5md.parameters.attrs["config.toml"] = np.string_(str(config)) + vmd_group = h5md.parameters.create_group("vmd_structure") + index_of_species = vmd_group.create_dataset( + "indexOfSpecies", (config.n_types,), "i" + ) + index_of_species[:] = np.array(list(range(config.n_types))) + + # VMD-h5mdplugin maximum name/type name length is 16 characters (for + # whatever reason [VMD internals?]). + name_dataset = vmd_group.create_dataset("name", (config.n_types,), "S16") + type_dataset = vmd_group.create_dataset("type", (config.n_types,), "S16") + if molecules is not None: + resid_dataset = vmd_group.create_dataset( + "resid", + (config.n_particles,), + "i", + ) + + # Change this + for i, n in config.type_to_name_map.items(): + name_dataset[i] = np.string_(n[:16]) + if n == "W": + type_dataset[i] = np.string_("solvent") + else: + type_dataset[i] = np.string_("membrane") + + total_bonds = comm.allreduce(len(bonds_2_atom1), MPI.SUM) + n_bonds_local = len(bonds_2_atom1) + + receive_buffer = comm.gather(n_bonds_local, root=0) + n_bonds_global = None + if comm.Get_rank() == 0: + n_bonds_global = receive_buffer + n_bonds_global = np.array(comm.bcast(n_bonds_global, root=0)) + rank_bond_start = np.sum(n_bonds_global[: comm.Get_rank()]) + + bonds_from = vmd_group.create_dataset("bond_from", (total_bonds,), "i") + bonds_to = vmd_group.create_dataset("bond_to", (total_bonds,), "i") + for i in range(n_bonds_local): + a = bonds_2_atom1[i] + b = bonds_2_atom2[i] + bonds_from[rank_bond_start + i] = indices[a] + 1 + bonds_to[rank_bond_start + i] = indices[b] + 1 + + if molecules is not None: + resid_dataset[indices[ind_sort]] = molecules
+ + +# store data old vs +""" +h5md, step, frame, indices, positions, velocities, forces, box_size, +temperature, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, +field_energy, field_q_energy, time_step, config, velocity_out=False, +force_out=False, charge_out=False, dump_per_particle=False, +""" + + +
[docs]def store_data( + h5md, + step, + frame, + indices, + positions, + velocities, + forces, + box_size, + temperature, + pressure, + kinetic_energy, + bond2_energy, + bond3_energy, + bond4_energy, + field_energy, + field_q_energy, + plumed_bias, + time_step, + config, + velocity_out=False, + force_out=False, + charge_out=False, + plumed_out=False, + dump_per_particle=False, + comm=MPI.COMM_WORLD, +): + """Writes time-step data to HDF5 output file + + Handles all quantities which change during simulation, as opposed to + static quanitities (see :code:`store_static`). + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + step : int + Step number. + frame : int + Output frame number (:code:`step // n_print`). + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + positions : (N,) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + velocities : (N,) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + forces : (N,) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. + box_size : (D,) numpy.ndarray + Array containing the simulation box size. + temperature : float + Calculated instantaneous temperature. + kinetic_energy : float + Calculated instantaneous kinetic energy. + bond2_energy : float + Calculated instantaneous harmonic two-particle bond energy. + bond3_energy : float + Calculated instantaneous harmonic angular three-particle bond energy. + bond4_energy : float + Calculated instantaneous dihedral four-particle torsion energy. + field_energy : float + Calculated instantaneous particle-field energy. + field_q_energy : float + Calculated instantaneous electrostatic energy. + plumed_bias : float + PLUMED instantaneous bias energy. + time_step : float + Value of the time step. + config : Config + Configuration object. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charge_out : bool, optional + If :code:`True`, electrostatic energies are written to the output + HDF5 file. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to the output HDF5 file. + dump_per_particle : bool, optional + If :code:`True`, all quantities are written **per particle**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + store_static : + Outputs all static time-independent quantities to the HDF5 output file + """ + for dset in ( + h5md.positions_step, + h5md.total_energy_step, + h5md.potential_energy_step, + h5md.kinetc_energy_step, + h5md.bond_energy_step, + h5md.angle_energy_step, + h5md.dihedral_energy_step, + h5md.field_energy_step, + h5md.total_momentum_step, + h5md.angular_momentum_step, + h5md.torque_step, + h5md.temperature_step, + h5md.pressure_step, + h5md.box_step, + h5md.thermostat_work_step, + ): + dset[frame] = step + + for dset in ( + h5md.positions_time, + h5md.total_energy_time, + h5md.potential_energy_time, + h5md.kinetc_energy_time, + h5md.bond_energy_time, + h5md.angle_energy_time, + h5md.dihedral_energy_time, + h5md.field_energy_time, + h5md.total_momentum_time, + h5md.angular_momentum_time, + h5md.torque_time, + h5md.temperature_time, + h5md.pressure_time, + h5md.box_time, + h5md.thermostat_work_time, + ): + dset[frame] = step * time_step + + if velocity_out: + h5md.velocities_step[frame] = step + h5md.velocities_time[frame] = step * time_step + if force_out: + h5md.forces_step[frame] = step + h5md.forces_time[frame] = step * time_step + if charge_out: + h5md.field_q_energy_step[frame] = step + h5md.field_q_energy_time[frame] = step * time_step + if plumed_out: + h5md.plumed_bias_step[frame] = step + h5md.plumed_bias_time[frame] = step * time_step + + ind_sort = np.argsort(indices) + h5md.positions[frame, indices[ind_sort]] = positions[ind_sort] + + if velocity_out: + h5md.velocities[frame, indices[ind_sort]] = velocities[ind_sort] + if force_out: + h5md.forces[frame, indices[ind_sort]] = forces[ind_sort] + if charge_out: + h5md.field_q_energy[frame] = field_q_energy + if plumed_out: + h5md.plumed_bias[frame] = plumed_bias + + potential_energy = ( + bond2_energy + bond3_energy + bond4_energy + field_energy + field_q_energy + ) + + total_momentum = config.mass * comm.allreduce(np.sum(velocities, axis=0), MPI.SUM) + angular_momentum = config.mass * comm.allreduce( + np.sum(np.cross(positions, velocities), axis=0), MPI.SUM + ) + torque = config.mass * comm.allreduce( + np.sum(np.cross(positions, forces), axis=0), MPI.SUM + ) + h5md.total_energy[frame] = kinetic_energy + potential_energy + h5md.potential_energy[frame] = potential_energy + h5md.kinetc_energy[frame] = kinetic_energy + h5md.bond_energy[frame] = bond2_energy + h5md.angle_energy[frame] = bond3_energy + h5md.dihedral_energy[frame] = bond4_energy + h5md.field_energy[frame] = field_energy + h5md.total_momentum[frame, :] = total_momentum + h5md.angular_momentum[frame, :] = angular_momentum + h5md.torque[frame, :] = torque + h5md.temperature[frame] = temperature + h5md.pressure[frame] = pressure + for d in range(3): + h5md.box_value[frame, d, d] = box_size[d] + h5md.thermostat_work[frame] = config.thermostat_work + + fmt_ = [ + "step", + "time", + "temp", + "tot E", + "kin E", + "pot E", + "field E", + "elec E", + "bond E", + "ang E", + "dih E", + "bias E", + "Px", + "Py", + "Pz", + "ΔH" if config.target_temperature else "ΔE", + ] + fmt_ = np.array(fmt_) + + # create mask to show only energies != 0 + en_array = np.array([ + field_energy, + field_q_energy, + bond2_energy, + bond3_energy, + bond4_energy, + plumed_bias, + ]) + mask = np.full_like(fmt_, True, dtype=bool) + mask[range(6,12)] = en_array != 0. + + header_ = fmt_[mask].shape[0] * "{:>13}" + if config.initial_energy is None: + fmt_[-1] = "" + + divide_by = 1.0 + if dump_per_particle: + for i in range(3, 9): + fmt_[i] = fmt_[i][:-2] + "E/N" + fmt_[-1] += "/N" + divide_by = config.n_particles + total_energy = kinetic_energy + potential_energy + if config.initial_energy is not None: + if config.target_temperature: + H_tilde = total_energy - config.initial_energy - config.thermostat_work + else: + H_tilde = total_energy - config.initial_energy + else: + H_tilde = 0.0 + + header = header_.format(*fmt_[mask]) + data_fmt = f'{"{:13}"}{(fmt_[mask].shape[0]-1) * "{:13.5g}" }' + all_data = [ + step, + time_step * step, + temperature, + total_energy / divide_by, + kinetic_energy / divide_by, + potential_energy / divide_by, + field_energy / divide_by, + field_q_energy / divide_by, + bond2_energy / divide_by, + bond3_energy / divide_by, + bond4_energy / divide_by, + plumed_bias / divide_by, + total_momentum[0] / divide_by, + total_momentum[1] / divide_by, + total_momentum[2] / divide_by, + H_tilde / divide_by, + ] + data = data_fmt.format(*[val for i, val in enumerate(all_data) if mask[i]]) + Logger.rank0.log(logging.INFO, ("\n" + header + "\n" + data))
+ + +
[docs]def distribute_input( + in_file, rank, size, n_particles, max_molecule_size=201, comm=MPI.COMM_WORLD +): + """Assign global arrays onto MPI ranks, attempting load balancing + + Distributes approximately equal numbers of particles (workload) onto each + independent MPI rank, while respecting the requirement that any molecule + must be fully contained on a single MPI rank only (no splitting molecules + across multiple CPUs). + + Parameters + ---------- + in_file : h5py.File + HDF5 input file object. + rank : int + Local rank number for this MPI rank. + size : int + Global size of the MPI communicator (number of total CPUs). + n_particles : int + Total number of particles. + max_molecule_size : int, optional + Maximum size of any molecule present in the system. Used to initially + guess where the MPI rank boundaries (start/end indices) in the global + arrays should be placed. If molecules of size + :code:`>max_molecule_size` exist in the simulation system, HyMD + **might** work as expected. Or it might fail spectacularly. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + rank_range : + Starting and ending indices in the global arrays for each MPI rank. + """ + if n_particles is None: + n_particles = len(in_file["indices"]) + np_per_MPI = n_particles // size + + molecules_flag = False + if "molecules" in in_file: + molecules_flag = True + + if not molecules_flag: + if rank == size - 1: + np_cum_mpi = [rank * np_per_MPI, n_particles] + else: + np_cum_mpi = [rank * np_per_MPI, (rank + 1) * np_per_MPI] + p_mpi_range = list(range(np_cum_mpi[0], np_cum_mpi[1])) + return p_mpi_range, molecules_flag + + # To avoid splitting molecules across multiple different ranks, we need + # to read in some extra indices before/after the expected break points + # and iterate until we find a molecule break. + # + # Implicitly assuming no molecule is bigger than + # min(max_molecule_size, n_particles // n_MPI_ranks) atoms. + max_molecule_size += 2 + grab_extra = max_molecule_size if np_per_MPI > max_molecule_size else np_per_MPI + if rank == 0: + mpi_range_start = 0 + if size == 1: + mpi_range_end = n_particles + else: + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + elif rank == size - 1: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = n_particles + else: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + + molecules = in_file["molecules"][mpi_range_start:mpi_range_end] + indices = in_file["indices"][mpi_range_start:mpi_range_end] + molecule_end_indices = np.nonzero(np.diff(molecules))[0] + + p_mpi_range = [None, None] + if rank == 0: + p_mpi_range[0] = 0 + if size == 1: + p_mpi_range[1] = n_particles + else: + p_mpi_range[1] = indices[ + molecule_end_indices[molecule_end_indices >= np_per_MPI][0] + 1 + ] + elif rank == size - 1: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = n_particles + else: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = ( + indices[molecule_end_indices[molecule_end_indices > np_per_MPI][0]] + + 1 # noqa: E501 + ) + return list(range(p_mpi_range[0], p_mpi_range[1])), molecules_flag
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/_modules/hymd/force.html b/v2.0.1/_modules/hymd/force.html new file mode 100644 index 00000000..5ac1d2fc --- /dev/null +++ b/v2.0.1/_modules/hymd/force.html @@ -0,0 +1,1167 @@ + + + + + + hymd.force — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.force

+"""Calculates intramolecular forces between bonded particles in molecules
+"""
+import numpy as np
+import networkx as nx
+from dataclasses import dataclass
+
+# Imported here so we can call from force import compute_bond_forces__fortran
+from force_kernels import cbf as compute_bond_forces__fortran  # noqa: F401
+from force_kernels import (  # noqa: F401
+    caf as compute_angle_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cdf as compute_dihedral_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cbf_d as compute_bond_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    caf_d as compute_angle_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    cdf_d as compute_dihedral_forces__fortran__double,
+)
+
+
+
[docs]@dataclass # might not be needed +class Dielectric_type: + atom_1: str + dielectric_value: float
+ + +
[docs]@dataclass +class Bond: + """Dataclass representing a single two-particle bond type + + A `bond type` is a bond strength and equilibrium distance associated with + any bond between particles of specific types :code:`A` and :code:`B` + (where :code:`A` and :code:`B` may be the same or different). Harmonic + two-particle bonds in HyMD take the form + + .. math:: + + V_2(\\mathbf{r}_1, \\mathbf{r}_2) = + \\frac{1}{2}k + \\left( + \\vert \\mathbf{r}_1 - \\mathbf{r}_2 \\vert - r_0 + \\right)^2, + + where :math:`k` is the bond strength (spring constant) and :math:`r_0` is + the equilibrium bond length (at which the energy is zero). + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + equilibrium : float + Equilibrium distance at which the energy associated with the bond + vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient (spring constant). + """ + + atom_1: str + atom_2: str + equilibrium: float + strength: float
+ + +
[docs]@dataclass +class Angle(Bond): + """Dataclass representing a single three-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any three-particle bond between particles of specific types :code:`A`, + :code:`B`, and :code:`C` (where :code:`A`, :code:`B`, and :code:`C` may be + different or the same). Harmonic angular three-particle bonds in HyMD take + the form + + .. math:: + + V_3(\\mathbf{r}_1, \\mathbf{r}_2, \\mathbf{r}_3) = + \\frac{1}{2}k + \\left( + \\cos^{-1} + \\left[ + \\frac{ + (\\mathbf{r}_1-\\mathbf{r}_2) + \\cdot + (\\mathbf{r}_3-\\mathbf{r}_2) + } + { + \\vert\\mathbf{r}_1-\\mathbf{r}_2\\vert + \\vert\\mathbf{r}_3-\\mathbf{r}_2\\vert + } + \\right] - \\theta_0 + \\right)^2 + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + equilibrium : float + Equilibrium angle at which the energy associated with the + three-particle angular bond vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient. + + See also + -------- + Bond : + Two-particle bond type dataclass + """ + + atom_3: str
+ + +
[docs]@dataclass +class Dihedral: + """Dataclass representing a single four-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any four-particle torsional bond between particles of specific types + :code:`A`, :code:`B`, :code:`C`, and :code:`D` (where :code:`A`, :code:`B`, + :code:`C`, and :code:`D` may be different or the same). Dihedral + four-particle bonds in HyMD take different forms depending on the + :code:`dih_type` parameter. + + In the following, let :math:`\\phi` denote the angle between the planes + spanned by the relative positions of atoms :code:`A`-:code:`B`-:code:`C` + and :code:`B`-:code:`C`-:code:`D`. If :code:`dih_type = 0`, then + + .. math:: + + V_4(\\phi) = \\sum_n c_n + \\left( + 1 + \\cos\\left[ + n\\phi - d_n + \\right] + \\right), + + where :math:`c_n` are energy coefficients and :math:`d_n` are propensity + phases. By default, the cosine sum is truncated at five terms. If + :code:`coeffs` provides only a single float, this is used as the coiling + propensity parameter :math:`\\lambda`. In this case, :math:`c_n` and + :math:`d_n` are automatically set to values which promote alpha helical + (:math:`\\lambda=-1`), beta sheet (:math:`\\lambda=1`), or a mixed + (:math:`1>\\lambda>-1`) structure (using values provided by Bore et al. + (2018)). In this case, the full potential takes the form + + .. math:: + + V_4(\\phi;\\lambda) = + \\frac{1}{2}(1-\\lambda) V_{\\text{prop},\\alpha}(\\phi) + + + \\frac{1}{2}(1+\\lambda) V_{\\text{prop},\\beta}(\\phi) + + + (1-\\vert\\lambda\\vert) V_{\\text{prop}, \\text{coil}}(\\phi), + + with each of the :math:`V_{\\mathrm{prop}, X}` being fixed cosine series + potentials with pre-set :math:`c_n` -s and :math:`d_n` -s. + + If :code:`dih_type = 1`, then a combined bending torsional (CBT) potential + is employed, + + .. math:: + + V_4(\\phi,\\gamma;\\lambda) = + V_4(\\phi;\\lambda) + + + \\frac{1}{2}K(\\phi)(\\gamma - \\gamma_0)^2, + + where :math:`V_4(\\phi;\\lambda)` specifies the potential as given by the + coiling propensity parameter above, :math:`K(\\phi)` is a separate cosine + series potential acting as the angular three-particle bond strength, and + :math:`\\gamma_0` is the three-particle bond equilibrium angle. In this + case, the :code:`coeffs` parameter must specify *both* a :math:`\\lambda` + value, in additon to the energy and phases dictating the :math:`K(\\phi)` + potential. + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + atom_4 : str + Type name of particle 4. + coeffs : list[list[float]] or list[float] or numpy.ndarray + Dihedral coefficients defining the series expansion of the dihedral + energy. + dih_type : int + Specifies the type of dihedral used; If :code:`0`, then :code:`coeffs` + must contain **either** two lists of five energy coefficients + :math:`c_n` and five propensity phases :math:`d_n` **or** a single + floating point number defining the :math:`\\lambda` coiling propensity + parameter. If :code:`1`, the combined bending-torsional potential is + used, and :code:`coeffs` must specify :math:`\\lambda` *and* two lists + containing energy coefficients and propensity phases for the + :math:`V_\\text{prop}` propensity potential, defined in terms of cosine + series. + + References + ---------- + Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018. + """ + + atom_1: str + atom_2: str + atom_3: str + atom_4: str + coeffs: np.ndarray + dih_type: int
+ + +
[docs]@dataclass +class Chi: + """Dataclass representing a single :math:`\\chi` mixing interaction type + + An `interaction mixing energy type` is a mixing energy associated with + density overlap between species of types :code:`A` and :code:`B` + (specified as inputs :code:`atom_1` and :code:`atom_2`). A positive mixing + energy promotes phase separation, a negative mixing energy promotes mixing. + The interaction energy density (provided the :code:`DefaultWithChi` + Hamiltonian is used) takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} + \\sum_{k,l}\\chi_{k,l} \\tilde\\phi_k\\tilde\\phi_l, + + where :math:`\\chi_{k,l}` denotes the mixing energy between species + :math:`k` and :math:`l`, with :math:`\\kappa` being the incompressibility. + The value of the interaction mixing energy parameter may be extracted from + `Flory-Huggins theory`_. + + .. _`Flory-Huggins theory`: + https://en.wikipedia.org/wiki/Flory%E2%80%93Huggins_solution_theory + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + interaction_energy : float + Interaction mixing energy. + + See also + -------- + hymd.hamiltonian.DefaultWithChi : + Interaction energy functional using :math:`\\chi`-interactions. + """ + + atom_1: str + atom_2: str + interaction_energy: float
+ + +
[docs]def find_all_paths(G, u, n): + """Helper function that recursively finds all paths of given lenght 'n + 1' inside a network 'G'. + Adapted from https://stackoverflow.com/a/28103735.""" + if n == 0: + return [[u]] + paths = [] + for neighbor in G.neighbors(u): + for path in find_all_paths(G, neighbor, n - 1): + if u not in path: + paths.append([u] + path) + return paths
+ + +
[docs]def propensity_potential_coeffs(x: float): + alpha_coeffs = np.array( + [ + [7.406, -5.298, -2.570, 1.336, 0.739], + [-0.28632126, 1.2099146, 1.18122138, 0.49075168, 0.98495911], + ] + ) + beta_coeffs = np.array( + [ + [3.770, 5.929, -4.151, -0.846, 0.190], + [-0.2300693, -0.0583289, 0.99342396, 1.03237971, 2.90160988], + ] + ) + coil_coeffs = np.array( + [ + [1.416, -0.739, 0.990, -0.397, 0.136], + [1.3495933, 0.45649087, 2.30441057, -0.12274901, -0.26179939], + ] + ) + + zero_add = np.zeros((2, 5)) + if np.isclose(x, -1): + return np.concatenate((alpha_coeffs, zero_add)) + elif np.isclose(x, 0): + return np.concatenate((coil_coeffs, zero_add)) + elif np.isclose(x, 1): + return np.concatenate((beta_coeffs, zero_add)) + + abs_x = np.abs(x) + if abs_x > 1: + err_str = ( + f"The provided value of lambda = {x} is out of lambda definition range, " + f"[-1.0, 1.0]." + ) + Logger.rank0.log(logging.ERROR, err_str) + else: + coil_coeffs[0] *= 1 - abs_x + if x < 0: + alpha_coeffs[0] *= 0.5 * (abs_x - x) + return np.concatenate((alpha_coeffs, coil_coeffs)) + else: + beta_coeffs[0] *= 0.5 * (abs_x + x) + return np.concatenate((beta_coeffs, coil_coeffs))
+ + +
[docs]def prepare_bonds_old(molecules, names, bonds, indices, config): + """Find bonded interactions from connectivity and bond types information + + .. deprecated:: 1.0.0 + :code:`prepare_bonds_old` was replaced by :code:`prepare_bonds` for + use with compiled Fortran kernels prior to 1.0.0 release. + + Prepares the necessary equilibrium and bond strength information needed by + the intramolecular interaction functions. This is performed locally on each + MPI rank, as the domain decomposition ensures that for all molecules *all* + consituent particles are always contained on *the same* MPI rankself. + + This function traverses the bond connectivity information provided in the + structure/topology input file and indentifies any two-, three-, or + four-particle potential bonds. For each connected chain of two, three, or + four particles, a matching to bond types is attempted. If the corresponding + names match, a bond object is initialized. + + In order to investigate the connectivity, a graph is created using + networkx functionality. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2 : list + List of lists containing *local* particle indices, equilibrium + distance, and bond strength coefficient for each reconstructed + two-particle bond. + bonds_3 : + List of lists containing *local* particle indices, equilibrium angle, + and bond strength coefficient for each reconstructed three-particle + bond. + bonds_4 : + List of lists containing *local* particle indices, dihedral type index, + and dihedral coefficients for each reconstructed four-particle + torsional bond. + bb_index : list + List indicating the dihedral type of each four-particle bond in + :code:`bonds_4`. + + See also + -------- + Bond : + Two-particle bond type dataclass. + Angle : + Three-particle angular bond type dataclass. + Dihedral : + Four-particle torsional bond type dataclass. + hymd.input_parser.Config + Configuration dataclass handler. + """ + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + bb_index = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + bb_dihedral = 0 + bond_graph = nx.Graph() + + for local_index, global_index in enumerate(indices): + if molecules[local_index] != mol: + continue + + bond_graph.add_node( + global_index, + name=names[local_index].decode("UTF-8"), + local_index=local_index, + ) + for bond in [b for b in bonds[local_index] if b != -1]: + bond_graph.add_edge(global_index, bond) + + connectivity = nx.all_pairs_shortest_path(bond_graph) + for c in connectivity: + i = c[0] + connected = c[1] + for j, path in connected.items(): + if len(path) == 2 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for b in config.bonds: + match_forward = name_i == b.atom_1 and name_j == b.atom_2 + match_backward = name_i == b.atom_2 and name_j == b.atom_1 + if match_forward or match_backward: + bonds_2.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[j]["local_index"], + b.equilibrium, + b.strength, + ] + ) + + if len(path) == 3 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_mid = bond_graph.nodes()[path[1]]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for a in config.angle_bonds: + match_forward = ( + name_i == a.atom_1 + and name_mid == a.atom_2 + and name_j == a.atom_3 + ) + match_backward = ( + name_i == a.atom_3 + and name_mid == a.atom_2 + and name_j == a.atom_1 + ) + if match_forward or match_backward: + bonds_3.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[path[1]]["local_index"], + bond_graph.nodes()[j]["local_index"], + np.radians(a.equilibrium), + a.strength, + ] + ) + + all_paths_len_four = find_all_paths(bond_graph, i, 3) + for p in all_paths_len_four: + name_i = bond_graph.nodes()[i]["name"] + name_mid_1 = bond_graph.nodes()[p[1]]["name"] + name_mid_2 = bond_graph.nodes()[p[2]]["name"] + name_j = bond_graph.nodes()[p[3]]["name"] + + for a in config.dihedrals: + match_forward = ( + name_i == a.atom_1 + and name_mid_1 == a.atom_2 + and name_mid_2 == a.atom_3 + and name_j == a.atom_4 + ) + if ( + match_forward + and [ + bond_graph.nodes()[p[3]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[i]["local_index"], + a.coeffs, + a.dih_type, + ] + not in bonds_4 + ): + bonds_4.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[3]]["local_index"], + a.coeffs, + a.dih_type, + ] + ) + if a.dih_type == 1: + bb_dihedral = len(bonds_4) + + if bb_dihedral: + bb_index.append(bb_dihedral - 1) + + return bonds_2, bonds_3, bonds_4, bb_index
+ + +
[docs]def prepare_index_based_bonds(molecules, topol): + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + resid = mol + 1 + top_summary = topol["system"]["molecules"] + resname = None + test_mol_number = 0 + for molname in top_summary: + test_mol_number += molname[1] + if resid <= test_mol_number: + resname = molname[0] + break + + if resname is None: + break + + if "bonds" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for bond in topol[resname]["bonds"]: + index_i = bond[0] - 1 + first_id + index_j = bond[1] - 1 + first_id + # bond[2] is the bond type, inherited by the itp format. Not used + equilibrium = bond[3] + strength = bond[4] + bonds_2.append([index_i, index_j, equilibrium, strength]) + + if "angles" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["angles"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + # angle[3] is the angle type, inherited by the itp format. Not used + equilibrium = np.radians(angle[4]) + strength = angle[5] + bonds_3.append([index_i, index_j, index_k, equilibrium, strength]) + + if "dihedrals" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["dihedrals"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + index_l = angle[3] - 1 + first_id + dih_type = angle[4] + coeff = angle[5] + if dih_type == 0 and isinstance(coeff[0], (float, int)): + coeff = propensity_potential_coeffs(coeff[0]) + elif dih_type == 1 and len(coeff) == 3: + coeff = np.array( + propensity_potential_coeffs(coeff[0][0]).tolist() + + coeff[1:] + ) + elif dih_type == 2: + coeff = np.array(coeff) + else: + coeff = np.insert(np.array(coeff), 2, np.zeros((2, 5)), axis=0) + bonds_4.append([index_i, index_j, index_k, index_l, coeff, dih_type, 0]) + return bonds_2, bonds_3, bonds_4
+ + +
[docs]def prepare_bonds(molecules, names, bonds, indices, config, topol=None): + """Rearrange the bond information for usage in compiled Fortran kernels + + Restructures the lists resulting from the execution of + :code:`prepare_bonds_old` into numpy arrays suitable for calls to optimized + Fortran code calculating bonded forces and energiesself. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2_atom_1 : (B,) numpy.ndarray + Local index of particle 1 for each of :code:`B` constructed + two-particle bonds. + bonds_2_atom_2 : (B,) numpy.ndarray + Local index of particle 2 for each of :code:`B` constructed + two-particle bonds. + bonds_2_equilibrium : (B,) numpy.ndarray + Equilibrium distance for each of :code:`B` constructed two-particle + bonds. + bonds_2_strength : (B,) numpy.ndarray + Bond strength for each of :code:`B` constructed two-particle + bonds. + bonds_3_atom_1 : (A,) numpy.ndarray + Local index of particle 1 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_2 : (A,) numpy.ndarray + Local index of particle 2 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_3 : (A,) numpy.ndarray + Local index of particle 3 for each of :code:`A` constructed + three-particle bonds. + bonds_3_equilibrium : (A,) numpy.ndarray + Equilibrium angle for each of :code:`A` constructed three-particle + bonds. + bonds_3_strength : (A,) numpy.ndarray + Bond strength for each of :code:`A` constructed three-particle + bonds. + bonds_4_atom_1 : (D,) numpy.ndarray + Local index of particle 1 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_2 : (D,) numpy.ndarray + Local index of particle 2 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_3 : (D,) numpy.ndarray + Local index of particle 3 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_4 : (D,) numpy.ndarray + Local index of particle 4 for each of :code:`D` constructed + four-particle bonds. + bonds_4_coeff : (D,) numpy.ndarray + Cosine series coefficients for each of :code:`D` constructed + four-particle bonds. + bonds_4_type : (D,) numpy.ndarray + Dihedral type for each of :code:`D` constructed four-particle + bonds. + bonds_4_last : (D,) numpy.ndarray + Flags indicating if :code:`dih_type` is :code:`1` for each of :code:`D` + constructed four-particle bonds. + + See also + -------- + prepare_bonds_old : + Used internally to reconstruct the bonded interactions types from the + connectivity information in the structure/topology input file and the + bonded types specified in the configuration file. + """ + if topol is not None: + bonds_2, bonds_3, bonds_4 = prepare_index_based_bonds( + molecules, topol + ) + else: + bonds_2, bonds_3, bonds_4, bb_index = prepare_bonds_old( + molecules, names, bonds, indices, config + ) + + # Bonds + bonds_2_atom1 = np.empty(len(bonds_2), dtype=int) + bonds_2_atom2 = np.empty(len(bonds_2), dtype=int) + bonds_2_equilibrium = np.empty(len(bonds_2), dtype=np.float64) + bonds_2_strength = np.empty(len(bonds_2), dtype=np.float64) + for i, b in enumerate(bonds_2): + bonds_2_atom1[i] = b[0] + bonds_2_atom2[i] = b[1] + bonds_2_equilibrium[i] = b[2] + bonds_2_strength[i] = b[3] + + # Angles + bonds_3_atom1 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom2 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom3 = np.empty(len(bonds_3), dtype=int) + bonds_3_equilibrium = np.empty(len(bonds_3), dtype=np.float64) + bonds_3_strength = np.empty(len(bonds_3), dtype=np.float64) + for i, b in enumerate(bonds_3): + bonds_3_atom1[i] = b[0] + bonds_3_atom2[i] = b[1] + bonds_3_atom3[i] = b[2] + bonds_3_equilibrium[i] = b[3] + bonds_3_strength[i] = b[4] + # Dihedrals + bonds_4_atom1 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom2 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom3 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom4 = np.empty(len(bonds_4), dtype=int) + number_of_coeff = 6 + len_of_coeff = 5 + bonds_4_coeff = np.empty( + (len(bonds_4), number_of_coeff, len_of_coeff), dtype=np.float64 + ) + bonds_4_type = np.empty(len(bonds_4), dtype=int) + bonds_4_last = np.zeros(len(bonds_4), dtype=int) + for i, b in enumerate(bonds_4): + bonds_4_atom1[i] = b[0] + bonds_4_atom2[i] = b[1] + bonds_4_atom3[i] = b[2] + bonds_4_atom4[i] = b[3] + bonds_4_coeff[i] = np.resize(b[4], (number_of_coeff, len_of_coeff)) + bonds_4_type[i] = b[5] + if topol is not None: + bonds_4_last[i] = b[6] + if topol is None: + bonds_4_last[bb_index] = 1 + + return ( + bonds_2_atom1, + bonds_2_atom2, + bonds_2_equilibrium, + bonds_2_strength, + bonds_3_atom1, + bonds_3_atom2, + bonds_3_atom3, + bonds_3_equilibrium, + bonds_3_strength, # noqa: E501 + bonds_4_atom1, + bonds_4_atom2, + bonds_4_atom3, + bonds_4_atom4, + bonds_4_coeff, + bonds_4_type, + bonds_4_last, # noqa: E501 + )
+ + +
[docs]def compute_bond_forces__plain(f_bonds, r, bonds_2, box_size): + """Computes forces resulting from bonded interactions + + .. deprecated:: 1.0.0 + :code:`compute_bond_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_bonds.fill(0.0) + energy = 0.0 + + for i, j, r0, k in bonds_2: + ri = r[i, :] + rj = r[j, :] + rij = rj - ri + + # Apply periodic boundary conditions to the distance rij + for dim in range(len(rij)): + rij[dim] -= box_size[dim] * np.around(rij[dim] / box_size[dim]) + dr = np.linalg.norm(rij) + df = -k * (dr - r0) + f_bond_vector = df * rij / dr + f_bonds[i, :] -= f_bond_vector + f_bonds[j, :] += f_bond_vector + + energy += 0.5 * k * (dr - r0) ** 2 + return energy
+ + +
[docs]def compute_angle_forces__plain(f_angles, r, bonds_3, box_size): + """Computes forces resulting from angular interactions + + .. deprecated:: 1.0.0 + :code:`compute_angle_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_angles.fill(0.0) + energy = 0.0 + + for a, b, c, theta0, k in bonds_3: + ra = r[a, :] - r[b, :] + rc = r[c, :] - r[b, :] + + for dim in range(len(ra)): + ra[dim] -= box_size[dim] * np.around(ra[dim] / box_size[dim]) + rc[dim] -= box_size[dim] * np.around(rc[dim] / box_size[dim]) + + xra = 1.0 / np.sqrt(np.dot(ra, ra)) + xrc = 1.0 / np.sqrt(np.dot(rc, rc)) + ea = ra * xra + ec = rc * xrc + + cosphi = np.dot(ea, ec) + theta = np.arccos(cosphi) + xsinph = 1.0 / np.sqrt(1.0 - cosphi**2) + + d = theta - theta0 + f = -k * d + + xrasin = xra * xsinph * f + xrcsin = xrc * xsinph * f + + fa = (ea * cosphi - ec) * xrasin + fc = (ec * cosphi - ea) * xrcsin + + f_angles[a, :] += fa + f_angles[c, :] += fc + f_angles[b, :] -= fa + fc + # f_angles[b, :] += -(fa + fc) + + energy -= 0.5 * f * d + + return energy
+ + +
[docs]def compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size): + """Computes forces resulting from dihedral interactions + + .. deprecated:: 1.0.0 + :code:`compute_dihedral_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_dihedrals.fill(0.0) + energy = 0.0 + + for a, b, c, d, coeffs, phase in bonds_4: + f = r[a, :] - r[b, :] + g = r[b, :] - r[c, :] + h = r[d, :] - r[c, :] + + for dim in range(3): + f -= box_size[dim] * np.around(f[dim] / box_size[dim]) + g -= box_size[dim] * np.around(g[dim] / box_size[dim]) + h -= box_size[dim] * np.around(h[dim] / box_size[dim]) + + v = np.cross(f, g) + w = np.cross(h, g) + vv = np.dot(v, v) + ww = np.dot(w, w) + gn = np.linalg.norm(g) + + cosphi = np.dot(v, w) + sinphi = np.dot(np.cross(v, w), g) / gn + phi = np.arctan2(sinphi, cosphi) + + fg = np.dot(f, g) + hg = np.dot(h, g) + sc = v * fg / (vv * gn) - w * hg / (ww * gn) + + df = 0 + + for m in range(len(coeffs[0])): + energy += coeffs[0][m] * (1 + np.cos(m * phi - coeffs[1][m])) + df += m * coeffs[0][m] * np.sin(m * phi - coeffs[1][m]) + + force_on_a = df * gn * v / vv + force_on_d = df * gn * w / ww + + f_dihedrals[a, :] -= force_on_a + f_dihedrals[b, :] += df * sc + force_on_a + f_dihedrals[c, :] -= df * sc + force_on_d + f_dihedrals[d, :] += force_on_d + return energy
+ + +
[docs]def dipole_forces_redistribution( + f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb +): + """Redistribute electrostatic forces calculated from topologically + reconstructed ghost dipole point charges to the backcone atoms of the protein. + """ + f_on_bead.fill(0.0) + for i, j, k, l, fd, matrix, dih_type, is_last in zip( + a, b, c, d, f_dipoles, trans_matrices, type_array, last_bb + ): + if dih_type == 1: + sum_force = fd[0] + fd[1] + diff_force = fd[0] - fd[1] + f_on_bead[i] += matrix[0] @ diff_force # Atom A + f_on_bead[j] += matrix[1] @ diff_force + 0.5 * sum_force # Atom B + f_on_bead[k] += matrix[2] @ diff_force + 0.5 * sum_force # Atom C + + if is_last == 1: + sum_force = fd[2] + fd[3] + diff_force = fd[2] - fd[3] + f_on_bead[j] += matrix[3] @ diff_force + f_on_bead[k] += matrix[4] @ diff_force + 0.5 * sum_force + f_on_bead[l] += matrix[5] @ diff_force + 0.5 * sum_force
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/_modules/hymd/hamiltonian.html b/v2.0.1/_modules/hymd/hamiltonian.html new file mode 100644 index 00000000..afb40ca7 --- /dev/null +++ b/v2.0.1/_modules/hymd/hamiltonian.html @@ -0,0 +1,802 @@ + + + + + + hymd.hamiltonian — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.hamiltonian

+"""Interaction energy functionals.
+
+Implements field--particle interaction energy functionals depending on the
+field configuration. Extending HyMD with a new Hamiltonian is done by
+subclassing the :code:`Hamiltonian` superclass with logic intialized in the
+constructor.
+
+The grid-independent filtering function is defined in the :code:`Hamiltonian`
+superclass constructor. Hijack :code:`self.H` in a subclass to change the
+filter.
+"""
+import numpy as np
+import sympy
+
+
+
[docs]class Hamiltonian: + """Interaction energy functional superclass""" + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + self.config = config + self._setup()
+ +
[docs] def _setup(self): + """Superclass setup + + Sets up the grid-independent filtering function :code:`H`, and the + SymPy logic for symbolically differentiating interaction energy + functionals in Hamiltonian subclasses. + """ + if not hasattr(self.config, "simulation_volume"): + self.config.simulation_volume = np.prod(np.asarray(self.config.box_size)) + if not self.config.barostat: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.config.a = self.config.rho0 + if not self.config.rho0: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.phi = sympy.var("phi:%d" % (self.config.n_types)) + k = sympy.var("k:%d" % (3)) + + # electrostatics variables + self.psi = sympy.var("psi") + self.phi_q = sympy.var("phi_q") + if not self.config.self_energy: + self.config.self_energy = 0.0 + + def fourier_space_window_function(k): + return sympy.functions.elementary.exponential.exp( + -0.5 + * self.config.sigma**2 + * (k0**2 + k1**2 + k2**2) # noqa: F821, E501 + ) + + self.window_function_lambda = sympy.lambdify( + [k], fourier_space_window_function(k) + ) + + def H(k, v): + return v * self.window_function_lambda(k) + + self.H = H
+ + +
[docs]class SquaredPhi(Hamiltonian): + """Simple squared density interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + \\sum_k \\tilde\\phi_k + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`rho_0` is the + average density of the fully homogenous system. Expressing the species + densities in terms of fluctuations from the average, + + .. math:: + + \\mathrm{d}\\tilde\\phi_k = \\rho_0 - \\tilde\\phi_k, + + it is evident that this interaction energy functional is a slight change of + the :code:`DefaultNoChi` Hamiltonian, as the expanded interaction energy + density becomes + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + 6\\rho_0\\left[ + \\sum_k \\mathrm{d}\\tilde\\phi_k + \\right] + + + 9\\rho_0^2 + + + \\sum_k \\mathrm{d}\\tilde\\phi_k^2 + + + \\prod_{k\\not=l} + \\mathrm{d}\\tilde\\phi_k \\mathrm{d}\\tilde\\phi_l + \\right), + + identical to :code:`DefaultNoChi` apart from a constant energy shift + :math:`9\\rho_0^2`(which does not impact dynamics) and the + :math:`\\rho_0`--:math:`\\mathrm{d}\\tilde\\phi_k` cross-terms. These + cross-terms constitute contributions to the energy linear in + :math:`\\mathrm{d}\\tilde\\phi_k` absent in :code:`DefaultNoChi`, which has + only quadratic terms present. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(SquaredPhi, self).__init__(config) + super(SquaredPhi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0): + return 0.5 / (kappa * rho0) * (sum(phi)) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + ): + V_incompressibility = 1 / (kappa * rho0) * sum(phi) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultNoChi(Hamiltonian): + """Incompressibility-only interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. The :code:`SquaredPhi` Hamiltonian implements a similar + functional with an additional linear term component depending on + + .. math:: + + \\mathmr{d}\\tilde\\phi_k = \\tilde\\phi_k - \\rho_0 + + and not :math:`\\mathrm{d}\\tilde\\phi_k^2`. No explicit inter-species + interaction is present apart from the indirect interaction through the + incompressibility. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + hymd.input_parser.Config : + Configuration dataclass handler. + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultNoChi, self).__init__(config) + super(DefaultNoChi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0, a=self.config.a): + return 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultWithChi(Hamiltonian): + """Incompressibility and :math:`\\chi`-interactions energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = + \\frac{1}{2\\rho_0} + \\sum_{k,l}\\chi_{kl} \\tilde\\phi_k \\tilde\\phi_l + + + \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. :math:`\\chi_{ij}` is the Flory-Huggins-like + inter-species mixing energy. + """ + +
[docs] def __init__(self, config, unique_names, type_to_name_map): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultWithChi, self).__init__(config) + super(DefaultWithChi, self)._setup() + self.setup(unique_names, type_to_name_map)
+ +
[docs] def setup(self, unique_names, type_to_name_map): + """Setup the interaction energy potential and the external potential + + Parameters + ---------- + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + """ + self.type_to_name_map = type_to_name_map + self.chi_type_dictionary = { + tuple(sorted([c.atom_1, c.atom_2])): c.interaction_energy + for c in self.config.chi + } + self.phi_laplacian = [ + sympy.var("phi_laplacian%d(0:%d)" % (t, 3)) + for t in range(self.config.n_types) + ] + + def w( + phi, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + interaction = 0.0 + for i in range(self.config.n_types): + for j in range(i + 1, self.config.n_types): + ni = type_to_name_map[i] + nj = type_to_name_map[j] + names = sorted([ni, nj]) + c = chi_type_dictionary[tuple(names)] + + interaction += c * phi[i] * phi[j] / rho0 + incompressibility = 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + return incompressibility + interaction + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + t, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + + V_interaction = 0.0 + nk = type_to_name_map[t] + for i in range(self.config.n_types): + ni = type_to_name_map[i] + names = sorted([nk, ni]) + if ni != nk: + c = chi_type_dictionary[tuple(names)] + else: + c = 0.0 + # uncomment to count diagonal chi terms: + # c = chi_type_dictionary[tuple(names)] + V_interaction += c * phi[i] / rho0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[t])) + for t in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +def get_hamiltonian(config): + """Return appropriate Hamiltonian object based on the + config.hamiltonian string. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ---------- + hamiltonian : Hamiltonian + Hamiltonian object. + """ + if config.hamiltonian.lower() == "defaultnochi": + hamiltonian = DefaultNoChi(config) + elif config.hamiltonian.lower() == "defaultwithchi": + hamiltonian = DefaultWithChi( + config, config.unique_names, config.type_to_name_map + ) + elif config.hamiltonian.lower() == "squaredphi": + hamiltonian = SquaredPhi(config) + + return hamiltonian +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/_modules/hymd/input_parser.html b/v2.0.1/_modules/hymd/input_parser.html new file mode 100644 index 00000000..cebf7386 --- /dev/null +++ b/v2.0.1/_modules/hymd/input_parser.html @@ -0,0 +1,1640 @@ + + + + + + hymd.input_parser — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.input_parser

+"""Parses and handles the configuration information provided for the simulation
+"""
+import copy
+import tomli
+import datetime
+import logging
+import warnings
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass, field
+from typing import List, Union, ClassVar
+from .force import Bond, Angle, Dihedral, Chi, Dielectric_type, propensity_potential_coeffs
+from .barostat import Target_pressure
+from .logger import Logger
+
+
+
[docs]@dataclass +class Config: + """Configuration object + + Handles and verifies the simulation configuration specified in the + configuration file. + + Attributes + ---------- + gas_constant : float + Constant value of the gas constant, R (equivalently the Boltzmann + constant) in the units used internally in HyMD. + coulomb_constant : float + Constant value of the Coulomb constant which converts electric field + values to forces and electric potential values to energies in the units + used internally in HyMD. + n_steps: int + Number of time steps in the simulation. + time_step: float + *Outer* time step used in the simulation. If the rRESPA intergrator is + used, the *inner* time step (the time step used in the integration of + intramolecular bending, stretching, and torsional forces) is + :code:`time_step / respa_inner`. + box_size : list[float] or (D,) numpy.ndarray + Simulation box size of simulation in :code:`D` dimensions in units of + nanometers. + mesh_size : list[int] or int or numpy.ndarray + Number of grid points used for the discrete density grid. + sigma : float + Filter width representing the effective coarse-graining level of the + particles in the simulation. + kappa : float + Compressibility parameter used in the relaxed incompressibility term in + the interaction energy functional. + n_print : int, optional + Frequency of trajectory/energy output to the H5MD trajectory/energy + output file (in units of number of time steps). + tau : float, optional + The time scale of the CSVR thermostat coupling. + start_temperature : float, optional + Generate starting temperature by assigning all particle velocities + randomly according to the Maxwell-Boltzmann distribution at + :code:`start_temperature` Kelvin prior to starting the simulation. + target_temperature : float, optional + Couple the system to a heat bath at :code:`target_temperature` Kelvin. + mass : float, optional + Mass of the particles in the simulation. + hamiltonian : str, optional + Specifies the interaction energy functional :math:`W[\\tilde\\phi]` + for use with the particle-field interactions. Options: + :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`. + domain_decomposition : int, optional + Specifies the interval (in time steps) of domain decomposition + exchange, involving all MPI ranks sending and receiving particles + according to the particles’ positions in the integration box and the + MPI ranks’ assigned domain. + integrator : str, optional + Specifies the time integrator used in the simulation. Options: + :code:`velocity-verlet` or :code:`respa`. + respa_inner : int, optional + The number of inner time steps in the rRESPA integrator. This denotes + the number of intramolecular force calculations (stretching, bending, + torsional) are performed between each impulse applied from the field + forces. + file_name : str, optional + File path of the parsed configuration file. + name : str, optional + Name for the simulation. + tags : list[str], optional + Tags for the simulation. + bonds : list[Bond], optional + Specifies harmonic stretching potentials between particles in the + same molecule. + angle_bonds : list[Angle], optional + Specifies harmonic angular bending potentials between particles in the + same molecule. + dihedrals : list[Dihedral], optional + Specifies four-particle torsional potentials by cosine series. + chi : list[Chi], optional + Specifies :math:`\\chi`-interaction parameters between particle + species. + n_particles : int, optional + Specifies the total number of particles in the input. Optional keyword + for validation, ensuring the input HDF5 topology has the correct number + of particles and molecules. + max_molecule_size : int, optional + Maximum size of any single molecule in the system. Used to speed up + distribution of particles onto MPI ranks in a parallel fashion. + n_flush : int, optional + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be + written to disk (in units of number of :code:`n_print`). + thermostat_work : float + Work performed by the thermostat on the system. + thermostat_coupling_groups : list[str], optional + Specifies individual groups coupling independently to the CSVR + thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and + :code:`"C"` type particles, + :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would + thermalise types :code:`"A"` and :code:`"B"` together and couple + :code:`"C"` type particles to a different thermostat (all individual + thermostats are at the same temperature, i.e. target_temperature + Kelvin). + initial_energy : float + Value of the total energy prior to the start of the simulation. + cancel_com_momentum : int, optional + If :code:`True`, the total linear momentum of the center of mass is + removed before starting the simulation. If an integer is specifed, the + total linear momentum of the center of mass is removed every + :code:`remove_com_momentum` time steps. If :code:`False`, the linear + momentum is never removed. + coulombtype : str, optional + Specifies the type of electrostatic Coulomb interactions in the system. + The strength of the electrostatic forces is modulated by the relative + dielectric constant of the simulation medium, specified with the + :code:`dielectric_const` keyword. Charges for individual particles are + specified in the structure/topology HDF5 input file, not in the + configuration file. If no charges (or peptide backbone dipoles) are + present, the electrostatic forces will not be calculated even if this + keyword is set to :code:`"PIC_Spectral"`. + dielectric_const : float, optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. When + using helical propensity dihedrals, this keyword must be specified—even + if electrostatics are not included with the :code:`coulombtype` + keyword. + dielectric_type: list[float], optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. The list assigns + relative dielectric values to each bead type, and an anisotropic + dielectric function is obtained from a weighted average. + + + See also + -------- + hymd.input_parser.Bond : + Two-particle bond type dataclass. + hymd.input_parser.Angle : + Three-particle bond type dataclass. + hymd.input_parser.Dihedral : + Four-particle bond type dataclass. + """ + + gas_constant: ClassVar[float] = 0.0083144621 # kJ mol-1 K-1 + coulomb_constant: ClassVar[float] = 138.935458 # kJ nm mol-1 e-2 + + n_steps: int + time_step: float + mesh_size: Union[Union[List[int], np.ndarray], int] + sigma: float + kappa: float + + dtype: np.dtype = None + box_size: Union[List[float], np.ndarray] = None + n_print: int = None + tau: float = None + start_temperature: Union[float, bool] = None + target_temperature: Union[float, bool] = None + mass: float = None + hamiltonian: str = None + domain_decomposition: Union[int, bool] = None + integrator: str = None + respa_inner: int = 1 + file_name: str = "<config file path unknown>" + name: str = None + tags: List[str] = field(default_factory=list) + bonds: List[Bond] = field(default_factory=list) + angle_bonds: List[Angle] = field(default_factory=list) + dihedrals: List[Dihedral] = field(default_factory=list) + chi: List[Chi] = field(default_factory=list) + n_particles: int = None + max_molecule_size: int = None + n_flush: int = None + thermostat_work: float = 0.0 + thermostat_coupling_groups: List[List[str]] = field(default_factory=list) + initial_energy: float = None + cancel_com_momentum: Union[int, bool] = False + coulombtype: str = None + convergence_type: str = None + pol_mixing: float = None + dielectric_const: float = None + conv_crit: float = None + dielectric_type: List[Dielectric_type] = field(default_factory=list) + self_energy: float = None + type_charges: Union[List[float], np.ndarray] = None + + # For NPT runs + rho0: float = None + a: float = None + pressure: bool = False + barostat: str = None + barostat_type: str = None + tau_p: float = None + target_pressure: List[Target_pressure] = field(default_factory=list) + n_b: int = None + m: List[float] = field(default_factory=list) + + def __str__(self): + target_pressure_str = "\ttarget_pressure:\n" + "".join( + "\t\tP_L: " + + f"{self.target_pressure.P_L}\n" + + "\t\tP_N: " + + f"{self.target_pressure.P_N}\n" + ) + bonds_str = "\tbonds:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " f"{k.equilibrium}, {k.strength}\n") + for k in self.bonds + ] + ) + angle_str = "\tangle_bonds:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3}: " + + f"{k.equilibrium}, {k.strength}\n" + ) + for k in self.angle_bonds + ] + ) + dihedrals_str = "\tdihedrals:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: " + # This might need to be fixed/made prettier, probably + # there's an easier way + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ).join( + map( + str, + [ + [round(num, 3) for num in c_in] + if isinstance(c_in, list) + else c_in + for c_in in k.coeffs + ], + ) + ) + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ) + + f"dih_type = {k.dih_type}\n" + ) + for k in self.dihedrals + ] + ) + chi_str = "\tchi:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " + f"{k.interaction_energy}\n") + for k in self.chi + ] + ) + + """ If dielectric wanted as dictionary + dielectric_type_str = "\tdielectric_type:\n" + "".join( + [ + (f"\t\t{k.atom_1}: " + f"{k.dielectric_value}\n") + for k in self.dielectric_type + ] + ) + + """ + + thermostat_coupling_groups_str = "" + if any(self.thermostat_coupling_groups): + thermostat_coupling_groups_str = ( + "\tthermostat_coupling_groups:\n" + + "".join( + [ + "\t\t" + ", ".join([f"{n}" for n in ng]) + "\n" + for ng in self.thermostat_coupling_groups + ] + ) + ) + + ret_str = f'\n\n\tConfig: {self.file_name}\n\t{50 * "-"}\n' + for k, v in self.__dict__.items(): + if k not in ( + "target_pressure", + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "thermostat_coupling_groups", + ): + ret_str += f"\t{k}: {v}\n" + ret_str += ( + target_pressure_str + + bonds_str + + angle_str + + dihedrals_str + + chi_str + + thermostat_coupling_groups_str + ) + return ret_str
+ + +
[docs]def read_config_toml(file_path): + with open(file_path, "r") as in_file: + file_content = in_file.read() + return file_content
+ +
[docs]def parse_config_toml(toml_content, file_path=None, comm=MPI.COMM_WORLD): + config_dict = {} + + # read toml to a dictionary + toml_content = tomli.loads(toml_content) + + # Defaults = None + for n in ( + "box_size", + "n_print", + "tau", + "start_temperature", + "target_temperature", + "mass", + "hamiltonian", + "domain_decomposition", + "integrator", + "name", + "n_particles", + "max_molecule_size", + "coulombtype", + "convergence_type", + "dielectric_const", + "pol_mixing", + "conv_crit", + "dielectric_type", + "n_b", + "box_size", + "n_flush", + "self_energy", + "dtype", + ): + config_dict[n] = None + + # Defaults = [] + + for n in ( + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "tags", + "m", + "dielectric_type", + "target_pressure", + "type_charges", + ): + config_dict[n] = [] + + # Defaults: bool + config_dict["pressure"] = False + + # Flatten the .toml dictionary, ignoring the top level [tag] directives (if + # any). + for k, v in toml_content.items(): + if isinstance(v, dict): + if k == "nn": # Don't parse diff-hymd optimization options + continue + for nested_k, nested_v in v.items(): + config_dict[nested_k] = nested_v + else: + config_dict[k] = v + for k, v in config_dict.items(): + if k == "bonds": + config_dict["bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["bonds"][i] = Bond( + atom_1=b[0], + atom_2=b[1], + equilibrium=b[2], + strength=b[3], + ) + if k == "angle_bonds": + config_dict["angle_bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["angle_bonds"][i] = Angle( + atom_1=b[0], + atom_2=b[1], + atom_3=b[2], + equilibrium=b[3], + strength=b[4], + ) + if k == "dihedrals": + config_dict["dihedrals"] = [None] * len(v) + for i, b in enumerate(v): + try: + dih_type = int(b[2][0]) + except IndexError: + Logger.rank0.log( + logging.WARNING, "Dihedral type not provided, defaulting to 0." + ) + dih_type = 0 + + # Probably it's better to move this in check_dihedrals? + wrong_len = len(b[1]) not in (1, 2) + wrong_type_1 = len(b[1]) == 1 and not isinstance(b[1][0], float) + wrong_type_2 = len(b[1]) == 2 and not isinstance(b[1][0], list) + if wrong_len or wrong_type_1 or wrong_type_2: + err_str = ( + "The coefficients specified for the dihedral type " + "(0) do not match the correct structure. Either " + "use [lambda] or [[cn_prop], [dn_prop]], or select" + " the correct dihedral type." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise RuntimeError(err_str) + + # FIXME: this is messy af, I don't like it + if dih_type == 0 and isinstance(b[1][0], (float, int)): + coeff = propensity_potential_coeffs(b[1][0]) + elif dih_type == 1 and len(b[1]) == 3: + coeff = np.array( + propensity_potential_coeffs(b[1][0][0]).tolist() + + b[1][1:] + ) + elif dih_type == 2: + coeff = np.array(b[1]) + else: + coeff = np.insert(np.array(b[1]), 2, np.zeros((2, 5)), axis=0) + + config_dict["dihedrals"][i] = Dihedral( + atom_1=b[0][0], + atom_2=b[0][1], + atom_3=b[0][2], + atom_4=b[0][3], + coeffs=coeff, + dih_type=dih_type, + ) + if k == "chi": + config_dict["chi"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0], c[1]]) + config_dict["chi"][i] = Chi( + atom_1=c_[0], atom_2=c_[1], interaction_energy=c[2] + ) + + """ + if k == "dielectric_type": + config_dict["dielectric_type"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0][0]]) + config_dict["dielectric_type"][i] = Dielectric_type( + atom_1=c_[0], dielectric_value=c[1][0] + ) + """ + if k == "target_pressure": + if len(v) == 2: + config_dict["target_pressure"] = Target_pressure( + P_L=v[0], + P_N=v[1], # check condition # V array (still read as array?) + ) + elif len(v) == 1: + config_dict["target_pressure"] = Target_pressure(P_L=v[0], P_N=None) + else: + config_dict["target_pressure"] = Target_pressure(P_L=None, P_N=None) + + if file_path is not None: + config_dict["file_name"] = file_path + + for n in ( + "n_steps", "time_step", "mesh_size", "sigma", "kappa" + ): + if n not in config_dict: + err_str = ( + f"No {n} specified in config file {file_path}. Unable to start" + f" simulation." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return Config(**config_dict)
+ + +
[docs]def check_n_particles(config, indices, comm=MPI.COMM_WORLD): + n_particles = comm.allreduce(len(indices), MPI.SUM) + if config.n_particles is None: + config = copy.deepcopy(config) + config.n_particles = n_particles + info_str = ( + f"No n_particles found in toml file {config.file_name}, defaulting" + f" to indices.shape ({n_particles})" + ) + Logger.rank0.log(logging.INFO, info_str) + return config + + if n_particles != config.n_particles: + warn_str = ( + f"n_particles in {config.file_name} ({config.n_particles}) does " + "not match the shape of the indices array in the .HDF5 file " + f"({n_particles}). Defaulting to using indices.shape " + f"({n_particles})" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.n_particles = n_particles + return config
+ + +
[docs]def check_max_molecule_size(config, comm=MPI.COMM_WORLD): + if config.max_molecule_size is None: + info_str = ( + f"No max_molecule_size found in toml file {config.file_name}, " + f"defaulting to 201" + ) + Logger.rank0.log(logging.INFO, info_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + + if config.max_molecule_size < 1: + warn_str = ( + f"max_molecule_size in {config.file_name} must be a positive " + f"integer, not {config.max_molecule_size}, defaulting to 201" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + return config
+ + +def _find_unique_names(config, names, comm=MPI.COMM_WORLD): + unique_names = np.unique(names) + receive_buffer = comm.gather(unique_names, root=0) + + gathered_unique_names = None + if comm.Get_rank() == 0: + gathered_unique_names = np.unique(np.concatenate(receive_buffer)) + unique_names = comm.bcast(gathered_unique_names, root=0) + unique_names = sorted([n.decode("UTF-8") for n in unique_names]) + config.unique_names = unique_names + config.n_types = len(unique_names) + return config + + +def _setup_type_to_name_map(config, names, types, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + name_to_type_ = {} + for n, t in zip(names, types): + n = n.decode("utf-8") + if n not in name_to_type_: + name_to_type_[n] = t + receive_buffer = comm.gather(name_to_type_, root=0) + gathered_dict = None + if comm.Get_rank() == 0: + gathered_dict = {} + for d in receive_buffer: + for k, v in d.items(): + if k not in gathered_dict: + gathered_dict[k] = v + else: + assert v == gathered_dict[k] + name_to_type_map = comm.bcast(gathered_dict, root=0) + config.name_to_type_map = name_to_type_map + config.type_to_name_map = {v: k for k, v in name_to_type_map.items()} + return config + + +
[docs]def check_bonds(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for b in config.bonds: + if b.atom_1 not in unique_names or b.atom_2 not in unique_names: + missing_str = "" + if b.atom_1 not in unique_names: + if b.atom_2 not in unique_names: + if b.atom_1 == b.atom_2: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"neither {b.atom_1}, {b.atom_2} atoms" + else: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"no {b.atom_2} atoms" + + warn_str = ( + f"Bond type {b.atom_1}--{b.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_angles(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for a in config.angle_bonds: + if ( + a.atom_1 not in unique_names + or a.atom_2 not in unique_names + or a.atom_3 not in unique_names + ): + missing = [ + a.atom_1 not in unique_names, + a.atom_2 not in unique_names, + a.atom_3 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([a.atom_1, a.atom_2, a.atom_3]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Angle bond type {a.atom_1}--{a.atom_2}--{a.atom_3} " + f"specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_dihedrals(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for d in config.dihedrals: + if ( + d.atom_1 not in unique_names + or d.atom_2 not in unique_names + or d.atom_3 not in unique_names + or d.atom_4 not in unique_names + ): + missing = [ + d.atom_1 not in unique_names, + d.atom_2 not in unique_names, + d.atom_3 not in unique_names, + d.atom_4 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([d.atom_1, d.atom_2, d.atom_3, d.atom_4]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Dihedral type {d.atom_1}--{d.atom_2}--{d.atom_3}--{d.atom_4}" + f" specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_chi(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for c in config.chi: + if c.atom_1 not in unique_names or c.atom_2 not in unique_names: + missing_str = "" + if c.atom_1 not in unique_names: + if c.atom_2 not in unique_names: + if c.atom_1 == c.atom_2: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"neither {c.atom_1}, {c.atom_2} atoms" + else: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"no {c.atom_2} atoms" + + warn_str = ( + f"Chi interaction {c.atom_1}--{c.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + for i, n in enumerate(unique_names): + for m in unique_names[i + 1 :]: + found = False + for c in config.chi: + if (c.atom_1 == n and c.atom_2 == m) or ( + c.atom_1 == m and c.atom_2 == n + ): + found = True + if not found: + config.chi.append(Chi(atom_1=n, atom_2=m, interaction_energy=0.0)) + warn_str = ( + f"Atom types {n} and {m} found in the " + f"system, but no chi interaction {n}--{m} " + f"specified in {config.file_name}. Defaulting to " + f"chi[{n}, {m}] = 0" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_box_size(config, input_box, comm=MPI.COMM_WORLD): + if config.box_size is not None: + config.box_size = np.array(config.box_size, dtype=np.float32) + if input_box.all() and not np.allclose(config.box_size, input_box, atol=0.009): + err_str = ( + f"Box size specified in {config.file_name}: " + f"{config.box_size} does not match input box:" + f"{input_box}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + else: + if input_box.all(): + config.box_size = input_box + else: + err_str = f"No box information found" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + for b in config.box_size: + if b <= 0.0: + err_str = ( + f"Invalid box size specified in {config.file_name}: " + f"{config.box_size}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return config
+ + +
[docs]def check_integrator(config, comm=MPI.COMM_WORLD): + if config.integrator.lower() not in ("velocity-verlet", "respa"): + err_str = ( + f"Invalid integrator specified in {config.file_name}: " + f'{config.integrator}. Available options "velocity-verlet" or ' + f'"respa".' + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + if config.integrator.lower() == "respa": + if isinstance(config.respa_inner, float): + warn_str = ( + f"Number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner} specified " + f"as float, using {int(config.respa_inner)}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = int(config.respa_inner) + elif not isinstance(config.respa_inner, int): + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + + if config.respa_inner <= 0: + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + if config.integrator.lower() == "velocity-verlet" and config.respa_inner != 1: + warn_str = ( + f"Integrator type Velocity-Verlet specified in {config.file_name} " + f"and inner rRESPA time steps set to {config.respa_inner}. " + f"Using respa_inner = 1" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = 1 + + return config
+ + +
[docs]def check_hamiltonian(config, comm=MPI.COMM_WORLD): + valid_hamiltonians = ["defaultnochi", "defaultwithchi", "squaredphi"] + + if config.hamiltonian is None: + if len(config.chi) == 0: + warn_str = ( + f"No hamiltonian form and no chi interactions specified in " + f"{config.file_name}, defaulting to DefaultNoChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultNoChi" + else: + warn_str = ( + f"No hamiltonian form specified in {config.file_name}, but " + f"chi interactions are specified, defaulting to " + f"DefaultWithChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultWithChi" + elif config.hamiltonian.lower() not in valid_hamiltonians: + err_str = ( + f"The specified Hamiltonian {config.hamiltonian} was not " + f"recognized as a valid Hamiltonian." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise NotImplementedError(err_str) + + return config
+ + +
[docs]def check_n_flush(config, comm=MPI.COMM_WORLD): + if config.n_print: + if config.n_flush is None: + config.n_flush = 10000 // config.n_print + return config
+ + +
[docs]def check_n_print(config, comm=MPI.COMM_WORLD): + if ( + not isinstance(config.n_print, int) + and not isinstance(config.n_print, float) + and config.n_print is not None + ): + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if config.n_print is None or config.n_print <= 0: + config.n_print = False + elif not isinstance(config.n_print, int): + if isinstance(config.n_print, float): + warn_str = ( + f"n_print is a float ({config.n_print}), not int, using " + f"{int(round(config.n_print))}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + config.n_print = int(round(config.n_print)) + else: + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + return config
+ + +
[docs]def check_tau(config, comm=MPI.COMM_WORLD): + if config.tau is None and config.target_temperature is not None: + warn_str = "target temp specified but no tau, defaulting 0.7" + config.tau = 0.7 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_start_and_target_temperature(config, comm=MPI.COMM_WORLD): + """Validate provided starting and target thermostat temperatures + + Assesses the provided temperature target and ensures it is a non-negative + floating point number or :code:`False`. Ensures the starting temperature is + a non-negative floating point number or :code:`False`. + + If the value for either is :code:`None`, the returned configuration object + has the values defaulted to :code:`False` in each case. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ------- + validated_config : Config + Configuration object with validated :code:`target_temperature` and + :code:`start_temperature`. + """ + for t in ("start_temperature", "target_temperature"): + if getattr(config, t) is not None: + try: + if getattr(config, t) < 0: + warn_str = ( + f"{t} set to negative value ({getattr(config, t)}), " + f"defaulting to False" + ) + setattr(config, t, False) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + except TypeError as e: + err_str = ( + f"Could not interpret {t} = {repr(getattr(config, t))} as " + f"a number." + ) + raise TypeError(err_str) from e + + if config.start_temperature is None: + config.start_temperature = False + if config.target_temperature is None: + config.target_temperature = False + return config
+ + +
[docs]def check_mass(config, comm=MPI.COMM_WORLD): + if config.mass is None: + info_str = "no mass specified, defaulting to 72.0" + config.mass = 72.0 + Logger.rank0.log(logging.INFO, info_str) + elif not isinstance(config.mass, int) and not isinstance(config.mass, float): + err_str = ( + f"specified mass is invalid type {config.mass}, " f"({type(config.mass)})" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + elif config.mass < 0: + err_str = f"invalid mass specified, {config.mass}" + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + else: + config.mass = float(config.mass) + + return config
+ + +
[docs]def check_domain_decomposition(config, comm=MPI.COMM_WORLD): + dd = config.domain_decomposition + if dd is None or dd is False: + config.domain_decomposition = False + return config + + if isinstance(dd, int): + if dd < 0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + elif isinstance(dd, float): + if dd < 0.0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + else: + warn_str = ( + f"domain_decomposition ({config.domain_decomposition}) is not " + f"an integer, using {int(round(dd))}" + ) + config.domain_decomposition = int(round(dd)) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + else: + err_str = ( + f"invalid value for domain_decomposition " + f"({config.domain_decomposition}) use an integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + return config
+ + +
[docs]def check_name(config, comm=MPI.COMM_WORLD): + if config.name is None: + root_current_time = "" + if comm.Get_rank() == 0: + root_current_time = datetime.datetime.now().strftime("%m/%d/%Y, %H:%M:%S") + current_time = comm.bcast(root_current_time, root=0) + + if config.name is None: + config.name = "sim" + current_time + else: + config.name = str(config.name) + return config
+ + +
[docs]def check_NPT_conditions(config, comm=MPI.COMM_WORLD): + """ + Check validity of barostat_type, barostat, + a, rho0, target_pressure, tau_p + """ + if config.barostat is None: + if ( + config.tau_p is not None + or (config.target_pressure.P_L and config.target_pressure.P_N) is not None + ): + err_str = ( + "barostat not specified but config.tau_p " + "or config.target_pressure specified, cannot start simulation {config.barostat}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.a: + warn_str = "a specified but no barostat," "setting a to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.rho0: + warn_str = ( + "rho0 specified but no barostat," "setting rho0 to average density" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + if config.barostat is not None: + if not config.barostat_type: + config.barostat_type = "berendsen" + warn_str = "barostat_type not specified," "setting to berendsen" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.barostat != "isotropic" and config.barostat != "semiisotropic": + err_str = "barostat option not recognised. Valid options: isotropic, semiisotropic" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.target_pressure.P_L is None: + config.target_pressure.P_L = 1.0 # bar + config.target_pressure.P_N = None + if config.barostat == "semiisotropic": + config.target_pressure.P_N = 1.0 # bar + warn_str = ( + "barostat specified but no target_pressure, defaulting to 1.0 bar" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.tau_p is None: + if config.tau <= 0.1: + config.tau_p = config.tau * 10.0 + else: + config.tau_p = 1.0 + warn_str = "barostat specified but no tau_p, defaulting to " + str( + config.tau_p + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if not config.a: + err_str = "a not specified; cannot start simulation {config.a}" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if not config.rho0: + warn_str = "rho0 not specified;" "setting rho0 to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + return config
+ + +
[docs]def check_thermostat_coupling_groups(config, comm=MPI.COMM_WORLD): + if any(config.thermostat_coupling_groups): + found = [0 for _ in config.unique_names] + unique_names = [n for n in config.unique_names] + for i, group in enumerate(config.thermostat_coupling_groups): + for species in group: + try: + ind = unique_names.index(species) + found[ind] += 1 + except ValueError as e: + err_str = ( + f"Particle species {species} specified in thermostat " + f"coupling group {i}, but no {species} particles were " + "found in the system." + ) + raise ValueError(err_str) from e + if any([True if f > 1 else False for f in found]): + for i, f in enumerate(found): + if f > 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} specified in multiple " + "thermostat coupling groups; " + f"{config.thermostat_coupling_groups}." + ) + raise ValueError(err_str) + if not all([True if f == 1 else False for f in found]): + for i, f in enumerate(found): + if f != 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} not specified in any " + f"thermostat coupling group, but {species} particles " + "were found in the system" + ) + raise ValueError(err_str) + return config
+ + +
[docs]def check_m(config, comm=MPI.COMM_WORLD): + if config.m == []: + config.m = [1.0 for t in range(config.n_types)] + return config
+ + +
[docs]def check_n_b(config, comm=MPI.COMM_WORLD): + if config.n_b is None: + warn_str = f"config.n_b not specified." "Defaulting to 1" + config.n_b = 1 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_cancel_com_momentum(config, comm=MPI.COMM_WORLD): + if isinstance(config.cancel_com_momentum, int): + if config.cancel_com_momentum == 0 or config.cancel_com_momentum < 0: + config.cancel_com_momentum = False + elif not isinstance(config.cancel_com_momentum, bool): + err_str = ( + f"Could not interpret {config.cancel_com_momentum} as an integer " + f"or boolean." + ) + raise ValueError(err_str) + return config
+ + +
[docs]def sort_dielectric_by_type_id(config, charges, types): + """ + Creates a list of length N CG-particles, sorted after the charges from + the input HDF5 file. Used in file_io.py + """ + dielectric_val = np.zeros(config.n_types) + for j in range(config.n_types): + name = config.dielectric_type[j][0][0] + type_id = config.name_to_type_map[name] + dielectric_val[type_id] = config.dielectric_type[j][1][0] + config.dielectric_type = dielectric_val.copy() + + N = len(charges) + len_list = np.zeros(config.n_types) + dielectric_by_types = np.zeros(N) + for i in range(N): + dielectric_by_types[i] = dielectric_val[types[i]] + # print("types ", types) + # print("diel val", dielectric_by_types) + # print("charges", charges) + # print(config.name_to_type_map) + return dielectric_by_types # by types with each particle id
+ + +
[docs]def check_charges_types_list(config, types, charges, comm=MPI.COMM_WORLD): + """ + Creates a list of charge values of length types. + Charges are sorted according to type ID. Used in field.py. + # TODO: this is messy, we should fix it + """ + if charges is None: + config.type_charges = [0.0] * config.n_types + return config + + check_val = -100.0 # some random value that will never be encountered + charges_list = np.full(config.n_types, check_val) # gatherv cant handle None + rank = comm.Get_rank() + # print(charges_list) + for t_ in range(config.n_types): + if t_ in types: + charges_list[t_] = charges[types == t_][0] + + nprocs = int(comm.Get_size()) + recv_charges = None + if rank == 0: + recv_charges = np.full( + config.n_types * nprocs, check_val + ) # gatherv cant handle None + comm.Gather(charges_list, recv_charges, root=0) + + ## make a charges list + if rank == 0: + config_charges = np.zeros(config.n_types) + test_config = np.full(config.n_types, check_val) + for j in range(nprocs): + for i in range(config.n_types): + if recv_charges[i + j * config.n_types] != check_val: + config_charges[i] = recv_charges[i + j * config.n_types] + if np.any([test_config, config_charges]): + continue + else: + break + + # print(config_charges) + # print(config.name_to_type_map) + # print(charges[types == 0][0],charges[types == 1][0],charges[types == 2][0],charges[types == 3][0], + # charges[types == 4][0]) + else: + config_charges = np.zeros(config.n_types) + + comm.Bcast(config_charges, root=0) + # print("config_charges", config_charges , "rank", rank) + # print(recv_charges) + # rank = comm.Get_rank() + # print(all_charges) + config.type_charges = config_charges + return config
+ + +
[docs]def check_dielectric(config, comm=MPI.COMM_WORLD): + """ + Error handling for electrostatics. + Unit testing of toml/tomli input. + """ + err_str_const = "Dielectric constant not given." + if config.coulombtype == "PIC_Spectral": + assert config.dielectric_const != None, err_str_const + + err_str = "Dielectric list is empty." + if config.coulombtype == "PIC_Spectral_GPE": + assert len(config.dielectric_type) != 0, err_str + # default values + if config.pol_mixing is None: + config.pol_mixing = 0.6 + if config.conv_crit is None: + config.conv_crit = 1e-6 + return config
+ + +
[docs]def check_charges(config, charges, comm=MPI.COMM_WORLD): + """Check if charges across ranks sum to zero. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of floats with charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + """ + total_charge = comm.allreduce(np.sum(charges), MPI.SUM) + + if not np.isclose(total_charge, 0.0): + warn_str = ( + f"Charges in the input file do not sum to zero. " + f"Total charge is {total_charge}." + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + # if charges are ok, compute self energy + if config.coulombtype == "PIC_Spectral": + from .field import compute_self_energy_q + + config.self_energy = compute_self_energy_q(config, charges, comm=comm) + + return config
+ + +
[docs]def check_config( + config, indices, names, types, charges, input_box, comm=MPI.COMM_WORLD +): + """Performs various checks on the specfied config to ensure consistency + + Parameters + ---------- + config : Config + Configuration object. + indices : (N,) numpy.ndarray + Array of integer indices for :code:`N` particles. + names : (N,) numpy.ndarray + Array of string names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of integer type indices for :code:`N` particles. + charges : (N,) numpy.ndarray + Array of floats charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + + Returns + ------- + config : Config + Validated configuration object. + """ + config = _find_unique_names(config, names, comm=comm) + if types is not None: + config = _setup_type_to_name_map(config, names, types, comm=comm) + config = check_box_size(config, input_box, comm=comm) + config = check_integrator(config, comm=comm) + config = check_max_molecule_size(config, comm=comm) + config = check_tau(config, comm=comm) + config = check_start_and_target_temperature(config, comm=comm) + config = check_mass(config, comm=comm) + config = check_domain_decomposition(config, comm=comm) + config = check_name(config, comm=comm) + config = check_n_particles(config, indices, comm=comm) + config = check_chi(config, names, comm=comm) + config = check_bonds(config, names, comm=comm) + config = check_angles(config, names, comm=comm) + config = check_dihedrals(config, names, comm=comm) + config = check_hamiltonian(config, comm=comm) + config = check_NPT_conditions(config, comm=comm) + config = check_n_b(config, comm=comm) + config = check_m(config, comm=comm) + config = check_thermostat_coupling_groups(config, comm=comm) + config = check_cancel_com_momentum(config, comm=comm) + config = check_dielectric(config, comm=comm) + config = check_n_print(config, comm=comm) + config = check_n_flush(config, comm=comm) + config = check_charges_types_list(config, types, charges, comm=comm) + if charges is not None: + config = check_charges(config, charges, comm=comm) + + return config
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/_modules/hymd/integrator.html b/v2.0.1/_modules/hymd/integrator.html new file mode 100644 index 00000000..e4956223 --- /dev/null +++ b/v2.0.1/_modules/hymd/integrator.html @@ -0,0 +1,363 @@ + + + + + + hymd.integrator — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.integrator

+"""Integrates equations of motion.
+
+Implements the Velocity Verlet integrator. The *reversible reference system
+propagator algorithm* (rRESPA) integrator uses the Velocity Verlet functions
+inside the MD loop in the main module.
+"""
+
+
+
[docs]def integrate_velocity(velocities, accelerations, time_step): + """Velocity update step of the Velocity Verlet integration algorithm. + + Computes the velocity update step of the Velocity Verlet algorithm. The + :code:`velocities` argument is **not** changed in place. + + Parameters + ---------- + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + accelerations : (N, D) numpy.ndarray + Array of accelerations of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step + + .. math:: \\mathbf{v}_{\\text{new}} = \\mathbf{v} + \\frac{\\Delta t}{2m} + \\mathbf{f} + + before the positions are moved a full step using the updated half-step + velocities. + + See Also + -------- + integrate_position : The position update step of the Velocity Verlet + algorithm. + """ + return velocities + 0.5 * time_step * accelerations
+ + +
[docs]def integrate_position(positions, velocities, time_step): + """Position update step of the Velocity Verlet integration algorithm. + + Computes the position update step of the Velocity Verlet algorithm. The + :code:`positions` argument is **not** changed in place. + + Parameters + ---------- + positions : (N, D) numpy.ndarray + Array of positions of :code:`N` particles in :code:`D` dimensions. + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step, then the positions are updated a full step using the updated + velocities + + .. math:: \\mathbf{x}_{\\text{new}} = \\mathbf{x} + \\Delta t \\mathbf{v} + + See Also + -------- + integrate_velocity : The velocity update step of the Velocity Verlet + algorithm. + """ + return positions + time_step * velocities
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/_modules/hymd/logger.html b/v2.0.1/_modules/hymd/logger.html new file mode 100644 index 00000000..a0b4919a --- /dev/null +++ b/v2.0.1/_modules/hymd/logger.html @@ -0,0 +1,552 @@ + + + + + + hymd.logger — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.logger

+"""Handles event logging for simulation information, warnings, and errors.
+"""
+import sys
+import os
+import logging
+from mpi4py import MPI
+from .version import __version__
+
+
+
[docs]class MPIFilterRoot(logging.Filter): + """Log output Filter wrapper class for the root MPI rank log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + if self.comm.Get_rank() == 0: + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True + else: + return False
+ + +
[docs]class MPIFilterAll(logging.Filter): + """Log output Filter wrapper class for the all-MPI-ranks log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True
+ + +class MPIFilterStdout(logging.Filter): + """Log output Filter wrapper class for filtering STDOUT log""" + + def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.funcName = "replica 0 " + record.funcName + if MPI.COMM_WORLD.Get_rank() == 0: + record.rank = MPI.COMM_WORLD.Get_rank() + record.size = MPI.COMM_WORLD.Get_size() + return True + else: + return False + + +
[docs]class Logger: + """Log output handler class + + Notes + ----- + This wraps the default python library :code:`logging`, see + `docs.python.org/3/library/logging.html`_. + + .. _`docs.python.org/3/library/logging.html`: + https://docs.python.org/3/library/logging.html + + Attributes + ---------- + level : int + Determines the verbosity level of the log, corresponding to + logging.level. Numerical values :code:`50` (:code:`logging.CRITICAL`), + :code:`40` (:code:`logging.ERROR`), :code:`30` + (:code:`logging.WARNING`), :code:`20` (:code:`logging.INFO`), + :code:`10` (:code:`logging.DEBUG`), and :code:`0` + (:code:`logging.UNSET`) are supported values. Any log event message + less severe than the specified level is ignored. All other event + messages are emitted. + log_file : str + Path to output log file. + format : str + Prepended dump string for each log event. Specifies the log event + level, the module emitting the event, the code line, the enclosing + function name, and the MPI rank writing the message. + date_format : str + Prepends the date before all log event messages. + formatter : logging.Formatter + Formatter handling the prepending of the information in `format` and + `date_format` to each log event message. Used by default for all + loggers. + rank0 : logging.Logger + Default logger object for the root MPI rank. + all_ranks : logging.Logger + Default logger object for messages being emitted from all MPI ranks + simultaneously. + """ + + level = None + log_file = None + format = " %(levelname)-8s [%(filename)s:%(lineno)d] <%(funcName)s> {rank %(rank)d/%(size)d} %(message)s" # noqa: E501 + date_format = "%(asctime)s" + formatter = logging.Formatter(fmt=date_format + format) + rank0 = logging.getLogger("HyMD.rank_0") + all_ranks = logging.getLogger("HyMD.all_ranks") + +
[docs] @classmethod + def setup(cls, default_level=logging.INFO, log_file=None, verbose=False, comm=MPI.COMM_WORLD): + """Sets up the logger object. + + If a :code:`log_file` path is provided, log event messages are output + to it. Otherwise, the logging messages are emitted to stdout. + + Parameters + ---------- + default_level : int, optional + Default verbosity level of the logger. Unless specified, it is + :code:`10` (:code:`logging.INFO`). + log_file : str, optional + Path to output log file. If `None` or not priovided, no log file is + used and all logging is done to stdout. + verbose : bool, optional + Increases the logging level to :code:`30` (:code:`logging.WARNING`) + if True, otherwise leaves the logging level unchanged. + """ + cls.level = default_level + cls.log_file = log_file + + log_to_stdout = False + if verbose: + log_to_stdout = True + + level = default_level + if not verbose: + level = logging.WARNING + cls.rank0.setLevel(level) + cls.all_ranks.setLevel(level) + + root_filter = MPIFilterRoot(comm) + all_filter = MPIFilterAll(comm) + cls.rank0.addFilter(root_filter) + cls.all_ranks.addFilter(all_filter) + + if (not log_file) and (not log_to_stdout): + return + if log_file: + cls.log_file_handler = logging.FileHandler(log_file) + cls.log_file_handler.setLevel(level) + cls.log_file_handler.setFormatter(cls.formatter) + + cls.rank0.addHandler(cls.log_file_handler) + cls.all_ranks.addHandler(cls.log_file_handler) + if log_to_stdout: + cls.log_to_stdout = True + cls.stdout_handler = logging.StreamHandler() + cls.stdout_handler.setLevel(level) + cls.stdout_handler.setStream(sys.stdout) + cls.stdout_handler.setFormatter(cls.formatter) + cls.stdout_handler.addFilter(MPIFilterStdout()) + + cls.rank0.addHandler(cls.stdout_handler) + cls.all_ranks.addHandler(cls.stdout_handler)
+ + +def format_timedelta(timedelta): + days = timedelta.days + hours, rem = divmod(timedelta.seconds, 3600) + minutes, seconds = divmod(rem, 60) + microseconds = timedelta.microseconds + ret_str = "" + if days != 0: + ret_str += f"{days} days " + ret_str += f"{hours:02d}:{minutes:02d}:{seconds:02d}.{microseconds:06d}" + return ret_str + + +def get_version(): + # Check if we are in a git repo and grab the commit hash and the branch if + # we are, append it to the version number in the output specification. + try: + import git + + try: + repo_dir = os.path.abspath( + os.path.join(os.path.dirname(__file__), os.pardir) + ) + repo = git.Repo(repo_dir) + commit = str(repo.head.commit)[:7] + branch = repo.active_branch + version = f"{__version__} [{branch} branch commit {commit}]" + except git.exc.InvalidGitRepositoryError: + version = f"{__version__}" + except ModuleNotFoundError: + version = f"{__version__}" + + return version + + +def print_header(): + banner = r""" + __ __ ____ __ _______ + / / / /_ __/ / /__ _________ _____ ______ / |/ / __ \ + / /_/ / / / / / / _ \/ ___/ __ `/ __ `/ ___/ / /|_/ / / / / + / __ / /_/ / / / __/ / / /_/ / /_/ (__ ) / / / / /_/ / + /_/ /_/\__, /_/_/\___/_/ \__,_/\__,_/____/ /_/ /_/_____/ + /____/ + """ + + refs_set = """ + + [1] Ledum, M.; Sen, S.; Li, X.; Carrer, M.; Feng Y.; Cascella, M.; Bore, S. L. + HylleraasMD: A Domain Decomposition-Based Hybrid Particle-Field Software for Multi-Scale Simulations of Soft Matter. + J. Chem. Theory Comput. 2023. + + [2] Ledum, M.; Carrer, M.; Sen, S.; Li, X.; Cascella, M.; Bore, S. L. + HyMD: Massively parallel hybrid particle-field molecular dynamics in Python. + J. Open Source Softw. 8(84), 4149, 2023. + + [3] Sen, S.; Ledum, M.; Bore, S. L.; Cascella, M. + Soft Matter under Pressure: Pushing Particle–Field Molecular Dynamics to the Isobaric Ensemble. + J Chem Inf Model 2023, 63(7), 1549-9596. + + [4] Bore, S. L.; Cascella, M. + Hamiltonian and alias-free hybrid particle–field molecular dynamics. + J. Chem. Phys. 2020, 153, 094106. + + [5] Pippig, M. PFFT: An extension of FFTW to massively parallel architectures. + SIAM J. Sci. Comput. 2013, 35, C213–C236. + +""" + + version = f"Version {get_version()}" + header = banner + header += version.center(56) + "\n\n" + #header += " Please read and cite the references below:" + header += " PLEASE READ AND CITE THE REFERENCES BELOW:" + header += refs_set + + return header +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/_modules/hymd/pressure.html b/v2.0.1/_modules/hymd/pressure.html new file mode 100644 index 00000000..ae866ae0 --- /dev/null +++ b/v2.0.1/_modules/hymd/pressure.html @@ -0,0 +1,469 @@ + + + + + + hymd.pressure — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.pressure

+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import sympy
+from .field import comp_laplacian
+
+
+
[docs]def comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fourier, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=MPI.COMM_WORLD, +): + """ + Computes total internal pressure of the system. + Kinetic pressure is trivially calculated from the kinetic energy. + Already computed bond and angle pressure terms are inserted into the + total internal pressure. + The field pressure equation is implemented. + + Parameters + ---------- + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fourier : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pressure : (18,) numpy.ndarray + Pressure contributions from various energy terms. + 0: due to kinetic energy + 1-5: due to field energy + 6-8: due to two-particle bonded terms + 9-11: due to three-particle bonded terms (called angle terms) + 12-14: due to four-particle bonded terms (called dihedral terms) + (defaults to 0 currently. Yet to be implemented) + 15-17: total pressure in x,y,z directions. + """ + rank = comm.Get_rank() + size = comm.Get_size() + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + w_elec = 0.0 + if (config.coulombtype == "PIC_Spectral_GPE") or ( + config.coulombtype == "PIC_Spectral" + ): + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + w = w_0 + w_elec + + # Kinetic term + kinetic_energy = 0.5 * config.mass * np.sum(velocities**2) + p_kin = 2 / (3 * V) * kinetic_energy + + # Term 1 + p0 = -1 / V * np.sum(w) + + # Term 2 + if psi is not None: # if using electrostatics + V_bar = np.array([hamiltonian.V_bar[k]([phi, psi]) for k in range(config.n_types)]) + else: + V_bar = np.array([hamiltonian.V_bar_0[k](phi) for k in range(config.n_types)]) + + p1 = np.sum((volume_per_cell / V) * V_bar * phi) + + # Term 3 + comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, + ) + + p2 = np.sum( + volume_per_cell + / V + * config.sigma**2 + * np.repeat(V_bar[:, np.newaxis, :, :, :], 3, axis=1) + * phi_laplacian, + axis=(0, 2, 3, 4), + ) + + # Bonded force term: linking 2 particles + p_bond = bond_pr / V + + # Angle force term: linking 3 particles + p_angle = angle_pr / V + + # TODO: Dihedral angle force term: linking 4 atoms + p_dihedral = np.zeros(3) + + # Add formal parameter dihedral_forces as: comp_pressure(..., dihedral_forces) + # Define dictionary: + # forces = { + # 'x': dihedral_forces[:,0], + # 'y': dihedral_forces[:,1], + # 'z': dihedral_forces[:,2] + # } + # Compute the pressure due to dihedrals as: + # p_dihedral = { + # 'x': np.sum( np.multiply(forces['x'],positions[:,0]) )*(1/V), + # 'y': np.sum( np.multiply(forces['y'],positions[:,1]) )*(1/V), + # 'z': np.sum( np.multiply(forces['z'],positions[:,2]) )*(1/V) + # } + + # Total pressure in x, y, z + p_tot = p_kin + p0 + p1 + p2 + p_bond + p_angle + p_dihedral + + return_value = np.array( + [ + p_kin, + p0, + p1, + p2[0], + p2[1], + p2[2], + p_bond[0], + p_bond[1], + p_bond[2], + p_angle[0], + p_angle[1], + p_angle[2], + p_dihedral[0], + p_dihedral[1], + p_dihedral[2], + p_tot[0], + p_tot[1], + p_tot[2], + ] + ) + return_value = comm.allreduce(return_value, MPI.SUM) + + return return_value
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/_modules/hymd/thermostat.html b/v2.0.1/_modules/hymd/thermostat.html new file mode 100644 index 00000000..168d684a --- /dev/null +++ b/v2.0.1/_modules/hymd/thermostat.html @@ -0,0 +1,509 @@ + + + + + + hymd.thermostat — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.thermostat

+"""Scales or otherwise modifies the particle velocities during simulation to
+simulate coupling to an external heat bath with temperature T₀.
+"""
+import numpy as np
+import logging
+from mpi4py import MPI
+from typing import Callable
+from .logger import Logger
+from .input_parser import Config
+
+
+def cancel_com_momentum(velocities, config, comm=MPI.COMM_WORLD):
+    com_velocity = comm.allreduce(np.sum(velocities[...], axis=0), MPI.SUM)
+    velocities[...] = velocities[...] - com_velocity / config.n_particles
+    return velocities
+
+
+def generate_initial_velocities(velocities, config, prng, comm=MPI.COMM_WORLD):
+    kT_start = config.gas_constant * config.start_temperature
+    n_particles_ = velocities.shape[0]
+    velocities[...] = prng.normal(
+        loc=0, scale=kT_start / config.mass, size=(n_particles_, 3)
+    )
+    velocities = cancel_com_momentum(velocities, config, comm=comm)
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    start_kinetic_energy_target = (
+        1.5 * config.gas_constant * config.n_particles * config.start_temperature
+    )
+    factor = np.sqrt(1.5 * config.n_particles * kT_start / kinetic_energy)
+    velocities[...] = velocities[...] * factor
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    Logger.rank0.log(
+        logging.INFO,
+        (
+            f"Initialized {config.n_particles} velocities, target kinetic "
+            f"energy: {start_kinetic_energy_target}, actual kinetic energy "
+            f"generated: {kinetic_energy}"
+        ),
+    )
+    return velocities
+
+
+
[docs]def _random_gaussian(prng: np.random.Generator) -> float: + """Draw a single random number from the standard normal distribution + Generate a number from the Gaussian distribution centered at zero with unit + standard deviation, :math:`N(0, 1)`. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + + Returns + ------- + float + A random number drawn from :math:`N(0, 1)`. + """ + return prng.normal()
+ + +
[docs]def _random_chi_squared(prng: np.random.Generator, M: int) -> float: + """Draw the sum of :code:`M` squared normally distributed values + + The value is generated by the Gamma distribution, in lieu of generating + :code:`M` Gaussian distributed numbers and summing their squares. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + M : int + Number of standard normally distributed numbers in the sum. + + Returns + ------- + float + The sum of :code:`M` squared normally distributed values centered at + zero with unit standard deviation. + + Notes + ----- + The sum of the squares of k independent standard normal random variables is + distributed according to a :math:`\\chi^2` distribution. + + .. math:: + + \\chi^2_1 + \\chi_2^2 + \\chi_3^2 + \\dots + \\chi_M^2 + \\sim + \\sigma^2\\chi^2(k) + + This is a special case of the :math:`\\Gamma` distribution, + :math:`\\Gamma(k/2, 2)`, and may be generated by + + .. math:: + + \\chi^2(k) \\sim 2 \\Gamma(k/2, 2) + + References + ---------- + Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of + Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. + J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246. + """ + return prng.chisquare(M)
+ + +
[docs]def csvr_thermostat( + velocity: np.ndarray, + names: np.ndarray, + config: Config, + prng: np.random.Generator, + comm: MPI.Intracomm = MPI.COMM_WORLD, + random_gaussian: Callable[[np.random.Generator], float] = _random_gaussian, + random_chi_squared: Callable[ + [np.random.Generator, int, float], float + ] = _random_chi_squared, + remove_center_of_mass_momentum: bool = True, +) -> np.ndarray: + """Canonical sampling through velocity rescaling thermostat + + Implements the CSVR thermostat. Rescales the system kinetic energy by a + stochastically chosen factor to keep the temperature constant. Requires + communcation of the kinetic energies calculated locally for each MPI rank. + The random numbers sampled through :code:`random_gaussian` and + :code:`random_chi_squared` are broadcast from the root rank to the other + ranks to ensure the scaling is performed with the same stochasticity for + all particles in the full system. + + The velocities are cleaned of center of mass momentum before the thermostat + is applied, and the center of mass momentum is subsequently reapplied. This + is performed for each thermostat coupling group, i.e. the center of mass + momenta of each *group* is separately removed and reapplied after + thermostatting. + + The implementation here is based on the derivation presented in the 2008 + Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper. + + Parameters + ---------- + velocity : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + names : (N,) numpy.ndarray + Array of particle names. + config : Config + Configuration dataclass containing simulation metadata and parameters. + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + random_gaussian : callable, optional + Function for generating standard normally distributed numbers. + random_chi_squared : callable, optional + Function for generating :math:`\\chi^2`-distributed numbers + remove_center_of_mass_momentum : bool, optional + If True, the center of mass of each coupling group is removed before + the thermostat is applied. The center of mass momenta are added back + after the kinetic energy rescaling is complete. + + See Also + -------- + _random_gaussian : + Used to sample Gaussian-distributed numbers. + _random_chi_squared : + Used to sample :math:`\\chi^2`-distributed numbers. + hymd.input_parser.Config : + Configuration dataclass handler. + + References + ---------- + G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). + G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008). + """ + if not any(config.thermostat_coupling_groups): + config.thermostat_coupling_groups = [config.unique_names.copy()] + for i, group in enumerate(config.thermostat_coupling_groups): + ind = np.where( + np.logical_or.reduce(list(names == np.string_(t) for t in group)) + ) + group_n_particles = comm.allreduce(len(ind[0]), MPI.SUM) + + # Clean velocities of center of mass momentum + if remove_center_of_mass_momentum and group_n_particles > 1: + com_velocity = comm.allreduce(np.sum(velocity[ind], axis=0)) + velocity_clean = velocity[ind] - com_velocity / group_n_particles + K = comm.allreduce(0.5 * config.mass * np.sum(velocity_clean[...] ** 2)) + else: + K = comm.allreduce(0.5 * config.mass * np.sum(velocity[...] ** 2)) + K_target = ( + 1.5 * config.gas_constant * group_n_particles * config.target_temperature + ) + N_f = 3 * group_n_particles + c = np.exp(-(config.time_step * config.respa_inner) / config.tau) + + # Random numbers are identical across ranks because all ranks have + # the same prng after the initialization of the velocities + R = random_gaussian(prng) + SNf = random_chi_squared(prng, N_f - 1) + + alpha2 = ( + c + + (1 - c) * (SNf + R**2) * K_target / (N_f * K) + + 2 * R * np.sqrt(c * (1 - c) * K_target / (N_f * K)) + ) + dK = K * (alpha2 - 1) + alpha = np.sqrt(alpha2) + + if remove_center_of_mass_momentum and group_n_particles > 1: + # Assign velocities and reapply the previously removed center + # of mass momentum removed + velocity_clean *= alpha + velocity[ind] = velocity_clean + com_velocity / group_n_particles + else: + velocity *= alpha + config.thermostat_work += dK
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/_modules/index.html b/v2.0.1/_modules/index.html new file mode 100644 index 00000000..b9e06f73 --- /dev/null +++ b/v2.0.1/_modules/index.html @@ -0,0 +1,299 @@ + + + + + + Overview: module code — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/v2.0.1/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css new file mode 100644 index 00000000..1b057df2 --- /dev/null +++ b/v2.0.1/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css @@ -0,0 +1 @@ +.badge{border-radius:.25rem;display:inline-block;font-size:75%;font-weight:700;line-height:1;padding:.25em .4em;text-align:center;vertical-align:baseline;white-space:nowrap}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{border-radius:10rem;padding-left:.6em;padding-right:.6em}.badge-primary{background-color:#007bff;color:#fff}.badge-primary[href]:focus,.badge-primary[href]:hover{background-color:#0062cc;color:#fff;text-decoration:none}.badge-secondary{background-color:#6c757d;color:#fff}.badge-secondary[href]:focus,.badge-secondary[href]:hover{background-color:#545b62;color:#fff;text-decoration:none}.badge-success{background-color:#28a745;color:#fff}.badge-success[href]:focus,.badge-success[href]:hover{background-color:#1e7e34;color:#fff;text-decoration:none}.badge-info{background-color:#17a2b8;color:#fff}.badge-info[href]:focus,.badge-info[href]:hover{background-color:#117a8b;color:#fff;text-decoration:none}.badge-warning{background-color:#ffc107;color:#212529}.badge-warning[href]:focus,.badge-warning[href]:hover{background-color:#d39e00;color:#212529;text-decoration:none}.badge-danger{background-color:#dc3545;color:#fff}.badge-danger[href]:focus,.badge-danger[href]:hover{background-color:#bd2130;color:#fff;text-decoration:none}.badge-light{background-color:#f8f9fa;color:#212529}.badge-light[href]:focus,.badge-light[href]:hover{background-color:#dae0e5;color:#212529;text-decoration:none}.badge-dark{background-color:#343a40;color:#fff}.badge-dark[href]:focus,.badge-dark[href]:hover{background-color:#1d2124;color:#fff;text-decoration:none}.border-0{border:0 !important}.border-top-0{border-top:0 !important}.border-right-0{border-right:0 !important}.border-bottom-0{border-bottom:0 !important}.border-left-0{border-left:0 !important}.p-0{padding:0 !important}.pt-0,.py-0{padding-top:0 !important}.pr-0,.px-0{padding-right:0 !important}.pb-0,.py-0{padding-bottom:0 !important}.pl-0,.px-0{padding-left:0 !important}.p-1{padding:.25rem !important}.pt-1,.py-1{padding-top:.25rem !important}.pr-1,.px-1{padding-right:.25rem !important}.pb-1,.py-1{padding-bottom:.25rem !important}.pl-1,.px-1{padding-left:.25rem !important}.p-2{padding:.5rem !important}.pt-2,.py-2{padding-top:.5rem !important}.pr-2,.px-2{padding-right:.5rem !important}.pb-2,.py-2{padding-bottom:.5rem !important}.pl-2,.px-2{padding-left:.5rem !important}.p-3{padding:1rem !important}.pt-3,.py-3{padding-top:1rem !important}.pr-3,.px-3{padding-right:1rem !important}.pb-3,.py-3{padding-bottom:1rem !important}.pl-3,.px-3{padding-left:1rem !important}.p-4{padding:1.5rem !important}.pt-4,.py-4{padding-top:1.5rem !important}.pr-4,.px-4{padding-right:1.5rem !important}.pb-4,.py-4{padding-bottom:1.5rem !important}.pl-4,.px-4{padding-left:1.5rem !important}.p-5{padding:3rem !important}.pt-5,.py-5{padding-top:3rem !important}.pr-5,.px-5{padding-right:3rem !important}.pb-5,.py-5{padding-bottom:3rem !important}.pl-5,.px-5{padding-left:3rem !important}.m-0{margin:0 !important}.mt-0,.my-0{margin-top:0 !important}.mr-0,.mx-0{margin-right:0 !important}.mb-0,.my-0{margin-bottom:0 !important}.ml-0,.mx-0{margin-left:0 !important}.m-1{margin:.25rem !important}.mt-1,.my-1{margin-top:.25rem !important}.mr-1,.mx-1{margin-right:.25rem !important}.mb-1,.my-1{margin-bottom:.25rem !important}.ml-1,.mx-1{margin-left:.25rem !important}.m-2{margin:.5rem !important}.mt-2,.my-2{margin-top:.5rem !important}.mr-2,.mx-2{margin-right:.5rem !important}.mb-2,.my-2{margin-bottom:.5rem !important}.ml-2,.mx-2{margin-left:.5rem !important}.m-3{margin:1rem !important}.mt-3,.my-3{margin-top:1rem !important}.mr-3,.mx-3{margin-right:1rem !important}.mb-3,.my-3{margin-bottom:1rem !important}.ml-3,.mx-3{margin-left:1rem !important}.m-4{margin:1.5rem !important}.mt-4,.my-4{margin-top:1.5rem !important}.mr-4,.mx-4{margin-right:1.5rem !important}.mb-4,.my-4{margin-bottom:1.5rem !important}.ml-4,.mx-4{margin-left:1.5rem !important}.m-5{margin:3rem !important}.mt-5,.my-5{margin-top:3rem !important}.mr-5,.mx-5{margin-right:3rem !important}.mb-5,.my-5{margin-bottom:3rem !important}.ml-5,.mx-5{margin-left:3rem !important}.btn{background-color:transparent;border:1px solid transparent;border-radius:.25rem;color:#212529;cursor:pointer;display:inline-block;font-size:1rem;font-weight:400;line-height:1.5;padding:.375rem .75rem;text-align:center;transition:color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none;vertical-align:middle}.btn:hover{color:#212529;text-decoration:none}.btn:visited{color:#212529}.btn.focus,.btn:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.25);outline:0}.btn.disabled,.btn:disabled{opacity:.65}@media (prefers-reduced-motion: reduce){.btn{transition:none}}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary:visited{color:#fff}.btn-primary:hover{background-color:#0069d9;border-color:#0062cc;color:#fff}.btn-primary.focus,.btn-primary:focus{background-color:#0069d9;border-color:#0062cc;box-shadow:0 0 0 .2rem rgba(0,123,255,0.5);color:#fff}.btn-primary.disabled,.btn-primary:disabled{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary.active:not(:disabled):not(.disabled),.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{background-color:#0062cc;border-color:#005cbf;color:#fff}.btn-primary.active:not(:disabled):not(.disabled):focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-secondary{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary:visited{color:#fff}.btn-secondary:hover{background-color:#5a6268;border-color:#545b62;color:#fff}.btn-secondary.focus,.btn-secondary:focus{background-color:#5a6268;border-color:#545b62;box-shadow:0 0 0 .2rem rgba(108,117,125,0.5);color:#fff}.btn-secondary.disabled,.btn-secondary:disabled{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled),.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{background-color:#545b62;border-color:#4e555b;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled):focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-success{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success:visited{color:#fff}.btn-success:hover{background-color:#218838;border-color:#1e7e34;color:#fff}.btn-success.focus,.btn-success:focus{background-color:#218838;border-color:#1e7e34;box-shadow:0 0 0 .2rem rgba(40,167,69,0.5);color:#fff}.btn-success.disabled,.btn-success:disabled{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success.active:not(:disabled):not(.disabled),.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{background-color:#1e7e34;border-color:#1c7430;color:#fff}.btn-success.active:not(:disabled):not(.disabled):focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-info{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info:visited{color:#fff}.btn-info:hover{background-color:#138496;border-color:#117a8b;color:#fff}.btn-info.focus,.btn-info:focus{background-color:#138496;border-color:#117a8b;box-shadow:0 0 0 .2rem rgba(23,162,184,0.5);color:#fff}.btn-info.disabled,.btn-info:disabled{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info.active:not(:disabled):not(.disabled),.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{background-color:#117a8b;border-color:#10707f;color:#fff}.btn-info.active:not(:disabled):not(.disabled):focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-warning{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning:visited{color:#212529}.btn-warning:hover{background-color:#e0a800;border-color:#d39e00;color:#212529}.btn-warning.focus,.btn-warning:focus{background-color:#e0a800;border-color:#d39e00;box-shadow:0 0 0 .2rem rgba(255,193,7,0.5);color:#212529}.btn-warning.disabled,.btn-warning:disabled{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning.active:not(:disabled):not(.disabled),.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{background-color:#d39e00;border-color:#c69500;color:#212529}.btn-warning.active:not(:disabled):not(.disabled):focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-danger{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger:visited{color:#fff}.btn-danger:hover{background-color:#c82333;border-color:#bd2130;color:#fff}.btn-danger.focus,.btn-danger:focus{background-color:#c82333;border-color:#bd2130;box-shadow:0 0 0 .2rem rgba(220,53,69,0.5);color:#fff}.btn-danger.disabled,.btn-danger:disabled{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger.active:not(:disabled):not(.disabled),.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{background-color:#bd2130;border-color:#b21f2d;color:#fff}.btn-danger.active:not(:disabled):not(.disabled):focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-light{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light:visited{color:#212529}.btn-light:hover{background-color:#e2e6ea;border-color:#dae0e5;color:#212529}.btn-light.focus,.btn-light:focus{background-color:#e2e6ea;border-color:#dae0e5;box-shadow:0 0 0 .2rem rgba(248,249,250,0.5);color:#212529}.btn-light.disabled,.btn-light:disabled{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light.active:not(:disabled):not(.disabled),.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{background-color:#dae0e5;border-color:#d3d9df;color:#212529}.btn-light.active:not(:disabled):not(.disabled):focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-dark{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark:visited{color:#fff}.btn-dark:hover{background-color:#23272b;border-color:#1d2124;color:#fff}.btn-dark.focus,.btn-dark:focus{background-color:#23272b;border-color:#1d2124;box-shadow:0 0 0 .2rem rgba(52,58,64,0.5);color:#fff}.btn-dark.disabled,.btn-dark:disabled{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark.active:not(:disabled):not(.disabled),.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{background-color:#1d2124;border-color:#171a1d;color:#fff}.btn-dark.active:not(:disabled):not(.disabled):focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-primary{border-color:#007bff;color:#007bff}.btn-outline-primary:visited{color:#007bff}.btn-outline-primary:hover{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{background-color:transparent;color:#007bff}.btn-outline-primary.active:not(:disabled):not(.disabled),.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.active:not(:disabled):not(.disabled):focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-secondary{border-color:#6c757d;color:#6c757d}.btn-outline-secondary:visited{color:#6c757d}.btn-outline-secondary:hover{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{background-color:transparent;color:#6c757d}.btn-outline-secondary.active:not(:disabled):not(.disabled),.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.active:not(:disabled):not(.disabled):focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-success{border-color:#28a745;color:#28a745}.btn-outline-success:visited{color:#28a745}.btn-outline-success:hover{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{background-color:transparent;color:#28a745}.btn-outline-success.active:not(:disabled):not(.disabled),.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.active:not(:disabled):not(.disabled):focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-info{border-color:#17a2b8;color:#17a2b8}.btn-outline-info:visited{color:#17a2b8}.btn-outline-info:hover{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{background-color:transparent;color:#17a2b8}.btn-outline-info.active:not(:disabled):not(.disabled),.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.active:not(:disabled):not(.disabled):focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-warning{border-color:#ffc107;color:#ffc107}.btn-outline-warning:visited{color:#ffc107}.btn-outline-warning:hover{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{background-color:transparent;color:#ffc107}.btn-outline-warning.active:not(:disabled):not(.disabled),.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.active:not(:disabled):not(.disabled):focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-danger{border-color:#dc3545;color:#dc3545}.btn-outline-danger:visited{color:#dc3545}.btn-outline-danger:hover{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{background-color:transparent;color:#dc3545}.btn-outline-danger.active:not(:disabled):not(.disabled),.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.active:not(:disabled):not(.disabled):focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-light{border-color:#f8f9fa;color:#f8f9fa}.btn-outline-light:visited{color:#f8f9fa}.btn-outline-light:hover{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{background-color:transparent;color:#f8f9fa}.btn-outline-light.active:not(:disabled):not(.disabled),.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.active:not(:disabled):not(.disabled):focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-dark{border-color:#343a40;color:#343a40}.btn-outline-dark:visited{color:#343a40}.btn-outline-dark:hover{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{background-color:transparent;color:#343a40}.btn-outline-dark.active:not(:disabled):not(.disabled),.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.active:not(:disabled):not(.disabled):focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-link{color:#007bff;font-weight:400;text-decoration:none}.btn-link:hover{color:#0056b3;text-decoration:underline}.btn-link.focus,.btn-link:focus{box-shadow:none;text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{border-radius:.3rem;font-size:1.25rem;line-height:1.5;padding:.5rem 1rem}.btn-group-sm>.btn,.btn-sm{border-radius:.2rem;font-size:.875rem;line-height:1.5;padding:.25rem .5rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input.btn-block[type=button],input.btn-block[type=reset],input.btn-block[type=submit]{width:100%}.stretched-link::after{background-color:rgba(0,0,0,0);bottom:0;content:'';left:0;pointer-events:auto;position:absolute;right:0;top:0;z-index:1}.text-wrap{white-space:normal !important}.card{background-clip:border-box;background-color:#fff;border:1px solid rgba(0,0,0,0.125);border-radius:.25rem;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;min-width:0;position:relative;word-wrap:break-word}.card>hr{margin-left:0;margin-right:0}.card>.list-group:first-child .list-group-item:first-child{border-top-left-radius:.25rem;border-top-right-radius:.25rem}.card>.list-group:last-child .list-group-item:last-child{border-bottom-left-radius:.25rem;border-bottom-right-radius:.25rem}.card-body{-ms-flex:1 1 auto;flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-bottom:0;margin-top:-.375rem}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{background-color:rgba(0,0,0,0.03);border-bottom:1px solid rgba(0,0,0,0.125);margin-bottom:0;padding:.75rem 1.25rem}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-header+.list-group .list-group-item:first-child{border-top:0}.card-footer{background-color:rgba(0,0,0,0.03);border-top:1px solid rgba(0,0,0,0.125);padding:.75rem 1.25rem}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{border-bottom:0;margin-bottom:-.75rem;margin-left:-.625rem;margin-right:-.625rem}.card-header-pills{margin-left:-.625rem;margin-right:-.625rem}.card-img-overlay{bottom:0;left:0;padding:1.25rem;position:absolute;right:0;top:0}.card-img,.card-img-bottom,.card-img-top{-ms-flex-negative:0;flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-left-radius:calc(.25rem - 1px);border-bottom-right-radius:calc(.25rem - 1px)}.w-100{width:100% !important}.shadow{box-shadow:0 0.5rem 1rem rgba(0,0,0,0.15) !important}.bg-primary{background-color:#007bff !important}button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc !important}a.bg-primary:focus,a.bg-primary:hover{background-color:#0062cc !important}a.text-primary:focus,a.text-primary:hover{color:#121416 !important}.bg-secondary{background-color:#6c757d !important}button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62 !important}a.bg-secondary:focus,a.bg-secondary:hover{background-color:#545b62 !important}a.text-secondary:focus,a.text-secondary:hover{color:#121416 !important}.bg-success{background-color:#28a745 !important}button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34 !important}a.bg-success:focus,a.bg-success:hover{background-color:#1e7e34 !important}a.text-success:focus,a.text-success:hover{color:#121416 !important}.bg-info{background-color:#17a2b8 !important}button.bg-info:focus,button.bg-info:hover{background-color:#117a8b !important}a.bg-info:focus,a.bg-info:hover{background-color:#117a8b !important}a.text-info:focus,a.text-info:hover{color:#121416 !important}.bg-warning{background-color:#ffc107 !important}button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00 !important}a.bg-warning:focus,a.bg-warning:hover{background-color:#d39e00 !important}a.text-warning:focus,a.text-warning:hover{color:#121416 !important}.bg-danger{background-color:#dc3545 !important}button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130 !important}a.bg-danger:focus,a.bg-danger:hover{background-color:#bd2130 !important}a.text-danger:focus,a.text-danger:hover{color:#121416 !important}.bg-light{background-color:#f8f9fa !important}button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5 !important}a.bg-light:focus,a.bg-light:hover{background-color:#dae0e5 !important}a.text-light:focus,a.text-light:hover{color:#121416 !important}.bg-dark{background-color:#343a40 !important}button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124 !important}a.bg-dark:focus,a.bg-dark:hover{background-color:#1d2124 !important}a.text-dark:focus,a.text-dark:hover{color:#121416 !important}.bg-white{background-color:#fff !important}button.bg-white:focus,button.bg-white:hover{background-color:#e6e6e6 !important}a.bg-white:focus,a.bg-white:hover{background-color:#e6e6e6 !important}a.text-white:focus,a.text-white:hover{color:#121416 !important}.text-primary{color:#007bff !important}.text-secondary{color:#6c757d !important}.text-success{color:#28a745 !important}.text-info{color:#17a2b8 !important}.text-warning{color:#ffc107 !important}.text-danger{color:#dc3545 !important}.text-light{color:#f8f9fa !important}.text-dark{color:#343a40 !important}.text-white{color:#fff !important}.text-body{color:#212529 !important}.text-muted{color:#6c757d !important}.text-black-50{color:rgba(0,0,0,0.5) !important}.text-white-50{color:rgba(255,255,255,0.5) !important}.bg-transparent{background-color:transparent !important}.text-justify{text-align:justify !important}.text-left{text-align:left !important}.text-right{text-align:right !important}.text-center{text-align:center !important}.font-weight-light{font-weight:300 !important}.font-weight-lighter{font-weight:lighter !important}.font-weight-normal{font-weight:400 !important}.font-weight-bold{font-weight:700 !important}.font-weight-bolder{font-weight:bolder !important}.font-italic{font-style:italic !important}.container{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container{max-width:540px}}@media (min-width: 768px){.container{max-width:720px}}@media (min-width: 992px){.container{max-width:960px}}@media (min-width: 1200px){.container{max-width:1140px}}.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container,.container-sm{max-width:540px}}@media (min-width: 768px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width: 992px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width: 1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1140px}}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;margin-right:-15px}.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{padding-left:15px;padding-right:15px;position:relative;width:100%}@media (min-width: 576px){.col-sm{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-sm-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-sm-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-sm-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-sm-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-sm-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 768px){.col-md{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-md-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-md-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-md-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-md-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-md-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 992px){.col-lg{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-lg-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-lg-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-lg-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-lg-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-lg-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 1200px){.col-xl{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-xl-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-xl-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-xl-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-xl-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-xl-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}.d-flex{display:-ms-flexbox !important;display:flex !important}.sphinx-bs,.sphinx-bs *{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sphinx-bs p{margin-top:0} diff --git a/v2.0.1/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/v2.0.1/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css new file mode 100644 index 00000000..fc14abc8 --- /dev/null +++ b/v2.0.1/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css @@ -0,0 +1 @@ +details.dropdown .summary-title{padding-right:3em !important;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none}details.dropdown:hover{cursor:pointer}details.dropdown .summary-content{cursor:default}details.dropdown summary{list-style:none;padding:1em}details.dropdown summary .octicon.no-title{vertical-align:middle}details.dropdown[open] summary .octicon.no-title{visibility:hidden}details.dropdown summary::-webkit-details-marker{display:none}details.dropdown summary:focus{outline:none}details.dropdown summary:hover .summary-up svg,details.dropdown summary:hover .summary-down svg{opacity:1}details.dropdown .summary-up svg,details.dropdown .summary-down svg{display:block;opacity:.6}details.dropdown .summary-up,details.dropdown .summary-down{pointer-events:none;position:absolute;right:1em;top:.75em}details.dropdown[open] .summary-down{visibility:hidden}details.dropdown:not([open]) .summary-up{visibility:hidden}details.dropdown.fade-in[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out;animation:panels-fade-in .5s ease-in-out}details.dropdown.fade-in-slide-down[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out}@keyframes panels-fade-in{0%{opacity:0}100%{opacity:1}}@keyframes panels-slide-down{0%{transform:translate(0, -10px)}100%{transform:translate(0, 0)}}.octicon{display:inline-block;fill:currentColor;vertical-align:text-top}.tabbed-content{box-shadow:0 -.0625rem var(--tabs-color-overline),0 .0625rem var(--tabs-color-underline);display:none;order:99;padding-bottom:.75rem;padding-top:.75rem;width:100%}.tabbed-content>:first-child{margin-top:0 !important}.tabbed-content>:last-child{margin-bottom:0 !important}.tabbed-content>.tabbed-set{margin:0}.tabbed-set{border-radius:.125rem;display:flex;flex-wrap:wrap;margin:1em 0;position:relative}.tabbed-set>input{opacity:0;position:absolute}.tabbed-set>input:checked+label{border-color:var(--tabs-color-label-active);color:var(--tabs-color-label-active)}.tabbed-set>input:checked+label+.tabbed-content{display:block}.tabbed-set>input:focus+label{outline-style:auto}.tabbed-set>input:not(.focus-visible)+label{outline:none;-webkit-tap-highlight-color:transparent}.tabbed-set>label{border-bottom:.125rem solid transparent;color:var(--tabs-color-label-inactive);cursor:pointer;font-size:var(--tabs-size-label);font-weight:700;padding:1em 1.25em .5em;transition:color 250ms;width:auto;z-index:1}html .tabbed-set>label:hover{color:var(--tabs-color-label-active)} diff --git a/v2.0.1/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css b/v2.0.1/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css new file mode 100644 index 00000000..adc61662 --- /dev/null +++ b/v2.0.1/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css @@ -0,0 +1,7 @@ +:root { +--tabs-color-label-active: hsla(231, 99%, 66%, 1); +--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); +--tabs-color-overline: rgb(207, 236, 238); +--tabs-color-underline: rgb(207, 236, 238); +--tabs-size-label: 1rem; +} \ No newline at end of file diff --git a/v2.0.1/_sources/doc_pages/api.rst.txt b/v2.0.1/_sources/doc_pages/api.rst.txt new file mode 100644 index 00000000..40f0838c --- /dev/null +++ b/v2.0.1/_sources/doc_pages/api.rst.txt @@ -0,0 +1,116 @@ +.. _api-label: + + +API reference +============= + +Integrator +---------- + +.. automodule:: hymd.integrator + :members: + + +Thermostat +---------- + +.. automodule:: hymd.thermostat + :members: csvr_thermostat, _random_chi_squared, _random_gaussian + :undoc-members: + + +Barostat +-------- + +Berendsen Barostat +^^^^^^^^^^^^^^^^^^ + +.. automodule:: hymd.barostat + :members: isotropic, semiisotropic + :undoc-members: + +SCR Barostat +^^^^^^^^^^^^^^^^^^ + +.. automodule:: hymd.barostat_bussi + :members: isotropic, semiisotropic + :undoc-members: + + +Hamiltonian +----------- + +.. autoclass:: hymd.hamiltonian.Hamiltonian + :members: + + .. automethod:: __init__ + + .. automethod:: _setup + +.. autoclass:: hymd.hamiltonian.SquaredPhi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultNoChi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultWithChi + :members: + + .. automethod:: __init__ + + +Force +----- + +.. automodule:: hymd.force + :members: + :undoc-members: + + +Pressure +-------- + +.. automodule:: hymd.pressure + :members: comp_pressure + :undoc-members: + + +Logger +------ + +.. autoclass:: hymd.logger.Logger + :members: + +.. autoclass:: hymd.logger.MPIFilterRoot + :members: + +.. autoclass:: hymd.logger.MPIFilterAll + :members: + + +Input parser +------------ + +.. automodule:: hymd.input_parser + :members: + :undoc-members: propensity_potential_coeffs + + +Field +----- + +.. automodule:: hymd.field + :members: + + +File input/output +----------------- + +.. automodule:: hymd.file_io + :members: diff --git a/v2.0.1/_sources/doc_pages/benchmarks.rst.txt b/v2.0.1/_sources/doc_pages/benchmarks.rst.txt new file mode 100644 index 00000000..06377a85 --- /dev/null +++ b/v2.0.1/_sources/doc_pages/benchmarks.rst.txt @@ -0,0 +1,93 @@ +.. _benchmarks-label: + +Benchmarks +########## +Homopolymer melt test systems of :math:`30^2`, :math:`40^2`, and :math:`50^2` +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively. + +Bonded forces +^^^^^^^^^^^^^ +Legend label denotes the number of particles in the system. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) + time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 + ], dtype=np.float64) + nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 + ], dtype=np.float64,) + time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, + ], dtype=np.float64) + nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 + ], dtype=np.float64) + time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, + ], dtype=np.float64) + plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" + ) + plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" + ) + plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" + ) + plt.xlabel("CPUs", fontsize=15) + plt.ylabel("Time per step, us", fontsize=15) + plt.legend(fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.show() + + +Particle--field forces +^^^^^^^^^^^^^^^^^^^^^^ +Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + + mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] + mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + + mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + + mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + + mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] + mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + + mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + + mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + + plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") + plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") + plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") + plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") + plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") + plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") + plt.xlabel("CPUs", fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.ylabel("Time per step, s", fontsize=15) + plt.legend(loc="upper left", fontsize=15) + plt.show() diff --git a/v2.0.1/_sources/doc_pages/command_line.rst.txt b/v2.0.1/_sources/doc_pages/command_line.rst.txt new file mode 100644 index 00000000..5233710f --- /dev/null +++ b/v2.0.1/_sources/doc_pages/command_line.rst.txt @@ -0,0 +1,120 @@ +.. _commandline-label: + +Command line arguments +###################### +Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle--field interactions. + + +Required arguments +================== +:configuration file: + :code:`type` positional + + Specifies the :code:`.toml` format configuration file containing simulation details. See :ref:`config-label` for details. + +:structure and topology file: + :code:`type` positional + + Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See :ref:`topology-label` for details. + +Optional arguments +================== +:code:`-v --verbose` + :code:`type` optional + + Number of following arguments: :code:`0` or :code:`1` + + Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying :code:`-v` or :code:`--verbose` with no additional specification. This increases verbosity level by :code:`1`. Alternatively, it maye be specified by :code:`--verbose V` with :code:`V` being :code:`0`, :code:`1`, or :code:`2`. + +:code:`--profile` + :code:`type` optional + + Number of following arguments: :code:`0` + + Enables code profiling using :code:`cProfile`. This will output one profiling file per MPI rank invoked in the simulation. + +:code:`--double-precision` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision internally in HyMD (including in the FFTs). + +:code:`--double-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision in the output trajectory from HyMD. + +:code:`--velocity-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that velocities should be output to the HyMD trajectory. + +:code:`--force-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that forces should be output to the HyMD trajectory. + +:code:`--disable-mpio` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult. + +:code:`--logfile` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the path of a plain text log file in which stdout is mirrored during simulation runs. + +:code:`--seed` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the random seed used in the :code:`numpy` random library to generate velocities, thermostatting, etc. + +:code:`--disable-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any two-particle bonds present in the system. + +:code:`--disable-angle-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any three-particle bonds present in the system. + +:code:`--disable-dihedrals` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any four-particle bonds present in the system. + +:code:`--disable-dipole` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any topological reconstruction of peptide backbone dipoles present in the system. + +:code:`--disable-field` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any particle--field interactions present in the system. diff --git a/v2.0.1/_sources/doc_pages/config_file.rst.txt b/v2.0.1/_sources/doc_pages/config_file.rst.txt new file mode 100644 index 00000000..2ee880b7 --- /dev/null +++ b/v2.0.1/_sources/doc_pages/config_file.rst.txt @@ -0,0 +1,244 @@ +.. _config-label: + +Configuration file +################## +The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order. + +The configuration file is a `toml`_ format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs. + +.. _`toml`: + https://github.com/toml-lang/toml + +.. role:: required + +Configuration file keywords +--------------------------- + +The following constitutes every possible keyword specification in HyMD +configuration files: + +Metadata keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying metadata for the H5MD output trajectory. + +:name: + :code:`string` [**optional**, default: :code:`None`] + + Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file. + + +:tags: + :code:`array` [:code:`string`] [**optional**, default: :code:`None`] + + Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file. + + +Particle keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying properties of particles and molecules in the +system. + +:n_particles: + :code:`integer` [**optional**, default: :code:`None`] + + Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules. + +:mass: + :code:`float` [**optional**, default: :code:`72.0`] {units: :math:`\text{u}=\text{g}\,\text{mol}^{-1}`} + + Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal. + +:max_molecule_size: + :code:`integer` [**optional**, default: :code:`201`] + + Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code **will** crash if there are molecules larger than :code:`max_molecule_size` in the topology/structure input file. + + +Simulation keywords +^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying simulation parameters. + +:n_steps: + :code:`integer` [:required:`required`] + + Total number of integration steps to perform for this simulation. + +:n_print: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of *number of time steps*). + +:n_flush: + :code:`integer` [**optional**, default: :code:`None`] + + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of *number of* :code:`n_print`, i.e. :code:`n_print = 13`, :code:`n_flush = 3` would result in the trajectory/energy being written to disk every :code:`13 x 3 = 39` *simulation steps*) + +:time_step: + :code:`float` [:required:`required`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time step per integration step. If the rRESPA multiple time step integrator is used (:code:`integrator = "respa"`), this specifies the **inner** time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is :code:`respa_inner` times the :code:`time_step` , and the total simulation time is :code:`n_steps` times :code:`time_step` times :code:`respa_inner` . + +:box_size: + :code:`array` [:code:`float`] [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable. + +:integrator: + :code:`string` [:required:`required`] (options: :code:`velocity-verlet` or :code:`respa`) + + Specifies the time integrator used in the simulation. If :code:`respa`, the *reversible reference system propagator algorithm (rRESPA)* :cite:`tuckerman1992reversible` integrator is used, with :code:`respa_inner` number of inner (intramolecular force) time steps. If :code:`velocity-verlet`, a normal Velocity Verlet integrator is used. If :code:`respa` and :code:`respa_inner = 1`, the rRESPA integrator is equivalent to the Velocity Verlet. + +:respa_inner: + :code:`integer` [**optional**, default: :code:`1`] + + The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces. + +:domain_decomposition: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Specifies the interval (in time steps) of *domain decomposition exchange*, involving all MPI ranks sending and receiving particles according to the particles' positions in the integration box and the MPI ranks' assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If :code:`True`, the decomposition is performed once (before starting the simulation). If :code:`False`, no decomposition is performed. + +:cancel_com_momentum: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + If :code:`True`, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every :code:`remove_com_momentum` time steps. If :code:`False`, the linear momentum is never removed. + +:start_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at :code:`start_temperature` Kelvin prior to starting the simulation. If :code:`False`, the velocities are not changed before starting the simulation. + +:target_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Couple the system to a heat bath at :code:`target_temperature` Kelvin by applying a *Canonical sampling through velocity rescaling* :cite:`Bussi2007JCP` thermostat with coupling strength :code:`tau`. If :code:`False`, no temperature control is applied. + +:tau: + :code:`float` [**optional**, default: :code:`0.7`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the CSVR thermostat coupling. In the limit of :code:`tau → ∞`, the Hamiltonian dynamics are preserved and no temperature coupling takes place. + +:thermostat_coupling_groups: + :code:`array` [:code:`array` [:code:`string`]] [**optional**, default: :code:`[]`] + + Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and :code:`"C"` type particles, :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would thermalise types :code:`"A"` and :code:`"B"` together and couple :code:`"C"` type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. :code:`target_temperature` Kelvin). +:hamiltonian: + :code:`string` [**optional**, default: :code:`"DefaultNohChi"`] (options: :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`) + + Specifies the interaction energy functional :math:`W[\tilde\phi]` for use with the particle-field interactions. See :ref:`functionals-label` for details. + + +Field keywords +^^^^^^^^^^^^^^ +Configuration keywords specifying field parameters. + +:mesh_size: + :code:`array` [:code:`integer`] or :code:`integer` [:required:`required`] + + Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is :code:`box_size / mesh_size`. + +:kappa: + :code:`float` [:required:`required`] {units: :math:`\text{kJ}^{-1}\text{mol}`} + + Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional :math:`W[\tilde\phi]`. See :ref:`functionals-label` for more details. + +:sigma: + :code:`float` [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See :ref:`filtering-label` for more details. + +:chi: + :code:`array` [:code:`array` [:code:`string`, :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}`} + + Array of :math:`\tilde\chi_\text{AB}`-parameters indicating the strength of the repulsive or attractive interaction between particles of type :code:`"A"` and the number density due to particles of type :code:`"B"`, and vice versa. Example: :code:`chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ]` would specify a repulsive :code:`"A"`--:code:`"B"` type interaction, and a weakly attractive :code:`"C"`--:code:`"D"` interaction. Self-interaction :math:`\tilde\chi`-terms are always zero. See :ref:`functionals-label` for more details. + + +Bond keywords +^^^^^^^^^^^^^ +Configuration keywords specifying bonds and bonds parameters. + +:bonds: + :code:`array` [:code:`array` [2 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{nm}=10^{-9}~\text{m}` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: :code:`bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ]` indicates a :code:`"A"`--:code:`"A"` bond of equilibrium length :code:`0.47` :math:`\text{nm}` with a bond strength of :code:`980.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding bond between :code:`"A"` and :code:`"B"` type particles with equilibrium length :code:`0.31` :math:`\text{nm}` and a strength of :code:`1250.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify stretching bonds. + +:angle_bonds: + :code:`array` [:code:`array` [3 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`{}^\circ` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: :code:`bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ]` indicates a :code:`"A"`--:code:`"A"`--:code:`"A"` angular bond that tries to keep the bond linear at :code:`180` degrees with a bending strength of :code:`55.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding angle bond between :code:`"A"`--:code:`"B"`--:code:`"B"` prefering the angle at :code:`120` degrees and a strength of :code:`25.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify angular bonds. + +:dihedrals: + :code:`array` [:code:`array` [4 :code:`string`, :code:`integer`, :code:`COSINE SERIES` ]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`} + + Specifies four-particle torsional potentials by cosine series. See :ref:`bonds-label` for details about how to specify dihedrals. + + + +Electrostatic keywords +^^^^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying electrostatics and electrostatic parameters. + +:coulombtype: + :code:`string` [**optional**, default: :code:`None`] (options: :code:`PIC_Spectral`) + + Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the :code:`dielectric_const` keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, *not* in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to `PIC_Spectral`. + +:dielectric_const: + :code:`float` [**optional**, default: :code:`None`] + + Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified---even if electrostatics are not included with the :code:`coulombtype` keyword. + +Pressure keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying pressure and barostat parameters. + +Simulation keywords +========================================= + +:pressure: + :code:`boolean` [**optional**, default: :code:`False`] + + Specifies whether or not to calculate total internal pressure vector. + +:barostat: + :code:`string` [**optional**, default: :code:`None`](options: :code:`isotropic` or :code:`semiisotropic`) + + Specifies whether to apply pressure constraints equally in all 3 Cartesian directions (`isotropic`) or equally in xy and different in z (`semiisotropic`). + +:barostat_type: + :code:`string` [**optional**, default: :code:`berendsen`](options: :code:`berendsen` or :code:`scr`) + + Specifies the type of barostat to use. :code:`berendsen` is more suitable for equilibration and :code:`scr` for equilibrium data collection. + +:n_b: + :code:`integer` [**optional**, default: :code:`1`] + + Frequency of barostat call in number of outer rRESPA steps. + +:tau_p: + :code:`float` [**optional**, default: :code:`10 tau` if :code:`tau < 0.1` else :code:`1.0`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the barostat coupling. + +:target_pressure: + :code:`array` [:code:`float`] [**optional**, default: :code:1] {units: `bar`} + + Couples the system to an external pressure set to `target_pressure`. + +Field keywords +========================================= + +:rho0: + :code:`float` [**optional**, default: :code:average density] {units: :math:`\text{nm}^{-3}`} + + Intrinsic parameter corresponding to the specific volume of a coarse-grained particle. Typically: `8.66` + +:a: + :code:`float` [:required:`required`] {units: :math:`\text{nm}^{-3}`} + + Calibrated parameter to obtain the correct average density at the target temperature and pressure. Typically: `9.21` diff --git a/v2.0.1/_sources/doc_pages/constants_and_units.rst.txt b/v2.0.1/_sources/doc_pages/constants_and_units.rst.txt new file mode 100644 index 00000000..ee429829 --- /dev/null +++ b/v2.0.1/_sources/doc_pages/constants_and_units.rst.txt @@ -0,0 +1,80 @@ +.. _units-label: + +Constants and Units +################### + +HyMD uses the following units and constants internally and in all input and +output: + +.. list-table:: **Units** + :widths: 30 10 75 + :header-rows: 1 + + * - Quantity + - Symbol + - Unit + * - length + - :math:`r` + - :math:`\text{nm}=10^{-9}~\text{m}` + * - time + - :math:`t` + - :math:`\text{ps}=10^{-12}~\text{s}` + * - charge + - :math:`q` + - :math:`e=1.602176634 \cdot 10^{-19}~\text{C}` + * - mass + - :math:`m` + - :math:`\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}` + * - temperature + - :math:`\text{T}` + - :math:`\text{K}` + * - energy + - :math:`E` + - :math:`\text{kJ}\,\text{mol}^{-1}` + * - velocity + - :math:`v` + - :math:`\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}` + * - momentum + - :math:`P` + - :math:`\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}` + * - force + - :math:`\mathbf{F}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}` + * - pressure + - :math:`p` + - :math:`\text{bar}=100~\text{kPa}` + * - electric potential + - :math:`\Psi` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}` + * - electric field + - :math:`\mathbf{E}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}` + * - compressibility + - :math:`\kappa` + - :math:`\text{mol}\,\text{kJ}^{-1}` + * - field-interaction + - :math:`\tilde\chi` + - :math:`\text{kJ}\,\text{mol}^{-1}` + +.. list-table:: **Constants** + :widths: 30 10 75 + :header-rows: 1 + + * - Constant + - Symbol + - Value + * - gas constant + - :math:`R` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Boltzmann’s constant + - :math:`k_\text{B}` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Avogadro's constant + - :math:`N_\text{A}` + - :math:`6.02214076 \cdot 10^23~\text{mol}^{-1}` + * - Vacuum permittivity + - :math:`\varepsilon_0` + - :math:`8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2` + * - Coulomb constant + - :math:`k_\text{e}` + - :math:`138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}` diff --git a/v2.0.1/_sources/doc_pages/electrostatics.rst.txt b/v2.0.1/_sources/doc_pages/electrostatics.rst.txt new file mode 100644 index 00000000..7e11c09d --- /dev/null +++ b/v2.0.1/_sources/doc_pages/electrostatics.rst.txt @@ -0,0 +1,48 @@ +.. _electrostatics-label: + +Electrostatic interactions +########################## +In the filtered Hamiltonian hPF formalism :cite:`bore2020hamiltonian` the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle--mesh Ewald. + +The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered + +.. math:: + + \tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i), + +with :math:`q_i` being the charge of particle :math:`i` and :math:`H` is the +filtering function (see :ref:`filtering-label`). The value of the charge grid at +vertex :math:`(i,j,k)` is found by + +.. math:: + + \tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)] + +and the electrostatic potential :math:`\Psi_{ijk}` + +.. math:: + + \Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right], + +where :math:`k_\text{e}` is the Coulomb constant :math:`1/4\pi\varepsilon_0`. +The *electric field* is obtained by differentiation of the electrostatic +potential in Fourier space, + +.. math:: + + \mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)] + +from which the forces are interpolated back to the particle positions. + +Specifying electrostatics +^^^^^^^^^^^^^^^^^^^^^^^^^ +In HyMD, electrostatics are specified by the :code:`coulombtype` and +:code:`dielectric_const` keywords in the configuration file (see +:ref:`config-label`) and the :code:`/charge` dataset in the HDF5 format +structure/topology input file (see :ref:`topology-label`). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions. diff --git a/v2.0.1/_sources/doc_pages/examples.rst.txt b/v2.0.1/_sources/doc_pages/examples.rst.txt new file mode 100644 index 00000000..9f9c3655 --- /dev/null +++ b/v2.0.1/_sources/doc_pages/examples.rst.txt @@ -0,0 +1,621 @@ +.. _examples-label: + +Examples +######## +The following examples are ordered in *more or less* order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the `HyMD-tutorial`_ github repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Ideal gas +========= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true + :align: right + :width: 200 + +The simplest possible system is one with no interactions at all---intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like: + + +.. code-block:: toml + :caption: **ideal_gas.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = false # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + +A simple input structure/topology file :code:`ideal_gas.HDF5` is available in +the `HyMD-tutorial/ideal_gas`_ github repository (along with the code to +generate it). Run the (very) short simulation by + +.. code:: bash + + python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field \ + --velocity-output \ + --force-output + +with the :code:`--disable-field` argument to completely turn off all +particle--field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook `ideal_gas.ipynb`_ for details. + + +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas +.. _ideal_gas.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.ipynb + + +Ideal chains +============ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true + :align: right + :width: 200 + +The simplest available interaction is the harmonic two-particle bond (see +:ref:`bonds-label`), + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2. + +Extending the configuration file from the ideal gas case, we need to add a +:code:`bonds` specification. Note that the :code:`[bonds]` meta specifier is not +necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **ideal_chain.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + +A simple input structure/topology file :code:`ideal_chain.HDF5` with a few +coiled up ideal chain polymers is available in the +`HyMD-tutorial/ideal_chain`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field + +we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +`ideal_chain.ipynb`_. + + +.. _HyMD-tutorial/ideal_chain: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_chain +.. _ideal_chain.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/ideal_chain.ipynb + + +Stiff rods +========== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true + :align: right + :width: 200 + +Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the :code:`i--j--k` angle :math:`\theta` (see +:ref:`bonds-label`), + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2. + +Extending the configuration file from the ideal chain case, we need to add a +:code:`angle_bonds` specification. Note that the :code:`[bonds]` meta specifier +is not necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **rods.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + + angle_bonds = [ + ["A", "A", "A", 180.0, 100.0], # (i, j, k, equilibrium angle, strength) + ] + + +A simple input structure/topology file :code:`rods.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook `rods.ipynb`_. + + +.. _HyMD-tutorial/rods: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/rods +.. _rods.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.ipynb + + + +Helixes +======= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true + :align: right + :width: 200 + +Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle :math:`\phi` between the +:code:`i--j--k` plane and the :code:`j--k--l` plane (see :ref:`bonds-label`), + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n). + +The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a :code:`dihedrals` keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the :code:`dielectric_const` +keyword even though we are not including electrostatic forces in the current +simulation. Note that the :code:`[bonds]` meta specifier is not necessary, but +may be used to help organise the input file. + +.. code-block:: toml + :caption: **helixes.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + dielectric_const = 15.0 + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.31, 10000.0], # (i name, j name, equilibrium length, strength) + ] + + dihedrals = [ + [ + ["A", "A", "A", "A"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0] + ], + ] + +A simple input structure/topology file :code:`helixes.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook `helixes.ipynb`_. + + +.. _HyMD-tutorial/helixes: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/helixes +.. _helixes.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.ipynb + + +Phase separation +================ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true + :align: right + :width: 200 + +The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types :code:`A` and :code:`B`. Using the Hamiltonian + +.. math:: + + \mathcal{H}=H_0+W + +with :math:`\tilde\chi`--dependent interactions defined by (specified in the +configuration file by :code:`hamiltonian = DefaultWithChi`): + +.. math:: + + W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2. + + +.. code-block:: toml + :caption: **phase_separation.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + + [field] + mesh_size = [20, 20, 20] # FFT grid size + sigma = 1.0 # filtering length scale in nm + kappa = 0.05 # compressibility in mol/kJ + chi = [ + ['A', 'B', 5.0], # (name i, name j, strength) + ] + +A simple input structure/topology file :code:`phase_separation.HDF5` containing +an equal number of :code:`A` type and :code:`B` type particles is available in +the `HyMD-tutorial/phase_separation`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd phase_separation.toml phase_separation.HDF5 + +we may examine the resulting trajectory. In the case of a low interaction +strength :math:`\tilde\chi` of :code:`5.0` (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to :code:`40.0` (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +`phase_separation.ipynb`_. + + +.. _HyMD-tutorial/phase_separation: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/phase_separation +.. _phase_separation.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/phase_separation.ipynb + + +Diblock copolymers +================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true + :align: right + :width: 200 + +Having introduced particle--field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive :math:`\tilde\chi`--interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the :code:`integrator = "respa"` keyword. Putting the pieces together, the +configuration file may look like the following: + +.. code-block:: toml + :caption: **copolymer.toml** + + [simulation] + integrator = "respa" + respa_inner = 15 + n_steps = 2000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [10.0, 10.0, 10.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [50, 50, 50] # FFT grid size + sigma = 0.5 # filtering length scale in nm + chi = [ + ["A", "B", 30.0], # (i, j, strength) + ] + + [bonds] + bonds = [ + ["A", "A", 0.25, 1500.0], # (i, j, equilibrium length, strength) + ["A", "B", 0.25, 1500.0], + ["B", "B", 0.25, 1500.0], + ] + angle_bonds = [ + ["A", "A", "A", 180.0, 25.0], # (i, j, k, equilibrium angle, strength) + ["B", "B", "B", 180.0, 25.0], + ] + +A simple input structure/topology file :code:`copolymer.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/copolymer`_ github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten :code:`A` followed by ten :code:`B` type particles. +Running the simulation with + +.. code:: bash + + python3 -m hymd copolymer.toml copolymer.HDF5 + +the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +`copolymer.ipynb`_. + + +.. _HyMD-tutorial/copolymer: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/copolymer +.. _copolymer.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer.ipynb + + +Lipid bilayer self-assembly +=========================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true + :align: right + :width: 300 + +Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field--particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the :code:`thermostat_coupling_groups` keyword. With parameters +optimised in :cite:`ledum2020automated`, the configuration file looks like: + + +.. code-block:: toml + :caption: **lipid_self_assembly.toml** + + [simulation] + integrator = "respa" + respa_inner = 25 + n_steps = 3000 + n_print = 200 + n_flush = 1 + time_step = 0.01 + box_size = [9.96924, 9.96924, 10.03970] + start_temperature = 323 + target_temperature = 323 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.05 + domain_decomposition = 10001 + cancel_com_momentum = true + max_molecule_size = 15 + thermostat_coupling_groups = [ + ["N", "P", "G", "C"], + ["W"], + ] + + [field] + mesh_size = [25, 25, 25] + sigma = 1.0 + chi = [ + ["C", "W", 42.24], + ["G", "C", 10.47], + ["N", "W", -3.77], + ["G", "W", 4.53], + ["N", "P", -9.34], + ["P", "G", 8.04], + ["N", "G", 1.97], + ["P", "C", 14.72], + ["P", "W", -1.51], + ["N", "C", 13.56], + ] + + [bonds] + bonds = [ + ["N", "P", 0.47, 1250.0], + ["P", "G", 0.47, 1250.0], + ["G", "G", 0.37, 1250.0], + ["G", "C", 0.47, 1250.0], + ["C", "C", 0.47, 1250.0], + ] + angle_bonds = [ + ["P", "G", "G", 120.0, 25.0], + ["P", "G", "C", 180.0, 25.0], + ["G", "C", "C", 180.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +A randomly mixed input structure/topology file +:code:`lipid_self_assembly.HDF5` with a few hundred lipids in a roughy +:code:`10 x 10 x 10nm` box is available in the +`HyMD-tutorial/lipid_self_assembly`_ github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation + +.. code:: bash + + python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5 + +we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook `lipid_self_assembly.ipynb`_. + + +.. _HyMD-tutorial/lipid_self_assembly: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/lipid_self_assembly +.. _lipid_self_assembly.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/lipid_self_assembly.ipynb + + +Peptide in lipid bilayer +======================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true + :align: right + :width: 300 + +Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer. + + +The `configuration file`_ is available in the `HyMD-tutorial/peptide`_ github +repository (omitted here for brevity). + +A pre-equilibrated input structure/topology file :code:`peptide.HDF5` with a +few hundred lipids in a roughy :code:`20 x 20 x 20nm` box is available in the +`HyMD-tutorial/peptide`_ github repository. Running the simulation + +.. code:: bash + + python3 -m hymd peptide.toml peptide.HDF5 + +we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook `peptide.ipynb`_. + + +.. _HyMD-tutorial/peptide: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/peptide +.. _configuration file: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.toml +.. _peptide.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.ipynb + + +SDS +=== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true + :align: right + :width: 300 + +The last part we introduce is explicit electrostatic interactions through +particle--mesh Ewald. Enabling the electrostatic calculations is done via the +:code:`coulombtype` keyword. :code:`"PIC_Spectral"` is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the :code:`dielectric_const` keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge. + + + +.. code-block:: toml + :caption: **sds.toml** + + [simulation] + integrator = "respa" + respa_inner = 10 + n_steps = 3000 + n_print = 1500 + n_flush = + time_step = 0.01 + box_size = [8.3, 8.3, 8.3] + start_temperature = 298 + target_temperature = 298 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.1 + domain_decomposition = 10000 + cancel_com_momentum = true + max_molecule_size = 5 + thermostat_coupling_groups = [ + ["S", "C"], + ["W", "Na"], + ] + dielectric_const = 45.0 # dielectric constant for the simulation medium + coulombtype = "PIC_Spectral" # particle in cloud, spectral method + + [field] + mesh_size = [64, 64, 64] + sigma = 0.5 + chi = [ + ["S", "C", 13.50], + ["S", "Na", 0.00], + ["S", "W", -3.60], + ["C", "Na", 13.50], + ["C", "W", 33.75], + ["W", "Na", 0.00], + ] + + [bonds] + bonds = [ + ["S", "C", 0.50, 1250.0], + ["C", "C", 0.50, 1250.0], + ] + angle_bonds = [ + ["S", "C", "C", 170.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +An input structure/topology file :code:`sds.HDF5` with a couple thousand +randomly dispersed SDS chains is available in the `HyMD-tutorial/sds`_ github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a :code:`/charge` dataset. +Running the simulation with + +.. code:: bash + + python3 -m hymd sds.toml sds.HDF5 + +we observe the aggregation of the SDS into micellular structures---first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook `sds.ipynb`_. + + +.. _HyMD-tutorial/sds: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/sds +.. _sds.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/sds.ipynb diff --git a/v2.0.1/_sources/doc_pages/filtering.rst.txt b/v2.0.1/_sources/doc_pages/filtering.rst.txt new file mode 100644 index 00000000..02af68c6 --- /dev/null +++ b/v2.0.1/_sources/doc_pages/filtering.rst.txt @@ -0,0 +1,30 @@ +.. _filtering-label: + +Filtering +######### +The default grid-independent filter function used in HyMD is a Gaussian + +.. math:: + + H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] + +with reciprocal space representation + +.. math:: + + \hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +The coarse-graining parameter :math:`\sigma` determines a length scale of +particle extent and is given as configuration file input by + +.. code:: toml + + sigma = 0.75 + + +Implementing new filters +^^^^^^^^^^^^^^^^^^^^^^^^ +Implementing new filter functions is straightforward by hijacking +the :code:`setup` method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional. diff --git a/v2.0.1/_sources/doc_pages/installation.rst.txt b/v2.0.1/_sources/doc_pages/installation.rst.txt new file mode 100644 index 00000000..9ab7e59c --- /dev/null +++ b/v2.0.1/_sources/doc_pages/installation.rst.txt @@ -0,0 +1,324 @@ +.. _installation-label: + +Installation +############ + +Dependencies +============ + +.. note:: + HyMD requires Python ≥3.6. Python version 3.9 is most likely fine + to use, but HyMD is only regularly tested with Python3.8 at the moment. + +.. warning:: + MPI-enabled h5py may fail to build under Python3.10. In this case, a + fall-back to Python3.9 or lower may be necessary. + + +**Installing non-Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-openmpi-dev # Install MPI-enabled HDF5 + sudo apt-get install -y pkg-config # Install pkg-config, required for h5py install + sudo apt-get install -y curl wget + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + sudo dnf update -y + sudo dnf install -y python3.9 python3-devel # Install python3 and pip + sudo dnf install -y openmpi-devel # Install MPI development headers + sudo dnf install -y hdf5-openmpi-devel # Install MPI-enabled HDF5 + sudo dnf install -y curl wget + + + The automatic download and building of PFFT has some issues, so we + manually build FFTW and PFFT before calling :code:`pip3 install pfft-python`. + + .. code-block:: bash + + sudo dnf install -y git + sudo dnf install -y libtool + sudo dnf install -y fftw-openmpi-devel fftw-openmpi-libs + export PATH=$PATH:/usr/lib64/openmpi/bin/ # Ensure MPICC is in path + git clone https://github.com/mpip/pfft.git + cd pfft/ + ./bootstrap.sh + ./configure + make + make install + + + .. group-tab:: Mac OSX (brew) + + .. code-block:: bash + + brew update + brew install python # Install python3 and pip + brew install open-mpi # Install MPI development headers + brew install hdf5-mpi # Install MPI-enabled HDF5 + brew install pkg-config # Install pkg-config, required for h5py install + brew install curl wget + +.. warning:: + There might be memory leaks when using HyMD with OpenMPI 4.1.1. + Therefore, using a newer version of OpenMPI is recommended. + See `Issue #186 `_ for more details. + + +**Installing Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + python3 -m pip install --upgrade pip + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + python3.9 -m ensurepip --upgrade + PATH=$PATH:/usr/lib64/openmpi/bin/:/usr/lib64/openmpi/lib/ + python3.9 -m pip install mpi4py numpy cython + export HDF5_DIR="/usr/lib64/openmpi/" + CC="mpicc" HDF5_MPI="ON" python3.9 -m pip install --no-binary=h5py h5py + + .. group-tab:: Mac OSX (brew) + + Find the location of the installed :code:`hdf5-mpi` package by + + .. code-block:: bash + + find /usr -iname "*hdf5.h" + + or + + .. code-block:: bash + + brew info hdf5-mpi + + and extract the path, which will look like for example + :code:`/usr/local/Cellar/hdf5-mpi/1.13.0/`. Export it as :code:`HDF5_DIR` + + .. code-block:: bash + + python3 -m ensurepip --upgrade + export HDF5_DIR="/usr/local/Cellar/hdf5-mpi/1.13.0/" + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + + +.. warning:: + + If MPI-enabled HDF5 and :code:`h5py` can not be installed, limited support + for serial HDF5 is available. Note that having MPI-enabled file IO is + **highly recommended**, and simulation performance under serial HDF5 will + potentially be very low. + + Example dependency install on Ubuntu (apt) using serial HDF5: + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-serial-dev # Install serial HDF5 + sudo apt-get install -y curl wget + + python3 -m pip install h5py mpi4py numpy cython + + Running parallel simulations without a + MPI-enabled HDF5 library available necessitates the use of the + :code:`--disable-mpio` argument to HyMD, see :ref:`commandline-label`. Note that + due to the way HyMD is built, a working MPI compiler is required even if all + intended simulations are serial. + + +Installing HyMD +=============== +HyMD may be installed using :code:`pip` by + +.. code-block:: bash + + python3 -m pip install hymd + + + +Install in docker +================= +A docker image with build essentials setup is available at `dockerhub`_ with tag +:code:`mortele/hymd`, + +.. code-block:: bash + + docker pull mortele/hymd:latest + docker run -it mortele/hymd + /app$ python3 -m pip install hymd + + # Grab example input files + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5 + + # Run simulation + /app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose + +.. _dockerhub: + https://hub.docker.com/repository/docker/mortele/hymd + + +Run interactively in Google Colaboratory +======================================== +A `Google Colaboratory`_ jupyter notebook is setup `here`_ with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Common issues +============= + +Numpy errors while importing the Fortran force kernels +------------------------------------------------------ + +.. code-block:: python + + RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd + + Traceback (most recent call last): + + (...) + + File "/..../HyMD/hymd/__init__.py", line 2, in + from .main import main # noqa: F401 + File "/..../HyMD/hymd/main.py", line 10, in + from .configure_runtime import configure_runtime + File "/..../hymd/configure_runtime.py", line 12, in + from .input_parser import read_config_toml, parse_config_toml + File "/..../HyMD/hymd/input_parser.py", line 12, in + from .force import Bond, Angle, Dihedral, Chi + File "/..../HyMD/hymd/force.py", line 8, in + from force_kernels import ( # noqa: F401 + ImportError: numpy.core.multiarray failed to import + +can normally be fixed by updating numpy versions, + +.. code-block:: bash + + python3 -m pip install -U numpy + + +Error building pfft-python due to missing curl/wget +--------------------------------------------------- + +.. code-block:: python + + Building wheel for pfft-python (setup.py) ... error + ERROR: Command errored out with exit status 1: + command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_ + cwd: /tmp/pip-install-fr6nt9m4/pfft-python/ + Complete output (56 lines): + running bdist_wheel + running build + running build_py + + (...) + + curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found + wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found + Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + Please check curl or wget + You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ + Traceback (most recent call last): + File "", line 1, in + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in + setup( + File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup + return distutils.core.setup(**attrs) + File "/usr/lib/python3.8/distutils/core.py", line 148, in setup + + (...) + + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions + build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:])) + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft + raise ValueError("could not build fftw; check MPICC?") + ValueError: could not build fftw; check MPICC? + ---------------------------------------- + ERROR: Failed building wheel for pfft-python + Running setup.py clean for pfft-python + Failed to build pfft-python + +can be fixed by installing either `curl`_ or `wget`_ + +.. code-block:: bash + + apt-get install -y curl wget + + +.. _`curl`: + https://curl.se/ + +.. _`wget`: + https://www.gnu.org/software/wget/ + + +Error running parallel HyMD without MPI-enabled h5py +---------------------------------------------------- + +.. code-block:: python + + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + main() + File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main + with h5py.File(args.input, "r", **_kwargs) as in_file: + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__ + with h5py.File(args.input, "r", **_kwargs) as in_file: + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + raise ValueError("h5py was built without MPI support, can't use mpio driver") + ValueError: h5py was built without MPI support, can't use mpio driver + +Can be fixed by installing a MPI-enabled :code:`h5py` through + +.. code-block:: bash + + python3 -m pip uninstall -y h5py + HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py diff --git a/v2.0.1/_sources/doc_pages/interaction_energy_functionals.rst.txt b/v2.0.1/_sources/doc_pages/interaction_energy_functionals.rst.txt new file mode 100644 index 00000000..f33c004e --- /dev/null +++ b/v2.0.1/_sources/doc_pages/interaction_energy_functionals.rst.txt @@ -0,0 +1,98 @@ +.. _functionals-label: + +Interaction energy functionals +############################## +A few interaction energy functionals :math:`W` are defined in HyMD through +the :code:`Hamiltonian` class and associated subclasses. + +:math:`\chi`--interaction and :math:`\kappa`--incompressibility +=============================================================== +The most common hPF energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultWithChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where :math:`\tilde\chi_{\text{A}-\text{B}}` is the interaction energy between +overlapping densities of particle types :math:`\text{A}` and :math:`\text{B}`. +The incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\tilde\chi` +and :math:`\kappa` in the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + chi = [ + ["A", "B", 15.85], + ["B", "C", -5.70], + ... + ] + +Only :math:`\kappa`--incompressibility +====================================== +The only :math:`\kappa` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultNoChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where the incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Only :math:`\phi^2` +=================== +The :math:`\phi^2` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "SquaredPhi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2, + +where the :math:`\phi` squared term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Implementing new interaction energy forms +========================================= +Implementing new interaction energy functions is straightforward by subclassing +:code:`Hamiltonian` and applying :code:`sympy` differentiation to the symbolic +field objects. The :code:`sympy.lamdify` function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields. diff --git a/v2.0.1/_sources/doc_pages/intramolecular_bonds.rst.txt b/v2.0.1/_sources/doc_pages/intramolecular_bonds.rst.txt new file mode 100644 index 00000000..820e81bc --- /dev/null +++ b/v2.0.1/_sources/doc_pages/intramolecular_bonds.rst.txt @@ -0,0 +1,142 @@ +.. _bonds-label: + +Intramolecular bonds +#################### + +Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see :ref:`config-label`. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +:ref:`benchmarks-label`), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable. + +All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]). + + +Two-particle bonds +^^^^^^^^^^^^^^^^^^ +Stretching bonds in HyMD are implemented as harmonic spring potentials, + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2, + +where :math:`r=|\mathbf{r}|` is the inter-particle distance, :math:`k` is a +constant of dimension energy (units :math:`\text{kJ}\,\text{mol}^{-1}`), and +:math:`r_0` is the equilibrum length of the bond (units: :math:`\text{nm}`). The +force is calculated as + +.. math:: + + F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r}, + +where :math:`\mathbf{r}` is the vector pointing *from* :math:`i` *to* :math:`j`. + +In the configuration file, two-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_two_particle_example.toml + + [bonds] + bonds = [ + ["A", "A", 0.47, 1250.0], + ["A", "B", 0.37, 940.0], + ["B", "C", 0.50, 1010.0], + ["C", "A", 0.42, 550.0], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Three-particle bonds +^^^^^^^^^^^^^^^^^^^^ +Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle--particle--particle angle :math:`\theta`, + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2, + +where :math:`k` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}`), and :math:`\theta_0` is the equilibrum +angle of the bond (units: :math:`{}^\circ`). Defining the particles with labels +:math:`a`, :math:`b`, and :math:`c`, let :math:`\mathbf{r}_a` denote the vector +pointing from :math:`b` to :math:`a`, and correspondingly let +:math:`\mathbf{r}_c` point from :math:`b` to :math:`c`. The +:math:`a`--:math:`b`--:math:`c` may be computed through the law of Cosines, + +.. math:: + + \theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right] + +Then the force acting on :math:`a` and :math:`c` is + +.. math:: + + \mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a}, + + \mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c}, + +and + +.. math:: + + \mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c + +In the configuration file, three-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_three_particle_example.toml + + [bonds] + angle_bonds = [ + ["A", "A", "A", 180.0, 90.0], + ["A", "B", "A", 120.0, 55.0], + ["B", "C", "C", 30.0, 10.0], + ["C", "A", "B", 110.0, 25.5], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Four-particle bonds +^^^^^^^^^^^^^^^^^^^ +Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle :math:`\phi` between the +:math:`a`--:math:`b`--:math:`c` and :math:`b`--:math:`c`--:math:`d` planes, for +a dihedral bond quartet :math:`a`, :math:`b`, :math:`c`, and :math:`d`. The +potential takes the form + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n), + +where :math:`c_n` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`), and :math:`\phi_n` are +specified phase angles in the cosine series. + +In the configuration file, four-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_four_particle_example.toml + + [bonds] + dihedrals = [ + ["A", "B", "C", "D"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0], + ] diff --git a/v2.0.1/_sources/doc_pages/overview.rst.txt b/v2.0.1/_sources/doc_pages/overview.rst.txt new file mode 100644 index 00000000..0e4d6b65 --- /dev/null +++ b/v2.0.1/_sources/doc_pages/overview.rst.txt @@ -0,0 +1,166 @@ +.. _overview-label: + +================================ + Usage overview for HylleraasMD +================================ + +HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a `toml`_ format configuration file, along with a topology and structure +file specifying the input system in HDF5 format. + +.. _`toml`: + https://github.com/toml-lang/toml + +**Configuration file** + +The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a :code:`[5, 5, 5]` nm simulation box at 300 K may look like +the following: + +.. code-block:: toml + :caption: **config_simple_1.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "SquaredPhi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [30, 30, 30] # FFT grid size + sigma = 0.5 # filtering length scale in nm + +Note that for the version 1.0 release of HyMD, the :code:`[particles]`, +:code:`[simulation]`, and :code:`[field]` groups are optional specifiers for +structuring the configuration file. + +For a full specification of every recognised configuration keyword in HyMD, +please refer to :ref:`config-label`. + +**Topology and structure file** + +The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +:code:`N` particles may look like the following: + +.. code-block:: bash + :caption: **example_structure.HDF5** + + group / + # root group + + dataset /coordinates + # float32, shape (T, N, D,) + # Time steps of N rows of D dimensional coordinate data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /velocities + # float32, shape (T, N, D,) OPTIONAL + # Time steps of N rows of D dimensional velocity data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /bonds + # int32, shape (N, B,) OPTIONAL + # Each row i contains indices of the particles bonds from/to i + # B denotes the maximum bonds per particle + + dataset /indices + # int32, shape (N,) + # Index of each particle, 0--(N-1) + + dataset /molecules + # int32, shape (N,) + # Index of molecule each particle belongs to + # Used to construct bond network locally on MPI ranks + + dataset /names + # str10, shape (N,) + # Fixed size string array containing particle type names + + dataset /types + # int32, shape (N,) OPTIONAL + # Mapping of particle names to type indices + + +For a full specification of the topology and structure input file, see +:ref:`topology-label`. + +**Command line arguments** + +A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the :code:`config_simple_1.toml` and :code:`example_structure.HDF5` +files may look like the following: + +.. code-block:: bash + + mpirun -n ${MPI_NUM_RANKS} python3 -m hymd \ # HyMD executable + config_simple_1.toml \ # configuration file + example_structure.HDF5 \ # structure file + --logfile=log_out.txt \ # set logfile path + --seed 123456 \ # set random seed + --verbose 2 \ # set logging verbosity + --velocity-output # enable velocity in trajectory output + +For a full specification of all command line arguments, see +:ref:`commandline-label`. + +**More examples** + +For more thorough rundown and concrete usage examples, see +:ref:`examples-label`. + +Running parallel simulations +============================ +Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the **only** difference being how the python3 interpreter is +invoked. Prepending :code:`mpirun -n ${NPROCS}` to the usual +:code:`python3 -m hymd` runs the simulation with :code:`${NPROCS}` MPI ranks. + +Inputting + +.. code:: bash + + mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field + +sets up an example simulation of the `HyMD-tutorial/ideal_gas`_ system. For +more details about this system in particular, or other example simulations, see +the `HyMD-tutorial`_ repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas + + +Running tests +============= +Run serial code tests by + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd + cd hymd/ + python3 -m pip install pytest pytest-mpi + python3 -m pytest + +There is a small convenience script in :code:`hymd/` for running the MPI-enabled +tests, + +.. code-block:: bash + + chmod +x pytest-mpi + ./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no diff --git a/v2.0.1/_sources/doc_pages/pressure.rst.txt b/v2.0.1/_sources/doc_pages/pressure.rst.txt new file mode 100644 index 00000000..be9c7cda --- /dev/null +++ b/v2.0.1/_sources/doc_pages/pressure.rst.txt @@ -0,0 +1,37 @@ +.. _pressure-label: + +Pressure +######## +Internal pressure is calculated from internal energy according to + +.. math:: + + P_a = \frac{1}{\mathcal{V}} \left( 2T_a - \text{Vir}_a \right) \\ + \text{Vir}_a = L_a \frac{\partial \mathcal{U}}{\partial L_a} \\ + \mathcal{U} = \sum_{i=1}^M \mathcal{U}_0( \{ \mathbf{r}\}_i ) + W[\{ \tilde\phi \} ] + +where +:math:`\mathcal{V}` is the simulation volume, +:math:`{T_a}` is the kinetic energy +and :math:`L_a` the length of the box in the Cartesian direction :math:`a`, +Vir is the virial of the total interaction energy :math:`\mathcal{U}`. + +:math:`\mathcal{U}` comprises intramolecular bonded terms :math:`\mathcal{U}_0` (see :ref:`bonds-label` for details), +and field terms :math:`W[\{ \tilde\phi \} ]` (see :ref:`theory-label` for details). + +Using the above expressions, the following form for internal pressure is obtained: + +.. math:: + + P_a = \frac{2 T_a}{\mathcal{V}} -\frac{L_a}{\mathcal{V}} \sum_{i=1}^N \frac{\partial \mathcal{U}_{0i}}{\partial L_a} + P^{(3)}_a \\ + +.. P^{(3)}_a = - \frac{L_a}{\mathcal{V}} \frac{\partial W[\{ \tilde\phi \} ]}{\partial L_a} \\ + +.. math:: + + P^{(3)}_a = \frac{1}{\mathcal{V}}\left ( -W[\{ \tilde\phi(\mathbf{r}) \}] + \int \sum_t \bar{V}_t(\mathbf{r})\tilde\phi_t(\mathbf{r})d\mathbf{r} + + \int \sum_t \sigma^2\bar{V}_t(\mathbf{r})\nabla_a^2\tilde\phi_t(\mathbf{r}) d\mathbf{r} \right) + +where :math:`\bar{V}_t(\mathbf{r}) = \frac{\partial w(\{\tilde\phi\})}{\partial\tilde\phi_t}` +and :math:`σ` is a coarse-graining parameter (see :ref:`filtering-label` for details). +Note that the above expression is obtained for a Gaussian filter which is the most natural choice in HhPF theory. diff --git a/v2.0.1/_sources/doc_pages/theory.rst.txt b/v2.0.1/_sources/doc_pages/theory.rst.txt new file mode 100644 index 00000000..2429bc0d --- /dev/null +++ b/v2.0.1/_sources/doc_pages/theory.rst.txt @@ -0,0 +1,122 @@ +.. _theory-label: + +Theory +###### +Hybrid particle--field simulations switch out the ordinary particle--particle +`Lennard-Jones`_ interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle--field densities are +defined as + +.. math:: + + \phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i), + +where :math:`\mathbf{r}` is a spatial coordinate, :math:`P` is a window function +used to distribute particle number densities onto a computational grid, and +:math:`\mathbf{r}_i` is the position of particle :math:`i` (of total :math:`N`). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of :math:`N` particles in :math:`M` molecules is + +.. math:: + + \mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})] + +with :math:`H_0` being a standard intramolecular Hamiltonian form (see +:ref:`bonds-label`) including kinetic terms, while :math:`W` is a density +dependent *interaction energy functional*. + +In the Hamiltonian hPF-MD formalism :cite:`bore2020hamiltonian`, the density +field is filtered using a grid-independent filtering function :math:`H`, + +.. math:: + + \tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}). + +The filter smooths the density, ensuring that :math:`\tilde\phi` and +:math:`W[\tilde\phi([\phi])]` both converge as the grid size is reduced. + +External potential +================== +The external potential acting on a particle is defined as the functional +derivative of :math:`W` with respect to :math:`\phi`. In the filtered formalism, +the potential takes the form + +.. math:: + + V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ + &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})}, + +under the assumption of a *local* form of the interaction energy functional, +:math:`W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]`. Note +that + +.. math:: + + \frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}). + +Force interpolation +=================== +The forces on particle :math:`i` are obtained by differentiation of the external +potential, + +.. math:: + + \mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i). + + +Reciprocal space calculations +============================= +The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density :math:`\phi_{ijk}` with CIC, we apply the filtering +and obtain the discrete version of the external potential by + +.. math:: + + \tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big] + +and + +.. math:: + + V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +The forces are obtained by differentiation of :math:`V` in Fourier space as + +.. math:: + + \nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +Filter +====== +By default, the filter used in HyMD is a simple Gaussian of the form + +.. math:: + + H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ + \hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +For more details about the filtering, see :ref:`filtering-label`. + +Hamiltonian form +================ +The default form of the interaction energy functional in HyMD is + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2. + +In the case of constant pressure simulations (NPT), the interaction energy functional becomes + +.. math:: + + W=\frac{1}{2\rho_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-a\right)^2. + +where, :math:`\rho_0= 1 / ν` is an intrinsic parameter corresponding to the specific volume :math:`(ν)` of a coarse-grained particle, +:math:`a` is a calibrated parameter to obtain the correct average density at the target temperature and pressure. +See :ref:`functionals-label` for details. + + +.. _`Lennard-Jones`: + https://en.wikipedia.org/wiki/Lennard-Jones_potential diff --git a/v2.0.1/_sources/doc_pages/topology_input.rst.txt b/v2.0.1/_sources/doc_pages/topology_input.rst.txt new file mode 100644 index 00000000..02faa501 --- /dev/null +++ b/v2.0.1/_sources/doc_pages/topology_input.rst.txt @@ -0,0 +1,84 @@ +.. _topology-label: + +============================ +Topology and structure file +============================ +The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root :code:`/` group. + +The `HyMD-tutorial`_ has multiple examples of structure files for various levels +of complexity. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Required datasets +================= +:/coordinates: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/indices: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/names: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`string` (:code:`length` between :code:`1` and :code:`16`)] + + The shape represents one particle name per :code:`N` particles. The datatype may be a string of length :code:`=<16`. + + + +Optional datasets +================= +:/velocities: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/types: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle type index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/molecules: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one molecule index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/bonds: + :code:`array` shape [:code:`N`, :code:`B`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents :code:`B` bond specifications (indices of different particles) per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/charge: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents one particle charge per :code:`N` particles. The data type may be either four or eight byte reals. + +:/box: + :code:`array` shape [:code:`3`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents the initial box dimensions in Cartesian coordinates. diff --git a/v2.0.1/_sources/index.rst.txt b/v2.0.1/_sources/index.rst.txt new file mode 100644 index 00000000..cfac690d --- /dev/null +++ b/v2.0.1/_sources/index.rst.txt @@ -0,0 +1,169 @@ +.. hymd documentation master file, created by + sphinx-quickstart on Thu Dec 16 13:31:43 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +############################### +HylleraasMD documentation +############################### + +:Release: + |release| +:Date: + |today| + +**HylleraasMD** (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems. + +HyMD can run canonical hPF-MD simulations :cite:`Milano2009JCP`, or filtered +density Hamiltonian hPF (HhPF-MD) simulations :cite:`bore2020hamiltonian`, with +or without explicit PME electrostatic interactions :cite:`kolli2018JCTC`. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +:cite:`Cascella2008,bore2018hybrid`. Martini +style elastic networks (ElNeDyn) :cite:`periole2009combining` are also +supported. + +HyMD uses the pmesh (`github.com/rainwoodman/pmesh`_) library for particle-mesh +operations, with the PPFT :cite:`pippig2013pfft` backend for FFTs through the +pfft-python bindings (`github.com/rainwoodman/pfft-python`_). File IO is done +via HDF5 formats to allow MPI parallel reads. + +User Guide +========== +The HylleraasMD :doc:`User Guide ` provides comprehensive information on how to run +simulations. Selected :doc:`Examples ` are available to guide new users. + +.. _`github.com/rainwoodman/pmesh`: + https://github.com/rainwoodman/pmesh +.. _`github.com/rainwoodman/pfft-python`: + https://github.com/rainwoodman/pfft-python + +Installing HyMD +=============== +The easiest approach is to install using pip_: + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + +For more information and **required dependencies**, see +:ref:`installation-label`. + +.. _pip: + http://www.pip-installer.org/en/latest/index.html + + +Run in Google colab +------------------- +Run HyMD interactively in `Google Colaboratory`_ jupyter notebook `here`_. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Source Code +=========== +**Source code** is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the `GNU Lesser General Public +License v3.0`_. Obtain the source code with `git`_: + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git + +.. _GNU Lesser General Public License v3.0: + https://www.gnu.org/licenses/lgpl-3.0.html +.. _git: + https://git-scm.com/ + + +Development +=========== +HyMD is developed and maintained by researchers at the `Hylleraas Centre for +Quantum Molecular Sciences`_ at the `University of Oslo`_. + +|pic1| |pic2| + +.. _`Hylleraas Centre for Quantum Molecular Sciences`: + https://www.mn.uio.no/hylleraas/english/ +.. _`University of Oslo`: + https://www.uio.no/ + +.. |pic1| image:: img/hylleraas_centre_logo_black.png + :target: img/hylleraas_centre_logo_black.png + :width: 250 px + +.. |pic2| image:: img/uio_full_logo_eng_pos.png + :target: img/uio_full_logo_eng_pos.png + :width: 325 px + + + +References +========== +.. bibliography:: + :all: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. Contents +.. ======== + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Getting started + + ./doc_pages/installation + ./doc_pages/overview + ./doc_pages/config_file + ./doc_pages/topology_input + ./doc_pages/command_line + ./doc_pages/constants_and_units + + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Examples + + ./doc_pages/examples + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Theory + + ./doc_pages/theory + ./doc_pages/intramolecular_bonds + ./doc_pages/electrostatics + ./doc_pages/pressure + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Developer documentation + + ./doc_pages/interaction_energy_functionals + ./doc_pages/filtering + ./doc_pages/benchmarks + ./doc_pages/api diff --git a/v2.0.1/_static/basic.css b/v2.0.1/_static/basic.css new file mode 100644 index 00000000..be19270e --- /dev/null +++ b/v2.0.1/_static/basic.css @@ -0,0 +1,856 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/v2.0.1/_static/css/badge_only.css b/v2.0.1/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/v2.0.1/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/v2.0.1/_static/css/fonts/Roboto-Slab-Bold.woff b/v2.0.1/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/v2.0.1/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/v2.0.1/_static/css/fonts/Roboto-Slab-Bold.woff2 b/v2.0.1/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/v2.0.1/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/v2.0.1/_static/css/fonts/Roboto-Slab-Regular.woff b/v2.0.1/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/v2.0.1/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/v2.0.1/_static/css/fonts/Roboto-Slab-Regular.woff2 b/v2.0.1/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/v2.0.1/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/v2.0.1/_static/css/fonts/fontawesome-webfont.eot b/v2.0.1/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/v2.0.1/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/v2.0.1/_static/css/fonts/fontawesome-webfont.svg b/v2.0.1/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/v2.0.1/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v2.0.1/_static/css/fonts/fontawesome-webfont.ttf b/v2.0.1/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/v2.0.1/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/v2.0.1/_static/css/fonts/fontawesome-webfont.woff b/v2.0.1/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/v2.0.1/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/v2.0.1/_static/css/fonts/fontawesome-webfont.woff2 b/v2.0.1/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/v2.0.1/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/v2.0.1/_static/css/fonts/lato-bold-italic.woff b/v2.0.1/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/v2.0.1/_static/css/fonts/lato-bold-italic.woff differ diff --git a/v2.0.1/_static/css/fonts/lato-bold-italic.woff2 b/v2.0.1/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/v2.0.1/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/v2.0.1/_static/css/fonts/lato-bold.woff b/v2.0.1/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/v2.0.1/_static/css/fonts/lato-bold.woff differ diff --git a/v2.0.1/_static/css/fonts/lato-bold.woff2 b/v2.0.1/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/v2.0.1/_static/css/fonts/lato-bold.woff2 differ diff --git a/v2.0.1/_static/css/fonts/lato-normal-italic.woff b/v2.0.1/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/v2.0.1/_static/css/fonts/lato-normal-italic.woff differ diff --git a/v2.0.1/_static/css/fonts/lato-normal-italic.woff2 b/v2.0.1/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/v2.0.1/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/v2.0.1/_static/css/fonts/lato-normal.woff b/v2.0.1/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/v2.0.1/_static/css/fonts/lato-normal.woff differ diff --git a/v2.0.1/_static/css/fonts/lato-normal.woff2 b/v2.0.1/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/v2.0.1/_static/css/fonts/lato-normal.woff2 differ diff --git a/v2.0.1/_static/css/theme.css b/v2.0.1/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/v2.0.1/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/v2.0.1/_static/custom.css b/v2.0.1/_static/custom.css new file mode 100644 index 00000000..b20d6282 --- /dev/null +++ b/v2.0.1/_static/custom.css @@ -0,0 +1,91 @@ + +body{ + background: #FFFFFF !important; +} + +.wy-menu-vertical header, .wy-menu-vertical p.caption{ + color: #4EA0AF!important; +} +.wy-menu-vertical li.current{ + background-color: #f4f4f4!important; +} +.wy-menu-vertical li.toctree-l2.current>a{ + background-color: #ebebeb!important; +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{ + background-color: #e3e3e3!important; +} + +.rst-content .sidebar{ + background-color: #fff!important; + border-radius: 6px; + -moz-border-radius: 6px; + -webkit-border-radius: 6px; +} + +h1 > a, h2 > a, h3 > a, h4 > a, h5 > a, h6 > a { + color: #17d9ff; +} + +h1, h2, h3, h4, h5, h6 { + color: black; + font-weight: normal; + padding: 0; +} + +h1, h2, h3 { + margin-top: 30px; + margin-bottom: 20px; +} + +h1 { + color: white; + padding: 20px 20px 20px 45px; + margin: 20px 0 35px -45px; + background: linear-gradient(to left, #fff, #2b38ff)!important; + + width: calc(100% + 90px); + border-bottom: 3px solid #000; +} + +h2 { + padding: .2em 0; + border-bottom: 1px solid #ddd; +} + +h3 { + margin-top: 35px; +} + +h4 { + margin-top: 30px; +} + +h5 { + margin-top: 25px; +} + +.wy-nav-content{ + max-width: none!important; +} + +.wy-side-nav-search{ + background: #2b38ff!important; +} + +.wy-side-nav-search input[type=text]{ + border-color:#4DA0B0!important; +} + +.wy-side-nav-search input[type=text]{ + border-radius: 4px!important; +} + +#caption-api { + background: red !important; +} + +#caption-text-api { + text-color: blue !important; +} diff --git a/v2.0.1/_static/doctools.js b/v2.0.1/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/v2.0.1/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/v2.0.1/_static/documentation_options.js b/v2.0.1/_static/documentation_options.js new file mode 100644 index 00000000..3b74bec4 --- /dev/null +++ b/v2.0.1/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '2.0.1', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/v2.0.1/_static/file.png b/v2.0.1/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/v2.0.1/_static/file.png differ diff --git a/v2.0.1/_static/hymd_icon_white.png b/v2.0.1/_static/hymd_icon_white.png new file mode 100644 index 00000000..d0396a17 Binary files /dev/null and b/v2.0.1/_static/hymd_icon_white.png differ diff --git a/v2.0.1/_static/hymd_logl_white_text_abbr.png b/v2.0.1/_static/hymd_logl_white_text_abbr.png new file mode 100644 index 00000000..8c0e50c8 Binary files /dev/null and b/v2.0.1/_static/hymd_logl_white_text_abbr.png differ diff --git a/v2.0.1/_static/jquery-3.5.1.js b/v2.0.1/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/v2.0.1/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. API reference

+
+

4.1. Integrator

+

Integrates equations of motion.

+

Implements the Velocity Verlet integrator. The reversible reference system +propagator algorithm (rRESPA) integrator uses the Velocity Verlet functions +inside the MD loop in the main module.

+
+
+hymd.integrator.integrate_position(positions, velocities, time_step)[source]
+

Position update step of the Velocity Verlet integration algorithm.

+

Computes the position update step of the Velocity Verlet algorithm. The +positions argument is not changed in place.

+
+
Parameters:
+
+
positions(N, D) numpy.ndarray

Array of positions of N particles in D dimensions.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_velocity

The velocity update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step, then the positions are updated a full step using the updated +velocities

+
+\[\mathbf{x}_{\text{new}} = \mathbf{x} + \Delta t \mathbf{v}\]
+
+ +
+
+hymd.integrator.integrate_velocity(velocities, accelerations, time_step)[source]
+

Velocity update step of the Velocity Verlet integration algorithm.

+

Computes the velocity update step of the Velocity Verlet algorithm. The +velocities argument is not changed in place.

+
+
Parameters:
+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
accelerations(N, D) numpy.ndarray

Array of accelerations of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_position

The position update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step

+
+\[\mathbf{v}_{\text{new}} = \mathbf{v} + \frac{\Delta t}{2m} +\mathbf{f}\]
+

before the positions are moved a full step using the updated half-step +velocities.

+
+ +
+
+

4.2. Thermostat

+

Scales or otherwise modifies the particle velocities during simulation to +simulate coupling to an external heat bath with temperature T₀.

+
+
+hymd.thermostat._random_chi_squared(prng: numpy.random._generator.Generator, M: int)float[source]
+

Draw the sum of M squared normally distributed values

+

The value is generated by the Gamma distribution, in lieu of generating +M Gaussian distributed numbers and summing their squares.

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
Mint

Number of standard normally distributed numbers in the sum.

+
+
+
+
Returns:
+
+
float

The sum of M squared normally distributed values centered at +zero with unit standard deviation.

+
+
+
+
+

Notes

+

The sum of the squares of k independent standard normal random variables is +distributed according to a \(\chi^2\) distribution.

+
+\[\chi^2_1 + \chi_2^2 + \chi_3^2 + \dots + \chi_M^2 +\sim +\sigma^2\chi^2(k)\]
+

This is a special case of the \(\Gamma\) distribution, +\(\Gamma(k/2, 2)\), and may be generated by

+
+\[\chi^2(k) \sim 2 \Gamma(k/2, 2)\]
+

References

+

Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of +Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. +J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246.

+
+ +
+
+hymd.thermostat._random_gaussian(prng: numpy.random._generator.Generator)float[source]
+

Draw a single random number from the standard normal distribution +Generate a number from the Gaussian distribution centered at zero with unit +standard deviation, \(N(0, 1)\).

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
+
+
Returns:
+
+
float

A random number drawn from \(N(0, 1)\).

+
+
+
+
+
+ +
+
+hymd.thermostat.csvr_thermostat(velocity: numpy.ndarray, names: numpy.ndarray, config: hymd.input_parser.Config, prng: numpy.random._generator.Generator, comm: mpi4py.MPI.Intracomm = <mpi4py.MPI.Intracomm object>, random_gaussian: Callable[[numpy.random._generator.Generator], float] = <function _random_gaussian>, random_chi_squared: Callable[[numpy.random._generator.Generator, int, float], float] = <function _random_chi_squared>, remove_center_of_mass_momentum: bool = True)numpy.ndarray[source]
+

Canonical sampling through velocity rescaling thermostat

+

Implements the CSVR thermostat. Rescales the system kinetic energy by a +stochastically chosen factor to keep the temperature constant. Requires +communcation of the kinetic energies calculated locally for each MPI rank. +The random numbers sampled through random_gaussian and +random_chi_squared are broadcast from the root rank to the other +ranks to ensure the scaling is performed with the same stochasticity for +all particles in the full system.

+

The velocities are cleaned of center of mass momentum before the thermostat +is applied, and the center of mass momentum is subsequently reapplied. This +is performed for each thermostat coupling group, i.e. the center of mass +momenta of each group is separately removed and reapplied after +thermostatting.

+

The implementation here is based on the derivation presented in the 2008 +Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper.

+
+
Parameters:
+
+
velocity(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
names(N,) numpy.ndarray

Array of particle names.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
random_gaussiancallable, optional

Function for generating standard normally distributed numbers.

+
+
random_chi_squaredcallable, optional

Function for generating \(\chi^2\)-distributed numbers

+
+
remove_center_of_mass_momentumbool, optional

If True, the center of mass of each coupling group is removed before +the thermostat is applied. The center of mass momenta are added back +after the kinetic energy rescaling is complete.

+
+
+
+
+
+

See also

+
+
_random_gaussian

Used to sample Gaussian-distributed numbers.

+
+
_random_chi_squared

Used to sample \(\chi^2\)-distributed numbers.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +

References

+

G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). +G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008).

+
+ +
+
+

4.3. Barostat

+
+

4.3.1. Berendsen Barostat

+

Implements the Berendsen barostat. +Scales the box and particle positions during simulation to +simulate coupling to an external pressure bath set at a +target pressure.

+

It calculates the scaling factor according to: +.. math:

+
\alpha_{L,N} = 1 - \frac{dt n_b}{\tau_p}\β(P_{L,N}^t - P_{L,N})
+
+
+

where \(dt\) is the outer rRESPA time-step, \(n_b\) is the frequency +of barostat calls, \(\tau_p\) is the pressure coupling time constant, +\(\beta\) is the isothermal compressibility, \(P_{L,N}^t\) and +\(P_{L,N}\) is the target and instantaneous internal pressure in the +lateral (L) and normal (N) directions respectively. Convention: Cartesian +z-direction is considered normal.

+

The box and particle positions are scaled in the L and N directions according +to the nature of the barostat (see functions isotropic and semiisotropic +below by an amount \(\α^{\frac{1}{3}}\).

+

The updated system information is passed on to the pmesh objects.

+
+

4.3.1.1. References

+

H. J. C. Berendsen, J. P. M. Postma, W. F. van Gunsteren, +A. DiNola, and J. R. Haak , “Molecular dynamics with coupling +to an external bath”, J. Chem. Phys. 81, 3684-3690 (1984)

+
+
+hymd.barostat.isotropic(pmesh, pm_stuff, phi, phi_q, psi, hamiltonian, positions, velocities, config, phi_fft, phi_laplacian, phi_transfer, bond_pr, angle_pr, step, prng, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Implements an isotropic Berendsen barostat. +The box and particle positions are scaled uniformly +in the L and N directions.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of pmesh objects.

+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fftlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds.

+
+
stepinteger

MD step number

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of modified/unmodified pmesh objects.

+
+
changeBoolean

Indicates whether or not any pmesh objects were reinitialized.

+
+
+
+
+
+ +
+
+hymd.barostat.semiisotropic(pmesh, pm_stuff, phi, phi_q, psi, hamiltonian, positions, velocities, config, phi_fft, phi_laplacian, phi_transfer, bond_pr, angle_pr, step, prng, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Implements a semiisotropic Berendsen barostat. +The box and particle positions are scaled by \(\alpha_L^{\frac{1}{3}}\) +in the L direction and by \(\alpha_N^{\frac{1}{3}}\) in the N direction.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of pmesh objects.

+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fftlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds.

+
+
stepinteger

MD step number

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of modified/unmodified pmesh objects.

+
+
changeBoolean

Indicates whether or not any pmesh objects were reinitialized.

+
+
+
+
+
+ +
+
+
+

4.3.2. SCR Barostat

+
+
+
+

4.4. Hamiltonian

+
+
+class hymd.hamiltonian.Hamiltonian(config)[source]
+

Interaction energy functional superclass

+
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+_setup()[source]
+

Superclass setup

+

Sets up the grid-independent filtering function H, and the +SymPy logic for symbolically differentiating interaction energy +functionals in Hamiltonian subclasses.

+
+ +
+ +
+
+class hymd.hamiltonian.SquaredPhi(config)[source]
+

Simple squared density interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + \sum_k \tilde\phi_k + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(rho_0\) is the +average density of the fully homogenous system. Expressing the species +densities in terms of fluctuations from the average,

+
+\[\mathrm{d}\tilde\phi_k = \rho_0 - \tilde\phi_k,\]
+

it is evident that this interaction energy functional is a slight change of +the DefaultNoChi Hamiltonian, as the expanded interaction energy +density becomes

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + 6\rho_0\left[ + \sum_k \mathrm{d}\tilde\phi_k + \right] + + + 9\rho_0^2 + + + \sum_k \mathrm{d}\tilde\phi_k^2 + + + \prod_{k\not=l} + \mathrm{d}\tilde\phi_k \mathrm{d}\tilde\phi_l + \right),\]
+

identical to DefaultNoChi apart from a constant energy shift +\(9\rho_0^2`(which does not impact dynamics) and the +:math:\)rho_0`–\(\mathrm{d}\tilde\phi_k\) cross-terms. These +cross-terms constitute contributions to the energy linear in +\(\mathrm{d}\tilde\phi_k\) absent in DefaultNoChi, which has +only quadratic terms present.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultNoChi(config)[source]
+

Incompressibility-only interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a +\right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. The SquaredPhi Hamiltonian implements a similar +functional with an additional linear term component depending on

+
+\[\mathmr{d}\tilde\phi_k = \tilde\phi_k - \rho_0\]
+

and not \(\mathrm{d}\tilde\phi_k^2\). No explicit inter-species +interaction is present apart from the indirect interaction through the +incompressibility.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultWithChi(config, unique_names, type_to_name_map)[source]
+

Incompressibility and \(\chi\)-interactions energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = + \frac{1}{2\rho_0} + \sum_{k,l}\chi_{kl} \tilde\phi_k \tilde\phi_l + + + \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. \(\chi_{ij}\) is the Flory-Huggins-like +inter-species mixing energy.

+
+
+__init__(config, unique_names, type_to_name_map)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup(unique_names, type_to_name_map)[source]
+

Setup the interaction energy potential and the external potential

+
+
Parameters:
+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+ +
+ +
+
+

4.5. Force

+

Calculates intramolecular forces between bonded particles in molecules

+
+
+class hymd.force.Angle(atom_1: str, atom_2: str, equilibrium: float, strength: float, atom_3: str)[source]
+

Dataclass representing a single three-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any three-particle bond between particles of specific types A, +B, and C (where A, B, and C may be +different or the same). Harmonic angular three-particle bonds in HyMD take +the form

+
+\[V_3(\mathbf{r}_1, \mathbf{r}_2, \mathbf{r}_3) = + \frac{1}{2}k + \left( + \cos^{-1} + \left[ + \frac{ + (\mathbf{r}_1-\mathbf{r}_2) + \cdot + (\mathbf{r}_3-\mathbf{r}_2) + } + { + \vert\mathbf{r}_1-\mathbf{r}_2\vert + \vert\mathbf{r}_3-\mathbf{r}_2\vert + } + \right] - \theta_0 + \right)^2\]
+
+

See also

+
+
Bond

Two-particle bond type dataclass

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
equilibriumfloat

Equilibrium angle at which the energy associated with the +three-particle angular bond vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient.

+
+
+
+
+
+
+atom_3: str
+
+ +
+ +
+
+class hymd.force.Bond(atom_1: str, atom_2: str, equilibrium: float, strength: float)[source]
+

Dataclass representing a single two-particle bond type

+

A bond type is a bond strength and equilibrium distance associated with +any bond between particles of specific types A and B +(where A and B may be the same or different). Harmonic +two-particle bonds in HyMD take the form

+
+\[V_2(\mathbf{r}_1, \mathbf{r}_2) = + \frac{1}{2}k + \left( + \vert \mathbf{r}_1 - \mathbf{r}_2 \vert - r_0 + \right)^2,\]
+

where \(k\) is the bond strength (spring constant) and \(r_0\) is +the equilibrium bond length (at which the energy is zero).

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
equilibriumfloat

Equilibrium distance at which the energy associated with the bond +vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient (spring constant).

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+equilibrium: float
+
+ +
+
+strength: float
+
+ +
+ +
+
+class hymd.force.Chi(atom_1: str, atom_2: str, interaction_energy: float)[source]
+

Dataclass representing a single \(\chi\) mixing interaction type

+

An interaction mixing energy type is a mixing energy associated with +density overlap between species of types A and B +(specified as inputs atom_1 and atom_2). A positive mixing +energy promotes phase separation, a negative mixing energy promotes mixing. +The interaction energy density (provided the DefaultWithChi +Hamiltonian is used) takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} + \sum_{k,l}\chi_{k,l} \tilde\phi_k\tilde\phi_l,\]
+

where \(\chi_{k,l}\) denotes the mixing energy between species +\(k\) and \(l\), with \(\kappa\) being the incompressibility. +The value of the interaction mixing energy parameter may be extracted from +Flory-Huggins theory.

+
+

See also

+
+
hymd.hamiltonian.DefaultWithChi

Interaction energy functional using \(\chi\)-interactions.

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
interaction_energyfloat

Interaction mixing energy.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+interaction_energy: float
+
+ +
+ +
+
+class hymd.force.Dielectric_type(atom_1: str, dielectric_value: float)[source]
+
+
+atom_1: str
+
+ +
+
+dielectric_value: float
+
+ +
+ +
+
+class hymd.force.Dihedral(atom_1: str, atom_2: str, atom_3: str, atom_4: str, coeffs: numpy.ndarray, dih_type: int)[source]
+

Dataclass representing a single four-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any four-particle torsional bond between particles of specific types +A, B, C, and D (where A, B, +C, and D may be different or the same). Dihedral +four-particle bonds in HyMD take different forms depending on the +dih_type parameter.

+

In the following, let \(\phi\) denote the angle between the planes +spanned by the relative positions of atoms A-B-C +and B-C-D. If dih_type = 0, then

+
+\[V_4(\phi) = \sum_n c_n + \left( + 1 + \cos\left[ + n\phi - d_n + \right] + \right),\]
+

where \(c_n\) are energy coefficients and \(d_n\) are propensity +phases. By default, the cosine sum is truncated at five terms. If +coeffs provides only a single float, this is used as the coiling +propensity parameter \(\lambda\). In this case, \(c_n\) and +\(d_n\) are automatically set to values which promote alpha helical +(\(\lambda=-1\)), beta sheet (\(\lambda=1\)), or a mixed +(\(1>\lambda>-1\)) structure (using values provided by Bore et al. +(2018)). In this case, the full potential takes the form

+
+\[V_4(\phi;\lambda) = + \frac{1}{2}(1-\lambda) V_{\text{prop},\alpha}(\phi) + + + \frac{1}{2}(1+\lambda) V_{\text{prop},\beta}(\phi) + + + (1-\vert\lambda\vert) V_{\text{prop}, \text{coil}}(\phi),\]
+

with each of the \(V_{\mathrm{prop}, X}\) being fixed cosine series +potentials with pre-set \(c_n\) -s and \(d_n\) -s.

+

If dih_type = 1, then a combined bending torsional (CBT) potential +is employed,

+
+\[V_4(\phi,\gamma;\lambda) = + V_4(\phi;\lambda) + + + \frac{1}{2}K(\phi)(\gamma - \gamma_0)^2,\]
+

where \(V_4(\phi;\lambda)\) specifies the potential as given by the +coiling propensity parameter above, \(K(\phi)\) is a separate cosine +series potential acting as the angular three-particle bond strength, and +\(\gamma_0\) is the three-particle bond equilibrium angle. In this +case, the coeffs parameter must specify both a \(\lambda\) +value, in additon to the energy and phases dictating the \(K(\phi)\) +potential.

+

References

+

Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018.

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
atom_4str

Type name of particle 4.

+
+
coeffslist[list[float]] or list[float] or numpy.ndarray

Dihedral coefficients defining the series expansion of the dihedral +energy.

+
+
dih_typeint

Specifies the type of dihedral used; If 0, then coeffs +must contain either two lists of five energy coefficients +\(c_n\) and five propensity phases \(d_n\) or a single +floating point number defining the \(\lambda\) coiling propensity +parameter. If 1, the combined bending-torsional potential is +used, and coeffs must specify \(\lambda\) and two lists +containing energy coefficients and propensity phases for the +\(V_\text{prop}\) propensity potential, defined in terms of cosine +series.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+atom_3: str
+
+ +
+
+atom_4: str
+
+ +
+
+coeffs: numpy.ndarray
+
+ +
+
+dih_type: int
+
+ +
+ +
+
+hymd.force.compute_angle_forces__plain(f_angles, r, bonds_3, box_size)[source]
+

Computes forces resulting from angular interactions

+
+

Deprecated since version 1.0.0: compute_angle_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_bond_forces__plain(f_bonds, r, bonds_2, box_size)[source]
+

Computes forces resulting from bonded interactions

+
+

Deprecated since version 1.0.0: compute_bond_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size)[source]
+

Computes forces resulting from dihedral interactions

+
+

Deprecated since version 1.0.0: compute_dihedral_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.dipole_forces_redistribution(f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb)[source]
+

Redistribute electrostatic forces calculated from topologically +reconstructed ghost dipole point charges to the backcone atoms of the protein.

+
+ +
+
+hymd.force.find_all_paths(G, u, n)[source]
+

Helper function that recursively finds all paths of given lenght ‘n + 1’ inside a network ‘G’. +Adapted from https://stackoverflow.com/a/28103735.

+
+ +
+
+hymd.force.prepare_bonds(molecules, names, bonds, indices, config, topol=None)[source]
+

Rearrange the bond information for usage in compiled Fortran kernels

+

Restructures the lists resulting from the execution of +prepare_bonds_old into numpy arrays suitable for calls to optimized +Fortran code calculating bonded forces and energiesself.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2_atom_1(B,) numpy.ndarray

Local index of particle 1 for each of B constructed +two-particle bonds.

+
+
bonds_2_atom_2(B,) numpy.ndarray

Local index of particle 2 for each of B constructed +two-particle bonds.

+
+
bonds_2_equilibrium(B,) numpy.ndarray

Equilibrium distance for each of B constructed two-particle +bonds.

+
+
bonds_2_strength(B,) numpy.ndarray

Bond strength for each of B constructed two-particle +bonds.

+
+
bonds_3_atom_1(A,) numpy.ndarray

Local index of particle 1 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_2(A,) numpy.ndarray

Local index of particle 2 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_3(A,) numpy.ndarray

Local index of particle 3 for each of A constructed +three-particle bonds.

+
+
bonds_3_equilibrium(A,) numpy.ndarray

Equilibrium angle for each of A constructed three-particle +bonds.

+
+
bonds_3_strength(A,) numpy.ndarray

Bond strength for each of A constructed three-particle +bonds.

+
+
bonds_4_atom_1(D,) numpy.ndarray

Local index of particle 1 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_2(D,) numpy.ndarray

Local index of particle 2 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_3(D,) numpy.ndarray

Local index of particle 3 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_4(D,) numpy.ndarray

Local index of particle 4 for each of D constructed +four-particle bonds.

+
+
bonds_4_coeff(D,) numpy.ndarray

Cosine series coefficients for each of D constructed +four-particle bonds.

+
+
bonds_4_type(D,) numpy.ndarray

Dihedral type for each of D constructed four-particle +bonds.

+
+
bonds_4_last(D,) numpy.ndarray

Flags indicating if dih_type is 1 for each of D +constructed four-particle bonds.

+
+
+
+
+
+

See also

+
+
prepare_bonds_old

Used internally to reconstruct the bonded interactions types from the connectivity information in the structure/topology input file and the bonded types specified in the configuration file.

+
+
+ +
+ +
+
+hymd.force.prepare_bonds_old(molecules, names, bonds, indices, config)[source]
+

Find bonded interactions from connectivity and bond types information

+
+

Deprecated since version 1.0.0: prepare_bonds_old was replaced by prepare_bonds for +use with compiled Fortran kernels prior to 1.0.0 release.

+
+

Prepares the necessary equilibrium and bond strength information needed by +the intramolecular interaction functions. This is performed locally on each +MPI rank, as the domain decomposition ensures that for all molecules all +consituent particles are always contained on the same MPI rankself.

+

This function traverses the bond connectivity information provided in the +structure/topology input file and indentifies any two-, three-, or +four-particle potential bonds. For each connected chain of two, three, or +four particles, a matching to bond types is attempted. If the corresponding +names match, a bond object is initialized.

+

In order to investigate the connectivity, a graph is created using +networkx functionality.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2list

List of lists containing local particle indices, equilibrium +distance, and bond strength coefficient for each reconstructed +two-particle bond.

+
+
bonds_3

List of lists containing local particle indices, equilibrium angle, +and bond strength coefficient for each reconstructed three-particle +bond.

+
+
bonds_4

List of lists containing local particle indices, dihedral type index, +and dihedral coefficients for each reconstructed four-particle +torsional bond.

+
+
bb_indexlist

List indicating the dihedral type of each four-particle bond in +bonds_4.

+
+
+
+
+
+

See also

+
+
Bond

Two-particle bond type dataclass.

+
+
Angle

Three-particle angular bond type dataclass.

+
+
Dihedral

Four-particle torsional bond type dataclass.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+hymd.force.prepare_index_based_bonds(molecules, topol)[source]
+
+ +
+
+hymd.force.propensity_potential_coeffs(x: float)[source]
+
+ +
+
+

4.6. Pressure

+
+
+hymd.pressure.comp_pressure(phi, phi_q, psi, hamiltonian, velocities, config, phi_fourier, phi_laplacian, phi_transfer, positions, bond_pr, angle_pr, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Computes total internal pressure of the system. +Kinetic pressure is trivially calculated from the kinetic energy. +Already computed bond and angle pressure terms are inserted into the +total internal pressure. +The field pressure equation is implemented.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fourierlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pressure(18,) numpy.ndarray

Pressure contributions from various energy terms. +0: due to kinetic energy +1-5: due to field energy +6-8: due to two-particle bonded terms +9-11: due to three-particle bonded terms (called angle terms) +12-14: due to four-particle bonded terms (called dihedral terms) +(defaults to 0 currently. Yet to be implemented) +15-17: total pressure in x,y,z directions.

+
+
+
+
+
+ +
+
+

4.7. Logger

+
+
+class hymd.logger.Logger[source]
+

Log output handler class

+

Notes

+

This wraps the default python library logging, see +docs.python.org/3/library/logging.html.

+
+
Attributes:
+
+
levelint

Determines the verbosity level of the log, corresponding to +logging.level. Numerical values 50 (logging.CRITICAL), +40 (logging.ERROR), 30 +(logging.WARNING), 20 (logging.INFO), +10 (logging.DEBUG), and 0 +(logging.UNSET) are supported values. Any log event message +less severe than the specified level is ignored. All other event +messages are emitted.

+
+
log_filestr

Path to output log file.

+
+
formatstr

Prepended dump string for each log event. Specifies the log event +level, the module emitting the event, the code line, the enclosing +function name, and the MPI rank writing the message.

+
+
date_formatstr

Prepends the date before all log event messages.

+
+
formatterlogging.Formatter

Formatter handling the prepending of the information in format and +date_format to each log event message. Used by default for all +loggers.

+
+
rank0logging.Logger

Default logger object for the root MPI rank.

+
+
all_rankslogging.Logger

Default logger object for messages being emitted from all MPI ranks +simultaneously.

+
+
+
+
+
+
+classmethod setup(default_level=20, log_file=None, verbose=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Sets up the logger object.

+

If a log_file path is provided, log event messages are output +to it. Otherwise, the logging messages are emitted to stdout.

+
+
Parameters:
+
+
default_levelint, optional

Default verbosity level of the logger. Unless specified, it is +10 (logging.INFO).

+
+
log_filestr, optional

Path to output log file. If None or not priovided, no log file is +used and all logging is done to stdout.

+
+
verbosebool, optional

Increases the logging level to 30 (logging.WARNING) +if True, otherwise leaves the logging level unchanged.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterRoot(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the root MPI rank log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterAll(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the all-MPI-ranks log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+

4.8. Input parser

+

Parses and handles the configuration information provided for the simulation

+
+
+class hymd.input_parser.Config(n_steps: int, time_step: float, mesh_size: Union[List[int], numpy.ndarray, int], sigma: float, kappa: float, dtype: Optional[numpy.dtype] = None, box_size: Optional[Union[List[float], numpy.ndarray]] = None, n_print: Optional[int] = None, tau: Optional[float] = None, start_temperature: Optional[Union[float, bool]] = None, target_temperature: Optional[Union[float, bool]] = None, mass: Optional[float] = None, hamiltonian: Optional[str] = None, domain_decomposition: Optional[Union[int, bool]] = None, integrator: Optional[str] = None, respa_inner: int = 1, file_name: str = '<config file path unknown>', name: Optional[str] = None, tags: List[str] = <factory>, bonds: List[hymd.force.Bond] = <factory>, angle_bonds: List[hymd.force.Angle] = <factory>, dihedrals: List[hymd.force.Dihedral] = <factory>, chi: List[hymd.force.Chi] = <factory>, n_particles: Optional[int] = None, max_molecule_size: Optional[int] = None, n_flush: Optional[int] = None, thermostat_work: float = 0.0, thermostat_coupling_groups: List[List[str]] = <factory>, initial_energy: Optional[float] = None, cancel_com_momentum: Union[int, bool] = False, coulombtype: Optional[str] = None, convergence_type: Optional[str] = None, pol_mixing: Optional[float] = None, dielectric_const: Optional[float] = None, conv_crit: Optional[float] = None, dielectric_type: List[hymd.force.Dielectric_type] = <factory>, self_energy: Optional[float] = None, type_charges: Optional[Union[List[float], numpy.ndarray]] = None, rho0: Optional[float] = None, a: Optional[float] = None, pressure: bool = False, barostat: Optional[str] = None, barostat_type: Optional[str] = None, tau_p: Optional[float] = None, target_pressure: List[hymd.barostat.Target_pressure] = <factory>, n_b: Optional[int] = None, m: List[float] = <factory>)[source]
+

Configuration object

+

Handles and verifies the simulation configuration specified in the +configuration file.

+
+

See also

+
+
hymd.input_parser.Bond

Two-particle bond type dataclass.

+
+
hymd.input_parser.Angle

Three-particle bond type dataclass.

+
+
hymd.input_parser.Dihedral

Four-particle bond type dataclass.

+
+
+ +
+
Attributes:
+
+
gas_constantfloat

Constant value of the gas constant, R (equivalently the Boltzmann +constant) in the units used internally in HyMD.

+
+
coulomb_constantfloat

Constant value of the Coulomb constant which converts electric field +values to forces and electric potential values to energies in the units +used internally in HyMD.

+
+
n_steps: int

Number of time steps in the simulation.

+
+
time_step: float

Outer time step used in the simulation. If the rRESPA intergrator is +used, the inner time step (the time step used in the integration of +intramolecular bending, stretching, and torsional forces) is +time_step / respa_inner.

+
+
box_sizelist[float] or (D,) numpy.ndarray

Simulation box size of simulation in D dimensions in units of +nanometers.

+
+
mesh_sizelist[int] or int or numpy.ndarray

Number of grid points used for the discrete density grid.

+
+
sigmafloat

Filter width representing the effective coarse-graining level of the +particles in the simulation.

+
+
kappafloat

Compressibility parameter used in the relaxed incompressibility term in +the interaction energy functional.

+
+
n_printint, optional

Frequency of trajectory/energy output to the H5MD trajectory/energy +output file (in units of number of time steps).

+
+
taufloat, optional

The time scale of the CSVR thermostat coupling.

+
+
start_temperaturefloat, optional

Generate starting temperature by assigning all particle velocities +randomly according to the Maxwell-Boltzmann distribution at +start_temperature Kelvin prior to starting the simulation.

+
+
target_temperaturefloat, optional

Couple the system to a heat bath at target_temperature Kelvin.

+
+
massfloat, optional

Mass of the particles in the simulation.

+
+
hamiltonianstr, optional

Specifies the interaction energy functional \(W[\tilde\phi]\) +for use with the particle-field interactions. Options: +SquaredPhi, DefaultNohChi, or DefaultWithChi.

+
+
domain_decompositionint, optional

Specifies the interval (in time steps) of domain decomposition +exchange, involving all MPI ranks sending and receiving particles +according to the particles’ positions in the integration box and the +MPI ranks’ assigned domain.

+
+
integratorstr, optional

Specifies the time integrator used in the simulation. Options: +velocity-verlet or respa.

+
+
respa_innerint, optional

The number of inner time steps in the rRESPA integrator. This denotes +the number of intramolecular force calculations (stretching, bending, +torsional) are performed between each impulse applied from the field +forces.

+
+
file_namestr, optional

File path of the parsed configuration file.

+
+
namestr, optional

Name for the simulation.

+
+
tagslist[str], optional

Tags for the simulation.

+
+
bondslist[Bond], optional

Specifies harmonic stretching potentials between particles in the +same molecule.

+
+
angle_bondslist[Angle], optional

Specifies harmonic angular bending potentials between particles in the +same molecule.

+
+
dihedralslist[Dihedral], optional

Specifies four-particle torsional potentials by cosine series.

+
+
chilist[Chi], optional

Specifies \(\chi\)-interaction parameters between particle +species.

+
+
n_particlesint, optional

Specifies the total number of particles in the input. Optional keyword +for validation, ensuring the input HDF5 topology has the correct number +of particles and molecules.

+
+
max_molecule_sizeint, optional

Maximum size of any single molecule in the system. Used to speed up +distribution of particles onto MPI ranks in a parallel fashion.

+
+
n_flushint, optional

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be +written to disk (in units of number of n_print).

+
+
thermostat_workfloat

Work performed by the thermostat on the system.

+
+
thermostat_coupling_groupslist[str], optional

Specifies individual groups coupling independently to the CSVR +thermostat. E.g. in a system containing "A", "B", and +"C" type particles, +thermostat_coupling_groups = [["A", "B"], ["C"],] would +thermalise types "A" and "B" together and couple +"C" type particles to a different thermostat (all individual +thermostats are at the same temperature, i.e. target_temperature +Kelvin).

+
+
initial_energyfloat

Value of the total energy prior to the start of the simulation.

+
+
cancel_com_momentumint, optional

If True, the total linear momentum of the center of mass is +removed before starting the simulation. If an integer is specifed, the +total linear momentum of the center of mass is removed every +remove_com_momentum time steps. If False, the linear +momentum is never removed.

+
+
coulombtypestr, optional

Specifies the type of electrostatic Coulomb interactions in the system. +The strength of the electrostatic forces is modulated by the relative +dielectric constant of the simulation medium, specified with the +dielectric_const keyword. Charges for individual particles are +specified in the structure/topology HDF5 input file, not in the +configuration file. If no charges (or peptide backbone dipoles) are +present, the electrostatic forces will not be calculated even if this +keyword is set to "PIC_Spectral".

+
+
dielectric_constfloat, optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. When +using helical propensity dihedrals, this keyword must be specified—even +if electrostatics are not included with the coulombtype +keyword.

+
+
dielectric_type: list[float], optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. The list assigns +relative dielectric values to each bead type, and an anisotropic +dielectric function is obtained from a weighted average.

+
+
+
+
+
+
+a: float = None
+
+ +
+
+angle_bonds: List[hymd.force.Angle]
+
+ +
+
+barostat: str = None
+
+ +
+
+barostat_type: str = None
+
+ +
+
+bonds: List[hymd.force.Bond]
+
+ +
+
+box_size: Union[List[float], numpy.ndarray] = None
+
+ +
+
+cancel_com_momentum: Union[int, bool] = False
+
+ +
+
+chi: List[hymd.force.Chi]
+
+ +
+
+conv_crit: float = None
+
+ +
+
+convergence_type: str = None
+
+ +
+
+coulomb_constant: ClassVar[float] = 138.935458
+
+ +
+
+coulombtype: str = None
+
+ +
+
+dielectric_const: float = None
+
+ +
+
+dielectric_type: List[hymd.force.Dielectric_type]
+
+ +
+
+dihedrals: List[hymd.force.Dihedral]
+
+ +
+
+domain_decomposition: Union[int, bool] = None
+
+ +
+
+dtype: numpy.dtype = None
+
+ +
+
+file_name: str = '<config file path unknown>'
+
+ +
+
+gas_constant: ClassVar[float] = 0.0083144621
+
+ +
+
+hamiltonian: str = None
+
+ +
+
+initial_energy: float = None
+
+ +
+
+integrator: str = None
+
+ +
+
+kappa: float
+
+ +
+
+m: List[float]
+
+ +
+
+mass: float = None
+
+ +
+
+max_molecule_size: int = None
+
+ +
+
+mesh_size: Union[List[int], numpy.ndarray, int]
+
+ +
+
+n_b: int = None
+
+ +
+
+n_flush: int = None
+
+ +
+
+n_particles: int = None
+
+ +
+
+n_print: int = None
+
+ +
+
+n_steps: int
+
+ +
+
+name: str = None
+
+ +
+
+pol_mixing: float = None
+
+ +
+
+pressure: bool = False
+
+ +
+
+respa_inner: int = 1
+
+ +
+
+rho0: float = None
+
+ +
+
+self_energy: float = None
+
+ +
+
+sigma: float
+
+ +
+
+start_temperature: Union[float, bool] = None
+
+ +
+
+tags: List[str]
+
+ +
+
+target_pressure: List[hymd.barostat.Target_pressure]
+
+ +
+
+target_temperature: Union[float, bool] = None
+
+ +
+
+tau: float = None
+
+ +
+
+tau_p: float = None
+
+ +
+
+thermostat_coupling_groups: List[List[str]]
+
+ +
+
+thermostat_work: float = 0.0
+
+ +
+
+time_step: float
+
+ +
+
+type_charges: Union[List[float], numpy.ndarray] = None
+
+ +
+ +
+
+hymd.input_parser.check_NPT_conditions(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check validity of barostat_type, barostat, +a, rho0, target_pressure, tau_p

+
+ +
+
+hymd.input_parser.check_angles(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_bonds(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_box_size(config, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_cancel_com_momentum(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_charges(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if charges across ranks sum to zero.

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of floats with charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_charges_types_list(config, types, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates a list of charge values of length types. +Charges are sorted according to type ID. Used in field.py. +# TODO: this is messy, we should fix it

+
+ +
+
+hymd.input_parser.check_chi(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_config(config, indices, names, types, charges, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs various checks on the specfied config to ensure consistency

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
indices(N,) numpy.ndarray

Array of integer indices for N particles.

+
+
names(N,) numpy.ndarray

Array of string names for N particles.

+
+
types(N,) numpy.ndarray

Array of integer type indices for N particles.

+
+
charges(N,) numpy.ndarray

Array of floats charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
Returns:
+
+
configConfig

Validated configuration object.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_dielectric(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Error handling for electrostatics. +Unit testing of toml/tomli input.

+
+ +
+
+hymd.input_parser.check_dihedrals(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_domain_decomposition(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_hamiltonian(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_integrator(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_m(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_mass(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_max_molecule_size(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_b(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_flush(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_particles(config, indices, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_print(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_name(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_start_and_target_temperature(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Validate provided starting and target thermostat temperatures

+

Assesses the provided temperature target and ensures it is a non-negative +floating point number or False. Ensures the starting temperature is +a non-negative floating point number or False.

+

If the value for either is None, the returned configuration object +has the values defaulted to False in each case.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
validated_configConfig

Configuration object with validated target_temperature and +start_temperature.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_tau(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_thermostat_coupling_groups(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.parse_config_toml(toml_content, file_path=None, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.read_config_toml(file_path)[source]
+
+ +
+
+hymd.input_parser.sort_dielectric_by_type_id(config, charges, types)[source]
+

Creates a list of length N CG-particles, sorted after the charges from +the input HDF5 file. Used in file_io.py

+
+ +
+
+

4.9. Field

+

Forces and energies from the discretized particle-field grid interactions

+
+
+hymd.field.compute_field_and_kinetic_energy(phi, phi_q, psi, velocity, hamiltonian, positions, types, v_ext, config, layouts, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the particle-field and kinetic energy contributions

+

Calculates the kinetic energy through

+
+\[E_k = \sum_j \frac{1}{2}m_j\mathbf{v}_j\cdot\mathbf{v}_j,\]
+

and the particle-field energy by

+
+\[E_\text{field} = \int\mathrm{d}\mathbf{r}\, + w[\tilde\phi],\]
+

where \(w\) is the interaction energy functional density.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
velocity(N,D) numpy.ndarray

Array of velocities for N particles in D dimensions. +Local for each MPI rank.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Local for each MPI rank–the full computational grid is +represented by the collective fields of all MPI ranks.

+
+
configConfig

Configuration object.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field

Computes the up-to-date external potential for use in calculating the particle-field energy.

+
+
+ +
+ +
+
+hymd.field.compute_field_energy_q_GPE(config, phi_eps, field_q_energy, dot_elec, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the electrostatic energy after electrosatic forces is +calculated.

+

From the definition of the elecrostatic potential \(\Psi\), the energy +is

+
+
+
W = frac{1}{2}intmathrm{d}mathbf{r},

epsilon(mathbf{r})} left(mathbf{E}cdot mathbf{E}right),

+
+
+
+

where \(\epsilon(\mathbf{r})}\) is the anisotropic, spatially dependent, +relative dielectric of the simulation medium.

+
+
Parameters:
+
+
confighymd.input_parser.Config

Configuration object.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
field_q_energyfloat

Total elecrostatic energy.

+
+
dot_elecpmesh.pm.RealField

Pmesh RealField object for storing \(|\mathbf{E(r)}|^{2}\) +on the computational grid. Local for each MPI rank – the full computational +grid is represented by the collective fields of all MPI ranks.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field_force_q_GPE

Compute the electrosatic force from an anisotropic dielectric general Poisson equation.

+
+
+ +
+ +
+
+hymd.field.compute_field_force(layouts, r, force_mesh, force, types, n_types)[source]
+

Interpolate particle-field forces from the grid onto particle positions

+

Backmaps the forces calculated on the grid to particle positions using the +window function \(P\) (by default cloud-in-cell [CIC]). In the +following, let \(\mathbf{F}_j\) denote the force acting on the +particle with index \(j\) and position \(\mathbf{r}_j\). The +interpolated force is

+
+\[\mathbf{F}_j = -\sum_k\nabla V_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(V_{j_k}\) is the discretized external potential at grid vertex +\(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid vertex +with index \(j_k\), and \(h^3\) is the volume of each grid voxel. +The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
r(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
force(N,D) numpy.ndarray

Array of forces for N particles in D dimensions. Local +for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
n_typesint

Number of different unique types present in the simulation system. +n_types is global, i.e. the same for all MPI ranks even if some +ranks contain zero particles of certain types.

+
+
+
+
+
+ +
+
+hymd.field.compute_self_energy_q(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the self energy for the interaction due to the Ewald scheme +used to compute the electrostatics. The energy is stored in config.

+

The self interaction energy is given by:

+
+\[U_{self} = \sqrt{\frac{1}{2\pi\sigma^2}} \sum_{i=1}^{N} q_i^2\]
+

where \(q_i\) are the charges and \(\sigma\) is the half-width +of the Gaussian filter.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
Returns:
+
+
field_q_self_energyfloat

Electrostatic self energy.

+
+
+
+
+
+ +
+
+hymd.field.domain_decomposition(positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs domain decomposition

+

Rearranges the MPI rank memory layout into one that better mimics the PFFT +pencil grid 2D decomposition. As molecules are always required to be fully +contained on a single MPI rank, a perfect decomposition is not always +possible. The best decomposition which leaves the center of mass of all +molecules in their respective correct domains is used, with possible +overlap into neighbouring domains if the spatial extent of any molecule +crosses domain boundaries.

+
+
Parameters:
+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
*args

Variable length argument list containing arrays to include in the +domain decomposition.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
bonds(N,M) numpy.ndarray, optional

Array of M bonds originating from each of N particles.

+
+
verboseint, optional

Specify the logging event verbosity of this function.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
Domain decomposedcode:positions and any array specified in
+
:code:`*args`, in addition tocode:bonds and molecules if these
+
arrays were provided as input.
+
+
+
+
+ +
+
+hymd.field.initialize_pm(pmesh, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates the necessary pmesh objects for pfft operations.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pmobject ‘pmesh.pm.ParticleMesh’
+
field_listlist[pmesh.pm.RealField], (multiple)

Essential list of pmesh objects required for MD

+
+
list_coulomblist[pmesh.pm.RealField], (multiple)

Additional list of pmesh objects required for electrostatics.

+
+
+
+
+
+ +
+
+hymd.field.update_field(phi, phi_laplacian, phi_transfer, layouts, force_mesh, hamiltonian, pm, positions, types, config, v_ext, phi_fourier, v_ext_fourier, m, compute_potential=False)[source]
+

Calculate the particle-field potential and force density

+

If compute_potential is True, the energy may subsequently +be computed by calling compute_field_and_kinetic_energy.

+

Computes the particle-field external potential \(V_\text{ext}\) from +particle number densities through the smoothed density field, +\(\phi(\mathbf{r})\). With \(P\) being the cloud-in-cell (CIC) +window function, the density and filtered densities are computed as

+
+\[\phi(\mathbf{r}) = \sum_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\phi(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +external potential is computed in reciprocal space as

+
+\[V_\text{ext} = \mathrm{FFT}^{-1}\left[ + \mathrm{FFT} + \left( + \frac{\partial w}{\partial \tilde\phi} + \right) + \mathrm{FFT}(H) +\right],\]
+

where \(w\) is the interaction energy functional. Differentiating +\(V_\text{ext}\) is done by simply applying \(i\mathbf{k}\) in +Fourier space, and the resulting forces are back-transformed to direct +space and interpolated to particle positions by

+
+\[\mathbf{F}_j = -\sum_{j_k} \nabla V_{j_k} + P(\mathbf{r}_{j_k} - \mathbf{r}_j)h^3,\]
+

where \(j_k\) are the neighbouring vertices of particle \(j\) at +position \(\mathbf{r}_j\), and \(h^3\) is the volume of each grid +voxel.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Pre-allocated, but empty; any values +in this field are discarded. Changed in-place. Local for each MPI +rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
configConfig

Configuration object.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Pre-allocated, but empty; any values in this field are +discarded Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
phi_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computational grid is represented by the collective fields of all +MPI ranks.

+
+
v_ext_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplesField objects containing discretized +particle-field external potential values in reciprocal space on the +computational grid; D+1 fields in D dimensions for each +particle type. D copies are made after calculation for later +use in force calculation, because the force transfer function +application differentiates the field in-place, ruining the contents +for differentiation in the remaining D-1 spatial directions. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
m: list[float], (M,)

pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. +Defaults to 1.0 for all particle types.

+
+
compute_potentialbool, optional

If True, a D+1-th copy of the Fourier transformed +external potential field is made to be used later in particle-field +energy calculation. If False, only D copies are made.

+
+
+
+
+
+

See also

+
+
compute_field_and_kinetic_energy

Compute the particle-field energy after the external potential is calculated.

+
+
+ +
+ +
+
+hymd.field.update_field_force_q(charges, phi_q, phi_q_fourier, psi, psi_fourier, elec_field_fourier, elec_field, elec_forces, layout_q, hamiltonian, pm, positions, config)[source]
+

Calculate the electrostatic particle-field forces on the grid

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential is computed in reciprocal space as

+
+\[\Phi = \mathrm{FFT}^{-1}\left[ + \frac{4\pi k_e}{\varepsilon \vert\mathbf{k}\vert^2} + \mathrm{FFT}(\rho)\mathrm{FFT}(H) +\right],\]
+

with the electric field

+
+\[\mathbf{E} = \mathrm{FFT}^{-1}\left[ + -i\mathbf{k}\,\mathrm{FFT}(\Psi) +\right].\]
+

In the following, let \(\mathbf{F}_j\) denote the electrostatic force +acting on the particle with index \(j\) and position +\(\mathbf{r}_j\). The interpolated electrostatic force is

+
+\[\mathbf{F}_j = \sum_k q_j\mathbf{E}_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(\mathbf{E}_{j_k}\) is the discretized electric field at grid +vertex \(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid +vertex with index \(j_k\), and \(h^3\) is the volume of each grid +voxel. The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty; any values in this field +are discarded. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
elec_field_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +electric field values in reciprocal space on the computational grid. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
+
+
+
+ +
+
+hymd.field.update_field_force_q_GPE(conv_fun, phi, types, charges, phi_q, phi_q_fourier, phi_eps, phi_eps_fourier, phi_eta, phi_eta_fourier, phi_pol_prev, phi_pol, elec_field, elec_forces, elec_field_contrib, psi, Vbar_elec, Vbar_elec_fourier, force_mesh_elec, force_mesh_elec_fourier, hamiltonian, layout_q, layouts, pm, positions, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Calculate the electrostatic particle-field forces on the grid, arising from +a general Poisson equation, i.e. anisotropic permittivity/dielectric. +The function is called when tomli input config.coulombtype = “PIC_Spectral_GPE.”

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential for a variable dielectric does not have an +analytical expression, and is computed in reciprocal through an iterative +method.

+

The GPE states that

+
+\[\nabla \cdot \left(\epsilon(\mathbf{r}) +\nabla{\mathbf{\psi(r)}}\right) = -\rho({\mathbf{r}}).\]
+

where \(\epsilon(\mathbf{r})\) is the relative dielectric function.

+
+
Parameters:
+
+
conv_funConvergence function.

Returns a scalar. Depends on MPI allreduce for similar convergence +across MPI ranks.

+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_eps_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_etapmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +gradients of the relative dielectric values on the computational grid. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank–the +full computational grid is represented by the collective fields of all MPI ranks.

+
+
phi_eta_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated discretized +Fourier transformed gradient relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_pol_prevpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charge values on the computational grid. Parameter in +the iterative method.Pre-allocated,but empty. Changedin-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_polpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charges on the computational grid. Parameter in the iterative +method, updating the next quess in solving for the electrostatic potential. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank– +the full computational grid is represented by the collective fields of +all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all +MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
elec_field_contribpmesh.pm.RealField

Pmesh RealField object for storing +\(|\mathbf{E(r)}|^2/\phi_{0}\) on the computational grid. +Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
psipmesh.pm.RealField

Pmesh RealField object for storing electrostatic potential +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
Vbar_elecmesh.pm.RealField

Pmesh RealField object for storing functional derivatives of +:math:`|w({ phi })_{elec}`on the computational grid. +Pre-allocated, but empty. Changed in-place. Local for each MPI rank– +the full computational grid is represented by the collective fields of

+
+

all MPI ranks.

+
+
+
Vbar_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated functional +derivatives of \(\|w(\{ \phi \})_{elec}\) in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
force_mesh_elecpmesh.pm.RealField

Pmesh RealField object for storing electrostatic force values +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
force_mesh_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated electrostatic +force values in reciprocal space on the computational grid. Local for +each MPI rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
layouts: list[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
comm: mpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
compute_field_energy_q_GPE

Compute the electrostatic energy after electrosatic force is calculated for a variable (anisotropic) dielectric general Poisson equation.

+
+
+ +
+ +
+
+

4.10. File input/output

+

Handle file input/output in parllel HDF5 fashion

+
+
+class hymd.file_io.OutDataset(dest_directory, config, double_out=False, disable_mpio=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

HDF5 dataset handler for file output

+
+
+close_file(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Closes the HDF5 output file

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+
+flush()[source]
+

Flushes output buffers, forcing file writes

+
+ +
+
+is_open(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if HDF5 output file is open

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+ +
+
+hymd.file_io.distribute_input(in_file, rank, size, n_particles, max_molecule_size=201, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Assign global arrays onto MPI ranks, attempting load balancing

+

Distributes approximately equal numbers of particles (workload) onto each +independent MPI rank, while respecting the requirement that any molecule +must be fully contained on a single MPI rank only (no splitting molecules +across multiple CPUs).

+
+
Parameters:
+
+
in_fileh5py.File

HDF5 input file object.

+
+
rankint

Local rank number for this MPI rank.

+
+
sizeint

Global size of the MPI communicator (number of total CPUs).

+
+
n_particlesint

Total number of particles.

+
+
max_molecule_sizeint, optional

Maximum size of any molecule present in the system. Used to initially +guess where the MPI rank boundaries (start/end indices) in the global +arrays should be placed. If molecules of size +>max_molecule_size exist in the simulation system, HyMD +might work as expected. Or it might fail spectacularly.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
rank_range

Starting and ending indices in the global arrays for each MPI rank.

+
+
+
+
+
+ +
+
+hymd.file_io.setup_time_dependent_element(name, parent_group, n_frames, shape, dtype, units=None)[source]
+

Helper function for setting up time-dependent HDF5 group datasets

+

All output groups must adhere to the H5MD standard, meaning a structure of

+
+
┗━ group particle group (e.g. all) or observables group
+
+
┗━ group time-dependent data
+
+
┣━ dataset step shape=(n_frames,)
+
┣━ dataset time shape=(n_frames,)
+
┗━ dataset value shape=(n_frames, *)
+
+
+
+

is necessary.

+

References

+
+
H5MD specification :

https://www.nongnu.org/h5md/h5md.html

+
+
+
+ +
+
+hymd.file_io.store_data(h5md, step, frame, indices, positions, velocities, forces, box_size, temperature, pressure, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, field_energy, field_q_energy, plumed_bias, time_step, config, velocity_out=False, force_out=False, charge_out=False, plumed_out=False, dump_per_particle=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Writes time-step data to HDF5 output file

+

Handles all quantities which change during simulation, as opposed to +static quanitities (see store_static).

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
stepint

Step number.

+
+
frameint

Output frame number (step // n_print).

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
positions(N,) numpy.ndarray

Array of positions for N particles in D dimensions.

+
+
velocities(N,) numpy.ndarray

Array of velocities for N particles in D dimensions.

+
+
forces(N,) numpy.ndarray

Array of forces for N particles in D dimensions.

+
+
box_size(D,) numpy.ndarray

Array containing the simulation box size.

+
+
temperaturefloat

Calculated instantaneous temperature.

+
+
kinetic_energyfloat

Calculated instantaneous kinetic energy.

+
+
bond2_energyfloat

Calculated instantaneous harmonic two-particle bond energy.

+
+
bond3_energyfloat

Calculated instantaneous harmonic angular three-particle bond energy.

+
+
bond4_energyfloat

Calculated instantaneous dihedral four-particle torsion energy.

+
+
field_energyfloat

Calculated instantaneous particle-field energy.

+
+
field_q_energyfloat

Calculated instantaneous electrostatic energy.

+
+
plumed_biasfloat

PLUMED instantaneous bias energy.

+
+
time_stepfloat

Value of the time step.

+
+
configConfig

Configuration object.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charge_outbool, optional

If True, electrostatic energies are written to the output +HDF5 file.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to the output HDF5 file.

+
+
dump_per_particlebool, optional

If True, all quantities are written per particle.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
store_static

Outputs all static time-independent quantities to the HDF5 output file

+
+
+ +
+ +
+
+hymd.file_io.store_static(h5md, rank_range, names, types, indices, config, bonds_2_atom1, bonds_2_atom2, molecules=None, velocity_out=False, force_out=False, charges=False, dielectrics=False, plumed_out=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Outputs all static time-independent quantities to the HDF5 output file

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
rank_rangelist[int]

Start and end indices for global arrays for each MPI rank.

+
+
names(N,) numpy.ndarray

Array of names for N particles.

+
+
types(N,) numpy.ndarray

Array of type indices for N particles.

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
configConfig

Configuration object.

+
+
bonds_2_atom1(B,) numpy.ndarray

Array of indices of the first particle for B total +two-particle bonds.

+
+
bonds_2_atom2(B,) numpy.ndarray

Array of indices of the second particle for B total +two-particle bonds.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles.

+
+
dielectrics(N,) numpy.ndarray

Array of particle relative dielectric values for N particles.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to output HDF5 file.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
prepare_bonds

Constructs two-, three-, and four-particle bonds from toplogy input file and bond configuration information.

+
+
distribute_input

Distributes input arrays onto MPI ranks, attempting load balancing.

+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/doc_pages/benchmarks.html b/v2.0.1/doc_pages/benchmarks.html new file mode 100644 index 00000000..90c9bb15 --- /dev/null +++ b/v2.0.1/doc_pages/benchmarks.html @@ -0,0 +1,317 @@ + + + + + + + 3. Benchmarks — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Benchmarks

+

Homopolymer melt test systems of \(30^2\), \(40^2\), and \(50^2\) +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively.

+
+

3.1. Bonded forces

+

Legend label denotes the number of particles in the system.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-1.png +
+
+
+

3.2. Particle–field forces

+

Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-2.png +
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/doc_pages/command_line.html b/v2.0.1/doc_pages/command_line.html new file mode 100644 index 00000000..852dd4f0 --- /dev/null +++ b/v2.0.1/doc_pages/command_line.html @@ -0,0 +1,374 @@ + + + + + + + 5. Command line arguments — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. Command line arguments

+

Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle–field interactions.

+
+

5.1. Required arguments

+
+
configuration file:
+

type positional

+

Specifies the .toml format configuration file containing simulation details. See Configuration file for details.

+
+
structure and topology file:
+

type positional

+

Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See Topology and structure file for details.

+
+
+
+
+

5.2. Optional arguments

+
+
-v  --verbose

type optional

+

Number of following arguments: 0 or 1

+

Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying -v or --verbose with no additional specification. This increases verbosity level by 1. Alternatively, it maye be specified by --verbose V with V being 0, 1, or 2.

+
+
--profile

type optional

+

Number of following arguments: 0

+

Enables code profiling using cProfile. This will output one profiling file per MPI rank invoked in the simulation.

+
+
--double-precision

type optional

+

Number of following arguments: 0

+

Specify usage of double precision internally in HyMD (including in the FFTs).

+
+
--double-output

type optional

+

Number of following arguments: 0

+

Specify usage of double precision in the output trajectory from HyMD.

+
+
--velocity-output

type optional

+

Number of following arguments: 0

+

Specify that velocities should be output to the HyMD trajectory.

+
+
--force-output

type optional

+

Number of following arguments: 0

+

Specify that forces should be output to the HyMD trajectory.

+
+
--disable-mpio

type optional

+

Number of following arguments: 0

+

Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult.

+
+
--logfile

type optional

+

Number of following arguments: 1

+

Specifies the path of a plain text log file in which stdout is mirrored during simulation runs.

+
+
--seed

type optional

+

Number of following arguments: 1

+

Specifies the random seed used in the numpy random library to generate velocities, thermostatting, etc.

+
+
--disable-bonds

type optional

+

Number of following arguments: 0

+

Disable any two-particle bonds present in the system.

+
+
--disable-angle-bonds

type optional

+

Number of following arguments: 0

+

Disable any three-particle bonds present in the system.

+
+
--disable-dihedrals

type optional

+

Number of following arguments: 0

+

Disable any four-particle bonds present in the system.

+
+
--disable-dipole

type optional

+

Number of following arguments: 0

+

Disable any topological reconstruction of peptide backbone dipoles present in the system.

+
+
--disable-field

type optional

+

Number of following arguments: 0

+

Disable any particle–field interactions present in the system.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/doc_pages/config_file.html b/v2.0.1/doc_pages/config_file.html new file mode 100644 index 00000000..2724c9ec --- /dev/null +++ b/v2.0.1/doc_pages/config_file.html @@ -0,0 +1,507 @@ + + + + + + + 3. Configuration file — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Configuration file

+

The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order.

+

The configuration file is a toml format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs.

+
+

3.1. Configuration file keywords

+

The following constitutes every possible keyword specification in HyMD +configuration files:

+
+

3.1.1. Metadata keywords

+

Configuration keywords specifying metadata for the H5MD output trajectory.

+
+
name:
+

string [optional, default: None]

+

Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file.

+
+
tags:
+

array [string] [optional, default: None]

+

Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file.

+
+
+
+
+

3.1.2. Particle keywords

+

Configuration keywords specifying properties of particles and molecules in the +system.

+
+
n_particles:
+

integer [optional, default: None]

+

Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules.

+
+
mass:
+

float [optional, default: 72.0] {units: \(\text{u}=\text{g}\,\text{mol}^{-1}\)}

+

Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal.

+
+
max_molecule_size:
+

integer [optional, default: 201]

+

Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code will crash if there are molecules larger than max_molecule_size in the topology/structure input file.

+
+
+
+
+

3.1.3. Simulation keywords

+

Configuration keywords specifying simulation parameters.

+
+
n_steps:
+

integer [required]

+

Total number of integration steps to perform for this simulation.

+
+
n_print:
+

integer or boolean [optional, default: False]

+

Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of number of time steps).

+
+
n_flush:
+

integer [optional, default: None]

+

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of number of n_print, i.e. n_print = 13, n_flush = 3 would result in the trajectory/energy being written to disk every 13 x 3 = 39 simulation steps)

+
+
time_step:
+

float [required] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time step per integration step. If the rRESPA multiple time step integrator is used (integrator = "respa"), this specifies the inner time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is respa_inner times the time_step , and the total simulation time is n_steps times time_step times respa_inner .

+
+
box_size:
+

array [float] [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable.

+
+
integrator:
+

string [required] (options: velocity-verlet or respa)

+

Specifies the time integrator used in the simulation. If respa, the reversible reference system propagator algorithm (rRESPA) [Tuckerman et al., 1992] integrator is used, with respa_inner number of inner (intramolecular force) time steps. If velocity-verlet, a normal Velocity Verlet integrator is used. If respa and respa_inner = 1, the rRESPA integrator is equivalent to the Velocity Verlet.

+
+
respa_inner:
+

integer [optional, default: 1]

+

The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces.

+
+
domain_decomposition:
+

integer or boolean [optional, default: False]

+

Specifies the interval (in time steps) of domain decomposition exchange, involving all MPI ranks sending and receiving particles according to the particles’ positions in the integration box and the MPI ranks’ assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If True, the decomposition is performed once (before starting the simulation). If False, no decomposition is performed.

+
+
cancel_com_momentum:
+

integer or boolean [optional, default: False]

+

If True, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every remove_com_momentum time steps. If False, the linear momentum is never removed.

+
+
start_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at start_temperature Kelvin prior to starting the simulation. If False, the velocities are not changed before starting the simulation.

+
+
target_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Couple the system to a heat bath at target_temperature Kelvin by applying a Canonical sampling through velocity rescaling [Bussi et al., 2007] thermostat with coupling strength tau. If False, no temperature control is applied.

+
+
tau:
+

float [optional, default: 0.7] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the CSVR thermostat coupling. In the limit of tau , the Hamiltonian dynamics are preserved and no temperature coupling takes place.

+
+
thermostat_coupling_groups:
+

array [array [string]] [optional, default: []]

+

Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing "A", "B", and "C" type particles, thermostat_coupling_groups = [["A", "B"], ["C"],] would thermalise types "A" and "B" together and couple "C" type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. target_temperature Kelvin).

+
+
hamiltonian:
+

string [optional, default: "DefaultNohChi"] (options: SquaredPhi, DefaultNohChi, or DefaultWithChi)

+

Specifies the interaction energy functional \(W[\tilde\phi]\) for use with the particle-field interactions. See Interaction energy functionals for details.

+
+
+
+
+

3.1.4. Field keywords

+

Configuration keywords specifying field parameters.

+
+
mesh_size:
+

array [integer] or integer [required]

+

Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is box_size / mesh_size.

+
+
kappa:
+

float [required] {units: \(\text{kJ}^{-1}\text{mol}\)}

+

Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional \(W[\tilde\phi]\). See Interaction energy functionals for more details.

+
+
sigma:
+

float [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See Filtering for more details.

+
+
chi:
+

array [array [string, float]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\)}

+

Array of \(\tilde\chi_\text{AB}\)-parameters indicating the strength of the repulsive or attractive interaction between particles of type "A" and the number density due to particles of type "B", and vice versa. Example: chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ] would specify a repulsive "A""B" type interaction, and a weakly attractive "C""D" interaction. Self-interaction \(\tilde\chi\)-terms are always zero. See Interaction energy functionals for more details.

+
+
+
+
+

3.1.5. Bond keywords

+

Configuration keywords specifying bonds and bonds parameters.

+
+
bonds:
+

array [array [2 string, 2 float]] [optional, default: []] {units: \(\text{nm}=10^{-9}~\text{m}\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+

Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ] indicates a "A""A" bond of equilibrium length 0.47 \(\text{nm}\) with a bond strength of 980.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding bond between "A" and "B" type particles with equilibrium length 0.31 \(\text{nm}\) and a strength of 1250.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify stretching bonds.

+
+
angle_bonds:
+

array [array [3 string, 2 float]] [optional, default: []] {units: \({}^\circ\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+
+

Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ] indicates a "A""A""A" angular bond that tries to keep the bond linear at 180 degrees with a bending strength of 55.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding angle bond between "A""B""B" prefering the angle at 120 degrees and a strength of 25.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify angular bonds.

+
+
+
dihedrals:
+

array [array [4 string, integer, COSINE SERIES ]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)}

+

Specifies four-particle torsional potentials by cosine series. See Intramolecular bonds for details about how to specify dihedrals.

+
+
+
+
+

3.1.6. Electrostatic keywords

+

Configuration keywords specifying electrostatics and electrostatic parameters.

+
+
coulombtype:
+

string [optional, default: None] (options: PIC_Spectral)

+

Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the dielectric_const keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, not in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to PIC_Spectral.

+
+
dielectric_const:
+

float [optional, default: None]

+

Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified—even if electrostatics are not included with the coulombtype keyword.

+
+
+
+
+

3.1.7. Pressure keywords

+

Configuration keywords specifying pressure and barostat parameters.

+
+

3.1.7.1. Simulation keywords

+
+
pressure:
+

boolean [optional, default: False]

+

Specifies whether or not to calculate total internal pressure vector.

+
+
barostat:
+

string [optional, default: None](options: isotropic or semiisotropic)

+

Specifies whether to apply pressure constraints equally in all 3 Cartesian directions (isotropic) or equally in xy and different in z (semiisotropic).

+
+
barostat_type:
+

string [optional, default: berendsen](options: berendsen or scr)

+

Specifies the type of barostat to use. berendsen is more suitable for equilibration and scr for equilibrium data collection.

+
+
n_b:
+

integer [optional, default: 1]

+

Frequency of barostat call in number of outer rRESPA steps.

+
+
tau_p:
+

float [optional, default: 10 tau if tau < 0.1 else 1.0] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the barostat coupling.

+
+
target_pressure:
+

array [float] [optional, default: :code:1] {units: bar}

+

Couples the system to an external pressure set to target_pressure.

+
+
+
+
+

3.1.7.2. Field keywords

+
+
rho0:
+

float [optional, default: :code:average density] {units: \(\text{nm}^{-3}\)}

+

Intrinsic parameter corresponding to the specific volume of a coarse-grained particle. Typically: 8.66

+
+
a:
+

float [required] {units: \(\text{nm}^{-3}\)}

+

Calibrated parameter to obtain the correct average density at the target temperature and pressure. Typically: 9.21

+
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/doc_pages/constants_and_units.html b/v2.0.1/doc_pages/constants_and_units.html new file mode 100644 index 00000000..e7860f3d --- /dev/null +++ b/v2.0.1/doc_pages/constants_and_units.html @@ -0,0 +1,408 @@ + + + + + + + 6. Constants and Units — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

6. Constants and Units

+

HyMD uses the following units and constants internally and in all input and +output:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Units

Quantity

Symbol

Unit

length

\(r\)

\(\text{nm}=10^{-9}~\text{m}\)

time

\(t\)

\(\text{ps}=10^{-12}~\text{s}\)

charge

\(q\)

\(e=1.602176634 \cdot 10^{-19}~\text{C}\)

mass

\(m\)

\(\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}\)

temperature

\(\text{T}\)

\(\text{K}\)

energy

\(E\)

\(\text{kJ}\,\text{mol}^{-1}\)

velocity

\(v\)

\(\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}\)

momentum

\(P\)

\(\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}\)

force

\(\mathbf{F}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}\)

pressure

\(p\)

\(\text{bar}=100~\text{kPa}\)

electric potential

\(\Psi\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}\)

electric field

\(\mathbf{E}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}\)

compressibility

\(\kappa\)

\(\text{mol}\,\text{kJ}^{-1}\)

field-interaction

\(\tilde\chi\)

\(\text{kJ}\,\text{mol}^{-1}\)

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants

Constant

Symbol

Value

gas constant

\(R\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Boltzmann’s constant

\(k_\text{B}\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Avogadro’s constant

\(N_\text{A}\)

\(6.02214076 \cdot 10^23~\text{mol}^{-1}\)

Vacuum permittivity

\(\varepsilon_0\)

\(8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2\)

Coulomb constant

\(k_\text{e}\)

\(138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}\)

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/doc_pages/electrostatics.html b/v2.0.1/doc_pages/electrostatics.html new file mode 100644 index 00000000..b495573f --- /dev/null +++ b/v2.0.1/doc_pages/electrostatics.html @@ -0,0 +1,329 @@ + + + + + + + 3. Electrostatic interactions — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Electrostatic interactions

+

In the filtered Hamiltonian hPF formalism [Bore and Cascella, 2020] the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle–mesh Ewald.

+

The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered

+
+\[\tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i),\]
+

with \(q_i\) being the charge of particle \(i\) and \(H\) is the +filtering function (see Filtering). The value of the charge grid at +vertex \((i,j,k)\) is found by

+
+\[\tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)]\]
+

and the electrostatic potential \(\Psi_{ijk}\)

+
+\[\Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right],\]
+

where \(k_\text{e}\) is the Coulomb constant \(1/4\pi\varepsilon_0\). +The electric field is obtained by differentiation of the electrostatic +potential in Fourier space,

+
+\[\mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)]\]
+

from which the forces are interpolated back to the particle positions.

+
+

3.1. Specifying electrostatics

+

In HyMD, electrostatics are specified by the coulombtype and +dielectric_const keywords in the configuration file (see +Configuration file) and the /charge dataset in the HDF5 format +structure/topology input file (see Topology and structure file). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/doc_pages/examples.html b/v2.0.1/doc_pages/examples.html new file mode 100644 index 00000000..88fc5fbb --- /dev/null +++ b/v2.0.1/doc_pages/examples.html @@ -0,0 +1,777 @@ + + + + + + + 1. Examples — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Examples

+

The following examples are ordered in more or less order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the HyMD-tutorial github repository.

+
+

1.1. Ideal gas

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true +

The simplest possible system is one with no interactions at all—intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like:

+
+
ideal_gas.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = false         # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+
+
+

A simple input structure/topology file ideal_gas.HDF5 is available in +the HyMD-tutorial/ideal_gas github repository (along with the code to +generate it). Run the (very) short simulation by

+
python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field   \
+                                              --velocity-output \
+                                              --force-output
+
+
+

with the --disable-field argument to completely turn off all +particle–field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook ideal_gas.ipynb for details.

+
+
+

1.2. Ideal chains

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true +

The simplest available interaction is the harmonic two-particle bond (see +Intramolecular bonds),

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2.\]
+

Extending the configuration file from the ideal gas case, we need to add a +bonds specification. Note that the [bonds] meta specifier is not +necessary, but may be used to help organise the input file.

+
+
ideal_chain.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+
+
+

A simple input structure/topology file ideal_chain.HDF5 with a few +coiled up ideal chain polymers is available in the +HyMD-tutorial/ideal_chain github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field
+
+
+

we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +ideal_chain.ipynb.

+
+
+

1.3. Stiff rods

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true +

Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the i--j--k angle \(\theta\) (see +Intramolecular bonds),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2.\]
+

Extending the configuration file from the ideal chain case, we need to add a +angle_bonds specification. Note that the [bonds] meta specifier +is not necessary, but may be used to help organise the input file.

+
+
rods.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+angle_bonds = [
+  ["A", "A", "A", 180.0, 100.0],   # (i, j, k, equilibrium angle, strength)
+]
+
+
+
+

A simple input structure/topology file rods.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook rods.ipynb.

+
+
+

1.4. Helixes

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true +

Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle \(\phi\) between the +i--j--k plane and the j--k--l plane (see Intramolecular bonds),

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n).\]
+

The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a dihedrals keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the dielectric_const +keyword even though we are not including electrostatic forces in the current +simulation. Note that the [bonds] meta specifier is not necessary, but +may be used to help organise the input file.

+
+
helixes.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+dielectric_const = 15.0
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.31, 10000.0],       # (i name, j name, equilibrium length, strength)
+]
+
+dihedrals = [
+  [
+    ["A", "A", "A", "A"],
+    [
+      [-1],
+      [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+      [0.08, 0.46, 1.65, -0.96, 0.38],
+    ],
+    [1.0]
+  ],
+]
+
+
+
+

A simple input structure/topology file helixes.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook helixes.ipynb.

+
+
+

1.5. Phase separation

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true +

The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types A and B. Using the Hamiltonian

+
+\[\mathcal{H}=H_0+W\]
+

with \(\tilde\chi\)–dependent interactions defined by (specified in the +configuration file by hamiltonian = DefaultWithChi):

+
+\[W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2.\]
+
+
phase_separation.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+
+[field]
+mesh_size = [20, 20, 20]           # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+kappa = 0.05                       # compressibility in mol/kJ
+chi = [
+  ['A', 'B', 5.0],                 # (name i, name j, strength)
+]
+
+
+
+

A simple input structure/topology file phase_separation.HDF5 containing +an equal number of A type and B type particles is available in +the HyMD-tutorial/phase_separation github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd phase_separation.toml phase_separation.HDF5
+
+
+

we may examine the resulting trajectory. In the case of a low interaction +strength \(\tilde\chi\) of 5.0 (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to 40.0 (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +phase_separation.ipynb.

+
+
+

1.6. Diblock copolymers

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true +

Having introduced particle–field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive \(\tilde\chi\)–interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the integrator = "respa" keyword. Putting the pieces together, the +configuration file may look like the following:

+
+
copolymer.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 15
+n_steps = 2000                     # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [10.0, 10.0, 10.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [50, 50, 50]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+chi = [
+  ["A", "B", 30.0],                # (i, j, strength)
+]
+
+[bonds]
+bonds = [
+  ["A", "A", 0.25, 1500.0],        # (i, j, equilibrium length, strength)
+  ["A", "B", 0.25, 1500.0],
+  ["B", "B", 0.25, 1500.0],
+]
+angle_bonds = [
+  ["A", "A", "A", 180.0, 25.0],    # (i, j, k, equilibrium angle, strength)
+  ["B", "B", "B", 180.0, 25.0],
+]
+
+
+
+

A simple input structure/topology file copolymer.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/copolymer github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten A followed by ten B type particles. +Running the simulation with

+
python3 -m hymd copolymer.toml copolymer.HDF5
+
+
+

the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +copolymer.ipynb.

+
+
+

1.7. Lipid bilayer self-assembly

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true +

Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field–particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the thermostat_coupling_groups keyword. With parameters +optimised in [Ledum et al., 2020], the configuration file looks like:

+
+
lipid_self_assembly.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 25
+n_steps = 3000
+n_print = 200
+n_flush = 1
+time_step = 0.01
+box_size = [9.96924, 9.96924, 10.03970]
+start_temperature = 323
+target_temperature = 323
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.05
+domain_decomposition = 10001
+cancel_com_momentum = true
+max_molecule_size = 15
+thermostat_coupling_groups = [
+  ["N", "P", "G", "C"],
+  ["W"],
+]
+
+[field]
+mesh_size = [25, 25, 25]
+sigma = 1.0
+chi = [
+  ["C", "W", 42.24],
+  ["G", "C", 10.47],
+  ["N", "W", -3.77],
+  ["G", "W", 4.53],
+  ["N", "P", -9.34],
+  ["P", "G", 8.04],
+  ["N", "G", 1.97],
+  ["P", "C", 14.72],
+  ["P", "W", -1.51],
+  ["N", "C", 13.56],
+]
+
+[bonds]
+bonds = [
+  ["N", "P", 0.47, 1250.0],
+  ["P", "G", 0.47, 1250.0],
+  ["G", "G", 0.37, 1250.0],
+  ["G", "C", 0.47, 1250.0],
+  ["C", "C", 0.47, 1250.0],
+]
+angle_bonds = [
+  ["P", "G", "G", 120.0, 25.0],
+  ["P", "G", "C", 180.0, 25.0],
+  ["G", "C", "C", 180.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

A randomly mixed input structure/topology file +lipid_self_assembly.HDF5 with a few hundred lipids in a roughy +10 x 10 x 10nm box is available in the +HyMD-tutorial/lipid_self_assembly github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation

+
python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5
+
+
+

we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook lipid_self_assembly.ipynb.

+
+
+

1.8. Peptide in lipid bilayer

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true +

Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer.

+

The configuration file is available in the HyMD-tutorial/peptide github +repository (omitted here for brevity).

+

A pre-equilibrated input structure/topology file peptide.HDF5 with a +few hundred lipids in a roughy 20 x 20 x 20nm box is available in the +HyMD-tutorial/peptide github repository. Running the simulation

+
python3 -m hymd peptide.toml peptide.HDF5
+
+
+

we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook peptide.ipynb.

+
+
+

1.9. SDS

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true +

The last part we introduce is explicit electrostatic interactions through +particle–mesh Ewald. Enabling the electrostatic calculations is done via the +coulombtype keyword. "PIC_Spectral" is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the dielectric_const keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge.

+
+
sds.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 10
+n_steps = 3000
+n_print = 1500
+n_flush =
+time_step = 0.01
+box_size = [8.3, 8.3, 8.3]
+start_temperature = 298
+target_temperature = 298
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.1
+domain_decomposition = 10000
+cancel_com_momentum = true
+max_molecule_size = 5
+thermostat_coupling_groups = [
+  ["S", "C"],
+  ["W", "Na"],
+]
+dielectric_const = 45.0              # dielectric constant for the simulation medium
+coulombtype = "PIC_Spectral"         # particle in cloud, spectral method
+
+[field]
+mesh_size = [64, 64, 64]
+sigma = 0.5
+chi = [
+  ["S", "C",  13.50],
+  ["S", "Na",  0.00],
+  ["S", "W",  -3.60],
+  ["C", "Na", 13.50],
+  ["C", "W",  33.75],
+  ["W", "Na",  0.00],
+]
+
+[bonds]
+bonds = [
+  ["S",   "C",   0.50, 1250.0],
+  ["C",   "C",   0.50, 1250.0],
+]
+angle_bonds = [
+  ["S", "C", "C", 170.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

An input structure/topology file sds.HDF5 with a couple thousand +randomly dispersed SDS chains is available in the HyMD-tutorial/sds github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a /charge dataset. +Running the simulation with

+
python3 -m hymd sds.toml sds.HDF5
+
+
+

we observe the aggregation of the SDS into micellular structures—first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook sds.ipynb.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/doc_pages/filtering.html b/v2.0.1/doc_pages/filtering.html new file mode 100644 index 00000000..da167af4 --- /dev/null +++ b/v2.0.1/doc_pages/filtering.html @@ -0,0 +1,316 @@ + + + + + + + 2. Filtering — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Filtering

+

The default grid-independent filter function used in HyMD is a Gaussian

+
+\[H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right]\]
+

with reciprocal space representation

+
+\[\hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right].\]
+

The coarse-graining parameter \(\sigma\) determines a length scale of +particle extent and is given as configuration file input by

+
sigma = 0.75
+
+
+
+

2.1. Implementing new filters

+

Implementing new filter functions is straightforward by hijacking +the setup method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/doc_pages/installation.html b/v2.0.1/doc_pages/installation.html new file mode 100644 index 00000000..f68c97d1 --- /dev/null +++ b/v2.0.1/doc_pages/installation.html @@ -0,0 +1,558 @@ + + + + + + + 1. Installation — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Installation

+
+

1.1. Dependencies

+
+

Note

+

HyMD requires Python ≥3.6. Python version 3.9 is most likely fine +to use, but HyMD is only regularly tested with Python3.8 at the moment.

+ +
+

Warning

+

MPI-enabled h5py may fail to build under Python3.10. In this case, a +fall-back to Python3.9 or lower may be necessary.

+ +

Installing non-Python dependencies may be done by

+
+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-openmpi-dev  # Install MPI-enabled HDF5
+sudo apt-get install -y pkg-config           # Install pkg-config, required for h5py install
+sudo apt-get install -y curl wget
+
+
+
+
+

Warning

+

There might be memory leaks when using HyMD with OpenMPI 4.1.1. +Therefore, using a newer version of OpenMPI is recommended. +See Issue #186 for more details.

+ +

Installing Python dependencies may be done by

+
+
python3 -m pip install --upgrade pip
+CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+python3 -m pip install mpi4py numpy cython
+
+
+
+
+

Warning

+

If MPI-enabled HDF5 and h5py can not be installed, limited support +for serial HDF5 is available. Note that having MPI-enabled file IO is +highly recommended, and simulation performance under serial HDF5 will +potentially be very low.

+

Example dependency install on Ubuntu (apt) using serial HDF5:

+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-serial-dev   # Install serial HDF5
+sudo apt-get install -y curl wget
+
+python3 -m pip install h5py mpi4py numpy cython
+
+
+

Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +--disable-mpio argument to HyMD, see Command line arguments. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial.

+ +
+
+

1.2. Installing HyMD

+

HyMD may be installed using pip by

+
python3 -m pip install hymd
+
+
+
+
+

1.3. Install in docker

+

A docker image with build essentials setup is available at dockerhub with tag +mortele/hymd,

+
docker pull mortele/hymd:latest
+docker run -it mortele/hymd
+/app$ python3 -m pip install hymd
+
+# Grab example input files
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5
+
+# Run simulation
+/app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose
+
+
+
+
+

1.4. Run interactively in Google Colaboratory

+

A Google Colaboratory jupyter notebook is setup here with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons.

+
+
+

1.5. Common issues

+
+

1.5.1. Numpy errors while importing the Fortran force kernels

+
RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd
+
+Traceback (most recent call last):
+
+  (...)
+
+File "/..../HyMD/hymd/__init__.py", line 2, in <module>
+  from .main import main  # noqa: F401
+File "/..../HyMD/hymd/main.py", line 10, in <module>
+  from .configure_runtime import configure_runtime
+File "/..../hymd/configure_runtime.py", line 12, in <module>
+  from .input_parser import read_config_toml, parse_config_toml
+File "/..../HyMD/hymd/input_parser.py", line 12, in <module>
+  from .force import Bond, Angle, Dihedral, Chi
+File "/..../HyMD/hymd/force.py", line 8, in <module>
+  from force_kernels import (  # noqa: F401
+ImportError: numpy.core.multiarray failed to import
+
+
+

can normally be fixed by updating numpy versions,

+
python3 -m pip install -U numpy
+
+
+
+
+

1.5.2. Error building pfft-python due to missing curl/wget

+
Building wheel for pfft-python (setup.py) ... error
+ERROR: Command errored out with exit status 1:
+command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_
+cwd: /tmp/pip-install-fr6nt9m4/pfft-python/
+Complete output (56 lines):
+running bdist_wheel
+running build
+running build_py
+
+  (...)
+
+curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found
+wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found
+Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+Please check curl or wget
+You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/
+Traceback (most recent call last):
+  File "<string>", line 1, in <module>
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in <module>
+    setup(
+  File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup
+    return distutils.core.setup(**attrs)
+  File "/usr/lib/python3.8/distutils/core.py", line 148, in setup
+
+  (...)
+
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions
+    build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:]))
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft
+    raise ValueError("could not build fftw; check MPICC?")
+ValueError: could not build fftw; check MPICC?
+----------------------------------------
+ERROR: Failed building wheel for pfft-python
+Running setup.py clean for pfft-python
+Failed to build pfft-python
+
+
+

can be fixed by installing either curl or wget

+
apt-get install -y curl wget
+
+
+
+
+

1.5.3. Error running parallel HyMD without MPI-enabled h5py

+
Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    main()
+  File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    raise ValueError("h5py was built without MPI support, can't use mpio driver")
+ValueError: h5py was built without MPI support, can't use mpio driver
+
+
+

Can be fixed by installing a MPI-enabled h5py through

+
python3 -m pip uninstall -y h5py
+HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/doc_pages/interaction_energy_functionals.html b/v2.0.1/doc_pages/interaction_energy_functionals.html new file mode 100644 index 00000000..335fdf21 --- /dev/null +++ b/v2.0.1/doc_pages/interaction_energy_functionals.html @@ -0,0 +1,369 @@ + + + + + + + 1. Interaction energy functionals — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Interaction energy functionals

+

A few interaction energy functionals \(W\) are defined in HyMD through +the Hamiltonian class and associated subclasses.

+
+

1.1. \(\chi\)–interaction and \(\kappa\)–incompressibility

+

The most common hPF energy functional is specified by

+
hamiltonian = "DefaultWithChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where \(\tilde\chi_{\text{A}-\text{B}}\) is the interaction energy between +overlapping densities of particle types \(\text{A}\) and \(\text{B}\). +The incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\tilde\chi\) +and \(\kappa\) in the configuration file (see Configuration file)

+
kappa = 0.05
+chi = [
+   ["A", "B", 15.85],
+   ["B", "C", -5.70],
+   ...
+]
+
+
+
+
+

1.2. Only \(\kappa\)–incompressibility

+

The only \(\kappa\) interactions energy functional is specified by

+
hamiltonian = "DefaultNoChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where the incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.3. Only \(\phi^2\)

+

The \(\phi^2\) interactions energy functional is specified by

+
hamiltonian = "SquaredPhi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2,\]
+

where the \(\phi\) squared term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.4. Implementing new interaction energy forms

+

Implementing new interaction energy functions is straightforward by subclassing +Hamiltonian and applying sympy differentiation to the symbolic +field objects. The sympy.lamdify function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/doc_pages/intramolecular_bonds.html b/v2.0.1/doc_pages/intramolecular_bonds.html new file mode 100644 index 00000000..b57b08b4 --- /dev/null +++ b/v2.0.1/doc_pages/intramolecular_bonds.html @@ -0,0 +1,409 @@ + + + + + + + 2. Intramolecular bonds — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Intramolecular bonds

+

Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see Configuration file. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +Benchmarks), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable.

+

All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]).

+
+

2.1. Two-particle bonds

+

Stretching bonds in HyMD are implemented as harmonic spring potentials,

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2,\]
+

where \(r=|\mathbf{r}|\) is the inter-particle distance, \(k\) is a +constant of dimension energy (units \(\text{kJ}\,\text{mol}^{-1}\)), and +\(r_0\) is the equilibrum length of the bond (units: \(\text{nm}\)). The +force is calculated as

+
+\[F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r},\]
+

where \(\mathbf{r}\) is the vector pointing from \(i\) to \(j\).

+

In the configuration file, two-particle bonds are specified per particle type:

+
+
configuration_two_particle_example.toml
+
[bonds]
+bonds = [
+   ["A", "A", 0.47, 1250.0],
+   ["A", "B", 0.37,  940.0],
+   ["B", "C", 0.50, 1010.0],
+   ["C", "A", 0.42,  550.0],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.2. Three-particle bonds

+

Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle–particle–particle angle \(\theta\),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2,\]
+

where \(k\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\)), and \(\theta_0\) is the equilibrum +angle of the bond (units: \({}^\circ\)). Defining the particles with labels +\(a\), \(b\), and \(c\), let \(\mathbf{r}_a\) denote the vector +pointing from \(b\) to \(a\), and correspondingly let +\(\mathbf{r}_c\) point from \(b\) to \(c\). The +\(a\)\(b\)\(c\) may be computed through the law of Cosines,

+
+\[\theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right]\]
+

Then the force acting on \(a\) and \(c\) is

+
+\[ \begin{align}\begin{aligned}\mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a},\\\mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c},\end{aligned}\end{align} \]
+

and

+
+\[\mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c\]
+

In the configuration file, three-particle bonds are specified per particle type:

+
+
configuration_three_particle_example.toml
+
[bonds]
+angle_bonds = [
+   ["A", "A", "A", 180.0, 90.0],
+   ["A", "B", "A", 120.0, 55.0],
+   ["B", "C", "C",  30.0, 10.0],
+   ["C", "A", "B", 110.0, 25.5],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.3. Four-particle bonds

+

Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle \(\phi\) between the +\(a\)\(b\)\(c\) and \(b\)\(c\)\(d\) planes, for +a dihedral bond quartet \(a\), \(b\), \(c\), and \(d\). The +potential takes the form

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n),\]
+

where \(c_n\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)), and \(\phi_n\) are +specified phase angles in the cosine series.

+

In the configuration file, four-particle bonds are specified per particle type:

+
+
configuration_four_particle_example.toml
+
[bonds]
+dihedrals = [
+   ["A", "B", "C", "D"],
+   [
+     [-1],
+     [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+     [0.08, 0.46, 1.65, -0.96, 0.38],
+   ],
+   [1.0],
+]
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/doc_pages/overview.html b/v2.0.1/doc_pages/overview.html new file mode 100644 index 00000000..2dac0629 --- /dev/null +++ b/v2.0.1/doc_pages/overview.html @@ -0,0 +1,430 @@ + + + + + + + 2. Usage overview for HylleraasMD — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Usage overview for HylleraasMD

+

HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a toml format configuration file, along with a topology and structure +file specifying the input system in HDF5 format.

+

Configuration file

+

The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a [5, 5, 5] nm simulation box at 300 K may look like +the following:

+
+
config_simple_1.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "SquaredPhi"         # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [30, 30, 30]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+
+
+
+

Note that for the version 1.0 release of HyMD, the [particles], +[simulation], and [field] groups are optional specifiers for +structuring the configuration file.

+

For a full specification of every recognised configuration keyword in HyMD, +please refer to Configuration file.

+

Topology and structure file

+

The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +N particles may look like the following:

+
+
example_structure.HDF5
+
group   /
+   # root group
+
+dataset /coordinates
+   # float32, shape (T, N, D,)
+   # Time steps of N rows of D dimensional coordinate data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /velocities
+   # float32, shape (T, N, D,) OPTIONAL
+   # Time steps of N rows of D dimensional velocity data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /bonds
+   # int32,   shape (N, B,)    OPTIONAL
+   # Each row i contains indices of the particles bonds from/to i
+   # B denotes the maximum bonds per particle
+
+dataset /indices
+   # int32,   shape (N,)
+   # Index of each particle, 0--(N-1)
+
+dataset /molecules
+   # int32,   shape (N,)
+   # Index of molecule each particle belongs to
+   # Used to construct bond network locally on MPI ranks
+
+dataset /names
+   # str10,   shape (N,)
+   # Fixed size string array containing particle type names
+
+dataset /types
+   # int32,   shape (N,)       OPTIONAL
+   # Mapping of particle names to type indices
+
+
+
+

For a full specification of the topology and structure input file, see +Topology and structure file.

+

Command line arguments

+

A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the config_simple_1.toml and example_structure.HDF5 +files may look like the following:

+
mpirun -n ${MPI_NUM_RANKS} python3 -m hymd         \  # HyMD executable
+                           config_simple_1.toml    \  # configuration file
+                           example_structure.HDF5  \  # structure file
+                           --logfile=log_out.txt   \  # set logfile path
+                           --seed 123456           \  # set random seed
+                           --verbose 2             \  # set logging verbosity
+                           --velocity-output          # enable velocity in trajectory output
+
+
+

For a full specification of all command line arguments, see +Command line arguments.

+

More examples

+

For more thorough rundown and concrete usage examples, see +Examples.

+
+

2.1. Running parallel simulations

+

Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the only difference being how the python3 interpreter is +invoked. Prepending mpirun -n ${NPROCS} to the usual +python3 -m hymd runs the simulation with ${NPROCS} MPI ranks.

+

Inputting

+
mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field
+
+
+

sets up an example simulation of the HyMD-tutorial/ideal_gas system. For +more details about this system in particular, or other example simulations, see +the HyMD-tutorial repository.

+
+
+

2.2. Running tests

+

Run serial code tests by

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd
+cd hymd/
+python3 -m pip install pytest pytest-mpi
+python3 -m pytest
+
+
+

There is a small convenience script in hymd/ for running the MPI-enabled +tests,

+
chmod +x pytest-mpi
+./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/doc_pages/pressure.html b/v2.0.1/doc_pages/pressure.html new file mode 100644 index 00000000..715873f1 --- /dev/null +++ b/v2.0.1/doc_pages/pressure.html @@ -0,0 +1,319 @@ + + + + + + + 4. Pressure — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Pressure

+

Internal pressure is calculated from internal energy according to

+
+\[\begin{split}P_a = \frac{1}{\mathcal{V}} \left( 2T_a - \text{Vir}_a \right) \\ +\text{Vir}_a = L_a \frac{\partial \mathcal{U}}{\partial L_a} \\ +\mathcal{U} = \sum_{i=1}^M \mathcal{U}_0( \{ \mathbf{r}\}_i ) + W[\{ \tilde\phi \} ]\end{split}\]
+

where +\(\mathcal{V}\) is the simulation volume, +\({T_a}\) is the kinetic energy +and \(L_a\) the length of the box in the Cartesian direction \(a\), +Vir is the virial of the total interaction energy \(\mathcal{U}\).

+

\(\mathcal{U}\) comprises intramolecular bonded terms \(\mathcal{U}_0\) (see Intramolecular bonds for details), +and field terms \(W[\{ \tilde\phi \} ]\) (see Theory for details).

+

Using the above expressions, the following form for internal pressure is obtained:

+
+\[\begin{split}P_a = \frac{2 T_a}{\mathcal{V}} -\frac{L_a}{\mathcal{V}} \sum_{i=1}^N \frac{\partial \mathcal{U}_{0i}}{\partial L_a} + P^{(3)}_a \\\end{split}\]
+
+\[P^{(3)}_a = \frac{1}{\mathcal{V}}\left ( -W[\{ \tilde\phi(\mathbf{r}) \}] + \int \sum_t \bar{V}_t(\mathbf{r})\tilde\phi_t(\mathbf{r})d\mathbf{r} + + \int \sum_t \sigma^2\bar{V}_t(\mathbf{r})\nabla_a^2\tilde\phi_t(\mathbf{r}) d\mathbf{r} \right)\]
+

where \(\bar{V}_t(\mathbf{r}) = \frac{\partial w(\{\tilde\phi\})}{\partial\tilde\phi_t}\) +and \(σ\) is a coarse-graining parameter (see Filtering for details). +Note that the above expression is obtained for a Gaussian filter which is the most natural choice in HhPF theory.

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/doc_pages/theory.html b/v2.0.1/doc_pages/theory.html new file mode 100644 index 00000000..1e526411 --- /dev/null +++ b/v2.0.1/doc_pages/theory.html @@ -0,0 +1,377 @@ + + + + + + + 1. Theory — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Theory

+

Hybrid particle–field simulations switch out the ordinary particle–particle +Lennard-Jones interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle–field densities are +defined as

+
+\[\phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i),\]
+

where \(\mathbf{r}\) is a spatial coordinate, \(P\) is a window function +used to distribute particle number densities onto a computational grid, and +\(\mathbf{r}_i\) is the position of particle \(i\) (of total \(N\)). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of \(N\) particles in \(M\) molecules is

+
+\[\mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})]\]
+

with \(H_0\) being a standard intramolecular Hamiltonian form (see +Intramolecular bonds) including kinetic terms, while \(W\) is a density +dependent interaction energy functional.

+

In the Hamiltonian hPF-MD formalism [Bore and Cascella, 2020], the density +field is filtered using a grid-independent filtering function \(H\),

+
+\[\tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}).\]
+

The filter smooths the density, ensuring that \(\tilde\phi\) and +\(W[\tilde\phi([\phi])]\) both converge as the grid size is reduced.

+
+

1.1. External potential

+

The external potential acting on a particle is defined as the functional +derivative of \(W\) with respect to \(\phi\). In the filtered formalism, +the potential takes the form

+
+\[\begin{split}V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ +&= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})},\end{split}\]
+

under the assumption of a local form of the interaction energy functional, +\(W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]\). Note +that

+
+\[\frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}).\]
+
+
+

1.2. Force interpolation

+

The forces on particle \(i\) are obtained by differentiation of the external +potential,

+
+\[\mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i).\]
+
+
+

1.3. Reciprocal space calculations

+

The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density \(\phi_{ijk}\) with CIC, we apply the filtering +and obtain the discrete version of the external potential by

+
+\[\tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big]\]
+

and

+
+\[V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+

The forces are obtained by differentiation of \(V\) in Fourier space as

+
+\[\nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+
+
+

1.4. Filter

+

By default, the filter used in HyMD is a simple Gaussian of the form

+
+\[\begin{split}H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ +\hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right].\end{split}\]
+

For more details about the filtering, see Filtering.

+
+
+

1.5. Hamiltonian form

+

The default form of the interaction energy functional in HyMD is

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2.\]
+

In the case of constant pressure simulations (NPT), the interaction energy functional becomes

+
+\[W=\frac{1}{2\rho_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-a\right)^2.\]
+

where, \(\rho_0= 1 / ν\) is an intrinsic parameter corresponding to the specific volume \((ν)\) of a coarse-grained particle, +\(a\) is a calibrated parameter to obtain the correct average density at the target temperature and pressure. +See Interaction energy functionals for details.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/doc_pages/topology_input.html b/v2.0.1/doc_pages/topology_input.html new file mode 100644 index 00000000..5f79af75 --- /dev/null +++ b/v2.0.1/doc_pages/topology_input.html @@ -0,0 +1,358 @@ + + + + + + + 4. Topology and structure file — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Topology and structure file

+

The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root / group.

+

The HyMD-tutorial has multiple examples of structure files for various levels +of complexity.

+
+

4.1. Required datasets

+
+
/coordinates:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/indices:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/names:
+

array shape [N,]

+

datatype [string (length between 1 and 16)]

+

The shape represents one particle name per N particles. The datatype may be a string of length =<16.

+
+
+
+
+

4.2. Optional datasets

+
+
/velocities:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/types:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle type index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/molecules:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one molecule index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/bonds:
+

array shape [N, B,]

+

datatype [int32 or int64]

+

The shape represents B bond specifications (indices of different particles) per N particles. The data type may be either 32 or 64 bit integers.

+
+
/charge:
+

array shape [N,]

+

datatype [float32 or float64]

+

The shape represents one particle charge per N particles. The data type may be either four or eight byte reals.

+
+
/box:
+

array shape [3,]

+

datatype [float32 or float64]

+

The shape represents the initial box dimensions in Cartesian coordinates.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/genindex.html b/v2.0.1/genindex.html new file mode 100644 index 00000000..0953302b --- /dev/null +++ b/v2.0.1/genindex.html @@ -0,0 +1,855 @@ + + + + + + Index — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + +
+ +

F

+ + + +
+ +

G

+ + +
+ +

H

+ + + +
    +
  • + hymd.input_parser + +
  • +
  • + hymd.integrator + +
  • +
  • + hymd.pressure + +
  • +
  • + hymd.thermostat + +
  • +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/index.html b/v2.0.1/index.html new file mode 100644 index 00000000..7a6c06c5 --- /dev/null +++ b/v2.0.1/index.html @@ -0,0 +1,417 @@ + + + + + + + HylleraasMD documentation — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

HylleraasMD documentation

+
+
Release:
+

2.0.1

+
+
Date:
+

Apr 05, 2023

+
+
+

HylleraasMD (HyMD) is a massively parallel Python package for hybrid +particle-field molecular dynamics (hPF-MD) simulations of coarse-grained bio- +and soft-matter systems.

+

HyMD can run canonical hPF-MD simulations [Milano and Kawakatsu, 2009], or filtered +density Hamiltonian hPF (HhPF-MD) simulations [Bore and Cascella, 2020], with +or without explicit PME electrostatic interactions [Kolli et al., 2018]. It +includes all standard intramolecular interactions, including stretching, +bending, torsional, and combined bending-dihedral potentials. Additionally, +topological reconstruction of permanent peptide chain backbone dipoles is +possible for accurate recreation of protein conformational dynamics +[Bore et al., 2018, Cascella et al., 2008]. Martini +style elastic networks (ElNeDyn) [Periole et al., 2009] are also +supported.

+

HyMD uses the pmesh (github.com/rainwoodman/pmesh) library for particle-mesh +operations, with the PPFT [Pippig, 2013] backend for FFTs through the +pfft-python bindings (github.com/rainwoodman/pfft-python). File IO is done +via HDF5 formats to allow MPI parallel reads.

+
+

User Guide

+

The HylleraasMD User Guide provides comprehensive information on how to run +simulations. Selected Examples are available to guide new users.

+
+
+

Installing HyMD

+

The easiest approach is to install using pip:

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+

For more information and required dependencies, see +Installation.

+
+

Run in Google colab

+

Run HyMD interactively in Google Colaboratory jupyter notebook here.

+
+
+
+

Source Code

+

Source code is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the GNU Lesser General Public +License v3.0. Obtain the source code with git:

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git
+
+
+
+
+

Development

+

HyMD is developed and maintained by researchers at the Hylleraas Centre for +Quantum Molecular Sciences at the University of Oslo.

+

pic1 pic2

+
+
+

References

+
+
+[BC20] +

Sigbjørn Løland Bore and Michele Cascella. Hamiltonian and alias-free hybrid particle–field molecular dynamics. J. Chem. Phys., 153(9):094106, 2020. doi:10.1063/5.0020733.

+
+
+[BMC18] +

Sigbjørn Løland Bore, Giuseppe Milano, and Michele Cascella. Hybrid particle-field model for conformational dynamics of peptide chains. J. Chem. Theory Comput., 14(2):1120–1130, 2018. doi:10.1021/acs.jctc.7b01160.

+
+
+[BDP07] +

Giovanni Bussi, Davide Donadio, and Michele Parrinello. Canonical sampling through velocity rescaling. J. Chem. Phys., 126(1):014101, 2007. doi:10.1063/1.2408420.

+
+
+[CNCDP08] +

Michele Cascella, Marilisa A. Neri, Paolo Carloni, and Matteo Dal Peraro. Topologically based multipolar reconstruction of electrostatic interactions in multiscale simulations of proteins. J. Chem. Theory Comput., 4(8):1378–1385, 2008. doi:10.1021/ct800122x.

+
+
+[KDNB+18] +

Hima Bindu Kolli, Antonio De Nicola, Sigbjørn Løland Bore, Ken Schäfer, Gregor Diezemann, Jürgen Gauss, Toshihiro Kawakatsu, Zhong-Yuan Lu, You-Liang Zhu, Giuseppe Milano, and Michele Cascella. Hybrid particle-field molecular dynamics simulations of charged amphiphiles in an aqueous environment. J. Chem. Theory Comput., 14(9):4928–4937, 2018. doi:10.26434/chemrxiv.6264644.v1.

+
+
+[LBC20] +

Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Automated determination of hybrid particle-field parameters by machine learning. Mol. Phys., 118(19-20):e1785571, 2020. doi:10.1080/00268976.2020.1785571.

+
+
+[MK09] +

Giuseppe Milano and Toshihiro Kawakatsu. Hybrid particle-field molecular dynamics simulations for dense polymer systems. J. Chem. Phys., 130(21):214106, 2009. doi:10.1063/1.3142103.

+
+
+[PCMC09] +

Xavier Periole, Marco Cavalli, Siewert-Jan Marrink, and Marco A Ceruso. Combining an elastic network with a coarse-grained molecular force field: structure, dynamics, and intermolecular recognition. Journal of chemical theory and computation, 5(9):2531–2543, 2009. doi:10.1021/ct9002114.

+
+
+[Pip13] +

Michael Pippig. Pfft: an extension of fftw to massively parallel architectures. SIAM J. Sci. Comput., 35(3):C213–C236, 2013. doi:10.1137/120885887.

+
+
+[TBM92] +

MBBJM Tuckerman, Bruce J Berne, and Glenn J Martyna. Reversible multiple time scale molecular dynamics. J. Chem. Phys., 97(3):1990–2001, 1992. doi:10.1063/1.463137.

+
+
+
+
+
+

Indices and tables

+ +
+
+
+
+
+
+
+
+
+ + + +
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+ + + + + +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/objects.inv b/v2.0.1/objects.inv new file mode 100644 index 00000000..a569cad6 Binary files /dev/null and b/v2.0.1/objects.inv differ diff --git a/v2.0.1/py-modindex.html b/v2.0.1/py-modindex.html new file mode 100644 index 00000000..ac35d939 --- /dev/null +++ b/v2.0.1/py-modindex.html @@ -0,0 +1,349 @@ + + + + + + Python Module Index — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ h +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ h
+ hymd +
    + hymd.barostat +
    + hymd.field +
    + hymd.file_io +
    + hymd.force +
    + hymd.input_parser +
    + hymd.integrator +
    + hymd.pressure +
    + hymd.thermostat +
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.1/search.html b/v2.0.1/search.html new file mode 100644 index 00000000..b3fabc54 --- /dev/null +++ b/v2.0.1/search.html @@ -0,0 +1,309 @@ + + + + + + Search — hymd 2.0.1 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.1 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v2.0.1/searchindex.js b/v2.0.1/searchindex.js new file mode 100644 index 00000000..d511b137 --- /dev/null +++ b/v2.0.1/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["doc_pages/api","doc_pages/benchmarks","doc_pages/command_line","doc_pages/config_file","doc_pages/constants_and_units","doc_pages/electrostatics","doc_pages/examples","doc_pages/filtering","doc_pages/installation","doc_pages/interaction_energy_functionals","doc_pages/intramolecular_bonds","doc_pages/overview","doc_pages/pressure","doc_pages/theory","doc_pages/topology_input","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,"sphinxcontrib.bibtex":9,sphinx:56},filenames:["doc_pages/api.rst","doc_pages/benchmarks.rst","doc_pages/command_line.rst","doc_pages/config_file.rst","doc_pages/constants_and_units.rst","doc_pages/electrostatics.rst","doc_pages/examples.rst","doc_pages/filtering.rst","doc_pages/installation.rst","doc_pages/interaction_energy_functionals.rst","doc_pages/intramolecular_bonds.rst","doc_pages/overview.rst","doc_pages/pressure.rst","doc_pages/theory.rst","doc_pages/topology_input.rst","index.rst"],objects:{"hymd.barostat":{isotropic:[0,1,1,""],semiisotropic:[0,1,1,""]},"hymd.field":{compute_field_and_kinetic_energy:[0,1,1,""],compute_field_energy_q_GPE:[0,1,1,""],compute_field_force:[0,1,1,""],compute_self_energy_q:[0,1,1,""],domain_decomposition:[0,1,1,""],initialize_pm:[0,1,1,""],update_field:[0,1,1,""],update_field_force_q:[0,1,1,""],update_field_force_q_GPE:[0,1,1,""]},"hymd.file_io":{OutDataset:[0,2,1,""],distribute_input:[0,1,1,""],setup_time_dependent_element:[0,1,1,""],store_data:[0,1,1,""],store_static:[0,1,1,""]},"hymd.file_io.OutDataset":{close_file:[0,3,1,""],flush:[0,3,1,""],is_open:[0,3,1,""]},"hymd.force":{Angle:[0,2,1,""],Bond:[0,2,1,""],Chi:[0,2,1,""],Dielectric_type:[0,2,1,""],Dihedral:[0,2,1,""],compute_angle_forces__plain:[0,1,1,""],compute_bond_forces__plain:[0,1,1,""],compute_dihedral_forces__plain:[0,1,1,""],dipole_forces_redistribution:[0,1,1,""],find_all_paths:[0,1,1,""],prepare_bonds:[0,1,1,""],prepare_bonds_old:[0,1,1,""],prepare_index_based_bonds:[0,1,1,""],propensity_potential_coeffs:[0,1,1,""]},"hymd.force.Angle":{atom_3:[0,4,1,""]},"hymd.force.Bond":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],equilibrium:[0,4,1,""],strength:[0,4,1,""]},"hymd.force.Chi":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],interaction_energy:[0,4,1,""]},"hymd.force.Dielectric_type":{atom_1:[0,4,1,""],dielectric_value:[0,4,1,""]},"hymd.force.Dihedral":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],atom_3:[0,4,1,""],atom_4:[0,4,1,""],coeffs:[0,4,1,""],dih_type:[0,4,1,""]},"hymd.hamiltonian":{DefaultNoChi:[0,2,1,""],DefaultWithChi:[0,2,1,""],Hamiltonian:[0,2,1,""],SquaredPhi:[0,2,1,""]},"hymd.hamiltonian.DefaultNoChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.DefaultWithChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.Hamiltonian":{__init__:[0,3,1,""],_setup:[0,3,1,""]},"hymd.hamiltonian.SquaredPhi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.input_parser":{Config:[0,2,1,""],check_NPT_conditions:[0,1,1,""],check_angles:[0,1,1,""],check_bonds:[0,1,1,""],check_box_size:[0,1,1,""],check_cancel_com_momentum:[0,1,1,""],check_charges:[0,1,1,""],check_charges_types_list:[0,1,1,""],check_chi:[0,1,1,""],check_config:[0,1,1,""],check_dielectric:[0,1,1,""],check_dihedrals:[0,1,1,""],check_domain_decomposition:[0,1,1,""],check_hamiltonian:[0,1,1,""],check_integrator:[0,1,1,""],check_m:[0,1,1,""],check_mass:[0,1,1,""],check_max_molecule_size:[0,1,1,""],check_n_b:[0,1,1,""],check_n_flush:[0,1,1,""],check_n_particles:[0,1,1,""],check_n_print:[0,1,1,""],check_name:[0,1,1,""],check_start_and_target_temperature:[0,1,1,""],check_tau:[0,1,1,""],check_thermostat_coupling_groups:[0,1,1,""],parse_config_toml:[0,1,1,""],read_config_toml:[0,1,1,""],sort_dielectric_by_type_id:[0,1,1,""]},"hymd.input_parser.Config":{a:[0,4,1,""],angle_bonds:[0,4,1,""],barostat:[0,4,1,""],barostat_type:[0,4,1,""],bonds:[0,4,1,""],box_size:[0,4,1,""],cancel_com_momentum:[0,4,1,""],chi:[0,4,1,""],conv_crit:[0,4,1,""],convergence_type:[0,4,1,""],coulomb_constant:[0,4,1,""],coulombtype:[0,4,1,""],dielectric_const:[0,4,1,""],dielectric_type:[0,4,1,""],dihedrals:[0,4,1,""],domain_decomposition:[0,4,1,""],dtype:[0,4,1,""],file_name:[0,4,1,""],gas_constant:[0,4,1,""],hamiltonian:[0,4,1,""],initial_energy:[0,4,1,""],integrator:[0,4,1,""],kappa:[0,4,1,""],m:[0,4,1,""],mass:[0,4,1,""],max_molecule_size:[0,4,1,""],mesh_size:[0,4,1,""],n_b:[0,4,1,""],n_flush:[0,4,1,""],n_particles:[0,4,1,""],n_print:[0,4,1,""],n_steps:[0,4,1,""],name:[0,4,1,""],pol_mixing:[0,4,1,""],pressure:[0,4,1,""],respa_inner:[0,4,1,""],rho0:[0,4,1,""],self_energy:[0,4,1,""],sigma:[0,4,1,""],start_temperature:[0,4,1,""],tags:[0,4,1,""],target_pressure:[0,4,1,""],target_temperature:[0,4,1,""],tau:[0,4,1,""],tau_p:[0,4,1,""],thermostat_coupling_groups:[0,4,1,""],thermostat_work:[0,4,1,""],time_step:[0,4,1,""],type_charges:[0,4,1,""]},"hymd.integrator":{integrate_position:[0,1,1,""],integrate_velocity:[0,1,1,""]},"hymd.logger":{Logger:[0,2,1,""],MPIFilterAll:[0,2,1,""],MPIFilterRoot:[0,2,1,""]},"hymd.logger.Logger":{setup:[0,3,1,""]},"hymd.logger.MPIFilterAll":{filter:[0,3,1,""]},"hymd.logger.MPIFilterRoot":{filter:[0,3,1,""]},"hymd.pressure":{comp_pressure:[0,1,1,""]},"hymd.thermostat":{_random_chi_squared:[0,1,1,""],_random_gaussian:[0,1,1,""],csvr_thermostat:[0,1,1,""]},hymd:{barostat:[0,0,0,"-"],field:[0,0,0,"-"],file_io:[0,0,0,"-"],force:[0,0,0,"-"],input_parser:[0,0,0,"-"],integrator:[0,0,0,"-"],pressure:[0,0,0,"-"],thermostat:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0020733":15,"00268976":15,"0083144621":0,"01036426965":4,"014101":[0,15],"02214076":4,"03642696562":4,"03970":6,"08790868":[6,10],"094106":15,"0xd":8,"0xe":8,"100":[4,6,11],"1000":6,"10000":6,"10001":6,"1010":10,"1021":15,"1063":15,"1080":15,"10nm":6,"110":10,"1120":[0,15],"1130":[0,15],"1137":15,"118":15,"120":[3,6,10],"120885887":15,"120ff":0,"123456":11,"1250":[3,6,10],"126":[0,15],"130":15,"1378":15,"138":[0,4],"1385":15,"144":8,"148":8,"1500":6,"153":15,"166":8,"170":6,"1785571":15,"179":0,"180":[3,6,10],"186":8,"197":8,"1974":0,"1981":0,"1984":0,"1990":15,"1992":[3,15],"200":[6,10],"2000":6,"2001":15,"2007":[0,3,15],"2008":[0,15],"2009":15,"201":[0,3],"2013":15,"2018":[0,15],"2020":[5,6,13,15],"2023":15,"20nm":6,"214106":15,"223":0,"224":1,"2408420":15,"2408724":[6,10],"246":0,"251":[6,10],"2531":15,"2543":15,"26434":15,"28103735":0,"298":6,"2_1":0,"2don2d":8,"2nd":0,"2t_a":12,"300":[6,11],"3000":6,"3142103":15,"3144621":4,"323":6,"3684":0,"3690":0,"449":[6,10],"463137":15,"48626121":[6,10],"4928":15,"4937":15,"502":8,"533":1,"544":[6,10],"550":10,"59427866":[6,10],"602176634":4,"610":[6,10],"6264644":15,"66053906660":4,"7b01160":15,"85418781281":4,"935458":[0,4],"940":10,"96924":6,"980":3,"9918564":[6,10],"\u03b1":0,"\u03b2":0,"\u03bd":13,"\u03c3":12,"boolean":[0,3],"byte":14,"case":[0,3,6,8,10,13],"class":[0,9],"default":[0,3,7,11,13,14],"export":8,"float":[0,3],"function":[0,3,5,6,7,11,13],"int":[0,5,6,9,12,13],"long":[5,6],"new":[0,10,14,15],"public":15,"return":[0,8],"short":[6,11],"sigbj\u00e3":15,"static":0,"switch":13,"true":[0,3,6],"while":[0,13],Adding:6,For:[0,11,13,15],The:[0,3,5,6,7,8,9,10,11,13,14,15],Then:10,There:[8,11],These:0,Used:[0,3,11],Using:[6,9,12],With:[0,6],__file__:8,__init__:[0,8],__main__:8,_gener:0,_hl:8,_kwarg:8,_random_chi_squar:0,_random_gaussian:0,_run_cod:8,_run_module_as_main:8,_set_fapl_mpio:8,_setup:0,about:[3,11,13],abov:[0,6,12],absent:0,acceler:0,accompani:6,accord:[0,3,12],accur:15,acid:6,across:[0,3],acs:15,act:[0,10,13],adapt:0,add:[5,6],added:0,adding:6,addison:0,addit:[0,2,5,11],addition:15,additon:0,adher:0,affect:0,affili:[0,2],after:[0,10,13],against:8,aggreg:6,ahren:0,alanin:6,algorithm:[0,3,13],alia:15,all:[0,2,3,4,6,8,10,11,15],all_nam:0,all_rank:0,alloc:0,allow:[11,15],allreduc:0,along:[6,11],alpha3:8,alpha:0,alpha_:0,alpha_l:0,alpha_n:0,alreadi:0,also:[6,8,15],altern:2,alwai:[0,3],amino:6,amount:0,amphiphil:15,analyt:0,angl:[0,2,3,6,8,10],angle_bond:[0,3,6,10],angle_pr:0,angular:[0,3,6,10],ani:[0,2,3],anisotrop:0,antonio:15,apart:0,api:8,app:8,appli:[0,3,7,9,13],applic:0,approach:15,approxim:0,apr:15,apt:8,aqueou:15,architectur:15,arg:[0,8],argument:[0,6,8,11],argv:8,aris:0,around:10,arrai:[0,3,11,14],arriv:6,art:0,aspect:3,assess:0,assign:[0,3,10],associ:[0,9],assum:3,assumpt:13,atom:0,atom_1:0,atom_2:0,atom_3:0,atom_4:0,attach:14,attempt:0,attr:8,attract:3,attribut:0,autom:15,automat:[0,7,8,9],avail:[6,8,15],averag:[0,3,9,13],avogadro:4,back:[0,5,8],backbon:[0,2,3,15],backcon:0,backend:15,backmap:0,balanc:0,ballist:6,bar:[3,4,12],barostat:3,barostat_typ:[0,3],base:[0,15],bath:[0,3],bb_index:0,bc20:15,bdist_wheel:8,bdp07:15,bead:0,becaus:0,becom:[0,13],befor:[0,3,6,8],being:[0,2,3,5,10,11,13],belong:11,below:[0,6],benchmark:10,bend:[0,3,10,15],berendsen:3,bern:15,besid:2,best:0,beta:0,better:0,between:[0,3,5,6,9,10,13,14],bia:0,big:13,bin:8,binari:8,bind:15,bindu:15,bio:15,bit:[0,14],blueprint:0,bmc18:15,boltzmann:[0,3,4],bond2_energi:0,bond3_energi:0,bond4_energi:0,bond:[0,2,6,8,11,12,13,14],bond_pr:0,bonds_2:0,bonds_2_atom1:0,bonds_2_atom2:0,bonds_2_atom_1:0,bonds_2_atom_2:0,bonds_2_equilibrium:0,bonds_2_strength:0,bonds_3:0,bonds_3_atom_1:0,bonds_3_atom_2:0,bonds_3_atom_3:0,bonds_3_equilibrium:0,bonds_3_strength:0,bonds_4:0,bonds_4_atom_1:0,bonds_4_atom_2:0,bonds_4_atom_3:0,bonds_4_atom_4:0,bonds_4_coeff:0,bonds_4_last:0,bonds_4_typ:0,bool:0,bootstrap:8,bore:[0,5,13,15],both:[0,13],boundari:[0,3],box:[0,3,6,11,12,14],box_siz:[0,3,6,11],breviti:6,brew:8,broadcast:0,browser:8,bruce:15,buffer:[0,3],build_extens:8,build_pfft:8,build_pi:8,built:8,bussi:[0,3,15],c213:15,c236:15,c_n:[0,6,10],calcul:[0,3,6,10,12],calibr:[0,3,13],call:[0,3,8],callabl:0,can:[6,8,15],cancel_com_momentum:[0,3,6],canon:[0,3,15],capabl:2,captur:11,carloni:15,carri:6,cartesian:[0,3,12,14],cascella:[5,8,11,13,15],caval:15,cbt:0,cdot10:4,cdot:[0,4,10],cell:[0,13],cellar:8,center:[0,3],centr:15,certain:[0,2],ceruso:15,chain:[0,15],chang:[0,3],changedin:0,charg:[0,3,4,5,6,14,15],charge_out:0,check:[0,8],check_angl:0,check_bond:0,check_box_s:0,check_cancel_com_momentum:0,check_charg:0,check_charges_types_list:0,check_chi:0,check_config:0,check_dielectr:0,check_dihedr:0,check_domain_decomposit:0,check_hamiltonian:0,check_integr:0,check_m:0,check_mass:0,check_max_molecule_s:0,check_n_b:0,check_n_flush:0,check_n_particl:0,check_n_print:0,check_nam:0,check_npt_condit:0,check_start_and_target_temperatur:0,check_tau:0,check_thermostat_coupling_group:0,chem:[0,15],chemic:15,chemrxiv:15,chi:[0,3,4,6,8],chi_2:0,chi_3:0,chi_:[0,3,6,9,13],chi_m:0,chmod:11,choic:12,chosen:0,cic:[0,5,13],circ:[3,10],circumv:13,classmethod:0,classvar:0,clean:[0,8],clone:[8,11,15],close:[0,8],close_fil:0,closest:0,cloud:[0,6,13],cncdp08:15,coars:[0,3,7,12,13,15],code:[0,1,2,3,6,8,11],coeff:0,coeffici:0,coil:[0,6],colab:8,colaboratori:15,collect:[0,3,14],com:[0,8,11,15],combin:[0,6,15],comm:0,comm_world:0,command:[8,11],common:9,commuic:0,commun:[0,3,10],communc:0,comp_pressur:0,compar:6,compat:2,compil:[0,8],compiler_so:8,complesfield:0,complet:[0,6,8],complex:[6,14],complexfield:0,compon:0,comprehens:15,compress:[0,3,4,6,9,11],compris:12,comput:[0,5,10,13,15],computaion:0,compute_angle_forces__plain:0,compute_bond_forces__plain:0,compute_dihedral_forces__plain:0,compute_field_and_kinetic_energi:0,compute_field_energy_q_gp:0,compute_field_forc:0,compute_potenti:0,compute_self_energy_q:0,concret:11,condit:6,config:[0,8],config_simple_1:11,configur:[0,2,5,6,7,8,9,10,11],configuration_four_particle_exampl:10,configuration_three_particle_exampl:10,configuration_two_particle_exampl:10,configure_runtim:8,conform:[6,14,15],connect:0,conserv:1,consid:[0,6],consist:[0,6],consit:6,consitu:0,constant:[0,3,5,6,10,13],constitut:[0,2,3],constraint:3,construct:[0,10,11],constructor:0,contain:[0,1,2,3,6,11],content:[0,6],contribut:0,control:3,conv_crit:0,conv_fun:0,conveni:11,convent:0,converg:[0,13],convergence_typ:0,convert:0,coordin:[11,13,14],copi:0,core:8,correct:[0,3,13],correspond:[0,3,13],correspondingli:10,cos:[0,6,10],cosin:[0,3,6,10],cost:[3,10],could:8,coulomb:[0,3,4,5],coulomb_const:0,coulombtyp:[0,3,5,6],counter:6,coupl:[0,3,6,11],cprofil:2,cpu:[0,10],crash:3,creat:[0,9],critic:[0,6],cross:0,csvr:[0,3],csvr_thermostat:0,ct800122x:15,ct9002114:15,current:[0,6],cwd:8,cython:[8,15],d_n:0,dal:15,data:[0,3,6,11,14],dataclass:0,dataset:[0,5,6,11],datatyp:14,date:[0,15],date_format:0,david:15,debug:[0,2],decompos:0,decomposit:[0,3,10],default_level:0,defaultnochi:[0,6,9],defaultnohchi:[0,3],defaultwithchi:[0,3,6,9],defin:[0,6,9,10,13],definit:0,degre:3,delta:[0,13],denot:[0,1,3,9,10,11],dens:15,densiti:[0,3,5,9,13,15],depend:[0,6,10,13,15],deprec:0,deriv:[0,13],design:6,dest_directori:0,detail:[2,3,6,8,11,12,13],determin:[0,2,7,15],dev:8,devel:8,develop:[6,8],deviat:[0,3],dict:0,dictat:0,dictionari:0,dielectr:[0,3,6],dielectric_const:[0,3,5,6],dielectric_typ:0,dielectric_valu:0,dieter:0,diezemann:15,differ:[0,3,6,11,14],differenti:[0,5,7,9,13],difficult:2,dih_typ:0,dihedr:[0,2,3,5,6,8,10,15],dimens:[0,10,11,14],dimension:11,dinola:0,dipol:[0,2,3,5,6,15],dipole_forces_redistribut:0,direct:[0,3,12],directori:11,disabl:[2,6,8,11],disable_mpio:0,discard:0,discret:[0,13],discretis:13,disk:[0,3],dispers:6,dist:8,distanc:[0,3,10],distinct:0,distribut:[0,3,5,6,13],distribute_input:0,distutil:8,dnf:8,doc:0,dockerhub:8,dodecyl:6,doe:[0,10],doi:15,domain:[0,3,10],domain_decomposit:[0,3,6],donadio:[0,15],done:[0,6,8,15],dopc:6,dot:0,dot_elec:0,doubl:2,double_out:0,download:8,dppc:6,draw:0,drawn:0,driver:[8,11],dtype:0,due:[0,3],dump:0,dump_per_particl:0,dure:[0,2,3,10,11],dynam:[0,3,11,13,15],e1785571:15,e_k:0,each:[0,3,6,10,11],easiest:15,effect:[0,3],effici:10,eight:14,either:[0,3,8,14],elast:15,elec:0,elec_field:0,elec_field_contrib:0,elec_field_fouri:0,elec_forc:0,elecrostat:0,electr:[0,4,5],electrosat:0,electrostat:[0,6,15],elnedyn:15,els:3,elucid:6,embed:6,emit:0,emploi:0,empti:0,enabl:[2,6,11],enclos:0,end:0,energi:[0,1,3,4,6,7,10,11,12,13],energiesself:0,ensur:[0,3,6,8,13],ensurepip:8,entri:3,environ:15,epsilon:0,equal:[0,3,6],equat:0,equilibr:[3,6],equilibrium:[0,3,6],equilibrum:10,equival:[0,3],error:0,essenti:[0,1,8],etc:[2,3],even:[0,3,6,8],event:0,everi:[0,3,6,10,11],evid:0,ewald:[0,5,6],examin:6,exampl:[3,8,11,14,15],example_structur:11,except:10,exchang:[0,3],exec:8,execut:[0,8,11],exist:0,exit:8,exp:[7,13],expand:0,expans:0,expect:0,expens:[3,13],explicit:[0,6,10,15],express:[0,12],ext:0,extend:6,extens:15,extent:[0,7],extern:[0,3],extract:[0,8],f401:8,f_angl:0,f_bond:0,f_dihedr:0,f_dipol:0,f_on_bead:0,factor:0,factori:0,fail:[0,8],fall:8,fals:[0,3,6],fapl:8,fashion:[0,3],fast:13,fedora:8,fer:15,few:[6,9,10,11],fft:[0,1,2,3,5,6,11,13,15],fftw3:8,fftw:[8,15],field:[2,4,5,6,9,11,12,13,15],field_energi:0,field_list:0,field_q_energi:0,field_q_self_energi:0,file:[2,5,6,7,8,9,10,11,15],file_io:0,file_nam:0,file_path:0,filter:[0,3,5,6,11,12,15],find:[0,8],find_all_path:0,fine:8,first:[0,3,6,11],five:0,fix:[0,8,11],flag:[0,14],flat:11,float32:[11,14],float64:14,flori:0,fluctuat:0,flush:[0,3],follow:[0,2,3,4,6,11,12],forc:[2,3,4,5,6,10,15],force_kernel:8,force_mesh:0,force_mesh_elec:0,force_mesh_elec_fouri:0,force_out:0,forego:2,form:[0,5,10,12],formal:[5,13],format:[0,2,3,5,11,14,15],formatt:0,fortran:[0,10],forward:0,found:[5,8],four:[0,2,3,6,14],fourier:[0,5,13],fr6nt9m4:8,frac:[0,5,6,7,9,10,12,13],frame:[0,11,14],framework:8,free:15,frequenc:[0,3],from:[0,2,3,5,6,8,9,10,11,12,15],full:[0,9,11],fulli:[0,6,8],fundament:11,gamma:0,gamma_0:0,gas:[0,4],gas_const:0,gather:0,gauss:15,gaussian:[0,3,7,12,13],gener:[0,2,3,6,15],get:8,getattr:8,ghost:0,giovanni:15,git:[8,11,15],github:[6,8,11,15],githubusercont:8,giusepp:15,given:[0,3,6,7],glenn:15,global:0,gnu:15,govern:9,gpe:0,grab:8,gradient:0,grain:[0,3,7,12,13,15],graph:0,gregor:15,grid:[0,1,3,5,6,7,11,13],group:[0,3,6,8,11,14,15],guess:0,gunsteren:0,gyrat:6,h5md:[0,3],h5py:[0,2],h_0:[6,13],haak:0,half:0,hamiltonian:[3,5,6,7,9,11,15],handl:0,handler:0,happen:10,harmon:[0,3,6,10],has:[0,3,8,14],hat:[7,13],have:[0,6,8],hdf5:[0,2,3,5,6,8,11,14,15],hdf5_dir:8,hdf5_mpi:8,head:6,header:8,heat:[0,3],helic:[0,3,5,6],help:6,helper:0,here:[0,6,8,15],hhpf:[12,15],highli:[8,10,11],hijack:7,hima:15,hire:1,homogen:0,homopolym:1,homopolypeptid:6,how:[3,11,15],howev:6,hpf:[3,5,9,11,13,15],html:0,http:[0,8,11,15],huggin:0,hundr:[6,10],hybrid:[11,13,15],hylleraa:15,hymd:[0,2,3,4,5,6,7,9,10,11,13,14],ideal:10,ideal_chain:[6,8],ideal_ga:[6,11],ident:0,ignor:0,ijk:[5,13],imag:8,impact:0,implement:[0,10],importerror:8,impuls:[0,3],in_fil:[0,8],inam:8,includ:[0,2,3,6,13,15],incompress:[0,3],increas:[0,2,6],indentifi:0,independ:[0,3,7,13],index:[0,11,14,15],indic:[0,2,3,10,11,14],indirect:0,individu:[0,3,6],induc:5,infer:10,info:[0,8],inform:[0,10,15],ingredi:6,initi:[0,14],initial_energi:0,initialis:11,initialize_pm:0,inner:[0,3],input:[2,3,4,5,6,7,8,11,14],input_box:0,input_pars:[0,8],insert:0,insid:[0,3,6],instal:[2,11],install_pfft:8,instantan:0,int32:[11,14],int64:14,integ:[0,3,6,14],integr:[3,6,11],integrate_posit:0,integrate_veloc:0,intend:8,inter:[0,10],interact:[0,2,3,4,6,7,11,12,13,15],interaction_energi:0,interfac:0,intergr:0,intermediari:0,intermolecular:[6,15],intern:[0,2,3,4,10,12],interpol:[0,5],interpret:11,interv:[0,3],intmathrm:0,intracomm:0,intramolecular:[0,3,6,12,13,15],intrins:[3,5,13],introduc:6,investig:0,invok:[2,11],involv:[0,3,10],ion:6,ipynb:6,is_open:0,isotherm:0,isotrop:[0,3],iter:0,j_k:0,jan:15,jctc:15,join:8,jone:13,journal:15,jupyt:[6,8,15],k_e:0,kappa:[0,3,4,6,11,13],kawakatsu:15,kdnb:15,keep:[0,3],kelvin:[0,3,6,11],ken:15,kernel:[0,10],keyword:[0,5,6,11],kinet:[0,12,13],kinetic_energi:0,knuth:0,kolli:15,kpa:4,kwd:8,l_a:12,label:[1,10],lambda:0,lamdifi:9,land:15,laplacian:0,larg:[8,11],larger:3,last:[6,8,11,14],last_bb:0,later:[0,6],latest:8,law:10,layout:0,layout_q:0,lbc20:15,leak:8,learn:15,leav:0,ledum:[6,15],left:[0,5,6,7,9,10,12,13],legend:1,lenght:0,length:[0,3,4,6,7,10,11,12,14],lennard:13,less:[0,6],lesser:15,let:[0,10],level:[0,2,3,14],liang:15,lib64:8,lib:8,libhdf5:8,libopenmpi:8,librari:[0,2,8,15],libtool:8,libver:8,licens:15,lieu:0,like:[0,6,8,11],limit:[3,8],line:[0,8,11],linear:[0,3],lipid_self_assembl:6,list:0,list_coulomb:0,load:0,local:[0,8,10,11,13],locat:8,log:[0,2,11],log_fil:0,log_out:11,logfil:[2,11],logger:2,logic:0,logrecord:0,look:[6,8,11],loop:0,lost:3,low:[6,8],lower:8,m_j:0,mac:8,machin:[2,15],made:0,mai:[0,2,3,6,8,10,11,14],main:[0,8,11],main_glob:8,maintain:15,make:[6,8],make_fapl:8,manner:6,manual:8,map:[0,11],marco:15,marilisa:15,marrink:15,martini:[6,15],martyna:15,mass:[0,3,4,14],massiv:15,match:0,math:0,mathbf:[0,4,5,6,9,10,12,13],mathcal:[6,12,13],mathmr:0,mathrm:[0,5,6,9,10,13],matteo:15,matter:[6,10,15],max_molecule_s:[0,3,6],maximum:[0,3,10,11],maxwel:[0,3],may:2,mbbjm:15,mean:[0,2,3],measur:10,medium:[0,3,6],melt:1,membran:6,memori:[0,8],mesh:[0,1,3,5,6,15],mesh_siz:[0,3,6,11],messag:0,messi:0,meta:6,metadata:0,method:[0,1,6,7],mh_0:13,micellular:6,michael:15,michel:15,might:[0,8],milano:15,mimic:0,minim:6,minuscul:10,mirror:2,mix:[0,6],mk09:15,model:[6,15],modifi:0,modul:[0,3,8,15],mol:[3,4,6,10,11,15],molecul:[0,3,11,13,14],molecular:[0,2,11,13,15],moment:8,momenta:[0,11],momentum:[0,3,4],monoatom:6,more:[2,3,6,8,11,13,15],mortel:8,morten:15,most:[8,9,11,12,13],mostli:2,motion:[0,6],move:0,mpi4pi:[0,8,15],mpi:[0,2,3,10,11,15],mpi_num_rank:11,mpicc:8,mpifilteral:0,mpifilterroot:0,mpio:[2,8],mpip:8,mpirun:11,multiarrai:8,multipl:[0,3,6,11,14,15],multipolar:15,multiscal:15,must:[0,3],n_b:[0,3],n_flush:[0,3,6],n_frame:0,n_particl:[0,3],n_print:[0,3,6,11],n_step:[0,3,6,11],n_type:0,nabla:[0,13],nabla_a:12,name:[0,2,3,6,10,11,14],nanomet:[0,1],nanosecond:6,natur:[0,12],ndarrai:0,ne5et1y_:8,necessari:[0,6,8],necessit:[8,9],need:[0,6],neg:[0,6],neighbour:0,neri:15,network:[0,10,11,14,15],networkx:0,neutralis:6,never:[0,3],nevertheless:3,newer:8,next:[0,6],nicola:15,non:[0,2,6,8],none:[0,3,8],nongnu:0,noqa:8,normal:[0,2,3,8,13],notabl:11,note:[0,6,8,11,12,13],notebook:[6,8,15],now:6,nproc:11,npt:[0,13],nq_i:5,number:[0,1,2,3,6,11,13,14],numer:0,numpi:[0,2,9,15],nvt:0,object:[0,9],oblat:6,observ:[0,6],obtain:[0,3,5,12,13,15],obviou:8,off:6,omit:6,onc:[3,10],one:[0,2,3,6,14],onli:[0,6,8,10,11],onto:[0,3,5,13],open:[0,8],openmpi:8,oper:[0,3,13,15],oppos:0,optim:[0,10],optimis:[6,10],option:[0,3,6,11],order:[0,3,6,10,11],ordinari:[5,13],org:0,organis:6,origin:0,oslo:15,osx:8,other:[0,11],otherwis:0,out:[8,13],outdataset:0,outer:[0,3],output:[2,3,4,6,8,11],outsid:3,over:0,overlap:[0,9],p_a:12,packag:[8,11,15],page:15,paint:0,paolo:15,paper:0,parallel:[0,2,3,15],paramet:[0,3,6,7,9,12,13,15],parent_group:0,parllel:0,parrinello:[0,15],pars:[0,3],parse_config_toml:[0,8],part:[5,6,13],partial:[0,12],particl:[0,2,5,6,7,9,11,13,14,15],particlemesh:0,particular:11,pass:0,path:[0,2,8,11],pcmc09:15,pdf:1,pencil:0,peptid:[0,2,3,5,15],per:[0,2,3,10,11,14],peraro:15,perfect:0,perform:[0,3,8,10,11,13],periol:15,perman:[10,15],permitt:[0,4],pfft:[0,15],pfft_build_dir:8,phase:[0,10],phase_separ:6,phi:[0,3,6,10,12,13],phi_0:[6,9,13],phi_:[0,6,9,13],phi_ep:0,phi_eps_fouri:0,phi_eta:0,phi_eta_fouri:0,phi_fft:0,phi_fouri:0,phi_k:0,phi_l:0,phi_laplacian:0,phi_n:[6,10],phi_pol:0,phi_pol_prev:0,phi_q:0,phi_q_fouri:0,phi_t:12,phi_transf:0,phospholipid:6,phy:[0,15],pic_spectr:[0,3,6],pic_spectral_gp:0,piec:6,pip13:15,pip3:8,pip:[8,11,15],pippig:15,pkg:8,place:[0,3],plain:2,plane:[0,6,10],pleas:[8,11],plist:8,plume:0,plumed_bia:0,plumed_out:0,pm_stuff:0,pme:15,pmesh:[0,15],png:1,point:[0,1,10,14],poisson:0,pol_mix:0,polar:0,polym:[6,15],posit:[0,2,3,5,6,11,13],possibl:[0,3,6,15],postma:0,potenti:[0,3,4,5,7,8,10,15],ppft:15,practic:10,pre:[0,6],precis:[1,2],prefer:3,prepar:0,prepare_bond:0,prepare_bonds_old:0,prepare_index_based_bond:0,prepend:[0,11],present:[0,2,3,6],preserv:3,pressur:[4,13],pretti:8,previou:0,previous:6,prior:[0,3],priovid:0,prng:0,prod_:0,profil:2,program:[0,11],project:5,promot:0,prop:0,propag:[0,3],propens:[0,3,5,6],propensity_potential_coeff:0,properti:3,protein:[0,15],provid:[0,2,3,11,14,15],psi:[0,4,5],psi_:5,psi_fouri:0,pull:8,put:6,pytest:11,python3:[6,8,11,15],python:[0,11,15],q_i:[0,5],q_j:0,quadrat:0,quanit:0,quantiti:[0,4],quantum:15,quartet:10,quess:0,r_0:[0,6,10],r_a:10,r_c:10,rad:[3,10],radial:6,radii:6,radiu:6,rainwoodman:[8,15],rais:[6,8],random:[0,2,11],random_chi_squar:0,random_gaussian:0,randomli:[0,3,6],rang:5,rank0:0,rank:[0,2,3,10,11],rank_rang:0,rankself:0,rare:10,raw:8,rdcc_nbyte:8,rdcc_nslot:8,rdcc_w0:8,read:[0,8,11,15],read_config_toml:[0,8],readout:0,real:14,realfield:0,realist:6,reappli:0,rearrang:0,reason:8,receiv:[0,3],recent:8,reciproc:[0,7],recognis:11,recognit:15,recommend:8,reconstruct:[0,2,5,6,10,15],record:0,recreat:15,recurs:0,redistribut:0,reduc:[3,13],refer:[3,11],regim:6,regul:[0,3],regularli:8,reiniti:0,rel:[0,3,6,10],relax:[0,3],releas:[0,6,8,11,15],remain:[0,6],remov:[0,3],remove_center_of_mass_momentum:0,remove_com_momentum:[0,3],replac:[0,8],repositori:[6,11],repres:[0,3,14],represent:7,repuls:3,requir:[0,3,8,10,11,15],rescal:[0,3,15],research:15,respa:[0,3,6],respa_inn:[0,3,6],respect:[0,1,13],restructur:0,result:[0,3,6,9],revers:[0,3,15],rgen:15,rho0:[0,3],rho:[0,5],rho_0:[0,13],rho_:5,right:[0,5,6,7,9,10,12,13],rightarrow:10,root:[0,11,14],roughi:6,row:11,rrespa:[0,3,6],ruin:0,run:[0,2,3,6,10],run_glob:8,rundown:11,runpi:8,runtimeerror:8,same:[0,3,6],sampl:[0,3,15],scalar:0,scale:[0,3,6,7,8,10,11,15],sch:15,scheme:[0,6],sci:15,scienc:15,scr:3,script:11,sds:6,search:15,second:[0,11],see:[0,2,3,5,6,8,9,10,11,12,13,15],seed:[2,11],select:[11,15],self:[0,3,8],self_energi:0,semiisotrop:[0,3],seminumer:0,send:[0,3],separ:0,seri:[0,3,6,10],serial:[8,11],serialis:3,set:[0,3,11],set_fapl:8,setup:[0,6,7,8,14],setup_time_dependent_el:0,setuptool:8,sever:0,shape:[0,6,11,14],sheet:0,shift:0,should:[0,2,10],shown:6,siam:15,siewert:15,sigbj:15,sigma:[0,3,6,7,11,12,13],sim:0,similar:0,simpl:[0,6,11,13],simplest:6,simpli:0,simul:[0,2,6,8,10,12,13,14,15],simultan:0,sinc:0,singl:[0,3,6],site:8,size:[0,3,6,11,13],slight:0,slowli:13,small:[3,11],smear:5,smooth:[0,13],sodium:6,soft:[6,15],solv:0,solvent:6,some:[0,3,8],sort:0,sort_dielectric_by_type_id:0,sourc:[0,1],space:[0,3,5,7],span:0,spatial:[0,3,11,13],specfi:0,speci:0,special:0,specif:[0,2,3,6,9,10,11,13,14],specifi:[0,2,3,6,9,10,11,14],spectacularli:0,spectral:6,speed:[0,3],spheric:6,spheroid:6,split:0,spontan:6,spring:[0,10],sqrt:[0,7,13],squar:[0,9],squaredphi:[0,3,9,11],stabil:6,stabl:6,stackoverflow:0,standard:[0,3,13,15],start:[0,3,6,10,14],start_temperatur:[0,3,6],state:0,statu:8,stdout:[0,2],step:[0,3,6,10,11],stiff:3,stochast:0,store:0,store_data:0,store_stat:0,str10:11,str:0,straightforward:[7,9],stream:0,strength:[0,3,6,11],stretch:[0,3,10,15],string:[0,3,8,11,14],structur:[0,2,3,5,6,11,15],style:15,sub:6,subclass:[0,9],subsequ:[0,5,6,10],sudo:8,suitabl:[0,3],sulfat:6,sum:0,sum_:[0,5,9,12,13],sum_i:0,sum_j:0,sum_k:0,sum_n:[0,6,10],sum_t:12,summari:11,superclass:[0,7],support:[0,6,8,15],swap:10,symbol:[0,4,9],sympi:[0,9],sys:8,system:[0,1,2,3,6,9,11,13,15],t_a:12,tag:[0,3,8],take:[0,3,5,9,10,11,13],taken:0,tar:8,target:[0,3,13],target_pressur:[0,3],target_temperatur:[0,3,6,11],tau:[0,3,6,11],tau_p:[0,3],tbm92:15,temperatur:[0,3,4,6,11,13],ten:6,term:[0,3,6,9,12,13],test:[0,1,8],text:[0,2,3,4,5,6,9,10,12,13],than:[0,3],theori:[0,12,15],therefor:8,thermalis:[0,3],thermostat:[2,3,6,11],thermostat_coupling_group:[0,3,6],thermostat_work:0,theta:[6,10],theta_0:[0,6,10],thi:[0,2,3,6,8,9,10,11,13],thorough:11,though:6,thousand:[6,10],three:[0,2,3,6],through:[0,3,6,7,8,9,10,15],tild:[0,3,4,5,6,9,12,13],time:[0,3,4,6,10,11,15],time_step:[0,3,6,11],tmp:8,todo:0,togeth:[0,3,6],token:8,toml:[0,2,3,6,8,10,11],toml_cont:0,tomli:0,too:3,toplog:0,topol:0,topolog:[0,2,3,5,6,11,15],torsion:[0,3,10,15],toshihiro:15,total:[0,3,6,11,12,13],traceback:8,trajectori:[0,2,3,6,11],trans_matric:0,transfer:[0,10],transform:[0,9,13],travers:0,tri:3,trivial:0,truncat:0,tuckerman:[3,15],turn:6,tutori:[6,8,11,14],two:[0,2,3,6],txt:11,type:[0,2,3,5,6,9,10,11,14],type_arrai:0,type_charg:0,type_to_name_map:0,typic:3,ubuntu:8,uio:[8,11,15],unchang:0,under:[6,8,13,15],uniformli:0,uninstal:8,union:0,uniqu:0,unique_nam:0,unit:[0,3,10],univers:15,unknown:0,unless:[0,3],unmodifi:0,unset:0,unstabl:3,until:6,updat:[0,8],update_field:0,update_field_force_q:0,update_field_force_q_gp:0,upgrad:[8,15],usag:[0,2],use:[0,3,5,6,8],used:[0,1,2,3,6,7,9,11,13,14],uses:[0,4,13,15],using:[0,2,3,8,13,15],usr:8,usual:11,v_2:[0,6,10],v_3:[0,6,10],v_4:[0,6,10],v_ext:0,v_ext_fouri:0,vacuum:4,valid:[0,3],validated_config:0,valu:[0,3,4,5,6,10],valueerror:8,van:0,vanish:0,varepsilon:0,varepsilon_0:[4,5],vari:13,variabl:0,variant:6,variou:[0,14],vbar_elec:0,vbar_elec_fouri:0,vector:[3,10],vectoris:9,veloc:[0,2,3,4,6,11,14,15],velocity_out:0,velocti:0,verbos:[0,2,8,11],veri:[6,8,10],verifi:0,verlet:[0,3,6,11],versa:3,version:[0,6,8,11,13],vert:0,vertex:[0,5],vertic:0,via:[6,15],vice:3,vir:12,virial:12,vol:0,volum:[0,3,12,13],voxel:0,wai:[8,13],warn:0,weakli:3,weight:0,well:6,were:0,weslei:0,wheel:8,when:[0,3,8,10],where:[0,5,9,10,12,13],whether:[0,3],which:[0,2,3,5,6,8,9,10,11,12],width:[0,3],window:[0,5,13],without:[0,15],work:[0,8],workload:0,would:[0,3],wrap:0,wrapper:0,write:[0,3],written:[0,3],www:0,xavier:15,yet:0,yield:6,you:[8,10,15],yuan:15,zero:[0,3],zhong:15,zhu:15},titles:["4. API reference","3. Benchmarks","5. Command line arguments","3. Configuration file","6. Constants and Units","3. Electrostatic interactions","1. Examples","2. Filtering","1. Installation","1. Interaction energy functionals","2. Intramolecular bonds","2. Usage overview for HylleraasMD","4. Pressure","1. Theory","4. Topology and structure file","HylleraasMD documentation"],titleterms:{"function":9,"import":8,"new":[7,9],"while":8,SDS:6,api:0,argument:2,assembl:6,barostat:0,benchmark:1,berendsen:0,bilay:6,bond:[1,3,10],build:8,calcul:13,chain:6,chi:9,code:15,colab:15,colaboratori:8,command:2,common:8,configur:3,constant:4,copolym:6,curl:8,dataset:14,depend:8,develop:15,diblock:6,docker:8,document:15,due:8,electrostat:[3,5],enabl:8,energi:9,error:8,exampl:6,extern:13,field:[0,1,3],file:[0,3,14],filter:[7,13],forc:[0,1,8,13],form:[9,13],fortran:8,four:10,gas:6,googl:[8,15],guid:15,h5py:8,hamiltonian:[0,13],helix:6,hylleraasmd:[11,15],hymd:[8,15],ideal:6,implement:[7,9],incompress:9,indic:15,input:0,instal:[8,15],integr:0,interact:[5,8,9],interpol:13,intramolecular:10,issu:8,kappa:9,kernel:8,keyword:3,line:2,lipid:6,logger:0,metadata:3,miss:8,mpi:8,numpi:8,onli:9,option:[2,14],output:0,overview:11,parallel:[8,11],parser:0,particl:[1,3,10],peptid:6,pfft:8,phase:6,phi:9,potenti:13,pressur:[0,3,12],python:8,reciproc:13,refer:[0,15],requir:[2,14],rod:6,run:[8,11,15],scr:0,self:6,separ:6,simul:[3,11],sourc:15,space:13,specifi:5,stiff:6,structur:14,tabl:15,test:11,theori:13,thermostat:0,three:10,topolog:14,two:10,unit:4,usag:11,user:15,wget:8,without:8}}) \ No newline at end of file diff --git a/v2.0.2/.buildinfo b/v2.0.2/.buildinfo new file mode 100644 index 00000000..1201e1d0 --- /dev/null +++ b/v2.0.2/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: fff46af7c3ac3dd3773fb68a1920c2c4 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v2.0.2/.doctrees/doc_pages/api.doctree b/v2.0.2/.doctrees/doc_pages/api.doctree new file mode 100644 index 00000000..304b4d73 Binary files /dev/null and b/v2.0.2/.doctrees/doc_pages/api.doctree differ diff --git a/v2.0.2/.doctrees/doc_pages/benchmarks.doctree b/v2.0.2/.doctrees/doc_pages/benchmarks.doctree new file mode 100644 index 00000000..47e55b55 Binary files /dev/null and b/v2.0.2/.doctrees/doc_pages/benchmarks.doctree differ diff --git a/v2.0.2/.doctrees/doc_pages/command_line.doctree b/v2.0.2/.doctrees/doc_pages/command_line.doctree new file mode 100644 index 00000000..b0af54d2 Binary files /dev/null and b/v2.0.2/.doctrees/doc_pages/command_line.doctree differ diff --git a/v2.0.2/.doctrees/doc_pages/config_file.doctree b/v2.0.2/.doctrees/doc_pages/config_file.doctree new file mode 100644 index 00000000..2673d752 Binary files /dev/null and b/v2.0.2/.doctrees/doc_pages/config_file.doctree differ diff --git a/v2.0.2/.doctrees/doc_pages/constants_and_units.doctree b/v2.0.2/.doctrees/doc_pages/constants_and_units.doctree new file mode 100644 index 00000000..16170cbc Binary files /dev/null and b/v2.0.2/.doctrees/doc_pages/constants_and_units.doctree differ diff --git a/v2.0.2/.doctrees/doc_pages/electrostatics.doctree b/v2.0.2/.doctrees/doc_pages/electrostatics.doctree new file mode 100644 index 00000000..9f8382aa Binary files /dev/null and b/v2.0.2/.doctrees/doc_pages/electrostatics.doctree differ diff --git a/v2.0.2/.doctrees/doc_pages/examples.doctree b/v2.0.2/.doctrees/doc_pages/examples.doctree new file mode 100644 index 00000000..c255cb40 Binary files /dev/null and b/v2.0.2/.doctrees/doc_pages/examples.doctree differ diff --git a/v2.0.2/.doctrees/doc_pages/filtering.doctree b/v2.0.2/.doctrees/doc_pages/filtering.doctree new file mode 100644 index 00000000..d8d5e7e9 Binary files /dev/null and b/v2.0.2/.doctrees/doc_pages/filtering.doctree differ diff --git a/v2.0.2/.doctrees/doc_pages/installation.doctree b/v2.0.2/.doctrees/doc_pages/installation.doctree new file mode 100644 index 00000000..cdeea450 Binary files /dev/null and b/v2.0.2/.doctrees/doc_pages/installation.doctree differ diff --git a/v2.0.2/.doctrees/doc_pages/interaction_energy_functionals.doctree b/v2.0.2/.doctrees/doc_pages/interaction_energy_functionals.doctree new file mode 100644 index 00000000..dea88299 Binary files /dev/null and b/v2.0.2/.doctrees/doc_pages/interaction_energy_functionals.doctree differ diff --git a/v2.0.2/.doctrees/doc_pages/intramolecular_bonds.doctree b/v2.0.2/.doctrees/doc_pages/intramolecular_bonds.doctree new file mode 100644 index 00000000..ccad6b66 Binary files /dev/null and b/v2.0.2/.doctrees/doc_pages/intramolecular_bonds.doctree differ diff --git a/v2.0.2/.doctrees/doc_pages/overview.doctree b/v2.0.2/.doctrees/doc_pages/overview.doctree new file mode 100644 index 00000000..bed061b1 Binary files /dev/null and b/v2.0.2/.doctrees/doc_pages/overview.doctree differ diff --git a/v2.0.2/.doctrees/doc_pages/pressure.doctree b/v2.0.2/.doctrees/doc_pages/pressure.doctree new file mode 100644 index 00000000..45a05246 Binary files /dev/null and b/v2.0.2/.doctrees/doc_pages/pressure.doctree differ diff --git a/v2.0.2/.doctrees/doc_pages/theory.doctree b/v2.0.2/.doctrees/doc_pages/theory.doctree new file mode 100644 index 00000000..b9c2b8a7 Binary files /dev/null and b/v2.0.2/.doctrees/doc_pages/theory.doctree differ diff --git a/v2.0.2/.doctrees/doc_pages/topology_input.doctree b/v2.0.2/.doctrees/doc_pages/topology_input.doctree new file mode 100644 index 00000000..d083e008 Binary files /dev/null and b/v2.0.2/.doctrees/doc_pages/topology_input.doctree differ diff --git a/v2.0.2/.doctrees/environment.pickle b/v2.0.2/.doctrees/environment.pickle new file mode 100644 index 00000000..e8e3061f Binary files /dev/null and b/v2.0.2/.doctrees/environment.pickle differ diff --git a/v2.0.2/.doctrees/index.doctree b/v2.0.2/.doctrees/index.doctree new file mode 100644 index 00000000..5b9f402b Binary files /dev/null and b/v2.0.2/.doctrees/index.doctree differ diff --git a/v2.0.2/_downloads/08b33f5b989a569ecc60b3664d8a65a2/benchmarks-1.hires.png b/v2.0.2/_downloads/08b33f5b989a569ecc60b3664d8a65a2/benchmarks-1.hires.png new file mode 100644 index 00000000..173b39f3 Binary files /dev/null and b/v2.0.2/_downloads/08b33f5b989a569ecc60b3664d8a65a2/benchmarks-1.hires.png differ diff --git a/v2.0.2/_downloads/0d02667f59b4a25eaf7e2dd654b9b230/benchmarks-2.hires.png b/v2.0.2/_downloads/0d02667f59b4a25eaf7e2dd654b9b230/benchmarks-2.hires.png new file mode 100644 index 00000000..82806426 Binary files /dev/null and b/v2.0.2/_downloads/0d02667f59b4a25eaf7e2dd654b9b230/benchmarks-2.hires.png differ diff --git a/v2.0.2/_downloads/319d6d4ede6c04e661e435832d4efef2/benchmarks-1.py b/v2.0.2/_downloads/319d6d4ede6c04e661e435832d4efef2/benchmarks-1.py new file mode 100644 index 00000000..deb4348f --- /dev/null +++ b/v2.0.2/_downloads/319d6d4ede6c04e661e435832d4efef2/benchmarks-1.py @@ -0,0 +1,38 @@ +import numpy as np +import matplotlib.pyplot as plt +nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) +time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 +], dtype=np.float64) +nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 +], dtype=np.float64,) +time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, +], dtype=np.float64) +nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 +], dtype=np.float64) +time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, +], dtype=np.float64) +plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" +) +plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" +) +plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" +) +plt.xlabel("CPUs", fontsize=15) +plt.ylabel("Time per step, us", fontsize=15) +plt.legend(fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.show() \ No newline at end of file diff --git a/v2.0.2/_downloads/59a950d23cac5ff75d472b28f2fb7bc1/benchmarks-2.py b/v2.0.2/_downloads/59a950d23cac5ff75d472b28f2fb7bc1/benchmarks-2.py new file mode 100644 index 00000000..fd287cbc --- /dev/null +++ b/v2.0.2/_downloads/59a950d23cac5ff75d472b28f2fb7bc1/benchmarks-2.py @@ -0,0 +1,33 @@ +import numpy as np +import matplotlib.pyplot as plt + +mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] +mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + +mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + +mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + +mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] +mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + +mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + +mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + +plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") +plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") +plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") +plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") +plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") +plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") +plt.xlabel("CPUs", fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.ylabel("Time per step, s", fontsize=15) +plt.legend(loc="upper left", fontsize=15) +plt.show() \ No newline at end of file diff --git a/v2.0.2/_downloads/7ac6b6b8f06de25c6a498cde7d8c5b6a/benchmarks-1.png b/v2.0.2/_downloads/7ac6b6b8f06de25c6a498cde7d8c5b6a/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v2.0.2/_downloads/7ac6b6b8f06de25c6a498cde7d8c5b6a/benchmarks-1.png differ diff --git a/v2.0.2/_downloads/956375565b4ff21c1da20626e7260565/benchmarks-2.pdf b/v2.0.2/_downloads/956375565b4ff21c1da20626e7260565/benchmarks-2.pdf new file mode 100644 index 00000000..139a30f0 Binary files /dev/null and b/v2.0.2/_downloads/956375565b4ff21c1da20626e7260565/benchmarks-2.pdf differ diff --git a/v2.0.2/_downloads/a5ee8476859dbdbebb1bc938d5a69d4d/benchmarks-1.pdf b/v2.0.2/_downloads/a5ee8476859dbdbebb1bc938d5a69d4d/benchmarks-1.pdf new file mode 100644 index 00000000..eba9d1ff Binary files /dev/null and b/v2.0.2/_downloads/a5ee8476859dbdbebb1bc938d5a69d4d/benchmarks-1.pdf differ diff --git a/v2.0.2/_downloads/d118f4a8bd3e9bb3fa0ededf8b16acf9/benchmarks-2.png b/v2.0.2/_downloads/d118f4a8bd3e9bb3fa0ededf8b16acf9/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v2.0.2/_downloads/d118f4a8bd3e9bb3fa0ededf8b16acf9/benchmarks-2.png differ diff --git a/v2.0.2/_images/benchmarks-1.png b/v2.0.2/_images/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v2.0.2/_images/benchmarks-1.png differ diff --git a/v2.0.2/_images/benchmarks-2.png b/v2.0.2/_images/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v2.0.2/_images/benchmarks-2.png differ diff --git a/v2.0.2/_images/hylleraas_centre_logo_black.png b/v2.0.2/_images/hylleraas_centre_logo_black.png new file mode 100644 index 00000000..40826396 Binary files /dev/null and b/v2.0.2/_images/hylleraas_centre_logo_black.png differ diff --git a/v2.0.2/_images/uio_full_logo_eng_pos.png b/v2.0.2/_images/uio_full_logo_eng_pos.png new file mode 100644 index 00000000..6c603139 Binary files /dev/null and b/v2.0.2/_images/uio_full_logo_eng_pos.png differ diff --git a/v2.0.2/_modules/hymd/barostat.html b/v2.0.2/_modules/hymd/barostat.html new file mode 100644 index 00000000..fcea2b1c --- /dev/null +++ b/v2.0.2/_modules/hymd/barostat.html @@ -0,0 +1,599 @@ + + + + + + hymd.barostat — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.barostat

+"""Implements the Berendsen barostat.
+Scales the box and particle positions during simulation to
+simulate coupling to an external pressure bath set at a
+target pressure.
+
+It calculates the scaling factor according to:
+.. math::
+
+    \\alpha_{L,N} = 1 - \\frac{dt n_b}{\\tau_p}\\β(P_{L,N}^t - P_{L,N})
+
+where :math:`dt` is the outer rRESPA time-step, :math:`n_b` is the frequency
+of barostat calls, :math:`\\tau_p` is the pressure coupling time constant,
+:math:`\\beta` is the isothermal compressibility, :math:`P_{L,N}^t` and 
+:math:`P_{L,N}` is the target and instantaneous internal pressure in the 
+lateral (L) and normal (N) directions respectively. Convention: Cartesian
+z-direction is considered normal.
+
+The box and particle positions are scaled in the L and N directions according
+to the nature of the barostat (see functions `isotropic` and `semiisotropic`
+below by an amount :math:`\α^{\\frac{1}{3}}`.
+
+The updated system information is passed on to the pmesh objects.
+
+References
+----------
+H. J. C. Berendsen, J. P. M. Postma, W. F. van Gunsteren,
+A. DiNola, and J. R. Haak , "Molecular dynamics with coupling
+to an external bath", J. Chem. Phys. 81, 3684-3690 (1984)
+"""
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass
+from typing import Union
+from .pressure import comp_pressure
+from .field import initialize_pm
+
+
+@dataclass
+class Target_pressure:
+    P_L: Union[bool, float]
+    P_N: Union[bool, float]
+
+
+
[docs]def isotropic( + pmesh, + pm_stuff, + phi, + phi_q, + psi, + hamiltonian, + positions, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + bond_pr, + angle_pr, + step, + prng, + comm=MPI.COMM_WORLD, +): + """ + Implements an isotropic Berendsen barostat. + The box and particle positions are scaled uniformly + in the L and N directions. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of pmesh objects. + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fft : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds. + step : integer + MD step number + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of modified/unmodified pmesh objects. + change : Boolean + Indicates whether or not any pmesh objects were reinitialized. + """ + rank = comm.Get_rank() + beta = 4.6 * 10 ** (-5) # bar^(-1) #isothermal compressibility of water + change = False + + if np.mod(step, config.n_b) == 0: + change = True + # compute pressure + pressure = comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=comm, + ) + + # Total pressure across all ranks + P = np.average(pressure[-3:-1]) # kJ/(mol nm^3) + P = P * 16.61 # bar + + # scaling factor + alpha = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_L - P) + ) ** (1 / 3) + + # length scaling + config.box_size *= alpha + + # position coordinates scaling + positions *= alpha + + # pmesh re-initialize + pm_stuff = initialize_pm(pmesh, config, comm) + return (pm_stuff, change)
+ + +
[docs]def semiisotropic( + pmesh, + pm_stuff, + phi, + phi_q, + psi, + hamiltonian, + positions, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + bond_pr, + angle_pr, + step, + prng, + comm=MPI.COMM_WORLD, +): + """ + Implements a semiisotropic Berendsen barostat. + The box and particle positions are scaled by :math:`\\alpha_L^{\\frac{1}{3}}` + in the L direction and by :math:`\\alpha_N^{\\frac{1}{3}}` in the N direction. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of pmesh objects. + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fft : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds. + step : integer + MD step number + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of modified/unmodified pmesh objects. + change : Boolean + Indicates whether or not any pmesh objects were reinitialized. + """ + rank = comm.Get_rank() + beta = 4.6 * 10 ** (-5) # bar^(-1) #isothermal compressibility of water + change = False + if np.mod(step, config.n_b) == 0: + change = True + + # compute pressure + pressure = comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=comm, + ) + + # Total pressure across all ranks + # L: Lateral; N: Normal + [PL, PN] = [0, 0] + PL = (pressure[-3] + pressure[-2]) / 2 # kJ/(mol nm^3) + PN = pressure[-1] # kJ/(mol nm^3) + PL = PL * 16.61 # bar + PN = PN * 16.61 # bar + alphaL = 1.0 + alphaN = 1.0 + + if config.target_pressure.P_L: + # scaling factor + alphaL = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_L - PL) + ) ** (1 / 3) + # length scaling + config.box_size[0:2] *= alphaL + + positions[:][0:2] *= alphaL + + if config.target_pressure.P_N: + # scaling factor + alphaN = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_N - PN) + ) ** (1 / 3) + # length scaling + config.box_size[2] *= alphaN + + positions[:][2] *= alphaN + + # pmesh re-initialize + pm_stuff = initialize_pm(pmesh, config, comm) + return (pm_stuff, change)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/_modules/hymd/field.html b/v2.0.2/_modules/hymd/field.html new file mode 100644 index 00000000..ece3bade --- /dev/null +++ b/v2.0.2/_modules/hymd/field.html @@ -0,0 +1,1468 @@ + + + + + + hymd.field — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.field

+"""Forces and energies from the discretized particle-field grid interactions
+"""
+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import warnings
+
+
+
[docs]def initialize_pm(pmesh, config, comm=MPI.COMM_WORLD): + """ + Creates the necessary pmesh objects for pfft operations. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + config : Config + Configuration dataclass containing simulation metadata and parameters. + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm : object 'pmesh.pm.ParticleMesh' + field_list : list[pmesh.pm.RealField], (multiple) + Essential list of pmesh objects required for MD + list_coulomb : list[pmesh.pm.RealField], (multiple) + Additional list of pmesh objects required for electrostatics. + """ + + if config.dtype == np.float64: + pmeshtype = "f8" + else: + pmeshtype = "f4" + # Ignore numpy numpy.VisibleDeprecationWarning: Creating an ndarray from + # ragged nested sequences until it is fixed in pmesh + with warnings.catch_warnings(): + warnings.filterwarnings( + action="ignore", + category=np.VisibleDeprecationWarning, + message=r"Creating an ndarray from ragged nested sequences", + ) + # The first argument of ParticleMesh has to be a tuple + pm = pmesh.ParticleMesh( + config.mesh_size, BoxSize=config.box_size, dtype=pmeshtype, comm=comm + ) + phi = [pm.create("real", value=0.0) for _ in range(config.n_types)] + phi_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] # noqa: E501 + force_on_grid = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + v_ext_fourier = [pm.create("complex", value=0.0) for _ in range(4)] + v_ext = [pm.create("real", value=0.0) for _ in range(config.n_types)] + + phi_transfer = [pm.create("complex", value=0.0) for _ in range(3)] + + phi_laplacian = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + + # Initialize charge density fields + coulomb_list = [] + elec_common_list = [None, None, None, None] + _SPACE_DIM = config.box_size.size + + if config.coulombtype == "PIC_Spectral_GPE" or config.coulombtype == "PIC_Spectral": + phi_q = pm.create("real", value=0.0) + phi_q_fourier = pm.create("complex", value=0.0) + psi = pm.create("real", value=0.0) + elec_field = [pm.create("real", value=0.0) for _ in range(_SPACE_DIM)] + + elec_common_list = [phi_q, phi_q_fourier, psi, elec_field] + + if config.coulombtype == "PIC_Spectral": + elec_field_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] # for force calculation + psi_fourier = pm.create("complex", value=0.0) + + coulomb_list = [ + elec_field_fourier, + psi_fourier, + ] + + if ( + config.coulombtype == "PIC_Spectral_GPE" + ): ## initializing the density mesh #dielectric_flag + phi_eps = pm.create( + "real", value=0.0 + ) ## real contrib of the epsilon dielectric painted to grid + phi_eps_fourier = pm.create("complex", value=0.0) # complex contrib of phi eps + phi_eta = [ + pm.create("real", value=0.0) for _ in range(_SPACE_DIM) + ] ## real contrib of factor in polarization charge density + phi_eta_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] ## fourier of factor in polarization charge density + phi_pol = pm.create( + "real", value=0.0 + ) ## real contrib of the polarization charge + phi_pol_prev = pm.create("real", value=0.0) + elec_dot = pm.create("real", value=0.0) + elec_field_contrib = pm.create( + "real", value=0.0 + ) # needed for pol energies later + + # External potential and force meshes + Vbar_elec = [pm.create("real", value=0.0) for _ in range(config.n_types)] + Vbar_elec_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] + force_mesh_elec = [ + [pm.create("real", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + force_mesh_elec_fourier = [ + [pm.create("complex", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + + coulomb_list = [ + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol, + phi_pol_prev, + elec_dot, + elec_field_contrib, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + ] + + field_list = [ + phi, + phi_fourier, + force_on_grid, + v_ext_fourier, + v_ext, + phi_transfer, + phi_laplacian, + ] + + return (pm, field_list, elec_common_list, coulomb_list)
+ + +
[docs]def compute_field_force(layouts, r, force_mesh, force, types, n_types): + """Interpolate particle-field forces from the grid onto particle positions + + Backmaps the forces calculated on the grid to particle positions using the + window function :math:`P` (by default cloud-in-cell [CIC]). In the + following, let :math:`\\mathbf{F}_j` denote the force acting on the + particle with index :math:`j` and position :math:`\\mathbf{r}_j`. The + interpolated force is + + .. math:: + + \\mathbf{F}_j = -\\sum_k\\nabla V_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`V_{j_k}` is the discretized external potential at grid vertex + :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid vertex + with index :math:`j_k`, and :math:`h^3` is the volume of each grid voxel. + The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + r : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + force : (N,D) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. Local + for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + n_types : int + Number of different unique types present in the simulation system. + :code:`n_types` is global, i.e. the same for all MPI ranks even if some + ranks contain zero particles of certain types. + """ + for t in range(n_types): + ind = types == t + for d in range(3): + force[ind, d] = force_mesh[t][d].readout(r[ind], layout=layouts[t])
+ + +
[docs]def compute_self_energy_q(config, charges, comm=MPI.COMM_WORLD): + """Compute the self energy for the interaction due to the Ewald scheme + used to compute the electrostatics. The energy is stored in :code:`config`. + + The self interaction energy is given by: + + .. math:: + + U_{self} = \\sqrt{\\frac{1}{2\\pi\\sigma^2}} \\sum_{i=1}^{N} q_i^2 + + where :math:`q_i` are the charges and :math:`\\sigma` is the half-width + of the Gaussian filter. + + Parameters + ---------- + config : Config + Configuration object. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + comm : mpi4py.Comm + MPI communicator to use for rank communication. + + Returns + ------- + field_q_self_energy : float + Electrostatic self energy. + """ + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + prefac = elec_conversion_factor * np.sqrt( + 1.0 / (2.0 * np.pi * config.sigma * config.sigma) + ) + _squared_charges = charges * charges + squared_charges_sum = comm.allreduce(np.sum(_squared_charges)) + return prefac * squared_charges_sum
+ + +
[docs]def update_field_force_q( + charges, + phi_q, + phi_q_fourier, + psi, + psi_fourier, + elec_field_fourier, + elec_field, + elec_forces, + layout_q, + hamiltonian, + pm, + positions, + config, +): + """Calculate the electrostatic particle-field forces on the grid + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential is computed in reciprocal space as + + .. math:: + + \\Phi = \\mathrm{FFT}^{-1}\\left[ + \\frac{4\\pi k_e}{\\varepsilon \\vert\\mathbf{k}\\vert^2} + \\mathrm{FFT}(\\rho)\\mathrm{FFT}(H) + \\right], + + with the electric field + + .. math:: + + \\mathbf{E} = \\mathrm{FFT}^{-1}\\left[ + -i\\mathbf{k}\\,\\mathrm{FFT}(\\Psi) + \\right]. + + In the following, let :math:`\\mathbf{F}_j` denote the electrostatic force + acting on the particle with index :math:`j` and position + :math:`\\mathbf{r}_j`. The interpolated electrostatic force is + + .. math:: + + \\mathbf{F}_j = \\sum_k q_j\\mathbf{E}_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`\\mathbf{E}_{j_k}` is the discretized electric field at grid + vertex :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid + vertex with index :math:`j_k`, and :math:`h^3` is the volume of each grid + voxel. The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty; any values in this field + are discarded. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + elec_field_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + electric field values in reciprocal space on the computational grid. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + n_dimensions = config.box_size.size + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + # charges to grid + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) + phi_q /= volume_per_cell + # print("phi_q", np.sum(phi_q)) + phi_q.r2c(out=phi_q_fourier) + + # smear charges with filter + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + + # solve Poisson equation in Fourier space to get electrostatic potential + def poisson_transfer_function(k, v): + return 4.0 * np.pi * elec_conversion_factor * v / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(poisson_transfer_function, out=psi_fourier) + # print("psi_fourier", np.sum(psi_fourier)) + psi_fourier.c2r(out=psi) + # print("phi_q * psi update_field", np.sum(phi_q * psi)) + + # exit() + + # compute electric field directly from smeared charged densities in Fourier + for _d in np.arange(n_dimensions): + + def poisson_transfer_function(k, v, d=_d): + return ( + -1j + * k[d] + * 4.0 + * np.pi + * elec_conversion_factor + * v + / k.normp(p=2, zeromode=1) + ) + + phi_q_fourier.apply(poisson_transfer_function, out=elec_field_fourier[_d]) + elec_field_fourier[_d].c2r(out=elec_field[_d]) + + # get electrostatic force from electric field + for _d in np.arange(n_dimensions): + elec_forces[:, _d] = charges * ( + elec_field[_d].readout(positions, layout=layout_q) + )
+ + +def comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, +): + for t in range(config.n_types): + np.copyto(phi_transfer[0].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[1].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[2].value, phi_fourier[t].value, casting="no", where=True) + + # Evaluate laplacian of phi in fourier space + for d in range(3): + + def laplacian_transfer(k, v, d=d): + return -k[d] ** 2 * v + + phi_transfer[d].apply(laplacian_transfer, out=Ellipsis) + phi_transfer[d].c2r(out=phi_laplacian[t][d]) + + +
[docs]def update_field( + phi, + phi_laplacian, + phi_transfer, + layouts, + force_mesh, + hamiltonian, + pm, + positions, + types, + config, + v_ext, + phi_fourier, + v_ext_fourier, + m, + compute_potential=False, +): + """Calculate the particle-field potential and force density + + If :code:`compute_potential` is :code:`True`, the energy may subsequently + be computed by calling :code:`compute_field_and_kinetic_energy`. + + Computes the particle-field external potential :math:`V_\\text{ext}` from + particle number densities through the smoothed density field, + :math:`\\phi(\\mathbf{r})`. With :math:`P` being the cloud-in-cell (CIC) + window function, the density and filtered densities are computed as + + .. math:: + + \\phi(\\mathbf{r}) = \\sum_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\phi(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\phi(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + external potential is computed in reciprocal space as + + .. math:: + + V_\\text{ext} = \\mathrm{FFT}^{-1}\\left[ + \\mathrm{FFT} + \\left( + \\frac{\\partial w}{\\partial \\tilde\\phi} + \\right) + \\mathrm{FFT}(H) + \\right], + + where :math:`w` is the interaction energy functional. Differentiating + :math:`V_\\text{ext}` is done by simply applying :math:`i\\mathbf{k}` in + Fourier space, and the resulting forces are back-transformed to direct + space and interpolated to particle positions by + + .. math:: + + \\mathbf{F}_j = -\\sum_{j_k} \\nabla V_{j_k} + P(\\mathbf{r}_{j_k} - \\mathbf{r}_j)h^3, + + where :math:`j_k` are the neighbouring vertices of particle :math:`j` at + position :math:`\\mathbf{r}_j`, and :math:`h^3` is the volume of each grid + voxel. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Pre-allocated, but empty; any values + in this field are discarded. Changed in-place. Local for each MPI + rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + config : Config + Configuration object. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Pre-allocated, but empty; any values in this field are + discarded Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + phi_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computational grid is represented by the collective fields of all + MPI ranks. + v_ext_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplesField` objects containing discretized + particle-field external potential values in reciprocal space on the + computational grid; :code:`D+1` fields in D dimensions for each + particle type. :code:`D` copies are made after calculation for later + use in force calculation, because the `force transfer function` + application differentiates the field in-place, ruining the contents + for differentiation in the remaining :code:`D-1` spatial directions. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + m: list[float], (M,) + pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. + Defaults to 1.0 for all particle types. + compute_potential : bool, optional + If :code:`True`, a :code:`D+1`-th copy of the Fourier transformed + external potential field is made to be used later in particle-field + energy calculation. If :code:`False`, only :code:`D` copies are made. + + See also + -------- + compute_field_and_kinetic_energy : + Compute the particle-field energy after the external potential is + calculated. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + for t in range(config.n_types): + pm.paint(positions[types == t], mass=m[t], layout=layouts[t], out=phi[t]) + phi[t] /= volume_per_cell + phi[t].r2c(out=phi_fourier[t]) + phi_fourier[t].apply(hamiltonian.H, out=Ellipsis) + phi_fourier[t].c2r(out=phi[t]) + + # External potential + for t in range(config.n_types): + v = hamiltonian.v_ext[t](phi) + + v.r2c(out=v_ext_fourier[0]) + v_ext_fourier[0].apply(hamiltonian.H, out=Ellipsis) + np.copyto( + v_ext_fourier[1].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + np.copyto( + v_ext_fourier[2].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + if compute_potential: + np.copyto( + v_ext_fourier[3].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + + # Differentiate the external potential in fourier space + for d in range(3): + + def force_transfer_function(k, v, d=d): + return -k[d] * 1j * v + + v_ext_fourier[d].apply(force_transfer_function, out=Ellipsis) + v_ext_fourier[d].c2r(out=force_mesh[t][d]) + + if compute_potential: + v_ext_fourier[3].c2r(out=v_ext[t])
+ + +
[docs]def compute_field_and_kinetic_energy( + phi, + phi_q, + psi, + velocity, + hamiltonian, + positions, + types, + v_ext, + config, + layouts, + comm=MPI.COMM_WORLD, +): + """Compute the particle-field and kinetic energy contributions + + Calculates the kinetic energy through + + .. math:: + + E_k = \\sum_j \\frac{1}{2}m_j\\mathbf{v}_j\\cdot\\mathbf{v}_j, + + and the particle-field energy by + + .. math:: + + E_\\text{field} = \\int\\mathrm{d}\\mathbf{r}\\, + w[\\tilde\\phi], + + where :math:`w` is the interaction energy functional `density`. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + velocity : (N,D) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Local for each MPI rank--the full computational grid is + represented by the collective fields of all MPI ranks. + config : Config + Configuration object. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field : + Computes the up-to-date external potential for use in calculating the + particle-field energy. + """ + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + field_energy = w_0.csum() # w to W + + kinetic_energy = comm.allreduce(0.5 * config.mass * np.sum(velocity**2)) + + if config.coulombtype == "PIC_Spectral": + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + field_q_energy = w_elec.csum() + else: + field_q_energy = 0.0 + + return field_energy, kinetic_energy, field_q_energy
+ + +
[docs]def compute_field_energy_q_GPE( + config, + phi_eps, + field_q_energy, + dot_elec, + comm=MPI.COMM_WORLD, +): + """ + Compute the electrostatic energy after electrosatic forces is + calculated. + + From the definition of the elecrostatic potential :math:`\\Psi`, the energy + is + + W = \\frac{1}{2}\\int\\mathrm{d}\\mathbf{r}\\, + \\epsilon(\\mathbf{r})} \\left(\\mathbf{E}\\cdot \\mathbf{E}\\right), + + where :math:`\\epsilon(\\mathbf{r})}` is the anisotropic, spatially dependent, + relative dielectric of the simulation medium. + + Parameters + ---------- + config : hymd.input_parser.Config + Configuration object. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + field_q_energy : float + Total elecrostatic energy. + dot_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing :math:`|\\mathbf{E(r)}|^{2}` + on the computational grid. Local for each MPI rank -- the full computational + grid is represented by the collective fields of all MPI ranks. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field_force_q_GPE: + Compute the electrosatic force from an anisotropic dielectric general + Poisson equation. + """ + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + # ^ due to integration on local cell before allreduce + + eps_0 = 1.0 / (config.coulomb_constant * 4 * np.pi) + field_q_energy = ( + volume_per_cell * (0.5 * eps_0) * comm.allreduce(np.sum(phi_eps * dot_elec)) + ) + + return field_q_energy
+ + +
[docs]def update_field_force_q_GPE( + conv_fun, + phi, + types, + charges, + phi_q, + phi_q_fourier, + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol_prev, + phi_pol, + elec_field, + elec_forces, + elec_field_contrib, + psi, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + hamiltonian, + layout_q, + layouts, + pm, + positions, + config, + comm=MPI.COMM_WORLD, +): + """ + Calculate the electrostatic particle-field forces on the grid, arising from + a general Poisson equation, i.e. anisotropic permittivity/dielectric. + The function is called when tomli input config.coulombtype = "PIC_Spectral_GPE." + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential for a variable dielectric does not have an + analytical expression, and is computed in reciprocal through an iterative + method. + + The GPE states that + + .. math:: + + \\nabla \\cdot \\left(\\epsilon(\\mathbf{r}) + \\nabla{\\mathbf{\\psi(r)}}\\right) = -\\rho({\\mathbf{r}}). + + where :math:`\\epsilon(\\mathbf{r})` is the relative dielectric function. + + Parameters + ---------- + conv_fun : Convergence function. + Returns a scalar. Depends on MPI allreduce for similar convergence + across MPI ranks. + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_eta : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + gradients of the relative dielectric values on the computational grid. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank--the + full computational grid is represented by the collective fields of all MPI ranks. + phi_eta_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated discretized + Fourier transformed gradient relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol_prev : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charge values on the computational grid. Parameter in + the iterative method.Pre-allocated,but empty. Changedin-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charges on the computational grid. Parameter in the iterative + method, updating the next quess in solving for the electrostatic potential. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all + MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + elec_field_contrib : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing + :math:`|\\mathbf{E(r)}|^2/\\phi_{0}` on the computational grid. + Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + psi : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic potential + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + Vbar_elec : mesh.pm.RealField + Pmesh :code:`RealField` object for storing functional derivatives of + :math:`\\|w(\\{ \\phi \\})_{elec}`on the computational grid. + Pre-allocated, but empty. Changed in-place. Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + Vbar_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated functional + derivatives of :math:`\\|w(\\{ \\phi \\})_{elec}` in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + force_mesh_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic force values + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + force_mesh_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated electrostatic + force values in reciprocal space on the computational grid. Local for + each MPI rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + layouts: list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + comm: mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + compute_field_energy_q_GPE: + Compute the electrostatic energy after electrosatic force is + calculated for a variable (anisotropic) dielectric general Poisson equation. + """ + + ## basic setup + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + ## old protocol in gen_qe_hpf_use_self + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) ## + ## scale and fft + ## old protocol in gen_qe_hpf_use_self + phi_q /= volume_per_cell + phi_q.r2c(out=phi_q_fourier) + + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + ## ^------ use the same gaussian as the \kai interaciton + phi_q_fourier.c2r(out=phi_q) ## this phi_q is after applying the smearing function + + denom_phi_tot = pm.create("real", value=0.0) + num_types = pm.create("real", value=0.0) + ### ^ ----- Calculate the relative dielectric (permittivity) to field + ### ------- from a mean contribution of particle number densities + + for t_ in range(config.n_types): + num_types = num_types + (config.dielectric_type[t_]) * phi[t_] + denom_phi_tot = denom_phi_tot + phi[t_] + + np.divide(num_types, denom_phi_tot, where=np.abs(denom_phi_tot > 1e-6), out=phi_eps) + + phi_eps.r2c(out=phi_eps_fourier) # FFT dielectric + + # phi_q_eps = (phi_q/phi_eps) + np.divide(phi_q, phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_q) + + _SPACE_DIM = 3 + ##^--------- constants needed throughout the calculations + + ### method for finding the gradient (fourier space), using the spatial dimension of k + for _d in np.arange(_SPACE_DIM): + + def gradient_transfer_function(k, x, d=_d): + return 1j * k[d] * x + + phi_eps_fourier.apply(gradient_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=phi_eta[_d]) + np.divide(phi_eta[_d], phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_eta[_d]) + + ### iterative GPE solver ### + ### ---------------------------------------------- + max_iter = 100 + i = 0 + delta = 1.0 + # phi_pol_prev = pm.create("real", value = 0.0) + ### ^------ set to zero before each iterative procedure or soft start + conv_criteria = config.conv_crit # conv. criteria (default 1e-6) + w = config.pol_mixing # polarization mixing param (default 0.6) + while i < max_iter and delta > conv_criteria: + (phi_q + phi_pol_prev).r2c(out=phi_q_fourier) + for _d in np.arange(_SPACE_DIM): + + def iterate_apply_k_vec(k, additive_terms, d=_d): + return additive_terms * (-1j * k[d]) / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(iterate_apply_k_vec, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + + phi_pol = -( + phi_eta[0] * elec_field[0] + + phi_eta[1] * elec_field[1] + + phi_eta[2] * elec_field[2] + ) + ### ^-- Following a negative sign convention (-ik) of the FT, a neg sign is + ### --- mathematically correct by the definition of the GPE (double - -> +) + phi_pol = w * phi_pol + (1.0 - w) * phi_pol_prev + diff = np.abs(phi_pol - phi_pol_prev) + delta = conv_fun(comm, diff) # decided from toml input + phi_pol_prev = phi_pol.copy() + i = i + 1 + # print("Stopping after iteration {:d} with stop crit {:.2e}, delta {:.2e}".format(i,conv_criteria,delta)) + + # compute_potential = True + def k_norm_divide(k, potential): + return potential / k.normp(p=2, zeromode=1) + + ## > Electrostatic potential + eps0_inv = config.coulomb_constant * 4 * np.pi + ## ^ the 1/(4pi eps0)*4*pi = 1/eps0 + ((eps0_inv) * (phi_q + phi_pol)).r2c(out=phi_q_fourier) + phi_q_fourier.apply(k_norm_divide, out=phi_q_fourier) + phi_q_fourier.c2r(out=psi) + ### ^ electrostatic potential for the GPE + + for _d in np.arange(_SPACE_DIM): + + def field_transfer_function(k, x, d=_d): + return ( + -1j * k[d] * x + ) ## negative sign relation, due to E = - nabla psi relation + + phi_q_fourier.apply(field_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + ## ^-------- Method: Obtaining the electric field from electrostatic potential + ## Assuming the electric field is conserved. + ## Assumption holds if no magnetic flux (magnetic induced fields) + + ############## Obtain forces ############## + elec_dot = ( + elec_field[0] * elec_field[0] + + elec_field[1] * elec_field[1] + + elec_field[2] * elec_field[2] + ) + # needed for energy calculations + + np.divide( + elec_dot, + denom_phi_tot, + where=np.abs(denom_phi_tot > 1e-6), + out=elec_field_contrib, + ) + + eps0_inv = config.coulomb_constant * 4 * np.pi + + for t_ in range(config.n_types): + Vbar_elec[t_] = ( + config.type_charges[t_] * psi + - (0.5 / eps0_inv) + * (config.dielectric_type[t_] - phi_eps) + * elec_field_contrib + ) + + # Obtain Vext,k + for t_ in range(config.n_types): + Vbar_elec[t_].r2c(out=Vbar_elec_fourier[t_]) + Vbar_elec_fourier[t_].apply(hamiltonian.H, out=Vbar_elec_fourier[t_]) + + # force terms + # F = - grad Vext + for t_ in range(config.n_types): + for _d in np.arange(_SPACE_DIM): + + def force_transfer_function(k, x, d=_d): + return -1j * k[_d] * x ## negative gradient + + Vbar_elec_fourier[t_].apply( + force_transfer_function, out=force_mesh_elec_fourier[t_][_d] + ) + force_mesh_elec_fourier[t_][_d].c2r(out=force_mesh_elec[t_][_d]) + elec_forces[types == t_, _d] = force_mesh_elec[t_][_d].readout( + positions[types == t_], layout=layouts[t_] + ) + + return Vbar_elec, phi_eps, elec_dot
+ + +
[docs]def domain_decomposition( + positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=MPI.COMM_WORLD +): + """Performs domain decomposition + + Rearranges the MPI rank memory layout into one that better mimics the PFFT + pencil grid 2D decomposition. As molecules are always required to be fully + contained on a single MPI rank, a perfect decomposition is not always + possible. The best decomposition which leaves the center of mass of all + molecules in their respective correct domains is used, with possible + overlap into neighbouring domains if the spatial extent of any molecule + crosses domain boundaries. + + Parameters + ---------- + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + *args + Variable length argument list containing arrays to include in the + domain decomposition. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + bonds : (N,M) numpy.ndarray, optional + Array of :code:`M` bonds originating from each of :code:`N` particles. + verbose : int, optional + Specify the logging event verbosity of this function. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + Domain decomposed :code:`positions` and any array specified in + :code:`*args`, in addition to :code:`bonds` and :code:`molecules` if these + arrays were provided as input. + """ + if molecules is not None: + if not topol: + assert bonds is not None, "bonds must be provided with molecules" + unique_molecules = np.sort(np.unique(molecules)) + molecules_com = np.empty_like(positions) + for m in unique_molecules: + ind = molecules == m + r = positions[ind, :][0, :] + molecules_com[ind, :] = r + layout = pm.decompose(molecules_com, smoothing=0) + if not topol: + args = (*args, bonds, molecules) + else: + args = (*args, molecules) + else: + layout = pm.decompose(positions, smoothing=0) + if verbose > 1: + Logger.rank0.log( + logging.INFO, + "DOMAIN_DECOMP: Total number of particles to be exchanged = %d", + np.sum(layout.get_exchange_cost()), + ) + return layout.exchange(positions, *args)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/_modules/hymd/file_io.html b/v2.0.2/_modules/hymd/file_io.html new file mode 100644 index 00000000..96653d02 --- /dev/null +++ b/v2.0.2/_modules/hymd/file_io.html @@ -0,0 +1,1164 @@ + + + + + + hymd.file_io — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.file_io

+"""Handle file input/output in parllel HDF5 fashion
+"""
+import numpy as np
+import h5py
+import os
+import logging
+import getpass
+from mpi4py import MPI
+from .logger import Logger, get_version
+
+
+
[docs]class OutDataset: + """HDF5 dataset handler for file output""" + + def __init__( + self, + dest_directory, + config, + double_out=False, + disable_mpio=False, + comm=MPI.COMM_WORLD, + ): + """Constructor + + Parameters + ---------- + dest_directory : str + Ouput directory for saving data. + config : Config + Configuration object. + double_out : bool, optional + If :code:`True`, the output HDF5 objects are written in eight byte + floating point representation. Otherwise, four byte single + precision is used. + disable_mpio : bool, optional + If :code:`True`, disables parallel MPI-enabled HDF5 file output. + This is a compatibility option used if HDF5 is not compiled with + MPI support. This makes everything much harder by splitting all + output in one file per MPI rank, and having an MPI-enabled HDF5 + library is **highly recommended**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + """ + self.disable_mpio = disable_mpio + self.config = config + if double_out: + self.float_dtype = "float64" + else: + self.float_dtype = "float32" + + if disable_mpio: + self.file = h5py.File( + os.path.join( + dest_directory, f"sim.hdf5-{comm.rank:6d}-of-{comm.size:6d}" + ), + "w", + ) + else: + self.file = h5py.File( + os.path.join(dest_directory, "sim.H5"), "w", driver="mpio", comm=comm + ) + +
[docs] def is_open(self, comm=MPI.COMM_WORLD): + """Check if HDF5 output file is open + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + return self.file.__bool__()
+ +
[docs] def close_file(self, comm=MPI.COMM_WORLD): + """Closes the HDF5 output file + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + self.file.close()
+ +
[docs] def flush(self): + """Flushes output buffers, forcing file writes""" + self.file.flush()
+ + +
[docs]def setup_time_dependent_element( + name, parent_group, n_frames, shape, dtype, units=None +): + """Helper function for setting up time-dependent HDF5 group datasets + + All output groups must adhere to the H5MD standard, meaning a structure of + + + | ┗━ **group** particle group (e.g. :code:`all`) or :code:`observables` group + | ┗━ **group** time-dependent data + | ┣━ **dataset** :code:`step` :code:`shape=(n_frames,)` + | ┣━ **dataset** :code:`time` :code:`shape=(n_frames,)` + | ┗━ **dataset** :code:`value` :code:`shape=(n_frames, *)` + + is necessary. + + References + ---------- + H5MD specification : + https://www.nongnu.org/h5md/h5md.html + """ # noqa: E501 + group = parent_group.create_group(name) + step = group.create_dataset("step", (n_frames,), "int32") + time = group.create_dataset("time", (n_frames,), "float32") + value = group.create_dataset("value", (n_frames, *shape), dtype) + + if units is not None: + value.attrs["unit"] = units + time.attrs["unit"] = "ps" + return group, step, time, value
+ + +
[docs]def store_static( + h5md, + rank_range, + names, + types, + indices, + config, + bonds_2_atom1, + bonds_2_atom2, + molecules=None, + velocity_out=False, + force_out=False, + charges=False, + dielectrics=False, + plumed_out=False, + comm=MPI.COMM_WORLD, +): + """Outputs all static time-independent quantities to the HDF5 output file + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + rank_range : list[int] + Start and end indices for global arrays for each MPI rank. + names : (N,) numpy.ndarray + Array of names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of type indices for :code:`N` particles. + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + config : Config + Configuration object. + bonds_2_atom1 : (B,) numpy.ndarray + Array of indices of the first particle for :code:`B` total + two-particle bonds. + bonds_2_atom2 : (B,) numpy.ndarray + Array of indices of the second particle for :code:`B` total + two-particle bonds. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. + dielectrics : (N,) numpy.ndarray + Array of particle relative dielectric values for :code:`N` particles. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to output HDF5 file. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + prepare_bonds : + Constructs two-, three-, and four-particle bonds from toplogy input + file and bond configuration information. + distribute_input : + Distributes input arrays onto MPI ranks, attempting load balancing. + """ + dtype = h5md.float_dtype + + h5md_group = h5md.file.create_group("/h5md") + h5md.h5md_group = h5md_group + h5md.observables = h5md.file.create_group("/observables") + h5md.connectivity = h5md.file.create_group("/connectivity") + h5md.parameters = h5md.file.create_group("/parameters") + + h5md_group.attrs["version"] = np.array([1, 1], dtype=int) + author_group = h5md_group.create_group("author") + author_group.attrs["name"] = np.string_(getpass.getuser()) + creator_group = h5md_group.create_group("creator") + creator_group.attrs["name"] = np.string_("Hylleraas MD") + + # Get HyMD version + creator_group.attrs["version"] = np.string_(get_version()) + + h5md.particles_group = h5md.file.create_group("/particles") + h5md.all_particles = h5md.particles_group.create_group("all") + mass = h5md.all_particles.create_dataset("mass", (config.n_particles,), dtype) + mass[...] = config.mass + + if charges is not False: + charge = h5md.all_particles.create_dataset( + "charge", (config.n_particles,), dtype="float32" + ) + charge[indices] = charges + if dielectrics is not False: + dielectric = h5md.all_particles.create_dataset( + "dielectric", (config.n_particles,), dtype="float32" + ) + dielectric[indices] = dielectrics + + box = h5md.all_particles.create_group("box") + box.attrs["dimension"] = 3 + box.attrs["boundary"] = np.array( + [np.string_(s) for s in 3 * ["periodic"]], dtype="S8" + ) + + n_frames = config.n_steps // config.n_print + if np.mod(config.n_steps - 1, config.n_print) != 0: + n_frames += 1 + if np.mod(config.n_steps, config.n_print) == 1: + n_frames += 1 + if n_frames == config.n_steps: + n_frames += 1 + + species = h5md.all_particles.create_dataset( + "species", + (config.n_particles,), + dtype="i", + ) + + ( + _, + h5md.positions_step, + h5md.positions_time, + h5md.positions, + ) = setup_time_dependent_element( + "position", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm", + ) + if velocity_out: + ( + _, + h5md.velocities_step, + h5md.velocities_time, + h5md.velocities, + ) = setup_time_dependent_element( + "velocity", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm ps-1", + ) + if force_out: + ( + _, + h5md.forces_step, + h5md.forces_time, + h5md.forces, + ) = setup_time_dependent_element( + "force", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="kJ mol-1 nm-1", + ) + ( + _, + h5md.total_energy_step, + h5md.total_energy_time, + h5md.total_energy, + ) = setup_time_dependent_element( + "total_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.kinetc_energy_step, + h5md.kinetc_energy_time, + h5md.kinetc_energy, + ) = setup_time_dependent_element( + "kinetic_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.potential_energy_step, + h5md.potential_energy_time, + h5md.potential_energy, + ) = setup_time_dependent_element( + "potential_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.bond_energy_step, + h5md.bond_energy_time, + h5md.bond_energy, + ) = setup_time_dependent_element( + "bond_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.angle_energy_step, + h5md.angle_energy_time, + h5md.angle_energy, + ) = setup_time_dependent_element( + "angle_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.dihedral_energy_step, + h5md.dihedral_energy_time, + h5md.dihedral_energy, + ) = setup_time_dependent_element( + "dihedral_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.field_energy_step, + h5md.field_energy_time, + h5md.field_energy, + ) = setup_time_dependent_element( + "field_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + if charges is not False: + ( + _, + h5md.field_q_energy_step, + h5md.field_q_energy_time, + h5md.field_q_energy, + ) = setup_time_dependent_element( + "field_q_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) # <-------- xinmeng + if plumed_out is not False: + ( + _, + h5md.plumed_bias_step, + h5md.plumed_bias_time, + h5md.plumed_bias, + ) = setup_time_dependent_element( + "plumed_bias", h5md.observables, n_frames, (1,), dtype, units="kJ mol-1" # noqa: E501 + ) + ( + _, + h5md.total_momentum_step, + h5md.total_momentum_time, + h5md.total_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "total_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm g ps-1 mol-1", + ) + ( + _, + h5md.angular_momentum_step, + h5md.angular_momentum_time, + h5md.angular_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "angular_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm+2 g ps-1 mol-1", + ) + ( + _, + h5md.torque_step, + h5md.torque_time, + h5md.torque, + ) = setup_time_dependent_element( # noqa: E501 + "torque", + h5md.observables, + n_frames, + (3,), + dtype, + units="kJ nm+2 mol-1", + ) + ( + _, + h5md.temperature_step, + h5md.temperature_time, + h5md.temperature, + ) = setup_time_dependent_element( + "temperature", h5md.observables, n_frames, (3,), dtype, units="K" + ) + ( + _, + h5md.thermostat_work_step, + h5md.thermostat_work_time, + h5md.thermostat_work, + ) = setup_time_dependent_element( + "thermostat_work", + h5md.observables, + n_frames, + (1,), + "float32", + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.pressure_step, + h5md.pressure_time, + h5md.pressure, + ) = setup_time_dependent_element( + "pressure", h5md.observables, n_frames, (18,), "float32", units="Bar" + ) + (_, h5md.box_step, h5md.box_time, h5md.box_value,) = setup_time_dependent_element( + "edges", box, n_frames, (3, 3), "float32", units="nm" + ) + + ind_sort = np.argsort(indices) + for i in ind_sort: + species[indices[i]] = config.name_to_type_map[names[i].decode("utf-8")] + + h5md.parameters.attrs["config.toml"] = np.string_(str(config)) + vmd_group = h5md.parameters.create_group("vmd_structure") + index_of_species = vmd_group.create_dataset( + "indexOfSpecies", (config.n_types,), "i" + ) + index_of_species[:] = np.array(list(range(config.n_types))) + + # VMD-h5mdplugin maximum name/type name length is 16 characters (for + # whatever reason [VMD internals?]). + name_dataset = vmd_group.create_dataset("name", (config.n_types,), "S16") + type_dataset = vmd_group.create_dataset("type", (config.n_types,), "S16") + if molecules is not None: + resid_dataset = vmd_group.create_dataset( + "resid", + (config.n_particles,), + "i", + ) + + # Change this + for i, n in config.type_to_name_map.items(): + name_dataset[i] = np.string_(n[:16]) + if n == "W": + type_dataset[i] = np.string_("solvent") + else: + type_dataset[i] = np.string_("membrane") + + total_bonds = comm.allreduce(len(bonds_2_atom1), MPI.SUM) + n_bonds_local = len(bonds_2_atom1) + + receive_buffer = comm.gather(n_bonds_local, root=0) + n_bonds_global = None + if comm.Get_rank() == 0: + n_bonds_global = receive_buffer + n_bonds_global = np.array(comm.bcast(n_bonds_global, root=0)) + rank_bond_start = np.sum(n_bonds_global[: comm.Get_rank()]) + + bonds_from = vmd_group.create_dataset("bond_from", (total_bonds,), "i") + bonds_to = vmd_group.create_dataset("bond_to", (total_bonds,), "i") + for i in range(n_bonds_local): + a = bonds_2_atom1[i] + b = bonds_2_atom2[i] + bonds_from[rank_bond_start + i] = indices[a] + 1 + bonds_to[rank_bond_start + i] = indices[b] + 1 + + if molecules is not None: + resid_dataset[indices[ind_sort]] = molecules
+ + +# store data old vs +""" +h5md, step, frame, indices, positions, velocities, forces, box_size, +temperature, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, +field_energy, field_q_energy, time_step, config, velocity_out=False, +force_out=False, charge_out=False, dump_per_particle=False, +""" + + +
[docs]def store_data( + h5md, + step, + frame, + indices, + positions, + velocities, + forces, + box_size, + temperature, + pressure, + kinetic_energy, + bond2_energy, + bond3_energy, + bond4_energy, + field_energy, + field_q_energy, + plumed_bias, + time_step, + config, + velocity_out=False, + force_out=False, + charge_out=False, + plumed_out=False, + dump_per_particle=False, + comm=MPI.COMM_WORLD, +): + """Writes time-step data to HDF5 output file + + Handles all quantities which change during simulation, as opposed to + static quanitities (see :code:`store_static`). + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + step : int + Step number. + frame : int + Output frame number (:code:`step // n_print`). + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + positions : (N,) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + velocities : (N,) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + forces : (N,) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. + box_size : (D,) numpy.ndarray + Array containing the simulation box size. + temperature : float + Calculated instantaneous temperature. + kinetic_energy : float + Calculated instantaneous kinetic energy. + bond2_energy : float + Calculated instantaneous harmonic two-particle bond energy. + bond3_energy : float + Calculated instantaneous harmonic angular three-particle bond energy. + bond4_energy : float + Calculated instantaneous dihedral four-particle torsion energy. + field_energy : float + Calculated instantaneous particle-field energy. + field_q_energy : float + Calculated instantaneous electrostatic energy. + plumed_bias : float + PLUMED instantaneous bias energy. + time_step : float + Value of the time step. + config : Config + Configuration object. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charge_out : bool, optional + If :code:`True`, electrostatic energies are written to the output + HDF5 file. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to the output HDF5 file. + dump_per_particle : bool, optional + If :code:`True`, all quantities are written **per particle**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + store_static : + Outputs all static time-independent quantities to the HDF5 output file + """ + for dset in ( + h5md.positions_step, + h5md.total_energy_step, + h5md.potential_energy_step, + h5md.kinetc_energy_step, + h5md.bond_energy_step, + h5md.angle_energy_step, + h5md.dihedral_energy_step, + h5md.field_energy_step, + h5md.total_momentum_step, + h5md.angular_momentum_step, + h5md.torque_step, + h5md.temperature_step, + h5md.pressure_step, + h5md.box_step, + h5md.thermostat_work_step, + ): + dset[frame] = step + + for dset in ( + h5md.positions_time, + h5md.total_energy_time, + h5md.potential_energy_time, + h5md.kinetc_energy_time, + h5md.bond_energy_time, + h5md.angle_energy_time, + h5md.dihedral_energy_time, + h5md.field_energy_time, + h5md.total_momentum_time, + h5md.angular_momentum_time, + h5md.torque_time, + h5md.temperature_time, + h5md.pressure_time, + h5md.box_time, + h5md.thermostat_work_time, + ): + dset[frame] = step * time_step + + if velocity_out: + h5md.velocities_step[frame] = step + h5md.velocities_time[frame] = step * time_step + if force_out: + h5md.forces_step[frame] = step + h5md.forces_time[frame] = step * time_step + if charge_out: + h5md.field_q_energy_step[frame] = step + h5md.field_q_energy_time[frame] = step * time_step + if plumed_out: + h5md.plumed_bias_step[frame] = step + h5md.plumed_bias_time[frame] = step * time_step + + ind_sort = np.argsort(indices) + h5md.positions[frame, indices[ind_sort]] = positions[ind_sort] + + if velocity_out: + h5md.velocities[frame, indices[ind_sort]] = velocities[ind_sort] + if force_out: + h5md.forces[frame, indices[ind_sort]] = forces[ind_sort] + if charge_out: + h5md.field_q_energy[frame] = field_q_energy + if plumed_out: + h5md.plumed_bias[frame] = plumed_bias + + potential_energy = ( + bond2_energy + bond3_energy + bond4_energy + field_energy + field_q_energy + ) + + total_momentum = config.mass * comm.allreduce(np.sum(velocities, axis=0), MPI.SUM) + angular_momentum = config.mass * comm.allreduce( + np.sum(np.cross(positions, velocities), axis=0), MPI.SUM + ) + torque = config.mass * comm.allreduce( + np.sum(np.cross(positions, forces), axis=0), MPI.SUM + ) + h5md.total_energy[frame] = kinetic_energy + potential_energy + h5md.potential_energy[frame] = potential_energy + h5md.kinetc_energy[frame] = kinetic_energy + h5md.bond_energy[frame] = bond2_energy + h5md.angle_energy[frame] = bond3_energy + h5md.dihedral_energy[frame] = bond4_energy + h5md.field_energy[frame] = field_energy + h5md.total_momentum[frame, :] = total_momentum + h5md.angular_momentum[frame, :] = angular_momentum + h5md.torque[frame, :] = torque + h5md.temperature[frame] = temperature + h5md.pressure[frame] = pressure + for d in range(3): + h5md.box_value[frame, d, d] = box_size[d] + h5md.thermostat_work[frame] = config.thermostat_work + + fmt_ = [ + "step", + "time", + "temp", + "tot E", + "kin E", + "pot E", + "field E", + "elec E", + "bond E", + "ang E", + "dih E", + "bias E", + "Px", + "Py", + "Pz", + "ΔH" if config.target_temperature else "ΔE", + ] + fmt_ = np.array(fmt_) + + # create mask to show only energies != 0 + en_array = np.array([ + field_energy, + field_q_energy, + bond2_energy, + bond3_energy, + bond4_energy, + plumed_bias, + ]) + mask = np.full_like(fmt_, True, dtype=bool) + mask[range(6,12)] = en_array != 0. + + header_ = fmt_[mask].shape[0] * "{:>13}" + if config.initial_energy is None: + fmt_[-1] = "" + + divide_by = 1.0 + if dump_per_particle: + for i in range(3, 9): + fmt_[i] = fmt_[i][:-2] + "E/N" + fmt_[-1] += "/N" + divide_by = config.n_particles + total_energy = kinetic_energy + potential_energy + if config.initial_energy is not None: + if config.target_temperature: + H_tilde = total_energy - config.initial_energy - config.thermostat_work + else: + H_tilde = total_energy - config.initial_energy + else: + H_tilde = 0.0 + + header = header_.format(*fmt_[mask]) + data_fmt = f'{"{:13}"}{(fmt_[mask].shape[0]-1) * "{:13.5g}" }' + all_data = [ + step, + time_step * step, + temperature, + total_energy / divide_by, + kinetic_energy / divide_by, + potential_energy / divide_by, + field_energy / divide_by, + field_q_energy / divide_by, + bond2_energy / divide_by, + bond3_energy / divide_by, + bond4_energy / divide_by, + plumed_bias / divide_by, + total_momentum[0] / divide_by, + total_momentum[1] / divide_by, + total_momentum[2] / divide_by, + H_tilde / divide_by, + ] + data = data_fmt.format(*[val for i, val in enumerate(all_data) if mask[i]]) + Logger.rank0.log(logging.INFO, ("\n" + header + "\n" + data))
+ + +
[docs]def distribute_input( + in_file, rank, size, n_particles, max_molecule_size=201, comm=MPI.COMM_WORLD +): + """Assign global arrays onto MPI ranks, attempting load balancing + + Distributes approximately equal numbers of particles (workload) onto each + independent MPI rank, while respecting the requirement that any molecule + must be fully contained on a single MPI rank only (no splitting molecules + across multiple CPUs). + + Parameters + ---------- + in_file : h5py.File + HDF5 input file object. + rank : int + Local rank number for this MPI rank. + size : int + Global size of the MPI communicator (number of total CPUs). + n_particles : int + Total number of particles. + max_molecule_size : int, optional + Maximum size of any molecule present in the system. Used to initially + guess where the MPI rank boundaries (start/end indices) in the global + arrays should be placed. If molecules of size + :code:`>max_molecule_size` exist in the simulation system, HyMD + **might** work as expected. Or it might fail spectacularly. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + rank_range : + Starting and ending indices in the global arrays for each MPI rank. + """ + if n_particles is None: + n_particles = len(in_file["indices"]) + np_per_MPI = n_particles // size + + molecules_flag = False + if "molecules" in in_file: + molecules_flag = True + + if not molecules_flag: + if rank == size - 1: + np_cum_mpi = [rank * np_per_MPI, n_particles] + else: + np_cum_mpi = [rank * np_per_MPI, (rank + 1) * np_per_MPI] + p_mpi_range = list(range(np_cum_mpi[0], np_cum_mpi[1])) + return p_mpi_range, molecules_flag + + # To avoid splitting molecules across multiple different ranks, we need + # to read in some extra indices before/after the expected break points + # and iterate until we find a molecule break. + # + # Implicitly assuming no molecule is bigger than + # min(max_molecule_size, n_particles // n_MPI_ranks) atoms. + max_molecule_size += 2 + grab_extra = max_molecule_size if np_per_MPI > max_molecule_size else np_per_MPI + if rank == 0: + mpi_range_start = 0 + if size == 1: + mpi_range_end = n_particles + else: + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + elif rank == size - 1: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = n_particles + else: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + + molecules = in_file["molecules"][mpi_range_start:mpi_range_end] + indices = in_file["indices"][mpi_range_start:mpi_range_end] + molecule_end_indices = np.nonzero(np.diff(molecules))[0] + + p_mpi_range = [None, None] + if rank == 0: + p_mpi_range[0] = 0 + if size == 1: + p_mpi_range[1] = n_particles + else: + p_mpi_range[1] = indices[ + molecule_end_indices[molecule_end_indices >= np_per_MPI][0] + 1 + ] + elif rank == size - 1: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = n_particles + else: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = ( + indices[molecule_end_indices[molecule_end_indices > np_per_MPI][0]] + + 1 # noqa: E501 + ) + return list(range(p_mpi_range[0], p_mpi_range[1])), molecules_flag
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/_modules/hymd/force.html b/v2.0.2/_modules/hymd/force.html new file mode 100644 index 00000000..fd10550f --- /dev/null +++ b/v2.0.2/_modules/hymd/force.html @@ -0,0 +1,1167 @@ + + + + + + hymd.force — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.force

+"""Calculates intramolecular forces between bonded particles in molecules
+"""
+import numpy as np
+import networkx as nx
+from dataclasses import dataclass
+
+# Imported here so we can call from force import compute_bond_forces__fortran
+from force_kernels import cbf as compute_bond_forces__fortran  # noqa: F401
+from force_kernels import (  # noqa: F401
+    caf as compute_angle_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cdf as compute_dihedral_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cbf_d as compute_bond_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    caf_d as compute_angle_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    cdf_d as compute_dihedral_forces__fortran__double,
+)
+
+
+
[docs]@dataclass # might not be needed +class Dielectric_type: + atom_1: str + dielectric_value: float
+ + +
[docs]@dataclass +class Bond: + """Dataclass representing a single two-particle bond type + + A `bond type` is a bond strength and equilibrium distance associated with + any bond between particles of specific types :code:`A` and :code:`B` + (where :code:`A` and :code:`B` may be the same or different). Harmonic + two-particle bonds in HyMD take the form + + .. math:: + + V_2(\\mathbf{r}_1, \\mathbf{r}_2) = + \\frac{1}{2}k + \\left( + \\vert \\mathbf{r}_1 - \\mathbf{r}_2 \\vert - r_0 + \\right)^2, + + where :math:`k` is the bond strength (spring constant) and :math:`r_0` is + the equilibrium bond length (at which the energy is zero). + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + equilibrium : float + Equilibrium distance at which the energy associated with the bond + vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient (spring constant). + """ + + atom_1: str + atom_2: str + equilibrium: float + strength: float
+ + +
[docs]@dataclass +class Angle(Bond): + """Dataclass representing a single three-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any three-particle bond between particles of specific types :code:`A`, + :code:`B`, and :code:`C` (where :code:`A`, :code:`B`, and :code:`C` may be + different or the same). Harmonic angular three-particle bonds in HyMD take + the form + + .. math:: + + V_3(\\mathbf{r}_1, \\mathbf{r}_2, \\mathbf{r}_3) = + \\frac{1}{2}k + \\left( + \\cos^{-1} + \\left[ + \\frac{ + (\\mathbf{r}_1-\\mathbf{r}_2) + \\cdot + (\\mathbf{r}_3-\\mathbf{r}_2) + } + { + \\vert\\mathbf{r}_1-\\mathbf{r}_2\\vert + \\vert\\mathbf{r}_3-\\mathbf{r}_2\\vert + } + \\right] - \\theta_0 + \\right)^2 + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + equilibrium : float + Equilibrium angle at which the energy associated with the + three-particle angular bond vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient. + + See also + -------- + Bond : + Two-particle bond type dataclass + """ + + atom_3: str
+ + +
[docs]@dataclass +class Dihedral: + """Dataclass representing a single four-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any four-particle torsional bond between particles of specific types + :code:`A`, :code:`B`, :code:`C`, and :code:`D` (where :code:`A`, :code:`B`, + :code:`C`, and :code:`D` may be different or the same). Dihedral + four-particle bonds in HyMD take different forms depending on the + :code:`dih_type` parameter. + + In the following, let :math:`\\phi` denote the angle between the planes + spanned by the relative positions of atoms :code:`A`-:code:`B`-:code:`C` + and :code:`B`-:code:`C`-:code:`D`. If :code:`dih_type = 0`, then + + .. math:: + + V_4(\\phi) = \\sum_n c_n + \\left( + 1 + \\cos\\left[ + n\\phi - d_n + \\right] + \\right), + + where :math:`c_n` are energy coefficients and :math:`d_n` are propensity + phases. By default, the cosine sum is truncated at five terms. If + :code:`coeffs` provides only a single float, this is used as the coiling + propensity parameter :math:`\\lambda`. In this case, :math:`c_n` and + :math:`d_n` are automatically set to values which promote alpha helical + (:math:`\\lambda=-1`), beta sheet (:math:`\\lambda=1`), or a mixed + (:math:`1>\\lambda>-1`) structure (using values provided by Bore et al. + (2018)). In this case, the full potential takes the form + + .. math:: + + V_4(\\phi;\\lambda) = + \\frac{1}{2}(1-\\lambda) V_{\\text{prop},\\alpha}(\\phi) + + + \\frac{1}{2}(1+\\lambda) V_{\\text{prop},\\beta}(\\phi) + + + (1-\\vert\\lambda\\vert) V_{\\text{prop}, \\text{coil}}(\\phi), + + with each of the :math:`V_{\\mathrm{prop}, X}` being fixed cosine series + potentials with pre-set :math:`c_n` -s and :math:`d_n` -s. + + If :code:`dih_type = 1`, then a combined bending torsional (CBT) potential + is employed, + + .. math:: + + V_4(\\phi,\\gamma;\\lambda) = + V_4(\\phi;\\lambda) + + + \\frac{1}{2}K(\\phi)(\\gamma - \\gamma_0)^2, + + where :math:`V_4(\\phi;\\lambda)` specifies the potential as given by the + coiling propensity parameter above, :math:`K(\\phi)` is a separate cosine + series potential acting as the angular three-particle bond strength, and + :math:`\\gamma_0` is the three-particle bond equilibrium angle. In this + case, the :code:`coeffs` parameter must specify *both* a :math:`\\lambda` + value, in additon to the energy and phases dictating the :math:`K(\\phi)` + potential. + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + atom_4 : str + Type name of particle 4. + coeffs : list[list[float]] or list[float] or numpy.ndarray + Dihedral coefficients defining the series expansion of the dihedral + energy. + dih_type : int + Specifies the type of dihedral used; If :code:`0`, then :code:`coeffs` + must contain **either** two lists of five energy coefficients + :math:`c_n` and five propensity phases :math:`d_n` **or** a single + floating point number defining the :math:`\\lambda` coiling propensity + parameter. If :code:`1`, the combined bending-torsional potential is + used, and :code:`coeffs` must specify :math:`\\lambda` *and* two lists + containing energy coefficients and propensity phases for the + :math:`V_\\text{prop}` propensity potential, defined in terms of cosine + series. + + References + ---------- + Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018. + """ + + atom_1: str + atom_2: str + atom_3: str + atom_4: str + coeffs: np.ndarray + dih_type: int
+ + +
[docs]@dataclass +class Chi: + """Dataclass representing a single :math:`\\chi` mixing interaction type + + An `interaction mixing energy type` is a mixing energy associated with + density overlap between species of types :code:`A` and :code:`B` + (specified as inputs :code:`atom_1` and :code:`atom_2`). A positive mixing + energy promotes phase separation, a negative mixing energy promotes mixing. + The interaction energy density (provided the :code:`DefaultWithChi` + Hamiltonian is used) takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} + \\sum_{k,l}\\chi_{k,l} \\tilde\\phi_k\\tilde\\phi_l, + + where :math:`\\chi_{k,l}` denotes the mixing energy between species + :math:`k` and :math:`l`, with :math:`\\kappa` being the incompressibility. + The value of the interaction mixing energy parameter may be extracted from + `Flory-Huggins theory`_. + + .. _`Flory-Huggins theory`: + https://en.wikipedia.org/wiki/Flory%E2%80%93Huggins_solution_theory + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + interaction_energy : float + Interaction mixing energy. + + See also + -------- + hymd.hamiltonian.DefaultWithChi : + Interaction energy functional using :math:`\\chi`-interactions. + """ + + atom_1: str + atom_2: str + interaction_energy: float
+ + +
[docs]def find_all_paths(G, u, n): + """Helper function that recursively finds all paths of given lenght 'n + 1' inside a network 'G'. + Adapted from https://stackoverflow.com/a/28103735.""" + if n == 0: + return [[u]] + paths = [] + for neighbor in G.neighbors(u): + for path in find_all_paths(G, neighbor, n - 1): + if u not in path: + paths.append([u] + path) + return paths
+ + +
[docs]def propensity_potential_coeffs(x: float): + alpha_coeffs = np.array( + [ + [7.406, -5.298, -2.570, 1.336, 0.739], + [-0.28632126, 1.2099146, 1.18122138, 0.49075168, 0.98495911], + ] + ) + beta_coeffs = np.array( + [ + [3.770, 5.929, -4.151, -0.846, 0.190], + [-0.2300693, -0.0583289, 0.99342396, 1.03237971, 2.90160988], + ] + ) + coil_coeffs = np.array( + [ + [1.416, -0.739, 0.990, -0.397, 0.136], + [1.3495933, 0.45649087, 2.30441057, -0.12274901, -0.26179939], + ] + ) + + zero_add = np.zeros((2, 5)) + if np.isclose(x, -1): + return np.concatenate((alpha_coeffs, zero_add)) + elif np.isclose(x, 0): + return np.concatenate((coil_coeffs, zero_add)) + elif np.isclose(x, 1): + return np.concatenate((beta_coeffs, zero_add)) + + abs_x = np.abs(x) + if abs_x > 1: + err_str = ( + f"The provided value of lambda = {x} is out of lambda definition range, " + f"[-1.0, 1.0]." + ) + Logger.rank0.log(logging.ERROR, err_str) + else: + coil_coeffs[0] *= 1 - abs_x + if x < 0: + alpha_coeffs[0] *= 0.5 * (abs_x - x) + return np.concatenate((alpha_coeffs, coil_coeffs)) + else: + beta_coeffs[0] *= 0.5 * (abs_x + x) + return np.concatenate((beta_coeffs, coil_coeffs))
+ + +
[docs]def prepare_bonds_old(molecules, names, bonds, indices, config): + """Find bonded interactions from connectivity and bond types information + + .. deprecated:: 1.0.0 + :code:`prepare_bonds_old` was replaced by :code:`prepare_bonds` for + use with compiled Fortran kernels prior to 1.0.0 release. + + Prepares the necessary equilibrium and bond strength information needed by + the intramolecular interaction functions. This is performed locally on each + MPI rank, as the domain decomposition ensures that for all molecules *all* + consituent particles are always contained on *the same* MPI rankself. + + This function traverses the bond connectivity information provided in the + structure/topology input file and indentifies any two-, three-, or + four-particle potential bonds. For each connected chain of two, three, or + four particles, a matching to bond types is attempted. If the corresponding + names match, a bond object is initialized. + + In order to investigate the connectivity, a graph is created using + networkx functionality. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2 : list + List of lists containing *local* particle indices, equilibrium + distance, and bond strength coefficient for each reconstructed + two-particle bond. + bonds_3 : + List of lists containing *local* particle indices, equilibrium angle, + and bond strength coefficient for each reconstructed three-particle + bond. + bonds_4 : + List of lists containing *local* particle indices, dihedral type index, + and dihedral coefficients for each reconstructed four-particle + torsional bond. + bb_index : list + List indicating the dihedral type of each four-particle bond in + :code:`bonds_4`. + + See also + -------- + Bond : + Two-particle bond type dataclass. + Angle : + Three-particle angular bond type dataclass. + Dihedral : + Four-particle torsional bond type dataclass. + hymd.input_parser.Config + Configuration dataclass handler. + """ + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + bb_index = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + bb_dihedral = 0 + bond_graph = nx.Graph() + + for local_index, global_index in enumerate(indices): + if molecules[local_index] != mol: + continue + + bond_graph.add_node( + global_index, + name=names[local_index].decode("UTF-8"), + local_index=local_index, + ) + for bond in [b for b in bonds[local_index] if b != -1]: + bond_graph.add_edge(global_index, bond) + + connectivity = nx.all_pairs_shortest_path(bond_graph) + for c in connectivity: + i = c[0] + connected = c[1] + for j, path in connected.items(): + if len(path) == 2 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for b in config.bonds: + match_forward = name_i == b.atom_1 and name_j == b.atom_2 + match_backward = name_i == b.atom_2 and name_j == b.atom_1 + if match_forward or match_backward: + bonds_2.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[j]["local_index"], + b.equilibrium, + b.strength, + ] + ) + + if len(path) == 3 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_mid = bond_graph.nodes()[path[1]]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for a in config.angle_bonds: + match_forward = ( + name_i == a.atom_1 + and name_mid == a.atom_2 + and name_j == a.atom_3 + ) + match_backward = ( + name_i == a.atom_3 + and name_mid == a.atom_2 + and name_j == a.atom_1 + ) + if match_forward or match_backward: + bonds_3.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[path[1]]["local_index"], + bond_graph.nodes()[j]["local_index"], + np.radians(a.equilibrium), + a.strength, + ] + ) + + all_paths_len_four = find_all_paths(bond_graph, i, 3) + for p in all_paths_len_four: + name_i = bond_graph.nodes()[i]["name"] + name_mid_1 = bond_graph.nodes()[p[1]]["name"] + name_mid_2 = bond_graph.nodes()[p[2]]["name"] + name_j = bond_graph.nodes()[p[3]]["name"] + + for a in config.dihedrals: + match_forward = ( + name_i == a.atom_1 + and name_mid_1 == a.atom_2 + and name_mid_2 == a.atom_3 + and name_j == a.atom_4 + ) + if ( + match_forward + and [ + bond_graph.nodes()[p[3]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[i]["local_index"], + a.coeffs, + a.dih_type, + ] + not in bonds_4 + ): + bonds_4.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[3]]["local_index"], + a.coeffs, + a.dih_type, + ] + ) + if a.dih_type == 1: + bb_dihedral = len(bonds_4) + + if bb_dihedral: + bb_index.append(bb_dihedral - 1) + + return bonds_2, bonds_3, bonds_4, bb_index
+ + +
[docs]def prepare_index_based_bonds(molecules, topol): + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + resid = mol + 1 + top_summary = topol["system"]["molecules"] + resname = None + test_mol_number = 0 + for molname in top_summary: + test_mol_number += molname[1] + if resid <= test_mol_number: + resname = molname[0] + break + + if resname is None: + break + + if "bonds" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for bond in topol[resname]["bonds"]: + index_i = bond[0] - 1 + first_id + index_j = bond[1] - 1 + first_id + # bond[2] is the bond type, inherited by the itp format. Not used + equilibrium = bond[3] + strength = bond[4] + bonds_2.append([index_i, index_j, equilibrium, strength]) + + if "angles" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["angles"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + # angle[3] is the angle type, inherited by the itp format. Not used + equilibrium = np.radians(angle[4]) + strength = angle[5] + bonds_3.append([index_i, index_j, index_k, equilibrium, strength]) + + if "dihedrals" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["dihedrals"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + index_l = angle[3] - 1 + first_id + dih_type = angle[4] + coeff = angle[5] + if dih_type == 0 and isinstance(coeff[0], (float, int)): + coeff = propensity_potential_coeffs(coeff[0]) + elif dih_type == 1 and len(coeff) == 3: + coeff = np.array( + propensity_potential_coeffs(coeff[0][0]).tolist() + + coeff[1:] + ) + elif dih_type == 2: + coeff = np.array(coeff) + else: + coeff = np.insert(np.array(coeff), 2, np.zeros((2, 5)), axis=0) + bonds_4.append([index_i, index_j, index_k, index_l, coeff, dih_type, 0]) + return bonds_2, bonds_3, bonds_4
+ + +
[docs]def prepare_bonds(molecules, names, bonds, indices, config, topol=None): + """Rearrange the bond information for usage in compiled Fortran kernels + + Restructures the lists resulting from the execution of + :code:`prepare_bonds_old` into numpy arrays suitable for calls to optimized + Fortran code calculating bonded forces and energiesself. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2_atom_1 : (B,) numpy.ndarray + Local index of particle 1 for each of :code:`B` constructed + two-particle bonds. + bonds_2_atom_2 : (B,) numpy.ndarray + Local index of particle 2 for each of :code:`B` constructed + two-particle bonds. + bonds_2_equilibrium : (B,) numpy.ndarray + Equilibrium distance for each of :code:`B` constructed two-particle + bonds. + bonds_2_strength : (B,) numpy.ndarray + Bond strength for each of :code:`B` constructed two-particle + bonds. + bonds_3_atom_1 : (A,) numpy.ndarray + Local index of particle 1 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_2 : (A,) numpy.ndarray + Local index of particle 2 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_3 : (A,) numpy.ndarray + Local index of particle 3 for each of :code:`A` constructed + three-particle bonds. + bonds_3_equilibrium : (A,) numpy.ndarray + Equilibrium angle for each of :code:`A` constructed three-particle + bonds. + bonds_3_strength : (A,) numpy.ndarray + Bond strength for each of :code:`A` constructed three-particle + bonds. + bonds_4_atom_1 : (D,) numpy.ndarray + Local index of particle 1 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_2 : (D,) numpy.ndarray + Local index of particle 2 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_3 : (D,) numpy.ndarray + Local index of particle 3 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_4 : (D,) numpy.ndarray + Local index of particle 4 for each of :code:`D` constructed + four-particle bonds. + bonds_4_coeff : (D,) numpy.ndarray + Cosine series coefficients for each of :code:`D` constructed + four-particle bonds. + bonds_4_type : (D,) numpy.ndarray + Dihedral type for each of :code:`D` constructed four-particle + bonds. + bonds_4_last : (D,) numpy.ndarray + Flags indicating if :code:`dih_type` is :code:`1` for each of :code:`D` + constructed four-particle bonds. + + See also + -------- + prepare_bonds_old : + Used internally to reconstruct the bonded interactions types from the + connectivity information in the structure/topology input file and the + bonded types specified in the configuration file. + """ + if topol is not None: + bonds_2, bonds_3, bonds_4 = prepare_index_based_bonds( + molecules, topol + ) + else: + bonds_2, bonds_3, bonds_4, bb_index = prepare_bonds_old( + molecules, names, bonds, indices, config + ) + + # Bonds + bonds_2_atom1 = np.empty(len(bonds_2), dtype=int) + bonds_2_atom2 = np.empty(len(bonds_2), dtype=int) + bonds_2_equilibrium = np.empty(len(bonds_2), dtype=np.float64) + bonds_2_strength = np.empty(len(bonds_2), dtype=np.float64) + for i, b in enumerate(bonds_2): + bonds_2_atom1[i] = b[0] + bonds_2_atom2[i] = b[1] + bonds_2_equilibrium[i] = b[2] + bonds_2_strength[i] = b[3] + + # Angles + bonds_3_atom1 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom2 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom3 = np.empty(len(bonds_3), dtype=int) + bonds_3_equilibrium = np.empty(len(bonds_3), dtype=np.float64) + bonds_3_strength = np.empty(len(bonds_3), dtype=np.float64) + for i, b in enumerate(bonds_3): + bonds_3_atom1[i] = b[0] + bonds_3_atom2[i] = b[1] + bonds_3_atom3[i] = b[2] + bonds_3_equilibrium[i] = b[3] + bonds_3_strength[i] = b[4] + # Dihedrals + bonds_4_atom1 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom2 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom3 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom4 = np.empty(len(bonds_4), dtype=int) + number_of_coeff = 6 + len_of_coeff = 5 + bonds_4_coeff = np.empty( + (len(bonds_4), number_of_coeff, len_of_coeff), dtype=np.float64 + ) + bonds_4_type = np.empty(len(bonds_4), dtype=int) + bonds_4_last = np.zeros(len(bonds_4), dtype=int) + for i, b in enumerate(bonds_4): + bonds_4_atom1[i] = b[0] + bonds_4_atom2[i] = b[1] + bonds_4_atom3[i] = b[2] + bonds_4_atom4[i] = b[3] + bonds_4_coeff[i] = np.resize(b[4], (number_of_coeff, len_of_coeff)) + bonds_4_type[i] = b[5] + if topol is not None: + bonds_4_last[i] = b[6] + if topol is None: + bonds_4_last[bb_index] = 1 + + return ( + bonds_2_atom1, + bonds_2_atom2, + bonds_2_equilibrium, + bonds_2_strength, + bonds_3_atom1, + bonds_3_atom2, + bonds_3_atom3, + bonds_3_equilibrium, + bonds_3_strength, # noqa: E501 + bonds_4_atom1, + bonds_4_atom2, + bonds_4_atom3, + bonds_4_atom4, + bonds_4_coeff, + bonds_4_type, + bonds_4_last, # noqa: E501 + )
+ + +
[docs]def compute_bond_forces__plain(f_bonds, r, bonds_2, box_size): + """Computes forces resulting from bonded interactions + + .. deprecated:: 1.0.0 + :code:`compute_bond_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_bonds.fill(0.0) + energy = 0.0 + + for i, j, r0, k in bonds_2: + ri = r[i, :] + rj = r[j, :] + rij = rj - ri + + # Apply periodic boundary conditions to the distance rij + for dim in range(len(rij)): + rij[dim] -= box_size[dim] * np.around(rij[dim] / box_size[dim]) + dr = np.linalg.norm(rij) + df = -k * (dr - r0) + f_bond_vector = df * rij / dr + f_bonds[i, :] -= f_bond_vector + f_bonds[j, :] += f_bond_vector + + energy += 0.5 * k * (dr - r0) ** 2 + return energy
+ + +
[docs]def compute_angle_forces__plain(f_angles, r, bonds_3, box_size): + """Computes forces resulting from angular interactions + + .. deprecated:: 1.0.0 + :code:`compute_angle_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_angles.fill(0.0) + energy = 0.0 + + for a, b, c, theta0, k in bonds_3: + ra = r[a, :] - r[b, :] + rc = r[c, :] - r[b, :] + + for dim in range(len(ra)): + ra[dim] -= box_size[dim] * np.around(ra[dim] / box_size[dim]) + rc[dim] -= box_size[dim] * np.around(rc[dim] / box_size[dim]) + + xra = 1.0 / np.sqrt(np.dot(ra, ra)) + xrc = 1.0 / np.sqrt(np.dot(rc, rc)) + ea = ra * xra + ec = rc * xrc + + cosphi = np.dot(ea, ec) + theta = np.arccos(cosphi) + xsinph = 1.0 / np.sqrt(1.0 - cosphi**2) + + d = theta - theta0 + f = -k * d + + xrasin = xra * xsinph * f + xrcsin = xrc * xsinph * f + + fa = (ea * cosphi - ec) * xrasin + fc = (ec * cosphi - ea) * xrcsin + + f_angles[a, :] += fa + f_angles[c, :] += fc + f_angles[b, :] -= fa + fc + # f_angles[b, :] += -(fa + fc) + + energy -= 0.5 * f * d + + return energy
+ + +
[docs]def compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size): + """Computes forces resulting from dihedral interactions + + .. deprecated:: 1.0.0 + :code:`compute_dihedral_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_dihedrals.fill(0.0) + energy = 0.0 + + for a, b, c, d, coeffs, phase in bonds_4: + f = r[a, :] - r[b, :] + g = r[b, :] - r[c, :] + h = r[d, :] - r[c, :] + + for dim in range(3): + f -= box_size[dim] * np.around(f[dim] / box_size[dim]) + g -= box_size[dim] * np.around(g[dim] / box_size[dim]) + h -= box_size[dim] * np.around(h[dim] / box_size[dim]) + + v = np.cross(f, g) + w = np.cross(h, g) + vv = np.dot(v, v) + ww = np.dot(w, w) + gn = np.linalg.norm(g) + + cosphi = np.dot(v, w) + sinphi = np.dot(np.cross(v, w), g) / gn + phi = np.arctan2(sinphi, cosphi) + + fg = np.dot(f, g) + hg = np.dot(h, g) + sc = v * fg / (vv * gn) - w * hg / (ww * gn) + + df = 0 + + for m in range(len(coeffs[0])): + energy += coeffs[0][m] * (1 + np.cos(m * phi - coeffs[1][m])) + df += m * coeffs[0][m] * np.sin(m * phi - coeffs[1][m]) + + force_on_a = df * gn * v / vv + force_on_d = df * gn * w / ww + + f_dihedrals[a, :] -= force_on_a + f_dihedrals[b, :] += df * sc + force_on_a + f_dihedrals[c, :] -= df * sc + force_on_d + f_dihedrals[d, :] += force_on_d + return energy
+ + +
[docs]def dipole_forces_redistribution( + f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb +): + """Redistribute electrostatic forces calculated from topologically + reconstructed ghost dipole point charges to the backcone atoms of the protein. + """ + f_on_bead.fill(0.0) + for i, j, k, l, fd, matrix, dih_type, is_last in zip( + a, b, c, d, f_dipoles, trans_matrices, type_array, last_bb + ): + if dih_type == 1: + sum_force = fd[0] + fd[1] + diff_force = fd[0] - fd[1] + f_on_bead[i] += matrix[0] @ diff_force # Atom A + f_on_bead[j] += matrix[1] @ diff_force + 0.5 * sum_force # Atom B + f_on_bead[k] += matrix[2] @ diff_force + 0.5 * sum_force # Atom C + + if is_last == 1: + sum_force = fd[2] + fd[3] + diff_force = fd[2] - fd[3] + f_on_bead[j] += matrix[3] @ diff_force + f_on_bead[k] += matrix[4] @ diff_force + 0.5 * sum_force + f_on_bead[l] += matrix[5] @ diff_force + 0.5 * sum_force
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/_modules/hymd/hamiltonian.html b/v2.0.2/_modules/hymd/hamiltonian.html new file mode 100644 index 00000000..8bc1f78c --- /dev/null +++ b/v2.0.2/_modules/hymd/hamiltonian.html @@ -0,0 +1,802 @@ + + + + + + hymd.hamiltonian — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.hamiltonian

+"""Interaction energy functionals.
+
+Implements field--particle interaction energy functionals depending on the
+field configuration. Extending HyMD with a new Hamiltonian is done by
+subclassing the :code:`Hamiltonian` superclass with logic intialized in the
+constructor.
+
+The grid-independent filtering function is defined in the :code:`Hamiltonian`
+superclass constructor. Hijack :code:`self.H` in a subclass to change the
+filter.
+"""
+import numpy as np
+import sympy
+
+
+
[docs]class Hamiltonian: + """Interaction energy functional superclass""" + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + self.config = config + self._setup()
+ +
[docs] def _setup(self): + """Superclass setup + + Sets up the grid-independent filtering function :code:`H`, and the + SymPy logic for symbolically differentiating interaction energy + functionals in Hamiltonian subclasses. + """ + if not hasattr(self.config, "simulation_volume"): + self.config.simulation_volume = np.prod(np.asarray(self.config.box_size)) + if not self.config.barostat: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.config.a = self.config.rho0 + if not self.config.rho0: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.phi = sympy.var("phi:%d" % (self.config.n_types)) + k = sympy.var("k:%d" % (3)) + + # electrostatics variables + self.psi = sympy.var("psi") + self.phi_q = sympy.var("phi_q") + if not self.config.self_energy: + self.config.self_energy = 0.0 + + def fourier_space_window_function(k): + return sympy.functions.elementary.exponential.exp( + -0.5 + * self.config.sigma**2 + * (k0**2 + k1**2 + k2**2) # noqa: F821, E501 + ) + + self.window_function_lambda = sympy.lambdify( + [k], fourier_space_window_function(k) + ) + + def H(k, v): + return v * self.window_function_lambda(k) + + self.H = H
+ + +
[docs]class SquaredPhi(Hamiltonian): + """Simple squared density interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + \\sum_k \\tilde\\phi_k + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`rho_0` is the + average density of the fully homogenous system. Expressing the species + densities in terms of fluctuations from the average, + + .. math:: + + \\mathrm{d}\\tilde\\phi_k = \\rho_0 - \\tilde\\phi_k, + + it is evident that this interaction energy functional is a slight change of + the :code:`DefaultNoChi` Hamiltonian, as the expanded interaction energy + density becomes + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + 6\\rho_0\\left[ + \\sum_k \\mathrm{d}\\tilde\\phi_k + \\right] + + + 9\\rho_0^2 + + + \\sum_k \\mathrm{d}\\tilde\\phi_k^2 + + + \\prod_{k\\not=l} + \\mathrm{d}\\tilde\\phi_k \\mathrm{d}\\tilde\\phi_l + \\right), + + identical to :code:`DefaultNoChi` apart from a constant energy shift + :math:`9\\rho_0^2`(which does not impact dynamics) and the + :math:`\\rho_0`--:math:`\\mathrm{d}\\tilde\\phi_k` cross-terms. These + cross-terms constitute contributions to the energy linear in + :math:`\\mathrm{d}\\tilde\\phi_k` absent in :code:`DefaultNoChi`, which has + only quadratic terms present. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(SquaredPhi, self).__init__(config) + super(SquaredPhi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0): + return 0.5 / (kappa * rho0) * (sum(phi)) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + ): + V_incompressibility = 1 / (kappa * rho0) * sum(phi) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultNoChi(Hamiltonian): + """Incompressibility-only interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. The :code:`SquaredPhi` Hamiltonian implements a similar + functional with an additional linear term component depending on + + .. math:: + + \\mathmr{d}\\tilde\\phi_k = \\tilde\\phi_k - \\rho_0 + + and not :math:`\\mathrm{d}\\tilde\\phi_k^2`. No explicit inter-species + interaction is present apart from the indirect interaction through the + incompressibility. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + hymd.input_parser.Config : + Configuration dataclass handler. + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultNoChi, self).__init__(config) + super(DefaultNoChi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0, a=self.config.a): + return 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultWithChi(Hamiltonian): + """Incompressibility and :math:`\\chi`-interactions energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = + \\frac{1}{2\\rho_0} + \\sum_{k,l}\\chi_{kl} \\tilde\\phi_k \\tilde\\phi_l + + + \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. :math:`\\chi_{ij}` is the Flory-Huggins-like + inter-species mixing energy. + """ + +
[docs] def __init__(self, config, unique_names, type_to_name_map): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultWithChi, self).__init__(config) + super(DefaultWithChi, self)._setup() + self.setup(unique_names, type_to_name_map)
+ +
[docs] def setup(self, unique_names, type_to_name_map): + """Setup the interaction energy potential and the external potential + + Parameters + ---------- + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + """ + self.type_to_name_map = type_to_name_map + self.chi_type_dictionary = { + tuple(sorted([c.atom_1, c.atom_2])): c.interaction_energy + for c in self.config.chi + } + self.phi_laplacian = [ + sympy.var("phi_laplacian%d(0:%d)" % (t, 3)) + for t in range(self.config.n_types) + ] + + def w( + phi, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + interaction = 0.0 + for i in range(self.config.n_types): + for j in range(i + 1, self.config.n_types): + ni = type_to_name_map[i] + nj = type_to_name_map[j] + names = sorted([ni, nj]) + c = chi_type_dictionary[tuple(names)] + + interaction += c * phi[i] * phi[j] / rho0 + incompressibility = 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + return incompressibility + interaction + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + t, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + + V_interaction = 0.0 + nk = type_to_name_map[t] + for i in range(self.config.n_types): + ni = type_to_name_map[i] + names = sorted([nk, ni]) + if ni != nk: + c = chi_type_dictionary[tuple(names)] + else: + c = 0.0 + # uncomment to count diagonal chi terms: + # c = chi_type_dictionary[tuple(names)] + V_interaction += c * phi[i] / rho0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[t])) + for t in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +def get_hamiltonian(config): + """Return appropriate Hamiltonian object based on the + config.hamiltonian string. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ---------- + hamiltonian : Hamiltonian + Hamiltonian object. + """ + if config.hamiltonian.lower() == "defaultnochi": + hamiltonian = DefaultNoChi(config) + elif config.hamiltonian.lower() == "defaultwithchi": + hamiltonian = DefaultWithChi( + config, config.unique_names, config.type_to_name_map + ) + elif config.hamiltonian.lower() == "squaredphi": + hamiltonian = SquaredPhi(config) + + return hamiltonian +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/_modules/hymd/input_parser.html b/v2.0.2/_modules/hymd/input_parser.html new file mode 100644 index 00000000..0d5cf724 --- /dev/null +++ b/v2.0.2/_modules/hymd/input_parser.html @@ -0,0 +1,1640 @@ + + + + + + hymd.input_parser — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.input_parser

+"""Parses and handles the configuration information provided for the simulation
+"""
+import copy
+import tomli
+import datetime
+import logging
+import warnings
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass, field
+from typing import List, Union, ClassVar
+from .force import Bond, Angle, Dihedral, Chi, Dielectric_type, propensity_potential_coeffs
+from .barostat import Target_pressure
+from .logger import Logger
+
+
+
[docs]@dataclass +class Config: + """Configuration object + + Handles and verifies the simulation configuration specified in the + configuration file. + + Attributes + ---------- + gas_constant : float + Constant value of the gas constant, R (equivalently the Boltzmann + constant) in the units used internally in HyMD. + coulomb_constant : float + Constant value of the Coulomb constant which converts electric field + values to forces and electric potential values to energies in the units + used internally in HyMD. + n_steps: int + Number of time steps in the simulation. + time_step: float + *Outer* time step used in the simulation. If the rRESPA intergrator is + used, the *inner* time step (the time step used in the integration of + intramolecular bending, stretching, and torsional forces) is + :code:`time_step / respa_inner`. + box_size : list[float] or (D,) numpy.ndarray + Simulation box size of simulation in :code:`D` dimensions in units of + nanometers. + mesh_size : list[int] or int or numpy.ndarray + Number of grid points used for the discrete density grid. + sigma : float + Filter width representing the effective coarse-graining level of the + particles in the simulation. + kappa : float + Compressibility parameter used in the relaxed incompressibility term in + the interaction energy functional. + n_print : int, optional + Frequency of trajectory/energy output to the H5MD trajectory/energy + output file (in units of number of time steps). + tau : float, optional + The time scale of the CSVR thermostat coupling. + start_temperature : float, optional + Generate starting temperature by assigning all particle velocities + randomly according to the Maxwell-Boltzmann distribution at + :code:`start_temperature` Kelvin prior to starting the simulation. + target_temperature : float, optional + Couple the system to a heat bath at :code:`target_temperature` Kelvin. + mass : float, optional + Mass of the particles in the simulation. + hamiltonian : str, optional + Specifies the interaction energy functional :math:`W[\\tilde\\phi]` + for use with the particle-field interactions. Options: + :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`. + domain_decomposition : int, optional + Specifies the interval (in time steps) of domain decomposition + exchange, involving all MPI ranks sending and receiving particles + according to the particles’ positions in the integration box and the + MPI ranks’ assigned domain. + integrator : str, optional + Specifies the time integrator used in the simulation. Options: + :code:`velocity-verlet` or :code:`respa`. + respa_inner : int, optional + The number of inner time steps in the rRESPA integrator. This denotes + the number of intramolecular force calculations (stretching, bending, + torsional) are performed between each impulse applied from the field + forces. + file_name : str, optional + File path of the parsed configuration file. + name : str, optional + Name for the simulation. + tags : list[str], optional + Tags for the simulation. + bonds : list[Bond], optional + Specifies harmonic stretching potentials between particles in the + same molecule. + angle_bonds : list[Angle], optional + Specifies harmonic angular bending potentials between particles in the + same molecule. + dihedrals : list[Dihedral], optional + Specifies four-particle torsional potentials by cosine series. + chi : list[Chi], optional + Specifies :math:`\\chi`-interaction parameters between particle + species. + n_particles : int, optional + Specifies the total number of particles in the input. Optional keyword + for validation, ensuring the input HDF5 topology has the correct number + of particles and molecules. + max_molecule_size : int, optional + Maximum size of any single molecule in the system. Used to speed up + distribution of particles onto MPI ranks in a parallel fashion. + n_flush : int, optional + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be + written to disk (in units of number of :code:`n_print`). + thermostat_work : float + Work performed by the thermostat on the system. + thermostat_coupling_groups : list[str], optional + Specifies individual groups coupling independently to the CSVR + thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and + :code:`"C"` type particles, + :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would + thermalise types :code:`"A"` and :code:`"B"` together and couple + :code:`"C"` type particles to a different thermostat (all individual + thermostats are at the same temperature, i.e. target_temperature + Kelvin). + initial_energy : float + Value of the total energy prior to the start of the simulation. + cancel_com_momentum : int, optional + If :code:`True`, the total linear momentum of the center of mass is + removed before starting the simulation. If an integer is specifed, the + total linear momentum of the center of mass is removed every + :code:`remove_com_momentum` time steps. If :code:`False`, the linear + momentum is never removed. + coulombtype : str, optional + Specifies the type of electrostatic Coulomb interactions in the system. + The strength of the electrostatic forces is modulated by the relative + dielectric constant of the simulation medium, specified with the + :code:`dielectric_const` keyword. Charges for individual particles are + specified in the structure/topology HDF5 input file, not in the + configuration file. If no charges (or peptide backbone dipoles) are + present, the electrostatic forces will not be calculated even if this + keyword is set to :code:`"PIC_Spectral"`. + dielectric_const : float, optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. When + using helical propensity dihedrals, this keyword must be specified—even + if electrostatics are not included with the :code:`coulombtype` + keyword. + dielectric_type: list[float], optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. The list assigns + relative dielectric values to each bead type, and an anisotropic + dielectric function is obtained from a weighted average. + + + See also + -------- + hymd.input_parser.Bond : + Two-particle bond type dataclass. + hymd.input_parser.Angle : + Three-particle bond type dataclass. + hymd.input_parser.Dihedral : + Four-particle bond type dataclass. + """ + + gas_constant: ClassVar[float] = 0.0083144621 # kJ mol-1 K-1 + coulomb_constant: ClassVar[float] = 138.935458 # kJ nm mol-1 e-2 + + n_steps: int + time_step: float + mesh_size: Union[Union[List[int], np.ndarray], int] + sigma: float + kappa: float + + dtype: np.dtype = None + box_size: Union[List[float], np.ndarray] = None + n_print: int = None + tau: float = None + start_temperature: Union[float, bool] = None + target_temperature: Union[float, bool] = None + mass: float = None + hamiltonian: str = None + domain_decomposition: Union[int, bool] = None + integrator: str = None + respa_inner: int = 1 + file_name: str = "<config file path unknown>" + name: str = None + tags: List[str] = field(default_factory=list) + bonds: List[Bond] = field(default_factory=list) + angle_bonds: List[Angle] = field(default_factory=list) + dihedrals: List[Dihedral] = field(default_factory=list) + chi: List[Chi] = field(default_factory=list) + n_particles: int = None + max_molecule_size: int = None + n_flush: int = None + thermostat_work: float = 0.0 + thermostat_coupling_groups: List[List[str]] = field(default_factory=list) + initial_energy: float = None + cancel_com_momentum: Union[int, bool] = False + coulombtype: str = None + convergence_type: str = None + pol_mixing: float = None + dielectric_const: float = None + conv_crit: float = None + dielectric_type: List[Dielectric_type] = field(default_factory=list) + self_energy: float = None + type_charges: Union[List[float], np.ndarray] = None + + # For NPT runs + rho0: float = None + a: float = None + pressure: bool = False + barostat: str = None + barostat_type: str = None + tau_p: float = None + target_pressure: List[Target_pressure] = field(default_factory=list) + n_b: int = None + m: List[float] = field(default_factory=list) + + def __str__(self): + target_pressure_str = "\ttarget_pressure:\n" + "".join( + "\t\tP_L: " + + f"{self.target_pressure.P_L}\n" + + "\t\tP_N: " + + f"{self.target_pressure.P_N}\n" + ) + bonds_str = "\tbonds:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " f"{k.equilibrium}, {k.strength}\n") + for k in self.bonds + ] + ) + angle_str = "\tangle_bonds:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3}: " + + f"{k.equilibrium}, {k.strength}\n" + ) + for k in self.angle_bonds + ] + ) + dihedrals_str = "\tdihedrals:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: " + # This might need to be fixed/made prettier, probably + # there's an easier way + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ).join( + map( + str, + [ + [round(num, 3) for num in c_in] + if isinstance(c_in, list) + else c_in + for c_in in k.coeffs + ], + ) + ) + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ) + + f"dih_type = {k.dih_type}\n" + ) + for k in self.dihedrals + ] + ) + chi_str = "\tchi:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " + f"{k.interaction_energy}\n") + for k in self.chi + ] + ) + + """ If dielectric wanted as dictionary + dielectric_type_str = "\tdielectric_type:\n" + "".join( + [ + (f"\t\t{k.atom_1}: " + f"{k.dielectric_value}\n") + for k in self.dielectric_type + ] + ) + + """ + + thermostat_coupling_groups_str = "" + if any(self.thermostat_coupling_groups): + thermostat_coupling_groups_str = ( + "\tthermostat_coupling_groups:\n" + + "".join( + [ + "\t\t" + ", ".join([f"{n}" for n in ng]) + "\n" + for ng in self.thermostat_coupling_groups + ] + ) + ) + + ret_str = f'\n\n\tConfig: {self.file_name}\n\t{50 * "-"}\n' + for k, v in self.__dict__.items(): + if k not in ( + "target_pressure", + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "thermostat_coupling_groups", + ): + ret_str += f"\t{k}: {v}\n" + ret_str += ( + target_pressure_str + + bonds_str + + angle_str + + dihedrals_str + + chi_str + + thermostat_coupling_groups_str + ) + return ret_str
+ + +
[docs]def read_config_toml(file_path): + with open(file_path, "r") as in_file: + file_content = in_file.read() + return file_content
+ +
[docs]def parse_config_toml(toml_content, file_path=None, comm=MPI.COMM_WORLD): + config_dict = {} + + # read toml to a dictionary + toml_content = tomli.loads(toml_content) + + # Defaults = None + for n in ( + "box_size", + "n_print", + "tau", + "start_temperature", + "target_temperature", + "mass", + "hamiltonian", + "domain_decomposition", + "integrator", + "name", + "n_particles", + "max_molecule_size", + "coulombtype", + "convergence_type", + "dielectric_const", + "pol_mixing", + "conv_crit", + "dielectric_type", + "n_b", + "box_size", + "n_flush", + "self_energy", + "dtype", + ): + config_dict[n] = None + + # Defaults = [] + + for n in ( + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "tags", + "m", + "dielectric_type", + "target_pressure", + "type_charges", + ): + config_dict[n] = [] + + # Defaults: bool + config_dict["pressure"] = False + + # Flatten the .toml dictionary, ignoring the top level [tag] directives (if + # any). + for k, v in toml_content.items(): + if isinstance(v, dict): + if k == "nn": # Don't parse diff-hymd optimization options + continue + for nested_k, nested_v in v.items(): + config_dict[nested_k] = nested_v + else: + config_dict[k] = v + for k, v in config_dict.items(): + if k == "bonds": + config_dict["bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["bonds"][i] = Bond( + atom_1=b[0], + atom_2=b[1], + equilibrium=b[2], + strength=b[3], + ) + if k == "angle_bonds": + config_dict["angle_bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["angle_bonds"][i] = Angle( + atom_1=b[0], + atom_2=b[1], + atom_3=b[2], + equilibrium=b[3], + strength=b[4], + ) + if k == "dihedrals": + config_dict["dihedrals"] = [None] * len(v) + for i, b in enumerate(v): + try: + dih_type = int(b[2][0]) + except IndexError: + Logger.rank0.log( + logging.WARNING, "Dihedral type not provided, defaulting to 0." + ) + dih_type = 0 + + # Probably it's better to move this in check_dihedrals? + wrong_len = len(b[1]) not in (1, 2) + wrong_type_1 = len(b[1]) == 1 and not isinstance(b[1][0], float) + wrong_type_2 = len(b[1]) == 2 and not isinstance(b[1][0], list) + if wrong_len or wrong_type_1 or wrong_type_2: + err_str = ( + "The coefficients specified for the dihedral type " + "(0) do not match the correct structure. Either " + "use [lambda] or [[cn_prop], [dn_prop]], or select" + " the correct dihedral type." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise RuntimeError(err_str) + + # FIXME: this is messy af, I don't like it + if dih_type == 0 and isinstance(b[1][0], (float, int)): + coeff = propensity_potential_coeffs(b[1][0]) + elif dih_type == 1 and len(b[1]) == 3: + coeff = np.array( + propensity_potential_coeffs(b[1][0][0]).tolist() + + b[1][1:] + ) + elif dih_type == 2: + coeff = np.array(b[1]) + else: + coeff = np.insert(np.array(b[1]), 2, np.zeros((2, 5)), axis=0) + + config_dict["dihedrals"][i] = Dihedral( + atom_1=b[0][0], + atom_2=b[0][1], + atom_3=b[0][2], + atom_4=b[0][3], + coeffs=coeff, + dih_type=dih_type, + ) + if k == "chi": + config_dict["chi"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0], c[1]]) + config_dict["chi"][i] = Chi( + atom_1=c_[0], atom_2=c_[1], interaction_energy=c[2] + ) + + """ + if k == "dielectric_type": + config_dict["dielectric_type"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0][0]]) + config_dict["dielectric_type"][i] = Dielectric_type( + atom_1=c_[0], dielectric_value=c[1][0] + ) + """ + if k == "target_pressure": + if len(v) == 2: + config_dict["target_pressure"] = Target_pressure( + P_L=v[0], + P_N=v[1], # check condition # V array (still read as array?) + ) + elif len(v) == 1: + config_dict["target_pressure"] = Target_pressure(P_L=v[0], P_N=None) + else: + config_dict["target_pressure"] = Target_pressure(P_L=None, P_N=None) + + if file_path is not None: + config_dict["file_name"] = file_path + + for n in ( + "n_steps", "time_step", "mesh_size", "sigma", "kappa" + ): + if n not in config_dict: + err_str = ( + f"No {n} specified in config file {file_path}. Unable to start" + f" simulation." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return Config(**config_dict)
+ + +
[docs]def check_n_particles(config, indices, comm=MPI.COMM_WORLD): + n_particles = comm.allreduce(len(indices), MPI.SUM) + if config.n_particles is None: + config = copy.deepcopy(config) + config.n_particles = n_particles + info_str = ( + f"No n_particles found in toml file {config.file_name}, defaulting" + f" to indices.shape ({n_particles})" + ) + Logger.rank0.log(logging.INFO, info_str) + return config + + if n_particles != config.n_particles: + warn_str = ( + f"n_particles in {config.file_name} ({config.n_particles}) does " + "not match the shape of the indices array in the .HDF5 file " + f"({n_particles}). Defaulting to using indices.shape " + f"({n_particles})" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.n_particles = n_particles + return config
+ + +
[docs]def check_max_molecule_size(config, comm=MPI.COMM_WORLD): + if config.max_molecule_size is None: + info_str = ( + f"No max_molecule_size found in toml file {config.file_name}, " + f"defaulting to 201" + ) + Logger.rank0.log(logging.INFO, info_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + + if config.max_molecule_size < 1: + warn_str = ( + f"max_molecule_size in {config.file_name} must be a positive " + f"integer, not {config.max_molecule_size}, defaulting to 201" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + return config
+ + +def _find_unique_names(config, names, comm=MPI.COMM_WORLD): + unique_names = np.unique(names) + receive_buffer = comm.gather(unique_names, root=0) + + gathered_unique_names = None + if comm.Get_rank() == 0: + gathered_unique_names = np.unique(np.concatenate(receive_buffer)) + unique_names = comm.bcast(gathered_unique_names, root=0) + unique_names = sorted([n.decode("UTF-8") for n in unique_names]) + config.unique_names = unique_names + config.n_types = len(unique_names) + return config + + +def _setup_type_to_name_map(config, names, types, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + name_to_type_ = {} + for n, t in zip(names, types): + n = n.decode("utf-8") + if n not in name_to_type_: + name_to_type_[n] = t + receive_buffer = comm.gather(name_to_type_, root=0) + gathered_dict = None + if comm.Get_rank() == 0: + gathered_dict = {} + for d in receive_buffer: + for k, v in d.items(): + if k not in gathered_dict: + gathered_dict[k] = v + else: + assert v == gathered_dict[k] + name_to_type_map = comm.bcast(gathered_dict, root=0) + config.name_to_type_map = name_to_type_map + config.type_to_name_map = {v: k for k, v in name_to_type_map.items()} + return config + + +
[docs]def check_bonds(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for b in config.bonds: + if b.atom_1 not in unique_names or b.atom_2 not in unique_names: + missing_str = "" + if b.atom_1 not in unique_names: + if b.atom_2 not in unique_names: + if b.atom_1 == b.atom_2: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"neither {b.atom_1}, {b.atom_2} atoms" + else: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"no {b.atom_2} atoms" + + warn_str = ( + f"Bond type {b.atom_1}--{b.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_angles(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for a in config.angle_bonds: + if ( + a.atom_1 not in unique_names + or a.atom_2 not in unique_names + or a.atom_3 not in unique_names + ): + missing = [ + a.atom_1 not in unique_names, + a.atom_2 not in unique_names, + a.atom_3 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([a.atom_1, a.atom_2, a.atom_3]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Angle bond type {a.atom_1}--{a.atom_2}--{a.atom_3} " + f"specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_dihedrals(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for d in config.dihedrals: + if ( + d.atom_1 not in unique_names + or d.atom_2 not in unique_names + or d.atom_3 not in unique_names + or d.atom_4 not in unique_names + ): + missing = [ + d.atom_1 not in unique_names, + d.atom_2 not in unique_names, + d.atom_3 not in unique_names, + d.atom_4 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([d.atom_1, d.atom_2, d.atom_3, d.atom_4]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Dihedral type {d.atom_1}--{d.atom_2}--{d.atom_3}--{d.atom_4}" + f" specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_chi(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for c in config.chi: + if c.atom_1 not in unique_names or c.atom_2 not in unique_names: + missing_str = "" + if c.atom_1 not in unique_names: + if c.atom_2 not in unique_names: + if c.atom_1 == c.atom_2: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"neither {c.atom_1}, {c.atom_2} atoms" + else: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"no {c.atom_2} atoms" + + warn_str = ( + f"Chi interaction {c.atom_1}--{c.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + for i, n in enumerate(unique_names): + for m in unique_names[i + 1 :]: + found = False + for c in config.chi: + if (c.atom_1 == n and c.atom_2 == m) or ( + c.atom_1 == m and c.atom_2 == n + ): + found = True + if not found: + config.chi.append(Chi(atom_1=n, atom_2=m, interaction_energy=0.0)) + warn_str = ( + f"Atom types {n} and {m} found in the " + f"system, but no chi interaction {n}--{m} " + f"specified in {config.file_name}. Defaulting to " + f"chi[{n}, {m}] = 0" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_box_size(config, input_box, comm=MPI.COMM_WORLD): + if config.box_size is not None: + config.box_size = np.array(config.box_size, dtype=np.float32) + if input_box.all() and not np.allclose(config.box_size, input_box, atol=0.009): + err_str = ( + f"Box size specified in {config.file_name}: " + f"{config.box_size} does not match input box:" + f"{input_box}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + else: + if input_box.all(): + config.box_size = input_box + else: + err_str = f"No box information found" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + for b in config.box_size: + if b <= 0.0: + err_str = ( + f"Invalid box size specified in {config.file_name}: " + f"{config.box_size}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return config
+ + +
[docs]def check_integrator(config, comm=MPI.COMM_WORLD): + if config.integrator.lower() not in ("velocity-verlet", "respa"): + err_str = ( + f"Invalid integrator specified in {config.file_name}: " + f'{config.integrator}. Available options "velocity-verlet" or ' + f'"respa".' + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + if config.integrator.lower() == "respa": + if isinstance(config.respa_inner, float): + warn_str = ( + f"Number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner} specified " + f"as float, using {int(config.respa_inner)}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = int(config.respa_inner) + elif not isinstance(config.respa_inner, int): + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + + if config.respa_inner <= 0: + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + if config.integrator.lower() == "velocity-verlet" and config.respa_inner != 1: + warn_str = ( + f"Integrator type Velocity-Verlet specified in {config.file_name} " + f"and inner rRESPA time steps set to {config.respa_inner}. " + f"Using respa_inner = 1" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = 1 + + return config
+ + +
[docs]def check_hamiltonian(config, comm=MPI.COMM_WORLD): + valid_hamiltonians = ["defaultnochi", "defaultwithchi", "squaredphi"] + + if config.hamiltonian is None: + if len(config.chi) == 0: + warn_str = ( + f"No hamiltonian form and no chi interactions specified in " + f"{config.file_name}, defaulting to DefaultNoChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultNoChi" + else: + warn_str = ( + f"No hamiltonian form specified in {config.file_name}, but " + f"chi interactions are specified, defaulting to " + f"DefaultWithChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultWithChi" + elif config.hamiltonian.lower() not in valid_hamiltonians: + err_str = ( + f"The specified Hamiltonian {config.hamiltonian} was not " + f"recognized as a valid Hamiltonian." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise NotImplementedError(err_str) + + return config
+ + +
[docs]def check_n_flush(config, comm=MPI.COMM_WORLD): + if config.n_print: + if config.n_flush is None: + config.n_flush = 10000 // config.n_print + return config
+ + +
[docs]def check_n_print(config, comm=MPI.COMM_WORLD): + if ( + not isinstance(config.n_print, int) + and not isinstance(config.n_print, float) + and config.n_print is not None + ): + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if config.n_print is None or config.n_print <= 0: + config.n_print = False + elif not isinstance(config.n_print, int): + if isinstance(config.n_print, float): + warn_str = ( + f"n_print is a float ({config.n_print}), not int, using " + f"{int(round(config.n_print))}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + config.n_print = int(round(config.n_print)) + else: + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + return config
+ + +
[docs]def check_tau(config, comm=MPI.COMM_WORLD): + if config.tau is None and config.target_temperature is not None: + warn_str = "target temp specified but no tau, defaulting 0.7" + config.tau = 0.7 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_start_and_target_temperature(config, comm=MPI.COMM_WORLD): + """Validate provided starting and target thermostat temperatures + + Assesses the provided temperature target and ensures it is a non-negative + floating point number or :code:`False`. Ensures the starting temperature is + a non-negative floating point number or :code:`False`. + + If the value for either is :code:`None`, the returned configuration object + has the values defaulted to :code:`False` in each case. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ------- + validated_config : Config + Configuration object with validated :code:`target_temperature` and + :code:`start_temperature`. + """ + for t in ("start_temperature", "target_temperature"): + if getattr(config, t) is not None: + try: + if getattr(config, t) < 0: + warn_str = ( + f"{t} set to negative value ({getattr(config, t)}), " + f"defaulting to False" + ) + setattr(config, t, False) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + except TypeError as e: + err_str = ( + f"Could not interpret {t} = {repr(getattr(config, t))} as " + f"a number." + ) + raise TypeError(err_str) from e + + if config.start_temperature is None: + config.start_temperature = False + if config.target_temperature is None: + config.target_temperature = False + return config
+ + +
[docs]def check_mass(config, comm=MPI.COMM_WORLD): + if config.mass is None: + info_str = "no mass specified, defaulting to 72.0" + config.mass = 72.0 + Logger.rank0.log(logging.INFO, info_str) + elif not isinstance(config.mass, int) and not isinstance(config.mass, float): + err_str = ( + f"specified mass is invalid type {config.mass}, " f"({type(config.mass)})" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + elif config.mass < 0: + err_str = f"invalid mass specified, {config.mass}" + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + else: + config.mass = float(config.mass) + + return config
+ + +
[docs]def check_domain_decomposition(config, comm=MPI.COMM_WORLD): + dd = config.domain_decomposition + if dd is None or dd is False: + config.domain_decomposition = False + return config + + if isinstance(dd, int): + if dd < 0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + elif isinstance(dd, float): + if dd < 0.0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + else: + warn_str = ( + f"domain_decomposition ({config.domain_decomposition}) is not " + f"an integer, using {int(round(dd))}" + ) + config.domain_decomposition = int(round(dd)) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + else: + err_str = ( + f"invalid value for domain_decomposition " + f"({config.domain_decomposition}) use an integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + return config
+ + +
[docs]def check_name(config, comm=MPI.COMM_WORLD): + if config.name is None: + root_current_time = "" + if comm.Get_rank() == 0: + root_current_time = datetime.datetime.now().strftime("%m/%d/%Y, %H:%M:%S") + current_time = comm.bcast(root_current_time, root=0) + + if config.name is None: + config.name = "sim" + current_time + else: + config.name = str(config.name) + return config
+ + +
[docs]def check_NPT_conditions(config, comm=MPI.COMM_WORLD): + """ + Check validity of barostat_type, barostat, + a, rho0, target_pressure, tau_p + """ + if config.barostat is None: + if ( + config.tau_p is not None + or (config.target_pressure.P_L and config.target_pressure.P_N) is not None + ): + err_str = ( + "barostat not specified but config.tau_p " + "or config.target_pressure specified, cannot start simulation {config.barostat}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.a: + warn_str = "a specified but no barostat," "setting a to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.rho0: + warn_str = ( + "rho0 specified but no barostat," "setting rho0 to average density" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + if config.barostat is not None: + if not config.barostat_type: + config.barostat_type = "berendsen" + warn_str = "barostat_type not specified," "setting to berendsen" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.barostat != "isotropic" and config.barostat != "semiisotropic": + err_str = "barostat option not recognised. Valid options: isotropic, semiisotropic" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.target_pressure.P_L is None: + config.target_pressure.P_L = 1.0 # bar + config.target_pressure.P_N = None + if config.barostat == "semiisotropic": + config.target_pressure.P_N = 1.0 # bar + warn_str = ( + "barostat specified but no target_pressure, defaulting to 1.0 bar" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.tau_p is None: + if config.tau <= 0.1: + config.tau_p = config.tau * 10.0 + else: + config.tau_p = 1.0 + warn_str = "barostat specified but no tau_p, defaulting to " + str( + config.tau_p + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if not config.a: + err_str = "a not specified; cannot start simulation {config.a}" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if not config.rho0: + warn_str = "rho0 not specified;" "setting rho0 to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + return config
+ + +
[docs]def check_thermostat_coupling_groups(config, comm=MPI.COMM_WORLD): + if any(config.thermostat_coupling_groups): + found = [0 for _ in config.unique_names] + unique_names = [n for n in config.unique_names] + for i, group in enumerate(config.thermostat_coupling_groups): + for species in group: + try: + ind = unique_names.index(species) + found[ind] += 1 + except ValueError as e: + err_str = ( + f"Particle species {species} specified in thermostat " + f"coupling group {i}, but no {species} particles were " + "found in the system." + ) + raise ValueError(err_str) from e + if any([True if f > 1 else False for f in found]): + for i, f in enumerate(found): + if f > 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} specified in multiple " + "thermostat coupling groups; " + f"{config.thermostat_coupling_groups}." + ) + raise ValueError(err_str) + if not all([True if f == 1 else False for f in found]): + for i, f in enumerate(found): + if f != 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} not specified in any " + f"thermostat coupling group, but {species} particles " + "were found in the system" + ) + raise ValueError(err_str) + return config
+ + +
[docs]def check_m(config, comm=MPI.COMM_WORLD): + if config.m == []: + config.m = [1.0 for t in range(config.n_types)] + return config
+ + +
[docs]def check_n_b(config, comm=MPI.COMM_WORLD): + if config.n_b is None: + warn_str = f"config.n_b not specified." "Defaulting to 1" + config.n_b = 1 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_cancel_com_momentum(config, comm=MPI.COMM_WORLD): + if isinstance(config.cancel_com_momentum, int): + if config.cancel_com_momentum == 0 or config.cancel_com_momentum < 0: + config.cancel_com_momentum = False + elif not isinstance(config.cancel_com_momentum, bool): + err_str = ( + f"Could not interpret {config.cancel_com_momentum} as an integer " + f"or boolean." + ) + raise ValueError(err_str) + return config
+ + +
[docs]def sort_dielectric_by_type_id(config, charges, types): + """ + Creates a list of length N CG-particles, sorted after the charges from + the input HDF5 file. Used in file_io.py + """ + dielectric_val = np.zeros(config.n_types) + for j in range(config.n_types): + name = config.dielectric_type[j][0][0] + type_id = config.name_to_type_map[name] + dielectric_val[type_id] = config.dielectric_type[j][1][0] + config.dielectric_type = dielectric_val.copy() + + N = len(charges) + len_list = np.zeros(config.n_types) + dielectric_by_types = np.zeros(N) + for i in range(N): + dielectric_by_types[i] = dielectric_val[types[i]] + # print("types ", types) + # print("diel val", dielectric_by_types) + # print("charges", charges) + # print(config.name_to_type_map) + return dielectric_by_types # by types with each particle id
+ + +
[docs]def check_charges_types_list(config, types, charges, comm=MPI.COMM_WORLD): + """ + Creates a list of charge values of length types. + Charges are sorted according to type ID. Used in field.py. + # TODO: this is messy, we should fix it + """ + if charges is None: + config.type_charges = [0.0] * config.n_types + return config + + check_val = -100.0 # some random value that will never be encountered + charges_list = np.full(config.n_types, check_val) # gatherv cant handle None + rank = comm.Get_rank() + # print(charges_list) + for t_ in range(config.n_types): + if t_ in types: + charges_list[t_] = charges[types == t_][0] + + nprocs = int(comm.Get_size()) + recv_charges = None + if rank == 0: + recv_charges = np.full( + config.n_types * nprocs, check_val + ) # gatherv cant handle None + comm.Gather(charges_list, recv_charges, root=0) + + ## make a charges list + if rank == 0: + config_charges = np.zeros(config.n_types) + test_config = np.full(config.n_types, check_val) + for j in range(nprocs): + for i in range(config.n_types): + if recv_charges[i + j * config.n_types] != check_val: + config_charges[i] = recv_charges[i + j * config.n_types] + if np.any([test_config, config_charges]): + continue + else: + break + + # print(config_charges) + # print(config.name_to_type_map) + # print(charges[types == 0][0],charges[types == 1][0],charges[types == 2][0],charges[types == 3][0], + # charges[types == 4][0]) + else: + config_charges = np.zeros(config.n_types) + + comm.Bcast(config_charges, root=0) + # print("config_charges", config_charges , "rank", rank) + # print(recv_charges) + # rank = comm.Get_rank() + # print(all_charges) + config.type_charges = config_charges + return config
+ + +
[docs]def check_dielectric(config, comm=MPI.COMM_WORLD): + """ + Error handling for electrostatics. + Unit testing of toml/tomli input. + """ + err_str_const = "Dielectric constant not given." + if config.coulombtype == "PIC_Spectral": + assert config.dielectric_const != None, err_str_const + + err_str = "Dielectric list is empty." + if config.coulombtype == "PIC_Spectral_GPE": + assert len(config.dielectric_type) != 0, err_str + # default values + if config.pol_mixing is None: + config.pol_mixing = 0.6 + if config.conv_crit is None: + config.conv_crit = 1e-6 + return config
+ + +
[docs]def check_charges(config, charges, comm=MPI.COMM_WORLD): + """Check if charges across ranks sum to zero. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of floats with charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + """ + total_charge = comm.allreduce(np.sum(charges), MPI.SUM) + + if not np.isclose(total_charge, 0.0): + warn_str = ( + f"Charges in the input file do not sum to zero. " + f"Total charge is {total_charge}." + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + # if charges are ok, compute self energy + if config.coulombtype == "PIC_Spectral": + from .field import compute_self_energy_q + + config.self_energy = compute_self_energy_q(config, charges, comm=comm) + + return config
+ + +
[docs]def check_config( + config, indices, names, types, charges, input_box, comm=MPI.COMM_WORLD +): + """Performs various checks on the specfied config to ensure consistency + + Parameters + ---------- + config : Config + Configuration object. + indices : (N,) numpy.ndarray + Array of integer indices for :code:`N` particles. + names : (N,) numpy.ndarray + Array of string names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of integer type indices for :code:`N` particles. + charges : (N,) numpy.ndarray + Array of floats charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + + Returns + ------- + config : Config + Validated configuration object. + """ + config = _find_unique_names(config, names, comm=comm) + if types is not None: + config = _setup_type_to_name_map(config, names, types, comm=comm) + config = check_box_size(config, input_box, comm=comm) + config = check_integrator(config, comm=comm) + config = check_max_molecule_size(config, comm=comm) + config = check_tau(config, comm=comm) + config = check_start_and_target_temperature(config, comm=comm) + config = check_mass(config, comm=comm) + config = check_domain_decomposition(config, comm=comm) + config = check_name(config, comm=comm) + config = check_n_particles(config, indices, comm=comm) + config = check_chi(config, names, comm=comm) + config = check_bonds(config, names, comm=comm) + config = check_angles(config, names, comm=comm) + config = check_dihedrals(config, names, comm=comm) + config = check_hamiltonian(config, comm=comm) + config = check_NPT_conditions(config, comm=comm) + config = check_n_b(config, comm=comm) + config = check_m(config, comm=comm) + config = check_thermostat_coupling_groups(config, comm=comm) + config = check_cancel_com_momentum(config, comm=comm) + config = check_dielectric(config, comm=comm) + config = check_n_print(config, comm=comm) + config = check_n_flush(config, comm=comm) + config = check_charges_types_list(config, types, charges, comm=comm) + if charges is not None: + config = check_charges(config, charges, comm=comm) + + return config
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/_modules/hymd/integrator.html b/v2.0.2/_modules/hymd/integrator.html new file mode 100644 index 00000000..9ad88490 --- /dev/null +++ b/v2.0.2/_modules/hymd/integrator.html @@ -0,0 +1,363 @@ + + + + + + hymd.integrator — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.integrator

+"""Integrates equations of motion.
+
+Implements the Velocity Verlet integrator. The *reversible reference system
+propagator algorithm* (rRESPA) integrator uses the Velocity Verlet functions
+inside the MD loop in the main module.
+"""
+
+
+
[docs]def integrate_velocity(velocities, accelerations, time_step): + """Velocity update step of the Velocity Verlet integration algorithm. + + Computes the velocity update step of the Velocity Verlet algorithm. The + :code:`velocities` argument is **not** changed in place. + + Parameters + ---------- + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + accelerations : (N, D) numpy.ndarray + Array of accelerations of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step + + .. math:: \\mathbf{v}_{\\text{new}} = \\mathbf{v} + \\frac{\\Delta t}{2m} + \\mathbf{f} + + before the positions are moved a full step using the updated half-step + velocities. + + See Also + -------- + integrate_position : The position update step of the Velocity Verlet + algorithm. + """ + return velocities + 0.5 * time_step * accelerations
+ + +
[docs]def integrate_position(positions, velocities, time_step): + """Position update step of the Velocity Verlet integration algorithm. + + Computes the position update step of the Velocity Verlet algorithm. The + :code:`positions` argument is **not** changed in place. + + Parameters + ---------- + positions : (N, D) numpy.ndarray + Array of positions of :code:`N` particles in :code:`D` dimensions. + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step, then the positions are updated a full step using the updated + velocities + + .. math:: \\mathbf{x}_{\\text{new}} = \\mathbf{x} + \\Delta t \\mathbf{v} + + See Also + -------- + integrate_velocity : The velocity update step of the Velocity Verlet + algorithm. + """ + return positions + time_step * velocities
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/_modules/hymd/logger.html b/v2.0.2/_modules/hymd/logger.html new file mode 100644 index 00000000..6519d73a --- /dev/null +++ b/v2.0.2/_modules/hymd/logger.html @@ -0,0 +1,552 @@ + + + + + + hymd.logger — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.logger

+"""Handles event logging for simulation information, warnings, and errors.
+"""
+import sys
+import os
+import logging
+from mpi4py import MPI
+from .version import __version__
+
+
+
[docs]class MPIFilterRoot(logging.Filter): + """Log output Filter wrapper class for the root MPI rank log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + if self.comm.Get_rank() == 0: + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True + else: + return False
+ + +
[docs]class MPIFilterAll(logging.Filter): + """Log output Filter wrapper class for the all-MPI-ranks log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True
+ + +class MPIFilterStdout(logging.Filter): + """Log output Filter wrapper class for filtering STDOUT log""" + + def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.funcName = "replica 0 " + record.funcName + if MPI.COMM_WORLD.Get_rank() == 0: + record.rank = MPI.COMM_WORLD.Get_rank() + record.size = MPI.COMM_WORLD.Get_size() + return True + else: + return False + + +
[docs]class Logger: + """Log output handler class + + Notes + ----- + This wraps the default python library :code:`logging`, see + `docs.python.org/3/library/logging.html`_. + + .. _`docs.python.org/3/library/logging.html`: + https://docs.python.org/3/library/logging.html + + Attributes + ---------- + level : int + Determines the verbosity level of the log, corresponding to + logging.level. Numerical values :code:`50` (:code:`logging.CRITICAL`), + :code:`40` (:code:`logging.ERROR`), :code:`30` + (:code:`logging.WARNING`), :code:`20` (:code:`logging.INFO`), + :code:`10` (:code:`logging.DEBUG`), and :code:`0` + (:code:`logging.UNSET`) are supported values. Any log event message + less severe than the specified level is ignored. All other event + messages are emitted. + log_file : str + Path to output log file. + format : str + Prepended dump string for each log event. Specifies the log event + level, the module emitting the event, the code line, the enclosing + function name, and the MPI rank writing the message. + date_format : str + Prepends the date before all log event messages. + formatter : logging.Formatter + Formatter handling the prepending of the information in `format` and + `date_format` to each log event message. Used by default for all + loggers. + rank0 : logging.Logger + Default logger object for the root MPI rank. + all_ranks : logging.Logger + Default logger object for messages being emitted from all MPI ranks + simultaneously. + """ + + level = None + log_file = None + format = " %(levelname)-8s [%(filename)s:%(lineno)d] <%(funcName)s> {rank %(rank)d/%(size)d} %(message)s" # noqa: E501 + date_format = "%(asctime)s" + formatter = logging.Formatter(fmt=date_format + format) + rank0 = logging.getLogger("HyMD.rank_0") + all_ranks = logging.getLogger("HyMD.all_ranks") + +
[docs] @classmethod + def setup(cls, default_level=logging.INFO, log_file=None, verbose=False, comm=MPI.COMM_WORLD): + """Sets up the logger object. + + If a :code:`log_file` path is provided, log event messages are output + to it. Otherwise, the logging messages are emitted to stdout. + + Parameters + ---------- + default_level : int, optional + Default verbosity level of the logger. Unless specified, it is + :code:`10` (:code:`logging.INFO`). + log_file : str, optional + Path to output log file. If `None` or not priovided, no log file is + used and all logging is done to stdout. + verbose : bool, optional + Increases the logging level to :code:`30` (:code:`logging.WARNING`) + if True, otherwise leaves the logging level unchanged. + """ + cls.level = default_level + cls.log_file = log_file + + log_to_stdout = False + if verbose: + log_to_stdout = True + + level = default_level + if not verbose: + level = logging.WARNING + cls.rank0.setLevel(level) + cls.all_ranks.setLevel(level) + + root_filter = MPIFilterRoot(comm) + all_filter = MPIFilterAll(comm) + cls.rank0.addFilter(root_filter) + cls.all_ranks.addFilter(all_filter) + + if (not log_file) and (not log_to_stdout): + return + if log_file: + cls.log_file_handler = logging.FileHandler(log_file) + cls.log_file_handler.setLevel(level) + cls.log_file_handler.setFormatter(cls.formatter) + + cls.rank0.addHandler(cls.log_file_handler) + cls.all_ranks.addHandler(cls.log_file_handler) + if log_to_stdout: + cls.log_to_stdout = True + cls.stdout_handler = logging.StreamHandler() + cls.stdout_handler.setLevel(level) + cls.stdout_handler.setStream(sys.stdout) + cls.stdout_handler.setFormatter(cls.formatter) + cls.stdout_handler.addFilter(MPIFilterStdout()) + + cls.rank0.addHandler(cls.stdout_handler) + cls.all_ranks.addHandler(cls.stdout_handler)
+ + +def format_timedelta(timedelta): + days = timedelta.days + hours, rem = divmod(timedelta.seconds, 3600) + minutes, seconds = divmod(rem, 60) + microseconds = timedelta.microseconds + ret_str = "" + if days != 0: + ret_str += f"{days} days " + ret_str += f"{hours:02d}:{minutes:02d}:{seconds:02d}.{microseconds:06d}" + return ret_str + + +def get_version(): + # Check if we are in a git repo and grab the commit hash and the branch if + # we are, append it to the version number in the output specification. + try: + import git + + try: + repo_dir = os.path.abspath( + os.path.join(os.path.dirname(__file__), os.pardir) + ) + repo = git.Repo(repo_dir) + commit = str(repo.head.commit)[:7] + branch = repo.active_branch + version = f"{__version__} [{branch} branch commit {commit}]" + except git.exc.InvalidGitRepositoryError: + version = f"{__version__}" + except ModuleNotFoundError: + version = f"{__version__}" + + return version + + +def print_header(): + banner = r""" + __ __ ____ __ _______ + / / / /_ __/ / /__ _________ _____ ______ / |/ / __ \ + / /_/ / / / / / / _ \/ ___/ __ `/ __ `/ ___/ / /|_/ / / / / + / __ / /_/ / / / __/ / / /_/ / /_/ (__ ) / / / / /_/ / + /_/ /_/\__, /_/_/\___/_/ \__,_/\__,_/____/ /_/ /_/_____/ + /____/ + """ + + refs_set = """ + + [1] Ledum, M.; Sen, S.; Li, X.; Carrer, M.; Feng Y.; Cascella, M.; Bore, S. L. + HylleraasMD: A Domain Decomposition-Based Hybrid Particle-Field Software for Multi-Scale Simulations of Soft Matter. + J. Chem. Theory Comput. 2023. + + [2] Ledum, M.; Carrer, M.; Sen, S.; Li, X.; Cascella, M.; Bore, S. L. + HyMD: Massively parallel hybrid particle-field molecular dynamics in Python. + J. Open Source Softw. 8(84), 4149, 2023. + + [3] Sen, S.; Ledum, M.; Bore, S. L.; Cascella, M. + Soft Matter under Pressure: Pushing Particle–Field Molecular Dynamics to the Isobaric Ensemble. + J Chem Inf Model 2023, 63(7), 1549-9596. + + [4] Bore, S. L.; Cascella, M. + Hamiltonian and alias-free hybrid particle–field molecular dynamics. + J. Chem. Phys. 2020, 153, 094106. + + [5] Pippig, M. PFFT: An extension of FFTW to massively parallel architectures. + SIAM J. Sci. Comput. 2013, 35, C213–C236. + +""" + + version = f"Version {get_version()}" + header = banner + header += version.center(56) + "\n\n" + #header += " Please read and cite the references below:" + header += " PLEASE READ AND CITE THE REFERENCES BELOW:" + header += refs_set + + return header +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/_modules/hymd/pressure.html b/v2.0.2/_modules/hymd/pressure.html new file mode 100644 index 00000000..42c45009 --- /dev/null +++ b/v2.0.2/_modules/hymd/pressure.html @@ -0,0 +1,469 @@ + + + + + + hymd.pressure — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.pressure

+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import sympy
+from .field import comp_laplacian
+
+
+
[docs]def comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fourier, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=MPI.COMM_WORLD, +): + """ + Computes total internal pressure of the system. + Kinetic pressure is trivially calculated from the kinetic energy. + Already computed bond and angle pressure terms are inserted into the + total internal pressure. + The field pressure equation is implemented. + + Parameters + ---------- + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fourier : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pressure : (18,) numpy.ndarray + Pressure contributions from various energy terms. + 0: due to kinetic energy + 1-5: due to field energy + 6-8: due to two-particle bonded terms + 9-11: due to three-particle bonded terms (called angle terms) + 12-14: due to four-particle bonded terms (called dihedral terms) + (defaults to 0 currently. Yet to be implemented) + 15-17: total pressure in x,y,z directions. + """ + rank = comm.Get_rank() + size = comm.Get_size() + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + w_elec = 0.0 + if (config.coulombtype == "PIC_Spectral_GPE") or ( + config.coulombtype == "PIC_Spectral" + ): + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + w = w_0 + w_elec + + # Kinetic term + kinetic_energy = 0.5 * config.mass * np.sum(velocities**2) + p_kin = 2 / (3 * V) * kinetic_energy + + # Term 1 + p0 = -1 / V * np.sum(w) + + # Term 2 + if psi is not None: # if using electrostatics + V_bar = np.array([hamiltonian.V_bar[k]([phi, psi]) for k in range(config.n_types)]) + else: + V_bar = np.array([hamiltonian.V_bar_0[k](phi) for k in range(config.n_types)]) + + p1 = np.sum((volume_per_cell / V) * V_bar * phi) + + # Term 3 + comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, + ) + + p2 = np.sum( + volume_per_cell + / V + * config.sigma**2 + * np.repeat(V_bar[:, np.newaxis, :, :, :], 3, axis=1) + * phi_laplacian, + axis=(0, 2, 3, 4), + ) + + # Bonded force term: linking 2 particles + p_bond = bond_pr / V + + # Angle force term: linking 3 particles + p_angle = angle_pr / V + + # TODO: Dihedral angle force term: linking 4 atoms + p_dihedral = np.zeros(3) + + # Add formal parameter dihedral_forces as: comp_pressure(..., dihedral_forces) + # Define dictionary: + # forces = { + # 'x': dihedral_forces[:,0], + # 'y': dihedral_forces[:,1], + # 'z': dihedral_forces[:,2] + # } + # Compute the pressure due to dihedrals as: + # p_dihedral = { + # 'x': np.sum( np.multiply(forces['x'],positions[:,0]) )*(1/V), + # 'y': np.sum( np.multiply(forces['y'],positions[:,1]) )*(1/V), + # 'z': np.sum( np.multiply(forces['z'],positions[:,2]) )*(1/V) + # } + + # Total pressure in x, y, z + p_tot = p_kin + p0 + p1 + p2 + p_bond + p_angle + p_dihedral + + return_value = np.array( + [ + p_kin, + p0, + p1, + p2[0], + p2[1], + p2[2], + p_bond[0], + p_bond[1], + p_bond[2], + p_angle[0], + p_angle[1], + p_angle[2], + p_dihedral[0], + p_dihedral[1], + p_dihedral[2], + p_tot[0], + p_tot[1], + p_tot[2], + ] + ) + return_value = comm.allreduce(return_value, MPI.SUM) + + return return_value
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/_modules/hymd/thermostat.html b/v2.0.2/_modules/hymd/thermostat.html new file mode 100644 index 00000000..2ea2ab43 --- /dev/null +++ b/v2.0.2/_modules/hymd/thermostat.html @@ -0,0 +1,509 @@ + + + + + + hymd.thermostat — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.thermostat

+"""Scales or otherwise modifies the particle velocities during simulation to
+simulate coupling to an external heat bath with temperature T₀.
+"""
+import numpy as np
+import logging
+from mpi4py import MPI
+from typing import Callable
+from .logger import Logger
+from .input_parser import Config
+
+
+def cancel_com_momentum(velocities, config, comm=MPI.COMM_WORLD):
+    com_velocity = comm.allreduce(np.sum(velocities[...], axis=0), MPI.SUM)
+    velocities[...] = velocities[...] - com_velocity / config.n_particles
+    return velocities
+
+
+def generate_initial_velocities(velocities, config, prng, comm=MPI.COMM_WORLD):
+    kT_start = config.gas_constant * config.start_temperature
+    n_particles_ = velocities.shape[0]
+    velocities[...] = prng.normal(
+        loc=0, scale=kT_start / config.mass, size=(n_particles_, 3)
+    )
+    velocities = cancel_com_momentum(velocities, config, comm=comm)
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    start_kinetic_energy_target = (
+        1.5 * config.gas_constant * config.n_particles * config.start_temperature
+    )
+    factor = np.sqrt(1.5 * config.n_particles * kT_start / kinetic_energy)
+    velocities[...] = velocities[...] * factor
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    Logger.rank0.log(
+        logging.INFO,
+        (
+            f"Initialized {config.n_particles} velocities, target kinetic "
+            f"energy: {start_kinetic_energy_target}, actual kinetic energy "
+            f"generated: {kinetic_energy}"
+        ),
+    )
+    return velocities
+
+
+
[docs]def _random_gaussian(prng: np.random.Generator) -> float: + """Draw a single random number from the standard normal distribution + Generate a number from the Gaussian distribution centered at zero with unit + standard deviation, :math:`N(0, 1)`. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + + Returns + ------- + float + A random number drawn from :math:`N(0, 1)`. + """ + return prng.normal()
+ + +
[docs]def _random_chi_squared(prng: np.random.Generator, M: int) -> float: + """Draw the sum of :code:`M` squared normally distributed values + + The value is generated by the Gamma distribution, in lieu of generating + :code:`M` Gaussian distributed numbers and summing their squares. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + M : int + Number of standard normally distributed numbers in the sum. + + Returns + ------- + float + The sum of :code:`M` squared normally distributed values centered at + zero with unit standard deviation. + + Notes + ----- + The sum of the squares of k independent standard normal random variables is + distributed according to a :math:`\\chi^2` distribution. + + .. math:: + + \\chi^2_1 + \\chi_2^2 + \\chi_3^2 + \\dots + \\chi_M^2 + \\sim + \\sigma^2\\chi^2(k) + + This is a special case of the :math:`\\Gamma` distribution, + :math:`\\Gamma(k/2, 2)`, and may be generated by + + .. math:: + + \\chi^2(k) \\sim 2 \\Gamma(k/2, 2) + + References + ---------- + Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of + Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. + J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246. + """ + return prng.chisquare(M)
+ + +
[docs]def csvr_thermostat( + velocity: np.ndarray, + names: np.ndarray, + config: Config, + prng: np.random.Generator, + comm: MPI.Intracomm = MPI.COMM_WORLD, + random_gaussian: Callable[[np.random.Generator], float] = _random_gaussian, + random_chi_squared: Callable[ + [np.random.Generator, int, float], float + ] = _random_chi_squared, + remove_center_of_mass_momentum: bool = True, +) -> np.ndarray: + """Canonical sampling through velocity rescaling thermostat + + Implements the CSVR thermostat. Rescales the system kinetic energy by a + stochastically chosen factor to keep the temperature constant. Requires + communcation of the kinetic energies calculated locally for each MPI rank. + The random numbers sampled through :code:`random_gaussian` and + :code:`random_chi_squared` are broadcast from the root rank to the other + ranks to ensure the scaling is performed with the same stochasticity for + all particles in the full system. + + The velocities are cleaned of center of mass momentum before the thermostat + is applied, and the center of mass momentum is subsequently reapplied. This + is performed for each thermostat coupling group, i.e. the center of mass + momenta of each *group* is separately removed and reapplied after + thermostatting. + + The implementation here is based on the derivation presented in the 2008 + Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper. + + Parameters + ---------- + velocity : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + names : (N,) numpy.ndarray + Array of particle names. + config : Config + Configuration dataclass containing simulation metadata and parameters. + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + random_gaussian : callable, optional + Function for generating standard normally distributed numbers. + random_chi_squared : callable, optional + Function for generating :math:`\\chi^2`-distributed numbers + remove_center_of_mass_momentum : bool, optional + If True, the center of mass of each coupling group is removed before + the thermostat is applied. The center of mass momenta are added back + after the kinetic energy rescaling is complete. + + See Also + -------- + _random_gaussian : + Used to sample Gaussian-distributed numbers. + _random_chi_squared : + Used to sample :math:`\\chi^2`-distributed numbers. + hymd.input_parser.Config : + Configuration dataclass handler. + + References + ---------- + G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). + G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008). + """ + if not any(config.thermostat_coupling_groups): + config.thermostat_coupling_groups = [config.unique_names.copy()] + for i, group in enumerate(config.thermostat_coupling_groups): + ind = np.where( + np.logical_or.reduce(list(names == np.string_(t) for t in group)) + ) + group_n_particles = comm.allreduce(len(ind[0]), MPI.SUM) + + # Clean velocities of center of mass momentum + if remove_center_of_mass_momentum and group_n_particles > 1: + com_velocity = comm.allreduce(np.sum(velocity[ind], axis=0)) + velocity_clean = velocity[ind] - com_velocity / group_n_particles + K = comm.allreduce(0.5 * config.mass * np.sum(velocity_clean[...] ** 2)) + else: + K = comm.allreduce(0.5 * config.mass * np.sum(velocity[...] ** 2)) + K_target = ( + 1.5 * config.gas_constant * group_n_particles * config.target_temperature + ) + N_f = 3 * group_n_particles + c = np.exp(-(config.time_step * config.respa_inner) / config.tau) + + # Random numbers are identical across ranks because all ranks have + # the same prng after the initialization of the velocities + R = random_gaussian(prng) + SNf = random_chi_squared(prng, N_f - 1) + + alpha2 = ( + c + + (1 - c) * (SNf + R**2) * K_target / (N_f * K) + + 2 * R * np.sqrt(c * (1 - c) * K_target / (N_f * K)) + ) + dK = K * (alpha2 - 1) + alpha = np.sqrt(alpha2) + + if remove_center_of_mass_momentum and group_n_particles > 1: + # Assign velocities and reapply the previously removed center + # of mass momentum removed + velocity_clean *= alpha + velocity[ind] = velocity_clean + com_velocity / group_n_particles + else: + velocity *= alpha + config.thermostat_work += dK
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/_modules/index.html b/v2.0.2/_modules/index.html new file mode 100644 index 00000000..c1784229 --- /dev/null +++ b/v2.0.2/_modules/index.html @@ -0,0 +1,299 @@ + + + + + + Overview: module code — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/v2.0.2/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css new file mode 100644 index 00000000..1b057df2 --- /dev/null +++ b/v2.0.2/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css @@ -0,0 +1 @@ +.badge{border-radius:.25rem;display:inline-block;font-size:75%;font-weight:700;line-height:1;padding:.25em .4em;text-align:center;vertical-align:baseline;white-space:nowrap}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{border-radius:10rem;padding-left:.6em;padding-right:.6em}.badge-primary{background-color:#007bff;color:#fff}.badge-primary[href]:focus,.badge-primary[href]:hover{background-color:#0062cc;color:#fff;text-decoration:none}.badge-secondary{background-color:#6c757d;color:#fff}.badge-secondary[href]:focus,.badge-secondary[href]:hover{background-color:#545b62;color:#fff;text-decoration:none}.badge-success{background-color:#28a745;color:#fff}.badge-success[href]:focus,.badge-success[href]:hover{background-color:#1e7e34;color:#fff;text-decoration:none}.badge-info{background-color:#17a2b8;color:#fff}.badge-info[href]:focus,.badge-info[href]:hover{background-color:#117a8b;color:#fff;text-decoration:none}.badge-warning{background-color:#ffc107;color:#212529}.badge-warning[href]:focus,.badge-warning[href]:hover{background-color:#d39e00;color:#212529;text-decoration:none}.badge-danger{background-color:#dc3545;color:#fff}.badge-danger[href]:focus,.badge-danger[href]:hover{background-color:#bd2130;color:#fff;text-decoration:none}.badge-light{background-color:#f8f9fa;color:#212529}.badge-light[href]:focus,.badge-light[href]:hover{background-color:#dae0e5;color:#212529;text-decoration:none}.badge-dark{background-color:#343a40;color:#fff}.badge-dark[href]:focus,.badge-dark[href]:hover{background-color:#1d2124;color:#fff;text-decoration:none}.border-0{border:0 !important}.border-top-0{border-top:0 !important}.border-right-0{border-right:0 !important}.border-bottom-0{border-bottom:0 !important}.border-left-0{border-left:0 !important}.p-0{padding:0 !important}.pt-0,.py-0{padding-top:0 !important}.pr-0,.px-0{padding-right:0 !important}.pb-0,.py-0{padding-bottom:0 !important}.pl-0,.px-0{padding-left:0 !important}.p-1{padding:.25rem !important}.pt-1,.py-1{padding-top:.25rem !important}.pr-1,.px-1{padding-right:.25rem !important}.pb-1,.py-1{padding-bottom:.25rem !important}.pl-1,.px-1{padding-left:.25rem !important}.p-2{padding:.5rem !important}.pt-2,.py-2{padding-top:.5rem !important}.pr-2,.px-2{padding-right:.5rem !important}.pb-2,.py-2{padding-bottom:.5rem !important}.pl-2,.px-2{padding-left:.5rem !important}.p-3{padding:1rem !important}.pt-3,.py-3{padding-top:1rem !important}.pr-3,.px-3{padding-right:1rem !important}.pb-3,.py-3{padding-bottom:1rem !important}.pl-3,.px-3{padding-left:1rem !important}.p-4{padding:1.5rem !important}.pt-4,.py-4{padding-top:1.5rem !important}.pr-4,.px-4{padding-right:1.5rem !important}.pb-4,.py-4{padding-bottom:1.5rem !important}.pl-4,.px-4{padding-left:1.5rem !important}.p-5{padding:3rem !important}.pt-5,.py-5{padding-top:3rem !important}.pr-5,.px-5{padding-right:3rem !important}.pb-5,.py-5{padding-bottom:3rem !important}.pl-5,.px-5{padding-left:3rem !important}.m-0{margin:0 !important}.mt-0,.my-0{margin-top:0 !important}.mr-0,.mx-0{margin-right:0 !important}.mb-0,.my-0{margin-bottom:0 !important}.ml-0,.mx-0{margin-left:0 !important}.m-1{margin:.25rem !important}.mt-1,.my-1{margin-top:.25rem !important}.mr-1,.mx-1{margin-right:.25rem !important}.mb-1,.my-1{margin-bottom:.25rem !important}.ml-1,.mx-1{margin-left:.25rem !important}.m-2{margin:.5rem !important}.mt-2,.my-2{margin-top:.5rem !important}.mr-2,.mx-2{margin-right:.5rem !important}.mb-2,.my-2{margin-bottom:.5rem !important}.ml-2,.mx-2{margin-left:.5rem !important}.m-3{margin:1rem !important}.mt-3,.my-3{margin-top:1rem !important}.mr-3,.mx-3{margin-right:1rem !important}.mb-3,.my-3{margin-bottom:1rem !important}.ml-3,.mx-3{margin-left:1rem !important}.m-4{margin:1.5rem !important}.mt-4,.my-4{margin-top:1.5rem !important}.mr-4,.mx-4{margin-right:1.5rem !important}.mb-4,.my-4{margin-bottom:1.5rem !important}.ml-4,.mx-4{margin-left:1.5rem !important}.m-5{margin:3rem !important}.mt-5,.my-5{margin-top:3rem !important}.mr-5,.mx-5{margin-right:3rem !important}.mb-5,.my-5{margin-bottom:3rem !important}.ml-5,.mx-5{margin-left:3rem !important}.btn{background-color:transparent;border:1px solid transparent;border-radius:.25rem;color:#212529;cursor:pointer;display:inline-block;font-size:1rem;font-weight:400;line-height:1.5;padding:.375rem .75rem;text-align:center;transition:color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none;vertical-align:middle}.btn:hover{color:#212529;text-decoration:none}.btn:visited{color:#212529}.btn.focus,.btn:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.25);outline:0}.btn.disabled,.btn:disabled{opacity:.65}@media (prefers-reduced-motion: reduce){.btn{transition:none}}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary:visited{color:#fff}.btn-primary:hover{background-color:#0069d9;border-color:#0062cc;color:#fff}.btn-primary.focus,.btn-primary:focus{background-color:#0069d9;border-color:#0062cc;box-shadow:0 0 0 .2rem rgba(0,123,255,0.5);color:#fff}.btn-primary.disabled,.btn-primary:disabled{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary.active:not(:disabled):not(.disabled),.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{background-color:#0062cc;border-color:#005cbf;color:#fff}.btn-primary.active:not(:disabled):not(.disabled):focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-secondary{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary:visited{color:#fff}.btn-secondary:hover{background-color:#5a6268;border-color:#545b62;color:#fff}.btn-secondary.focus,.btn-secondary:focus{background-color:#5a6268;border-color:#545b62;box-shadow:0 0 0 .2rem rgba(108,117,125,0.5);color:#fff}.btn-secondary.disabled,.btn-secondary:disabled{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled),.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{background-color:#545b62;border-color:#4e555b;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled):focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-success{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success:visited{color:#fff}.btn-success:hover{background-color:#218838;border-color:#1e7e34;color:#fff}.btn-success.focus,.btn-success:focus{background-color:#218838;border-color:#1e7e34;box-shadow:0 0 0 .2rem rgba(40,167,69,0.5);color:#fff}.btn-success.disabled,.btn-success:disabled{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success.active:not(:disabled):not(.disabled),.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{background-color:#1e7e34;border-color:#1c7430;color:#fff}.btn-success.active:not(:disabled):not(.disabled):focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-info{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info:visited{color:#fff}.btn-info:hover{background-color:#138496;border-color:#117a8b;color:#fff}.btn-info.focus,.btn-info:focus{background-color:#138496;border-color:#117a8b;box-shadow:0 0 0 .2rem rgba(23,162,184,0.5);color:#fff}.btn-info.disabled,.btn-info:disabled{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info.active:not(:disabled):not(.disabled),.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{background-color:#117a8b;border-color:#10707f;color:#fff}.btn-info.active:not(:disabled):not(.disabled):focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-warning{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning:visited{color:#212529}.btn-warning:hover{background-color:#e0a800;border-color:#d39e00;color:#212529}.btn-warning.focus,.btn-warning:focus{background-color:#e0a800;border-color:#d39e00;box-shadow:0 0 0 .2rem rgba(255,193,7,0.5);color:#212529}.btn-warning.disabled,.btn-warning:disabled{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning.active:not(:disabled):not(.disabled),.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{background-color:#d39e00;border-color:#c69500;color:#212529}.btn-warning.active:not(:disabled):not(.disabled):focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-danger{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger:visited{color:#fff}.btn-danger:hover{background-color:#c82333;border-color:#bd2130;color:#fff}.btn-danger.focus,.btn-danger:focus{background-color:#c82333;border-color:#bd2130;box-shadow:0 0 0 .2rem rgba(220,53,69,0.5);color:#fff}.btn-danger.disabled,.btn-danger:disabled{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger.active:not(:disabled):not(.disabled),.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{background-color:#bd2130;border-color:#b21f2d;color:#fff}.btn-danger.active:not(:disabled):not(.disabled):focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-light{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light:visited{color:#212529}.btn-light:hover{background-color:#e2e6ea;border-color:#dae0e5;color:#212529}.btn-light.focus,.btn-light:focus{background-color:#e2e6ea;border-color:#dae0e5;box-shadow:0 0 0 .2rem rgba(248,249,250,0.5);color:#212529}.btn-light.disabled,.btn-light:disabled{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light.active:not(:disabled):not(.disabled),.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{background-color:#dae0e5;border-color:#d3d9df;color:#212529}.btn-light.active:not(:disabled):not(.disabled):focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-dark{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark:visited{color:#fff}.btn-dark:hover{background-color:#23272b;border-color:#1d2124;color:#fff}.btn-dark.focus,.btn-dark:focus{background-color:#23272b;border-color:#1d2124;box-shadow:0 0 0 .2rem rgba(52,58,64,0.5);color:#fff}.btn-dark.disabled,.btn-dark:disabled{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark.active:not(:disabled):not(.disabled),.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{background-color:#1d2124;border-color:#171a1d;color:#fff}.btn-dark.active:not(:disabled):not(.disabled):focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-primary{border-color:#007bff;color:#007bff}.btn-outline-primary:visited{color:#007bff}.btn-outline-primary:hover{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{background-color:transparent;color:#007bff}.btn-outline-primary.active:not(:disabled):not(.disabled),.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.active:not(:disabled):not(.disabled):focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-secondary{border-color:#6c757d;color:#6c757d}.btn-outline-secondary:visited{color:#6c757d}.btn-outline-secondary:hover{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{background-color:transparent;color:#6c757d}.btn-outline-secondary.active:not(:disabled):not(.disabled),.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.active:not(:disabled):not(.disabled):focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-success{border-color:#28a745;color:#28a745}.btn-outline-success:visited{color:#28a745}.btn-outline-success:hover{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{background-color:transparent;color:#28a745}.btn-outline-success.active:not(:disabled):not(.disabled),.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.active:not(:disabled):not(.disabled):focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-info{border-color:#17a2b8;color:#17a2b8}.btn-outline-info:visited{color:#17a2b8}.btn-outline-info:hover{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{background-color:transparent;color:#17a2b8}.btn-outline-info.active:not(:disabled):not(.disabled),.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.active:not(:disabled):not(.disabled):focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-warning{border-color:#ffc107;color:#ffc107}.btn-outline-warning:visited{color:#ffc107}.btn-outline-warning:hover{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{background-color:transparent;color:#ffc107}.btn-outline-warning.active:not(:disabled):not(.disabled),.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.active:not(:disabled):not(.disabled):focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-danger{border-color:#dc3545;color:#dc3545}.btn-outline-danger:visited{color:#dc3545}.btn-outline-danger:hover{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{background-color:transparent;color:#dc3545}.btn-outline-danger.active:not(:disabled):not(.disabled),.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.active:not(:disabled):not(.disabled):focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-light{border-color:#f8f9fa;color:#f8f9fa}.btn-outline-light:visited{color:#f8f9fa}.btn-outline-light:hover{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{background-color:transparent;color:#f8f9fa}.btn-outline-light.active:not(:disabled):not(.disabled),.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.active:not(:disabled):not(.disabled):focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-dark{border-color:#343a40;color:#343a40}.btn-outline-dark:visited{color:#343a40}.btn-outline-dark:hover{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{background-color:transparent;color:#343a40}.btn-outline-dark.active:not(:disabled):not(.disabled),.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.active:not(:disabled):not(.disabled):focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-link{color:#007bff;font-weight:400;text-decoration:none}.btn-link:hover{color:#0056b3;text-decoration:underline}.btn-link.focus,.btn-link:focus{box-shadow:none;text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{border-radius:.3rem;font-size:1.25rem;line-height:1.5;padding:.5rem 1rem}.btn-group-sm>.btn,.btn-sm{border-radius:.2rem;font-size:.875rem;line-height:1.5;padding:.25rem .5rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input.btn-block[type=button],input.btn-block[type=reset],input.btn-block[type=submit]{width:100%}.stretched-link::after{background-color:rgba(0,0,0,0);bottom:0;content:'';left:0;pointer-events:auto;position:absolute;right:0;top:0;z-index:1}.text-wrap{white-space:normal !important}.card{background-clip:border-box;background-color:#fff;border:1px solid rgba(0,0,0,0.125);border-radius:.25rem;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;min-width:0;position:relative;word-wrap:break-word}.card>hr{margin-left:0;margin-right:0}.card>.list-group:first-child .list-group-item:first-child{border-top-left-radius:.25rem;border-top-right-radius:.25rem}.card>.list-group:last-child .list-group-item:last-child{border-bottom-left-radius:.25rem;border-bottom-right-radius:.25rem}.card-body{-ms-flex:1 1 auto;flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-bottom:0;margin-top:-.375rem}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{background-color:rgba(0,0,0,0.03);border-bottom:1px solid rgba(0,0,0,0.125);margin-bottom:0;padding:.75rem 1.25rem}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-header+.list-group .list-group-item:first-child{border-top:0}.card-footer{background-color:rgba(0,0,0,0.03);border-top:1px solid rgba(0,0,0,0.125);padding:.75rem 1.25rem}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{border-bottom:0;margin-bottom:-.75rem;margin-left:-.625rem;margin-right:-.625rem}.card-header-pills{margin-left:-.625rem;margin-right:-.625rem}.card-img-overlay{bottom:0;left:0;padding:1.25rem;position:absolute;right:0;top:0}.card-img,.card-img-bottom,.card-img-top{-ms-flex-negative:0;flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-left-radius:calc(.25rem - 1px);border-bottom-right-radius:calc(.25rem - 1px)}.w-100{width:100% !important}.shadow{box-shadow:0 0.5rem 1rem rgba(0,0,0,0.15) !important}.bg-primary{background-color:#007bff !important}button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc !important}a.bg-primary:focus,a.bg-primary:hover{background-color:#0062cc !important}a.text-primary:focus,a.text-primary:hover{color:#121416 !important}.bg-secondary{background-color:#6c757d !important}button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62 !important}a.bg-secondary:focus,a.bg-secondary:hover{background-color:#545b62 !important}a.text-secondary:focus,a.text-secondary:hover{color:#121416 !important}.bg-success{background-color:#28a745 !important}button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34 !important}a.bg-success:focus,a.bg-success:hover{background-color:#1e7e34 !important}a.text-success:focus,a.text-success:hover{color:#121416 !important}.bg-info{background-color:#17a2b8 !important}button.bg-info:focus,button.bg-info:hover{background-color:#117a8b !important}a.bg-info:focus,a.bg-info:hover{background-color:#117a8b !important}a.text-info:focus,a.text-info:hover{color:#121416 !important}.bg-warning{background-color:#ffc107 !important}button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00 !important}a.bg-warning:focus,a.bg-warning:hover{background-color:#d39e00 !important}a.text-warning:focus,a.text-warning:hover{color:#121416 !important}.bg-danger{background-color:#dc3545 !important}button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130 !important}a.bg-danger:focus,a.bg-danger:hover{background-color:#bd2130 !important}a.text-danger:focus,a.text-danger:hover{color:#121416 !important}.bg-light{background-color:#f8f9fa !important}button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5 !important}a.bg-light:focus,a.bg-light:hover{background-color:#dae0e5 !important}a.text-light:focus,a.text-light:hover{color:#121416 !important}.bg-dark{background-color:#343a40 !important}button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124 !important}a.bg-dark:focus,a.bg-dark:hover{background-color:#1d2124 !important}a.text-dark:focus,a.text-dark:hover{color:#121416 !important}.bg-white{background-color:#fff !important}button.bg-white:focus,button.bg-white:hover{background-color:#e6e6e6 !important}a.bg-white:focus,a.bg-white:hover{background-color:#e6e6e6 !important}a.text-white:focus,a.text-white:hover{color:#121416 !important}.text-primary{color:#007bff !important}.text-secondary{color:#6c757d !important}.text-success{color:#28a745 !important}.text-info{color:#17a2b8 !important}.text-warning{color:#ffc107 !important}.text-danger{color:#dc3545 !important}.text-light{color:#f8f9fa !important}.text-dark{color:#343a40 !important}.text-white{color:#fff !important}.text-body{color:#212529 !important}.text-muted{color:#6c757d !important}.text-black-50{color:rgba(0,0,0,0.5) !important}.text-white-50{color:rgba(255,255,255,0.5) !important}.bg-transparent{background-color:transparent !important}.text-justify{text-align:justify !important}.text-left{text-align:left !important}.text-right{text-align:right !important}.text-center{text-align:center !important}.font-weight-light{font-weight:300 !important}.font-weight-lighter{font-weight:lighter !important}.font-weight-normal{font-weight:400 !important}.font-weight-bold{font-weight:700 !important}.font-weight-bolder{font-weight:bolder !important}.font-italic{font-style:italic !important}.container{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container{max-width:540px}}@media (min-width: 768px){.container{max-width:720px}}@media (min-width: 992px){.container{max-width:960px}}@media (min-width: 1200px){.container{max-width:1140px}}.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container,.container-sm{max-width:540px}}@media (min-width: 768px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width: 992px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width: 1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1140px}}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;margin-right:-15px}.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{padding-left:15px;padding-right:15px;position:relative;width:100%}@media (min-width: 576px){.col-sm{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-sm-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-sm-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-sm-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-sm-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-sm-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 768px){.col-md{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-md-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-md-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-md-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-md-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-md-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 992px){.col-lg{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-lg-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-lg-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-lg-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-lg-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-lg-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 1200px){.col-xl{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-xl-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-xl-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-xl-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-xl-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-xl-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}.d-flex{display:-ms-flexbox !important;display:flex !important}.sphinx-bs,.sphinx-bs *{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sphinx-bs p{margin-top:0} diff --git a/v2.0.2/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/v2.0.2/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css new file mode 100644 index 00000000..fc14abc8 --- /dev/null +++ b/v2.0.2/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css @@ -0,0 +1 @@ +details.dropdown .summary-title{padding-right:3em !important;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none}details.dropdown:hover{cursor:pointer}details.dropdown .summary-content{cursor:default}details.dropdown summary{list-style:none;padding:1em}details.dropdown summary .octicon.no-title{vertical-align:middle}details.dropdown[open] summary .octicon.no-title{visibility:hidden}details.dropdown summary::-webkit-details-marker{display:none}details.dropdown summary:focus{outline:none}details.dropdown summary:hover .summary-up svg,details.dropdown summary:hover .summary-down svg{opacity:1}details.dropdown .summary-up svg,details.dropdown .summary-down svg{display:block;opacity:.6}details.dropdown .summary-up,details.dropdown .summary-down{pointer-events:none;position:absolute;right:1em;top:.75em}details.dropdown[open] .summary-down{visibility:hidden}details.dropdown:not([open]) .summary-up{visibility:hidden}details.dropdown.fade-in[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out;animation:panels-fade-in .5s ease-in-out}details.dropdown.fade-in-slide-down[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out}@keyframes panels-fade-in{0%{opacity:0}100%{opacity:1}}@keyframes panels-slide-down{0%{transform:translate(0, -10px)}100%{transform:translate(0, 0)}}.octicon{display:inline-block;fill:currentColor;vertical-align:text-top}.tabbed-content{box-shadow:0 -.0625rem var(--tabs-color-overline),0 .0625rem var(--tabs-color-underline);display:none;order:99;padding-bottom:.75rem;padding-top:.75rem;width:100%}.tabbed-content>:first-child{margin-top:0 !important}.tabbed-content>:last-child{margin-bottom:0 !important}.tabbed-content>.tabbed-set{margin:0}.tabbed-set{border-radius:.125rem;display:flex;flex-wrap:wrap;margin:1em 0;position:relative}.tabbed-set>input{opacity:0;position:absolute}.tabbed-set>input:checked+label{border-color:var(--tabs-color-label-active);color:var(--tabs-color-label-active)}.tabbed-set>input:checked+label+.tabbed-content{display:block}.tabbed-set>input:focus+label{outline-style:auto}.tabbed-set>input:not(.focus-visible)+label{outline:none;-webkit-tap-highlight-color:transparent}.tabbed-set>label{border-bottom:.125rem solid transparent;color:var(--tabs-color-label-inactive);cursor:pointer;font-size:var(--tabs-size-label);font-weight:700;padding:1em 1.25em .5em;transition:color 250ms;width:auto;z-index:1}html .tabbed-set>label:hover{color:var(--tabs-color-label-active)} diff --git a/v2.0.2/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css b/v2.0.2/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css new file mode 100644 index 00000000..adc61662 --- /dev/null +++ b/v2.0.2/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css @@ -0,0 +1,7 @@ +:root { +--tabs-color-label-active: hsla(231, 99%, 66%, 1); +--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); +--tabs-color-overline: rgb(207, 236, 238); +--tabs-color-underline: rgb(207, 236, 238); +--tabs-size-label: 1rem; +} \ No newline at end of file diff --git a/v2.0.2/_sources/doc_pages/api.rst.txt b/v2.0.2/_sources/doc_pages/api.rst.txt new file mode 100644 index 00000000..40f0838c --- /dev/null +++ b/v2.0.2/_sources/doc_pages/api.rst.txt @@ -0,0 +1,116 @@ +.. _api-label: + + +API reference +============= + +Integrator +---------- + +.. automodule:: hymd.integrator + :members: + + +Thermostat +---------- + +.. automodule:: hymd.thermostat + :members: csvr_thermostat, _random_chi_squared, _random_gaussian + :undoc-members: + + +Barostat +-------- + +Berendsen Barostat +^^^^^^^^^^^^^^^^^^ + +.. automodule:: hymd.barostat + :members: isotropic, semiisotropic + :undoc-members: + +SCR Barostat +^^^^^^^^^^^^^^^^^^ + +.. automodule:: hymd.barostat_bussi + :members: isotropic, semiisotropic + :undoc-members: + + +Hamiltonian +----------- + +.. autoclass:: hymd.hamiltonian.Hamiltonian + :members: + + .. automethod:: __init__ + + .. automethod:: _setup + +.. autoclass:: hymd.hamiltonian.SquaredPhi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultNoChi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultWithChi + :members: + + .. automethod:: __init__ + + +Force +----- + +.. automodule:: hymd.force + :members: + :undoc-members: + + +Pressure +-------- + +.. automodule:: hymd.pressure + :members: comp_pressure + :undoc-members: + + +Logger +------ + +.. autoclass:: hymd.logger.Logger + :members: + +.. autoclass:: hymd.logger.MPIFilterRoot + :members: + +.. autoclass:: hymd.logger.MPIFilterAll + :members: + + +Input parser +------------ + +.. automodule:: hymd.input_parser + :members: + :undoc-members: propensity_potential_coeffs + + +Field +----- + +.. automodule:: hymd.field + :members: + + +File input/output +----------------- + +.. automodule:: hymd.file_io + :members: diff --git a/v2.0.2/_sources/doc_pages/benchmarks.rst.txt b/v2.0.2/_sources/doc_pages/benchmarks.rst.txt new file mode 100644 index 00000000..06377a85 --- /dev/null +++ b/v2.0.2/_sources/doc_pages/benchmarks.rst.txt @@ -0,0 +1,93 @@ +.. _benchmarks-label: + +Benchmarks +########## +Homopolymer melt test systems of :math:`30^2`, :math:`40^2`, and :math:`50^2` +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively. + +Bonded forces +^^^^^^^^^^^^^ +Legend label denotes the number of particles in the system. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) + time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 + ], dtype=np.float64) + nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 + ], dtype=np.float64,) + time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, + ], dtype=np.float64) + nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 + ], dtype=np.float64) + time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, + ], dtype=np.float64) + plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" + ) + plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" + ) + plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" + ) + plt.xlabel("CPUs", fontsize=15) + plt.ylabel("Time per step, us", fontsize=15) + plt.legend(fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.show() + + +Particle--field forces +^^^^^^^^^^^^^^^^^^^^^^ +Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + + mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] + mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + + mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + + mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + + mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] + mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + + mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + + mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + + plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") + plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") + plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") + plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") + plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") + plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") + plt.xlabel("CPUs", fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.ylabel("Time per step, s", fontsize=15) + plt.legend(loc="upper left", fontsize=15) + plt.show() diff --git a/v2.0.2/_sources/doc_pages/command_line.rst.txt b/v2.0.2/_sources/doc_pages/command_line.rst.txt new file mode 100644 index 00000000..5233710f --- /dev/null +++ b/v2.0.2/_sources/doc_pages/command_line.rst.txt @@ -0,0 +1,120 @@ +.. _commandline-label: + +Command line arguments +###################### +Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle--field interactions. + + +Required arguments +================== +:configuration file: + :code:`type` positional + + Specifies the :code:`.toml` format configuration file containing simulation details. See :ref:`config-label` for details. + +:structure and topology file: + :code:`type` positional + + Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See :ref:`topology-label` for details. + +Optional arguments +================== +:code:`-v --verbose` + :code:`type` optional + + Number of following arguments: :code:`0` or :code:`1` + + Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying :code:`-v` or :code:`--verbose` with no additional specification. This increases verbosity level by :code:`1`. Alternatively, it maye be specified by :code:`--verbose V` with :code:`V` being :code:`0`, :code:`1`, or :code:`2`. + +:code:`--profile` + :code:`type` optional + + Number of following arguments: :code:`0` + + Enables code profiling using :code:`cProfile`. This will output one profiling file per MPI rank invoked in the simulation. + +:code:`--double-precision` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision internally in HyMD (including in the FFTs). + +:code:`--double-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision in the output trajectory from HyMD. + +:code:`--velocity-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that velocities should be output to the HyMD trajectory. + +:code:`--force-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that forces should be output to the HyMD trajectory. + +:code:`--disable-mpio` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult. + +:code:`--logfile` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the path of a plain text log file in which stdout is mirrored during simulation runs. + +:code:`--seed` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the random seed used in the :code:`numpy` random library to generate velocities, thermostatting, etc. + +:code:`--disable-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any two-particle bonds present in the system. + +:code:`--disable-angle-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any three-particle bonds present in the system. + +:code:`--disable-dihedrals` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any four-particle bonds present in the system. + +:code:`--disable-dipole` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any topological reconstruction of peptide backbone dipoles present in the system. + +:code:`--disable-field` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any particle--field interactions present in the system. diff --git a/v2.0.2/_sources/doc_pages/config_file.rst.txt b/v2.0.2/_sources/doc_pages/config_file.rst.txt new file mode 100644 index 00000000..2ee880b7 --- /dev/null +++ b/v2.0.2/_sources/doc_pages/config_file.rst.txt @@ -0,0 +1,244 @@ +.. _config-label: + +Configuration file +################## +The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order. + +The configuration file is a `toml`_ format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs. + +.. _`toml`: + https://github.com/toml-lang/toml + +.. role:: required + +Configuration file keywords +--------------------------- + +The following constitutes every possible keyword specification in HyMD +configuration files: + +Metadata keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying metadata for the H5MD output trajectory. + +:name: + :code:`string` [**optional**, default: :code:`None`] + + Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file. + + +:tags: + :code:`array` [:code:`string`] [**optional**, default: :code:`None`] + + Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file. + + +Particle keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying properties of particles and molecules in the +system. + +:n_particles: + :code:`integer` [**optional**, default: :code:`None`] + + Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules. + +:mass: + :code:`float` [**optional**, default: :code:`72.0`] {units: :math:`\text{u}=\text{g}\,\text{mol}^{-1}`} + + Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal. + +:max_molecule_size: + :code:`integer` [**optional**, default: :code:`201`] + + Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code **will** crash if there are molecules larger than :code:`max_molecule_size` in the topology/structure input file. + + +Simulation keywords +^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying simulation parameters. + +:n_steps: + :code:`integer` [:required:`required`] + + Total number of integration steps to perform for this simulation. + +:n_print: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of *number of time steps*). + +:n_flush: + :code:`integer` [**optional**, default: :code:`None`] + + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of *number of* :code:`n_print`, i.e. :code:`n_print = 13`, :code:`n_flush = 3` would result in the trajectory/energy being written to disk every :code:`13 x 3 = 39` *simulation steps*) + +:time_step: + :code:`float` [:required:`required`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time step per integration step. If the rRESPA multiple time step integrator is used (:code:`integrator = "respa"`), this specifies the **inner** time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is :code:`respa_inner` times the :code:`time_step` , and the total simulation time is :code:`n_steps` times :code:`time_step` times :code:`respa_inner` . + +:box_size: + :code:`array` [:code:`float`] [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable. + +:integrator: + :code:`string` [:required:`required`] (options: :code:`velocity-verlet` or :code:`respa`) + + Specifies the time integrator used in the simulation. If :code:`respa`, the *reversible reference system propagator algorithm (rRESPA)* :cite:`tuckerman1992reversible` integrator is used, with :code:`respa_inner` number of inner (intramolecular force) time steps. If :code:`velocity-verlet`, a normal Velocity Verlet integrator is used. If :code:`respa` and :code:`respa_inner = 1`, the rRESPA integrator is equivalent to the Velocity Verlet. + +:respa_inner: + :code:`integer` [**optional**, default: :code:`1`] + + The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces. + +:domain_decomposition: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Specifies the interval (in time steps) of *domain decomposition exchange*, involving all MPI ranks sending and receiving particles according to the particles' positions in the integration box and the MPI ranks' assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If :code:`True`, the decomposition is performed once (before starting the simulation). If :code:`False`, no decomposition is performed. + +:cancel_com_momentum: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + If :code:`True`, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every :code:`remove_com_momentum` time steps. If :code:`False`, the linear momentum is never removed. + +:start_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at :code:`start_temperature` Kelvin prior to starting the simulation. If :code:`False`, the velocities are not changed before starting the simulation. + +:target_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Couple the system to a heat bath at :code:`target_temperature` Kelvin by applying a *Canonical sampling through velocity rescaling* :cite:`Bussi2007JCP` thermostat with coupling strength :code:`tau`. If :code:`False`, no temperature control is applied. + +:tau: + :code:`float` [**optional**, default: :code:`0.7`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the CSVR thermostat coupling. In the limit of :code:`tau → ∞`, the Hamiltonian dynamics are preserved and no temperature coupling takes place. + +:thermostat_coupling_groups: + :code:`array` [:code:`array` [:code:`string`]] [**optional**, default: :code:`[]`] + + Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and :code:`"C"` type particles, :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would thermalise types :code:`"A"` and :code:`"B"` together and couple :code:`"C"` type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. :code:`target_temperature` Kelvin). +:hamiltonian: + :code:`string` [**optional**, default: :code:`"DefaultNohChi"`] (options: :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`) + + Specifies the interaction energy functional :math:`W[\tilde\phi]` for use with the particle-field interactions. See :ref:`functionals-label` for details. + + +Field keywords +^^^^^^^^^^^^^^ +Configuration keywords specifying field parameters. + +:mesh_size: + :code:`array` [:code:`integer`] or :code:`integer` [:required:`required`] + + Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is :code:`box_size / mesh_size`. + +:kappa: + :code:`float` [:required:`required`] {units: :math:`\text{kJ}^{-1}\text{mol}`} + + Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional :math:`W[\tilde\phi]`. See :ref:`functionals-label` for more details. + +:sigma: + :code:`float` [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See :ref:`filtering-label` for more details. + +:chi: + :code:`array` [:code:`array` [:code:`string`, :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}`} + + Array of :math:`\tilde\chi_\text{AB}`-parameters indicating the strength of the repulsive or attractive interaction between particles of type :code:`"A"` and the number density due to particles of type :code:`"B"`, and vice versa. Example: :code:`chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ]` would specify a repulsive :code:`"A"`--:code:`"B"` type interaction, and a weakly attractive :code:`"C"`--:code:`"D"` interaction. Self-interaction :math:`\tilde\chi`-terms are always zero. See :ref:`functionals-label` for more details. + + +Bond keywords +^^^^^^^^^^^^^ +Configuration keywords specifying bonds and bonds parameters. + +:bonds: + :code:`array` [:code:`array` [2 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{nm}=10^{-9}~\text{m}` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: :code:`bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ]` indicates a :code:`"A"`--:code:`"A"` bond of equilibrium length :code:`0.47` :math:`\text{nm}` with a bond strength of :code:`980.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding bond between :code:`"A"` and :code:`"B"` type particles with equilibrium length :code:`0.31` :math:`\text{nm}` and a strength of :code:`1250.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify stretching bonds. + +:angle_bonds: + :code:`array` [:code:`array` [3 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`{}^\circ` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: :code:`bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ]` indicates a :code:`"A"`--:code:`"A"`--:code:`"A"` angular bond that tries to keep the bond linear at :code:`180` degrees with a bending strength of :code:`55.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding angle bond between :code:`"A"`--:code:`"B"`--:code:`"B"` prefering the angle at :code:`120` degrees and a strength of :code:`25.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify angular bonds. + +:dihedrals: + :code:`array` [:code:`array` [4 :code:`string`, :code:`integer`, :code:`COSINE SERIES` ]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`} + + Specifies four-particle torsional potentials by cosine series. See :ref:`bonds-label` for details about how to specify dihedrals. + + + +Electrostatic keywords +^^^^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying electrostatics and electrostatic parameters. + +:coulombtype: + :code:`string` [**optional**, default: :code:`None`] (options: :code:`PIC_Spectral`) + + Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the :code:`dielectric_const` keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, *not* in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to `PIC_Spectral`. + +:dielectric_const: + :code:`float` [**optional**, default: :code:`None`] + + Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified---even if electrostatics are not included with the :code:`coulombtype` keyword. + +Pressure keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying pressure and barostat parameters. + +Simulation keywords +========================================= + +:pressure: + :code:`boolean` [**optional**, default: :code:`False`] + + Specifies whether or not to calculate total internal pressure vector. + +:barostat: + :code:`string` [**optional**, default: :code:`None`](options: :code:`isotropic` or :code:`semiisotropic`) + + Specifies whether to apply pressure constraints equally in all 3 Cartesian directions (`isotropic`) or equally in xy and different in z (`semiisotropic`). + +:barostat_type: + :code:`string` [**optional**, default: :code:`berendsen`](options: :code:`berendsen` or :code:`scr`) + + Specifies the type of barostat to use. :code:`berendsen` is more suitable for equilibration and :code:`scr` for equilibrium data collection. + +:n_b: + :code:`integer` [**optional**, default: :code:`1`] + + Frequency of barostat call in number of outer rRESPA steps. + +:tau_p: + :code:`float` [**optional**, default: :code:`10 tau` if :code:`tau < 0.1` else :code:`1.0`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the barostat coupling. + +:target_pressure: + :code:`array` [:code:`float`] [**optional**, default: :code:1] {units: `bar`} + + Couples the system to an external pressure set to `target_pressure`. + +Field keywords +========================================= + +:rho0: + :code:`float` [**optional**, default: :code:average density] {units: :math:`\text{nm}^{-3}`} + + Intrinsic parameter corresponding to the specific volume of a coarse-grained particle. Typically: `8.66` + +:a: + :code:`float` [:required:`required`] {units: :math:`\text{nm}^{-3}`} + + Calibrated parameter to obtain the correct average density at the target temperature and pressure. Typically: `9.21` diff --git a/v2.0.2/_sources/doc_pages/constants_and_units.rst.txt b/v2.0.2/_sources/doc_pages/constants_and_units.rst.txt new file mode 100644 index 00000000..ee429829 --- /dev/null +++ b/v2.0.2/_sources/doc_pages/constants_and_units.rst.txt @@ -0,0 +1,80 @@ +.. _units-label: + +Constants and Units +################### + +HyMD uses the following units and constants internally and in all input and +output: + +.. list-table:: **Units** + :widths: 30 10 75 + :header-rows: 1 + + * - Quantity + - Symbol + - Unit + * - length + - :math:`r` + - :math:`\text{nm}=10^{-9}~\text{m}` + * - time + - :math:`t` + - :math:`\text{ps}=10^{-12}~\text{s}` + * - charge + - :math:`q` + - :math:`e=1.602176634 \cdot 10^{-19}~\text{C}` + * - mass + - :math:`m` + - :math:`\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}` + * - temperature + - :math:`\text{T}` + - :math:`\text{K}` + * - energy + - :math:`E` + - :math:`\text{kJ}\,\text{mol}^{-1}` + * - velocity + - :math:`v` + - :math:`\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}` + * - momentum + - :math:`P` + - :math:`\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}` + * - force + - :math:`\mathbf{F}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}` + * - pressure + - :math:`p` + - :math:`\text{bar}=100~\text{kPa}` + * - electric potential + - :math:`\Psi` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}` + * - electric field + - :math:`\mathbf{E}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}` + * - compressibility + - :math:`\kappa` + - :math:`\text{mol}\,\text{kJ}^{-1}` + * - field-interaction + - :math:`\tilde\chi` + - :math:`\text{kJ}\,\text{mol}^{-1}` + +.. list-table:: **Constants** + :widths: 30 10 75 + :header-rows: 1 + + * - Constant + - Symbol + - Value + * - gas constant + - :math:`R` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Boltzmann’s constant + - :math:`k_\text{B}` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Avogadro's constant + - :math:`N_\text{A}` + - :math:`6.02214076 \cdot 10^23~\text{mol}^{-1}` + * - Vacuum permittivity + - :math:`\varepsilon_0` + - :math:`8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2` + * - Coulomb constant + - :math:`k_\text{e}` + - :math:`138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}` diff --git a/v2.0.2/_sources/doc_pages/electrostatics.rst.txt b/v2.0.2/_sources/doc_pages/electrostatics.rst.txt new file mode 100644 index 00000000..7e11c09d --- /dev/null +++ b/v2.0.2/_sources/doc_pages/electrostatics.rst.txt @@ -0,0 +1,48 @@ +.. _electrostatics-label: + +Electrostatic interactions +########################## +In the filtered Hamiltonian hPF formalism :cite:`bore2020hamiltonian` the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle--mesh Ewald. + +The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered + +.. math:: + + \tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i), + +with :math:`q_i` being the charge of particle :math:`i` and :math:`H` is the +filtering function (see :ref:`filtering-label`). The value of the charge grid at +vertex :math:`(i,j,k)` is found by + +.. math:: + + \tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)] + +and the electrostatic potential :math:`\Psi_{ijk}` + +.. math:: + + \Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right], + +where :math:`k_\text{e}` is the Coulomb constant :math:`1/4\pi\varepsilon_0`. +The *electric field* is obtained by differentiation of the electrostatic +potential in Fourier space, + +.. math:: + + \mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)] + +from which the forces are interpolated back to the particle positions. + +Specifying electrostatics +^^^^^^^^^^^^^^^^^^^^^^^^^ +In HyMD, electrostatics are specified by the :code:`coulombtype` and +:code:`dielectric_const` keywords in the configuration file (see +:ref:`config-label`) and the :code:`/charge` dataset in the HDF5 format +structure/topology input file (see :ref:`topology-label`). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions. diff --git a/v2.0.2/_sources/doc_pages/examples.rst.txt b/v2.0.2/_sources/doc_pages/examples.rst.txt new file mode 100644 index 00000000..9f9c3655 --- /dev/null +++ b/v2.0.2/_sources/doc_pages/examples.rst.txt @@ -0,0 +1,621 @@ +.. _examples-label: + +Examples +######## +The following examples are ordered in *more or less* order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the `HyMD-tutorial`_ github repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Ideal gas +========= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true + :align: right + :width: 200 + +The simplest possible system is one with no interactions at all---intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like: + + +.. code-block:: toml + :caption: **ideal_gas.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = false # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + +A simple input structure/topology file :code:`ideal_gas.HDF5` is available in +the `HyMD-tutorial/ideal_gas`_ github repository (along with the code to +generate it). Run the (very) short simulation by + +.. code:: bash + + python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field \ + --velocity-output \ + --force-output + +with the :code:`--disable-field` argument to completely turn off all +particle--field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook `ideal_gas.ipynb`_ for details. + + +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas +.. _ideal_gas.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.ipynb + + +Ideal chains +============ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true + :align: right + :width: 200 + +The simplest available interaction is the harmonic two-particle bond (see +:ref:`bonds-label`), + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2. + +Extending the configuration file from the ideal gas case, we need to add a +:code:`bonds` specification. Note that the :code:`[bonds]` meta specifier is not +necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **ideal_chain.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + +A simple input structure/topology file :code:`ideal_chain.HDF5` with a few +coiled up ideal chain polymers is available in the +`HyMD-tutorial/ideal_chain`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field + +we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +`ideal_chain.ipynb`_. + + +.. _HyMD-tutorial/ideal_chain: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_chain +.. _ideal_chain.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/ideal_chain.ipynb + + +Stiff rods +========== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true + :align: right + :width: 200 + +Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the :code:`i--j--k` angle :math:`\theta` (see +:ref:`bonds-label`), + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2. + +Extending the configuration file from the ideal chain case, we need to add a +:code:`angle_bonds` specification. Note that the :code:`[bonds]` meta specifier +is not necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **rods.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + + angle_bonds = [ + ["A", "A", "A", 180.0, 100.0], # (i, j, k, equilibrium angle, strength) + ] + + +A simple input structure/topology file :code:`rods.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook `rods.ipynb`_. + + +.. _HyMD-tutorial/rods: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/rods +.. _rods.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.ipynb + + + +Helixes +======= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true + :align: right + :width: 200 + +Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle :math:`\phi` between the +:code:`i--j--k` plane and the :code:`j--k--l` plane (see :ref:`bonds-label`), + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n). + +The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a :code:`dihedrals` keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the :code:`dielectric_const` +keyword even though we are not including electrostatic forces in the current +simulation. Note that the :code:`[bonds]` meta specifier is not necessary, but +may be used to help organise the input file. + +.. code-block:: toml + :caption: **helixes.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + dielectric_const = 15.0 + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.31, 10000.0], # (i name, j name, equilibrium length, strength) + ] + + dihedrals = [ + [ + ["A", "A", "A", "A"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0] + ], + ] + +A simple input structure/topology file :code:`helixes.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook `helixes.ipynb`_. + + +.. _HyMD-tutorial/helixes: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/helixes +.. _helixes.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.ipynb + + +Phase separation +================ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true + :align: right + :width: 200 + +The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types :code:`A` and :code:`B`. Using the Hamiltonian + +.. math:: + + \mathcal{H}=H_0+W + +with :math:`\tilde\chi`--dependent interactions defined by (specified in the +configuration file by :code:`hamiltonian = DefaultWithChi`): + +.. math:: + + W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2. + + +.. code-block:: toml + :caption: **phase_separation.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + + [field] + mesh_size = [20, 20, 20] # FFT grid size + sigma = 1.0 # filtering length scale in nm + kappa = 0.05 # compressibility in mol/kJ + chi = [ + ['A', 'B', 5.0], # (name i, name j, strength) + ] + +A simple input structure/topology file :code:`phase_separation.HDF5` containing +an equal number of :code:`A` type and :code:`B` type particles is available in +the `HyMD-tutorial/phase_separation`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd phase_separation.toml phase_separation.HDF5 + +we may examine the resulting trajectory. In the case of a low interaction +strength :math:`\tilde\chi` of :code:`5.0` (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to :code:`40.0` (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +`phase_separation.ipynb`_. + + +.. _HyMD-tutorial/phase_separation: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/phase_separation +.. _phase_separation.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/phase_separation.ipynb + + +Diblock copolymers +================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true + :align: right + :width: 200 + +Having introduced particle--field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive :math:`\tilde\chi`--interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the :code:`integrator = "respa"` keyword. Putting the pieces together, the +configuration file may look like the following: + +.. code-block:: toml + :caption: **copolymer.toml** + + [simulation] + integrator = "respa" + respa_inner = 15 + n_steps = 2000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [10.0, 10.0, 10.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [50, 50, 50] # FFT grid size + sigma = 0.5 # filtering length scale in nm + chi = [ + ["A", "B", 30.0], # (i, j, strength) + ] + + [bonds] + bonds = [ + ["A", "A", 0.25, 1500.0], # (i, j, equilibrium length, strength) + ["A", "B", 0.25, 1500.0], + ["B", "B", 0.25, 1500.0], + ] + angle_bonds = [ + ["A", "A", "A", 180.0, 25.0], # (i, j, k, equilibrium angle, strength) + ["B", "B", "B", 180.0, 25.0], + ] + +A simple input structure/topology file :code:`copolymer.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/copolymer`_ github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten :code:`A` followed by ten :code:`B` type particles. +Running the simulation with + +.. code:: bash + + python3 -m hymd copolymer.toml copolymer.HDF5 + +the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +`copolymer.ipynb`_. + + +.. _HyMD-tutorial/copolymer: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/copolymer +.. _copolymer.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer.ipynb + + +Lipid bilayer self-assembly +=========================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true + :align: right + :width: 300 + +Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field--particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the :code:`thermostat_coupling_groups` keyword. With parameters +optimised in :cite:`ledum2020automated`, the configuration file looks like: + + +.. code-block:: toml + :caption: **lipid_self_assembly.toml** + + [simulation] + integrator = "respa" + respa_inner = 25 + n_steps = 3000 + n_print = 200 + n_flush = 1 + time_step = 0.01 + box_size = [9.96924, 9.96924, 10.03970] + start_temperature = 323 + target_temperature = 323 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.05 + domain_decomposition = 10001 + cancel_com_momentum = true + max_molecule_size = 15 + thermostat_coupling_groups = [ + ["N", "P", "G", "C"], + ["W"], + ] + + [field] + mesh_size = [25, 25, 25] + sigma = 1.0 + chi = [ + ["C", "W", 42.24], + ["G", "C", 10.47], + ["N", "W", -3.77], + ["G", "W", 4.53], + ["N", "P", -9.34], + ["P", "G", 8.04], + ["N", "G", 1.97], + ["P", "C", 14.72], + ["P", "W", -1.51], + ["N", "C", 13.56], + ] + + [bonds] + bonds = [ + ["N", "P", 0.47, 1250.0], + ["P", "G", 0.47, 1250.0], + ["G", "G", 0.37, 1250.0], + ["G", "C", 0.47, 1250.0], + ["C", "C", 0.47, 1250.0], + ] + angle_bonds = [ + ["P", "G", "G", 120.0, 25.0], + ["P", "G", "C", 180.0, 25.0], + ["G", "C", "C", 180.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +A randomly mixed input structure/topology file +:code:`lipid_self_assembly.HDF5` with a few hundred lipids in a roughy +:code:`10 x 10 x 10nm` box is available in the +`HyMD-tutorial/lipid_self_assembly`_ github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation + +.. code:: bash + + python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5 + +we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook `lipid_self_assembly.ipynb`_. + + +.. _HyMD-tutorial/lipid_self_assembly: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/lipid_self_assembly +.. _lipid_self_assembly.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/lipid_self_assembly.ipynb + + +Peptide in lipid bilayer +======================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true + :align: right + :width: 300 + +Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer. + + +The `configuration file`_ is available in the `HyMD-tutorial/peptide`_ github +repository (omitted here for brevity). + +A pre-equilibrated input structure/topology file :code:`peptide.HDF5` with a +few hundred lipids in a roughy :code:`20 x 20 x 20nm` box is available in the +`HyMD-tutorial/peptide`_ github repository. Running the simulation + +.. code:: bash + + python3 -m hymd peptide.toml peptide.HDF5 + +we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook `peptide.ipynb`_. + + +.. _HyMD-tutorial/peptide: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/peptide +.. _configuration file: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.toml +.. _peptide.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.ipynb + + +SDS +=== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true + :align: right + :width: 300 + +The last part we introduce is explicit electrostatic interactions through +particle--mesh Ewald. Enabling the electrostatic calculations is done via the +:code:`coulombtype` keyword. :code:`"PIC_Spectral"` is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the :code:`dielectric_const` keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge. + + + +.. code-block:: toml + :caption: **sds.toml** + + [simulation] + integrator = "respa" + respa_inner = 10 + n_steps = 3000 + n_print = 1500 + n_flush = + time_step = 0.01 + box_size = [8.3, 8.3, 8.3] + start_temperature = 298 + target_temperature = 298 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.1 + domain_decomposition = 10000 + cancel_com_momentum = true + max_molecule_size = 5 + thermostat_coupling_groups = [ + ["S", "C"], + ["W", "Na"], + ] + dielectric_const = 45.0 # dielectric constant for the simulation medium + coulombtype = "PIC_Spectral" # particle in cloud, spectral method + + [field] + mesh_size = [64, 64, 64] + sigma = 0.5 + chi = [ + ["S", "C", 13.50], + ["S", "Na", 0.00], + ["S", "W", -3.60], + ["C", "Na", 13.50], + ["C", "W", 33.75], + ["W", "Na", 0.00], + ] + + [bonds] + bonds = [ + ["S", "C", 0.50, 1250.0], + ["C", "C", 0.50, 1250.0], + ] + angle_bonds = [ + ["S", "C", "C", 170.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +An input structure/topology file :code:`sds.HDF5` with a couple thousand +randomly dispersed SDS chains is available in the `HyMD-tutorial/sds`_ github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a :code:`/charge` dataset. +Running the simulation with + +.. code:: bash + + python3 -m hymd sds.toml sds.HDF5 + +we observe the aggregation of the SDS into micellular structures---first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook `sds.ipynb`_. + + +.. _HyMD-tutorial/sds: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/sds +.. _sds.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/sds.ipynb diff --git a/v2.0.2/_sources/doc_pages/filtering.rst.txt b/v2.0.2/_sources/doc_pages/filtering.rst.txt new file mode 100644 index 00000000..02af68c6 --- /dev/null +++ b/v2.0.2/_sources/doc_pages/filtering.rst.txt @@ -0,0 +1,30 @@ +.. _filtering-label: + +Filtering +######### +The default grid-independent filter function used in HyMD is a Gaussian + +.. math:: + + H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] + +with reciprocal space representation + +.. math:: + + \hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +The coarse-graining parameter :math:`\sigma` determines a length scale of +particle extent and is given as configuration file input by + +.. code:: toml + + sigma = 0.75 + + +Implementing new filters +^^^^^^^^^^^^^^^^^^^^^^^^ +Implementing new filter functions is straightforward by hijacking +the :code:`setup` method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional. diff --git a/v2.0.2/_sources/doc_pages/installation.rst.txt b/v2.0.2/_sources/doc_pages/installation.rst.txt new file mode 100644 index 00000000..930d5dbc --- /dev/null +++ b/v2.0.2/_sources/doc_pages/installation.rst.txt @@ -0,0 +1,315 @@ +.. _installation-label: + +Installation +############ + +Dependencies +============ + +**Installing non-Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-openmpi-dev # Install MPI-enabled HDF5 + sudo apt-get install -y pkg-config # Install pkg-config, required for h5py install + sudo apt-get install -y curl wget + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + sudo dnf update -y + sudo dnf install -y python3.9 python3-devel # Install python3 and pip + sudo dnf install -y openmpi-devel # Install MPI development headers + sudo dnf install -y hdf5-openmpi-devel # Install MPI-enabled HDF5 + sudo dnf install -y curl wget + + + The automatic download and building of PFFT has some issues, so we + manually build FFTW and PFFT before calling :code:`pip3 install pfft-python`. + + .. code-block:: bash + + sudo dnf install -y git + sudo dnf install -y libtool + sudo dnf install -y fftw-openmpi-devel fftw-openmpi-libs + export PATH=$PATH:/usr/lib64/openmpi/bin/ # Ensure MPICC is in path + git clone https://github.com/mpip/pfft.git + cd pfft/ + ./bootstrap.sh + ./configure + make + make install + + + .. group-tab:: Mac OSX (brew) + + .. code-block:: bash + + brew update + brew install python # Install python3 and pip + brew install open-mpi # Install MPI development headers + brew install hdf5-mpi # Install MPI-enabled HDF5 + brew install pkg-config # Install pkg-config, required for h5py install + brew install curl wget + +.. warning:: + There might be memory leaks when using HyMD with OpenMPI 4.1.1. + Therefore, using a newer version of OpenMPI is recommended. + See `Issue #186 `_ for more details. + + +**Installing Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + python3 -m pip install --upgrade pip + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + python3.9 -m ensurepip --upgrade + PATH=$PATH:/usr/lib64/openmpi/bin/:/usr/lib64/openmpi/lib/ + python3.9 -m pip install mpi4py numpy cython + export HDF5_DIR="/usr/lib64/openmpi/" + CC="mpicc" HDF5_MPI="ON" python3.9 -m pip install --no-binary=h5py h5py + + .. group-tab:: Mac OSX (brew) + + Find the location of the installed :code:`hdf5-mpi` package by + + .. code-block:: bash + + find /usr -iname "*hdf5.h" + + or + + .. code-block:: bash + + brew info hdf5-mpi + + and extract the path, which will look like for example + :code:`/usr/local/Cellar/hdf5-mpi/1.13.0/`. Export it as :code:`HDF5_DIR` + + .. code-block:: bash + + python3 -m ensurepip --upgrade + export HDF5_DIR="/usr/local/Cellar/hdf5-mpi/1.13.0/" + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + + +.. warning:: + + If MPI-enabled HDF5 and :code:`h5py` can not be installed, limited support + for serial HDF5 is available. Note that having MPI-enabled file IO is + **highly recommended**, and simulation performance under serial HDF5 will + potentially be very low. + + Example dependency install on Ubuntu (apt) using serial HDF5: + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-serial-dev # Install serial HDF5 + sudo apt-get install -y curl wget + + python3 -m pip install h5py mpi4py numpy cython + + Running parallel simulations without a + MPI-enabled HDF5 library available necessitates the use of the + :code:`--disable-mpio` argument to HyMD, see :ref:`commandline-label`. Note that + due to the way HyMD is built, a working MPI compiler is required even if all + intended simulations are serial. + + +Installing HyMD +=============== +HyMD may be installed using :code:`pip` by + +.. code-block:: bash + + python3 -m pip install hymd + + + +Install in docker +================= +A docker image with build essentials setup is available at `dockerhub`_ with tag +:code:`mortele/hymd`, + +.. code-block:: bash + + docker pull mortele/hymd:latest + docker run -it mortele/hymd + /app$ python3 -m pip install hymd + + # Grab example input files + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5 + + # Run simulation + /app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose + +.. _dockerhub: + https://hub.docker.com/repository/docker/mortele/hymd + + +Run interactively in Google Colaboratory +======================================== +A `Google Colaboratory`_ jupyter notebook is setup `here`_ with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Common issues +============= + +Numpy errors while importing the Fortran force kernels +------------------------------------------------------ + +.. code-block:: python + + RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd + + Traceback (most recent call last): + + (...) + + File "/..../HyMD/hymd/__init__.py", line 2, in + from .main import main # noqa: F401 + File "/..../HyMD/hymd/main.py", line 10, in + from .configure_runtime import configure_runtime + File "/..../hymd/configure_runtime.py", line 12, in + from .input_parser import read_config_toml, parse_config_toml + File "/..../HyMD/hymd/input_parser.py", line 12, in + from .force import Bond, Angle, Dihedral, Chi + File "/..../HyMD/hymd/force.py", line 8, in + from force_kernels import ( # noqa: F401 + ImportError: numpy.core.multiarray failed to import + +can normally be fixed by updating numpy versions, + +.. code-block:: bash + + python3 -m pip install -U numpy + + +Error building pfft-python due to missing curl/wget +--------------------------------------------------- + +.. code-block:: python + + Building wheel for pfft-python (setup.py) ... error + ERROR: Command errored out with exit status 1: + command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_ + cwd: /tmp/pip-install-fr6nt9m4/pfft-python/ + Complete output (56 lines): + running bdist_wheel + running build + running build_py + + (...) + + curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found + wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found + Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + Please check curl or wget + You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ + Traceback (most recent call last): + File "", line 1, in + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in + setup( + File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup + return distutils.core.setup(**attrs) + File "/usr/lib/python3.8/distutils/core.py", line 148, in setup + + (...) + + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions + build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:])) + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft + raise ValueError("could not build fftw; check MPICC?") + ValueError: could not build fftw; check MPICC? + ---------------------------------------- + ERROR: Failed building wheel for pfft-python + Running setup.py clean for pfft-python + Failed to build pfft-python + +can be fixed by installing either `curl`_ or `wget`_ + +.. code-block:: bash + + apt-get install -y curl wget + + +.. _`curl`: + https://curl.se/ + +.. _`wget`: + https://www.gnu.org/software/wget/ + + +Error running parallel HyMD without MPI-enabled h5py +---------------------------------------------------- + +.. code-block:: python + + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + main() + File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main + with h5py.File(args.input, "r", **_kwargs) as in_file: + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__ + with h5py.File(args.input, "r", **_kwargs) as in_file: + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + raise ValueError("h5py was built without MPI support, can't use mpio driver") + ValueError: h5py was built without MPI support, can't use mpio driver + +Can be fixed by installing a MPI-enabled :code:`h5py` through + +.. code-block:: bash + + python3 -m pip uninstall -y h5py + HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py diff --git a/v2.0.2/_sources/doc_pages/interaction_energy_functionals.rst.txt b/v2.0.2/_sources/doc_pages/interaction_energy_functionals.rst.txt new file mode 100644 index 00000000..f33c004e --- /dev/null +++ b/v2.0.2/_sources/doc_pages/interaction_energy_functionals.rst.txt @@ -0,0 +1,98 @@ +.. _functionals-label: + +Interaction energy functionals +############################## +A few interaction energy functionals :math:`W` are defined in HyMD through +the :code:`Hamiltonian` class and associated subclasses. + +:math:`\chi`--interaction and :math:`\kappa`--incompressibility +=============================================================== +The most common hPF energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultWithChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where :math:`\tilde\chi_{\text{A}-\text{B}}` is the interaction energy between +overlapping densities of particle types :math:`\text{A}` and :math:`\text{B}`. +The incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\tilde\chi` +and :math:`\kappa` in the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + chi = [ + ["A", "B", 15.85], + ["B", "C", -5.70], + ... + ] + +Only :math:`\kappa`--incompressibility +====================================== +The only :math:`\kappa` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultNoChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where the incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Only :math:`\phi^2` +=================== +The :math:`\phi^2` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "SquaredPhi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2, + +where the :math:`\phi` squared term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Implementing new interaction energy forms +========================================= +Implementing new interaction energy functions is straightforward by subclassing +:code:`Hamiltonian` and applying :code:`sympy` differentiation to the symbolic +field objects. The :code:`sympy.lamdify` function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields. diff --git a/v2.0.2/_sources/doc_pages/intramolecular_bonds.rst.txt b/v2.0.2/_sources/doc_pages/intramolecular_bonds.rst.txt new file mode 100644 index 00000000..820e81bc --- /dev/null +++ b/v2.0.2/_sources/doc_pages/intramolecular_bonds.rst.txt @@ -0,0 +1,142 @@ +.. _bonds-label: + +Intramolecular bonds +#################### + +Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see :ref:`config-label`. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +:ref:`benchmarks-label`), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable. + +All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]). + + +Two-particle bonds +^^^^^^^^^^^^^^^^^^ +Stretching bonds in HyMD are implemented as harmonic spring potentials, + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2, + +where :math:`r=|\mathbf{r}|` is the inter-particle distance, :math:`k` is a +constant of dimension energy (units :math:`\text{kJ}\,\text{mol}^{-1}`), and +:math:`r_0` is the equilibrum length of the bond (units: :math:`\text{nm}`). The +force is calculated as + +.. math:: + + F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r}, + +where :math:`\mathbf{r}` is the vector pointing *from* :math:`i` *to* :math:`j`. + +In the configuration file, two-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_two_particle_example.toml + + [bonds] + bonds = [ + ["A", "A", 0.47, 1250.0], + ["A", "B", 0.37, 940.0], + ["B", "C", 0.50, 1010.0], + ["C", "A", 0.42, 550.0], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Three-particle bonds +^^^^^^^^^^^^^^^^^^^^ +Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle--particle--particle angle :math:`\theta`, + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2, + +where :math:`k` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}`), and :math:`\theta_0` is the equilibrum +angle of the bond (units: :math:`{}^\circ`). Defining the particles with labels +:math:`a`, :math:`b`, and :math:`c`, let :math:`\mathbf{r}_a` denote the vector +pointing from :math:`b` to :math:`a`, and correspondingly let +:math:`\mathbf{r}_c` point from :math:`b` to :math:`c`. The +:math:`a`--:math:`b`--:math:`c` may be computed through the law of Cosines, + +.. math:: + + \theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right] + +Then the force acting on :math:`a` and :math:`c` is + +.. math:: + + \mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a}, + + \mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c}, + +and + +.. math:: + + \mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c + +In the configuration file, three-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_three_particle_example.toml + + [bonds] + angle_bonds = [ + ["A", "A", "A", 180.0, 90.0], + ["A", "B", "A", 120.0, 55.0], + ["B", "C", "C", 30.0, 10.0], + ["C", "A", "B", 110.0, 25.5], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Four-particle bonds +^^^^^^^^^^^^^^^^^^^ +Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle :math:`\phi` between the +:math:`a`--:math:`b`--:math:`c` and :math:`b`--:math:`c`--:math:`d` planes, for +a dihedral bond quartet :math:`a`, :math:`b`, :math:`c`, and :math:`d`. The +potential takes the form + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n), + +where :math:`c_n` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`), and :math:`\phi_n` are +specified phase angles in the cosine series. + +In the configuration file, four-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_four_particle_example.toml + + [bonds] + dihedrals = [ + ["A", "B", "C", "D"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0], + ] diff --git a/v2.0.2/_sources/doc_pages/overview.rst.txt b/v2.0.2/_sources/doc_pages/overview.rst.txt new file mode 100644 index 00000000..0e4d6b65 --- /dev/null +++ b/v2.0.2/_sources/doc_pages/overview.rst.txt @@ -0,0 +1,166 @@ +.. _overview-label: + +================================ + Usage overview for HylleraasMD +================================ + +HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a `toml`_ format configuration file, along with a topology and structure +file specifying the input system in HDF5 format. + +.. _`toml`: + https://github.com/toml-lang/toml + +**Configuration file** + +The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a :code:`[5, 5, 5]` nm simulation box at 300 K may look like +the following: + +.. code-block:: toml + :caption: **config_simple_1.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "SquaredPhi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [30, 30, 30] # FFT grid size + sigma = 0.5 # filtering length scale in nm + +Note that for the version 1.0 release of HyMD, the :code:`[particles]`, +:code:`[simulation]`, and :code:`[field]` groups are optional specifiers for +structuring the configuration file. + +For a full specification of every recognised configuration keyword in HyMD, +please refer to :ref:`config-label`. + +**Topology and structure file** + +The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +:code:`N` particles may look like the following: + +.. code-block:: bash + :caption: **example_structure.HDF5** + + group / + # root group + + dataset /coordinates + # float32, shape (T, N, D,) + # Time steps of N rows of D dimensional coordinate data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /velocities + # float32, shape (T, N, D,) OPTIONAL + # Time steps of N rows of D dimensional velocity data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /bonds + # int32, shape (N, B,) OPTIONAL + # Each row i contains indices of the particles bonds from/to i + # B denotes the maximum bonds per particle + + dataset /indices + # int32, shape (N,) + # Index of each particle, 0--(N-1) + + dataset /molecules + # int32, shape (N,) + # Index of molecule each particle belongs to + # Used to construct bond network locally on MPI ranks + + dataset /names + # str10, shape (N,) + # Fixed size string array containing particle type names + + dataset /types + # int32, shape (N,) OPTIONAL + # Mapping of particle names to type indices + + +For a full specification of the topology and structure input file, see +:ref:`topology-label`. + +**Command line arguments** + +A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the :code:`config_simple_1.toml` and :code:`example_structure.HDF5` +files may look like the following: + +.. code-block:: bash + + mpirun -n ${MPI_NUM_RANKS} python3 -m hymd \ # HyMD executable + config_simple_1.toml \ # configuration file + example_structure.HDF5 \ # structure file + --logfile=log_out.txt \ # set logfile path + --seed 123456 \ # set random seed + --verbose 2 \ # set logging verbosity + --velocity-output # enable velocity in trajectory output + +For a full specification of all command line arguments, see +:ref:`commandline-label`. + +**More examples** + +For more thorough rundown and concrete usage examples, see +:ref:`examples-label`. + +Running parallel simulations +============================ +Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the **only** difference being how the python3 interpreter is +invoked. Prepending :code:`mpirun -n ${NPROCS}` to the usual +:code:`python3 -m hymd` runs the simulation with :code:`${NPROCS}` MPI ranks. + +Inputting + +.. code:: bash + + mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field + +sets up an example simulation of the `HyMD-tutorial/ideal_gas`_ system. For +more details about this system in particular, or other example simulations, see +the `HyMD-tutorial`_ repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas + + +Running tests +============= +Run serial code tests by + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd + cd hymd/ + python3 -m pip install pytest pytest-mpi + python3 -m pytest + +There is a small convenience script in :code:`hymd/` for running the MPI-enabled +tests, + +.. code-block:: bash + + chmod +x pytest-mpi + ./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no diff --git a/v2.0.2/_sources/doc_pages/pressure.rst.txt b/v2.0.2/_sources/doc_pages/pressure.rst.txt new file mode 100644 index 00000000..be9c7cda --- /dev/null +++ b/v2.0.2/_sources/doc_pages/pressure.rst.txt @@ -0,0 +1,37 @@ +.. _pressure-label: + +Pressure +######## +Internal pressure is calculated from internal energy according to + +.. math:: + + P_a = \frac{1}{\mathcal{V}} \left( 2T_a - \text{Vir}_a \right) \\ + \text{Vir}_a = L_a \frac{\partial \mathcal{U}}{\partial L_a} \\ + \mathcal{U} = \sum_{i=1}^M \mathcal{U}_0( \{ \mathbf{r}\}_i ) + W[\{ \tilde\phi \} ] + +where +:math:`\mathcal{V}` is the simulation volume, +:math:`{T_a}` is the kinetic energy +and :math:`L_a` the length of the box in the Cartesian direction :math:`a`, +Vir is the virial of the total interaction energy :math:`\mathcal{U}`. + +:math:`\mathcal{U}` comprises intramolecular bonded terms :math:`\mathcal{U}_0` (see :ref:`bonds-label` for details), +and field terms :math:`W[\{ \tilde\phi \} ]` (see :ref:`theory-label` for details). + +Using the above expressions, the following form for internal pressure is obtained: + +.. math:: + + P_a = \frac{2 T_a}{\mathcal{V}} -\frac{L_a}{\mathcal{V}} \sum_{i=1}^N \frac{\partial \mathcal{U}_{0i}}{\partial L_a} + P^{(3)}_a \\ + +.. P^{(3)}_a = - \frac{L_a}{\mathcal{V}} \frac{\partial W[\{ \tilde\phi \} ]}{\partial L_a} \\ + +.. math:: + + P^{(3)}_a = \frac{1}{\mathcal{V}}\left ( -W[\{ \tilde\phi(\mathbf{r}) \}] + \int \sum_t \bar{V}_t(\mathbf{r})\tilde\phi_t(\mathbf{r})d\mathbf{r} + + \int \sum_t \sigma^2\bar{V}_t(\mathbf{r})\nabla_a^2\tilde\phi_t(\mathbf{r}) d\mathbf{r} \right) + +where :math:`\bar{V}_t(\mathbf{r}) = \frac{\partial w(\{\tilde\phi\})}{\partial\tilde\phi_t}` +and :math:`σ` is a coarse-graining parameter (see :ref:`filtering-label` for details). +Note that the above expression is obtained for a Gaussian filter which is the most natural choice in HhPF theory. diff --git a/v2.0.2/_sources/doc_pages/theory.rst.txt b/v2.0.2/_sources/doc_pages/theory.rst.txt new file mode 100644 index 00000000..2429bc0d --- /dev/null +++ b/v2.0.2/_sources/doc_pages/theory.rst.txt @@ -0,0 +1,122 @@ +.. _theory-label: + +Theory +###### +Hybrid particle--field simulations switch out the ordinary particle--particle +`Lennard-Jones`_ interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle--field densities are +defined as + +.. math:: + + \phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i), + +where :math:`\mathbf{r}` is a spatial coordinate, :math:`P` is a window function +used to distribute particle number densities onto a computational grid, and +:math:`\mathbf{r}_i` is the position of particle :math:`i` (of total :math:`N`). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of :math:`N` particles in :math:`M` molecules is + +.. math:: + + \mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})] + +with :math:`H_0` being a standard intramolecular Hamiltonian form (see +:ref:`bonds-label`) including kinetic terms, while :math:`W` is a density +dependent *interaction energy functional*. + +In the Hamiltonian hPF-MD formalism :cite:`bore2020hamiltonian`, the density +field is filtered using a grid-independent filtering function :math:`H`, + +.. math:: + + \tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}). + +The filter smooths the density, ensuring that :math:`\tilde\phi` and +:math:`W[\tilde\phi([\phi])]` both converge as the grid size is reduced. + +External potential +================== +The external potential acting on a particle is defined as the functional +derivative of :math:`W` with respect to :math:`\phi`. In the filtered formalism, +the potential takes the form + +.. math:: + + V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ + &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})}, + +under the assumption of a *local* form of the interaction energy functional, +:math:`W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]`. Note +that + +.. math:: + + \frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}). + +Force interpolation +=================== +The forces on particle :math:`i` are obtained by differentiation of the external +potential, + +.. math:: + + \mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i). + + +Reciprocal space calculations +============================= +The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density :math:`\phi_{ijk}` with CIC, we apply the filtering +and obtain the discrete version of the external potential by + +.. math:: + + \tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big] + +and + +.. math:: + + V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +The forces are obtained by differentiation of :math:`V` in Fourier space as + +.. math:: + + \nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +Filter +====== +By default, the filter used in HyMD is a simple Gaussian of the form + +.. math:: + + H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ + \hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +For more details about the filtering, see :ref:`filtering-label`. + +Hamiltonian form +================ +The default form of the interaction energy functional in HyMD is + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2. + +In the case of constant pressure simulations (NPT), the interaction energy functional becomes + +.. math:: + + W=\frac{1}{2\rho_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-a\right)^2. + +where, :math:`\rho_0= 1 / ν` is an intrinsic parameter corresponding to the specific volume :math:`(ν)` of a coarse-grained particle, +:math:`a` is a calibrated parameter to obtain the correct average density at the target temperature and pressure. +See :ref:`functionals-label` for details. + + +.. _`Lennard-Jones`: + https://en.wikipedia.org/wiki/Lennard-Jones_potential diff --git a/v2.0.2/_sources/doc_pages/topology_input.rst.txt b/v2.0.2/_sources/doc_pages/topology_input.rst.txt new file mode 100644 index 00000000..02faa501 --- /dev/null +++ b/v2.0.2/_sources/doc_pages/topology_input.rst.txt @@ -0,0 +1,84 @@ +.. _topology-label: + +============================ +Topology and structure file +============================ +The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root :code:`/` group. + +The `HyMD-tutorial`_ has multiple examples of structure files for various levels +of complexity. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Required datasets +================= +:/coordinates: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/indices: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/names: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`string` (:code:`length` between :code:`1` and :code:`16`)] + + The shape represents one particle name per :code:`N` particles. The datatype may be a string of length :code:`=<16`. + + + +Optional datasets +================= +:/velocities: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/types: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle type index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/molecules: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one molecule index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/bonds: + :code:`array` shape [:code:`N`, :code:`B`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents :code:`B` bond specifications (indices of different particles) per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/charge: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents one particle charge per :code:`N` particles. The data type may be either four or eight byte reals. + +:/box: + :code:`array` shape [:code:`3`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents the initial box dimensions in Cartesian coordinates. diff --git a/v2.0.2/_sources/index.rst.txt b/v2.0.2/_sources/index.rst.txt new file mode 100644 index 00000000..6afdbf7a --- /dev/null +++ b/v2.0.2/_sources/index.rst.txt @@ -0,0 +1,162 @@ +.. hymd documentation master file, created by + sphinx-quickstart on Thu Dec 16 13:31:43 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +############################### +HylleraasMD documentation +############################### + +:Release: + |release| +:Date: + |today| + +**HylleraasMD** (HyMD) is a massively parallel Python package for Hamiltonian hybrid +particle-field molecular dynamics (HhPF-MD) simulations of coarse-grained bio- +and soft-matter systems. + +HyMD can run canonical hPF-MD simulations, or filtered density HhPF-MD simulations :cite:`hymd_domain2023,hymd_massive2023,hymd_pressure2023,hymd_alias2020` +with or without explicit PME electrostatic interactions. It includes all standard intramolecular interactions, +including stretching, bending, torsional, and combined bending-dihedral potentials. Additionally, topological reconstruction of permanent peptide chain backbone +dipoles is possible for accurate recreation of protein conformational dynamics. It can run simulations in constant energy (NVE), constant volume (NVT) :cite:`hymd_domain2023,hymd_massive2023` +or constant pressure (NPT) conditions :cite:`hymd_pressure2023`. + +HyMD uses the pmesh library for particle-mesh operations, with the PPFT :cite:`pippig2013` backend for FFTs through the pfft-python bindings. +File IO is done via HDF5 formats to allow MPI parallel reads. + +User Guide +========== +The HylleraasMD :doc:`User Guide ` provides comprehensive information on how to run +simulations. Selected :doc:`Examples ` are available to guide new users. + +.. _`github.com/rainwoodman/pmesh`: + https://github.com/rainwoodman/pmesh +.. _`github.com/rainwoodman/pfft-python`: + https://github.com/rainwoodman/pfft-python + +Installing HyMD +=============== +The easiest approach is to install using pip_: + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + +For more information and **required dependencies**, see +:ref:`installation-label`. + +.. _pip: + http://www.pip-installer.org/en/latest/index.html + + +Run in Google colab +------------------- +Run HyMD interactively in `Google Colaboratory`_ jupyter notebook `here`_. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Source Code +=========== +**Source code** is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the `GNU Lesser General Public +License v3.0`_. Obtain the source code with `git`_: + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git + +.. _GNU Lesser General Public License v3.0: + https://www.gnu.org/licenses/lgpl-3.0.html +.. _git: + https://git-scm.com/ + + +Development +=========== +HyMD is developed and maintained by researchers at the `Hylleraas Centre for +Quantum Molecular Sciences`_ at the `University of Oslo`_. + +|pic1| |pic2| + +.. _`Hylleraas Centre for Quantum Molecular Sciences`: + https://www.mn.uio.no/hylleraas/english/ +.. _`University of Oslo`: + https://www.uio.no/ + +.. |pic1| image:: img/hylleraas_centre_logo_black.png + :target: img/hylleraas_centre_logo_black.png + :width: 250 px + +.. |pic2| image:: img/uio_full_logo_eng_pos.png + :target: img/uio_full_logo_eng_pos.png + :width: 325 px + + + +References +========== +.. bibliography:: + :all: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. Contents +.. ======== + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Getting started + + ./doc_pages/installation + ./doc_pages/overview + ./doc_pages/config_file + ./doc_pages/topology_input + ./doc_pages/command_line + ./doc_pages/constants_and_units + + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Examples + + ./doc_pages/examples + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Theory + + ./doc_pages/theory + ./doc_pages/intramolecular_bonds + ./doc_pages/electrostatics + ./doc_pages/pressure + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Developer documentation + + ./doc_pages/interaction_energy_functionals + ./doc_pages/filtering + ./doc_pages/benchmarks + ./doc_pages/api diff --git a/v2.0.2/_static/basic.css b/v2.0.2/_static/basic.css new file mode 100644 index 00000000..be19270e --- /dev/null +++ b/v2.0.2/_static/basic.css @@ -0,0 +1,856 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/v2.0.2/_static/css/badge_only.css b/v2.0.2/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/v2.0.2/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/v2.0.2/_static/css/fonts/Roboto-Slab-Bold.woff b/v2.0.2/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/v2.0.2/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/v2.0.2/_static/css/fonts/Roboto-Slab-Bold.woff2 b/v2.0.2/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/v2.0.2/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/v2.0.2/_static/css/fonts/Roboto-Slab-Regular.woff b/v2.0.2/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/v2.0.2/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/v2.0.2/_static/css/fonts/Roboto-Slab-Regular.woff2 b/v2.0.2/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/v2.0.2/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/v2.0.2/_static/css/fonts/fontawesome-webfont.eot b/v2.0.2/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/v2.0.2/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/v2.0.2/_static/css/fonts/fontawesome-webfont.svg b/v2.0.2/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/v2.0.2/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v2.0.2/_static/css/fonts/fontawesome-webfont.ttf b/v2.0.2/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/v2.0.2/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/v2.0.2/_static/css/fonts/fontawesome-webfont.woff b/v2.0.2/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/v2.0.2/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/v2.0.2/_static/css/fonts/fontawesome-webfont.woff2 b/v2.0.2/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/v2.0.2/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/v2.0.2/_static/css/fonts/lato-bold-italic.woff b/v2.0.2/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/v2.0.2/_static/css/fonts/lato-bold-italic.woff differ diff --git a/v2.0.2/_static/css/fonts/lato-bold-italic.woff2 b/v2.0.2/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/v2.0.2/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/v2.0.2/_static/css/fonts/lato-bold.woff b/v2.0.2/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/v2.0.2/_static/css/fonts/lato-bold.woff differ diff --git a/v2.0.2/_static/css/fonts/lato-bold.woff2 b/v2.0.2/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/v2.0.2/_static/css/fonts/lato-bold.woff2 differ diff --git a/v2.0.2/_static/css/fonts/lato-normal-italic.woff b/v2.0.2/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/v2.0.2/_static/css/fonts/lato-normal-italic.woff differ diff --git a/v2.0.2/_static/css/fonts/lato-normal-italic.woff2 b/v2.0.2/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/v2.0.2/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/v2.0.2/_static/css/fonts/lato-normal.woff b/v2.0.2/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/v2.0.2/_static/css/fonts/lato-normal.woff differ diff --git a/v2.0.2/_static/css/fonts/lato-normal.woff2 b/v2.0.2/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/v2.0.2/_static/css/fonts/lato-normal.woff2 differ diff --git a/v2.0.2/_static/css/theme.css b/v2.0.2/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/v2.0.2/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/v2.0.2/_static/custom.css b/v2.0.2/_static/custom.css new file mode 100644 index 00000000..b20d6282 --- /dev/null +++ b/v2.0.2/_static/custom.css @@ -0,0 +1,91 @@ + +body{ + background: #FFFFFF !important; +} + +.wy-menu-vertical header, .wy-menu-vertical p.caption{ + color: #4EA0AF!important; +} +.wy-menu-vertical li.current{ + background-color: #f4f4f4!important; +} +.wy-menu-vertical li.toctree-l2.current>a{ + background-color: #ebebeb!important; +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{ + background-color: #e3e3e3!important; +} + +.rst-content .sidebar{ + background-color: #fff!important; + border-radius: 6px; + -moz-border-radius: 6px; + -webkit-border-radius: 6px; +} + +h1 > a, h2 > a, h3 > a, h4 > a, h5 > a, h6 > a { + color: #17d9ff; +} + +h1, h2, h3, h4, h5, h6 { + color: black; + font-weight: normal; + padding: 0; +} + +h1, h2, h3 { + margin-top: 30px; + margin-bottom: 20px; +} + +h1 { + color: white; + padding: 20px 20px 20px 45px; + margin: 20px 0 35px -45px; + background: linear-gradient(to left, #fff, #2b38ff)!important; + + width: calc(100% + 90px); + border-bottom: 3px solid #000; +} + +h2 { + padding: .2em 0; + border-bottom: 1px solid #ddd; +} + +h3 { + margin-top: 35px; +} + +h4 { + margin-top: 30px; +} + +h5 { + margin-top: 25px; +} + +.wy-nav-content{ + max-width: none!important; +} + +.wy-side-nav-search{ + background: #2b38ff!important; +} + +.wy-side-nav-search input[type=text]{ + border-color:#4DA0B0!important; +} + +.wy-side-nav-search input[type=text]{ + border-radius: 4px!important; +} + +#caption-api { + background: red !important; +} + +#caption-text-api { + text-color: blue !important; +} diff --git a/v2.0.2/_static/doctools.js b/v2.0.2/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/v2.0.2/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/v2.0.2/_static/documentation_options.js b/v2.0.2/_static/documentation_options.js new file mode 100644 index 00000000..cce035de --- /dev/null +++ b/v2.0.2/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '2.0.2', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/v2.0.2/_static/file.png b/v2.0.2/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/v2.0.2/_static/file.png differ diff --git a/v2.0.2/_static/hymd_icon_white.png b/v2.0.2/_static/hymd_icon_white.png new file mode 100644 index 00000000..d0396a17 Binary files /dev/null and b/v2.0.2/_static/hymd_icon_white.png differ diff --git a/v2.0.2/_static/hymd_logl_white_text_abbr.png b/v2.0.2/_static/hymd_logl_white_text_abbr.png new file mode 100644 index 00000000..8c0e50c8 Binary files /dev/null and b/v2.0.2/_static/hymd_logl_white_text_abbr.png differ diff --git a/v2.0.2/_static/jquery-3.5.1.js b/v2.0.2/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/v2.0.2/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. API reference

+
+

4.1. Integrator

+

Integrates equations of motion.

+

Implements the Velocity Verlet integrator. The reversible reference system +propagator algorithm (rRESPA) integrator uses the Velocity Verlet functions +inside the MD loop in the main module.

+
+
+hymd.integrator.integrate_position(positions, velocities, time_step)[source]
+

Position update step of the Velocity Verlet integration algorithm.

+

Computes the position update step of the Velocity Verlet algorithm. The +positions argument is not changed in place.

+
+
Parameters:
+
+
positions(N, D) numpy.ndarray

Array of positions of N particles in D dimensions.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_velocity

The velocity update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step, then the positions are updated a full step using the updated +velocities

+
+\[\mathbf{x}_{\text{new}} = \mathbf{x} + \Delta t \mathbf{v}\]
+
+ +
+
+hymd.integrator.integrate_velocity(velocities, accelerations, time_step)[source]
+

Velocity update step of the Velocity Verlet integration algorithm.

+

Computes the velocity update step of the Velocity Verlet algorithm. The +velocities argument is not changed in place.

+
+
Parameters:
+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
accelerations(N, D) numpy.ndarray

Array of accelerations of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_position

The position update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step

+
+\[\mathbf{v}_{\text{new}} = \mathbf{v} + \frac{\Delta t}{2m} +\mathbf{f}\]
+

before the positions are moved a full step using the updated half-step +velocities.

+
+ +
+
+

4.2. Thermostat

+

Scales or otherwise modifies the particle velocities during simulation to +simulate coupling to an external heat bath with temperature T₀.

+
+
+hymd.thermostat._random_chi_squared(prng: numpy.random._generator.Generator, M: int)float[source]
+

Draw the sum of M squared normally distributed values

+

The value is generated by the Gamma distribution, in lieu of generating +M Gaussian distributed numbers and summing their squares.

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
Mint

Number of standard normally distributed numbers in the sum.

+
+
+
+
Returns:
+
+
float

The sum of M squared normally distributed values centered at +zero with unit standard deviation.

+
+
+
+
+

Notes

+

The sum of the squares of k independent standard normal random variables is +distributed according to a \(\chi^2\) distribution.

+
+\[\chi^2_1 + \chi_2^2 + \chi_3^2 + \dots + \chi_M^2 +\sim +\sigma^2\chi^2(k)\]
+

This is a special case of the \(\Gamma\) distribution, +\(\Gamma(k/2, 2)\), and may be generated by

+
+\[\chi^2(k) \sim 2 \Gamma(k/2, 2)\]
+

References

+

Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of +Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. +J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246.

+
+ +
+
+hymd.thermostat._random_gaussian(prng: numpy.random._generator.Generator)float[source]
+

Draw a single random number from the standard normal distribution +Generate a number from the Gaussian distribution centered at zero with unit +standard deviation, \(N(0, 1)\).

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
+
+
Returns:
+
+
float

A random number drawn from \(N(0, 1)\).

+
+
+
+
+
+ +
+
+hymd.thermostat.csvr_thermostat(velocity: numpy.ndarray, names: numpy.ndarray, config: hymd.input_parser.Config, prng: numpy.random._generator.Generator, comm: mpi4py.MPI.Intracomm = <mpi4py.MPI.Intracomm object>, random_gaussian: Callable[[numpy.random._generator.Generator], float] = <function _random_gaussian>, random_chi_squared: Callable[[numpy.random._generator.Generator, int, float], float] = <function _random_chi_squared>, remove_center_of_mass_momentum: bool = True)numpy.ndarray[source]
+

Canonical sampling through velocity rescaling thermostat

+

Implements the CSVR thermostat. Rescales the system kinetic energy by a +stochastically chosen factor to keep the temperature constant. Requires +communcation of the kinetic energies calculated locally for each MPI rank. +The random numbers sampled through random_gaussian and +random_chi_squared are broadcast from the root rank to the other +ranks to ensure the scaling is performed with the same stochasticity for +all particles in the full system.

+

The velocities are cleaned of center of mass momentum before the thermostat +is applied, and the center of mass momentum is subsequently reapplied. This +is performed for each thermostat coupling group, i.e. the center of mass +momenta of each group is separately removed and reapplied after +thermostatting.

+

The implementation here is based on the derivation presented in the 2008 +Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper.

+
+
Parameters:
+
+
velocity(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
names(N,) numpy.ndarray

Array of particle names.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
random_gaussiancallable, optional

Function for generating standard normally distributed numbers.

+
+
random_chi_squaredcallable, optional

Function for generating \(\chi^2\)-distributed numbers

+
+
remove_center_of_mass_momentumbool, optional

If True, the center of mass of each coupling group is removed before +the thermostat is applied. The center of mass momenta are added back +after the kinetic energy rescaling is complete.

+
+
+
+
+
+

See also

+
+
_random_gaussian

Used to sample Gaussian-distributed numbers.

+
+
_random_chi_squared

Used to sample \(\chi^2\)-distributed numbers.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +

References

+

G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). +G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008).

+
+ +
+
+

4.3. Barostat

+
+

4.3.1. Berendsen Barostat

+

Implements the Berendsen barostat. +Scales the box and particle positions during simulation to +simulate coupling to an external pressure bath set at a +target pressure.

+

It calculates the scaling factor according to: +.. math:

+
\alpha_{L,N} = 1 - \frac{dt n_b}{\tau_p}\β(P_{L,N}^t - P_{L,N})
+
+
+

where \(dt\) is the outer rRESPA time-step, \(n_b\) is the frequency +of barostat calls, \(\tau_p\) is the pressure coupling time constant, +\(\beta\) is the isothermal compressibility, \(P_{L,N}^t\) and +\(P_{L,N}\) is the target and instantaneous internal pressure in the +lateral (L) and normal (N) directions respectively. Convention: Cartesian +z-direction is considered normal.

+

The box and particle positions are scaled in the L and N directions according +to the nature of the barostat (see functions isotropic and semiisotropic +below by an amount \(\α^{\frac{1}{3}}\).

+

The updated system information is passed on to the pmesh objects.

+
+

4.3.1.1. References

+

H. J. C. Berendsen, J. P. M. Postma, W. F. van Gunsteren, +A. DiNola, and J. R. Haak , “Molecular dynamics with coupling +to an external bath”, J. Chem. Phys. 81, 3684-3690 (1984)

+
+
+hymd.barostat.isotropic(pmesh, pm_stuff, phi, phi_q, psi, hamiltonian, positions, velocities, config, phi_fft, phi_laplacian, phi_transfer, bond_pr, angle_pr, step, prng, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Implements an isotropic Berendsen barostat. +The box and particle positions are scaled uniformly +in the L and N directions.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of pmesh objects.

+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fftlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds.

+
+
stepinteger

MD step number

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of modified/unmodified pmesh objects.

+
+
changeBoolean

Indicates whether or not any pmesh objects were reinitialized.

+
+
+
+
+
+ +
+
+hymd.barostat.semiisotropic(pmesh, pm_stuff, phi, phi_q, psi, hamiltonian, positions, velocities, config, phi_fft, phi_laplacian, phi_transfer, bond_pr, angle_pr, step, prng, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Implements a semiisotropic Berendsen barostat. +The box and particle positions are scaled by \(\alpha_L^{\frac{1}{3}}\) +in the L direction and by \(\alpha_N^{\frac{1}{3}}\) in the N direction.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of pmesh objects.

+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fftlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds.

+
+
stepinteger

MD step number

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of modified/unmodified pmesh objects.

+
+
changeBoolean

Indicates whether or not any pmesh objects were reinitialized.

+
+
+
+
+
+ +
+
+
+

4.3.2. SCR Barostat

+
+
+
+

4.4. Hamiltonian

+
+
+class hymd.hamiltonian.Hamiltonian(config)[source]
+

Interaction energy functional superclass

+
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+_setup()[source]
+

Superclass setup

+

Sets up the grid-independent filtering function H, and the +SymPy logic for symbolically differentiating interaction energy +functionals in Hamiltonian subclasses.

+
+ +
+ +
+
+class hymd.hamiltonian.SquaredPhi(config)[source]
+

Simple squared density interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + \sum_k \tilde\phi_k + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(rho_0\) is the +average density of the fully homogenous system. Expressing the species +densities in terms of fluctuations from the average,

+
+\[\mathrm{d}\tilde\phi_k = \rho_0 - \tilde\phi_k,\]
+

it is evident that this interaction energy functional is a slight change of +the DefaultNoChi Hamiltonian, as the expanded interaction energy +density becomes

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + 6\rho_0\left[ + \sum_k \mathrm{d}\tilde\phi_k + \right] + + + 9\rho_0^2 + + + \sum_k \mathrm{d}\tilde\phi_k^2 + + + \prod_{k\not=l} + \mathrm{d}\tilde\phi_k \mathrm{d}\tilde\phi_l + \right),\]
+

identical to DefaultNoChi apart from a constant energy shift +\(9\rho_0^2`(which does not impact dynamics) and the +:math:\)rho_0`–\(\mathrm{d}\tilde\phi_k\) cross-terms. These +cross-terms constitute contributions to the energy linear in +\(\mathrm{d}\tilde\phi_k\) absent in DefaultNoChi, which has +only quadratic terms present.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultNoChi(config)[source]
+

Incompressibility-only interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a +\right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. The SquaredPhi Hamiltonian implements a similar +functional with an additional linear term component depending on

+
+\[\mathmr{d}\tilde\phi_k = \tilde\phi_k - \rho_0\]
+

and not \(\mathrm{d}\tilde\phi_k^2\). No explicit inter-species +interaction is present apart from the indirect interaction through the +incompressibility.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultWithChi(config, unique_names, type_to_name_map)[source]
+

Incompressibility and \(\chi\)-interactions energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = + \frac{1}{2\rho_0} + \sum_{k,l}\chi_{kl} \tilde\phi_k \tilde\phi_l + + + \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. \(\chi_{ij}\) is the Flory-Huggins-like +inter-species mixing energy.

+
+
+__init__(config, unique_names, type_to_name_map)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup(unique_names, type_to_name_map)[source]
+

Setup the interaction energy potential and the external potential

+
+
Parameters:
+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+ +
+ +
+
+

4.5. Force

+

Calculates intramolecular forces between bonded particles in molecules

+
+
+class hymd.force.Angle(atom_1: str, atom_2: str, equilibrium: float, strength: float, atom_3: str)[source]
+

Dataclass representing a single three-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any three-particle bond between particles of specific types A, +B, and C (where A, B, and C may be +different or the same). Harmonic angular three-particle bonds in HyMD take +the form

+
+\[V_3(\mathbf{r}_1, \mathbf{r}_2, \mathbf{r}_3) = + \frac{1}{2}k + \left( + \cos^{-1} + \left[ + \frac{ + (\mathbf{r}_1-\mathbf{r}_2) + \cdot + (\mathbf{r}_3-\mathbf{r}_2) + } + { + \vert\mathbf{r}_1-\mathbf{r}_2\vert + \vert\mathbf{r}_3-\mathbf{r}_2\vert + } + \right] - \theta_0 + \right)^2\]
+
+

See also

+
+
Bond

Two-particle bond type dataclass

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
equilibriumfloat

Equilibrium angle at which the energy associated with the +three-particle angular bond vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient.

+
+
+
+
+
+
+atom_3: str
+
+ +
+ +
+
+class hymd.force.Bond(atom_1: str, atom_2: str, equilibrium: float, strength: float)[source]
+

Dataclass representing a single two-particle bond type

+

A bond type is a bond strength and equilibrium distance associated with +any bond between particles of specific types A and B +(where A and B may be the same or different). Harmonic +two-particle bonds in HyMD take the form

+
+\[V_2(\mathbf{r}_1, \mathbf{r}_2) = + \frac{1}{2}k + \left( + \vert \mathbf{r}_1 - \mathbf{r}_2 \vert - r_0 + \right)^2,\]
+

where \(k\) is the bond strength (spring constant) and \(r_0\) is +the equilibrium bond length (at which the energy is zero).

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
equilibriumfloat

Equilibrium distance at which the energy associated with the bond +vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient (spring constant).

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+equilibrium: float
+
+ +
+
+strength: float
+
+ +
+ +
+
+class hymd.force.Chi(atom_1: str, atom_2: str, interaction_energy: float)[source]
+

Dataclass representing a single \(\chi\) mixing interaction type

+

An interaction mixing energy type is a mixing energy associated with +density overlap between species of types A and B +(specified as inputs atom_1 and atom_2). A positive mixing +energy promotes phase separation, a negative mixing energy promotes mixing. +The interaction energy density (provided the DefaultWithChi +Hamiltonian is used) takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} + \sum_{k,l}\chi_{k,l} \tilde\phi_k\tilde\phi_l,\]
+

where \(\chi_{k,l}\) denotes the mixing energy between species +\(k\) and \(l\), with \(\kappa\) being the incompressibility. +The value of the interaction mixing energy parameter may be extracted from +Flory-Huggins theory.

+
+

See also

+
+
hymd.hamiltonian.DefaultWithChi

Interaction energy functional using \(\chi\)-interactions.

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
interaction_energyfloat

Interaction mixing energy.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+interaction_energy: float
+
+ +
+ +
+
+class hymd.force.Dielectric_type(atom_1: str, dielectric_value: float)[source]
+
+
+atom_1: str
+
+ +
+
+dielectric_value: float
+
+ +
+ +
+
+class hymd.force.Dihedral(atom_1: str, atom_2: str, atom_3: str, atom_4: str, coeffs: numpy.ndarray, dih_type: int)[source]
+

Dataclass representing a single four-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any four-particle torsional bond between particles of specific types +A, B, C, and D (where A, B, +C, and D may be different or the same). Dihedral +four-particle bonds in HyMD take different forms depending on the +dih_type parameter.

+

In the following, let \(\phi\) denote the angle between the planes +spanned by the relative positions of atoms A-B-C +and B-C-D. If dih_type = 0, then

+
+\[V_4(\phi) = \sum_n c_n + \left( + 1 + \cos\left[ + n\phi - d_n + \right] + \right),\]
+

where \(c_n\) are energy coefficients and \(d_n\) are propensity +phases. By default, the cosine sum is truncated at five terms. If +coeffs provides only a single float, this is used as the coiling +propensity parameter \(\lambda\). In this case, \(c_n\) and +\(d_n\) are automatically set to values which promote alpha helical +(\(\lambda=-1\)), beta sheet (\(\lambda=1\)), or a mixed +(\(1>\lambda>-1\)) structure (using values provided by Bore et al. +(2018)). In this case, the full potential takes the form

+
+\[V_4(\phi;\lambda) = + \frac{1}{2}(1-\lambda) V_{\text{prop},\alpha}(\phi) + + + \frac{1}{2}(1+\lambda) V_{\text{prop},\beta}(\phi) + + + (1-\vert\lambda\vert) V_{\text{prop}, \text{coil}}(\phi),\]
+

with each of the \(V_{\mathrm{prop}, X}\) being fixed cosine series +potentials with pre-set \(c_n\) -s and \(d_n\) -s.

+

If dih_type = 1, then a combined bending torsional (CBT) potential +is employed,

+
+\[V_4(\phi,\gamma;\lambda) = + V_4(\phi;\lambda) + + + \frac{1}{2}K(\phi)(\gamma - \gamma_0)^2,\]
+

where \(V_4(\phi;\lambda)\) specifies the potential as given by the +coiling propensity parameter above, \(K(\phi)\) is a separate cosine +series potential acting as the angular three-particle bond strength, and +\(\gamma_0\) is the three-particle bond equilibrium angle. In this +case, the coeffs parameter must specify both a \(\lambda\) +value, in additon to the energy and phases dictating the \(K(\phi)\) +potential.

+

References

+

Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018.

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
atom_4str

Type name of particle 4.

+
+
coeffslist[list[float]] or list[float] or numpy.ndarray

Dihedral coefficients defining the series expansion of the dihedral +energy.

+
+
dih_typeint

Specifies the type of dihedral used; If 0, then coeffs +must contain either two lists of five energy coefficients +\(c_n\) and five propensity phases \(d_n\) or a single +floating point number defining the \(\lambda\) coiling propensity +parameter. If 1, the combined bending-torsional potential is +used, and coeffs must specify \(\lambda\) and two lists +containing energy coefficients and propensity phases for the +\(V_\text{prop}\) propensity potential, defined in terms of cosine +series.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+atom_3: str
+
+ +
+
+atom_4: str
+
+ +
+
+coeffs: numpy.ndarray
+
+ +
+
+dih_type: int
+
+ +
+ +
+
+hymd.force.compute_angle_forces__plain(f_angles, r, bonds_3, box_size)[source]
+

Computes forces resulting from angular interactions

+
+

Deprecated since version 1.0.0: compute_angle_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_bond_forces__plain(f_bonds, r, bonds_2, box_size)[source]
+

Computes forces resulting from bonded interactions

+
+

Deprecated since version 1.0.0: compute_bond_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size)[source]
+

Computes forces resulting from dihedral interactions

+
+

Deprecated since version 1.0.0: compute_dihedral_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.dipole_forces_redistribution(f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb)[source]
+

Redistribute electrostatic forces calculated from topologically +reconstructed ghost dipole point charges to the backcone atoms of the protein.

+
+ +
+
+hymd.force.find_all_paths(G, u, n)[source]
+

Helper function that recursively finds all paths of given lenght ‘n + 1’ inside a network ‘G’. +Adapted from https://stackoverflow.com/a/28103735.

+
+ +
+
+hymd.force.prepare_bonds(molecules, names, bonds, indices, config, topol=None)[source]
+

Rearrange the bond information for usage in compiled Fortran kernels

+

Restructures the lists resulting from the execution of +prepare_bonds_old into numpy arrays suitable for calls to optimized +Fortran code calculating bonded forces and energiesself.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2_atom_1(B,) numpy.ndarray

Local index of particle 1 for each of B constructed +two-particle bonds.

+
+
bonds_2_atom_2(B,) numpy.ndarray

Local index of particle 2 for each of B constructed +two-particle bonds.

+
+
bonds_2_equilibrium(B,) numpy.ndarray

Equilibrium distance for each of B constructed two-particle +bonds.

+
+
bonds_2_strength(B,) numpy.ndarray

Bond strength for each of B constructed two-particle +bonds.

+
+
bonds_3_atom_1(A,) numpy.ndarray

Local index of particle 1 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_2(A,) numpy.ndarray

Local index of particle 2 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_3(A,) numpy.ndarray

Local index of particle 3 for each of A constructed +three-particle bonds.

+
+
bonds_3_equilibrium(A,) numpy.ndarray

Equilibrium angle for each of A constructed three-particle +bonds.

+
+
bonds_3_strength(A,) numpy.ndarray

Bond strength for each of A constructed three-particle +bonds.

+
+
bonds_4_atom_1(D,) numpy.ndarray

Local index of particle 1 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_2(D,) numpy.ndarray

Local index of particle 2 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_3(D,) numpy.ndarray

Local index of particle 3 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_4(D,) numpy.ndarray

Local index of particle 4 for each of D constructed +four-particle bonds.

+
+
bonds_4_coeff(D,) numpy.ndarray

Cosine series coefficients for each of D constructed +four-particle bonds.

+
+
bonds_4_type(D,) numpy.ndarray

Dihedral type for each of D constructed four-particle +bonds.

+
+
bonds_4_last(D,) numpy.ndarray

Flags indicating if dih_type is 1 for each of D +constructed four-particle bonds.

+
+
+
+
+
+

See also

+
+
prepare_bonds_old

Used internally to reconstruct the bonded interactions types from the connectivity information in the structure/topology input file and the bonded types specified in the configuration file.

+
+
+ +
+ +
+
+hymd.force.prepare_bonds_old(molecules, names, bonds, indices, config)[source]
+

Find bonded interactions from connectivity and bond types information

+
+

Deprecated since version 1.0.0: prepare_bonds_old was replaced by prepare_bonds for +use with compiled Fortran kernels prior to 1.0.0 release.

+
+

Prepares the necessary equilibrium and bond strength information needed by +the intramolecular interaction functions. This is performed locally on each +MPI rank, as the domain decomposition ensures that for all molecules all +consituent particles are always contained on the same MPI rankself.

+

This function traverses the bond connectivity information provided in the +structure/topology input file and indentifies any two-, three-, or +four-particle potential bonds. For each connected chain of two, three, or +four particles, a matching to bond types is attempted. If the corresponding +names match, a bond object is initialized.

+

In order to investigate the connectivity, a graph is created using +networkx functionality.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2list

List of lists containing local particle indices, equilibrium +distance, and bond strength coefficient for each reconstructed +two-particle bond.

+
+
bonds_3

List of lists containing local particle indices, equilibrium angle, +and bond strength coefficient for each reconstructed three-particle +bond.

+
+
bonds_4

List of lists containing local particle indices, dihedral type index, +and dihedral coefficients for each reconstructed four-particle +torsional bond.

+
+
bb_indexlist

List indicating the dihedral type of each four-particle bond in +bonds_4.

+
+
+
+
+
+

See also

+
+
Bond

Two-particle bond type dataclass.

+
+
Angle

Three-particle angular bond type dataclass.

+
+
Dihedral

Four-particle torsional bond type dataclass.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+hymd.force.prepare_index_based_bonds(molecules, topol)[source]
+
+ +
+
+hymd.force.propensity_potential_coeffs(x: float)[source]
+
+ +
+
+

4.6. Pressure

+
+
+hymd.pressure.comp_pressure(phi, phi_q, psi, hamiltonian, velocities, config, phi_fourier, phi_laplacian, phi_transfer, positions, bond_pr, angle_pr, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Computes total internal pressure of the system. +Kinetic pressure is trivially calculated from the kinetic energy. +Already computed bond and angle pressure terms are inserted into the +total internal pressure. +The field pressure equation is implemented.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fourierlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pressure(18,) numpy.ndarray

Pressure contributions from various energy terms. +0: due to kinetic energy +1-5: due to field energy +6-8: due to two-particle bonded terms +9-11: due to three-particle bonded terms (called angle terms) +12-14: due to four-particle bonded terms (called dihedral terms) +(defaults to 0 currently. Yet to be implemented) +15-17: total pressure in x,y,z directions.

+
+
+
+
+
+ +
+
+

4.7. Logger

+
+
+class hymd.logger.Logger[source]
+

Log output handler class

+

Notes

+

This wraps the default python library logging, see +docs.python.org/3/library/logging.html.

+
+
Attributes:
+
+
levelint

Determines the verbosity level of the log, corresponding to +logging.level. Numerical values 50 (logging.CRITICAL), +40 (logging.ERROR), 30 +(logging.WARNING), 20 (logging.INFO), +10 (logging.DEBUG), and 0 +(logging.UNSET) are supported values. Any log event message +less severe than the specified level is ignored. All other event +messages are emitted.

+
+
log_filestr

Path to output log file.

+
+
formatstr

Prepended dump string for each log event. Specifies the log event +level, the module emitting the event, the code line, the enclosing +function name, and the MPI rank writing the message.

+
+
date_formatstr

Prepends the date before all log event messages.

+
+
formatterlogging.Formatter

Formatter handling the prepending of the information in format and +date_format to each log event message. Used by default for all +loggers.

+
+
rank0logging.Logger

Default logger object for the root MPI rank.

+
+
all_rankslogging.Logger

Default logger object for messages being emitted from all MPI ranks +simultaneously.

+
+
+
+
+
+
+classmethod setup(default_level=20, log_file=None, verbose=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Sets up the logger object.

+

If a log_file path is provided, log event messages are output +to it. Otherwise, the logging messages are emitted to stdout.

+
+
Parameters:
+
+
default_levelint, optional

Default verbosity level of the logger. Unless specified, it is +10 (logging.INFO).

+
+
log_filestr, optional

Path to output log file. If None or not priovided, no log file is +used and all logging is done to stdout.

+
+
verbosebool, optional

Increases the logging level to 30 (logging.WARNING) +if True, otherwise leaves the logging level unchanged.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterRoot(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the root MPI rank log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterAll(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the all-MPI-ranks log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+

4.8. Input parser

+

Parses and handles the configuration information provided for the simulation

+
+
+class hymd.input_parser.Config(n_steps: int, time_step: float, mesh_size: Union[List[int], numpy.ndarray, int], sigma: float, kappa: float, dtype: Optional[numpy.dtype] = None, box_size: Optional[Union[List[float], numpy.ndarray]] = None, n_print: Optional[int] = None, tau: Optional[float] = None, start_temperature: Optional[Union[float, bool]] = None, target_temperature: Optional[Union[float, bool]] = None, mass: Optional[float] = None, hamiltonian: Optional[str] = None, domain_decomposition: Optional[Union[int, bool]] = None, integrator: Optional[str] = None, respa_inner: int = 1, file_name: str = '<config file path unknown>', name: Optional[str] = None, tags: List[str] = <factory>, bonds: List[hymd.force.Bond] = <factory>, angle_bonds: List[hymd.force.Angle] = <factory>, dihedrals: List[hymd.force.Dihedral] = <factory>, chi: List[hymd.force.Chi] = <factory>, n_particles: Optional[int] = None, max_molecule_size: Optional[int] = None, n_flush: Optional[int] = None, thermostat_work: float = 0.0, thermostat_coupling_groups: List[List[str]] = <factory>, initial_energy: Optional[float] = None, cancel_com_momentum: Union[int, bool] = False, coulombtype: Optional[str] = None, convergence_type: Optional[str] = None, pol_mixing: Optional[float] = None, dielectric_const: Optional[float] = None, conv_crit: Optional[float] = None, dielectric_type: List[hymd.force.Dielectric_type] = <factory>, self_energy: Optional[float] = None, type_charges: Optional[Union[List[float], numpy.ndarray]] = None, rho0: Optional[float] = None, a: Optional[float] = None, pressure: bool = False, barostat: Optional[str] = None, barostat_type: Optional[str] = None, tau_p: Optional[float] = None, target_pressure: List[hymd.barostat.Target_pressure] = <factory>, n_b: Optional[int] = None, m: List[float] = <factory>)[source]
+

Configuration object

+

Handles and verifies the simulation configuration specified in the +configuration file.

+
+

See also

+
+
hymd.input_parser.Bond

Two-particle bond type dataclass.

+
+
hymd.input_parser.Angle

Three-particle bond type dataclass.

+
+
hymd.input_parser.Dihedral

Four-particle bond type dataclass.

+
+
+ +
+
Attributes:
+
+
gas_constantfloat

Constant value of the gas constant, R (equivalently the Boltzmann +constant) in the units used internally in HyMD.

+
+
coulomb_constantfloat

Constant value of the Coulomb constant which converts electric field +values to forces and electric potential values to energies in the units +used internally in HyMD.

+
+
n_steps: int

Number of time steps in the simulation.

+
+
time_step: float

Outer time step used in the simulation. If the rRESPA intergrator is +used, the inner time step (the time step used in the integration of +intramolecular bending, stretching, and torsional forces) is +time_step / respa_inner.

+
+
box_sizelist[float] or (D,) numpy.ndarray

Simulation box size of simulation in D dimensions in units of +nanometers.

+
+
mesh_sizelist[int] or int or numpy.ndarray

Number of grid points used for the discrete density grid.

+
+
sigmafloat

Filter width representing the effective coarse-graining level of the +particles in the simulation.

+
+
kappafloat

Compressibility parameter used in the relaxed incompressibility term in +the interaction energy functional.

+
+
n_printint, optional

Frequency of trajectory/energy output to the H5MD trajectory/energy +output file (in units of number of time steps).

+
+
taufloat, optional

The time scale of the CSVR thermostat coupling.

+
+
start_temperaturefloat, optional

Generate starting temperature by assigning all particle velocities +randomly according to the Maxwell-Boltzmann distribution at +start_temperature Kelvin prior to starting the simulation.

+
+
target_temperaturefloat, optional

Couple the system to a heat bath at target_temperature Kelvin.

+
+
massfloat, optional

Mass of the particles in the simulation.

+
+
hamiltonianstr, optional

Specifies the interaction energy functional \(W[\tilde\phi]\) +for use with the particle-field interactions. Options: +SquaredPhi, DefaultNohChi, or DefaultWithChi.

+
+
domain_decompositionint, optional

Specifies the interval (in time steps) of domain decomposition +exchange, involving all MPI ranks sending and receiving particles +according to the particles’ positions in the integration box and the +MPI ranks’ assigned domain.

+
+
integratorstr, optional

Specifies the time integrator used in the simulation. Options: +velocity-verlet or respa.

+
+
respa_innerint, optional

The number of inner time steps in the rRESPA integrator. This denotes +the number of intramolecular force calculations (stretching, bending, +torsional) are performed between each impulse applied from the field +forces.

+
+
file_namestr, optional

File path of the parsed configuration file.

+
+
namestr, optional

Name for the simulation.

+
+
tagslist[str], optional

Tags for the simulation.

+
+
bondslist[Bond], optional

Specifies harmonic stretching potentials between particles in the +same molecule.

+
+
angle_bondslist[Angle], optional

Specifies harmonic angular bending potentials between particles in the +same molecule.

+
+
dihedralslist[Dihedral], optional

Specifies four-particle torsional potentials by cosine series.

+
+
chilist[Chi], optional

Specifies \(\chi\)-interaction parameters between particle +species.

+
+
n_particlesint, optional

Specifies the total number of particles in the input. Optional keyword +for validation, ensuring the input HDF5 topology has the correct number +of particles and molecules.

+
+
max_molecule_sizeint, optional

Maximum size of any single molecule in the system. Used to speed up +distribution of particles onto MPI ranks in a parallel fashion.

+
+
n_flushint, optional

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be +written to disk (in units of number of n_print).

+
+
thermostat_workfloat

Work performed by the thermostat on the system.

+
+
thermostat_coupling_groupslist[str], optional

Specifies individual groups coupling independently to the CSVR +thermostat. E.g. in a system containing "A", "B", and +"C" type particles, +thermostat_coupling_groups = [["A", "B"], ["C"],] would +thermalise types "A" and "B" together and couple +"C" type particles to a different thermostat (all individual +thermostats are at the same temperature, i.e. target_temperature +Kelvin).

+
+
initial_energyfloat

Value of the total energy prior to the start of the simulation.

+
+
cancel_com_momentumint, optional

If True, the total linear momentum of the center of mass is +removed before starting the simulation. If an integer is specifed, the +total linear momentum of the center of mass is removed every +remove_com_momentum time steps. If False, the linear +momentum is never removed.

+
+
coulombtypestr, optional

Specifies the type of electrostatic Coulomb interactions in the system. +The strength of the electrostatic forces is modulated by the relative +dielectric constant of the simulation medium, specified with the +dielectric_const keyword. Charges for individual particles are +specified in the structure/topology HDF5 input file, not in the +configuration file. If no charges (or peptide backbone dipoles) are +present, the electrostatic forces will not be calculated even if this +keyword is set to "PIC_Spectral".

+
+
dielectric_constfloat, optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. When +using helical propensity dihedrals, this keyword must be specified—even +if electrostatics are not included with the coulombtype +keyword.

+
+
dielectric_type: list[float], optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. The list assigns +relative dielectric values to each bead type, and an anisotropic +dielectric function is obtained from a weighted average.

+
+
+
+
+
+
+a: float = None
+
+ +
+
+angle_bonds: List[hymd.force.Angle]
+
+ +
+
+barostat: str = None
+
+ +
+
+barostat_type: str = None
+
+ +
+
+bonds: List[hymd.force.Bond]
+
+ +
+
+box_size: Union[List[float], numpy.ndarray] = None
+
+ +
+
+cancel_com_momentum: Union[int, bool] = False
+
+ +
+
+chi: List[hymd.force.Chi]
+
+ +
+
+conv_crit: float = None
+
+ +
+
+convergence_type: str = None
+
+ +
+
+coulomb_constant: ClassVar[float] = 138.935458
+
+ +
+
+coulombtype: str = None
+
+ +
+
+dielectric_const: float = None
+
+ +
+
+dielectric_type: List[hymd.force.Dielectric_type]
+
+ +
+
+dihedrals: List[hymd.force.Dihedral]
+
+ +
+
+domain_decomposition: Union[int, bool] = None
+
+ +
+
+dtype: numpy.dtype = None
+
+ +
+
+file_name: str = '<config file path unknown>'
+
+ +
+
+gas_constant: ClassVar[float] = 0.0083144621
+
+ +
+
+hamiltonian: str = None
+
+ +
+
+initial_energy: float = None
+
+ +
+
+integrator: str = None
+
+ +
+
+kappa: float
+
+ +
+
+m: List[float]
+
+ +
+
+mass: float = None
+
+ +
+
+max_molecule_size: int = None
+
+ +
+
+mesh_size: Union[List[int], numpy.ndarray, int]
+
+ +
+
+n_b: int = None
+
+ +
+
+n_flush: int = None
+
+ +
+
+n_particles: int = None
+
+ +
+
+n_print: int = None
+
+ +
+
+n_steps: int
+
+ +
+
+name: str = None
+
+ +
+
+pol_mixing: float = None
+
+ +
+
+pressure: bool = False
+
+ +
+
+respa_inner: int = 1
+
+ +
+
+rho0: float = None
+
+ +
+
+self_energy: float = None
+
+ +
+
+sigma: float
+
+ +
+
+start_temperature: Union[float, bool] = None
+
+ +
+
+tags: List[str]
+
+ +
+
+target_pressure: List[hymd.barostat.Target_pressure]
+
+ +
+
+target_temperature: Union[float, bool] = None
+
+ +
+
+tau: float = None
+
+ +
+
+tau_p: float = None
+
+ +
+
+thermostat_coupling_groups: List[List[str]]
+
+ +
+
+thermostat_work: float = 0.0
+
+ +
+
+time_step: float
+
+ +
+
+type_charges: Union[List[float], numpy.ndarray] = None
+
+ +
+ +
+
+hymd.input_parser.check_NPT_conditions(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check validity of barostat_type, barostat, +a, rho0, target_pressure, tau_p

+
+ +
+
+hymd.input_parser.check_angles(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_bonds(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_box_size(config, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_cancel_com_momentum(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_charges(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if charges across ranks sum to zero.

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of floats with charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_charges_types_list(config, types, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates a list of charge values of length types. +Charges are sorted according to type ID. Used in field.py. +# TODO: this is messy, we should fix it

+
+ +
+
+hymd.input_parser.check_chi(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_config(config, indices, names, types, charges, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs various checks on the specfied config to ensure consistency

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
indices(N,) numpy.ndarray

Array of integer indices for N particles.

+
+
names(N,) numpy.ndarray

Array of string names for N particles.

+
+
types(N,) numpy.ndarray

Array of integer type indices for N particles.

+
+
charges(N,) numpy.ndarray

Array of floats charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
Returns:
+
+
configConfig

Validated configuration object.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_dielectric(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Error handling for electrostatics. +Unit testing of toml/tomli input.

+
+ +
+
+hymd.input_parser.check_dihedrals(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_domain_decomposition(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_hamiltonian(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_integrator(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_m(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_mass(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_max_molecule_size(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_b(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_flush(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_particles(config, indices, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_print(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_name(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_start_and_target_temperature(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Validate provided starting and target thermostat temperatures

+

Assesses the provided temperature target and ensures it is a non-negative +floating point number or False. Ensures the starting temperature is +a non-negative floating point number or False.

+

If the value for either is None, the returned configuration object +has the values defaulted to False in each case.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
validated_configConfig

Configuration object with validated target_temperature and +start_temperature.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_tau(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_thermostat_coupling_groups(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.parse_config_toml(toml_content, file_path=None, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.read_config_toml(file_path)[source]
+
+ +
+
+hymd.input_parser.sort_dielectric_by_type_id(config, charges, types)[source]
+

Creates a list of length N CG-particles, sorted after the charges from +the input HDF5 file. Used in file_io.py

+
+ +
+
+

4.9. Field

+

Forces and energies from the discretized particle-field grid interactions

+
+
+hymd.field.compute_field_and_kinetic_energy(phi, phi_q, psi, velocity, hamiltonian, positions, types, v_ext, config, layouts, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the particle-field and kinetic energy contributions

+

Calculates the kinetic energy through

+
+\[E_k = \sum_j \frac{1}{2}m_j\mathbf{v}_j\cdot\mathbf{v}_j,\]
+

and the particle-field energy by

+
+\[E_\text{field} = \int\mathrm{d}\mathbf{r}\, + w[\tilde\phi],\]
+

where \(w\) is the interaction energy functional density.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
velocity(N,D) numpy.ndarray

Array of velocities for N particles in D dimensions. +Local for each MPI rank.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Local for each MPI rank–the full computational grid is +represented by the collective fields of all MPI ranks.

+
+
configConfig

Configuration object.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field

Computes the up-to-date external potential for use in calculating the particle-field energy.

+
+
+ +
+ +
+
+hymd.field.compute_field_energy_q_GPE(config, phi_eps, field_q_energy, dot_elec, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the electrostatic energy after electrosatic forces is +calculated.

+

From the definition of the elecrostatic potential \(\Psi\), the energy +is

+
+
+
W = frac{1}{2}intmathrm{d}mathbf{r},

epsilon(mathbf{r})} left(mathbf{E}cdot mathbf{E}right),

+
+
+
+

where \(\epsilon(\mathbf{r})}\) is the anisotropic, spatially dependent, +relative dielectric of the simulation medium.

+
+
Parameters:
+
+
confighymd.input_parser.Config

Configuration object.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
field_q_energyfloat

Total elecrostatic energy.

+
+
dot_elecpmesh.pm.RealField

Pmesh RealField object for storing \(|\mathbf{E(r)}|^{2}\) +on the computational grid. Local for each MPI rank – the full computational +grid is represented by the collective fields of all MPI ranks.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field_force_q_GPE

Compute the electrosatic force from an anisotropic dielectric general Poisson equation.

+
+
+ +
+ +
+
+hymd.field.compute_field_force(layouts, r, force_mesh, force, types, n_types)[source]
+

Interpolate particle-field forces from the grid onto particle positions

+

Backmaps the forces calculated on the grid to particle positions using the +window function \(P\) (by default cloud-in-cell [CIC]). In the +following, let \(\mathbf{F}_j\) denote the force acting on the +particle with index \(j\) and position \(\mathbf{r}_j\). The +interpolated force is

+
+\[\mathbf{F}_j = -\sum_k\nabla V_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(V_{j_k}\) is the discretized external potential at grid vertex +\(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid vertex +with index \(j_k\), and \(h^3\) is the volume of each grid voxel. +The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
r(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
force(N,D) numpy.ndarray

Array of forces for N particles in D dimensions. Local +for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
n_typesint

Number of different unique types present in the simulation system. +n_types is global, i.e. the same for all MPI ranks even if some +ranks contain zero particles of certain types.

+
+
+
+
+
+ +
+
+hymd.field.compute_self_energy_q(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the self energy for the interaction due to the Ewald scheme +used to compute the electrostatics. The energy is stored in config.

+

The self interaction energy is given by:

+
+\[U_{self} = \sqrt{\frac{1}{2\pi\sigma^2}} \sum_{i=1}^{N} q_i^2\]
+

where \(q_i\) are the charges and \(\sigma\) is the half-width +of the Gaussian filter.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
Returns:
+
+
field_q_self_energyfloat

Electrostatic self energy.

+
+
+
+
+
+ +
+
+hymd.field.domain_decomposition(positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs domain decomposition

+

Rearranges the MPI rank memory layout into one that better mimics the PFFT +pencil grid 2D decomposition. As molecules are always required to be fully +contained on a single MPI rank, a perfect decomposition is not always +possible. The best decomposition which leaves the center of mass of all +molecules in their respective correct domains is used, with possible +overlap into neighbouring domains if the spatial extent of any molecule +crosses domain boundaries.

+
+
Parameters:
+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
*args

Variable length argument list containing arrays to include in the +domain decomposition.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
bonds(N,M) numpy.ndarray, optional

Array of M bonds originating from each of N particles.

+
+
verboseint, optional

Specify the logging event verbosity of this function.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
Domain decomposedcode:positions and any array specified in
+
:code:`*args`, in addition tocode:bonds and molecules if these
+
arrays were provided as input.
+
+
+
+
+ +
+
+hymd.field.initialize_pm(pmesh, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates the necessary pmesh objects for pfft operations.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pmobject ‘pmesh.pm.ParticleMesh’
+
field_listlist[pmesh.pm.RealField], (multiple)

Essential list of pmesh objects required for MD

+
+
list_coulomblist[pmesh.pm.RealField], (multiple)

Additional list of pmesh objects required for electrostatics.

+
+
+
+
+
+ +
+
+hymd.field.update_field(phi, phi_laplacian, phi_transfer, layouts, force_mesh, hamiltonian, pm, positions, types, config, v_ext, phi_fourier, v_ext_fourier, m, compute_potential=False)[source]
+

Calculate the particle-field potential and force density

+

If compute_potential is True, the energy may subsequently +be computed by calling compute_field_and_kinetic_energy.

+

Computes the particle-field external potential \(V_\text{ext}\) from +particle number densities through the smoothed density field, +\(\phi(\mathbf{r})\). With \(P\) being the cloud-in-cell (CIC) +window function, the density and filtered densities are computed as

+
+\[\phi(\mathbf{r}) = \sum_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\phi(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +external potential is computed in reciprocal space as

+
+\[V_\text{ext} = \mathrm{FFT}^{-1}\left[ + \mathrm{FFT} + \left( + \frac{\partial w}{\partial \tilde\phi} + \right) + \mathrm{FFT}(H) +\right],\]
+

where \(w\) is the interaction energy functional. Differentiating +\(V_\text{ext}\) is done by simply applying \(i\mathbf{k}\) in +Fourier space, and the resulting forces are back-transformed to direct +space and interpolated to particle positions by

+
+\[\mathbf{F}_j = -\sum_{j_k} \nabla V_{j_k} + P(\mathbf{r}_{j_k} - \mathbf{r}_j)h^3,\]
+

where \(j_k\) are the neighbouring vertices of particle \(j\) at +position \(\mathbf{r}_j\), and \(h^3\) is the volume of each grid +voxel.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Pre-allocated, but empty; any values +in this field are discarded. Changed in-place. Local for each MPI +rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
configConfig

Configuration object.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Pre-allocated, but empty; any values in this field are +discarded Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
phi_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computational grid is represented by the collective fields of all +MPI ranks.

+
+
v_ext_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplesField objects containing discretized +particle-field external potential values in reciprocal space on the +computational grid; D+1 fields in D dimensions for each +particle type. D copies are made after calculation for later +use in force calculation, because the force transfer function +application differentiates the field in-place, ruining the contents +for differentiation in the remaining D-1 spatial directions. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
m: list[float], (M,)

pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. +Defaults to 1.0 for all particle types.

+
+
compute_potentialbool, optional

If True, a D+1-th copy of the Fourier transformed +external potential field is made to be used later in particle-field +energy calculation. If False, only D copies are made.

+
+
+
+
+
+

See also

+
+
compute_field_and_kinetic_energy

Compute the particle-field energy after the external potential is calculated.

+
+
+ +
+ +
+
+hymd.field.update_field_force_q(charges, phi_q, phi_q_fourier, psi, psi_fourier, elec_field_fourier, elec_field, elec_forces, layout_q, hamiltonian, pm, positions, config)[source]
+

Calculate the electrostatic particle-field forces on the grid

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential is computed in reciprocal space as

+
+\[\Phi = \mathrm{FFT}^{-1}\left[ + \frac{4\pi k_e}{\varepsilon \vert\mathbf{k}\vert^2} + \mathrm{FFT}(\rho)\mathrm{FFT}(H) +\right],\]
+

with the electric field

+
+\[\mathbf{E} = \mathrm{FFT}^{-1}\left[ + -i\mathbf{k}\,\mathrm{FFT}(\Psi) +\right].\]
+

In the following, let \(\mathbf{F}_j\) denote the electrostatic force +acting on the particle with index \(j\) and position +\(\mathbf{r}_j\). The interpolated electrostatic force is

+
+\[\mathbf{F}_j = \sum_k q_j\mathbf{E}_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(\mathbf{E}_{j_k}\) is the discretized electric field at grid +vertex \(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid +vertex with index \(j_k\), and \(h^3\) is the volume of each grid +voxel. The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty; any values in this field +are discarded. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
elec_field_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +electric field values in reciprocal space on the computational grid. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
+
+
+
+ +
+
+hymd.field.update_field_force_q_GPE(conv_fun, phi, types, charges, phi_q, phi_q_fourier, phi_eps, phi_eps_fourier, phi_eta, phi_eta_fourier, phi_pol_prev, phi_pol, elec_field, elec_forces, elec_field_contrib, psi, Vbar_elec, Vbar_elec_fourier, force_mesh_elec, force_mesh_elec_fourier, hamiltonian, layout_q, layouts, pm, positions, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Calculate the electrostatic particle-field forces on the grid, arising from +a general Poisson equation, i.e. anisotropic permittivity/dielectric. +The function is called when tomli input config.coulombtype = “PIC_Spectral_GPE.”

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential for a variable dielectric does not have an +analytical expression, and is computed in reciprocal through an iterative +method.

+

The GPE states that

+
+\[\nabla \cdot \left(\epsilon(\mathbf{r}) +\nabla{\mathbf{\psi(r)}}\right) = -\rho({\mathbf{r}}).\]
+

where \(\epsilon(\mathbf{r})\) is the relative dielectric function.

+
+
Parameters:
+
+
conv_funConvergence function.

Returns a scalar. Depends on MPI allreduce for similar convergence +across MPI ranks.

+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_eps_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_etapmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +gradients of the relative dielectric values on the computational grid. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank–the +full computational grid is represented by the collective fields of all MPI ranks.

+
+
phi_eta_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated discretized +Fourier transformed gradient relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_pol_prevpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charge values on the computational grid. Parameter in +the iterative method.Pre-allocated,but empty. Changedin-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_polpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charges on the computational grid. Parameter in the iterative +method, updating the next quess in solving for the electrostatic potential. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank– +the full computational grid is represented by the collective fields of +all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all +MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
elec_field_contribpmesh.pm.RealField

Pmesh RealField object for storing +\(|\mathbf{E(r)}|^2/\phi_{0}\) on the computational grid. +Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
psipmesh.pm.RealField

Pmesh RealField object for storing electrostatic potential +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
Vbar_elecmesh.pm.RealField

Pmesh RealField object for storing functional derivatives of +:math:`|w({ phi })_{elec}`on the computational grid. +Pre-allocated, but empty. Changed in-place. Local for each MPI rank– +the full computational grid is represented by the collective fields of

+
+

all MPI ranks.

+
+
+
Vbar_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated functional +derivatives of \(\|w(\{ \phi \})_{elec}\) in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
force_mesh_elecpmesh.pm.RealField

Pmesh RealField object for storing electrostatic force values +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
force_mesh_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated electrostatic +force values in reciprocal space on the computational grid. Local for +each MPI rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
layouts: list[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
comm: mpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
compute_field_energy_q_GPE

Compute the electrostatic energy after electrosatic force is calculated for a variable (anisotropic) dielectric general Poisson equation.

+
+
+ +
+ +
+
+

4.10. File input/output

+

Handle file input/output in parllel HDF5 fashion

+
+
+class hymd.file_io.OutDataset(dest_directory, config, double_out=False, disable_mpio=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

HDF5 dataset handler for file output

+
+
+close_file(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Closes the HDF5 output file

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+
+flush()[source]
+

Flushes output buffers, forcing file writes

+
+ +
+
+is_open(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if HDF5 output file is open

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+ +
+
+hymd.file_io.distribute_input(in_file, rank, size, n_particles, max_molecule_size=201, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Assign global arrays onto MPI ranks, attempting load balancing

+

Distributes approximately equal numbers of particles (workload) onto each +independent MPI rank, while respecting the requirement that any molecule +must be fully contained on a single MPI rank only (no splitting molecules +across multiple CPUs).

+
+
Parameters:
+
+
in_fileh5py.File

HDF5 input file object.

+
+
rankint

Local rank number for this MPI rank.

+
+
sizeint

Global size of the MPI communicator (number of total CPUs).

+
+
n_particlesint

Total number of particles.

+
+
max_molecule_sizeint, optional

Maximum size of any molecule present in the system. Used to initially +guess where the MPI rank boundaries (start/end indices) in the global +arrays should be placed. If molecules of size +>max_molecule_size exist in the simulation system, HyMD +might work as expected. Or it might fail spectacularly.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
rank_range

Starting and ending indices in the global arrays for each MPI rank.

+
+
+
+
+
+ +
+
+hymd.file_io.setup_time_dependent_element(name, parent_group, n_frames, shape, dtype, units=None)[source]
+

Helper function for setting up time-dependent HDF5 group datasets

+

All output groups must adhere to the H5MD standard, meaning a structure of

+
+
┗━ group particle group (e.g. all) or observables group
+
+
┗━ group time-dependent data
+
+
┣━ dataset step shape=(n_frames,)
+
┣━ dataset time shape=(n_frames,)
+
┗━ dataset value shape=(n_frames, *)
+
+
+
+

is necessary.

+

References

+
+
H5MD specification :

https://www.nongnu.org/h5md/h5md.html

+
+
+
+ +
+
+hymd.file_io.store_data(h5md, step, frame, indices, positions, velocities, forces, box_size, temperature, pressure, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, field_energy, field_q_energy, plumed_bias, time_step, config, velocity_out=False, force_out=False, charge_out=False, plumed_out=False, dump_per_particle=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Writes time-step data to HDF5 output file

+

Handles all quantities which change during simulation, as opposed to +static quanitities (see store_static).

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
stepint

Step number.

+
+
frameint

Output frame number (step // n_print).

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
positions(N,) numpy.ndarray

Array of positions for N particles in D dimensions.

+
+
velocities(N,) numpy.ndarray

Array of velocities for N particles in D dimensions.

+
+
forces(N,) numpy.ndarray

Array of forces for N particles in D dimensions.

+
+
box_size(D,) numpy.ndarray

Array containing the simulation box size.

+
+
temperaturefloat

Calculated instantaneous temperature.

+
+
kinetic_energyfloat

Calculated instantaneous kinetic energy.

+
+
bond2_energyfloat

Calculated instantaneous harmonic two-particle bond energy.

+
+
bond3_energyfloat

Calculated instantaneous harmonic angular three-particle bond energy.

+
+
bond4_energyfloat

Calculated instantaneous dihedral four-particle torsion energy.

+
+
field_energyfloat

Calculated instantaneous particle-field energy.

+
+
field_q_energyfloat

Calculated instantaneous electrostatic energy.

+
+
plumed_biasfloat

PLUMED instantaneous bias energy.

+
+
time_stepfloat

Value of the time step.

+
+
configConfig

Configuration object.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charge_outbool, optional

If True, electrostatic energies are written to the output +HDF5 file.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to the output HDF5 file.

+
+
dump_per_particlebool, optional

If True, all quantities are written per particle.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
store_static

Outputs all static time-independent quantities to the HDF5 output file

+
+
+ +
+ +
+
+hymd.file_io.store_static(h5md, rank_range, names, types, indices, config, bonds_2_atom1, bonds_2_atom2, molecules=None, velocity_out=False, force_out=False, charges=False, dielectrics=False, plumed_out=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Outputs all static time-independent quantities to the HDF5 output file

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
rank_rangelist[int]

Start and end indices for global arrays for each MPI rank.

+
+
names(N,) numpy.ndarray

Array of names for N particles.

+
+
types(N,) numpy.ndarray

Array of type indices for N particles.

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
configConfig

Configuration object.

+
+
bonds_2_atom1(B,) numpy.ndarray

Array of indices of the first particle for B total +two-particle bonds.

+
+
bonds_2_atom2(B,) numpy.ndarray

Array of indices of the second particle for B total +two-particle bonds.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles.

+
+
dielectrics(N,) numpy.ndarray

Array of particle relative dielectric values for N particles.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to output HDF5 file.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
prepare_bonds

Constructs two-, three-, and four-particle bonds from toplogy input file and bond configuration information.

+
+
distribute_input

Distributes input arrays onto MPI ranks, attempting load balancing.

+
+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/doc_pages/benchmarks.html b/v2.0.2/doc_pages/benchmarks.html new file mode 100644 index 00000000..1e51a7a6 --- /dev/null +++ b/v2.0.2/doc_pages/benchmarks.html @@ -0,0 +1,317 @@ + + + + + + + 3. Benchmarks — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Benchmarks

+

Homopolymer melt test systems of \(30^2\), \(40^2\), and \(50^2\) +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively.

+
+

3.1. Bonded forces

+

Legend label denotes the number of particles in the system.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-1.png +
+
+
+

3.2. Particle–field forces

+

Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-2.png +
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/doc_pages/command_line.html b/v2.0.2/doc_pages/command_line.html new file mode 100644 index 00000000..e68a4185 --- /dev/null +++ b/v2.0.2/doc_pages/command_line.html @@ -0,0 +1,374 @@ + + + + + + + 5. Command line arguments — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. Command line arguments

+

Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle–field interactions.

+
+

5.1. Required arguments

+
+
configuration file:
+

type positional

+

Specifies the .toml format configuration file containing simulation details. See Configuration file for details.

+
+
structure and topology file:
+

type positional

+

Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See Topology and structure file for details.

+
+
+
+
+

5.2. Optional arguments

+
+
-v  --verbose

type optional

+

Number of following arguments: 0 or 1

+

Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying -v or --verbose with no additional specification. This increases verbosity level by 1. Alternatively, it maye be specified by --verbose V with V being 0, 1, or 2.

+
+
--profile

type optional

+

Number of following arguments: 0

+

Enables code profiling using cProfile. This will output one profiling file per MPI rank invoked in the simulation.

+
+
--double-precision

type optional

+

Number of following arguments: 0

+

Specify usage of double precision internally in HyMD (including in the FFTs).

+
+
--double-output

type optional

+

Number of following arguments: 0

+

Specify usage of double precision in the output trajectory from HyMD.

+
+
--velocity-output

type optional

+

Number of following arguments: 0

+

Specify that velocities should be output to the HyMD trajectory.

+
+
--force-output

type optional

+

Number of following arguments: 0

+

Specify that forces should be output to the HyMD trajectory.

+
+
--disable-mpio

type optional

+

Number of following arguments: 0

+

Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult.

+
+
--logfile

type optional

+

Number of following arguments: 1

+

Specifies the path of a plain text log file in which stdout is mirrored during simulation runs.

+
+
--seed

type optional

+

Number of following arguments: 1

+

Specifies the random seed used in the numpy random library to generate velocities, thermostatting, etc.

+
+
--disable-bonds

type optional

+

Number of following arguments: 0

+

Disable any two-particle bonds present in the system.

+
+
--disable-angle-bonds

type optional

+

Number of following arguments: 0

+

Disable any three-particle bonds present in the system.

+
+
--disable-dihedrals

type optional

+

Number of following arguments: 0

+

Disable any four-particle bonds present in the system.

+
+
--disable-dipole

type optional

+

Number of following arguments: 0

+

Disable any topological reconstruction of peptide backbone dipoles present in the system.

+
+
--disable-field

type optional

+

Number of following arguments: 0

+

Disable any particle–field interactions present in the system.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/doc_pages/config_file.html b/v2.0.2/doc_pages/config_file.html new file mode 100644 index 00000000..75606226 --- /dev/null +++ b/v2.0.2/doc_pages/config_file.html @@ -0,0 +1,507 @@ + + + + + + + 3. Configuration file — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Configuration file

+

The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order.

+

The configuration file is a toml format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs.

+
+

3.1. Configuration file keywords

+

The following constitutes every possible keyword specification in HyMD +configuration files:

+
+

3.1.1. Metadata keywords

+

Configuration keywords specifying metadata for the H5MD output trajectory.

+
+
name:
+

string [optional, default: None]

+

Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file.

+
+
tags:
+

array [string] [optional, default: None]

+

Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file.

+
+
+
+
+

3.1.2. Particle keywords

+

Configuration keywords specifying properties of particles and molecules in the +system.

+
+
n_particles:
+

integer [optional, default: None]

+

Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules.

+
+
mass:
+

float [optional, default: 72.0] {units: \(\text{u}=\text{g}\,\text{mol}^{-1}\)}

+

Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal.

+
+
max_molecule_size:
+

integer [optional, default: 201]

+

Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code will crash if there are molecules larger than max_molecule_size in the topology/structure input file.

+
+
+
+
+

3.1.3. Simulation keywords

+

Configuration keywords specifying simulation parameters.

+
+
n_steps:
+

integer [required]

+

Total number of integration steps to perform for this simulation.

+
+
n_print:
+

integer or boolean [optional, default: False]

+

Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of number of time steps).

+
+
n_flush:
+

integer [optional, default: None]

+

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of number of n_print, i.e. n_print = 13, n_flush = 3 would result in the trajectory/energy being written to disk every 13 x 3 = 39 simulation steps)

+
+
time_step:
+

float [required] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time step per integration step. If the rRESPA multiple time step integrator is used (integrator = "respa"), this specifies the inner time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is respa_inner times the time_step , and the total simulation time is n_steps times time_step times respa_inner .

+
+
box_size:
+

array [float] [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable.

+
+
integrator:
+

string [required] (options: velocity-verlet or respa)

+

Specifies the time integrator used in the simulation. If respa, the reversible reference system propagator algorithm (rRESPA) [Tuckerman et al., 1992] integrator is used, with respa_inner number of inner (intramolecular force) time steps. If velocity-verlet, a normal Velocity Verlet integrator is used. If respa and respa_inner = 1, the rRESPA integrator is equivalent to the Velocity Verlet.

+
+
respa_inner:
+

integer [optional, default: 1]

+

The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces.

+
+
domain_decomposition:
+

integer or boolean [optional, default: False]

+

Specifies the interval (in time steps) of domain decomposition exchange, involving all MPI ranks sending and receiving particles according to the particles’ positions in the integration box and the MPI ranks’ assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If True, the decomposition is performed once (before starting the simulation). If False, no decomposition is performed.

+
+
cancel_com_momentum:
+

integer or boolean [optional, default: False]

+

If True, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every remove_com_momentum time steps. If False, the linear momentum is never removed.

+
+
start_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at start_temperature Kelvin prior to starting the simulation. If False, the velocities are not changed before starting the simulation.

+
+
target_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Couple the system to a heat bath at target_temperature Kelvin by applying a Canonical sampling through velocity rescaling [Bussi et al., 2007] thermostat with coupling strength tau. If False, no temperature control is applied.

+
+
tau:
+

float [optional, default: 0.7] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the CSVR thermostat coupling. In the limit of tau , the Hamiltonian dynamics are preserved and no temperature coupling takes place.

+
+
thermostat_coupling_groups:
+

array [array [string]] [optional, default: []]

+

Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing "A", "B", and "C" type particles, thermostat_coupling_groups = [["A", "B"], ["C"],] would thermalise types "A" and "B" together and couple "C" type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. target_temperature Kelvin).

+
+
hamiltonian:
+

string [optional, default: "DefaultNohChi"] (options: SquaredPhi, DefaultNohChi, or DefaultWithChi)

+

Specifies the interaction energy functional \(W[\tilde\phi]\) for use with the particle-field interactions. See Interaction energy functionals for details.

+
+
+
+
+

3.1.4. Field keywords

+

Configuration keywords specifying field parameters.

+
+
mesh_size:
+

array [integer] or integer [required]

+

Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is box_size / mesh_size.

+
+
kappa:
+

float [required] {units: \(\text{kJ}^{-1}\text{mol}\)}

+

Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional \(W[\tilde\phi]\). See Interaction energy functionals for more details.

+
+
sigma:
+

float [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See Filtering for more details.

+
+
chi:
+

array [array [string, float]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\)}

+

Array of \(\tilde\chi_\text{AB}\)-parameters indicating the strength of the repulsive or attractive interaction between particles of type "A" and the number density due to particles of type "B", and vice versa. Example: chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ] would specify a repulsive "A""B" type interaction, and a weakly attractive "C""D" interaction. Self-interaction \(\tilde\chi\)-terms are always zero. See Interaction energy functionals for more details.

+
+
+
+
+

3.1.5. Bond keywords

+

Configuration keywords specifying bonds and bonds parameters.

+
+
bonds:
+

array [array [2 string, 2 float]] [optional, default: []] {units: \(\text{nm}=10^{-9}~\text{m}\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+

Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ] indicates a "A""A" bond of equilibrium length 0.47 \(\text{nm}\) with a bond strength of 980.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding bond between "A" and "B" type particles with equilibrium length 0.31 \(\text{nm}\) and a strength of 1250.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify stretching bonds.

+
+
angle_bonds:
+

array [array [3 string, 2 float]] [optional, default: []] {units: \({}^\circ\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+
+

Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ] indicates a "A""A""A" angular bond that tries to keep the bond linear at 180 degrees with a bending strength of 55.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding angle bond between "A""B""B" prefering the angle at 120 degrees and a strength of 25.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify angular bonds.

+
+
+
dihedrals:
+

array [array [4 string, integer, COSINE SERIES ]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)}

+

Specifies four-particle torsional potentials by cosine series. See Intramolecular bonds for details about how to specify dihedrals.

+
+
+
+
+

3.1.6. Electrostatic keywords

+

Configuration keywords specifying electrostatics and electrostatic parameters.

+
+
coulombtype:
+

string [optional, default: None] (options: PIC_Spectral)

+

Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the dielectric_const keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, not in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to PIC_Spectral.

+
+
dielectric_const:
+

float [optional, default: None]

+

Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified—even if electrostatics are not included with the coulombtype keyword.

+
+
+
+
+

3.1.7. Pressure keywords

+

Configuration keywords specifying pressure and barostat parameters.

+
+

3.1.7.1. Simulation keywords

+
+
pressure:
+

boolean [optional, default: False]

+

Specifies whether or not to calculate total internal pressure vector.

+
+
barostat:
+

string [optional, default: None](options: isotropic or semiisotropic)

+

Specifies whether to apply pressure constraints equally in all 3 Cartesian directions (isotropic) or equally in xy and different in z (semiisotropic).

+
+
barostat_type:
+

string [optional, default: berendsen](options: berendsen or scr)

+

Specifies the type of barostat to use. berendsen is more suitable for equilibration and scr for equilibrium data collection.

+
+
n_b:
+

integer [optional, default: 1]

+

Frequency of barostat call in number of outer rRESPA steps.

+
+
tau_p:
+

float [optional, default: 10 tau if tau < 0.1 else 1.0] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the barostat coupling.

+
+
target_pressure:
+

array [float] [optional, default: :code:1] {units: bar}

+

Couples the system to an external pressure set to target_pressure.

+
+
+
+
+

3.1.7.2. Field keywords

+
+
rho0:
+

float [optional, default: :code:average density] {units: \(\text{nm}^{-3}\)}

+

Intrinsic parameter corresponding to the specific volume of a coarse-grained particle. Typically: 8.66

+
+
a:
+

float [required] {units: \(\text{nm}^{-3}\)}

+

Calibrated parameter to obtain the correct average density at the target temperature and pressure. Typically: 9.21

+
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/doc_pages/constants_and_units.html b/v2.0.2/doc_pages/constants_and_units.html new file mode 100644 index 00000000..36fd62d1 --- /dev/null +++ b/v2.0.2/doc_pages/constants_and_units.html @@ -0,0 +1,408 @@ + + + + + + + 6. Constants and Units — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

6. Constants and Units

+

HyMD uses the following units and constants internally and in all input and +output:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Units

Quantity

Symbol

Unit

length

\(r\)

\(\text{nm}=10^{-9}~\text{m}\)

time

\(t\)

\(\text{ps}=10^{-12}~\text{s}\)

charge

\(q\)

\(e=1.602176634 \cdot 10^{-19}~\text{C}\)

mass

\(m\)

\(\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}\)

temperature

\(\text{T}\)

\(\text{K}\)

energy

\(E\)

\(\text{kJ}\,\text{mol}^{-1}\)

velocity

\(v\)

\(\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}\)

momentum

\(P\)

\(\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}\)

force

\(\mathbf{F}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}\)

pressure

\(p\)

\(\text{bar}=100~\text{kPa}\)

electric potential

\(\Psi\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}\)

electric field

\(\mathbf{E}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}\)

compressibility

\(\kappa\)

\(\text{mol}\,\text{kJ}^{-1}\)

field-interaction

\(\tilde\chi\)

\(\text{kJ}\,\text{mol}^{-1}\)

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants

Constant

Symbol

Value

gas constant

\(R\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Boltzmann’s constant

\(k_\text{B}\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Avogadro’s constant

\(N_\text{A}\)

\(6.02214076 \cdot 10^23~\text{mol}^{-1}\)

Vacuum permittivity

\(\varepsilon_0\)

\(8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2\)

Coulomb constant

\(k_\text{e}\)

\(138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}\)

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/doc_pages/electrostatics.html b/v2.0.2/doc_pages/electrostatics.html new file mode 100644 index 00000000..7fd55032 --- /dev/null +++ b/v2.0.2/doc_pages/electrostatics.html @@ -0,0 +1,329 @@ + + + + + + + 3. Electrostatic interactions — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Electrostatic interactions

+

In the filtered Hamiltonian hPF formalism [] the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle–mesh Ewald.

+

The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered

+
+\[\tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i),\]
+

with \(q_i\) being the charge of particle \(i\) and \(H\) is the +filtering function (see Filtering). The value of the charge grid at +vertex \((i,j,k)\) is found by

+
+\[\tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)]\]
+

and the electrostatic potential \(\Psi_{ijk}\)

+
+\[\Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right],\]
+

where \(k_\text{e}\) is the Coulomb constant \(1/4\pi\varepsilon_0\). +The electric field is obtained by differentiation of the electrostatic +potential in Fourier space,

+
+\[\mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)]\]
+

from which the forces are interpolated back to the particle positions.

+
+

3.1. Specifying electrostatics

+

In HyMD, electrostatics are specified by the coulombtype and +dielectric_const keywords in the configuration file (see +Configuration file) and the /charge dataset in the HDF5 format +structure/topology input file (see Topology and structure file). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/doc_pages/examples.html b/v2.0.2/doc_pages/examples.html new file mode 100644 index 00000000..ef3b9481 --- /dev/null +++ b/v2.0.2/doc_pages/examples.html @@ -0,0 +1,777 @@ + + + + + + + 1. Examples — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Examples

+

The following examples are ordered in more or less order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the HyMD-tutorial github repository.

+
+

1.1. Ideal gas

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true +

The simplest possible system is one with no interactions at all—intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like:

+
+
ideal_gas.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = false         # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+
+
+

A simple input structure/topology file ideal_gas.HDF5 is available in +the HyMD-tutorial/ideal_gas github repository (along with the code to +generate it). Run the (very) short simulation by

+
python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field   \
+                                              --velocity-output \
+                                              --force-output
+
+
+

with the --disable-field argument to completely turn off all +particle–field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook ideal_gas.ipynb for details.

+
+
+

1.2. Ideal chains

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true +

The simplest available interaction is the harmonic two-particle bond (see +Intramolecular bonds),

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2.\]
+

Extending the configuration file from the ideal gas case, we need to add a +bonds specification. Note that the [bonds] meta specifier is not +necessary, but may be used to help organise the input file.

+
+
ideal_chain.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+
+
+

A simple input structure/topology file ideal_chain.HDF5 with a few +coiled up ideal chain polymers is available in the +HyMD-tutorial/ideal_chain github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field
+
+
+

we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +ideal_chain.ipynb.

+
+
+

1.3. Stiff rods

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true +

Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the i--j--k angle \(\theta\) (see +Intramolecular bonds),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2.\]
+

Extending the configuration file from the ideal chain case, we need to add a +angle_bonds specification. Note that the [bonds] meta specifier +is not necessary, but may be used to help organise the input file.

+
+
rods.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+angle_bonds = [
+  ["A", "A", "A", 180.0, 100.0],   # (i, j, k, equilibrium angle, strength)
+]
+
+
+
+

A simple input structure/topology file rods.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook rods.ipynb.

+
+
+

1.4. Helixes

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true +

Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle \(\phi\) between the +i--j--k plane and the j--k--l plane (see Intramolecular bonds),

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n).\]
+

The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a dihedrals keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the dielectric_const +keyword even though we are not including electrostatic forces in the current +simulation. Note that the [bonds] meta specifier is not necessary, but +may be used to help organise the input file.

+
+
helixes.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+dielectric_const = 15.0
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.31, 10000.0],       # (i name, j name, equilibrium length, strength)
+]
+
+dihedrals = [
+  [
+    ["A", "A", "A", "A"],
+    [
+      [-1],
+      [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+      [0.08, 0.46, 1.65, -0.96, 0.38],
+    ],
+    [1.0]
+  ],
+]
+
+
+
+

A simple input structure/topology file helixes.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook helixes.ipynb.

+
+
+

1.5. Phase separation

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true +

The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types A and B. Using the Hamiltonian

+
+\[\mathcal{H}=H_0+W\]
+

with \(\tilde\chi\)–dependent interactions defined by (specified in the +configuration file by hamiltonian = DefaultWithChi):

+
+\[W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2.\]
+
+
phase_separation.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+
+[field]
+mesh_size = [20, 20, 20]           # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+kappa = 0.05                       # compressibility in mol/kJ
+chi = [
+  ['A', 'B', 5.0],                 # (name i, name j, strength)
+]
+
+
+
+

A simple input structure/topology file phase_separation.HDF5 containing +an equal number of A type and B type particles is available in +the HyMD-tutorial/phase_separation github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd phase_separation.toml phase_separation.HDF5
+
+
+

we may examine the resulting trajectory. In the case of a low interaction +strength \(\tilde\chi\) of 5.0 (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to 40.0 (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +phase_separation.ipynb.

+
+
+

1.6. Diblock copolymers

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true +

Having introduced particle–field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive \(\tilde\chi\)–interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the integrator = "respa" keyword. Putting the pieces together, the +configuration file may look like the following:

+
+
copolymer.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 15
+n_steps = 2000                     # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [10.0, 10.0, 10.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [50, 50, 50]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+chi = [
+  ["A", "B", 30.0],                # (i, j, strength)
+]
+
+[bonds]
+bonds = [
+  ["A", "A", 0.25, 1500.0],        # (i, j, equilibrium length, strength)
+  ["A", "B", 0.25, 1500.0],
+  ["B", "B", 0.25, 1500.0],
+]
+angle_bonds = [
+  ["A", "A", "A", 180.0, 25.0],    # (i, j, k, equilibrium angle, strength)
+  ["B", "B", "B", 180.0, 25.0],
+]
+
+
+
+

A simple input structure/topology file copolymer.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/copolymer github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten A followed by ten B type particles. +Running the simulation with

+
python3 -m hymd copolymer.toml copolymer.HDF5
+
+
+

the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +copolymer.ipynb.

+
+
+

1.7. Lipid bilayer self-assembly

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true +

Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field–particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the thermostat_coupling_groups keyword. With parameters +optimised in [Ledum et al., 2020], the configuration file looks like:

+
+
lipid_self_assembly.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 25
+n_steps = 3000
+n_print = 200
+n_flush = 1
+time_step = 0.01
+box_size = [9.96924, 9.96924, 10.03970]
+start_temperature = 323
+target_temperature = 323
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.05
+domain_decomposition = 10001
+cancel_com_momentum = true
+max_molecule_size = 15
+thermostat_coupling_groups = [
+  ["N", "P", "G", "C"],
+  ["W"],
+]
+
+[field]
+mesh_size = [25, 25, 25]
+sigma = 1.0
+chi = [
+  ["C", "W", 42.24],
+  ["G", "C", 10.47],
+  ["N", "W", -3.77],
+  ["G", "W", 4.53],
+  ["N", "P", -9.34],
+  ["P", "G", 8.04],
+  ["N", "G", 1.97],
+  ["P", "C", 14.72],
+  ["P", "W", -1.51],
+  ["N", "C", 13.56],
+]
+
+[bonds]
+bonds = [
+  ["N", "P", 0.47, 1250.0],
+  ["P", "G", 0.47, 1250.0],
+  ["G", "G", 0.37, 1250.0],
+  ["G", "C", 0.47, 1250.0],
+  ["C", "C", 0.47, 1250.0],
+]
+angle_bonds = [
+  ["P", "G", "G", 120.0, 25.0],
+  ["P", "G", "C", 180.0, 25.0],
+  ["G", "C", "C", 180.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

A randomly mixed input structure/topology file +lipid_self_assembly.HDF5 with a few hundred lipids in a roughy +10 x 10 x 10nm box is available in the +HyMD-tutorial/lipid_self_assembly github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation

+
python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5
+
+
+

we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook lipid_self_assembly.ipynb.

+
+
+

1.8. Peptide in lipid bilayer

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true +

Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer.

+

The configuration file is available in the HyMD-tutorial/peptide github +repository (omitted here for brevity).

+

A pre-equilibrated input structure/topology file peptide.HDF5 with a +few hundred lipids in a roughy 20 x 20 x 20nm box is available in the +HyMD-tutorial/peptide github repository. Running the simulation

+
python3 -m hymd peptide.toml peptide.HDF5
+
+
+

we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook peptide.ipynb.

+
+
+

1.9. SDS

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true +

The last part we introduce is explicit electrostatic interactions through +particle–mesh Ewald. Enabling the electrostatic calculations is done via the +coulombtype keyword. "PIC_Spectral" is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the dielectric_const keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge.

+
+
sds.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 10
+n_steps = 3000
+n_print = 1500
+n_flush =
+time_step = 0.01
+box_size = [8.3, 8.3, 8.3]
+start_temperature = 298
+target_temperature = 298
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.1
+domain_decomposition = 10000
+cancel_com_momentum = true
+max_molecule_size = 5
+thermostat_coupling_groups = [
+  ["S", "C"],
+  ["W", "Na"],
+]
+dielectric_const = 45.0              # dielectric constant for the simulation medium
+coulombtype = "PIC_Spectral"         # particle in cloud, spectral method
+
+[field]
+mesh_size = [64, 64, 64]
+sigma = 0.5
+chi = [
+  ["S", "C",  13.50],
+  ["S", "Na",  0.00],
+  ["S", "W",  -3.60],
+  ["C", "Na", 13.50],
+  ["C", "W",  33.75],
+  ["W", "Na",  0.00],
+]
+
+[bonds]
+bonds = [
+  ["S",   "C",   0.50, 1250.0],
+  ["C",   "C",   0.50, 1250.0],
+]
+angle_bonds = [
+  ["S", "C", "C", 170.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

An input structure/topology file sds.HDF5 with a couple thousand +randomly dispersed SDS chains is available in the HyMD-tutorial/sds github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a /charge dataset. +Running the simulation with

+
python3 -m hymd sds.toml sds.HDF5
+
+
+

we observe the aggregation of the SDS into micellular structures—first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook sds.ipynb.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/doc_pages/filtering.html b/v2.0.2/doc_pages/filtering.html new file mode 100644 index 00000000..0ba6c188 --- /dev/null +++ b/v2.0.2/doc_pages/filtering.html @@ -0,0 +1,316 @@ + + + + + + + 2. Filtering — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Filtering

+

The default grid-independent filter function used in HyMD is a Gaussian

+
+\[H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right]\]
+

with reciprocal space representation

+
+\[\hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right].\]
+

The coarse-graining parameter \(\sigma\) determines a length scale of +particle extent and is given as configuration file input by

+
sigma = 0.75
+
+
+
+

2.1. Implementing new filters

+

Implementing new filter functions is straightforward by hijacking +the setup method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/doc_pages/installation.html b/v2.0.2/doc_pages/installation.html new file mode 100644 index 00000000..1b72bedb --- /dev/null +++ b/v2.0.2/doc_pages/installation.html @@ -0,0 +1,548 @@ + + + + + + + 1. Installation — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Installation

+
+

1.1. Dependencies

+

Installing non-Python dependencies may be done by

+
+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-openmpi-dev  # Install MPI-enabled HDF5
+sudo apt-get install -y pkg-config           # Install pkg-config, required for h5py install
+sudo apt-get install -y curl wget
+
+
+
+
+

Warning

+

There might be memory leaks when using HyMD with OpenMPI 4.1.1. +Therefore, using a newer version of OpenMPI is recommended. +See Issue #186 for more details.

+ +

Installing Python dependencies may be done by

+
+
python3 -m pip install --upgrade pip
+CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+python3 -m pip install mpi4py numpy cython
+
+
+
+
+

Warning

+

If MPI-enabled HDF5 and h5py can not be installed, limited support +for serial HDF5 is available. Note that having MPI-enabled file IO is +highly recommended, and simulation performance under serial HDF5 will +potentially be very low.

+

Example dependency install on Ubuntu (apt) using serial HDF5:

+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-serial-dev   # Install serial HDF5
+sudo apt-get install -y curl wget
+
+python3 -m pip install h5py mpi4py numpy cython
+
+
+

Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +--disable-mpio argument to HyMD, see Command line arguments. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial.

+ +
+
+

1.2. Installing HyMD

+

HyMD may be installed using pip by

+
python3 -m pip install hymd
+
+
+
+
+

1.3. Install in docker

+

A docker image with build essentials setup is available at dockerhub with tag +mortele/hymd,

+
docker pull mortele/hymd:latest
+docker run -it mortele/hymd
+/app$ python3 -m pip install hymd
+
+# Grab example input files
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5
+
+# Run simulation
+/app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose
+
+
+
+
+

1.4. Run interactively in Google Colaboratory

+

A Google Colaboratory jupyter notebook is setup here with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons.

+
+
+

1.5. Common issues

+
+

1.5.1. Numpy errors while importing the Fortran force kernels

+
RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd
+
+Traceback (most recent call last):
+
+  (...)
+
+File "/..../HyMD/hymd/__init__.py", line 2, in <module>
+  from .main import main  # noqa: F401
+File "/..../HyMD/hymd/main.py", line 10, in <module>
+  from .configure_runtime import configure_runtime
+File "/..../hymd/configure_runtime.py", line 12, in <module>
+  from .input_parser import read_config_toml, parse_config_toml
+File "/..../HyMD/hymd/input_parser.py", line 12, in <module>
+  from .force import Bond, Angle, Dihedral, Chi
+File "/..../HyMD/hymd/force.py", line 8, in <module>
+  from force_kernels import (  # noqa: F401
+ImportError: numpy.core.multiarray failed to import
+
+
+

can normally be fixed by updating numpy versions,

+
python3 -m pip install -U numpy
+
+
+
+
+

1.5.2. Error building pfft-python due to missing curl/wget

+
Building wheel for pfft-python (setup.py) ... error
+ERROR: Command errored out with exit status 1:
+command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_
+cwd: /tmp/pip-install-fr6nt9m4/pfft-python/
+Complete output (56 lines):
+running bdist_wheel
+running build
+running build_py
+
+  (...)
+
+curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found
+wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found
+Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+Please check curl or wget
+You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/
+Traceback (most recent call last):
+  File "<string>", line 1, in <module>
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in <module>
+    setup(
+  File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup
+    return distutils.core.setup(**attrs)
+  File "/usr/lib/python3.8/distutils/core.py", line 148, in setup
+
+  (...)
+
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions
+    build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:]))
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft
+    raise ValueError("could not build fftw; check MPICC?")
+ValueError: could not build fftw; check MPICC?
+----------------------------------------
+ERROR: Failed building wheel for pfft-python
+Running setup.py clean for pfft-python
+Failed to build pfft-python
+
+
+

can be fixed by installing either curl or wget

+
apt-get install -y curl wget
+
+
+
+
+

1.5.3. Error running parallel HyMD without MPI-enabled h5py

+
Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    main()
+  File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    raise ValueError("h5py was built without MPI support, can't use mpio driver")
+ValueError: h5py was built without MPI support, can't use mpio driver
+
+
+

Can be fixed by installing a MPI-enabled h5py through

+
python3 -m pip uninstall -y h5py
+HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/doc_pages/interaction_energy_functionals.html b/v2.0.2/doc_pages/interaction_energy_functionals.html new file mode 100644 index 00000000..2922cb54 --- /dev/null +++ b/v2.0.2/doc_pages/interaction_energy_functionals.html @@ -0,0 +1,369 @@ + + + + + + + 1. Interaction energy functionals — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Interaction energy functionals

+

A few interaction energy functionals \(W\) are defined in HyMD through +the Hamiltonian class and associated subclasses.

+
+

1.1. \(\chi\)–interaction and \(\kappa\)–incompressibility

+

The most common hPF energy functional is specified by

+
hamiltonian = "DefaultWithChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where \(\tilde\chi_{\text{A}-\text{B}}\) is the interaction energy between +overlapping densities of particle types \(\text{A}\) and \(\text{B}\). +The incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\tilde\chi\) +and \(\kappa\) in the configuration file (see Configuration file)

+
kappa = 0.05
+chi = [
+   ["A", "B", 15.85],
+   ["B", "C", -5.70],
+   ...
+]
+
+
+
+
+

1.2. Only \(\kappa\)–incompressibility

+

The only \(\kappa\) interactions energy functional is specified by

+
hamiltonian = "DefaultNoChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where the incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.3. Only \(\phi^2\)

+

The \(\phi^2\) interactions energy functional is specified by

+
hamiltonian = "SquaredPhi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2,\]
+

where the \(\phi\) squared term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.4. Implementing new interaction energy forms

+

Implementing new interaction energy functions is straightforward by subclassing +Hamiltonian and applying sympy differentiation to the symbolic +field objects. The sympy.lamdify function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/doc_pages/intramolecular_bonds.html b/v2.0.2/doc_pages/intramolecular_bonds.html new file mode 100644 index 00000000..b6697db0 --- /dev/null +++ b/v2.0.2/doc_pages/intramolecular_bonds.html @@ -0,0 +1,409 @@ + + + + + + + 2. Intramolecular bonds — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Intramolecular bonds

+

Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see Configuration file. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +Benchmarks), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable.

+

All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]).

+
+

2.1. Two-particle bonds

+

Stretching bonds in HyMD are implemented as harmonic spring potentials,

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2,\]
+

where \(r=|\mathbf{r}|\) is the inter-particle distance, \(k\) is a +constant of dimension energy (units \(\text{kJ}\,\text{mol}^{-1}\)), and +\(r_0\) is the equilibrum length of the bond (units: \(\text{nm}\)). The +force is calculated as

+
+\[F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r},\]
+

where \(\mathbf{r}\) is the vector pointing from \(i\) to \(j\).

+

In the configuration file, two-particle bonds are specified per particle type:

+
+
configuration_two_particle_example.toml
+
[bonds]
+bonds = [
+   ["A", "A", 0.47, 1250.0],
+   ["A", "B", 0.37,  940.0],
+   ["B", "C", 0.50, 1010.0],
+   ["C", "A", 0.42,  550.0],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.2. Three-particle bonds

+

Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle–particle–particle angle \(\theta\),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2,\]
+

where \(k\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\)), and \(\theta_0\) is the equilibrum +angle of the bond (units: \({}^\circ\)). Defining the particles with labels +\(a\), \(b\), and \(c\), let \(\mathbf{r}_a\) denote the vector +pointing from \(b\) to \(a\), and correspondingly let +\(\mathbf{r}_c\) point from \(b\) to \(c\). The +\(a\)\(b\)\(c\) may be computed through the law of Cosines,

+
+\[\theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right]\]
+

Then the force acting on \(a\) and \(c\) is

+
+\[ \begin{align}\begin{aligned}\mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a},\\\mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c},\end{aligned}\end{align} \]
+

and

+
+\[\mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c\]
+

In the configuration file, three-particle bonds are specified per particle type:

+
+
configuration_three_particle_example.toml
+
[bonds]
+angle_bonds = [
+   ["A", "A", "A", 180.0, 90.0],
+   ["A", "B", "A", 120.0, 55.0],
+   ["B", "C", "C",  30.0, 10.0],
+   ["C", "A", "B", 110.0, 25.5],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.3. Four-particle bonds

+

Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle \(\phi\) between the +\(a\)\(b\)\(c\) and \(b\)\(c\)\(d\) planes, for +a dihedral bond quartet \(a\), \(b\), \(c\), and \(d\). The +potential takes the form

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n),\]
+

where \(c_n\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)), and \(\phi_n\) are +specified phase angles in the cosine series.

+

In the configuration file, four-particle bonds are specified per particle type:

+
+
configuration_four_particle_example.toml
+
[bonds]
+dihedrals = [
+   ["A", "B", "C", "D"],
+   [
+     [-1],
+     [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+     [0.08, 0.46, 1.65, -0.96, 0.38],
+   ],
+   [1.0],
+]
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/doc_pages/overview.html b/v2.0.2/doc_pages/overview.html new file mode 100644 index 00000000..8d1bb334 --- /dev/null +++ b/v2.0.2/doc_pages/overview.html @@ -0,0 +1,430 @@ + + + + + + + 2. Usage overview for HylleraasMD — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Usage overview for HylleraasMD

+

HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a toml format configuration file, along with a topology and structure +file specifying the input system in HDF5 format.

+

Configuration file

+

The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a [5, 5, 5] nm simulation box at 300 K may look like +the following:

+
+
config_simple_1.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "SquaredPhi"         # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [30, 30, 30]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+
+
+
+

Note that for the version 1.0 release of HyMD, the [particles], +[simulation], and [field] groups are optional specifiers for +structuring the configuration file.

+

For a full specification of every recognised configuration keyword in HyMD, +please refer to Configuration file.

+

Topology and structure file

+

The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +N particles may look like the following:

+
+
example_structure.HDF5
+
group   /
+   # root group
+
+dataset /coordinates
+   # float32, shape (T, N, D,)
+   # Time steps of N rows of D dimensional coordinate data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /velocities
+   # float32, shape (T, N, D,) OPTIONAL
+   # Time steps of N rows of D dimensional velocity data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /bonds
+   # int32,   shape (N, B,)    OPTIONAL
+   # Each row i contains indices of the particles bonds from/to i
+   # B denotes the maximum bonds per particle
+
+dataset /indices
+   # int32,   shape (N,)
+   # Index of each particle, 0--(N-1)
+
+dataset /molecules
+   # int32,   shape (N,)
+   # Index of molecule each particle belongs to
+   # Used to construct bond network locally on MPI ranks
+
+dataset /names
+   # str10,   shape (N,)
+   # Fixed size string array containing particle type names
+
+dataset /types
+   # int32,   shape (N,)       OPTIONAL
+   # Mapping of particle names to type indices
+
+
+
+

For a full specification of the topology and structure input file, see +Topology and structure file.

+

Command line arguments

+

A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the config_simple_1.toml and example_structure.HDF5 +files may look like the following:

+
mpirun -n ${MPI_NUM_RANKS} python3 -m hymd         \  # HyMD executable
+                           config_simple_1.toml    \  # configuration file
+                           example_structure.HDF5  \  # structure file
+                           --logfile=log_out.txt   \  # set logfile path
+                           --seed 123456           \  # set random seed
+                           --verbose 2             \  # set logging verbosity
+                           --velocity-output          # enable velocity in trajectory output
+
+
+

For a full specification of all command line arguments, see +Command line arguments.

+

More examples

+

For more thorough rundown and concrete usage examples, see +Examples.

+
+

2.1. Running parallel simulations

+

Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the only difference being how the python3 interpreter is +invoked. Prepending mpirun -n ${NPROCS} to the usual +python3 -m hymd runs the simulation with ${NPROCS} MPI ranks.

+

Inputting

+
mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field
+
+
+

sets up an example simulation of the HyMD-tutorial/ideal_gas system. For +more details about this system in particular, or other example simulations, see +the HyMD-tutorial repository.

+
+
+

2.2. Running tests

+

Run serial code tests by

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd
+cd hymd/
+python3 -m pip install pytest pytest-mpi
+python3 -m pytest
+
+
+

There is a small convenience script in hymd/ for running the MPI-enabled +tests,

+
chmod +x pytest-mpi
+./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/doc_pages/pressure.html b/v2.0.2/doc_pages/pressure.html new file mode 100644 index 00000000..cb671d43 --- /dev/null +++ b/v2.0.2/doc_pages/pressure.html @@ -0,0 +1,319 @@ + + + + + + + 4. Pressure — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Pressure

+

Internal pressure is calculated from internal energy according to

+
+\[\begin{split}P_a = \frac{1}{\mathcal{V}} \left( 2T_a - \text{Vir}_a \right) \\ +\text{Vir}_a = L_a \frac{\partial \mathcal{U}}{\partial L_a} \\ +\mathcal{U} = \sum_{i=1}^M \mathcal{U}_0( \{ \mathbf{r}\}_i ) + W[\{ \tilde\phi \} ]\end{split}\]
+

where +\(\mathcal{V}\) is the simulation volume, +\({T_a}\) is the kinetic energy +and \(L_a\) the length of the box in the Cartesian direction \(a\), +Vir is the virial of the total interaction energy \(\mathcal{U}\).

+

\(\mathcal{U}\) comprises intramolecular bonded terms \(\mathcal{U}_0\) (see Intramolecular bonds for details), +and field terms \(W[\{ \tilde\phi \} ]\) (see Theory for details).

+

Using the above expressions, the following form for internal pressure is obtained:

+
+\[\begin{split}P_a = \frac{2 T_a}{\mathcal{V}} -\frac{L_a}{\mathcal{V}} \sum_{i=1}^N \frac{\partial \mathcal{U}_{0i}}{\partial L_a} + P^{(3)}_a \\\end{split}\]
+
+\[P^{(3)}_a = \frac{1}{\mathcal{V}}\left ( -W[\{ \tilde\phi(\mathbf{r}) \}] + \int \sum_t \bar{V}_t(\mathbf{r})\tilde\phi_t(\mathbf{r})d\mathbf{r} + + \int \sum_t \sigma^2\bar{V}_t(\mathbf{r})\nabla_a^2\tilde\phi_t(\mathbf{r}) d\mathbf{r} \right)\]
+

where \(\bar{V}_t(\mathbf{r}) = \frac{\partial w(\{\tilde\phi\})}{\partial\tilde\phi_t}\) +and \(σ\) is a coarse-graining parameter (see Filtering for details). +Note that the above expression is obtained for a Gaussian filter which is the most natural choice in HhPF theory.

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/doc_pages/theory.html b/v2.0.2/doc_pages/theory.html new file mode 100644 index 00000000..c72da78e --- /dev/null +++ b/v2.0.2/doc_pages/theory.html @@ -0,0 +1,377 @@ + + + + + + + 1. Theory — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Theory

+

Hybrid particle–field simulations switch out the ordinary particle–particle +Lennard-Jones interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle–field densities are +defined as

+
+\[\phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i),\]
+

where \(\mathbf{r}\) is a spatial coordinate, \(P\) is a window function +used to distribute particle number densities onto a computational grid, and +\(\mathbf{r}_i\) is the position of particle \(i\) (of total \(N\)). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of \(N\) particles in \(M\) molecules is

+
+\[\mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})]\]
+

with \(H_0\) being a standard intramolecular Hamiltonian form (see +Intramolecular bonds) including kinetic terms, while \(W\) is a density +dependent interaction energy functional.

+

In the Hamiltonian hPF-MD formalism [], the density +field is filtered using a grid-independent filtering function \(H\),

+
+\[\tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}).\]
+

The filter smooths the density, ensuring that \(\tilde\phi\) and +\(W[\tilde\phi([\phi])]\) both converge as the grid size is reduced.

+
+

1.1. External potential

+

The external potential acting on a particle is defined as the functional +derivative of \(W\) with respect to \(\phi\). In the filtered formalism, +the potential takes the form

+
+\[\begin{split}V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ +&= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})},\end{split}\]
+

under the assumption of a local form of the interaction energy functional, +\(W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]\). Note +that

+
+\[\frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}).\]
+
+
+

1.2. Force interpolation

+

The forces on particle \(i\) are obtained by differentiation of the external +potential,

+
+\[\mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i).\]
+
+
+

1.3. Reciprocal space calculations

+

The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density \(\phi_{ijk}\) with CIC, we apply the filtering +and obtain the discrete version of the external potential by

+
+\[\tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big]\]
+

and

+
+\[V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+

The forces are obtained by differentiation of \(V\) in Fourier space as

+
+\[\nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+
+
+

1.4. Filter

+

By default, the filter used in HyMD is a simple Gaussian of the form

+
+\[\begin{split}H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ +\hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right].\end{split}\]
+

For more details about the filtering, see Filtering.

+
+
+

1.5. Hamiltonian form

+

The default form of the interaction energy functional in HyMD is

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2.\]
+

In the case of constant pressure simulations (NPT), the interaction energy functional becomes

+
+\[W=\frac{1}{2\rho_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-a\right)^2.\]
+

where, \(\rho_0= 1 / ν\) is an intrinsic parameter corresponding to the specific volume \((ν)\) of a coarse-grained particle, +\(a\) is a calibrated parameter to obtain the correct average density at the target temperature and pressure. +See Interaction energy functionals for details.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/doc_pages/topology_input.html b/v2.0.2/doc_pages/topology_input.html new file mode 100644 index 00000000..a93db710 --- /dev/null +++ b/v2.0.2/doc_pages/topology_input.html @@ -0,0 +1,358 @@ + + + + + + + 4. Topology and structure file — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Topology and structure file

+

The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root / group.

+

The HyMD-tutorial has multiple examples of structure files for various levels +of complexity.

+
+

4.1. Required datasets

+
+
/coordinates:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/indices:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/names:
+

array shape [N,]

+

datatype [string (length between 1 and 16)]

+

The shape represents one particle name per N particles. The datatype may be a string of length =<16.

+
+
+
+
+

4.2. Optional datasets

+
+
/velocities:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/types:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle type index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/molecules:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one molecule index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/bonds:
+

array shape [N, B,]

+

datatype [int32 or int64]

+

The shape represents B bond specifications (indices of different particles) per N particles. The data type may be either 32 or 64 bit integers.

+
+
/charge:
+

array shape [N,]

+

datatype [float32 or float64]

+

The shape represents one particle charge per N particles. The data type may be either four or eight byte reals.

+
+
/box:
+

array shape [3,]

+

datatype [float32 or float64]

+

The shape represents the initial box dimensions in Cartesian coordinates.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/genindex.html b/v2.0.2/genindex.html new file mode 100644 index 00000000..48b211e7 --- /dev/null +++ b/v2.0.2/genindex.html @@ -0,0 +1,855 @@ + + + + + + Index — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + +
+ +

F

+ + + +
+ +

G

+ + +
+ +

H

+ + + +
    +
  • + hymd.input_parser + +
  • +
  • + hymd.integrator + +
  • +
  • + hymd.pressure + +
  • +
  • + hymd.thermostat + +
  • +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/index.html b/v2.0.2/index.html new file mode 100644 index 00000000..b927e28f --- /dev/null +++ b/v2.0.2/index.html @@ -0,0 +1,402 @@ + + + + + + + HylleraasMD documentation — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

HylleraasMD documentation

+
+
Release:
+

2.0.2

+
+
Date:
+

Apr 28, 2023

+
+
+

HylleraasMD (HyMD) is a massively parallel Python package for Hamiltonian hybrid +particle-field molecular dynamics (HhPF-MD) simulations of coarse-grained bio- +and soft-matter systems.

+

HyMD can run canonical hPF-MD simulations, or filtered density HhPF-MD simulations [Bore and Cascella, 2020, Ledum et al., 2023, Ledum et al., 2023, Sen et al., 2023] +with or without explicit PME electrostatic interactions. It includes all standard intramolecular interactions, +including stretching, bending, torsional, and combined bending-dihedral potentials. Additionally, topological reconstruction of permanent peptide chain backbone +dipoles is possible for accurate recreation of protein conformational dynamics. It can run simulations in constant energy (NVE), constant volume (NVT) [Ledum et al., 2023, Ledum et al., 2023] +or constant pressure (NPT) conditions [Sen et al., 2023].

+

HyMD uses the pmesh library for particle-mesh operations, with the PPFT [Pippig, 2013] backend for FFTs through the pfft-python bindings. +File IO is done via HDF5 formats to allow MPI parallel reads.

+
+

User Guide

+

The HylleraasMD User Guide provides comprehensive information on how to run +simulations. Selected Examples are available to guide new users.

+
+
+

Installing HyMD

+

The easiest approach is to install using pip:

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+

For more information and required dependencies, see +Installation.

+
+

Run in Google colab

+

Run HyMD interactively in Google Colaboratory jupyter notebook here.

+
+
+
+

Source Code

+

Source code is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the GNU Lesser General Public +License v3.0. Obtain the source code with git:

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git
+
+
+
+
+

Development

+

HyMD is developed and maintained by researchers at the Hylleraas Centre for +Quantum Molecular Sciences at the University of Oslo.

+

pic1 pic2

+
+
+

References

+
+
+[BC20] +

Sigbjørn Løland Bore and Michele Cascella. Hamiltonian and alias-free hybrid particle–field molecular dynamics. J. Chem. Phys., 153(9):094106, 2020. doi:10.1063/5.0020733.

+
+
+[BDP07] +

Giovanni Bussi, Davide Donadio, and Michele Parrinello. Canonical sampling through velocity rescaling. J. Chem. Phys., 126(1):014101, 2007. doi:10.1063/1.2408420.

+
+
+[LBC20] +

Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Automated determination of hybrid particle-field parameters by machine learning. Mol. Phys., 118(19-20):e1785571, 2020. doi:10.1080/00268976.2020.1785571.

+
+
+[LCS+23] +

Morten Ledum, Manuel Carrer, Samiran Sen, Xinmeng Li, Michele Cascella, and Sigbjørn Løland Bore. HylleraasMD: Massively parallel hybrid particle-field molecular dynamics in Python. Journal of Open Source Software, 8(84):4149, apr 2023. URL: https://joss.theoj.org/papers/10.21105/joss.04149, doi:10.21105/joss.04149.

+
+
+[LSL+23] +

missing journal in hymd_domain2023

+
+
+[Pip13] +

Michael Pippig. Pfft: an extension of fftw to massively parallel architectures. SIAM J. Sci. Comput., 35(3):C213–C236, 2013. doi:10.1137/120885887.

+
+
+[SLBC23] +

Samiran Sen, Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Soft matter under pressure: pushing particle–field molecular dynamics to the isobaric ensemble. J Chem Inf Model, 63(7):2207–2217, March 2023. URL: https://doi.org/10.1021/acs.jcim.3c00186, doi:10.1021/acs.jcim.3c00186.

+
+
+[TBM92] +

MBBJM Tuckerman, Bruce J Berne, and Glenn J Martyna. Reversible multiple time scale molecular dynamics. J. Chem. Phys., 97(3):1990–2001, 1992. doi:10.1063/1.463137.

+
+
+
+
+
+

Indices and tables

+ +
+
+
+
+
+
+
+
+
+ + + +
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+ + + + + +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/objects.inv b/v2.0.2/objects.inv new file mode 100644 index 00000000..b8f0d720 Binary files /dev/null and b/v2.0.2/objects.inv differ diff --git a/v2.0.2/py-modindex.html b/v2.0.2/py-modindex.html new file mode 100644 index 00000000..dcdadddf --- /dev/null +++ b/v2.0.2/py-modindex.html @@ -0,0 +1,349 @@ + + + + + + Python Module Index — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ h +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ h
+ hymd +
    + hymd.barostat +
    + hymd.field +
    + hymd.file_io +
    + hymd.force +
    + hymd.input_parser +
    + hymd.integrator +
    + hymd.pressure +
    + hymd.thermostat +
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.0.2/search.html b/v2.0.2/search.html new file mode 100644 index 00000000..8b4b8c16 --- /dev/null +++ b/v2.0.2/search.html @@ -0,0 +1,309 @@ + + + + + + Search — hymd 2.0.2 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.0.2 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v2.0.2/searchindex.js b/v2.0.2/searchindex.js new file mode 100644 index 00000000..95013b76 --- /dev/null +++ b/v2.0.2/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["doc_pages/api","doc_pages/benchmarks","doc_pages/command_line","doc_pages/config_file","doc_pages/constants_and_units","doc_pages/electrostatics","doc_pages/examples","doc_pages/filtering","doc_pages/installation","doc_pages/interaction_energy_functionals","doc_pages/intramolecular_bonds","doc_pages/overview","doc_pages/pressure","doc_pages/theory","doc_pages/topology_input","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,"sphinxcontrib.bibtex":9,sphinx:56},filenames:["doc_pages/api.rst","doc_pages/benchmarks.rst","doc_pages/command_line.rst","doc_pages/config_file.rst","doc_pages/constants_and_units.rst","doc_pages/electrostatics.rst","doc_pages/examples.rst","doc_pages/filtering.rst","doc_pages/installation.rst","doc_pages/interaction_energy_functionals.rst","doc_pages/intramolecular_bonds.rst","doc_pages/overview.rst","doc_pages/pressure.rst","doc_pages/theory.rst","doc_pages/topology_input.rst","index.rst"],objects:{"hymd.barostat":{isotropic:[0,1,1,""],semiisotropic:[0,1,1,""]},"hymd.field":{compute_field_and_kinetic_energy:[0,1,1,""],compute_field_energy_q_GPE:[0,1,1,""],compute_field_force:[0,1,1,""],compute_self_energy_q:[0,1,1,""],domain_decomposition:[0,1,1,""],initialize_pm:[0,1,1,""],update_field:[0,1,1,""],update_field_force_q:[0,1,1,""],update_field_force_q_GPE:[0,1,1,""]},"hymd.file_io":{OutDataset:[0,2,1,""],distribute_input:[0,1,1,""],setup_time_dependent_element:[0,1,1,""],store_data:[0,1,1,""],store_static:[0,1,1,""]},"hymd.file_io.OutDataset":{close_file:[0,3,1,""],flush:[0,3,1,""],is_open:[0,3,1,""]},"hymd.force":{Angle:[0,2,1,""],Bond:[0,2,1,""],Chi:[0,2,1,""],Dielectric_type:[0,2,1,""],Dihedral:[0,2,1,""],compute_angle_forces__plain:[0,1,1,""],compute_bond_forces__plain:[0,1,1,""],compute_dihedral_forces__plain:[0,1,1,""],dipole_forces_redistribution:[0,1,1,""],find_all_paths:[0,1,1,""],prepare_bonds:[0,1,1,""],prepare_bonds_old:[0,1,1,""],prepare_index_based_bonds:[0,1,1,""],propensity_potential_coeffs:[0,1,1,""]},"hymd.force.Angle":{atom_3:[0,4,1,""]},"hymd.force.Bond":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],equilibrium:[0,4,1,""],strength:[0,4,1,""]},"hymd.force.Chi":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],interaction_energy:[0,4,1,""]},"hymd.force.Dielectric_type":{atom_1:[0,4,1,""],dielectric_value:[0,4,1,""]},"hymd.force.Dihedral":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],atom_3:[0,4,1,""],atom_4:[0,4,1,""],coeffs:[0,4,1,""],dih_type:[0,4,1,""]},"hymd.hamiltonian":{DefaultNoChi:[0,2,1,""],DefaultWithChi:[0,2,1,""],Hamiltonian:[0,2,1,""],SquaredPhi:[0,2,1,""]},"hymd.hamiltonian.DefaultNoChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.DefaultWithChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.Hamiltonian":{__init__:[0,3,1,""],_setup:[0,3,1,""]},"hymd.hamiltonian.SquaredPhi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.input_parser":{Config:[0,2,1,""],check_NPT_conditions:[0,1,1,""],check_angles:[0,1,1,""],check_bonds:[0,1,1,""],check_box_size:[0,1,1,""],check_cancel_com_momentum:[0,1,1,""],check_charges:[0,1,1,""],check_charges_types_list:[0,1,1,""],check_chi:[0,1,1,""],check_config:[0,1,1,""],check_dielectric:[0,1,1,""],check_dihedrals:[0,1,1,""],check_domain_decomposition:[0,1,1,""],check_hamiltonian:[0,1,1,""],check_integrator:[0,1,1,""],check_m:[0,1,1,""],check_mass:[0,1,1,""],check_max_molecule_size:[0,1,1,""],check_n_b:[0,1,1,""],check_n_flush:[0,1,1,""],check_n_particles:[0,1,1,""],check_n_print:[0,1,1,""],check_name:[0,1,1,""],check_start_and_target_temperature:[0,1,1,""],check_tau:[0,1,1,""],check_thermostat_coupling_groups:[0,1,1,""],parse_config_toml:[0,1,1,""],read_config_toml:[0,1,1,""],sort_dielectric_by_type_id:[0,1,1,""]},"hymd.input_parser.Config":{a:[0,4,1,""],angle_bonds:[0,4,1,""],barostat:[0,4,1,""],barostat_type:[0,4,1,""],bonds:[0,4,1,""],box_size:[0,4,1,""],cancel_com_momentum:[0,4,1,""],chi:[0,4,1,""],conv_crit:[0,4,1,""],convergence_type:[0,4,1,""],coulomb_constant:[0,4,1,""],coulombtype:[0,4,1,""],dielectric_const:[0,4,1,""],dielectric_type:[0,4,1,""],dihedrals:[0,4,1,""],domain_decomposition:[0,4,1,""],dtype:[0,4,1,""],file_name:[0,4,1,""],gas_constant:[0,4,1,""],hamiltonian:[0,4,1,""],initial_energy:[0,4,1,""],integrator:[0,4,1,""],kappa:[0,4,1,""],m:[0,4,1,""],mass:[0,4,1,""],max_molecule_size:[0,4,1,""],mesh_size:[0,4,1,""],n_b:[0,4,1,""],n_flush:[0,4,1,""],n_particles:[0,4,1,""],n_print:[0,4,1,""],n_steps:[0,4,1,""],name:[0,4,1,""],pol_mixing:[0,4,1,""],pressure:[0,4,1,""],respa_inner:[0,4,1,""],rho0:[0,4,1,""],self_energy:[0,4,1,""],sigma:[0,4,1,""],start_temperature:[0,4,1,""],tags:[0,4,1,""],target_pressure:[0,4,1,""],target_temperature:[0,4,1,""],tau:[0,4,1,""],tau_p:[0,4,1,""],thermostat_coupling_groups:[0,4,1,""],thermostat_work:[0,4,1,""],time_step:[0,4,1,""],type_charges:[0,4,1,""]},"hymd.integrator":{integrate_position:[0,1,1,""],integrate_velocity:[0,1,1,""]},"hymd.logger":{Logger:[0,2,1,""],MPIFilterAll:[0,2,1,""],MPIFilterRoot:[0,2,1,""]},"hymd.logger.Logger":{setup:[0,3,1,""]},"hymd.logger.MPIFilterAll":{filter:[0,3,1,""]},"hymd.logger.MPIFilterRoot":{filter:[0,3,1,""]},"hymd.pressure":{comp_pressure:[0,1,1,""]},"hymd.thermostat":{_random_chi_squared:[0,1,1,""],_random_gaussian:[0,1,1,""],csvr_thermostat:[0,1,1,""]},hymd:{barostat:[0,0,0,"-"],field:[0,0,0,"-"],file_io:[0,0,0,"-"],force:[0,0,0,"-"],input_parser:[0,0,0,"-"],integrator:[0,0,0,"-"],pressure:[0,0,0,"-"],thermostat:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0020733":15,"00268976":15,"0083144621":0,"01036426965":4,"014101":[0,15],"02214076":4,"03642696562":4,"03970":6,"04149":15,"08790868":[6,10],"094106":15,"0xd":8,"0xe":8,"100":[4,6,11],"1000":6,"10000":6,"10001":6,"1010":10,"1021":15,"1063":15,"1080":15,"10nm":6,"110":10,"1120":0,"1130":0,"1137":15,"118":15,"120":[3,6,10],"120885887":15,"120ff":0,"123456":11,"1250":[3,6,10],"126":[0,15],"138":[0,4],"144":8,"148":8,"1500":6,"153":15,"166":8,"170":6,"1785571":15,"179":0,"180":[3,6,10],"186":8,"197":8,"1974":0,"1981":0,"1984":0,"1990":15,"1992":[3,15],"200":[6,10],"2000":6,"2001":15,"2007":[0,3,15],"2008":0,"201":[0,3],"2013":15,"2018":0,"2020":[6,15],"2023":15,"20nm":6,"21105":15,"2207":15,"2217":15,"223":0,"224":1,"2408420":15,"2408724":[6,10],"246":0,"251":[6,10],"28103735":0,"298":6,"2_1":0,"2don2d":8,"2nd":0,"2t_a":12,"300":[6,11],"3000":6,"3144621":4,"323":6,"3684":0,"3690":0,"3c00186":15,"4149":15,"449":[6,10],"463137":15,"48626121":[6,10],"502":8,"533":1,"544":[6,10],"550":10,"59427866":[6,10],"602176634":4,"610":[6,10],"66053906660":4,"85418781281":4,"935458":[0,4],"940":10,"96924":6,"980":3,"9918564":[6,10],"\u03b1":0,"\u03b2":0,"\u03bd":13,"\u03c3":12,"boolean":[0,3],"byte":14,"case":[0,3,6,10,13],"class":[0,9],"default":[0,3,7,11,13,14],"export":8,"float":[0,3],"function":[0,3,5,6,7,11,13],"int":[0,5,6,9,12,13],"long":[5,6],"new":[0,10,14,15],"particle\u00e2":15,"public":15,"return":[0,8],"short":[6,11],"static":0,"switch":13,"true":[0,3,6],"while":[0,13],Adding:6,For:[0,11,13,15],LCS:15,The:[0,3,5,6,7,8,9,10,11,13,14,15],Then:10,There:[8,11],These:0,Used:[0,3,11],Using:[6,9,12],With:[0,6],__file__:8,__init__:[0,8],__main__:8,_gener:0,_hl:8,_kwarg:8,_random_chi_squar:0,_random_gaussian:0,_run_cod:8,_run_module_as_main:8,_set_fapl_mpio:8,_setup:0,about:[3,11,13],abov:[0,6,12],absent:0,acceler:0,accompani:6,accord:[0,3,12],accur:15,acid:6,across:[0,3],acs:15,act:[0,10,13],adapt:0,add:[5,6],added:0,adding:6,addison:0,addit:[0,2,5,11],addition:15,additon:0,adher:0,affect:0,affili:[0,2],after:[0,10,13],against:8,aggreg:6,ahren:0,alanin:6,algorithm:[0,3,13],alia:15,all:[0,2,3,4,6,8,10,11,15],all_nam:0,all_rank:0,alloc:0,allow:[11,15],allreduc:0,along:[6,11],alpha3:8,alpha:0,alpha_:0,alpha_l:0,alpha_n:0,alreadi:0,also:[6,8],altern:2,alwai:[0,3],amino:6,amount:0,analyt:0,angl:[0,2,3,6,8,10],angle_bond:[0,3,6,10],angle_pr:0,angular:[0,3,6,10],ani:[0,2,3],anisotrop:0,apart:0,api:8,app:8,appli:[0,3,7,9,13],applic:0,approach:15,approxim:0,apr:15,apt:8,architectur:15,arg:[0,8],argument:[0,6,8,11],argv:8,aris:0,around:10,arrai:[0,3,11,14],arriv:6,art:0,aspect:3,assess:0,assign:[0,3,10],associ:[0,9],assum:3,assumpt:13,atom:0,atom_1:0,atom_2:0,atom_3:0,atom_4:0,attach:14,attempt:0,attr:8,attract:3,attribut:0,autom:15,automat:[0,7,8,9],avail:[6,8,15],averag:[0,3,9,13],avogadro:4,back:[0,5],backbon:[0,2,3,15],backcon:0,backend:15,backmap:0,balanc:0,ballist:6,bar:[3,4,12],barostat:3,barostat_typ:[0,3],base:0,bath:[0,3],bb_index:0,bc20:15,bdist_wheel:8,bdp07:15,bead:0,becaus:0,becom:[0,13],befor:[0,3,6,8],being:[0,2,3,5,10,11,13],belong:11,below:[0,6],benchmark:10,bend:[0,3,10,15],berendsen:3,bern:15,besid:2,best:0,beta:0,better:0,between:[0,3,5,6,9,10,13,14],bia:0,big:13,bin:8,binari:8,bind:15,bio:15,bit:[0,14],blueprint:0,boltzmann:[0,3,4],bond2_energi:0,bond3_energi:0,bond4_energi:0,bond:[0,2,6,8,11,12,13,14],bond_pr:0,bonds_2:0,bonds_2_atom1:0,bonds_2_atom2:0,bonds_2_atom_1:0,bonds_2_atom_2:0,bonds_2_equilibrium:0,bonds_2_strength:0,bonds_3:0,bonds_3_atom_1:0,bonds_3_atom_2:0,bonds_3_atom_3:0,bonds_3_equilibrium:0,bonds_3_strength:0,bonds_4:0,bonds_4_atom_1:0,bonds_4_atom_2:0,bonds_4_atom_3:0,bonds_4_atom_4:0,bonds_4_coeff:0,bonds_4_last:0,bonds_4_typ:0,bool:0,bootstrap:8,bore:[0,15],both:[0,13],boundari:[0,3],box:[0,3,6,11,12,14],box_siz:[0,3,6,11],breviti:6,brew:8,broadcast:0,browser:8,bruce:15,buffer:[0,3],build_extens:8,build_pfft:8,build_pi:8,built:8,bussi:[0,3,15],c213:15,c236:15,c_n:[0,6,10],calcul:[0,3,6,10,12],calibr:[0,3,13],call:[0,3,8],callabl:0,can:[6,8,15],cancel_com_momentum:[0,3,6],canon:[0,3,15],capabl:2,captur:11,carrer:15,carri:6,cartesian:[0,3,12,14],cascella:[8,11,15],cbt:0,cdot10:4,cdot:[0,4,10],cell:[0,13],cellar:8,center:[0,3],centr:15,certain:[0,2],chain:[0,15],chang:[0,3],changedin:0,charg:[0,3,4,5,6,14],charge_out:0,check:[0,8],check_angl:0,check_bond:0,check_box_s:0,check_cancel_com_momentum:0,check_charg:0,check_charges_types_list:0,check_chi:0,check_config:0,check_dielectr:0,check_dihedr:0,check_domain_decomposit:0,check_hamiltonian:0,check_integr:0,check_m:0,check_mass:0,check_max_molecule_s:0,check_n_b:0,check_n_flush:0,check_n_particl:0,check_n_print:0,check_nam:0,check_npt_condit:0,check_start_and_target_temperatur:0,check_tau:0,check_thermostat_coupling_group:0,chem:[0,15],chi:[0,3,4,6,8],chi_2:0,chi_3:0,chi_:[0,3,6,9,13],chi_m:0,chmod:11,choic:12,chosen:0,cic:[0,5,13],circ:[3,10],circumv:13,classmethod:0,classvar:0,clean:[0,8],clone:[8,11,15],close:[0,8],close_fil:0,closest:0,cloud:[0,6,13],coars:[0,3,7,12,13,15],code:[0,1,2,3,6,8,11],coeff:0,coeffici:0,coil:[0,6],colab:8,colaboratori:15,collect:[0,3,14],com:[0,8,11,15],combin:[0,6,15],comm:0,comm_world:0,command:[8,11],common:9,commuic:0,commun:[0,3,10],communc:0,comp_pressur:0,compar:6,compat:2,compil:[0,8],compiler_so:8,complesfield:0,complet:[0,6,8],complex:[6,14],complexfield:0,compon:0,comprehens:15,compress:[0,3,4,6,9,11],compris:12,comput:[0,5,10,13,15],computaion:0,compute_angle_forces__plain:0,compute_bond_forces__plain:0,compute_dihedral_forces__plain:0,compute_field_and_kinetic_energi:0,compute_field_energy_q_gp:0,compute_field_forc:0,compute_potenti:0,compute_self_energy_q:0,concret:11,condit:[6,15],config:[0,8],config_simple_1:11,configur:[0,2,5,6,7,8,9,10,11],configuration_four_particle_exampl:10,configuration_three_particle_exampl:10,configuration_two_particle_exampl:10,configure_runtim:8,conform:[6,14,15],connect:0,conserv:1,consid:[0,6],consist:[0,6],consit:6,consitu:0,constant:[0,3,5,6,10,13,15],constitut:[0,2,3],constraint:3,construct:[0,10,11],constructor:0,contain:[0,1,2,3,6,11],content:[0,6],contribut:0,control:3,conv_crit:0,conv_fun:0,conveni:11,convent:0,converg:[0,13],convergence_typ:0,convert:0,coordin:[11,13,14],copi:0,core:8,correct:[0,3,13],correspond:[0,3,13],correspondingli:10,cos:[0,6,10],cosin:[0,3,6,10],cost:[3,10],could:8,coulomb:[0,3,4,5],coulomb_const:0,coulombtyp:[0,3,5,6],counter:6,coupl:[0,3,6,11],cprofil:2,cpu:[0,10],crash:3,creat:[0,9],critic:[0,6],cross:0,csvr:[0,3],csvr_thermostat:0,current:[0,6],cwd:8,cython:[8,15],d_n:0,data:[0,3,6,11,14],dataclass:0,dataset:[0,5,6,11],datatyp:14,date:[0,15],date_format:0,david:15,debug:[0,2],decompos:0,decomposit:[0,3,10],default_level:0,defaultnochi:[0,6,9],defaultnohchi:[0,3],defaultwithchi:[0,3,6,9],defin:[0,6,9,10,13],definit:0,degre:3,delta:[0,13],denot:[0,1,3,9,10,11],densiti:[0,3,5,9,13,15],depend:[0,6,10,13,15],deprec:0,deriv:[0,13],design:6,dest_directori:0,detail:[2,3,6,8,11,12,13],determin:[0,2,7,15],dev:8,devel:8,develop:[6,8],deviat:[0,3],dict:0,dictat:0,dictionari:0,dielectr:[0,3,6],dielectric_const:[0,3,5,6],dielectric_typ:0,dielectric_valu:0,dieter:0,differ:[0,3,6,11,14],differenti:[0,5,7,9,13],difficult:2,dih_typ:0,dihedr:[0,2,3,5,6,8,10,15],dimens:[0,10,11,14],dimension:11,dinola:0,dipol:[0,2,3,5,6,15],dipole_forces_redistribut:0,direct:[0,3,12],directori:11,disabl:[2,6,8,11],disable_mpio:0,discard:0,discret:[0,13],discretis:13,disk:[0,3],dispers:6,dist:8,distanc:[0,3,10],distinct:0,distribut:[0,3,5,6,13],distribute_input:0,distutil:8,dnf:8,doc:0,dockerhub:8,dodecyl:6,doe:[0,10],doi:15,domain:[0,3,10],domain_decomposit:[0,3,6],donadio:[0,15],done:[0,6,8,15],dopc:6,dot:0,dot_elec:0,doubl:2,double_out:0,download:8,dppc:6,draw:0,drawn:0,driver:[8,11],dtype:0,due:[0,3],dump:0,dump_per_particl:0,dure:[0,2,3,10,11],dynam:[0,3,11,13,15],e1785571:15,e_k:0,each:[0,3,6,10,11],easiest:15,effect:[0,3],effici:10,eight:14,either:[0,3,8,14],elec:0,elec_field:0,elec_field_contrib:0,elec_field_fouri:0,elec_forc:0,elecrostat:0,electr:[0,4,5],electrosat:0,electrostat:[0,6,15],els:3,elucid:6,embed:6,emit:0,emploi:0,empti:0,enabl:[2,6,11],enclos:0,end:0,energi:[0,1,3,4,6,7,10,11,12,13,15],energiesself:0,ensembl:15,ensur:[0,3,6,8,13],ensurepip:8,entri:3,epsilon:0,equal:[0,3,6],equat:0,equilibr:[3,6],equilibrium:[0,3,6],equilibrum:10,equival:[0,3],error:0,essenti:[0,1,8],etc:[2,3],even:[0,3,6,8],event:0,everi:[0,3,6,10,11],evid:0,ewald:[0,5,6],examin:6,exampl:[3,8,11,14,15],example_structur:11,except:10,exchang:[0,3],exec:8,execut:[0,8,11],exist:0,exit:8,exp:[7,13],expand:0,expans:0,expect:0,expens:[3,13],explicit:[0,6,10,15],express:[0,12],ext:0,extend:6,extens:15,extent:[0,7],extern:[0,3],extract:[0,8],f401:8,f_angl:0,f_bond:0,f_dihedr:0,f_dipol:0,f_on_bead:0,factor:0,factori:0,fail:[0,8],fals:[0,3,6],fapl:8,fashion:[0,3],fast:13,fedora:8,few:[6,9,10,11],fft:[0,1,2,3,5,6,11,13,15],fftw3:8,fftw:[8,15],field:[2,4,5,6,9,11,12,13,15],field_energi:0,field_list:0,field_q_energi:0,field_q_self_energi:0,file:[2,5,6,7,8,9,10,11,15],file_io:0,file_nam:0,file_path:0,filter:[0,3,5,6,11,12,15],find:[0,8],find_all_path:0,first:[0,3,6,11],five:0,fix:[0,8,11],flag:[0,14],flat:11,float32:[11,14],float64:14,flori:0,fluctuat:0,flush:[0,3],follow:[0,2,3,4,6,11,12],forc:[2,3,4,5,6,10],force_kernel:8,force_mesh:0,force_mesh_elec:0,force_mesh_elec_fouri:0,force_out:0,forego:2,form:[0,5,10,12],formal:[5,13],format:[0,2,3,5,11,14,15],formatt:0,fortran:[0,10],forward:0,found:[5,8],four:[0,2,3,6,14],fourier:[0,5,13],fr6nt9m4:8,frac:[0,5,6,7,9,10,12,13],frame:[0,11,14],framework:8,free:15,frequenc:[0,3],from:[0,2,3,5,6,8,9,10,11,12,15],full:[0,9,11],fulli:[0,6,8],fundament:11,gamma:0,gamma_0:0,gas:[0,4],gas_const:0,gather:0,gaussian:[0,3,7,12,13],gener:[0,2,3,6,15],get:8,getattr:8,ghost:0,giovanni:15,git:[8,11,15],github:[6,8,11,15],githubusercont:8,given:[0,3,6,7],glenn:15,global:0,gnu:15,govern:9,gpe:0,grab:8,gradient:0,grain:[0,3,7,12,13,15],graph:0,grid:[0,1,3,5,6,7,11,13],group:[0,3,6,8,11,14,15],guess:0,gunsteren:0,gyrat:6,h5md:[0,3],h5py:[0,2],h_0:[6,13],haak:0,half:0,hamiltonian:[3,5,6,7,9,11,15],handl:0,handler:0,happen:10,harmon:[0,3,6,10],has:[0,3,8,14],hat:[7,13],have:[0,6,8],hdf5:[0,2,3,5,6,8,11,14,15],hdf5_dir:8,hdf5_mpi:8,head:6,header:8,heat:[0,3],helic:[0,3,5,6],help:6,helper:0,here:[0,6,8,15],hhpf:[12,15],highli:[8,10,11],hijack:7,hire:1,homogen:0,homopolym:1,homopolypeptid:6,how:[3,11,15],howev:6,hpf:[3,5,9,11,13,15],html:0,http:[0,8,11,15],huggin:0,hundr:[6,10],hybrid:[11,13,15],hylleraa:15,hymd:[0,2,3,4,5,6,7,9,10,11,13,14],hymd_domain2023:15,ideal:10,ideal_chain:[6,8],ideal_ga:[6,11],ident:0,ignor:0,ijk:[5,13],imag:8,impact:0,implement:[0,10],importerror:8,impuls:[0,3],in_fil:[0,8],inam:8,includ:[0,2,3,6,13,15],incompress:[0,3],increas:[0,2,6],indentifi:0,independ:[0,3,7,13],index:[0,11,14,15],indic:[0,2,3,10,11,14],indirect:0,individu:[0,3,6],induc:5,inf:15,infer:10,info:[0,8],inform:[0,10,15],ingredi:6,initi:[0,14],initial_energi:0,initialis:11,initialize_pm:0,inner:[0,3],input:[2,3,4,5,6,7,8,11,14],input_box:0,input_pars:[0,8],insert:0,insid:[0,3,6],instal:[2,11],install_pfft:8,instantan:0,int32:[11,14],int64:14,integ:[0,3,6,14],integr:[3,6,11],integrate_posit:0,integrate_veloc:0,intend:8,inter:[0,10],interact:[0,2,3,4,6,7,11,12,13,15],interaction_energi:0,interfac:0,intergr:0,intermediari:0,intermolecular:6,intern:[0,2,3,4,10,12],interpol:[0,5],interpret:11,interv:[0,3],intmathrm:0,intracomm:0,intramolecular:[0,3,6,12,13,15],intrins:[3,5,13],introduc:6,investig:0,invok:[2,11],involv:[0,3,10],ion:6,ipynb:6,is_open:0,isobar:15,isotherm:0,isotrop:[0,3],iter:0,j_k:0,jcim:15,join:8,jone:13,joss:15,journal:15,jupyt:[6,8,15],k_e:0,kappa:[0,3,4,6,11,13],keep:[0,3],kelvin:[0,3,6,11],kernel:[0,10],keyword:[0,5,6,11],kinet:[0,12,13],kinetic_energi:0,knuth:0,kpa:4,kwd:8,l_a:12,label:[1,10],lambda:0,lamdifi:9,land:15,laplacian:0,larg:[8,11],larger:3,last:[6,8,11,14],last_bb:0,later:[0,6],latest:8,law:10,layout:0,layout_q:0,lbc20:15,leak:8,learn:15,leav:0,ledum:[6,15],left:[0,5,6,7,9,10,12,13],legend:1,lenght:0,length:[0,3,4,6,7,10,11,12,14],lennard:13,less:[0,6],lesser:15,let:[0,10],level:[0,2,3,14],lib64:8,lib:8,libhdf5:8,libopenmpi:8,librari:[0,2,8,15],libtool:8,libver:8,licens:15,lieu:0,like:[0,6,8,11],limit:[3,8],line:[0,8,11],linear:[0,3],lipid_self_assembl:6,list:0,list_coulomb:0,load:0,local:[0,8,10,11,13],locat:8,log:[0,2,11],log_fil:0,log_out:11,logfil:[2,11],logger:2,logic:0,logrecord:0,look:[6,8,11],loop:0,lost:3,low:[6,8],lsl:15,m_j:0,mac:8,machin:[2,15],made:0,mai:[0,2,3,6,8,10,11,14],main:[0,8,11],main_glob:8,maintain:15,make:[6,8],make_fapl:8,manner:6,manual:8,manuel:15,map:[0,11],march:15,martini:6,martyna:15,mass:[0,3,4,14],massiv:15,match:0,math:0,mathbf:[0,4,5,6,9,10,12,13],mathcal:[6,12,13],mathmr:0,mathrm:[0,5,6,9,10,13],matter:[6,10,15],max_molecule_s:[0,3,6],maximum:[0,3,10,11],maxwel:[0,3],may:2,mbbjm:15,mean:[0,2,3],measur:10,medium:[0,3,6],melt:1,membran:6,memori:[0,8],mesh:[0,1,3,5,6,15],mesh_siz:[0,3,6,11],messag:0,messi:0,meta:6,metadata:0,method:[0,1,6,7],mh_0:13,micellular:6,michael:15,michel:15,might:[0,8],mimic:0,minim:6,minuscul:10,mirror:2,miss:15,mix:[0,6],model:[6,15],modifi:0,modul:[0,3,8,15],mol:[3,4,6,10,11,15],molecul:[0,3,11,13,14],molecular:[0,2,11,13,15],momenta:[0,11],momentum:[0,3,4],monoatom:6,more:[2,3,6,8,11,13,15],mortel:8,morten:15,most:[8,9,11,12,13],mostli:2,motion:[0,6],move:0,mpi4pi:[0,8,15],mpi:[0,2,3,10,11,15],mpi_num_rank:11,mpicc:8,mpifilteral:0,mpifilterroot:0,mpio:[2,8],mpip:8,mpirun:11,multiarrai:8,multipl:[0,3,6,11,14,15],must:[0,3],n_b:[0,3],n_flush:[0,3,6],n_frame:0,n_particl:[0,3],n_print:[0,3,6,11],n_step:[0,3,6,11],n_type:0,nabla:[0,13],nabla_a:12,name:[0,2,3,6,10,11,14],nanomet:[0,1],nanosecond:6,natur:[0,12],ndarrai:0,ne5et1y_:8,necessari:[0,6],necessit:[8,9],need:[0,6],neg:[0,6],neighbour:0,network:[0,10,11,14],networkx:0,neutralis:6,never:[0,3],nevertheless:3,newer:8,next:[0,6],non:[0,2,6,8],none:[0,3,8],nongnu:0,noqa:8,normal:[0,2,3,8,13],notabl:11,note:[0,6,8,11,12,13],notebook:[6,8,15],now:6,nproc:11,npt:[0,13,15],nq_i:5,number:[0,1,2,3,6,11,13,14],numer:0,numpi:[0,2,9,15],nve:15,nvt:[0,15],object:[0,9],oblat:6,observ:[0,6],obtain:[0,3,5,12,13,15],obviou:8,off:6,omit:6,onc:[3,10],one:[0,2,3,6,14],onli:[0,6,10,11],onto:[0,3,5,13],open:[0,8,15],openmpi:8,oper:[0,3,13,15],oppos:0,optim:[0,10],optimis:[6,10],option:[0,3,6,11],order:[0,3,6,10,11],ordinari:[5,13],org:[0,15],organis:6,origin:0,oslo:15,osx:8,other:[0,11],otherwis:0,out:[8,13],outdataset:0,outer:[0,3],output:[2,3,4,6,8,11],outsid:3,over:0,overlap:[0,9],p_a:12,packag:[8,11,15],page:15,paint:0,paper:[0,15],parallel:[0,2,3,15],paramet:[0,3,6,7,9,12,13,15],parent_group:0,parllel:0,parrinello:[0,15],pars:[0,3],parse_config_toml:[0,8],part:[5,6,13],partial:[0,12],particl:[0,2,5,6,7,9,11,13,14,15],particlemesh:0,particular:11,pass:0,path:[0,2,8,11],pdf:1,pencil:0,peptid:[0,2,3,5,15],per:[0,2,3,10,11,14],perfect:0,perform:[0,3,8,10,11,13],perman:[10,15],permitt:[0,4],pfft:[0,15],pfft_build_dir:8,phase:[0,10],phase_separ:6,phi:[0,3,6,10,12,13],phi_0:[6,9,13],phi_:[0,6,9,13],phi_ep:0,phi_eps_fouri:0,phi_eta:0,phi_eta_fouri:0,phi_fft:0,phi_fouri:0,phi_k:0,phi_l:0,phi_laplacian:0,phi_n:[6,10],phi_pol:0,phi_pol_prev:0,phi_q:0,phi_q_fouri:0,phi_t:12,phi_transf:0,phospholipid:6,phy:[0,15],pic_spectr:[0,3,6],pic_spectral_gp:0,piec:6,pip13:15,pip3:8,pip:[8,11,15],pippig:15,pkg:8,place:[0,3],plain:2,plane:[0,6,10],pleas:[8,11],plist:8,plume:0,plumed_bia:0,plumed_out:0,pm_stuff:0,pme:15,pmesh:[0,15],png:1,point:[0,1,10,14],poisson:0,pol_mix:0,polar:0,polym:6,posit:[0,2,3,5,6,11,13],possibl:[0,3,6,15],postma:0,potenti:[0,3,4,5,7,8,10,15],ppft:15,practic:10,pre:[0,6],precis:[1,2],prefer:3,prepar:0,prepare_bond:0,prepare_bonds_old:0,prepare_index_based_bond:0,prepend:[0,11],present:[0,2,3,6],preserv:3,pressur:[4,13,15],pretti:8,previou:0,previous:6,prior:[0,3],priovid:0,prng:0,prod_:0,profil:2,program:[0,11],project:5,promot:0,prop:0,propag:[0,3],propens:[0,3,5,6],propensity_potential_coeff:0,properti:3,protein:[0,15],provid:[0,2,3,11,14,15],psi:[0,4,5],psi_:5,psi_fouri:0,pull:8,push:15,put:6,pytest:11,python3:[6,8,11,15],python:[0,11,15],q_i:[0,5],q_j:0,quadrat:0,quanit:0,quantiti:[0,4],quantum:15,quartet:10,quess:0,r_0:[0,6,10],r_a:10,r_c:10,rad:[3,10],radial:6,radii:6,radiu:6,rainwoodman:8,rais:[6,8],random:[0,2,11],random_chi_squar:0,random_gaussian:0,randomli:[0,3,6],rang:5,rank0:0,rank:[0,2,3,10,11],rank_rang:0,rankself:0,rare:10,raw:8,rdcc_nbyte:8,rdcc_nslot:8,rdcc_w0:8,read:[0,8,11,15],read_config_toml:[0,8],readout:0,real:14,realfield:0,realist:6,reappli:0,rearrang:0,reason:8,receiv:[0,3],recent:8,reciproc:[0,7],recognis:11,recommend:8,reconstruct:[0,2,5,6,10,15],record:0,recreat:15,recurs:0,redistribut:0,reduc:[3,13],refer:[3,11],regim:6,regul:[0,3],reiniti:0,rel:[0,3,6,10],relax:[0,3],releas:[0,6,8,11,15],remain:[0,6],remov:[0,3],remove_center_of_mass_momentum:0,remove_com_momentum:[0,3],replac:[0,8],repositori:[6,11],repres:[0,3,14],represent:7,repuls:3,requir:[0,3,8,10,11,15],rescal:[0,3,15],research:15,respa:[0,3,6],respa_inn:[0,3,6],respect:[0,1,13],restructur:0,result:[0,3,6,9],revers:[0,3,15],rho0:[0,3],rho:[0,5],rho_0:[0,13],rho_:5,right:[0,5,6,7,9,10,12,13],rightarrow:10,root:[0,11,14],roughi:6,row:11,rrespa:[0,3,6],ruin:0,run:[0,2,3,6,10],run_glob:8,rundown:11,runpi:8,runtimeerror:8,same:[0,3,6],samiran:15,sampl:[0,3,15],scalar:0,scale:[0,3,6,7,8,10,11,15],scheme:[0,6],sci:15,scienc:15,scr:3,script:11,sds:6,search:15,second:[0,11],see:[0,2,3,5,6,8,9,10,11,12,13,15],seed:[2,11],select:[11,15],self:[0,3,8],self_energi:0,semiisotrop:[0,3],seminumer:0,sen:15,send:[0,3],separ:0,seri:[0,3,6,10],serial:[8,11],serialis:3,set:[0,3,11],set_fapl:8,setup:[0,6,7,8,14],setup_time_dependent_el:0,setuptool:8,sever:0,shape:[0,6,11,14],sheet:0,shift:0,should:[0,2,10],shown:6,siam:15,sigbj:15,sigma:[0,3,6,7,11,12,13],sim:0,similar:0,simpl:[0,6,11,13],simplest:6,simpli:0,simul:[0,2,6,8,10,12,13,14,15],simultan:0,sinc:0,singl:[0,3,6],site:8,size:[0,3,6,11,13],slbc23:15,slight:0,slowli:13,small:[3,11],smear:5,smooth:[0,13],sodium:6,soft:[6,15],softwar:15,solv:0,solvent:6,some:[0,3,8],sort:0,sort_dielectric_by_type_id:0,sourc:[0,1],space:[0,3,5,7],span:0,spatial:[0,3,11,13],specfi:0,speci:0,special:0,specif:[0,2,3,6,9,10,11,13,14],specifi:[0,2,3,6,9,10,11,14],spectacularli:0,spectral:6,speed:[0,3],spheric:6,spheroid:6,split:0,spontan:6,spring:[0,10],sqrt:[0,7,13],squar:[0,9],squaredphi:[0,3,9,11],stabil:6,stabl:6,stackoverflow:0,standard:[0,3,13,15],start:[0,3,6,10,14],start_temperatur:[0,3,6],state:0,statu:8,stdout:[0,2],step:[0,3,6,10,11],stiff:3,stochast:0,store:0,store_data:0,store_stat:0,str10:11,str:0,straightforward:[7,9],stream:0,strength:[0,3,6,11],stretch:[0,3,10,15],string:[0,3,8,11,14],structur:[0,2,3,5,6,11],sub:6,subclass:[0,9],subsequ:[0,5,6,10],sudo:8,suitabl:[0,3],sulfat:6,sum:0,sum_:[0,5,9,12,13],sum_i:0,sum_j:0,sum_k:0,sum_n:[0,6,10],sum_t:12,summari:11,superclass:[0,7],support:[0,6,8],swap:10,symbol:[0,4,9],sympi:[0,9],sys:8,system:[0,1,2,3,6,9,11,13,15],t_a:12,tag:[0,3,8],take:[0,3,5,9,10,11,13],taken:0,tar:8,target:[0,3,13],target_pressur:[0,3],target_temperatur:[0,3,6,11],tau:[0,3,6,11],tau_p:[0,3],tbm92:15,temperatur:[0,3,4,6,11,13],ten:6,term:[0,3,6,9,12,13],test:[0,1],text:[0,2,3,4,5,6,9,10,12,13],than:[0,3],theoj:15,theori:[0,12],therefor:8,thermalis:[0,3],thermostat:[2,3,6,11],thermostat_coupling_group:[0,3,6],thermostat_work:0,theta:[6,10],theta_0:[0,6,10],thi:[0,2,3,6,8,9,10,11,13],thorough:11,though:6,thousand:[6,10],three:[0,2,3,6],through:[0,3,6,7,8,9,10,15],tild:[0,3,4,5,6,9,12,13],time:[0,3,4,6,10,11,15],time_step:[0,3,6,11],tmp:8,todo:0,togeth:[0,3,6],token:8,toml:[0,2,3,6,8,10,11],toml_cont:0,tomli:0,too:3,toplog:0,topol:0,topolog:[0,2,3,5,6,11,15],torsion:[0,3,10,15],total:[0,3,6,11,12,13],traceback:8,trajectori:[0,2,3,6,11],trans_matric:0,transfer:[0,10],transform:[0,9,13],travers:0,tri:3,trivial:0,truncat:0,tuckerman:[3,15],turn:6,tutori:[6,8,11,14],two:[0,2,3,6],txt:11,type:[0,2,3,5,6,9,10,11,14],type_arrai:0,type_charg:0,type_to_name_map:0,typic:3,ubuntu:8,uio:[8,11,15],unchang:0,under:[6,8,13,15],uniformli:0,uninstal:8,union:0,uniqu:0,unique_nam:0,unit:[0,3,10],univers:15,unknown:0,unless:[0,3],unmodifi:0,unset:0,unstabl:3,until:6,updat:[0,8],update_field:0,update_field_force_q:0,update_field_force_q_gp:0,upgrad:[8,15],url:15,usag:[0,2],use:[0,3,5,6,8],used:[0,1,2,3,6,7,9,11,13,14],uses:[0,4,13,15],using:[0,2,3,8,13,15],usr:8,usual:11,v_2:[0,6,10],v_3:[0,6,10],v_4:[0,6,10],v_ext:0,v_ext_fouri:0,vacuum:4,valid:[0,3],validated_config:0,valu:[0,3,4,5,6,10],valueerror:8,van:0,vanish:0,varepsilon:0,varepsilon_0:[4,5],vari:13,variabl:0,variant:6,variou:[0,14],vbar_elec:0,vbar_elec_fouri:0,vector:[3,10],vectoris:9,veloc:[0,2,3,4,6,11,14,15],velocity_out:0,velocti:0,verbos:[0,2,8,11],veri:[6,8,10],verifi:0,verlet:[0,3,6,11],versa:3,version:[0,6,8,11,13],vert:0,vertex:[0,5],vertic:0,via:[6,15],vice:3,vir:12,virial:12,vol:0,volum:[0,3,12,13,15],voxel:0,wai:[8,13],warn:0,weakli:3,weight:0,well:6,were:0,weslei:0,wheel:8,when:[0,3,8,10],where:[0,5,9,10,12,13],whether:[0,3],which:[0,2,3,5,6,8,9,10,11,12],width:[0,3],window:[0,5,13],without:[0,15],work:[0,8],workload:0,would:[0,3],wrap:0,wrapper:0,write:[0,3],written:[0,3],www:0,xinmeng:15,yet:0,yield:6,you:[8,10],zero:[0,3]},titles:["4. API reference","3. Benchmarks","5. Command line arguments","3. Configuration file","6. Constants and Units","3. Electrostatic interactions","1. Examples","2. Filtering","1. Installation","1. Interaction energy functionals","2. Intramolecular bonds","2. Usage overview for HylleraasMD","4. Pressure","1. Theory","4. Topology and structure file","HylleraasMD documentation"],titleterms:{"function":9,"import":8,"new":[7,9],"while":8,SDS:6,api:0,argument:2,assembl:6,barostat:0,benchmark:1,berendsen:0,bilay:6,bond:[1,3,10],build:8,calcul:13,chain:6,chi:9,code:15,colab:15,colaboratori:8,command:2,common:8,configur:3,constant:4,copolym:6,curl:8,dataset:14,depend:8,develop:15,diblock:6,docker:8,document:15,due:8,electrostat:[3,5],enabl:8,energi:9,error:8,exampl:6,extern:13,field:[0,1,3],file:[0,3,14],filter:[7,13],forc:[0,1,8,13],form:[9,13],fortran:8,four:10,gas:6,googl:[8,15],guid:15,h5py:8,hamiltonian:[0,13],helix:6,hylleraasmd:[11,15],hymd:[8,15],ideal:6,implement:[7,9],incompress:9,indic:15,input:0,instal:[8,15],integr:0,interact:[5,8,9],interpol:13,intramolecular:10,issu:8,kappa:9,kernel:8,keyword:3,line:2,lipid:6,logger:0,metadata:3,miss:8,mpi:8,numpi:8,onli:9,option:[2,14],output:0,overview:11,parallel:[8,11],parser:0,particl:[1,3,10],peptid:6,pfft:8,phase:6,phi:9,potenti:13,pressur:[0,3,12],python:8,reciproc:13,refer:[0,15],requir:[2,14],rod:6,run:[8,11,15],scr:0,self:6,separ:6,simul:[3,11],sourc:15,space:13,specifi:5,stiff:6,structur:14,tabl:15,test:11,theori:13,thermostat:0,three:10,topolog:14,two:10,unit:4,usag:11,user:15,wget:8,without:8}}) \ No newline at end of file diff --git a/v2.1.0/.buildinfo b/v2.1.0/.buildinfo new file mode 100644 index 00000000..f74bca4d --- /dev/null +++ b/v2.1.0/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 624b94b77cb2296653a35bc4e17ece7e +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v2.1.0/.doctrees/doc_pages/api.doctree b/v2.1.0/.doctrees/doc_pages/api.doctree new file mode 100644 index 00000000..eee15c84 Binary files /dev/null and b/v2.1.0/.doctrees/doc_pages/api.doctree differ diff --git a/v2.1.0/.doctrees/doc_pages/benchmarks.doctree b/v2.1.0/.doctrees/doc_pages/benchmarks.doctree new file mode 100644 index 00000000..f1669a11 Binary files /dev/null and b/v2.1.0/.doctrees/doc_pages/benchmarks.doctree differ diff --git a/v2.1.0/.doctrees/doc_pages/command_line.doctree b/v2.1.0/.doctrees/doc_pages/command_line.doctree new file mode 100644 index 00000000..9aa101ea Binary files /dev/null and b/v2.1.0/.doctrees/doc_pages/command_line.doctree differ diff --git a/v2.1.0/.doctrees/doc_pages/config_file.doctree b/v2.1.0/.doctrees/doc_pages/config_file.doctree new file mode 100644 index 00000000..1de31867 Binary files /dev/null and b/v2.1.0/.doctrees/doc_pages/config_file.doctree differ diff --git a/v2.1.0/.doctrees/doc_pages/constants_and_units.doctree b/v2.1.0/.doctrees/doc_pages/constants_and_units.doctree new file mode 100644 index 00000000..69b37cd5 Binary files /dev/null and b/v2.1.0/.doctrees/doc_pages/constants_and_units.doctree differ diff --git a/v2.1.0/.doctrees/doc_pages/electrostatics.doctree b/v2.1.0/.doctrees/doc_pages/electrostatics.doctree new file mode 100644 index 00000000..366896e8 Binary files /dev/null and b/v2.1.0/.doctrees/doc_pages/electrostatics.doctree differ diff --git a/v2.1.0/.doctrees/doc_pages/examples.doctree b/v2.1.0/.doctrees/doc_pages/examples.doctree new file mode 100644 index 00000000..3f5ac381 Binary files /dev/null and b/v2.1.0/.doctrees/doc_pages/examples.doctree differ diff --git a/v2.1.0/.doctrees/doc_pages/filtering.doctree b/v2.1.0/.doctrees/doc_pages/filtering.doctree new file mode 100644 index 00000000..1764d67b Binary files /dev/null and b/v2.1.0/.doctrees/doc_pages/filtering.doctree differ diff --git a/v2.1.0/.doctrees/doc_pages/installation.doctree b/v2.1.0/.doctrees/doc_pages/installation.doctree new file mode 100644 index 00000000..da8017b0 Binary files /dev/null and b/v2.1.0/.doctrees/doc_pages/installation.doctree differ diff --git a/v2.1.0/.doctrees/doc_pages/interaction_energy_functionals.doctree b/v2.1.0/.doctrees/doc_pages/interaction_energy_functionals.doctree new file mode 100644 index 00000000..9efed988 Binary files /dev/null and b/v2.1.0/.doctrees/doc_pages/interaction_energy_functionals.doctree differ diff --git a/v2.1.0/.doctrees/doc_pages/interfaces.doctree b/v2.1.0/.doctrees/doc_pages/interfaces.doctree new file mode 100644 index 00000000..7ddee8b1 Binary files /dev/null and b/v2.1.0/.doctrees/doc_pages/interfaces.doctree differ diff --git a/v2.1.0/.doctrees/doc_pages/intramolecular_bonds.doctree b/v2.1.0/.doctrees/doc_pages/intramolecular_bonds.doctree new file mode 100644 index 00000000..6a69ed85 Binary files /dev/null and b/v2.1.0/.doctrees/doc_pages/intramolecular_bonds.doctree differ diff --git a/v2.1.0/.doctrees/doc_pages/overview.doctree b/v2.1.0/.doctrees/doc_pages/overview.doctree new file mode 100644 index 00000000..92991656 Binary files /dev/null and b/v2.1.0/.doctrees/doc_pages/overview.doctree differ diff --git a/v2.1.0/.doctrees/doc_pages/pressure.doctree b/v2.1.0/.doctrees/doc_pages/pressure.doctree new file mode 100644 index 00000000..3b111239 Binary files /dev/null and b/v2.1.0/.doctrees/doc_pages/pressure.doctree differ diff --git a/v2.1.0/.doctrees/doc_pages/theory.doctree b/v2.1.0/.doctrees/doc_pages/theory.doctree new file mode 100644 index 00000000..baef613a Binary files /dev/null and b/v2.1.0/.doctrees/doc_pages/theory.doctree differ diff --git a/v2.1.0/.doctrees/doc_pages/topology_input.doctree b/v2.1.0/.doctrees/doc_pages/topology_input.doctree new file mode 100644 index 00000000..d8f5d66f Binary files /dev/null and b/v2.1.0/.doctrees/doc_pages/topology_input.doctree differ diff --git a/v2.1.0/.doctrees/environment.pickle b/v2.1.0/.doctrees/environment.pickle new file mode 100644 index 00000000..20a8ef20 Binary files /dev/null and b/v2.1.0/.doctrees/environment.pickle differ diff --git a/v2.1.0/.doctrees/index.doctree b/v2.1.0/.doctrees/index.doctree new file mode 100644 index 00000000..836a4c09 Binary files /dev/null and b/v2.1.0/.doctrees/index.doctree differ diff --git a/v2.1.0/_downloads/34e181af408678710cbbd4fb98e80d71/benchmarks-1.pdf b/v2.1.0/_downloads/34e181af408678710cbbd4fb98e80d71/benchmarks-1.pdf new file mode 100644 index 00000000..9f2a7994 Binary files /dev/null and b/v2.1.0/_downloads/34e181af408678710cbbd4fb98e80d71/benchmarks-1.pdf differ diff --git a/v2.1.0/_downloads/3c945b95edd98b40d354622557c432ca/benchmarks-2.pdf b/v2.1.0/_downloads/3c945b95edd98b40d354622557c432ca/benchmarks-2.pdf new file mode 100644 index 00000000..55055fc1 Binary files /dev/null and b/v2.1.0/_downloads/3c945b95edd98b40d354622557c432ca/benchmarks-2.pdf differ diff --git a/v2.1.0/_downloads/6ca31d19d7eef5039179ad6c1fa57634/benchmarks-2.hires.png b/v2.1.0/_downloads/6ca31d19d7eef5039179ad6c1fa57634/benchmarks-2.hires.png new file mode 100644 index 00000000..82806426 Binary files /dev/null and b/v2.1.0/_downloads/6ca31d19d7eef5039179ad6c1fa57634/benchmarks-2.hires.png differ diff --git a/v2.1.0/_downloads/781b262f84d79a879382a54ddef79579/benchmarks-2.py b/v2.1.0/_downloads/781b262f84d79a879382a54ddef79579/benchmarks-2.py new file mode 100644 index 00000000..fd287cbc --- /dev/null +++ b/v2.1.0/_downloads/781b262f84d79a879382a54ddef79579/benchmarks-2.py @@ -0,0 +1,33 @@ +import numpy as np +import matplotlib.pyplot as plt + +mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] +mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + +mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + +mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + +mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] +mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + +mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + +mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + +plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") +plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") +plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") +plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") +plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") +plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") +plt.xlabel("CPUs", fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.ylabel("Time per step, s", fontsize=15) +plt.legend(loc="upper left", fontsize=15) +plt.show() \ No newline at end of file diff --git a/v2.1.0/_downloads/822f2d70dc3f622e0c7cdebd46e5ff4b/benchmarks-1.py b/v2.1.0/_downloads/822f2d70dc3f622e0c7cdebd46e5ff4b/benchmarks-1.py new file mode 100644 index 00000000..deb4348f --- /dev/null +++ b/v2.1.0/_downloads/822f2d70dc3f622e0c7cdebd46e5ff4b/benchmarks-1.py @@ -0,0 +1,38 @@ +import numpy as np +import matplotlib.pyplot as plt +nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) +time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 +], dtype=np.float64) +nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 +], dtype=np.float64,) +time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, +], dtype=np.float64) +nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 +], dtype=np.float64) +time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, +], dtype=np.float64) +plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" +) +plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" +) +plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" +) +plt.xlabel("CPUs", fontsize=15) +plt.ylabel("Time per step, us", fontsize=15) +plt.legend(fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.show() \ No newline at end of file diff --git a/v2.1.0/_downloads/87c86d38867ba414c922fb3946a3a560/benchmarks-2.png b/v2.1.0/_downloads/87c86d38867ba414c922fb3946a3a560/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v2.1.0/_downloads/87c86d38867ba414c922fb3946a3a560/benchmarks-2.png differ diff --git a/v2.1.0/_downloads/90e97805d5b4c37812b70e852301c49d/benchmarks-1.hires.png b/v2.1.0/_downloads/90e97805d5b4c37812b70e852301c49d/benchmarks-1.hires.png new file mode 100644 index 00000000..173b39f3 Binary files /dev/null and b/v2.1.0/_downloads/90e97805d5b4c37812b70e852301c49d/benchmarks-1.hires.png differ diff --git a/v2.1.0/_downloads/a74a82833e9d9928de5f8aea4dc1118c/benchmarks-1.png b/v2.1.0/_downloads/a74a82833e9d9928de5f8aea4dc1118c/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v2.1.0/_downloads/a74a82833e9d9928de5f8aea4dc1118c/benchmarks-1.png differ diff --git a/v2.1.0/_images/benchmarks-1.png b/v2.1.0/_images/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v2.1.0/_images/benchmarks-1.png differ diff --git a/v2.1.0/_images/benchmarks-2.png b/v2.1.0/_images/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v2.1.0/_images/benchmarks-2.png differ diff --git a/v2.1.0/_images/hylleraas_centre_logo_black.png b/v2.1.0/_images/hylleraas_centre_logo_black.png new file mode 100644 index 00000000..40826396 Binary files /dev/null and b/v2.1.0/_images/hylleraas_centre_logo_black.png differ diff --git a/v2.1.0/_images/uio_full_logo_eng_pos.png b/v2.1.0/_images/uio_full_logo_eng_pos.png new file mode 100644 index 00000000..6c603139 Binary files /dev/null and b/v2.1.0/_images/uio_full_logo_eng_pos.png differ diff --git a/v2.1.0/_modules/hymd/barostat.html b/v2.1.0/_modules/hymd/barostat.html new file mode 100644 index 00000000..c01251bd --- /dev/null +++ b/v2.1.0/_modules/hymd/barostat.html @@ -0,0 +1,604 @@ + + + + + + hymd.barostat — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.barostat

+"""Implements the Berendsen barostat.
+Scales the box and particle positions during simulation to
+simulate coupling to an external pressure bath set at a
+target pressure.
+
+It calculates the scaling factor according to:
+.. math::
+
+    \\alpha_{L,N} = 1 - \\frac{dt n_b}{\\tau_p}\\β(P_{L,N}^t - P_{L,N})
+
+where :math:`dt` is the outer rRESPA time-step, :math:`n_b` is the frequency
+of barostat calls, :math:`\\tau_p` is the pressure coupling time constant,
+:math:`\\beta` is the isothermal compressibility, :math:`P_{L,N}^t` and 
+:math:`P_{L,N}` is the target and instantaneous internal pressure in the 
+lateral (L) and normal (N) directions respectively. Convention: Cartesian
+z-direction is considered normal.
+
+The box and particle positions are scaled in the L and N directions according
+to the nature of the barostat (see functions `isotropic` and `semiisotropic`
+below by an amount :math:`\α^{\\frac{1}{3}}`.
+
+The updated system information is passed on to the pmesh objects.
+
+References
+----------
+H. J. C. Berendsen, J. P. M. Postma, W. F. van Gunsteren,
+A. DiNola, and J. R. Haak , "Molecular dynamics with coupling
+to an external bath", J. Chem. Phys. 81, 3684-3690 (1984)
+"""
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass
+from typing import Union
+from .pressure import comp_pressure
+from .field import initialize_pm
+
+
+@dataclass
+class Target_pressure:
+    P_L: Union[bool, float]
+    P_N: Union[bool, float]
+
+
+
[docs]def isotropic( + pmesh, + pm_stuff, + phi, + phi_q, + psi, + hamiltonian, + positions, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + bond_pr, + angle_pr, + step, + prng, + comm=MPI.COMM_WORLD, +): + """ + Implements an isotropic Berendsen barostat. + The box and particle positions are scaled uniformly + in the L and N directions. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of pmesh objects. + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fft : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds. + step : integer + MD step number + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of modified/unmodified pmesh objects. + change : Boolean + Indicates whether or not any pmesh objects were reinitialized. + """ + rank = comm.Get_rank() + beta = 4.6 * 10 ** (-5) # bar^(-1) #isothermal compressibility of water + change = False + + if np.mod(step, config.n_b) == 0: + change = True + # compute pressure + pressure = comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=comm, + ) + + # Total pressure across all ranks + P = np.average(pressure[-3:-1]) # kJ/(mol nm^3) + P = P * 16.61 # bar + + # scaling factor + alpha = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_L - P) + ) ** (1 / 3) + + # length scaling + config.box_size *= alpha + + # position coordinates scaling + positions *= alpha + + # pmesh re-initialize + pm_stuff = initialize_pm(pmesh, config, comm) + return (pm_stuff, change)
+ + +
[docs]def semiisotropic( + pmesh, + pm_stuff, + phi, + phi_q, + psi, + hamiltonian, + positions, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + bond_pr, + angle_pr, + step, + prng, + comm=MPI.COMM_WORLD, +): + """ + Implements a semiisotropic Berendsen barostat. + The box and particle positions are scaled by :math:`\\alpha_L^{\\frac{1}{3}}` + in the L direction and by :math:`\\alpha_N^{\\frac{1}{3}}` in the N direction. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of pmesh objects. + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fft : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds. + step : integer + MD step number + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of modified/unmodified pmesh objects. + change : Boolean + Indicates whether or not any pmesh objects were reinitialized. + """ + rank = comm.Get_rank() + beta = 4.6 * 10 ** (-5) # bar^(-1) #isothermal compressibility of water + change = False + if np.mod(step, config.n_b) == 0: + change = True + + # compute pressure + pressure = comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=comm, + ) + + # Total pressure across all ranks + # L: Lateral; N: Normal + [PL, PN] = [0, 0] + PL = (pressure[-3] + pressure[-2]) / 2 # kJ/(mol nm^3) + PN = pressure[-1] # kJ/(mol nm^3) + PL = PL * 16.61 # bar + PN = PN * 16.61 # bar + alphaL = 1.0 + alphaN = 1.0 + + if config.target_pressure.P_L: + # scaling factor + alphaL = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_L - PL) + ) ** (1 / 3) + # length scaling + config.box_size[0:2] *= alphaL + + positions[:][0:2] *= alphaL + + if config.target_pressure.P_N: + # scaling factor + alphaN = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_N - PN) + ) ** (1 / 3) + # length scaling + config.box_size[2] *= alphaN + + positions[:][2] *= alphaN + + # pmesh re-initialize + pm_stuff = initialize_pm(pmesh, config, comm) + return (pm_stuff, change)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/_modules/hymd/field.html b/v2.1.0/_modules/hymd/field.html new file mode 100644 index 00000000..ed446a2b --- /dev/null +++ b/v2.1.0/_modules/hymd/field.html @@ -0,0 +1,1473 @@ + + + + + + hymd.field — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.field

+"""Forces and energies from the discretized particle-field grid interactions
+"""
+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import warnings
+
+
+
[docs]def initialize_pm(pmesh, config, comm=MPI.COMM_WORLD): + """ + Creates the necessary pmesh objects for pfft operations. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + config : Config + Configuration dataclass containing simulation metadata and parameters. + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm : object 'pmesh.pm.ParticleMesh' + field_list : list[pmesh.pm.RealField], (multiple) + Essential list of pmesh objects required for MD + list_coulomb : list[pmesh.pm.RealField], (multiple) + Additional list of pmesh objects required for electrostatics. + """ + + if config.dtype == np.float64: + pmeshtype = "f8" + else: + pmeshtype = "f4" + # Ignore numpy numpy.VisibleDeprecationWarning: Creating an ndarray from + # ragged nested sequences until it is fixed in pmesh + with warnings.catch_warnings(): + warnings.filterwarnings( + action="ignore", + category=np.VisibleDeprecationWarning, + message=r"Creating an ndarray from ragged nested sequences", + ) + # The first argument of ParticleMesh has to be a tuple + pm = pmesh.ParticleMesh( + config.mesh_size, BoxSize=config.box_size, dtype=pmeshtype, comm=comm + ) + phi = [pm.create("real", value=0.0) for _ in range(config.n_types)] + phi_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] # noqa: E501 + force_on_grid = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + v_ext_fourier = [pm.create("complex", value=0.0) for _ in range(4)] + v_ext = [pm.create("real", value=0.0) for _ in range(config.n_types)] + + phi_transfer = [pm.create("complex", value=0.0) for _ in range(3)] + + phi_laplacian = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + + # Initialize charge density fields + coulomb_list = [] + elec_common_list = [None, None, None, None] + _SPACE_DIM = config.box_size.size + + if config.coulombtype == "PIC_Spectral_GPE" or config.coulombtype == "PIC_Spectral": + phi_q = pm.create("real", value=0.0) + phi_q_fourier = pm.create("complex", value=0.0) + psi = pm.create("real", value=0.0) + elec_field = [pm.create("real", value=0.0) for _ in range(_SPACE_DIM)] + + elec_common_list = [phi_q, phi_q_fourier, psi, elec_field] + + if config.coulombtype == "PIC_Spectral": + elec_field_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] # for force calculation + psi_fourier = pm.create("complex", value=0.0) + + coulomb_list = [ + elec_field_fourier, + psi_fourier, + ] + + if ( + config.coulombtype == "PIC_Spectral_GPE" + ): ## initializing the density mesh #dielectric_flag + phi_eps = pm.create( + "real", value=0.0 + ) ## real contrib of the epsilon dielectric painted to grid + phi_eps_fourier = pm.create("complex", value=0.0) # complex contrib of phi eps + phi_eta = [ + pm.create("real", value=0.0) for _ in range(_SPACE_DIM) + ] ## real contrib of factor in polarization charge density + phi_eta_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] ## fourier of factor in polarization charge density + phi_pol = pm.create( + "real", value=0.0 + ) ## real contrib of the polarization charge + phi_pol_prev = pm.create("real", value=0.0) + elec_dot = pm.create("real", value=0.0) + elec_field_contrib = pm.create( + "real", value=0.0 + ) # needed for pol energies later + + # External potential and force meshes + Vbar_elec = [pm.create("real", value=0.0) for _ in range(config.n_types)] + Vbar_elec_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] + force_mesh_elec = [ + [pm.create("real", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + force_mesh_elec_fourier = [ + [pm.create("complex", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + + coulomb_list = [ + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol, + phi_pol_prev, + elec_dot, + elec_field_contrib, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + ] + + field_list = [ + phi, + phi_fourier, + force_on_grid, + v_ext_fourier, + v_ext, + phi_transfer, + phi_laplacian, + ] + + return (pm, field_list, elec_common_list, coulomb_list)
+ + +
[docs]def compute_field_force(layouts, r, force_mesh, force, types, n_types): + """Interpolate particle-field forces from the grid onto particle positions + + Backmaps the forces calculated on the grid to particle positions using the + window function :math:`P` (by default cloud-in-cell [CIC]). In the + following, let :math:`\\mathbf{F}_j` denote the force acting on the + particle with index :math:`j` and position :math:`\\mathbf{r}_j`. The + interpolated force is + + .. math:: + + \\mathbf{F}_j = -\\sum_k\\nabla V_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`V_{j_k}` is the discretized external potential at grid vertex + :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid vertex + with index :math:`j_k`, and :math:`h^3` is the volume of each grid voxel. + The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + r : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + force : (N,D) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. Local + for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + n_types : int + Number of different unique types present in the simulation system. + :code:`n_types` is global, i.e. the same for all MPI ranks even if some + ranks contain zero particles of certain types. + """ + for t in range(n_types): + ind = types == t + for d in range(3): + force[ind, d] = force_mesh[t][d].readout(r[ind], layout=layouts[t])
+ + +
[docs]def compute_self_energy_q(config, charges, comm=MPI.COMM_WORLD): + """Compute the self energy for the interaction due to the Ewald scheme + used to compute the electrostatics. The energy is stored in :code:`config`. + + The self interaction energy is given by: + + .. math:: + + U_{self} = \\sqrt{\\frac{1}{2\\pi\\sigma^2}} \\sum_{i=1}^{N} q_i^2 + + where :math:`q_i` are the charges and :math:`\\sigma` is the half-width + of the Gaussian filter. + + Parameters + ---------- + config : Config + Configuration object. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + comm : mpi4py.Comm + MPI communicator to use for rank communication. + + Returns + ------- + field_q_self_energy : float + Electrostatic self energy. + """ + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + prefac = elec_conversion_factor * np.sqrt( + 1.0 / (2.0 * np.pi * config.sigma * config.sigma) + ) + _squared_charges = charges * charges + squared_charges_sum = comm.allreduce(np.sum(_squared_charges)) + return prefac * squared_charges_sum
+ + +
[docs]def update_field_force_q( + charges, + phi_q, + phi_q_fourier, + psi, + psi_fourier, + elec_field_fourier, + elec_field, + elec_forces, + layout_q, + hamiltonian, + pm, + positions, + config, +): + """Calculate the electrostatic particle-field forces on the grid + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential is computed in reciprocal space as + + .. math:: + + \\Phi = \\mathrm{FFT}^{-1}\\left[ + \\frac{4\\pi k_e}{\\varepsilon \\vert\\mathbf{k}\\vert^2} + \\mathrm{FFT}(\\rho)\\mathrm{FFT}(H) + \\right], + + with the electric field + + .. math:: + + \\mathbf{E} = \\mathrm{FFT}^{-1}\\left[ + -i\\mathbf{k}\\,\\mathrm{FFT}(\\Psi) + \\right]. + + In the following, let :math:`\\mathbf{F}_j` denote the electrostatic force + acting on the particle with index :math:`j` and position + :math:`\\mathbf{r}_j`. The interpolated electrostatic force is + + .. math:: + + \\mathbf{F}_j = \\sum_k q_j\\mathbf{E}_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`\\mathbf{E}_{j_k}` is the discretized electric field at grid + vertex :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid + vertex with index :math:`j_k`, and :math:`h^3` is the volume of each grid + voxel. The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty; any values in this field + are discarded. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + elec_field_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + electric field values in reciprocal space on the computational grid. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + n_dimensions = config.box_size.size + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + # charges to grid + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) + phi_q /= volume_per_cell + # print("phi_q", np.sum(phi_q)) + phi_q.r2c(out=phi_q_fourier) + + # smear charges with filter + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + + # solve Poisson equation in Fourier space to get electrostatic potential + def poisson_transfer_function(k, v): + return 4.0 * np.pi * elec_conversion_factor * v / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(poisson_transfer_function, out=psi_fourier) + # print("psi_fourier", np.sum(psi_fourier)) + psi_fourier.c2r(out=psi) + # print("phi_q * psi update_field", np.sum(phi_q * psi)) + + # exit() + + # compute electric field directly from smeared charged densities in Fourier + for _d in np.arange(n_dimensions): + + def poisson_transfer_function(k, v, d=_d): + return ( + -1j + * k[d] + * 4.0 + * np.pi + * elec_conversion_factor + * v + / k.normp(p=2, zeromode=1) + ) + + phi_q_fourier.apply(poisson_transfer_function, out=elec_field_fourier[_d]) + elec_field_fourier[_d].c2r(out=elec_field[_d]) + + # get electrostatic force from electric field + for _d in np.arange(n_dimensions): + elec_forces[:, _d] = charges * ( + elec_field[_d].readout(positions, layout=layout_q) + )
+ + +def comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, +): + for t in range(config.n_types): + np.copyto(phi_transfer[0].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[1].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[2].value, phi_fourier[t].value, casting="no", where=True) + + # Evaluate laplacian of phi in fourier space + for d in range(3): + + def laplacian_transfer(k, v, d=d): + return -k[d] ** 2 * v + + phi_transfer[d].apply(laplacian_transfer, out=Ellipsis) + phi_transfer[d].c2r(out=phi_laplacian[t][d]) + + +
[docs]def update_field( + phi, + phi_laplacian, + phi_transfer, + layouts, + force_mesh, + hamiltonian, + pm, + positions, + types, + config, + v_ext, + phi_fourier, + v_ext_fourier, + m, + compute_potential=False, +): + """Calculate the particle-field potential and force density + + If :code:`compute_potential` is :code:`True`, the energy may subsequently + be computed by calling :code:`compute_field_and_kinetic_energy`. + + Computes the particle-field external potential :math:`V_\\text{ext}` from + particle number densities through the smoothed density field, + :math:`\\phi(\\mathbf{r})`. With :math:`P` being the cloud-in-cell (CIC) + window function, the density and filtered densities are computed as + + .. math:: + + \\phi(\\mathbf{r}) = \\sum_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\phi(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\phi(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + external potential is computed in reciprocal space as + + .. math:: + + V_\\text{ext} = \\mathrm{FFT}^{-1}\\left[ + \\mathrm{FFT} + \\left( + \\frac{\\partial w}{\\partial \\tilde\\phi} + \\right) + \\mathrm{FFT}(H) + \\right], + + where :math:`w` is the interaction energy functional. Differentiating + :math:`V_\\text{ext}` is done by simply applying :math:`i\\mathbf{k}` in + Fourier space, and the resulting forces are back-transformed to direct + space and interpolated to particle positions by + + .. math:: + + \\mathbf{F}_j = -\\sum_{j_k} \\nabla V_{j_k} + P(\\mathbf{r}_{j_k} - \\mathbf{r}_j)h^3, + + where :math:`j_k` are the neighbouring vertices of particle :math:`j` at + position :math:`\\mathbf{r}_j`, and :math:`h^3` is the volume of each grid + voxel. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Pre-allocated, but empty; any values + in this field are discarded. Changed in-place. Local for each MPI + rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + config : Config + Configuration object. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Pre-allocated, but empty; any values in this field are + discarded Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + phi_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computational grid is represented by the collective fields of all + MPI ranks. + v_ext_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplesField` objects containing discretized + particle-field external potential values in reciprocal space on the + computational grid; :code:`D+1` fields in D dimensions for each + particle type. :code:`D` copies are made after calculation for later + use in force calculation, because the `force transfer function` + application differentiates the field in-place, ruining the contents + for differentiation in the remaining :code:`D-1` spatial directions. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + m: list[float], (M,) + pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. + Defaults to 1.0 for all particle types. + compute_potential : bool, optional + If :code:`True`, a :code:`D+1`-th copy of the Fourier transformed + external potential field is made to be used later in particle-field + energy calculation. If :code:`False`, only :code:`D` copies are made. + + See also + -------- + compute_field_and_kinetic_energy : + Compute the particle-field energy after the external potential is + calculated. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + for t in range(config.n_types): + pm.paint(positions[types == t], mass=m[t], layout=layouts[t], out=phi[t]) + phi[t] /= volume_per_cell + phi[t].r2c(out=phi_fourier[t]) + phi_fourier[t].apply(hamiltonian.H, out=Ellipsis) + phi_fourier[t].c2r(out=phi[t]) + + # External potential + for t in range(config.n_types): + v = hamiltonian.v_ext[t](phi) + + v.r2c(out=v_ext_fourier[0]) + v_ext_fourier[0].apply(hamiltonian.H, out=Ellipsis) + np.copyto( + v_ext_fourier[1].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + np.copyto( + v_ext_fourier[2].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + if compute_potential: + np.copyto( + v_ext_fourier[3].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + + # Differentiate the external potential in fourier space + for d in range(3): + + def force_transfer_function(k, v, d=d): + return -k[d] * 1j * v + + v_ext_fourier[d].apply(force_transfer_function, out=Ellipsis) + v_ext_fourier[d].c2r(out=force_mesh[t][d]) + + if compute_potential: + v_ext_fourier[3].c2r(out=v_ext[t])
+ + +
[docs]def compute_field_and_kinetic_energy( + phi, + phi_q, + psi, + velocity, + hamiltonian, + positions, + types, + v_ext, + config, + layouts, + comm=MPI.COMM_WORLD, +): + """Compute the particle-field and kinetic energy contributions + + Calculates the kinetic energy through + + .. math:: + + E_k = \\sum_j \\frac{1}{2}m_j\\mathbf{v}_j\\cdot\\mathbf{v}_j, + + and the particle-field energy by + + .. math:: + + E_\\text{field} = \\int\\mathrm{d}\\mathbf{r}\\, + w[\\tilde\\phi], + + where :math:`w` is the interaction energy functional `density`. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + velocity : (N,D) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Local for each MPI rank--the full computational grid is + represented by the collective fields of all MPI ranks. + config : Config + Configuration object. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field : + Computes the up-to-date external potential for use in calculating the + particle-field energy. + """ + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + field_energy = w_0.csum() # w to W + + kinetic_energy = comm.allreduce(0.5 * config.mass * np.sum(velocity**2)) + + if config.coulombtype == "PIC_Spectral": + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + field_q_energy = w_elec.csum() + else: + field_q_energy = 0.0 + + return field_energy, kinetic_energy, field_q_energy
+ + +
[docs]def compute_field_energy_q_GPE( + config, + phi_eps, + field_q_energy, + dot_elec, + comm=MPI.COMM_WORLD, +): + """ + Compute the electrostatic energy after electrosatic forces is + calculated. + + From the definition of the elecrostatic potential :math:`\\Psi`, the energy + is + + W = \\frac{1}{2}\\int\\mathrm{d}\\mathbf{r}\\, + \\epsilon(\\mathbf{r})} \\left(\\mathbf{E}\\cdot \\mathbf{E}\\right), + + where :math:`\\epsilon(\\mathbf{r})}` is the anisotropic, spatially dependent, + relative dielectric of the simulation medium. + + Parameters + ---------- + config : hymd.input_parser.Config + Configuration object. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + field_q_energy : float + Total elecrostatic energy. + dot_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing :math:`|\\mathbf{E(r)}|^{2}` + on the computational grid. Local for each MPI rank -- the full computational + grid is represented by the collective fields of all MPI ranks. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field_force_q_GPE: + Compute the electrosatic force from an anisotropic dielectric general + Poisson equation. + """ + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + # ^ due to integration on local cell before allreduce + + eps_0 = 1.0 / (config.coulomb_constant * 4 * np.pi) + field_q_energy = ( + volume_per_cell * (0.5 * eps_0) * comm.allreduce(np.sum(phi_eps * dot_elec)) + ) + + return field_q_energy
+ + +
[docs]def update_field_force_q_GPE( + conv_fun, + phi, + types, + charges, + phi_q, + phi_q_fourier, + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol_prev, + phi_pol, + elec_field, + elec_forces, + elec_field_contrib, + psi, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + hamiltonian, + layout_q, + layouts, + pm, + positions, + config, + comm=MPI.COMM_WORLD, +): + """ + Calculate the electrostatic particle-field forces on the grid, arising from + a general Poisson equation, i.e. anisotropic permittivity/dielectric. + The function is called when tomli input config.coulombtype = "PIC_Spectral_GPE." + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential for a variable dielectric does not have an + analytical expression, and is computed in reciprocal through an iterative + method. + + The GPE states that + + .. math:: + + \\nabla \\cdot \\left(\\epsilon(\\mathbf{r}) + \\nabla{\\mathbf{\\psi(r)}}\\right) = -\\rho({\\mathbf{r}}). + + where :math:`\\epsilon(\\mathbf{r})` is the relative dielectric function. + + Parameters + ---------- + conv_fun : Convergence function. + Returns a scalar. Depends on MPI allreduce for similar convergence + across MPI ranks. + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_eta : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + gradients of the relative dielectric values on the computational grid. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank--the + full computational grid is represented by the collective fields of all MPI ranks. + phi_eta_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated discretized + Fourier transformed gradient relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol_prev : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charge values on the computational grid. Parameter in + the iterative method.Pre-allocated,but empty. Changedin-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charges on the computational grid. Parameter in the iterative + method, updating the next quess in solving for the electrostatic potential. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all + MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + elec_field_contrib : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing + :math:`|\\mathbf{E(r)}|^2/\\phi_{0}` on the computational grid. + Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + psi : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic potential + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + Vbar_elec : mesh.pm.RealField + Pmesh :code:`RealField` object for storing functional derivatives of + :math:`\\|w(\\{ \\phi \\})_{elec}`on the computational grid. + Pre-allocated, but empty. Changed in-place. Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + Vbar_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated functional + derivatives of :math:`\\|w(\\{ \\phi \\})_{elec}` in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + force_mesh_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic force values + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + force_mesh_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated electrostatic + force values in reciprocal space on the computational grid. Local for + each MPI rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + layouts: list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + comm: mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + compute_field_energy_q_GPE: + Compute the electrostatic energy after electrosatic force is + calculated for a variable (anisotropic) dielectric general Poisson equation. + """ + + ## basic setup + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + ## old protocol in gen_qe_hpf_use_self + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) ## + ## scale and fft + ## old protocol in gen_qe_hpf_use_self + phi_q /= volume_per_cell + phi_q.r2c(out=phi_q_fourier) + + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + ## ^------ use the same gaussian as the \kai interaciton + phi_q_fourier.c2r(out=phi_q) ## this phi_q is after applying the smearing function + + denom_phi_tot = pm.create("real", value=0.0) + num_types = pm.create("real", value=0.0) + ### ^ ----- Calculate the relative dielectric (permittivity) to field + ### ------- from a mean contribution of particle number densities + + for t_ in range(config.n_types): + num_types = num_types + (config.dielectric_type[t_]) * phi[t_] + denom_phi_tot = denom_phi_tot + phi[t_] + + np.divide(num_types, denom_phi_tot, where=np.abs(denom_phi_tot > 1e-6), out=phi_eps) + + phi_eps.r2c(out=phi_eps_fourier) # FFT dielectric + + # phi_q_eps = (phi_q/phi_eps) + np.divide(phi_q, phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_q) + + _SPACE_DIM = 3 + ##^--------- constants needed throughout the calculations + + ### method for finding the gradient (fourier space), using the spatial dimension of k + for _d in np.arange(_SPACE_DIM): + + def gradient_transfer_function(k, x, d=_d): + return 1j * k[d] * x + + phi_eps_fourier.apply(gradient_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=phi_eta[_d]) + np.divide(phi_eta[_d], phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_eta[_d]) + + ### iterative GPE solver ### + ### ---------------------------------------------- + max_iter = 100 + i = 0 + delta = 1.0 + # phi_pol_prev = pm.create("real", value = 0.0) + ### ^------ set to zero before each iterative procedure or soft start + conv_criteria = config.conv_crit # conv. criteria (default 1e-6) + w = config.pol_mixing # polarization mixing param (default 0.6) + while i < max_iter and delta > conv_criteria: + (phi_q + phi_pol_prev).r2c(out=phi_q_fourier) + for _d in np.arange(_SPACE_DIM): + + def iterate_apply_k_vec(k, additive_terms, d=_d): + return additive_terms * (-1j * k[d]) / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(iterate_apply_k_vec, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + + phi_pol = -( + phi_eta[0] * elec_field[0] + + phi_eta[1] * elec_field[1] + + phi_eta[2] * elec_field[2] + ) + ### ^-- Following a negative sign convention (-ik) of the FT, a neg sign is + ### --- mathematically correct by the definition of the GPE (double - -> +) + phi_pol = w * phi_pol + (1.0 - w) * phi_pol_prev + diff = np.abs(phi_pol - phi_pol_prev) + delta = conv_fun(comm, diff) # decided from toml input + phi_pol_prev = phi_pol.copy() + i = i + 1 + # print("Stopping after iteration {:d} with stop crit {:.2e}, delta {:.2e}".format(i,conv_criteria,delta)) + + # compute_potential = True + def k_norm_divide(k, potential): + return potential / k.normp(p=2, zeromode=1) + + ## > Electrostatic potential + eps0_inv = config.coulomb_constant * 4 * np.pi + ## ^ the 1/(4pi eps0)*4*pi = 1/eps0 + ((eps0_inv) * (phi_q + phi_pol)).r2c(out=phi_q_fourier) + phi_q_fourier.apply(k_norm_divide, out=phi_q_fourier) + phi_q_fourier.c2r(out=psi) + ### ^ electrostatic potential for the GPE + + for _d in np.arange(_SPACE_DIM): + + def field_transfer_function(k, x, d=_d): + return ( + -1j * k[d] * x + ) ## negative sign relation, due to E = - nabla psi relation + + phi_q_fourier.apply(field_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + ## ^-------- Method: Obtaining the electric field from electrostatic potential + ## Assuming the electric field is conserved. + ## Assumption holds if no magnetic flux (magnetic induced fields) + + ############## Obtain forces ############## + elec_dot = ( + elec_field[0] * elec_field[0] + + elec_field[1] * elec_field[1] + + elec_field[2] * elec_field[2] + ) + # needed for energy calculations + + np.divide( + elec_dot, + denom_phi_tot, + where=np.abs(denom_phi_tot > 1e-6), + out=elec_field_contrib, + ) + + eps0_inv = config.coulomb_constant * 4 * np.pi + + for t_ in range(config.n_types): + Vbar_elec[t_] = ( + config.type_charges[t_] * psi + - (0.5 / eps0_inv) + * (config.dielectric_type[t_] - phi_eps) + * elec_field_contrib + ) + + # Obtain Vext,k + for t_ in range(config.n_types): + Vbar_elec[t_].r2c(out=Vbar_elec_fourier[t_]) + Vbar_elec_fourier[t_].apply(hamiltonian.H, out=Vbar_elec_fourier[t_]) + + # force terms + # F = - grad Vext + for t_ in range(config.n_types): + for _d in np.arange(_SPACE_DIM): + + def force_transfer_function(k, x, d=_d): + return -1j * k[_d] * x ## negative gradient + + Vbar_elec_fourier[t_].apply( + force_transfer_function, out=force_mesh_elec_fourier[t_][_d] + ) + force_mesh_elec_fourier[t_][_d].c2r(out=force_mesh_elec[t_][_d]) + elec_forces[types == t_, _d] = force_mesh_elec[t_][_d].readout( + positions[types == t_], layout=layouts[t_] + ) + + return Vbar_elec, phi_eps, elec_dot
+ + +
[docs]def domain_decomposition( + positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=MPI.COMM_WORLD +): + """Performs domain decomposition + + Rearranges the MPI rank memory layout into one that better mimics the PFFT + pencil grid 2D decomposition. As molecules are always required to be fully + contained on a single MPI rank, a perfect decomposition is not always + possible. The best decomposition which leaves the center of mass of all + molecules in their respective correct domains is used, with possible + overlap into neighbouring domains if the spatial extent of any molecule + crosses domain boundaries. + + Parameters + ---------- + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + *args + Variable length argument list containing arrays to include in the + domain decomposition. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + bonds : (N,M) numpy.ndarray, optional + Array of :code:`M` bonds originating from each of :code:`N` particles. + verbose : int, optional + Specify the logging event verbosity of this function. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + Domain decomposed :code:`positions` and any array specified in + :code:`*args`, in addition to :code:`bonds` and :code:`molecules` if these + arrays were provided as input. + """ + if molecules is not None: + if not topol: + assert bonds is not None, "bonds must be provided with molecules" + unique_molecules = np.sort(np.unique(molecules)) + molecules_com = np.empty_like(positions) + for m in unique_molecules: + ind = molecules == m + r = positions[ind, :][0, :] + molecules_com[ind, :] = r + layout = pm.decompose(molecules_com, smoothing=0) + if not topol: + args = (*args, bonds, molecules) + else: + args = (*args, molecules) + else: + layout = pm.decompose(positions, smoothing=0) + if verbose > 1: + Logger.rank0.log( + logging.INFO, + "DOMAIN_DECOMP: Total number of particles to be exchanged = %d", + np.sum(layout.get_exchange_cost()), + ) + return layout.exchange(positions, *args)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/_modules/hymd/file_io.html b/v2.1.0/_modules/hymd/file_io.html new file mode 100644 index 00000000..3081218b --- /dev/null +++ b/v2.1.0/_modules/hymd/file_io.html @@ -0,0 +1,1169 @@ + + + + + + hymd.file_io — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.file_io

+"""Handle file input/output in parllel HDF5 fashion
+"""
+import numpy as np
+import h5py
+import os
+import logging
+import getpass
+from mpi4py import MPI
+from .logger import Logger, get_version
+
+
+
[docs]class OutDataset: + """HDF5 dataset handler for file output""" + + def __init__( + self, + dest_directory, + config, + double_out=False, + disable_mpio=False, + comm=MPI.COMM_WORLD, + ): + """Constructor + + Parameters + ---------- + dest_directory : str + Ouput directory for saving data. + config : Config + Configuration object. + double_out : bool, optional + If :code:`True`, the output HDF5 objects are written in eight byte + floating point representation. Otherwise, four byte single + precision is used. + disable_mpio : bool, optional + If :code:`True`, disables parallel MPI-enabled HDF5 file output. + This is a compatibility option used if HDF5 is not compiled with + MPI support. This makes everything much harder by splitting all + output in one file per MPI rank, and having an MPI-enabled HDF5 + library is **highly recommended**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + """ + self.disable_mpio = disable_mpio + self.config = config + if double_out: + self.float_dtype = "float64" + else: + self.float_dtype = "float32" + + if disable_mpio: + self.file = h5py.File( + os.path.join( + dest_directory, f"sim.hdf5-{comm.rank:6d}-of-{comm.size:6d}" + ), + "w", + ) + else: + self.file = h5py.File( + os.path.join(dest_directory, "sim.H5"), "w", driver="mpio", comm=comm + ) + +
[docs] def is_open(self, comm=MPI.COMM_WORLD): + """Check if HDF5 output file is open + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + return self.file.__bool__()
+ +
[docs] def close_file(self, comm=MPI.COMM_WORLD): + """Closes the HDF5 output file + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + self.file.close()
+ +
[docs] def flush(self): + """Flushes output buffers, forcing file writes""" + self.file.flush()
+ + +
[docs]def setup_time_dependent_element( + name, parent_group, n_frames, shape, dtype, units=None +): + """Helper function for setting up time-dependent HDF5 group datasets + + All output groups must adhere to the H5MD standard, meaning a structure of + + + | ┗━ **group** particle group (e.g. :code:`all`) or :code:`observables` group + | ┗━ **group** time-dependent data + | ┣━ **dataset** :code:`step` :code:`shape=(n_frames,)` + | ┣━ **dataset** :code:`time` :code:`shape=(n_frames,)` + | ┗━ **dataset** :code:`value` :code:`shape=(n_frames, *)` + + is necessary. + + References + ---------- + H5MD specification : + https://www.nongnu.org/h5md/h5md.html + """ # noqa: E501 + group = parent_group.create_group(name) + step = group.create_dataset("step", (n_frames,), "int32") + time = group.create_dataset("time", (n_frames,), "float32") + value = group.create_dataset("value", (n_frames, *shape), dtype) + + if units is not None: + value.attrs["unit"] = units + time.attrs["unit"] = "ps" + return group, step, time, value
+ + +
[docs]def store_static( + h5md, + rank_range, + names, + types, + indices, + config, + bonds_2_atom1, + bonds_2_atom2, + molecules=None, + velocity_out=False, + force_out=False, + charges=False, + dielectrics=False, + plumed_out=False, + comm=MPI.COMM_WORLD, +): + """Outputs all static time-independent quantities to the HDF5 output file + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + rank_range : list[int] + Start and end indices for global arrays for each MPI rank. + names : (N,) numpy.ndarray + Array of names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of type indices for :code:`N` particles. + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + config : Config + Configuration object. + bonds_2_atom1 : (B,) numpy.ndarray + Array of indices of the first particle for :code:`B` total + two-particle bonds. + bonds_2_atom2 : (B,) numpy.ndarray + Array of indices of the second particle for :code:`B` total + two-particle bonds. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. + dielectrics : (N,) numpy.ndarray + Array of particle relative dielectric values for :code:`N` particles. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to output HDF5 file. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + prepare_bonds : + Constructs two-, three-, and four-particle bonds from toplogy input + file and bond configuration information. + distribute_input : + Distributes input arrays onto MPI ranks, attempting load balancing. + """ + dtype = h5md.float_dtype + + h5md_group = h5md.file.create_group("/h5md") + h5md.h5md_group = h5md_group + h5md.observables = h5md.file.create_group("/observables") + h5md.connectivity = h5md.file.create_group("/connectivity") + h5md.parameters = h5md.file.create_group("/parameters") + + h5md_group.attrs["version"] = np.array([1, 1], dtype=int) + author_group = h5md_group.create_group("author") + author_group.attrs["name"] = np.string_(getpass.getuser()) + creator_group = h5md_group.create_group("creator") + creator_group.attrs["name"] = np.string_("Hylleraas MD") + + # Get HyMD version + creator_group.attrs["version"] = np.string_(get_version()) + + h5md.particles_group = h5md.file.create_group("/particles") + h5md.all_particles = h5md.particles_group.create_group("all") + mass = h5md.all_particles.create_dataset("mass", (config.n_particles,), dtype) + mass[...] = config.mass + + if charges is not False: + charge = h5md.all_particles.create_dataset( + "charge", (config.n_particles,), dtype="float32" + ) + charge[indices] = charges + if dielectrics is not False: + dielectric = h5md.all_particles.create_dataset( + "dielectric", (config.n_particles,), dtype="float32" + ) + dielectric[indices] = dielectrics + + box = h5md.all_particles.create_group("box") + box.attrs["dimension"] = 3 + box.attrs["boundary"] = np.array( + [np.string_(s) for s in 3 * ["periodic"]], dtype="S8" + ) + + n_frames = config.n_steps // config.n_print + if np.mod(config.n_steps - 1, config.n_print) != 0: + n_frames += 1 + if np.mod(config.n_steps, config.n_print) == 1: + n_frames += 1 + if n_frames == config.n_steps: + n_frames += 1 + + species = h5md.all_particles.create_dataset( + "species", + (config.n_particles,), + dtype="i", + ) + + ( + _, + h5md.positions_step, + h5md.positions_time, + h5md.positions, + ) = setup_time_dependent_element( + "position", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm", + ) + if velocity_out: + ( + _, + h5md.velocities_step, + h5md.velocities_time, + h5md.velocities, + ) = setup_time_dependent_element( + "velocity", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm ps-1", + ) + if force_out: + ( + _, + h5md.forces_step, + h5md.forces_time, + h5md.forces, + ) = setup_time_dependent_element( + "force", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="kJ mol-1 nm-1", + ) + ( + _, + h5md.total_energy_step, + h5md.total_energy_time, + h5md.total_energy, + ) = setup_time_dependent_element( + "total_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.kinetc_energy_step, + h5md.kinetc_energy_time, + h5md.kinetc_energy, + ) = setup_time_dependent_element( + "kinetic_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.potential_energy_step, + h5md.potential_energy_time, + h5md.potential_energy, + ) = setup_time_dependent_element( + "potential_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.bond_energy_step, + h5md.bond_energy_time, + h5md.bond_energy, + ) = setup_time_dependent_element( + "bond_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.angle_energy_step, + h5md.angle_energy_time, + h5md.angle_energy, + ) = setup_time_dependent_element( + "angle_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.dihedral_energy_step, + h5md.dihedral_energy_time, + h5md.dihedral_energy, + ) = setup_time_dependent_element( + "dihedral_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.field_energy_step, + h5md.field_energy_time, + h5md.field_energy, + ) = setup_time_dependent_element( + "field_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + if charges is not False: + ( + _, + h5md.field_q_energy_step, + h5md.field_q_energy_time, + h5md.field_q_energy, + ) = setup_time_dependent_element( + "field_q_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) # <-------- xinmeng + if plumed_out is not False: + ( + _, + h5md.plumed_bias_step, + h5md.plumed_bias_time, + h5md.plumed_bias, + ) = setup_time_dependent_element( + "plumed_bias", h5md.observables, n_frames, (1,), dtype, units="kJ mol-1" # noqa: E501 + ) + ( + _, + h5md.total_momentum_step, + h5md.total_momentum_time, + h5md.total_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "total_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm g ps-1 mol-1", + ) + ( + _, + h5md.angular_momentum_step, + h5md.angular_momentum_time, + h5md.angular_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "angular_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm+2 g ps-1 mol-1", + ) + ( + _, + h5md.torque_step, + h5md.torque_time, + h5md.torque, + ) = setup_time_dependent_element( # noqa: E501 + "torque", + h5md.observables, + n_frames, + (3,), + dtype, + units="kJ nm+2 mol-1", + ) + ( + _, + h5md.temperature_step, + h5md.temperature_time, + h5md.temperature, + ) = setup_time_dependent_element( + "temperature", h5md.observables, n_frames, (3,), dtype, units="K" + ) + ( + _, + h5md.thermostat_work_step, + h5md.thermostat_work_time, + h5md.thermostat_work, + ) = setup_time_dependent_element( + "thermostat_work", + h5md.observables, + n_frames, + (1,), + "float32", + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.pressure_step, + h5md.pressure_time, + h5md.pressure, + ) = setup_time_dependent_element( + "pressure", h5md.observables, n_frames, (18,), "float32", units="Bar" + ) + (_, h5md.box_step, h5md.box_time, h5md.box_value,) = setup_time_dependent_element( + "edges", box, n_frames, (3, 3), "float32", units="nm" + ) + + ind_sort = np.argsort(indices) + for i in ind_sort: + species[indices[i]] = config.name_to_type_map[names[i].decode("utf-8")] + + h5md.parameters.attrs["config.toml"] = np.string_(str(config)) + vmd_group = h5md.parameters.create_group("vmd_structure") + index_of_species = vmd_group.create_dataset( + "indexOfSpecies", (config.n_types,), "i" + ) + index_of_species[:] = np.array(list(range(config.n_types))) + + # VMD-h5mdplugin maximum name/type name length is 16 characters (for + # whatever reason [VMD internals?]). + name_dataset = vmd_group.create_dataset("name", (config.n_types,), "S16") + type_dataset = vmd_group.create_dataset("type", (config.n_types,), "S16") + if molecules is not None: + resid_dataset = vmd_group.create_dataset( + "resid", + (config.n_particles,), + "i", + ) + + # Change this + for i, n in config.type_to_name_map.items(): + name_dataset[i] = np.string_(n[:16]) + if n == "W": + type_dataset[i] = np.string_("solvent") + else: + type_dataset[i] = np.string_("membrane") + + total_bonds = comm.allreduce(len(bonds_2_atom1), MPI.SUM) + n_bonds_local = len(bonds_2_atom1) + + receive_buffer = comm.gather(n_bonds_local, root=0) + n_bonds_global = None + if comm.Get_rank() == 0: + n_bonds_global = receive_buffer + n_bonds_global = np.array(comm.bcast(n_bonds_global, root=0)) + rank_bond_start = np.sum(n_bonds_global[: comm.Get_rank()]) + + bonds_from = vmd_group.create_dataset("bond_from", (total_bonds,), "i") + bonds_to = vmd_group.create_dataset("bond_to", (total_bonds,), "i") + for i in range(n_bonds_local): + a = bonds_2_atom1[i] + b = bonds_2_atom2[i] + bonds_from[rank_bond_start + i] = indices[a] + 1 + bonds_to[rank_bond_start + i] = indices[b] + 1 + + if molecules is not None: + resid_dataset[indices[ind_sort]] = molecules
+ + +# store data old vs +""" +h5md, step, frame, indices, positions, velocities, forces, box_size, +temperature, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, +field_energy, field_q_energy, time_step, config, velocity_out=False, +force_out=False, charge_out=False, dump_per_particle=False, +""" + + +
[docs]def store_data( + h5md, + step, + frame, + indices, + positions, + velocities, + forces, + box_size, + temperature, + pressure, + kinetic_energy, + bond2_energy, + bond3_energy, + bond4_energy, + field_energy, + field_q_energy, + plumed_bias, + time_step, + config, + velocity_out=False, + force_out=False, + charge_out=False, + plumed_out=False, + dump_per_particle=False, + comm=MPI.COMM_WORLD, +): + """Writes time-step data to HDF5 output file + + Handles all quantities which change during simulation, as opposed to + static quanitities (see :code:`store_static`). + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + step : int + Step number. + frame : int + Output frame number (:code:`step // n_print`). + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + positions : (N,) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + velocities : (N,) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + forces : (N,) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. + box_size : (D,) numpy.ndarray + Array containing the simulation box size. + temperature : float + Calculated instantaneous temperature. + kinetic_energy : float + Calculated instantaneous kinetic energy. + bond2_energy : float + Calculated instantaneous harmonic two-particle bond energy. + bond3_energy : float + Calculated instantaneous harmonic angular three-particle bond energy. + bond4_energy : float + Calculated instantaneous dihedral four-particle torsion energy. + field_energy : float + Calculated instantaneous particle-field energy. + field_q_energy : float + Calculated instantaneous electrostatic energy. + plumed_bias : float + PLUMED instantaneous bias energy. + time_step : float + Value of the time step. + config : Config + Configuration object. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charge_out : bool, optional + If :code:`True`, electrostatic energies are written to the output + HDF5 file. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to the output HDF5 file. + dump_per_particle : bool, optional + If :code:`True`, all quantities are written **per particle**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + store_static : + Outputs all static time-independent quantities to the HDF5 output file + """ + for dset in ( + h5md.positions_step, + h5md.total_energy_step, + h5md.potential_energy_step, + h5md.kinetc_energy_step, + h5md.bond_energy_step, + h5md.angle_energy_step, + h5md.dihedral_energy_step, + h5md.field_energy_step, + h5md.total_momentum_step, + h5md.angular_momentum_step, + h5md.torque_step, + h5md.temperature_step, + h5md.pressure_step, + h5md.box_step, + h5md.thermostat_work_step, + ): + dset[frame] = step + + for dset in ( + h5md.positions_time, + h5md.total_energy_time, + h5md.potential_energy_time, + h5md.kinetc_energy_time, + h5md.bond_energy_time, + h5md.angle_energy_time, + h5md.dihedral_energy_time, + h5md.field_energy_time, + h5md.total_momentum_time, + h5md.angular_momentum_time, + h5md.torque_time, + h5md.temperature_time, + h5md.pressure_time, + h5md.box_time, + h5md.thermostat_work_time, + ): + dset[frame] = step * time_step + + if velocity_out: + h5md.velocities_step[frame] = step + h5md.velocities_time[frame] = step * time_step + if force_out: + h5md.forces_step[frame] = step + h5md.forces_time[frame] = step * time_step + if charge_out: + h5md.field_q_energy_step[frame] = step + h5md.field_q_energy_time[frame] = step * time_step + if plumed_out: + h5md.plumed_bias_step[frame] = step + h5md.plumed_bias_time[frame] = step * time_step + + ind_sort = np.argsort(indices) + h5md.positions[frame, indices[ind_sort]] = positions[ind_sort] + + if velocity_out: + h5md.velocities[frame, indices[ind_sort]] = velocities[ind_sort] + if force_out: + h5md.forces[frame, indices[ind_sort]] = forces[ind_sort] + if charge_out: + h5md.field_q_energy[frame] = field_q_energy + if plumed_out: + h5md.plumed_bias[frame] = plumed_bias + + potential_energy = ( + bond2_energy + bond3_energy + bond4_energy + field_energy + field_q_energy + ) + + total_momentum = config.mass * comm.allreduce(np.sum(velocities, axis=0), MPI.SUM) + angular_momentum = config.mass * comm.allreduce( + np.sum(np.cross(positions, velocities), axis=0), MPI.SUM + ) + torque = config.mass * comm.allreduce( + np.sum(np.cross(positions, forces), axis=0), MPI.SUM + ) + h5md.total_energy[frame] = kinetic_energy + potential_energy + h5md.potential_energy[frame] = potential_energy + h5md.kinetc_energy[frame] = kinetic_energy + h5md.bond_energy[frame] = bond2_energy + h5md.angle_energy[frame] = bond3_energy + h5md.dihedral_energy[frame] = bond4_energy + h5md.field_energy[frame] = field_energy + h5md.total_momentum[frame, :] = total_momentum + h5md.angular_momentum[frame, :] = angular_momentum + h5md.torque[frame, :] = torque + h5md.temperature[frame] = temperature + h5md.pressure[frame] = pressure + for d in range(3): + h5md.box_value[frame, d, d] = box_size[d] + h5md.thermostat_work[frame] = config.thermostat_work + + fmt_ = [ + "step", + "time", + "temp", + "tot E", + "kin E", + "pot E", + "field E", + "elec E", + "bond E", + "ang E", + "dih E", + "bias E", + "Px", + "Py", + "Pz", + "ΔH" if config.target_temperature else "ΔE", + ] + fmt_ = np.array(fmt_) + + # create mask to show only energies != 0 + en_array = np.array([ + field_energy, + field_q_energy, + bond2_energy, + bond3_energy, + bond4_energy, + plumed_bias, + ]) + mask = np.full_like(fmt_, True, dtype=bool) + mask[range(6,12)] = en_array != 0. + + header_ = fmt_[mask].shape[0] * "{:>13}" + if config.initial_energy is None: + fmt_[-1] = "" + + divide_by = 1.0 + if dump_per_particle: + for i in range(3, 9): + fmt_[i] = fmt_[i][:-2] + "E/N" + fmt_[-1] += "/N" + divide_by = config.n_particles + total_energy = kinetic_energy + potential_energy + if config.initial_energy is not None: + if config.target_temperature: + H_tilde = total_energy - config.initial_energy - config.thermostat_work + else: + H_tilde = total_energy - config.initial_energy + else: + H_tilde = 0.0 + + header = header_.format(*fmt_[mask]) + data_fmt = f'{"{:13}"}{(fmt_[mask].shape[0]-1) * "{:13.5g}" }' + all_data = [ + step, + time_step * step, + temperature, + total_energy / divide_by, + kinetic_energy / divide_by, + potential_energy / divide_by, + field_energy / divide_by, + field_q_energy / divide_by, + bond2_energy / divide_by, + bond3_energy / divide_by, + bond4_energy / divide_by, + plumed_bias / divide_by, + total_momentum[0] / divide_by, + total_momentum[1] / divide_by, + total_momentum[2] / divide_by, + H_tilde / divide_by, + ] + data = data_fmt.format(*[val for i, val in enumerate(all_data) if mask[i]]) + Logger.rank0.log(logging.INFO, ("\n" + header + "\n" + data))
+ + +
[docs]def distribute_input( + in_file, rank, size, n_particles, max_molecule_size=201, comm=MPI.COMM_WORLD +): + """Assign global arrays onto MPI ranks, attempting load balancing + + Distributes approximately equal numbers of particles (workload) onto each + independent MPI rank, while respecting the requirement that any molecule + must be fully contained on a single MPI rank only (no splitting molecules + across multiple CPUs). + + Parameters + ---------- + in_file : h5py.File + HDF5 input file object. + rank : int + Local rank number for this MPI rank. + size : int + Global size of the MPI communicator (number of total CPUs). + n_particles : int + Total number of particles. + max_molecule_size : int, optional + Maximum size of any molecule present in the system. Used to initially + guess where the MPI rank boundaries (start/end indices) in the global + arrays should be placed. If molecules of size + :code:`>max_molecule_size` exist in the simulation system, HyMD + **might** work as expected. Or it might fail spectacularly. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + rank_range : + Starting and ending indices in the global arrays for each MPI rank. + """ + if n_particles is None: + n_particles = len(in_file["indices"]) + np_per_MPI = n_particles // size + + molecules_flag = False + if "molecules" in in_file: + molecules_flag = True + + if not molecules_flag: + if rank == size - 1: + np_cum_mpi = [rank * np_per_MPI, n_particles] + else: + np_cum_mpi = [rank * np_per_MPI, (rank + 1) * np_per_MPI] + p_mpi_range = list(range(np_cum_mpi[0], np_cum_mpi[1])) + return p_mpi_range, molecules_flag + + # To avoid splitting molecules across multiple different ranks, we need + # to read in some extra indices before/after the expected break points + # and iterate until we find a molecule break. + # + # Implicitly assuming no molecule is bigger than + # min(max_molecule_size, n_particles // n_MPI_ranks) atoms. + max_molecule_size += 2 + grab_extra = max_molecule_size if np_per_MPI > max_molecule_size else np_per_MPI + if rank == 0: + mpi_range_start = 0 + if size == 1: + mpi_range_end = n_particles + else: + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + elif rank == size - 1: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = n_particles + else: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + + molecules = in_file["molecules"][mpi_range_start:mpi_range_end] + indices = in_file["indices"][mpi_range_start:mpi_range_end] + molecule_end_indices = np.nonzero(np.diff(molecules))[0] + + p_mpi_range = [None, None] + if rank == 0: + p_mpi_range[0] = 0 + if size == 1: + p_mpi_range[1] = n_particles + else: + p_mpi_range[1] = indices[ + molecule_end_indices[molecule_end_indices >= np_per_MPI][0] + 1 + ] + elif rank == size - 1: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = n_particles + else: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = ( + indices[molecule_end_indices[molecule_end_indices > np_per_MPI][0]] + + 1 # noqa: E501 + ) + return list(range(p_mpi_range[0], p_mpi_range[1])), molecules_flag
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/_modules/hymd/force.html b/v2.1.0/_modules/hymd/force.html new file mode 100644 index 00000000..fd129851 --- /dev/null +++ b/v2.1.0/_modules/hymd/force.html @@ -0,0 +1,1172 @@ + + + + + + hymd.force — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.force

+"""Calculates intramolecular forces between bonded particles in molecules
+"""
+import numpy as np
+import networkx as nx
+from dataclasses import dataclass
+
+# Imported here so we can call from force import compute_bond_forces__fortran
+from force_kernels import cbf as compute_bond_forces__fortran  # noqa: F401
+from force_kernels import (  # noqa: F401
+    caf as compute_angle_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cdf as compute_dihedral_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cbf_d as compute_bond_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    caf_d as compute_angle_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    cdf_d as compute_dihedral_forces__fortran__double,
+)
+
+
+
[docs]@dataclass # might not be needed +class Dielectric_type: + atom_1: str + dielectric_value: float
+ + +
[docs]@dataclass +class Bond: + """Dataclass representing a single two-particle bond type + + A `bond type` is a bond strength and equilibrium distance associated with + any bond between particles of specific types :code:`A` and :code:`B` + (where :code:`A` and :code:`B` may be the same or different). Harmonic + two-particle bonds in HyMD take the form + + .. math:: + + V_2(\\mathbf{r}_1, \\mathbf{r}_2) = + \\frac{1}{2}k + \\left( + \\vert \\mathbf{r}_1 - \\mathbf{r}_2 \\vert - r_0 + \\right)^2, + + where :math:`k` is the bond strength (spring constant) and :math:`r_0` is + the equilibrium bond length (at which the energy is zero). + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + equilibrium : float + Equilibrium distance at which the energy associated with the bond + vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient (spring constant). + """ + + atom_1: str + atom_2: str + equilibrium: float + strength: float
+ + +
[docs]@dataclass +class Angle(Bond): + """Dataclass representing a single three-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any three-particle bond between particles of specific types :code:`A`, + :code:`B`, and :code:`C` (where :code:`A`, :code:`B`, and :code:`C` may be + different or the same). Harmonic angular three-particle bonds in HyMD take + the form + + .. math:: + + V_3(\\mathbf{r}_1, \\mathbf{r}_2, \\mathbf{r}_3) = + \\frac{1}{2}k + \\left( + \\cos^{-1} + \\left[ + \\frac{ + (\\mathbf{r}_1-\\mathbf{r}_2) + \\cdot + (\\mathbf{r}_3-\\mathbf{r}_2) + } + { + \\vert\\mathbf{r}_1-\\mathbf{r}_2\\vert + \\vert\\mathbf{r}_3-\\mathbf{r}_2\\vert + } + \\right] - \\theta_0 + \\right)^2 + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + equilibrium : float + Equilibrium angle at which the energy associated with the + three-particle angular bond vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient. + + See also + -------- + Bond : + Two-particle bond type dataclass + """ + + atom_3: str
+ + +
[docs]@dataclass +class Dihedral: + """Dataclass representing a single four-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any four-particle torsional bond between particles of specific types + :code:`A`, :code:`B`, :code:`C`, and :code:`D` (where :code:`A`, :code:`B`, + :code:`C`, and :code:`D` may be different or the same). Dihedral + four-particle bonds in HyMD take different forms depending on the + :code:`dih_type` parameter. + + In the following, let :math:`\\phi` denote the angle between the planes + spanned by the relative positions of atoms :code:`A`-:code:`B`-:code:`C` + and :code:`B`-:code:`C`-:code:`D`. If :code:`dih_type = 0`, then + + .. math:: + + V_4(\\phi) = \\sum_n c_n + \\left( + 1 + \\cos\\left[ + n\\phi - d_n + \\right] + \\right), + + where :math:`c_n` are energy coefficients and :math:`d_n` are propensity + phases. By default, the cosine sum is truncated at five terms. If + :code:`coeffs` provides only a single float, this is used as the coiling + propensity parameter :math:`\\lambda`. In this case, :math:`c_n` and + :math:`d_n` are automatically set to values which promote alpha helical + (:math:`\\lambda=-1`), beta sheet (:math:`\\lambda=1`), or a mixed + (:math:`1>\\lambda>-1`) structure (using values provided by Bore et al. + (2018)). In this case, the full potential takes the form + + .. math:: + + V_4(\\phi;\\lambda) = + \\frac{1}{2}(1-\\lambda) V_{\\text{prop},\\alpha}(\\phi) + + + \\frac{1}{2}(1+\\lambda) V_{\\text{prop},\\beta}(\\phi) + + + (1-\\vert\\lambda\\vert) V_{\\text{prop}, \\text{coil}}(\\phi), + + with each of the :math:`V_{\\mathrm{prop}, X}` being fixed cosine series + potentials with pre-set :math:`c_n` -s and :math:`d_n` -s. + + If :code:`dih_type = 1`, then a combined bending torsional (CBT) potential + is employed, + + .. math:: + + V_4(\\phi,\\gamma;\\lambda) = + V_4(\\phi;\\lambda) + + + \\frac{1}{2}K(\\phi)(\\gamma - \\gamma_0)^2, + + where :math:`V_4(\\phi;\\lambda)` specifies the potential as given by the + coiling propensity parameter above, :math:`K(\\phi)` is a separate cosine + series potential acting as the angular three-particle bond strength, and + :math:`\\gamma_0` is the three-particle bond equilibrium angle. In this + case, the :code:`coeffs` parameter must specify *both* a :math:`\\lambda` + value, in additon to the energy and phases dictating the :math:`K(\\phi)` + potential. + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + atom_4 : str + Type name of particle 4. + coeffs : list[list[float]] or list[float] or numpy.ndarray + Dihedral coefficients defining the series expansion of the dihedral + energy. + dih_type : int + Specifies the type of dihedral used; If :code:`0`, then :code:`coeffs` + must contain **either** two lists of five energy coefficients + :math:`c_n` and five propensity phases :math:`d_n` **or** a single + floating point number defining the :math:`\\lambda` coiling propensity + parameter. If :code:`1`, the combined bending-torsional potential is + used, and :code:`coeffs` must specify :math:`\\lambda` *and* two lists + containing energy coefficients and propensity phases for the + :math:`V_\\text{prop}` propensity potential, defined in terms of cosine + series. + + References + ---------- + Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018. + """ + + atom_1: str + atom_2: str + atom_3: str + atom_4: str + coeffs: np.ndarray + dih_type: int
+ + +
[docs]@dataclass +class Chi: + """Dataclass representing a single :math:`\\chi` mixing interaction type + + An `interaction mixing energy type` is a mixing energy associated with + density overlap between species of types :code:`A` and :code:`B` + (specified as inputs :code:`atom_1` and :code:`atom_2`). A positive mixing + energy promotes phase separation, a negative mixing energy promotes mixing. + The interaction energy density (provided the :code:`DefaultWithChi` + Hamiltonian is used) takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} + \\sum_{k,l}\\chi_{k,l} \\tilde\\phi_k\\tilde\\phi_l, + + where :math:`\\chi_{k,l}` denotes the mixing energy between species + :math:`k` and :math:`l`, with :math:`\\kappa` being the incompressibility. + The value of the interaction mixing energy parameter may be extracted from + `Flory-Huggins theory`_. + + .. _`Flory-Huggins theory`: + https://en.wikipedia.org/wiki/Flory%E2%80%93Huggins_solution_theory + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + interaction_energy : float + Interaction mixing energy. + + See also + -------- + hymd.hamiltonian.DefaultWithChi : + Interaction energy functional using :math:`\\chi`-interactions. + """ + + atom_1: str + atom_2: str + interaction_energy: float
+ + +
[docs]def find_all_paths(G, u, n): + """Helper function that recursively finds all paths of given lenght 'n + 1' inside a network 'G'. + Adapted from https://stackoverflow.com/a/28103735.""" + if n == 0: + return [[u]] + paths = [] + for neighbor in G.neighbors(u): + for path in find_all_paths(G, neighbor, n - 1): + if u not in path: + paths.append([u] + path) + return paths
+ + +
[docs]def propensity_potential_coeffs(x: float): + alpha_coeffs = np.array( + [ + [7.406, -5.298, -2.570, 1.336, 0.739], + [-0.28632126, 1.2099146, 1.18122138, 0.49075168, 0.98495911], + ] + ) + beta_coeffs = np.array( + [ + [3.770, 5.929, -4.151, -0.846, 0.190], + [-0.2300693, -0.0583289, 0.99342396, 1.03237971, 2.90160988], + ] + ) + coil_coeffs = np.array( + [ + [1.416, -0.739, 0.990, -0.397, 0.136], + [1.3495933, 0.45649087, 2.30441057, -0.12274901, -0.26179939], + ] + ) + + zero_add = np.zeros((2, 5)) + if np.isclose(x, -1): + return np.concatenate((alpha_coeffs, zero_add)) + elif np.isclose(x, 0): + return np.concatenate((coil_coeffs, zero_add)) + elif np.isclose(x, 1): + return np.concatenate((beta_coeffs, zero_add)) + + abs_x = np.abs(x) + if abs_x > 1: + err_str = ( + f"The provided value of lambda = {x} is out of lambda definition range, " + f"[-1.0, 1.0]." + ) + Logger.rank0.log(logging.ERROR, err_str) + else: + coil_coeffs[0] *= 1 - abs_x + if x < 0: + alpha_coeffs[0] *= 0.5 * (abs_x - x) + return np.concatenate((alpha_coeffs, coil_coeffs)) + else: + beta_coeffs[0] *= 0.5 * (abs_x + x) + return np.concatenate((beta_coeffs, coil_coeffs))
+ + +
[docs]def prepare_bonds_old(molecules, names, bonds, indices, config): + """Find bonded interactions from connectivity and bond types information + + .. deprecated:: 1.0.0 + :code:`prepare_bonds_old` was replaced by :code:`prepare_bonds` for + use with compiled Fortran kernels prior to 1.0.0 release. + + Prepares the necessary equilibrium and bond strength information needed by + the intramolecular interaction functions. This is performed locally on each + MPI rank, as the domain decomposition ensures that for all molecules *all* + consituent particles are always contained on *the same* MPI rankself. + + This function traverses the bond connectivity information provided in the + structure/topology input file and indentifies any two-, three-, or + four-particle potential bonds. For each connected chain of two, three, or + four particles, a matching to bond types is attempted. If the corresponding + names match, a bond object is initialized. + + In order to investigate the connectivity, a graph is created using + networkx functionality. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2 : list + List of lists containing *local* particle indices, equilibrium + distance, and bond strength coefficient for each reconstructed + two-particle bond. + bonds_3 : + List of lists containing *local* particle indices, equilibrium angle, + and bond strength coefficient for each reconstructed three-particle + bond. + bonds_4 : + List of lists containing *local* particle indices, dihedral type index, + and dihedral coefficients for each reconstructed four-particle + torsional bond. + bb_index : list + List indicating the dihedral type of each four-particle bond in + :code:`bonds_4`. + + See also + -------- + Bond : + Two-particle bond type dataclass. + Angle : + Three-particle angular bond type dataclass. + Dihedral : + Four-particle torsional bond type dataclass. + hymd.input_parser.Config + Configuration dataclass handler. + """ + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + bb_index = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + bb_dihedral = 0 + bond_graph = nx.Graph() + + for local_index, global_index in enumerate(indices): + if molecules[local_index] != mol: + continue + + bond_graph.add_node( + global_index, + name=names[local_index].decode("UTF-8"), + local_index=local_index, + ) + for bond in [b for b in bonds[local_index] if b != -1]: + bond_graph.add_edge(global_index, bond) + + connectivity = nx.all_pairs_shortest_path(bond_graph) + for c in connectivity: + i = c[0] + connected = c[1] + for j, path in connected.items(): + if len(path) == 2 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for b in config.bonds: + match_forward = name_i == b.atom_1 and name_j == b.atom_2 + match_backward = name_i == b.atom_2 and name_j == b.atom_1 + if match_forward or match_backward: + bonds_2.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[j]["local_index"], + b.equilibrium, + b.strength, + ] + ) + + if len(path) == 3 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_mid = bond_graph.nodes()[path[1]]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for a in config.angle_bonds: + match_forward = ( + name_i == a.atom_1 + and name_mid == a.atom_2 + and name_j == a.atom_3 + ) + match_backward = ( + name_i == a.atom_3 + and name_mid == a.atom_2 + and name_j == a.atom_1 + ) + if match_forward or match_backward: + bonds_3.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[path[1]]["local_index"], + bond_graph.nodes()[j]["local_index"], + np.radians(a.equilibrium), + a.strength, + ] + ) + + all_paths_len_four = find_all_paths(bond_graph, i, 3) + for p in all_paths_len_four: + name_i = bond_graph.nodes()[i]["name"] + name_mid_1 = bond_graph.nodes()[p[1]]["name"] + name_mid_2 = bond_graph.nodes()[p[2]]["name"] + name_j = bond_graph.nodes()[p[3]]["name"] + + for a in config.dihedrals: + match_forward = ( + name_i == a.atom_1 + and name_mid_1 == a.atom_2 + and name_mid_2 == a.atom_3 + and name_j == a.atom_4 + ) + if ( + match_forward + and [ + bond_graph.nodes()[p[3]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[i]["local_index"], + a.coeffs, + a.dih_type, + ] + not in bonds_4 + ): + bonds_4.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[3]]["local_index"], + a.coeffs, + a.dih_type, + ] + ) + if a.dih_type == 1: + bb_dihedral = len(bonds_4) + + if bb_dihedral: + bb_index.append(bb_dihedral - 1) + + return bonds_2, bonds_3, bonds_4, bb_index
+ + +
[docs]def prepare_index_based_bonds(molecules, topol): + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + resid = mol + 1 + top_summary = topol["system"]["molecules"] + resname = None + test_mol_number = 0 + for molname in top_summary: + test_mol_number += molname[1] + if resid <= test_mol_number: + resname = molname[0] + break + + if resname is None: + break + + if "bonds" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for bond in topol[resname]["bonds"]: + index_i = bond[0] - 1 + first_id + index_j = bond[1] - 1 + first_id + # bond[2] is the bond type, inherited by the itp format. Not used + equilibrium = bond[3] + strength = bond[4] + bonds_2.append([index_i, index_j, equilibrium, strength]) + + if "angles" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["angles"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + # angle[3] is the angle type, inherited by the itp format. Not used + equilibrium = np.radians(angle[4]) + strength = angle[5] + bonds_3.append([index_i, index_j, index_k, equilibrium, strength]) + + if "dihedrals" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["dihedrals"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + index_l = angle[3] - 1 + first_id + dih_type = angle[4] + coeff = angle[5] + if dih_type == 0 and isinstance(coeff[0], (float, int)): + coeff = propensity_potential_coeffs(coeff[0]) + elif dih_type == 1 and len(coeff) == 3: + coeff = np.array( + propensity_potential_coeffs(coeff[0][0]).tolist() + + coeff[1:] + ) + elif dih_type == 2: + coeff = np.array(coeff) + else: + coeff = np.insert(np.array(coeff), 2, np.zeros((2, 5)), axis=0) + bonds_4.append([index_i, index_j, index_k, index_l, coeff, dih_type, 0]) + return bonds_2, bonds_3, bonds_4
+ + +
[docs]def prepare_bonds(molecules, names, bonds, indices, config, topol=None): + """Rearrange the bond information for usage in compiled Fortran kernels + + Restructures the lists resulting from the execution of + :code:`prepare_bonds_old` into numpy arrays suitable for calls to optimized + Fortran code calculating bonded forces and energiesself. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2_atom_1 : (B,) numpy.ndarray + Local index of particle 1 for each of :code:`B` constructed + two-particle bonds. + bonds_2_atom_2 : (B,) numpy.ndarray + Local index of particle 2 for each of :code:`B` constructed + two-particle bonds. + bonds_2_equilibrium : (B,) numpy.ndarray + Equilibrium distance for each of :code:`B` constructed two-particle + bonds. + bonds_2_strength : (B,) numpy.ndarray + Bond strength for each of :code:`B` constructed two-particle + bonds. + bonds_3_atom_1 : (A,) numpy.ndarray + Local index of particle 1 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_2 : (A,) numpy.ndarray + Local index of particle 2 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_3 : (A,) numpy.ndarray + Local index of particle 3 for each of :code:`A` constructed + three-particle bonds. + bonds_3_equilibrium : (A,) numpy.ndarray + Equilibrium angle for each of :code:`A` constructed three-particle + bonds. + bonds_3_strength : (A,) numpy.ndarray + Bond strength for each of :code:`A` constructed three-particle + bonds. + bonds_4_atom_1 : (D,) numpy.ndarray + Local index of particle 1 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_2 : (D,) numpy.ndarray + Local index of particle 2 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_3 : (D,) numpy.ndarray + Local index of particle 3 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_4 : (D,) numpy.ndarray + Local index of particle 4 for each of :code:`D` constructed + four-particle bonds. + bonds_4_coeff : (D,) numpy.ndarray + Cosine series coefficients for each of :code:`D` constructed + four-particle bonds. + bonds_4_type : (D,) numpy.ndarray + Dihedral type for each of :code:`D` constructed four-particle + bonds. + bonds_4_last : (D,) numpy.ndarray + Flags indicating if :code:`dih_type` is :code:`1` for each of :code:`D` + constructed four-particle bonds. + + See also + -------- + prepare_bonds_old : + Used internally to reconstruct the bonded interactions types from the + connectivity information in the structure/topology input file and the + bonded types specified in the configuration file. + """ + if topol is not None: + bonds_2, bonds_3, bonds_4 = prepare_index_based_bonds( + molecules, topol + ) + else: + bonds_2, bonds_3, bonds_4, bb_index = prepare_bonds_old( + molecules, names, bonds, indices, config + ) + + # Bonds + bonds_2_atom1 = np.empty(len(bonds_2), dtype=int) + bonds_2_atom2 = np.empty(len(bonds_2), dtype=int) + bonds_2_equilibrium = np.empty(len(bonds_2), dtype=np.float64) + bonds_2_strength = np.empty(len(bonds_2), dtype=np.float64) + for i, b in enumerate(bonds_2): + bonds_2_atom1[i] = b[0] + bonds_2_atom2[i] = b[1] + bonds_2_equilibrium[i] = b[2] + bonds_2_strength[i] = b[3] + + # Angles + bonds_3_atom1 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom2 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom3 = np.empty(len(bonds_3), dtype=int) + bonds_3_equilibrium = np.empty(len(bonds_3), dtype=np.float64) + bonds_3_strength = np.empty(len(bonds_3), dtype=np.float64) + for i, b in enumerate(bonds_3): + bonds_3_atom1[i] = b[0] + bonds_3_atom2[i] = b[1] + bonds_3_atom3[i] = b[2] + bonds_3_equilibrium[i] = b[3] + bonds_3_strength[i] = b[4] + # Dihedrals + bonds_4_atom1 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom2 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom3 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom4 = np.empty(len(bonds_4), dtype=int) + number_of_coeff = 6 + len_of_coeff = 5 + bonds_4_coeff = np.empty( + (len(bonds_4), number_of_coeff, len_of_coeff), dtype=np.float64 + ) + bonds_4_type = np.empty(len(bonds_4), dtype=int) + bonds_4_last = np.zeros(len(bonds_4), dtype=int) + for i, b in enumerate(bonds_4): + bonds_4_atom1[i] = b[0] + bonds_4_atom2[i] = b[1] + bonds_4_atom3[i] = b[2] + bonds_4_atom4[i] = b[3] + bonds_4_coeff[i] = np.resize(b[4], (number_of_coeff, len_of_coeff)) + bonds_4_type[i] = b[5] + if topol is not None: + bonds_4_last[i] = b[6] + if topol is None: + bonds_4_last[bb_index] = 1 + + return ( + bonds_2_atom1, + bonds_2_atom2, + bonds_2_equilibrium, + bonds_2_strength, + bonds_3_atom1, + bonds_3_atom2, + bonds_3_atom3, + bonds_3_equilibrium, + bonds_3_strength, # noqa: E501 + bonds_4_atom1, + bonds_4_atom2, + bonds_4_atom3, + bonds_4_atom4, + bonds_4_coeff, + bonds_4_type, + bonds_4_last, # noqa: E501 + )
+ + +
[docs]def compute_bond_forces__plain(f_bonds, r, bonds_2, box_size): + """Computes forces resulting from bonded interactions + + .. deprecated:: 1.0.0 + :code:`compute_bond_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_bonds.fill(0.0) + energy = 0.0 + + for i, j, r0, k in bonds_2: + ri = r[i, :] + rj = r[j, :] + rij = rj - ri + + # Apply periodic boundary conditions to the distance rij + for dim in range(len(rij)): + rij[dim] -= box_size[dim] * np.around(rij[dim] / box_size[dim]) + dr = np.linalg.norm(rij) + df = -k * (dr - r0) + f_bond_vector = df * rij / dr + f_bonds[i, :] -= f_bond_vector + f_bonds[j, :] += f_bond_vector + + energy += 0.5 * k * (dr - r0) ** 2 + return energy
+ + +
[docs]def compute_angle_forces__plain(f_angles, r, bonds_3, box_size): + """Computes forces resulting from angular interactions + + .. deprecated:: 1.0.0 + :code:`compute_angle_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_angles.fill(0.0) + energy = 0.0 + + for a, b, c, theta0, k in bonds_3: + ra = r[a, :] - r[b, :] + rc = r[c, :] - r[b, :] + + for dim in range(len(ra)): + ra[dim] -= box_size[dim] * np.around(ra[dim] / box_size[dim]) + rc[dim] -= box_size[dim] * np.around(rc[dim] / box_size[dim]) + + xra = 1.0 / np.sqrt(np.dot(ra, ra)) + xrc = 1.0 / np.sqrt(np.dot(rc, rc)) + ea = ra * xra + ec = rc * xrc + + cosphi = np.dot(ea, ec) + theta = np.arccos(cosphi) + xsinph = 1.0 / np.sqrt(1.0 - cosphi**2) + + d = theta - theta0 + f = -k * d + + xrasin = xra * xsinph * f + xrcsin = xrc * xsinph * f + + fa = (ea * cosphi - ec) * xrasin + fc = (ec * cosphi - ea) * xrcsin + + f_angles[a, :] += fa + f_angles[c, :] += fc + f_angles[b, :] -= fa + fc + # f_angles[b, :] += -(fa + fc) + + energy -= 0.5 * f * d + + return energy
+ + +
[docs]def compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size): + """Computes forces resulting from dihedral interactions + + .. deprecated:: 1.0.0 + :code:`compute_dihedral_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_dihedrals.fill(0.0) + energy = 0.0 + + for a, b, c, d, coeffs, phase in bonds_4: + f = r[a, :] - r[b, :] + g = r[b, :] - r[c, :] + h = r[d, :] - r[c, :] + + for dim in range(3): + f -= box_size[dim] * np.around(f[dim] / box_size[dim]) + g -= box_size[dim] * np.around(g[dim] / box_size[dim]) + h -= box_size[dim] * np.around(h[dim] / box_size[dim]) + + v = np.cross(f, g) + w = np.cross(h, g) + vv = np.dot(v, v) + ww = np.dot(w, w) + gn = np.linalg.norm(g) + + cosphi = np.dot(v, w) + sinphi = np.dot(np.cross(v, w), g) / gn + phi = np.arctan2(sinphi, cosphi) + + fg = np.dot(f, g) + hg = np.dot(h, g) + sc = v * fg / (vv * gn) - w * hg / (ww * gn) + + df = 0 + + for m in range(len(coeffs[0])): + energy += coeffs[0][m] * (1 + np.cos(m * phi - coeffs[1][m])) + df += m * coeffs[0][m] * np.sin(m * phi - coeffs[1][m]) + + force_on_a = df * gn * v / vv + force_on_d = df * gn * w / ww + + f_dihedrals[a, :] -= force_on_a + f_dihedrals[b, :] += df * sc + force_on_a + f_dihedrals[c, :] -= df * sc + force_on_d + f_dihedrals[d, :] += force_on_d + return energy
+ + +
[docs]def dipole_forces_redistribution( + f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb +): + """Redistribute electrostatic forces calculated from topologically + reconstructed ghost dipole point charges to the backcone atoms of the protein. + """ + f_on_bead.fill(0.0) + for i, j, k, l, fd, matrix, dih_type, is_last in zip( + a, b, c, d, f_dipoles, trans_matrices, type_array, last_bb + ): + if dih_type == 1: + sum_force = fd[0] + fd[1] + diff_force = fd[0] - fd[1] + f_on_bead[i] += matrix[0] @ diff_force # Atom A + f_on_bead[j] += matrix[1] @ diff_force + 0.5 * sum_force # Atom B + f_on_bead[k] += matrix[2] @ diff_force + 0.5 * sum_force # Atom C + + if is_last == 1: + sum_force = fd[2] + fd[3] + diff_force = fd[2] - fd[3] + f_on_bead[j] += matrix[3] @ diff_force + f_on_bead[k] += matrix[4] @ diff_force + 0.5 * sum_force + f_on_bead[l] += matrix[5] @ diff_force + 0.5 * sum_force
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/_modules/hymd/hamiltonian.html b/v2.1.0/_modules/hymd/hamiltonian.html new file mode 100644 index 00000000..62d53337 --- /dev/null +++ b/v2.1.0/_modules/hymd/hamiltonian.html @@ -0,0 +1,807 @@ + + + + + + hymd.hamiltonian — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.hamiltonian

+"""Interaction energy functionals.
+
+Implements field--particle interaction energy functionals depending on the
+field configuration. Extending HyMD with a new Hamiltonian is done by
+subclassing the :code:`Hamiltonian` superclass with logic intialized in the
+constructor.
+
+The grid-independent filtering function is defined in the :code:`Hamiltonian`
+superclass constructor. Hijack :code:`self.H` in a subclass to change the
+filter.
+"""
+import numpy as np
+import sympy
+
+
+
[docs]class Hamiltonian: + """Interaction energy functional superclass""" + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + self.config = config + self._setup()
+ +
[docs] def _setup(self): + """Superclass setup + + Sets up the grid-independent filtering function :code:`H`, and the + SymPy logic for symbolically differentiating interaction energy + functionals in Hamiltonian subclasses. + """ + if not hasattr(self.config, "simulation_volume"): + self.config.simulation_volume = np.prod(np.asarray(self.config.box_size)) + if not self.config.barostat: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.config.a = self.config.rho0 + if not self.config.rho0: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.phi = sympy.var("phi:%d" % (self.config.n_types)) + k = sympy.var("k:%d" % (3)) + + # electrostatics variables + self.psi = sympy.var("psi") + self.phi_q = sympy.var("phi_q") + if not self.config.self_energy: + self.config.self_energy = 0.0 + + def fourier_space_window_function(k): + return sympy.functions.elementary.exponential.exp( + -0.5 + * self.config.sigma**2 + * (k0**2 + k1**2 + k2**2) # noqa: F821, E501 + ) + + self.window_function_lambda = sympy.lambdify( + [k], fourier_space_window_function(k) + ) + + def H(k, v): + return v * self.window_function_lambda(k) + + self.H = H
+ + +
[docs]class SquaredPhi(Hamiltonian): + """Simple squared density interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + \\sum_k \\tilde\\phi_k + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`rho_0` is the + average density of the fully homogenous system. Expressing the species + densities in terms of fluctuations from the average, + + .. math:: + + \\mathrm{d}\\tilde\\phi_k = \\rho_0 - \\tilde\\phi_k, + + it is evident that this interaction energy functional is a slight change of + the :code:`DefaultNoChi` Hamiltonian, as the expanded interaction energy + density becomes + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + 6\\rho_0\\left[ + \\sum_k \\mathrm{d}\\tilde\\phi_k + \\right] + + + 9\\rho_0^2 + + + \\sum_k \\mathrm{d}\\tilde\\phi_k^2 + + + \\prod_{k\\not=l} + \\mathrm{d}\\tilde\\phi_k \\mathrm{d}\\tilde\\phi_l + \\right), + + identical to :code:`DefaultNoChi` apart from a constant energy shift + :math:`9\\rho_0^2`(which does not impact dynamics) and the + :math:`\\rho_0`--:math:`\\mathrm{d}\\tilde\\phi_k` cross-terms. These + cross-terms constitute contributions to the energy linear in + :math:`\\mathrm{d}\\tilde\\phi_k` absent in :code:`DefaultNoChi`, which has + only quadratic terms present. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(SquaredPhi, self).__init__(config) + super(SquaredPhi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0): + return 0.5 / (kappa * rho0) * (sum(phi)) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + ): + V_incompressibility = 1 / (kappa * rho0) * sum(phi) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultNoChi(Hamiltonian): + """Incompressibility-only interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. The :code:`SquaredPhi` Hamiltonian implements a similar + functional with an additional linear term component depending on + + .. math:: + + \\mathmr{d}\\tilde\\phi_k = \\tilde\\phi_k - \\rho_0 + + and not :math:`\\mathrm{d}\\tilde\\phi_k^2`. No explicit inter-species + interaction is present apart from the indirect interaction through the + incompressibility. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + hymd.input_parser.Config : + Configuration dataclass handler. + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultNoChi, self).__init__(config) + super(DefaultNoChi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0, a=self.config.a): + return 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultWithChi(Hamiltonian): + """Incompressibility and :math:`\\chi`-interactions energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = + \\frac{1}{2\\rho_0} + \\sum_{k,l}\\chi_{kl} \\tilde\\phi_k \\tilde\\phi_l + + + \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. :math:`\\chi_{ij}` is the Flory-Huggins-like + inter-species mixing energy. + """ + +
[docs] def __init__(self, config, unique_names, type_to_name_map): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultWithChi, self).__init__(config) + super(DefaultWithChi, self)._setup() + self.setup(unique_names, type_to_name_map)
+ +
[docs] def setup(self, unique_names, type_to_name_map): + """Setup the interaction energy potential and the external potential + + Parameters + ---------- + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + """ + self.type_to_name_map = type_to_name_map + self.chi_type_dictionary = { + tuple(sorted([c.atom_1, c.atom_2])): c.interaction_energy + for c in self.config.chi + } + self.phi_laplacian = [ + sympy.var("phi_laplacian%d(0:%d)" % (t, 3)) + for t in range(self.config.n_types) + ] + + def w( + phi, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + interaction = 0.0 + for i in range(self.config.n_types): + for j in range(i + 1, self.config.n_types): + ni = type_to_name_map[i] + nj = type_to_name_map[j] + names = sorted([ni, nj]) + c = chi_type_dictionary[tuple(names)] + + interaction += c * phi[i] * phi[j] / rho0 + incompressibility = 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + return incompressibility + interaction + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + t, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + + V_interaction = 0.0 + nk = type_to_name_map[t] + for i in range(self.config.n_types): + ni = type_to_name_map[i] + names = sorted([nk, ni]) + if ni != nk: + c = chi_type_dictionary[tuple(names)] + else: + c = 0.0 + # uncomment to count diagonal chi terms: + # c = chi_type_dictionary[tuple(names)] + V_interaction += c * phi[i] / rho0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[t])) + for t in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +def get_hamiltonian(config): + """Return appropriate Hamiltonian object based on the + config.hamiltonian string. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ---------- + hamiltonian : Hamiltonian + Hamiltonian object. + """ + if config.hamiltonian.lower() == "defaultnochi": + hamiltonian = DefaultNoChi(config) + elif config.hamiltonian.lower() == "defaultwithchi": + hamiltonian = DefaultWithChi( + config, config.unique_names, config.type_to_name_map + ) + elif config.hamiltonian.lower() == "squaredphi": + hamiltonian = SquaredPhi(config) + + return hamiltonian +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/_modules/hymd/input_parser.html b/v2.1.0/_modules/hymd/input_parser.html new file mode 100644 index 00000000..9475b172 --- /dev/null +++ b/v2.1.0/_modules/hymd/input_parser.html @@ -0,0 +1,1645 @@ + + + + + + hymd.input_parser — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.input_parser

+"""Parses and handles the configuration information provided for the simulation
+"""
+import copy
+import tomli
+import datetime
+import logging
+import warnings
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass, field
+from typing import List, Union, ClassVar
+from .force import Bond, Angle, Dihedral, Chi, Dielectric_type, propensity_potential_coeffs
+from .barostat import Target_pressure
+from .logger import Logger
+
+
+
[docs]@dataclass +class Config: + """Configuration object + + Handles and verifies the simulation configuration specified in the + configuration file. + + Attributes + ---------- + gas_constant : float + Constant value of the gas constant, R (equivalently the Boltzmann + constant) in the units used internally in HyMD. + coulomb_constant : float + Constant value of the Coulomb constant which converts electric field + values to forces and electric potential values to energies in the units + used internally in HyMD. + n_steps: int + Number of time steps in the simulation. + time_step: float + *Outer* time step used in the simulation. If the rRESPA intergrator is + used, the *inner* time step (the time step used in the integration of + intramolecular bending, stretching, and torsional forces) is + :code:`time_step / respa_inner`. + box_size : list[float] or (D,) numpy.ndarray + Simulation box size of simulation in :code:`D` dimensions in units of + nanometers. + mesh_size : list[int] or int or numpy.ndarray + Number of grid points used for the discrete density grid. + sigma : float + Filter width representing the effective coarse-graining level of the + particles in the simulation. + kappa : float + Compressibility parameter used in the relaxed incompressibility term in + the interaction energy functional. + n_print : int, optional + Frequency of trajectory/energy output to the H5MD trajectory/energy + output file (in units of number of time steps). + tau : float, optional + The time scale of the CSVR thermostat coupling. + start_temperature : float, optional + Generate starting temperature by assigning all particle velocities + randomly according to the Maxwell-Boltzmann distribution at + :code:`start_temperature` Kelvin prior to starting the simulation. + target_temperature : float, optional + Couple the system to a heat bath at :code:`target_temperature` Kelvin. + mass : float, optional + Mass of the particles in the simulation. + hamiltonian : str, optional + Specifies the interaction energy functional :math:`W[\\tilde\\phi]` + for use with the particle-field interactions. Options: + :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`. + domain_decomposition : int, optional + Specifies the interval (in time steps) of domain decomposition + exchange, involving all MPI ranks sending and receiving particles + according to the particles’ positions in the integration box and the + MPI ranks’ assigned domain. + integrator : str, optional + Specifies the time integrator used in the simulation. Options: + :code:`velocity-verlet` or :code:`respa`. + respa_inner : int, optional + The number of inner time steps in the rRESPA integrator. This denotes + the number of intramolecular force calculations (stretching, bending, + torsional) are performed between each impulse applied from the field + forces. + file_name : str, optional + File path of the parsed configuration file. + name : str, optional + Name for the simulation. + tags : list[str], optional + Tags for the simulation. + bonds : list[Bond], optional + Specifies harmonic stretching potentials between particles in the + same molecule. + angle_bonds : list[Angle], optional + Specifies harmonic angular bending potentials between particles in the + same molecule. + dihedrals : list[Dihedral], optional + Specifies four-particle torsional potentials by cosine series. + chi : list[Chi], optional + Specifies :math:`\\chi`-interaction parameters between particle + species. + n_particles : int, optional + Specifies the total number of particles in the input. Optional keyword + for validation, ensuring the input HDF5 topology has the correct number + of particles and molecules. + max_molecule_size : int, optional + Maximum size of any single molecule in the system. Used to speed up + distribution of particles onto MPI ranks in a parallel fashion. + n_flush : int, optional + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be + written to disk (in units of number of :code:`n_print`). + thermostat_work : float + Work performed by the thermostat on the system. + thermostat_coupling_groups : list[str], optional + Specifies individual groups coupling independently to the CSVR + thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and + :code:`"C"` type particles, + :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would + thermalise types :code:`"A"` and :code:`"B"` together and couple + :code:`"C"` type particles to a different thermostat (all individual + thermostats are at the same temperature, i.e. target_temperature + Kelvin). + initial_energy : float + Value of the total energy prior to the start of the simulation. + cancel_com_momentum : int, optional + If :code:`True`, the total linear momentum of the center of mass is + removed before starting the simulation. If an integer is specifed, the + total linear momentum of the center of mass is removed every + :code:`remove_com_momentum` time steps. If :code:`False`, the linear + momentum is never removed. + coulombtype : str, optional + Specifies the type of electrostatic Coulomb interactions in the system. + The strength of the electrostatic forces is modulated by the relative + dielectric constant of the simulation medium, specified with the + :code:`dielectric_const` keyword. Charges for individual particles are + specified in the structure/topology HDF5 input file, not in the + configuration file. If no charges (or peptide backbone dipoles) are + present, the electrostatic forces will not be calculated even if this + keyword is set to :code:`"PIC_Spectral"`. + dielectric_const : float, optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. When + using helical propensity dihedrals, this keyword must be specified—even + if electrostatics are not included with the :code:`coulombtype` + keyword. + dielectric_type: list[float], optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. The list assigns + relative dielectric values to each bead type, and an anisotropic + dielectric function is obtained from a weighted average. + + + See also + -------- + hymd.input_parser.Bond : + Two-particle bond type dataclass. + hymd.input_parser.Angle : + Three-particle bond type dataclass. + hymd.input_parser.Dihedral : + Four-particle bond type dataclass. + """ + + gas_constant: ClassVar[float] = 0.0083144621 # kJ mol-1 K-1 + coulomb_constant: ClassVar[float] = 138.935458 # kJ nm mol-1 e-2 + + n_steps: int + time_step: float + mesh_size: Union[Union[List[int], np.ndarray], int] + sigma: float + kappa: float + + dtype: np.dtype = None + box_size: Union[List[float], np.ndarray] = None + n_print: int = None + tau: float = None + start_temperature: Union[float, bool] = None + target_temperature: Union[float, bool] = None + mass: float = None + hamiltonian: str = None + domain_decomposition: Union[int, bool] = None + integrator: str = None + respa_inner: int = 1 + file_name: str = "<config file path unknown>" + name: str = None + tags: List[str] = field(default_factory=list) + bonds: List[Bond] = field(default_factory=list) + angle_bonds: List[Angle] = field(default_factory=list) + dihedrals: List[Dihedral] = field(default_factory=list) + chi: List[Chi] = field(default_factory=list) + n_particles: int = None + max_molecule_size: int = None + n_flush: int = None + thermostat_work: float = 0.0 + thermostat_coupling_groups: List[List[str]] = field(default_factory=list) + initial_energy: float = None + cancel_com_momentum: Union[int, bool] = False + coulombtype: str = None + convergence_type: str = None + pol_mixing: float = None + dielectric_const: float = None + conv_crit: float = None + dielectric_type: List[Dielectric_type] = field(default_factory=list) + self_energy: float = None + type_charges: Union[List[float], np.ndarray] = None + + # For NPT runs + rho0: float = None + a: float = None + pressure: bool = False + barostat: str = None + barostat_type: str = None + tau_p: float = None + target_pressure: List[Target_pressure] = field(default_factory=list) + n_b: int = None + m: List[float] = field(default_factory=list) + + def __str__(self): + target_pressure_str = "\ttarget_pressure:\n" + "".join( + "\t\tP_L: " + + f"{self.target_pressure.P_L}\n" + + "\t\tP_N: " + + f"{self.target_pressure.P_N}\n" + ) + bonds_str = "\tbonds:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " f"{k.equilibrium}, {k.strength}\n") + for k in self.bonds + ] + ) + angle_str = "\tangle_bonds:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3}: " + + f"{k.equilibrium}, {k.strength}\n" + ) + for k in self.angle_bonds + ] + ) + dihedrals_str = "\tdihedrals:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: " + # This might need to be fixed/made prettier, probably + # there's an easier way + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ).join( + map( + str, + [ + [round(num, 3) for num in c_in] + if isinstance(c_in, list) + else c_in + for c_in in k.coeffs + ], + ) + ) + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ) + + f"dih_type = {k.dih_type}\n" + ) + for k in self.dihedrals + ] + ) + chi_str = "\tchi:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " + f"{k.interaction_energy}\n") + for k in self.chi + ] + ) + + """ If dielectric wanted as dictionary + dielectric_type_str = "\tdielectric_type:\n" + "".join( + [ + (f"\t\t{k.atom_1}: " + f"{k.dielectric_value}\n") + for k in self.dielectric_type + ] + ) + + """ + + thermostat_coupling_groups_str = "" + if any(self.thermostat_coupling_groups): + thermostat_coupling_groups_str = ( + "\tthermostat_coupling_groups:\n" + + "".join( + [ + "\t\t" + ", ".join([f"{n}" for n in ng]) + "\n" + for ng in self.thermostat_coupling_groups + ] + ) + ) + + ret_str = f'\n\n\tConfig: {self.file_name}\n\t{50 * "-"}\n' + for k, v in self.__dict__.items(): + if k not in ( + "target_pressure", + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "thermostat_coupling_groups", + ): + ret_str += f"\t{k}: {v}\n" + ret_str += ( + target_pressure_str + + bonds_str + + angle_str + + dihedrals_str + + chi_str + + thermostat_coupling_groups_str + ) + return ret_str
+ + +
[docs]def read_config_toml(file_path): + with open(file_path, "r") as in_file: + file_content = in_file.read() + return file_content
+ +
[docs]def parse_config_toml(toml_content, file_path=None, comm=MPI.COMM_WORLD): + config_dict = {} + + # read toml to a dictionary + toml_content = tomli.loads(toml_content) + + # Defaults = None + for n in ( + "box_size", + "n_print", + "tau", + "start_temperature", + "target_temperature", + "mass", + "hamiltonian", + "domain_decomposition", + "integrator", + "name", + "n_particles", + "max_molecule_size", + "coulombtype", + "convergence_type", + "dielectric_const", + "pol_mixing", + "conv_crit", + "dielectric_type", + "n_b", + "box_size", + "n_flush", + "self_energy", + "dtype", + ): + config_dict[n] = None + + # Defaults = [] + + for n in ( + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "tags", + "m", + "dielectric_type", + "target_pressure", + "type_charges", + ): + config_dict[n] = [] + + # Defaults: bool + config_dict["pressure"] = False + + # Flatten the .toml dictionary, ignoring the top level [tag] directives (if + # any). + for k, v in toml_content.items(): + if isinstance(v, dict): + if k == "nn": # Don't parse diff-hymd optimization options + continue + for nested_k, nested_v in v.items(): + config_dict[nested_k] = nested_v + else: + config_dict[k] = v + for k, v in config_dict.items(): + if k == "bonds": + config_dict["bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["bonds"][i] = Bond( + atom_1=b[0], + atom_2=b[1], + equilibrium=b[2], + strength=b[3], + ) + if k == "angle_bonds": + config_dict["angle_bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["angle_bonds"][i] = Angle( + atom_1=b[0], + atom_2=b[1], + atom_3=b[2], + equilibrium=b[3], + strength=b[4], + ) + if k == "dihedrals": + config_dict["dihedrals"] = [None] * len(v) + for i, b in enumerate(v): + try: + dih_type = int(b[2][0]) + except IndexError: + Logger.rank0.log( + logging.WARNING, "Dihedral type not provided, defaulting to 0." + ) + dih_type = 0 + + # Probably it's better to move this in check_dihedrals? + wrong_len = len(b[1]) not in (1, 2) + wrong_type_1 = len(b[1]) == 1 and not isinstance(b[1][0], float) + wrong_type_2 = len(b[1]) == 2 and not isinstance(b[1][0], list) + if wrong_len or wrong_type_1 or wrong_type_2: + err_str = ( + "The coefficients specified for the dihedral type " + "(0) do not match the correct structure. Either " + "use [lambda] or [[cn_prop], [dn_prop]], or select" + " the correct dihedral type." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise RuntimeError(err_str) + + # FIXME: this is messy af, I don't like it + if dih_type == 0 and isinstance(b[1][0], (float, int)): + coeff = propensity_potential_coeffs(b[1][0]) + elif dih_type == 1 and len(b[1]) == 3: + coeff = np.array( + propensity_potential_coeffs(b[1][0][0]).tolist() + + b[1][1:] + ) + elif dih_type == 2: + coeff = np.array(b[1]) + else: + coeff = np.insert(np.array(b[1]), 2, np.zeros((2, 5)), axis=0) + + config_dict["dihedrals"][i] = Dihedral( + atom_1=b[0][0], + atom_2=b[0][1], + atom_3=b[0][2], + atom_4=b[0][3], + coeffs=coeff, + dih_type=dih_type, + ) + if k == "chi": + config_dict["chi"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0], c[1]]) + config_dict["chi"][i] = Chi( + atom_1=c_[0], atom_2=c_[1], interaction_energy=c[2] + ) + + """ + if k == "dielectric_type": + config_dict["dielectric_type"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0][0]]) + config_dict["dielectric_type"][i] = Dielectric_type( + atom_1=c_[0], dielectric_value=c[1][0] + ) + """ + if k == "target_pressure": + if len(v) == 2: + config_dict["target_pressure"] = Target_pressure( + P_L=v[0], + P_N=v[1], # check condition # V array (still read as array?) + ) + elif len(v) == 1: + config_dict["target_pressure"] = Target_pressure(P_L=v[0], P_N=None) + else: + config_dict["target_pressure"] = Target_pressure(P_L=None, P_N=None) + + if file_path is not None: + config_dict["file_name"] = file_path + + for n in ( + "n_steps", "time_step", "mesh_size", "sigma", "kappa" + ): + if n not in config_dict: + err_str = ( + f"No {n} specified in config file {file_path}. Unable to start" + f" simulation." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return Config(**config_dict)
+ + +
[docs]def check_n_particles(config, indices, comm=MPI.COMM_WORLD): + n_particles = comm.allreduce(len(indices), MPI.SUM) + if config.n_particles is None: + config = copy.deepcopy(config) + config.n_particles = n_particles + info_str = ( + f"No n_particles found in toml file {config.file_name}, defaulting" + f" to indices.shape ({n_particles})" + ) + Logger.rank0.log(logging.INFO, info_str) + return config + + if n_particles != config.n_particles: + warn_str = ( + f"n_particles in {config.file_name} ({config.n_particles}) does " + "not match the shape of the indices array in the .HDF5 file " + f"({n_particles}). Defaulting to using indices.shape " + f"({n_particles})" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.n_particles = n_particles + return config
+ + +
[docs]def check_max_molecule_size(config, comm=MPI.COMM_WORLD): + if config.max_molecule_size is None: + info_str = ( + f"No max_molecule_size found in toml file {config.file_name}, " + f"defaulting to 201" + ) + Logger.rank0.log(logging.INFO, info_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + + if config.max_molecule_size < 1: + warn_str = ( + f"max_molecule_size in {config.file_name} must be a positive " + f"integer, not {config.max_molecule_size}, defaulting to 201" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + return config
+ + +def _find_unique_names(config, names, comm=MPI.COMM_WORLD): + unique_names = np.unique(names) + receive_buffer = comm.gather(unique_names, root=0) + + gathered_unique_names = None + if comm.Get_rank() == 0: + gathered_unique_names = np.unique(np.concatenate(receive_buffer)) + unique_names = comm.bcast(gathered_unique_names, root=0) + unique_names = sorted([n.decode("UTF-8") for n in unique_names]) + config.unique_names = unique_names + config.n_types = len(unique_names) + return config + + +def _setup_type_to_name_map(config, names, types, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + name_to_type_ = {} + for n, t in zip(names, types): + n = n.decode("utf-8") + if n not in name_to_type_: + name_to_type_[n] = t + receive_buffer = comm.gather(name_to_type_, root=0) + gathered_dict = None + if comm.Get_rank() == 0: + gathered_dict = {} + for d in receive_buffer: + for k, v in d.items(): + if k not in gathered_dict: + gathered_dict[k] = v + else: + assert v == gathered_dict[k] + name_to_type_map = comm.bcast(gathered_dict, root=0) + config.name_to_type_map = name_to_type_map + config.type_to_name_map = {v: k for k, v in name_to_type_map.items()} + return config + + +
[docs]def check_bonds(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for b in config.bonds: + if b.atom_1 not in unique_names or b.atom_2 not in unique_names: + missing_str = "" + if b.atom_1 not in unique_names: + if b.atom_2 not in unique_names: + if b.atom_1 == b.atom_2: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"neither {b.atom_1}, {b.atom_2} atoms" + else: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"no {b.atom_2} atoms" + + warn_str = ( + f"Bond type {b.atom_1}--{b.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_angles(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for a in config.angle_bonds: + if ( + a.atom_1 not in unique_names + or a.atom_2 not in unique_names + or a.atom_3 not in unique_names + ): + missing = [ + a.atom_1 not in unique_names, + a.atom_2 not in unique_names, + a.atom_3 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([a.atom_1, a.atom_2, a.atom_3]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Angle bond type {a.atom_1}--{a.atom_2}--{a.atom_3} " + f"specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_dihedrals(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for d in config.dihedrals: + if ( + d.atom_1 not in unique_names + or d.atom_2 not in unique_names + or d.atom_3 not in unique_names + or d.atom_4 not in unique_names + ): + missing = [ + d.atom_1 not in unique_names, + d.atom_2 not in unique_names, + d.atom_3 not in unique_names, + d.atom_4 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([d.atom_1, d.atom_2, d.atom_3, d.atom_4]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Dihedral type {d.atom_1}--{d.atom_2}--{d.atom_3}--{d.atom_4}" + f" specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_chi(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for c in config.chi: + if c.atom_1 not in unique_names or c.atom_2 not in unique_names: + missing_str = "" + if c.atom_1 not in unique_names: + if c.atom_2 not in unique_names: + if c.atom_1 == c.atom_2: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"neither {c.atom_1}, {c.atom_2} atoms" + else: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"no {c.atom_2} atoms" + + warn_str = ( + f"Chi interaction {c.atom_1}--{c.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + for i, n in enumerate(unique_names): + for m in unique_names[i + 1 :]: + found = False + for c in config.chi: + if (c.atom_1 == n and c.atom_2 == m) or ( + c.atom_1 == m and c.atom_2 == n + ): + found = True + if not found: + config.chi.append(Chi(atom_1=n, atom_2=m, interaction_energy=0.0)) + warn_str = ( + f"Atom types {n} and {m} found in the " + f"system, but no chi interaction {n}--{m} " + f"specified in {config.file_name}. Defaulting to " + f"chi[{n}, {m}] = 0" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_box_size(config, input_box, comm=MPI.COMM_WORLD): + if config.box_size is not None: + config.box_size = np.array(config.box_size, dtype=np.float32) + if input_box.all() and not np.allclose(config.box_size, input_box, atol=0.009): + err_str = ( + f"Box size specified in {config.file_name}: " + f"{config.box_size} does not match input box:" + f"{input_box}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + else: + if input_box.all(): + config.box_size = input_box + else: + err_str = f"No box information found" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + for b in config.box_size: + if b <= 0.0: + err_str = ( + f"Invalid box size specified in {config.file_name}: " + f"{config.box_size}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return config
+ + +
[docs]def check_integrator(config, comm=MPI.COMM_WORLD): + if config.integrator.lower() not in ("velocity-verlet", "respa"): + err_str = ( + f"Invalid integrator specified in {config.file_name}: " + f'{config.integrator}. Available options "velocity-verlet" or ' + f'"respa".' + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + if config.integrator.lower() == "respa": + if isinstance(config.respa_inner, float): + warn_str = ( + f"Number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner} specified " + f"as float, using {int(config.respa_inner)}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = int(config.respa_inner) + elif not isinstance(config.respa_inner, int): + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + + if config.respa_inner <= 0: + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + if config.integrator.lower() == "velocity-verlet" and config.respa_inner != 1: + warn_str = ( + f"Integrator type Velocity-Verlet specified in {config.file_name} " + f"and inner rRESPA time steps set to {config.respa_inner}. " + f"Using respa_inner = 1" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = 1 + + return config
+ + +
[docs]def check_hamiltonian(config, comm=MPI.COMM_WORLD): + valid_hamiltonians = ["defaultnochi", "defaultwithchi", "squaredphi"] + + if config.hamiltonian is None: + if len(config.chi) == 0: + warn_str = ( + f"No hamiltonian form and no chi interactions specified in " + f"{config.file_name}, defaulting to DefaultNoChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultNoChi" + else: + warn_str = ( + f"No hamiltonian form specified in {config.file_name}, but " + f"chi interactions are specified, defaulting to " + f"DefaultWithChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultWithChi" + elif config.hamiltonian.lower() not in valid_hamiltonians: + err_str = ( + f"The specified Hamiltonian {config.hamiltonian} was not " + f"recognized as a valid Hamiltonian." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise NotImplementedError(err_str) + + return config
+ + +
[docs]def check_n_flush(config, comm=MPI.COMM_WORLD): + if config.n_print: + if config.n_flush is None: + config.n_flush = 10000 // config.n_print + return config
+ + +
[docs]def check_n_print(config, comm=MPI.COMM_WORLD): + if ( + not isinstance(config.n_print, int) + and not isinstance(config.n_print, float) + and config.n_print is not None + ): + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if config.n_print is None or config.n_print <= 0: + config.n_print = False + elif not isinstance(config.n_print, int): + if isinstance(config.n_print, float): + warn_str = ( + f"n_print is a float ({config.n_print}), not int, using " + f"{int(round(config.n_print))}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + config.n_print = int(round(config.n_print)) + else: + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + return config
+ + +
[docs]def check_tau(config, comm=MPI.COMM_WORLD): + if config.tau is None and config.target_temperature is not None: + warn_str = "target temp specified but no tau, defaulting 0.7" + config.tau = 0.7 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_start_and_target_temperature(config, comm=MPI.COMM_WORLD): + """Validate provided starting and target thermostat temperatures + + Assesses the provided temperature target and ensures it is a non-negative + floating point number or :code:`False`. Ensures the starting temperature is + a non-negative floating point number or :code:`False`. + + If the value for either is :code:`None`, the returned configuration object + has the values defaulted to :code:`False` in each case. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ------- + validated_config : Config + Configuration object with validated :code:`target_temperature` and + :code:`start_temperature`. + """ + for t in ("start_temperature", "target_temperature"): + if getattr(config, t) is not None: + try: + if getattr(config, t) < 0: + warn_str = ( + f"{t} set to negative value ({getattr(config, t)}), " + f"defaulting to False" + ) + setattr(config, t, False) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + except TypeError as e: + err_str = ( + f"Could not interpret {t} = {repr(getattr(config, t))} as " + f"a number." + ) + raise TypeError(err_str) from e + + if config.start_temperature is None: + config.start_temperature = False + if config.target_temperature is None: + config.target_temperature = False + return config
+ + +
[docs]def check_mass(config, comm=MPI.COMM_WORLD): + if config.mass is None: + info_str = "no mass specified, defaulting to 72.0" + config.mass = 72.0 + Logger.rank0.log(logging.INFO, info_str) + elif not isinstance(config.mass, int) and not isinstance(config.mass, float): + err_str = ( + f"specified mass is invalid type {config.mass}, " f"({type(config.mass)})" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + elif config.mass < 0: + err_str = f"invalid mass specified, {config.mass}" + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + else: + config.mass = float(config.mass) + + return config
+ + +
[docs]def check_domain_decomposition(config, comm=MPI.COMM_WORLD): + dd = config.domain_decomposition + if dd is None or dd is False: + config.domain_decomposition = False + return config + + if isinstance(dd, int): + if dd < 0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + elif isinstance(dd, float): + if dd < 0.0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + else: + warn_str = ( + f"domain_decomposition ({config.domain_decomposition}) is not " + f"an integer, using {int(round(dd))}" + ) + config.domain_decomposition = int(round(dd)) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + else: + err_str = ( + f"invalid value for domain_decomposition " + f"({config.domain_decomposition}) use an integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + return config
+ + +
[docs]def check_name(config, comm=MPI.COMM_WORLD): + if config.name is None: + root_current_time = "" + if comm.Get_rank() == 0: + root_current_time = datetime.datetime.now().strftime("%m/%d/%Y, %H:%M:%S") + current_time = comm.bcast(root_current_time, root=0) + + if config.name is None: + config.name = "sim" + current_time + else: + config.name = str(config.name) + return config
+ + +
[docs]def check_NPT_conditions(config, comm=MPI.COMM_WORLD): + """ + Check validity of barostat_type, barostat, + a, rho0, target_pressure, tau_p + """ + if config.barostat is None: + if ( + config.tau_p is not None + or (config.target_pressure.P_L and config.target_pressure.P_N) is not None + ): + err_str = ( + "barostat not specified but config.tau_p " + "or config.target_pressure specified, cannot start simulation {config.barostat}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.a: + warn_str = "a specified but no barostat," "setting a to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.rho0: + warn_str = ( + "rho0 specified but no barostat," "setting rho0 to average density" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + if config.barostat is not None: + if not config.barostat_type: + config.barostat_type = "berendsen" + warn_str = "barostat_type not specified," "setting to berendsen" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.barostat != "isotropic" and config.barostat != "semiisotropic": + err_str = "barostat option not recognised. Valid options: isotropic, semiisotropic" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.target_pressure.P_L is None: + config.target_pressure.P_L = 1.0 # bar + config.target_pressure.P_N = None + if config.barostat == "semiisotropic": + config.target_pressure.P_N = 1.0 # bar + warn_str = ( + "barostat specified but no target_pressure, defaulting to 1.0 bar" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.tau_p is None: + if config.tau <= 0.1: + config.tau_p = config.tau * 10.0 + else: + config.tau_p = 1.0 + warn_str = "barostat specified but no tau_p, defaulting to " + str( + config.tau_p + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if not config.a: + err_str = "a not specified; cannot start simulation {config.a}" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if not config.rho0: + warn_str = "rho0 not specified;" "setting rho0 to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + return config
+ + +
[docs]def check_thermostat_coupling_groups(config, comm=MPI.COMM_WORLD): + if any(config.thermostat_coupling_groups): + found = [0 for _ in config.unique_names] + unique_names = [n for n in config.unique_names] + for i, group in enumerate(config.thermostat_coupling_groups): + for species in group: + try: + ind = unique_names.index(species) + found[ind] += 1 + except ValueError as e: + err_str = ( + f"Particle species {species} specified in thermostat " + f"coupling group {i}, but no {species} particles were " + "found in the system." + ) + raise ValueError(err_str) from e + if any([True if f > 1 else False for f in found]): + for i, f in enumerate(found): + if f > 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} specified in multiple " + "thermostat coupling groups; " + f"{config.thermostat_coupling_groups}." + ) + raise ValueError(err_str) + if not all([True if f == 1 else False for f in found]): + for i, f in enumerate(found): + if f != 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} not specified in any " + f"thermostat coupling group, but {species} particles " + "were found in the system" + ) + raise ValueError(err_str) + return config
+ + +
[docs]def check_m(config, comm=MPI.COMM_WORLD): + if config.m == []: + config.m = [1.0 for t in range(config.n_types)] + return config
+ + +
[docs]def check_n_b(config, comm=MPI.COMM_WORLD): + if config.n_b is None: + warn_str = f"config.n_b not specified." "Defaulting to 1" + config.n_b = 1 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_cancel_com_momentum(config, comm=MPI.COMM_WORLD): + if isinstance(config.cancel_com_momentum, int): + if config.cancel_com_momentum == 0 or config.cancel_com_momentum < 0: + config.cancel_com_momentum = False + elif not isinstance(config.cancel_com_momentum, bool): + err_str = ( + f"Could not interpret {config.cancel_com_momentum} as an integer " + f"or boolean." + ) + raise ValueError(err_str) + return config
+ + +
[docs]def sort_dielectric_by_type_id(config, charges, types): + """ + Creates a list of length N CG-particles, sorted after the charges from + the input HDF5 file. Used in file_io.py + """ + dielectric_val = np.zeros(config.n_types) + for j in range(config.n_types): + name = config.dielectric_type[j][0][0] + type_id = config.name_to_type_map[name] + dielectric_val[type_id] = config.dielectric_type[j][1][0] + config.dielectric_type = dielectric_val.copy() + + N = len(charges) + len_list = np.zeros(config.n_types) + dielectric_by_types = np.zeros(N) + for i in range(N): + dielectric_by_types[i] = dielectric_val[types[i]] + # print("types ", types) + # print("diel val", dielectric_by_types) + # print("charges", charges) + # print(config.name_to_type_map) + return dielectric_by_types # by types with each particle id
+ + +
[docs]def check_charges_types_list(config, types, charges, comm=MPI.COMM_WORLD): + """ + Creates a list of charge values of length types. + Charges are sorted according to type ID. Used in field.py. + # TODO: this is messy, we should fix it + """ + if charges is None: + config.type_charges = [0.0] * config.n_types + return config + + check_val = -100.0 # some random value that will never be encountered + charges_list = np.full(config.n_types, check_val) # gatherv cant handle None + rank = comm.Get_rank() + # print(charges_list) + for t_ in range(config.n_types): + if t_ in types: + charges_list[t_] = charges[types == t_][0] + + nprocs = int(comm.Get_size()) + recv_charges = None + if rank == 0: + recv_charges = np.full( + config.n_types * nprocs, check_val + ) # gatherv cant handle None + comm.Gather(charges_list, recv_charges, root=0) + + ## make a charges list + if rank == 0: + config_charges = np.zeros(config.n_types) + test_config = np.full(config.n_types, check_val) + for j in range(nprocs): + for i in range(config.n_types): + if recv_charges[i + j * config.n_types] != check_val: + config_charges[i] = recv_charges[i + j * config.n_types] + if np.any([test_config, config_charges]): + continue + else: + break + + # print(config_charges) + # print(config.name_to_type_map) + # print(charges[types == 0][0],charges[types == 1][0],charges[types == 2][0],charges[types == 3][0], + # charges[types == 4][0]) + else: + config_charges = np.zeros(config.n_types) + + comm.Bcast(config_charges, root=0) + # print("config_charges", config_charges , "rank", rank) + # print(recv_charges) + # rank = comm.Get_rank() + # print(all_charges) + config.type_charges = config_charges + return config
+ + +
[docs]def check_dielectric(config, comm=MPI.COMM_WORLD): + """ + Error handling for electrostatics. + Unit testing of toml/tomli input. + """ + err_str_const = "Dielectric constant not given." + if config.coulombtype == "PIC_Spectral": + assert config.dielectric_const != None, err_str_const + + err_str = "Dielectric list is empty." + if config.coulombtype == "PIC_Spectral_GPE": + assert len(config.dielectric_type) != 0, err_str + # default values + if config.pol_mixing is None: + config.pol_mixing = 0.6 + if config.conv_crit is None: + config.conv_crit = 1e-6 + return config
+ + +
[docs]def check_charges(config, charges, comm=MPI.COMM_WORLD): + """Check if charges across ranks sum to zero. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of floats with charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + """ + total_charge = comm.allreduce(np.sum(charges), MPI.SUM) + + if not np.isclose(total_charge, 0.0): + warn_str = ( + f"Charges in the input file do not sum to zero. " + f"Total charge is {total_charge}." + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + # if charges are ok, compute self energy + if config.coulombtype == "PIC_Spectral": + from .field import compute_self_energy_q + + config.self_energy = compute_self_energy_q(config, charges, comm=comm) + + return config
+ + +
[docs]def check_config( + config, indices, names, types, charges, input_box, comm=MPI.COMM_WORLD +): + """Performs various checks on the specfied config to ensure consistency + + Parameters + ---------- + config : Config + Configuration object. + indices : (N,) numpy.ndarray + Array of integer indices for :code:`N` particles. + names : (N,) numpy.ndarray + Array of string names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of integer type indices for :code:`N` particles. + charges : (N,) numpy.ndarray + Array of floats charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + + Returns + ------- + config : Config + Validated configuration object. + """ + config = _find_unique_names(config, names, comm=comm) + if types is not None: + config = _setup_type_to_name_map(config, names, types, comm=comm) + config = check_box_size(config, input_box, comm=comm) + config = check_integrator(config, comm=comm) + config = check_max_molecule_size(config, comm=comm) + config = check_tau(config, comm=comm) + config = check_start_and_target_temperature(config, comm=comm) + config = check_mass(config, comm=comm) + config = check_domain_decomposition(config, comm=comm) + config = check_name(config, comm=comm) + config = check_n_particles(config, indices, comm=comm) + config = check_chi(config, names, comm=comm) + config = check_bonds(config, names, comm=comm) + config = check_angles(config, names, comm=comm) + config = check_dihedrals(config, names, comm=comm) + config = check_hamiltonian(config, comm=comm) + config = check_NPT_conditions(config, comm=comm) + config = check_n_b(config, comm=comm) + config = check_m(config, comm=comm) + config = check_thermostat_coupling_groups(config, comm=comm) + config = check_cancel_com_momentum(config, comm=comm) + config = check_dielectric(config, comm=comm) + config = check_n_print(config, comm=comm) + config = check_n_flush(config, comm=comm) + config = check_charges_types_list(config, types, charges, comm=comm) + if charges is not None: + config = check_charges(config, charges, comm=comm) + + return config
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/_modules/hymd/integrator.html b/v2.1.0/_modules/hymd/integrator.html new file mode 100644 index 00000000..6c45220b --- /dev/null +++ b/v2.1.0/_modules/hymd/integrator.html @@ -0,0 +1,368 @@ + + + + + + hymd.integrator — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.integrator

+"""Integrates equations of motion.
+
+Implements the Velocity Verlet integrator. The *reversible reference system
+propagator algorithm* (rRESPA) integrator uses the Velocity Verlet functions
+inside the MD loop in the main module.
+"""
+
+
+
[docs]def integrate_velocity(velocities, accelerations, time_step): + """Velocity update step of the Velocity Verlet integration algorithm. + + Computes the velocity update step of the Velocity Verlet algorithm. The + :code:`velocities` argument is **not** changed in place. + + Parameters + ---------- + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + accelerations : (N, D) numpy.ndarray + Array of accelerations of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step + + .. math:: \\mathbf{v}_{\\text{new}} = \\mathbf{v} + \\frac{\\Delta t}{2m} + \\mathbf{f} + + before the positions are moved a full step using the updated half-step + velocities. + + See Also + -------- + integrate_position : The position update step of the Velocity Verlet + algorithm. + """ + return velocities + 0.5 * time_step * accelerations
+ + +
[docs]def integrate_position(positions, velocities, time_step): + """Position update step of the Velocity Verlet integration algorithm. + + Computes the position update step of the Velocity Verlet algorithm. The + :code:`positions` argument is **not** changed in place. + + Parameters + ---------- + positions : (N, D) numpy.ndarray + Array of positions of :code:`N` particles in :code:`D` dimensions. + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step, then the positions are updated a full step using the updated + velocities + + .. math:: \\mathbf{x}_{\\text{new}} = \\mathbf{x} + \\Delta t \\mathbf{v} + + See Also + -------- + integrate_velocity : The velocity update step of the Velocity Verlet + algorithm. + """ + return positions + time_step * velocities
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/_modules/hymd/logger.html b/v2.1.0/_modules/hymd/logger.html new file mode 100644 index 00000000..3f764292 --- /dev/null +++ b/v2.1.0/_modules/hymd/logger.html @@ -0,0 +1,557 @@ + + + + + + hymd.logger — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.logger

+"""Handles event logging for simulation information, warnings, and errors.
+"""
+import sys
+import os
+import logging
+from mpi4py import MPI
+from .version import __version__
+
+
+
[docs]class MPIFilterRoot(logging.Filter): + """Log output Filter wrapper class for the root MPI rank log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + if self.comm.Get_rank() == 0: + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True + else: + return False
+ + +
[docs]class MPIFilterAll(logging.Filter): + """Log output Filter wrapper class for the all-MPI-ranks log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True
+ + +class MPIFilterStdout(logging.Filter): + """Log output Filter wrapper class for filtering STDOUT log""" + + def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.funcName = "replica 0 " + record.funcName + if MPI.COMM_WORLD.Get_rank() == 0: + record.rank = MPI.COMM_WORLD.Get_rank() + record.size = MPI.COMM_WORLD.Get_size() + return True + else: + return False + + +
[docs]class Logger: + """Log output handler class + + Notes + ----- + This wraps the default python library :code:`logging`, see + `docs.python.org/3/library/logging.html`_. + + .. _`docs.python.org/3/library/logging.html`: + https://docs.python.org/3/library/logging.html + + Attributes + ---------- + level : int + Determines the verbosity level of the log, corresponding to + logging.level. Numerical values :code:`50` (:code:`logging.CRITICAL`), + :code:`40` (:code:`logging.ERROR`), :code:`30` + (:code:`logging.WARNING`), :code:`20` (:code:`logging.INFO`), + :code:`10` (:code:`logging.DEBUG`), and :code:`0` + (:code:`logging.UNSET`) are supported values. Any log event message + less severe than the specified level is ignored. All other event + messages are emitted. + log_file : str + Path to output log file. + format : str + Prepended dump string for each log event. Specifies the log event + level, the module emitting the event, the code line, the enclosing + function name, and the MPI rank writing the message. + date_format : str + Prepends the date before all log event messages. + formatter : logging.Formatter + Formatter handling the prepending of the information in `format` and + `date_format` to each log event message. Used by default for all + loggers. + rank0 : logging.Logger + Default logger object for the root MPI rank. + all_ranks : logging.Logger + Default logger object for messages being emitted from all MPI ranks + simultaneously. + """ + + level = None + log_file = None + format = " %(levelname)-8s [%(filename)s:%(lineno)d] <%(funcName)s> {rank %(rank)d/%(size)d} %(message)s" # noqa: E501 + date_format = "%(asctime)s" + formatter = logging.Formatter(fmt=date_format + format) + rank0 = logging.getLogger("HyMD.rank_0") + all_ranks = logging.getLogger("HyMD.all_ranks") + +
[docs] @classmethod + def setup(cls, default_level=logging.INFO, log_file=None, verbose=False, comm=MPI.COMM_WORLD): + """Sets up the logger object. + + If a :code:`log_file` path is provided, log event messages are output + to it. Otherwise, the logging messages are emitted to stdout. + + Parameters + ---------- + default_level : int, optional + Default verbosity level of the logger. Unless specified, it is + :code:`10` (:code:`logging.INFO`). + log_file : str, optional + Path to output log file. If `None` or not priovided, no log file is + used and all logging is done to stdout. + verbose : bool, optional + Increases the logging level to :code:`30` (:code:`logging.WARNING`) + if True, otherwise leaves the logging level unchanged. + """ + cls.level = default_level + cls.log_file = log_file + + log_to_stdout = False + if verbose: + log_to_stdout = True + + level = default_level + if not verbose: + level = logging.WARNING + cls.rank0.setLevel(level) + cls.all_ranks.setLevel(level) + + root_filter = MPIFilterRoot(comm) + all_filter = MPIFilterAll(comm) + cls.rank0.addFilter(root_filter) + cls.all_ranks.addFilter(all_filter) + + if (not log_file) and (not log_to_stdout): + return + if log_file: + cls.log_file_handler = logging.FileHandler(log_file) + cls.log_file_handler.setLevel(level) + cls.log_file_handler.setFormatter(cls.formatter) + + cls.rank0.addHandler(cls.log_file_handler) + cls.all_ranks.addHandler(cls.log_file_handler) + if log_to_stdout: + cls.log_to_stdout = True + cls.stdout_handler = logging.StreamHandler() + cls.stdout_handler.setLevel(level) + cls.stdout_handler.setStream(sys.stdout) + cls.stdout_handler.setFormatter(cls.formatter) + cls.stdout_handler.addFilter(MPIFilterStdout()) + + cls.rank0.addHandler(cls.stdout_handler) + cls.all_ranks.addHandler(cls.stdout_handler)
+ + +def format_timedelta(timedelta): + days = timedelta.days + hours, rem = divmod(timedelta.seconds, 3600) + minutes, seconds = divmod(rem, 60) + microseconds = timedelta.microseconds + ret_str = "" + if days != 0: + ret_str += f"{days} days " + ret_str += f"{hours:02d}:{minutes:02d}:{seconds:02d}.{microseconds:06d}" + return ret_str + + +def get_version(): + # Check if we are in a git repo and grab the commit hash and the branch if + # we are, append it to the version number in the output specification. + try: + import git + + try: + repo_dir = os.path.abspath( + os.path.join(os.path.dirname(__file__), os.pardir) + ) + repo = git.Repo(repo_dir) + commit = str(repo.head.commit)[:7] + branch = repo.active_branch + version = f"{__version__} [{branch} branch commit {commit}]" + except git.exc.InvalidGitRepositoryError: + version = f"{__version__}" + except ModuleNotFoundError: + version = f"{__version__}" + + return version + + +def print_header(): + banner = r""" + __ __ ____ __ _______ + / / / /_ __/ / /__ _________ _____ ______ / |/ / __ \ + / /_/ / / / / / / _ \/ ___/ __ `/ __ `/ ___/ / /|_/ / / / / + / __ / /_/ / / / __/ / / /_/ / /_/ (__ ) / / / / /_/ / + /_/ /_/\__, /_/_/\___/_/ \__,_/\__,_/____/ /_/ /_/_____/ + /____/ + """ + + refs_set = """ + + [1] Ledum, M.; Sen, S.; Li, X.; Carrer, M.; Feng Y.; Cascella, M.; Bore, S. L. + HylleraasMD: A Domain Decomposition-Based Hybrid Particle-Field Software for Multi-Scale Simulations of Soft Matter. + J. Chem. Theory Comput. 2023. + + [2] Ledum, M.; Carrer, M.; Sen, S.; Li, X.; Cascella, M.; Bore, S. L. + HyMD: Massively parallel hybrid particle-field molecular dynamics in Python. + J. Open Source Softw. 8(84), 4149, 2023. + + [3] Sen, S.; Ledum, M.; Bore, S. L.; Cascella, M. + Soft Matter under Pressure: Pushing Particle–Field Molecular Dynamics to the Isobaric Ensemble. + J Chem Inf Model 2023, 63(7), 1549-9596. + + [4] Bore, S. L.; Cascella, M. + Hamiltonian and alias-free hybrid particle–field molecular dynamics. + J. Chem. Phys. 2020, 153, 094106. + + [5] Pippig, M. PFFT: An extension of FFTW to massively parallel architectures. + SIAM J. Sci. Comput. 2013, 35, C213–C236. + +""" + + version = f"Version {get_version()}" + header = banner + header += version.center(56) + "\n\n" + #header += " Please read and cite the references below:" + header += " PLEASE READ AND CITE THE REFERENCES BELOW:" + header += refs_set + + return header +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/_modules/hymd/plumed.html b/v2.1.0/_modules/hymd/plumed.html new file mode 100644 index 00000000..87def192 --- /dev/null +++ b/v2.1.0/_modules/hymd/plumed.html @@ -0,0 +1,530 @@ + + + + + + hymd.plumed — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.plumed

+"""Class to wrap PLUMED for use within HyMD.
+"""
+
+import numpy as np
+import logging
+import os
+from mpi4py import MPI
+from .logger import Logger
+
+
+
[docs]class PlumedBias: + """PLUMED handler class + + Notes + ----- + This wraps the :code:`Plumed()` class, see + `https://github.com/plumed/plumed2/tree/master/python`. + + The :code:`PlumedBias()` object is created with the arguments from + :code:`__init__` and at everystep the methods :code:`prepare()` and + :code:`calc()` should be called. + + Attributes + ---------- + plumed_obj : plumed.Plumed + Plumed object used to pass and request information from PLUMED. + plumed_forces : (N, D) numpy.ndarray + Array of forces of :code:`N` particles in :code:`D` dimensions. + After :code:`calc()`, this array contains only the forces due + to the PLUMED bias. + positions : (N, D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + Needed because we need C-contiguous array for passing to PLUMED. + plumed_bias : (1,) numpy.ndarray + Used as a pointer to an :code:`double` to store the bias energy. + plumed_version : (1,) numpy.ndarray + Used as a pointer to an :code:`int` to store PLUMED API version. + intracomm : mpi4py.Comm + MPI communicator to use for rank communication within a replica. + intercomm : mpi4py.Comm + MPI communicator to use for rank communication between replicas. + ready : bool + Stores wether the :code:`calc()` method can be called or not. + """ + + plumed_obj = None + plumed_forces = None + positions = None + charges = None + plumed_bias = np.zeros(1, np.double) + plumed_version = np.zeros(1, dtype=np.intc) + intracomm = None + intercomm = None + ready = False + verbose = None + + def __init__(self, config, plumeddat, logfile, intracomm=MPI.COMM_WORLD, intercomm=None, verbose=1): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + plumeddat : str + Path file containing PLUMED input. + logfile : str + Path to PLUMED's output file + intracomm : mpi4py.Comm, optional + MPI communicator to use for rank communication within a replica. + intercomm : mpi4py.Comm, optional + MPI communicator to use for rank communication between replicas. + verbose : int, optional + Specify the logging event verbosity of this object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + try: + import plumed + except ImportError: + err_str = ( + "You are trying to use PLUMED but HyMD could not import py-plumed." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ImportError(err_str) + + self.intracomm = intracomm + self.intercomm = intercomm + self.verbose = verbose + + try: + kernel_str = "Using PLUMED_KERNEL={}".format(os.environ["PLUMED_KERNEL"]) + except: + kernel_str = "The PLUMED_KERNEL environment variable is not set." + + Logger.rank0.log(logging.INFO, kernel_str) + + try: + self.plumed_obj = plumed.Plumed() + except: + err_str = ( + "HyMD was not able to create a PLUMED object. " + "Maybe there is a problem with your PLUMED_KERNEL?" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + self.plumed_obj.cmd("getApiVersion", self.plumed_version) + if self.plumed_version[0] <= 3: + err_str = "HyMD requires a PLUMED API > 3. Use a newer PLUMED kernel." + Logger.rank0.log(logging.ERROR, err_str) + raise AssertionError(err_str) + + self.plumed_obj.cmd("setMDEngine", "HyMD") + + if intercomm is not None: + if intracomm.Get_rank() == 0: + self.plumed_obj.cmd("GREX setMPIIntercomm", intercomm) + self.plumed_obj.cmd("GREX setMPIIntracomm", intracomm) + self.plumed_obj.cmd("GREX init") + + self.plumed_obj.cmd("setMPIComm", intracomm) + + Logger.rank0.log( + logging.INFO, f"Attempting to read PLUMED input from {plumeddat}" + ) + + self.plumed_obj.cmd("setPlumedDat", plumeddat) + self.plumed_obj.cmd("setLogFile", logfile) + self.plumed_obj.cmd("setTimestep", config.respa_inner * config.time_step) + self.plumed_obj.cmd("setNatoms", config.n_particles) + self.plumed_obj.cmd("setKbT", config.gas_constant * config.target_temperature) + self.plumed_obj.cmd("setNoVirial") + self.plumed_obj.cmd("init") + + Logger.rank0.log( + logging.INFO, + f"Successfully read PLUMED input. PLUMED output file is {logfile}", + ) + +
[docs] def finalize(self): + """Finalize object""" + self.plumed_obj.finalize()
+ + def __enter__(self): + """Allow usage in 'with' context""" + return self + + def __exit__(self, exc_type, exc_value, traceback): + """Finalize on exit of context""" + self.plumed_obj.__exit__(exc_type, exc_value, traceback) + + @property + def api_version(self): + """Returns the API version got from the PLUMED kernel.""" + return self.plumed_version[0] + +
[docs] def prepare(self, step, forces, positions, indices, config, charges): + """Set the pointers to positions and forces, and returns + wether the potential energy is being requested by PLUMED or not. + """ + if self.verbose > 1: + Logger.rank0.log(logging.INFO, f"Setting PLUMED pointers for step {step}") + self.plumed_forces = forces.ravel(order="C").astype(np.double) + self.charges = charges.astype(np.double) + self.positions = positions.ravel(order="C").astype( + np.double + ) # get C-contiguous array + + needs_energy = np.zeros(1, np.intc) + # plumed_virial = np.zeros((3,3), dtype=np.double) + masses = np.full_like(indices, config.mass, dtype=np.double) + box = np.diag(config.box_size).astype(np.double) + + self.plumed_obj.cmd("setAtomsNlocal", indices.shape[0]) + self.plumed_obj.cmd("setAtomsGatindex", indices) + self.plumed_obj.cmd("setStep", step) + self.plumed_obj.cmd("setForces", self.plumed_forces) + self.plumed_obj.cmd("setPositions", self.positions) + self.plumed_obj.cmd("setCharges", self.charges) + self.plumed_obj.cmd("setMasses", masses) + self.plumed_obj.cmd("setBox", box) + # self.plumed_obj.cmd("setVirial", plumed_virial) + + # check if PLUMED needs energy and returns + self.plumed_obj.cmd("prepareCalc") + self.plumed_obj.cmd("isEnergyNeeded", needs_energy) + + self.ready = True + return True if needs_energy[0] != 0 else False
+ +
[docs] def calc(self, forces, poteng): + """Passes the energy (which can be set to any value in case + :code:`prepare()` returns PLUMED doesn't need it) to get + the forces and energy from the bias. + """ + if not self.ready: + err_str = ( + "Trying to calculate PLUMED biased forces " + "without first calling prepare method." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if self.verbose > 1: + Logger.rank0.log(logging.INFO, "Calculating PLUMED forces") + + # set the energy and calc + self.plumed_obj.cmd("setEnergy", poteng) + self.plumed_obj.cmd("performCalc") + self.plumed_obj.cmd("getBias", self.plumed_bias) + + # check if the returned forces are valid + if np.isnan(self.plumed_forces).any(): + err_str = ( + "Forces returned by PLUMED are not valid. " + "It means there's a NaN in the computed forces, " + "and your input should be checked. " + ) + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + # subtract forces to get only the bias' extra force + self.plumed_forces -= forces.ravel(order="C") + + if self.verbose > 1: + Logger.rank0.log(logging.INFO, "Done calculating PLUMED forces") + + self.ready = False + return ( + np.asfortranarray(np.reshape(self.plumed_forces, forces.shape, order="C")), + self.plumed_bias[0], + )
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/_modules/hymd/pressure.html b/v2.1.0/_modules/hymd/pressure.html new file mode 100644 index 00000000..0b18e383 --- /dev/null +++ b/v2.1.0/_modules/hymd/pressure.html @@ -0,0 +1,474 @@ + + + + + + hymd.pressure — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.pressure

+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import sympy
+from .field import comp_laplacian
+
+
+
[docs]def comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fourier, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=MPI.COMM_WORLD, +): + """ + Computes total internal pressure of the system. + Kinetic pressure is trivially calculated from the kinetic energy. + Already computed bond and angle pressure terms are inserted into the + total internal pressure. + The field pressure equation is implemented. + + Parameters + ---------- + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fourier : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pressure : (18,) numpy.ndarray + Pressure contributions from various energy terms. + 0: due to kinetic energy + 1-5: due to field energy + 6-8: due to two-particle bonded terms + 9-11: due to three-particle bonded terms (called angle terms) + 12-14: due to four-particle bonded terms (called dihedral terms) + (defaults to 0 currently. Yet to be implemented) + 15-17: total pressure in x,y,z directions. + """ + rank = comm.Get_rank() + size = comm.Get_size() + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + w_elec = 0.0 + if (config.coulombtype == "PIC_Spectral_GPE") or ( + config.coulombtype == "PIC_Spectral" + ): + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + w = w_0 + w_elec + + # Kinetic term + kinetic_energy = 0.5 * config.mass * np.sum(velocities**2) + p_kin = 2 / (3 * V) * kinetic_energy + + # Term 1 + p0 = -1 / V * np.sum(w) + + # Term 2 + if psi is not None: # if using electrostatics + V_bar = np.array([hamiltonian.V_bar[k]([phi, psi]) for k in range(config.n_types)]) + else: + V_bar = np.array([hamiltonian.V_bar_0[k](phi) for k in range(config.n_types)]) + + p1 = np.sum((volume_per_cell / V) * V_bar * phi) + + # Term 3 + comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, + ) + + p2 = np.sum( + volume_per_cell + / V + * config.sigma**2 + * np.repeat(V_bar[:, np.newaxis, :, :, :], 3, axis=1) + * phi_laplacian, + axis=(0, 2, 3, 4), + ) + + # Bonded force term: linking 2 particles + p_bond = bond_pr / V + + # Angle force term: linking 3 particles + p_angle = angle_pr / V + + # TODO: Dihedral angle force term: linking 4 atoms + p_dihedral = np.zeros(3) + + # Add formal parameter dihedral_forces as: comp_pressure(..., dihedral_forces) + # Define dictionary: + # forces = { + # 'x': dihedral_forces[:,0], + # 'y': dihedral_forces[:,1], + # 'z': dihedral_forces[:,2] + # } + # Compute the pressure due to dihedrals as: + # p_dihedral = { + # 'x': np.sum( np.multiply(forces['x'],positions[:,0]) )*(1/V), + # 'y': np.sum( np.multiply(forces['y'],positions[:,1]) )*(1/V), + # 'z': np.sum( np.multiply(forces['z'],positions[:,2]) )*(1/V) + # } + + # Total pressure in x, y, z + p_tot = p_kin + p0 + p1 + p2 + p_bond + p_angle + p_dihedral + + return_value = np.array( + [ + p_kin, + p0, + p1, + p2[0], + p2[1], + p2[2], + p_bond[0], + p_bond[1], + p_bond[2], + p_angle[0], + p_angle[1], + p_angle[2], + p_dihedral[0], + p_dihedral[1], + p_dihedral[2], + p_tot[0], + p_tot[1], + p_tot[2], + ] + ) + return_value = comm.allreduce(return_value, MPI.SUM) + + return return_value
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/_modules/hymd/thermostat.html b/v2.1.0/_modules/hymd/thermostat.html new file mode 100644 index 00000000..a2fcd1a7 --- /dev/null +++ b/v2.1.0/_modules/hymd/thermostat.html @@ -0,0 +1,514 @@ + + + + + + hymd.thermostat — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.thermostat

+"""Scales or otherwise modifies the particle velocities during simulation to
+simulate coupling to an external heat bath with temperature T₀.
+"""
+import numpy as np
+import logging
+from mpi4py import MPI
+from typing import Callable
+from .logger import Logger
+from .input_parser import Config
+
+
+def cancel_com_momentum(velocities, config, comm=MPI.COMM_WORLD):
+    com_velocity = comm.allreduce(np.sum(velocities[...], axis=0), MPI.SUM)
+    velocities[...] = velocities[...] - com_velocity / config.n_particles
+    return velocities
+
+
+def generate_initial_velocities(velocities, config, prng, comm=MPI.COMM_WORLD):
+    kT_start = config.gas_constant * config.start_temperature
+    n_particles_ = velocities.shape[0]
+    velocities[...] = prng.normal(
+        loc=0, scale=kT_start / config.mass, size=(n_particles_, 3)
+    )
+    velocities = cancel_com_momentum(velocities, config, comm=comm)
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    start_kinetic_energy_target = (
+        1.5 * config.gas_constant * config.n_particles * config.start_temperature
+    )
+    factor = np.sqrt(1.5 * config.n_particles * kT_start / kinetic_energy)
+    velocities[...] = velocities[...] * factor
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    Logger.rank0.log(
+        logging.INFO,
+        (
+            f"Initialized {config.n_particles} velocities, target kinetic "
+            f"energy: {start_kinetic_energy_target}, actual kinetic energy "
+            f"generated: {kinetic_energy}"
+        ),
+    )
+    return velocities
+
+
+
[docs]def _random_gaussian(prng: np.random.Generator) -> float: + """Draw a single random number from the standard normal distribution + Generate a number from the Gaussian distribution centered at zero with unit + standard deviation, :math:`N(0, 1)`. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + + Returns + ------- + float + A random number drawn from :math:`N(0, 1)`. + """ + return prng.normal()
+ + +
[docs]def _random_chi_squared(prng: np.random.Generator, M: int) -> float: + """Draw the sum of :code:`M` squared normally distributed values + + The value is generated by the Gamma distribution, in lieu of generating + :code:`M` Gaussian distributed numbers and summing their squares. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + M : int + Number of standard normally distributed numbers in the sum. + + Returns + ------- + float + The sum of :code:`M` squared normally distributed values centered at + zero with unit standard deviation. + + Notes + ----- + The sum of the squares of k independent standard normal random variables is + distributed according to a :math:`\\chi^2` distribution. + + .. math:: + + \\chi^2_1 + \\chi_2^2 + \\chi_3^2 + \\dots + \\chi_M^2 + \\sim + \\sigma^2\\chi^2(k) + + This is a special case of the :math:`\\Gamma` distribution, + :math:`\\Gamma(k/2, 2)`, and may be generated by + + .. math:: + + \\chi^2(k) \\sim 2 \\Gamma(k/2, 2) + + References + ---------- + Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of + Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. + J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246. + """ + return prng.chisquare(M)
+ + +
[docs]def csvr_thermostat( + velocity: np.ndarray, + names: np.ndarray, + config: Config, + prng: np.random.Generator, + comm: MPI.Intracomm = MPI.COMM_WORLD, + random_gaussian: Callable[[np.random.Generator], float] = _random_gaussian, + random_chi_squared: Callable[ + [np.random.Generator, int, float], float + ] = _random_chi_squared, + remove_center_of_mass_momentum: bool = True, +) -> np.ndarray: + """Canonical sampling through velocity rescaling thermostat + + Implements the CSVR thermostat. Rescales the system kinetic energy by a + stochastically chosen factor to keep the temperature constant. Requires + communcation of the kinetic energies calculated locally for each MPI rank. + The random numbers sampled through :code:`random_gaussian` and + :code:`random_chi_squared` are broadcast from the root rank to the other + ranks to ensure the scaling is performed with the same stochasticity for + all particles in the full system. + + The velocities are cleaned of center of mass momentum before the thermostat + is applied, and the center of mass momentum is subsequently reapplied. This + is performed for each thermostat coupling group, i.e. the center of mass + momenta of each *group* is separately removed and reapplied after + thermostatting. + + The implementation here is based on the derivation presented in the 2008 + Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper. + + Parameters + ---------- + velocity : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + names : (N,) numpy.ndarray + Array of particle names. + config : Config + Configuration dataclass containing simulation metadata and parameters. + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + random_gaussian : callable, optional + Function for generating standard normally distributed numbers. + random_chi_squared : callable, optional + Function for generating :math:`\\chi^2`-distributed numbers + remove_center_of_mass_momentum : bool, optional + If True, the center of mass of each coupling group is removed before + the thermostat is applied. The center of mass momenta are added back + after the kinetic energy rescaling is complete. + + See Also + -------- + _random_gaussian : + Used to sample Gaussian-distributed numbers. + _random_chi_squared : + Used to sample :math:`\\chi^2`-distributed numbers. + hymd.input_parser.Config : + Configuration dataclass handler. + + References + ---------- + G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). + G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008). + """ + if not any(config.thermostat_coupling_groups): + config.thermostat_coupling_groups = [config.unique_names.copy()] + for i, group in enumerate(config.thermostat_coupling_groups): + ind = np.where( + np.logical_or.reduce(list(names == np.string_(t) for t in group)) + ) + group_n_particles = comm.allreduce(len(ind[0]), MPI.SUM) + + # Clean velocities of center of mass momentum + if remove_center_of_mass_momentum and group_n_particles > 1: + com_velocity = comm.allreduce(np.sum(velocity[ind], axis=0)) + velocity_clean = velocity[ind] - com_velocity / group_n_particles + K = comm.allreduce(0.5 * config.mass * np.sum(velocity_clean[...] ** 2)) + else: + K = comm.allreduce(0.5 * config.mass * np.sum(velocity[...] ** 2)) + K_target = ( + 1.5 * config.gas_constant * group_n_particles * config.target_temperature + ) + N_f = 3 * group_n_particles + c = np.exp(-(config.time_step * config.respa_inner) / config.tau) + + # Random numbers are identical across ranks because all ranks have + # the same prng after the initialization of the velocities + R = random_gaussian(prng) + SNf = random_chi_squared(prng, N_f - 1) + + alpha2 = ( + c + + (1 - c) * (SNf + R**2) * K_target / (N_f * K) + + 2 * R * np.sqrt(c * (1 - c) * K_target / (N_f * K)) + ) + dK = K * (alpha2 - 1) + alpha = np.sqrt(alpha2) + + if remove_center_of_mass_momentum and group_n_particles > 1: + # Assign velocities and reapply the previously removed center + # of mass momentum removed + velocity_clean *= alpha + velocity[ind] = velocity_clean + com_velocity / group_n_particles + else: + velocity *= alpha + config.thermostat_work += dK
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/_modules/index.html b/v2.1.0/_modules/index.html new file mode 100644 index 00000000..0708d573 --- /dev/null +++ b/v2.1.0/_modules/index.html @@ -0,0 +1,305 @@ + + + + + + Overview: module code — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/v2.1.0/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css new file mode 100644 index 00000000..1b057df2 --- /dev/null +++ b/v2.1.0/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css @@ -0,0 +1 @@ +.badge{border-radius:.25rem;display:inline-block;font-size:75%;font-weight:700;line-height:1;padding:.25em .4em;text-align:center;vertical-align:baseline;white-space:nowrap}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{border-radius:10rem;padding-left:.6em;padding-right:.6em}.badge-primary{background-color:#007bff;color:#fff}.badge-primary[href]:focus,.badge-primary[href]:hover{background-color:#0062cc;color:#fff;text-decoration:none}.badge-secondary{background-color:#6c757d;color:#fff}.badge-secondary[href]:focus,.badge-secondary[href]:hover{background-color:#545b62;color:#fff;text-decoration:none}.badge-success{background-color:#28a745;color:#fff}.badge-success[href]:focus,.badge-success[href]:hover{background-color:#1e7e34;color:#fff;text-decoration:none}.badge-info{background-color:#17a2b8;color:#fff}.badge-info[href]:focus,.badge-info[href]:hover{background-color:#117a8b;color:#fff;text-decoration:none}.badge-warning{background-color:#ffc107;color:#212529}.badge-warning[href]:focus,.badge-warning[href]:hover{background-color:#d39e00;color:#212529;text-decoration:none}.badge-danger{background-color:#dc3545;color:#fff}.badge-danger[href]:focus,.badge-danger[href]:hover{background-color:#bd2130;color:#fff;text-decoration:none}.badge-light{background-color:#f8f9fa;color:#212529}.badge-light[href]:focus,.badge-light[href]:hover{background-color:#dae0e5;color:#212529;text-decoration:none}.badge-dark{background-color:#343a40;color:#fff}.badge-dark[href]:focus,.badge-dark[href]:hover{background-color:#1d2124;color:#fff;text-decoration:none}.border-0{border:0 !important}.border-top-0{border-top:0 !important}.border-right-0{border-right:0 !important}.border-bottom-0{border-bottom:0 !important}.border-left-0{border-left:0 !important}.p-0{padding:0 !important}.pt-0,.py-0{padding-top:0 !important}.pr-0,.px-0{padding-right:0 !important}.pb-0,.py-0{padding-bottom:0 !important}.pl-0,.px-0{padding-left:0 !important}.p-1{padding:.25rem !important}.pt-1,.py-1{padding-top:.25rem !important}.pr-1,.px-1{padding-right:.25rem !important}.pb-1,.py-1{padding-bottom:.25rem !important}.pl-1,.px-1{padding-left:.25rem !important}.p-2{padding:.5rem !important}.pt-2,.py-2{padding-top:.5rem !important}.pr-2,.px-2{padding-right:.5rem !important}.pb-2,.py-2{padding-bottom:.5rem !important}.pl-2,.px-2{padding-left:.5rem !important}.p-3{padding:1rem !important}.pt-3,.py-3{padding-top:1rem !important}.pr-3,.px-3{padding-right:1rem !important}.pb-3,.py-3{padding-bottom:1rem !important}.pl-3,.px-3{padding-left:1rem !important}.p-4{padding:1.5rem !important}.pt-4,.py-4{padding-top:1.5rem !important}.pr-4,.px-4{padding-right:1.5rem !important}.pb-4,.py-4{padding-bottom:1.5rem !important}.pl-4,.px-4{padding-left:1.5rem !important}.p-5{padding:3rem !important}.pt-5,.py-5{padding-top:3rem !important}.pr-5,.px-5{padding-right:3rem !important}.pb-5,.py-5{padding-bottom:3rem !important}.pl-5,.px-5{padding-left:3rem !important}.m-0{margin:0 !important}.mt-0,.my-0{margin-top:0 !important}.mr-0,.mx-0{margin-right:0 !important}.mb-0,.my-0{margin-bottom:0 !important}.ml-0,.mx-0{margin-left:0 !important}.m-1{margin:.25rem !important}.mt-1,.my-1{margin-top:.25rem !important}.mr-1,.mx-1{margin-right:.25rem !important}.mb-1,.my-1{margin-bottom:.25rem !important}.ml-1,.mx-1{margin-left:.25rem !important}.m-2{margin:.5rem !important}.mt-2,.my-2{margin-top:.5rem !important}.mr-2,.mx-2{margin-right:.5rem !important}.mb-2,.my-2{margin-bottom:.5rem !important}.ml-2,.mx-2{margin-left:.5rem !important}.m-3{margin:1rem !important}.mt-3,.my-3{margin-top:1rem !important}.mr-3,.mx-3{margin-right:1rem !important}.mb-3,.my-3{margin-bottom:1rem !important}.ml-3,.mx-3{margin-left:1rem !important}.m-4{margin:1.5rem !important}.mt-4,.my-4{margin-top:1.5rem !important}.mr-4,.mx-4{margin-right:1.5rem !important}.mb-4,.my-4{margin-bottom:1.5rem !important}.ml-4,.mx-4{margin-left:1.5rem !important}.m-5{margin:3rem !important}.mt-5,.my-5{margin-top:3rem !important}.mr-5,.mx-5{margin-right:3rem !important}.mb-5,.my-5{margin-bottom:3rem !important}.ml-5,.mx-5{margin-left:3rem !important}.btn{background-color:transparent;border:1px solid transparent;border-radius:.25rem;color:#212529;cursor:pointer;display:inline-block;font-size:1rem;font-weight:400;line-height:1.5;padding:.375rem .75rem;text-align:center;transition:color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none;vertical-align:middle}.btn:hover{color:#212529;text-decoration:none}.btn:visited{color:#212529}.btn.focus,.btn:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.25);outline:0}.btn.disabled,.btn:disabled{opacity:.65}@media (prefers-reduced-motion: reduce){.btn{transition:none}}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary:visited{color:#fff}.btn-primary:hover{background-color:#0069d9;border-color:#0062cc;color:#fff}.btn-primary.focus,.btn-primary:focus{background-color:#0069d9;border-color:#0062cc;box-shadow:0 0 0 .2rem rgba(0,123,255,0.5);color:#fff}.btn-primary.disabled,.btn-primary:disabled{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary.active:not(:disabled):not(.disabled),.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{background-color:#0062cc;border-color:#005cbf;color:#fff}.btn-primary.active:not(:disabled):not(.disabled):focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-secondary{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary:visited{color:#fff}.btn-secondary:hover{background-color:#5a6268;border-color:#545b62;color:#fff}.btn-secondary.focus,.btn-secondary:focus{background-color:#5a6268;border-color:#545b62;box-shadow:0 0 0 .2rem rgba(108,117,125,0.5);color:#fff}.btn-secondary.disabled,.btn-secondary:disabled{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled),.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{background-color:#545b62;border-color:#4e555b;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled):focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-success{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success:visited{color:#fff}.btn-success:hover{background-color:#218838;border-color:#1e7e34;color:#fff}.btn-success.focus,.btn-success:focus{background-color:#218838;border-color:#1e7e34;box-shadow:0 0 0 .2rem rgba(40,167,69,0.5);color:#fff}.btn-success.disabled,.btn-success:disabled{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success.active:not(:disabled):not(.disabled),.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{background-color:#1e7e34;border-color:#1c7430;color:#fff}.btn-success.active:not(:disabled):not(.disabled):focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-info{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info:visited{color:#fff}.btn-info:hover{background-color:#138496;border-color:#117a8b;color:#fff}.btn-info.focus,.btn-info:focus{background-color:#138496;border-color:#117a8b;box-shadow:0 0 0 .2rem rgba(23,162,184,0.5);color:#fff}.btn-info.disabled,.btn-info:disabled{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info.active:not(:disabled):not(.disabled),.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{background-color:#117a8b;border-color:#10707f;color:#fff}.btn-info.active:not(:disabled):not(.disabled):focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-warning{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning:visited{color:#212529}.btn-warning:hover{background-color:#e0a800;border-color:#d39e00;color:#212529}.btn-warning.focus,.btn-warning:focus{background-color:#e0a800;border-color:#d39e00;box-shadow:0 0 0 .2rem rgba(255,193,7,0.5);color:#212529}.btn-warning.disabled,.btn-warning:disabled{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning.active:not(:disabled):not(.disabled),.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{background-color:#d39e00;border-color:#c69500;color:#212529}.btn-warning.active:not(:disabled):not(.disabled):focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-danger{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger:visited{color:#fff}.btn-danger:hover{background-color:#c82333;border-color:#bd2130;color:#fff}.btn-danger.focus,.btn-danger:focus{background-color:#c82333;border-color:#bd2130;box-shadow:0 0 0 .2rem rgba(220,53,69,0.5);color:#fff}.btn-danger.disabled,.btn-danger:disabled{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger.active:not(:disabled):not(.disabled),.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{background-color:#bd2130;border-color:#b21f2d;color:#fff}.btn-danger.active:not(:disabled):not(.disabled):focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-light{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light:visited{color:#212529}.btn-light:hover{background-color:#e2e6ea;border-color:#dae0e5;color:#212529}.btn-light.focus,.btn-light:focus{background-color:#e2e6ea;border-color:#dae0e5;box-shadow:0 0 0 .2rem rgba(248,249,250,0.5);color:#212529}.btn-light.disabled,.btn-light:disabled{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light.active:not(:disabled):not(.disabled),.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{background-color:#dae0e5;border-color:#d3d9df;color:#212529}.btn-light.active:not(:disabled):not(.disabled):focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-dark{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark:visited{color:#fff}.btn-dark:hover{background-color:#23272b;border-color:#1d2124;color:#fff}.btn-dark.focus,.btn-dark:focus{background-color:#23272b;border-color:#1d2124;box-shadow:0 0 0 .2rem rgba(52,58,64,0.5);color:#fff}.btn-dark.disabled,.btn-dark:disabled{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark.active:not(:disabled):not(.disabled),.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{background-color:#1d2124;border-color:#171a1d;color:#fff}.btn-dark.active:not(:disabled):not(.disabled):focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-primary{border-color:#007bff;color:#007bff}.btn-outline-primary:visited{color:#007bff}.btn-outline-primary:hover{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{background-color:transparent;color:#007bff}.btn-outline-primary.active:not(:disabled):not(.disabled),.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.active:not(:disabled):not(.disabled):focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-secondary{border-color:#6c757d;color:#6c757d}.btn-outline-secondary:visited{color:#6c757d}.btn-outline-secondary:hover{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{background-color:transparent;color:#6c757d}.btn-outline-secondary.active:not(:disabled):not(.disabled),.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.active:not(:disabled):not(.disabled):focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-success{border-color:#28a745;color:#28a745}.btn-outline-success:visited{color:#28a745}.btn-outline-success:hover{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{background-color:transparent;color:#28a745}.btn-outline-success.active:not(:disabled):not(.disabled),.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.active:not(:disabled):not(.disabled):focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-info{border-color:#17a2b8;color:#17a2b8}.btn-outline-info:visited{color:#17a2b8}.btn-outline-info:hover{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{background-color:transparent;color:#17a2b8}.btn-outline-info.active:not(:disabled):not(.disabled),.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.active:not(:disabled):not(.disabled):focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-warning{border-color:#ffc107;color:#ffc107}.btn-outline-warning:visited{color:#ffc107}.btn-outline-warning:hover{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{background-color:transparent;color:#ffc107}.btn-outline-warning.active:not(:disabled):not(.disabled),.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.active:not(:disabled):not(.disabled):focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-danger{border-color:#dc3545;color:#dc3545}.btn-outline-danger:visited{color:#dc3545}.btn-outline-danger:hover{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{background-color:transparent;color:#dc3545}.btn-outline-danger.active:not(:disabled):not(.disabled),.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.active:not(:disabled):not(.disabled):focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-light{border-color:#f8f9fa;color:#f8f9fa}.btn-outline-light:visited{color:#f8f9fa}.btn-outline-light:hover{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{background-color:transparent;color:#f8f9fa}.btn-outline-light.active:not(:disabled):not(.disabled),.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.active:not(:disabled):not(.disabled):focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-dark{border-color:#343a40;color:#343a40}.btn-outline-dark:visited{color:#343a40}.btn-outline-dark:hover{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{background-color:transparent;color:#343a40}.btn-outline-dark.active:not(:disabled):not(.disabled),.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.active:not(:disabled):not(.disabled):focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-link{color:#007bff;font-weight:400;text-decoration:none}.btn-link:hover{color:#0056b3;text-decoration:underline}.btn-link.focus,.btn-link:focus{box-shadow:none;text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{border-radius:.3rem;font-size:1.25rem;line-height:1.5;padding:.5rem 1rem}.btn-group-sm>.btn,.btn-sm{border-radius:.2rem;font-size:.875rem;line-height:1.5;padding:.25rem .5rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input.btn-block[type=button],input.btn-block[type=reset],input.btn-block[type=submit]{width:100%}.stretched-link::after{background-color:rgba(0,0,0,0);bottom:0;content:'';left:0;pointer-events:auto;position:absolute;right:0;top:0;z-index:1}.text-wrap{white-space:normal !important}.card{background-clip:border-box;background-color:#fff;border:1px solid rgba(0,0,0,0.125);border-radius:.25rem;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;min-width:0;position:relative;word-wrap:break-word}.card>hr{margin-left:0;margin-right:0}.card>.list-group:first-child .list-group-item:first-child{border-top-left-radius:.25rem;border-top-right-radius:.25rem}.card>.list-group:last-child .list-group-item:last-child{border-bottom-left-radius:.25rem;border-bottom-right-radius:.25rem}.card-body{-ms-flex:1 1 auto;flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-bottom:0;margin-top:-.375rem}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{background-color:rgba(0,0,0,0.03);border-bottom:1px solid rgba(0,0,0,0.125);margin-bottom:0;padding:.75rem 1.25rem}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-header+.list-group .list-group-item:first-child{border-top:0}.card-footer{background-color:rgba(0,0,0,0.03);border-top:1px solid rgba(0,0,0,0.125);padding:.75rem 1.25rem}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{border-bottom:0;margin-bottom:-.75rem;margin-left:-.625rem;margin-right:-.625rem}.card-header-pills{margin-left:-.625rem;margin-right:-.625rem}.card-img-overlay{bottom:0;left:0;padding:1.25rem;position:absolute;right:0;top:0}.card-img,.card-img-bottom,.card-img-top{-ms-flex-negative:0;flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-left-radius:calc(.25rem - 1px);border-bottom-right-radius:calc(.25rem - 1px)}.w-100{width:100% !important}.shadow{box-shadow:0 0.5rem 1rem rgba(0,0,0,0.15) !important}.bg-primary{background-color:#007bff !important}button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc !important}a.bg-primary:focus,a.bg-primary:hover{background-color:#0062cc !important}a.text-primary:focus,a.text-primary:hover{color:#121416 !important}.bg-secondary{background-color:#6c757d !important}button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62 !important}a.bg-secondary:focus,a.bg-secondary:hover{background-color:#545b62 !important}a.text-secondary:focus,a.text-secondary:hover{color:#121416 !important}.bg-success{background-color:#28a745 !important}button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34 !important}a.bg-success:focus,a.bg-success:hover{background-color:#1e7e34 !important}a.text-success:focus,a.text-success:hover{color:#121416 !important}.bg-info{background-color:#17a2b8 !important}button.bg-info:focus,button.bg-info:hover{background-color:#117a8b !important}a.bg-info:focus,a.bg-info:hover{background-color:#117a8b !important}a.text-info:focus,a.text-info:hover{color:#121416 !important}.bg-warning{background-color:#ffc107 !important}button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00 !important}a.bg-warning:focus,a.bg-warning:hover{background-color:#d39e00 !important}a.text-warning:focus,a.text-warning:hover{color:#121416 !important}.bg-danger{background-color:#dc3545 !important}button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130 !important}a.bg-danger:focus,a.bg-danger:hover{background-color:#bd2130 !important}a.text-danger:focus,a.text-danger:hover{color:#121416 !important}.bg-light{background-color:#f8f9fa !important}button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5 !important}a.bg-light:focus,a.bg-light:hover{background-color:#dae0e5 !important}a.text-light:focus,a.text-light:hover{color:#121416 !important}.bg-dark{background-color:#343a40 !important}button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124 !important}a.bg-dark:focus,a.bg-dark:hover{background-color:#1d2124 !important}a.text-dark:focus,a.text-dark:hover{color:#121416 !important}.bg-white{background-color:#fff !important}button.bg-white:focus,button.bg-white:hover{background-color:#e6e6e6 !important}a.bg-white:focus,a.bg-white:hover{background-color:#e6e6e6 !important}a.text-white:focus,a.text-white:hover{color:#121416 !important}.text-primary{color:#007bff !important}.text-secondary{color:#6c757d !important}.text-success{color:#28a745 !important}.text-info{color:#17a2b8 !important}.text-warning{color:#ffc107 !important}.text-danger{color:#dc3545 !important}.text-light{color:#f8f9fa !important}.text-dark{color:#343a40 !important}.text-white{color:#fff !important}.text-body{color:#212529 !important}.text-muted{color:#6c757d !important}.text-black-50{color:rgba(0,0,0,0.5) !important}.text-white-50{color:rgba(255,255,255,0.5) !important}.bg-transparent{background-color:transparent !important}.text-justify{text-align:justify !important}.text-left{text-align:left !important}.text-right{text-align:right !important}.text-center{text-align:center !important}.font-weight-light{font-weight:300 !important}.font-weight-lighter{font-weight:lighter !important}.font-weight-normal{font-weight:400 !important}.font-weight-bold{font-weight:700 !important}.font-weight-bolder{font-weight:bolder !important}.font-italic{font-style:italic !important}.container{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container{max-width:540px}}@media (min-width: 768px){.container{max-width:720px}}@media (min-width: 992px){.container{max-width:960px}}@media (min-width: 1200px){.container{max-width:1140px}}.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container,.container-sm{max-width:540px}}@media (min-width: 768px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width: 992px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width: 1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1140px}}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;margin-right:-15px}.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{padding-left:15px;padding-right:15px;position:relative;width:100%}@media (min-width: 576px){.col-sm{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-sm-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-sm-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-sm-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-sm-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-sm-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 768px){.col-md{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-md-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-md-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-md-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-md-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-md-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 992px){.col-lg{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-lg-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-lg-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-lg-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-lg-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-lg-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 1200px){.col-xl{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-xl-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-xl-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-xl-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-xl-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-xl-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}.d-flex{display:-ms-flexbox !important;display:flex !important}.sphinx-bs,.sphinx-bs *{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sphinx-bs p{margin-top:0} diff --git a/v2.1.0/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/v2.1.0/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css new file mode 100644 index 00000000..fc14abc8 --- /dev/null +++ b/v2.1.0/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css @@ -0,0 +1 @@ +details.dropdown .summary-title{padding-right:3em !important;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none}details.dropdown:hover{cursor:pointer}details.dropdown .summary-content{cursor:default}details.dropdown summary{list-style:none;padding:1em}details.dropdown summary .octicon.no-title{vertical-align:middle}details.dropdown[open] summary .octicon.no-title{visibility:hidden}details.dropdown summary::-webkit-details-marker{display:none}details.dropdown summary:focus{outline:none}details.dropdown summary:hover .summary-up svg,details.dropdown summary:hover .summary-down svg{opacity:1}details.dropdown .summary-up svg,details.dropdown .summary-down svg{display:block;opacity:.6}details.dropdown .summary-up,details.dropdown .summary-down{pointer-events:none;position:absolute;right:1em;top:.75em}details.dropdown[open] .summary-down{visibility:hidden}details.dropdown:not([open]) .summary-up{visibility:hidden}details.dropdown.fade-in[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out;animation:panels-fade-in .5s ease-in-out}details.dropdown.fade-in-slide-down[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out}@keyframes panels-fade-in{0%{opacity:0}100%{opacity:1}}@keyframes panels-slide-down{0%{transform:translate(0, -10px)}100%{transform:translate(0, 0)}}.octicon{display:inline-block;fill:currentColor;vertical-align:text-top}.tabbed-content{box-shadow:0 -.0625rem var(--tabs-color-overline),0 .0625rem var(--tabs-color-underline);display:none;order:99;padding-bottom:.75rem;padding-top:.75rem;width:100%}.tabbed-content>:first-child{margin-top:0 !important}.tabbed-content>:last-child{margin-bottom:0 !important}.tabbed-content>.tabbed-set{margin:0}.tabbed-set{border-radius:.125rem;display:flex;flex-wrap:wrap;margin:1em 0;position:relative}.tabbed-set>input{opacity:0;position:absolute}.tabbed-set>input:checked+label{border-color:var(--tabs-color-label-active);color:var(--tabs-color-label-active)}.tabbed-set>input:checked+label+.tabbed-content{display:block}.tabbed-set>input:focus+label{outline-style:auto}.tabbed-set>input:not(.focus-visible)+label{outline:none;-webkit-tap-highlight-color:transparent}.tabbed-set>label{border-bottom:.125rem solid transparent;color:var(--tabs-color-label-inactive);cursor:pointer;font-size:var(--tabs-size-label);font-weight:700;padding:1em 1.25em .5em;transition:color 250ms;width:auto;z-index:1}html .tabbed-set>label:hover{color:var(--tabs-color-label-active)} diff --git a/v2.1.0/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css b/v2.1.0/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css new file mode 100644 index 00000000..adc61662 --- /dev/null +++ b/v2.1.0/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css @@ -0,0 +1,7 @@ +:root { +--tabs-color-label-active: hsla(231, 99%, 66%, 1); +--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); +--tabs-color-overline: rgb(207, 236, 238); +--tabs-color-underline: rgb(207, 236, 238); +--tabs-size-label: 1rem; +} \ No newline at end of file diff --git a/v2.1.0/_sources/doc_pages/api.rst.txt b/v2.1.0/_sources/doc_pages/api.rst.txt new file mode 100644 index 00000000..6761cfc0 --- /dev/null +++ b/v2.1.0/_sources/doc_pages/api.rst.txt @@ -0,0 +1,122 @@ +.. _api-label: + + +API reference +============= + +Integrator +---------- + +.. automodule:: hymd.integrator + :members: + + +Thermostat +---------- + +.. automodule:: hymd.thermostat + :members: csvr_thermostat, _random_chi_squared, _random_gaussian + :undoc-members: + + +Barostat +-------- + +Berendsen Barostat +^^^^^^^^^^^^^^^^^^ + +.. automodule:: hymd.barostat + :members: isotropic, semiisotropic + :undoc-members: + +SCR Barostat +^^^^^^^^^^^^^^^^^^ + +.. automodule:: hymd.barostat_bussi + :members: isotropic, semiisotropic + :undoc-members: + + +Hamiltonian +----------- + +.. autoclass:: hymd.hamiltonian.Hamiltonian + :members: + + .. automethod:: __init__ + + .. automethod:: _setup + +.. autoclass:: hymd.hamiltonian.SquaredPhi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultNoChi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultWithChi + :members: + + .. automethod:: __init__ + + +Force +----- + +.. automodule:: hymd.force + :members: + :undoc-members: + + +Pressure +-------- + +.. automodule:: hymd.pressure + :members: comp_pressure + :undoc-members: + + +Logger +------ + +.. autoclass:: hymd.logger.Logger + :members: + +.. autoclass:: hymd.logger.MPIFilterRoot + :members: + +.. autoclass:: hymd.logger.MPIFilterAll + :members: + + +Input parser +------------ + +.. automodule:: hymd.input_parser + :members: + :undoc-members: propensity_potential_coeffs + + +Field +----- + +.. automodule:: hymd.field + :members: + + +File input/output +----------------- + +.. automodule:: hymd.file_io + :members: + +PLUMED +------ + +.. automodule:: hymd.plumed + :members: diff --git a/v2.1.0/_sources/doc_pages/benchmarks.rst.txt b/v2.1.0/_sources/doc_pages/benchmarks.rst.txt new file mode 100644 index 00000000..06377a85 --- /dev/null +++ b/v2.1.0/_sources/doc_pages/benchmarks.rst.txt @@ -0,0 +1,93 @@ +.. _benchmarks-label: + +Benchmarks +########## +Homopolymer melt test systems of :math:`30^2`, :math:`40^2`, and :math:`50^2` +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively. + +Bonded forces +^^^^^^^^^^^^^ +Legend label denotes the number of particles in the system. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) + time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 + ], dtype=np.float64) + nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 + ], dtype=np.float64,) + time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, + ], dtype=np.float64) + nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 + ], dtype=np.float64) + time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, + ], dtype=np.float64) + plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" + ) + plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" + ) + plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" + ) + plt.xlabel("CPUs", fontsize=15) + plt.ylabel("Time per step, us", fontsize=15) + plt.legend(fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.show() + + +Particle--field forces +^^^^^^^^^^^^^^^^^^^^^^ +Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + + mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] + mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + + mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + + mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + + mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] + mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + + mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + + mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + + plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") + plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") + plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") + plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") + plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") + plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") + plt.xlabel("CPUs", fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.ylabel("Time per step, s", fontsize=15) + plt.legend(loc="upper left", fontsize=15) + plt.show() diff --git a/v2.1.0/_sources/doc_pages/command_line.rst.txt b/v2.1.0/_sources/doc_pages/command_line.rst.txt new file mode 100644 index 00000000..f0fb00bd --- /dev/null +++ b/v2.1.0/_sources/doc_pages/command_line.rst.txt @@ -0,0 +1,130 @@ +.. _commandline-label: + +Command line arguments +###################### +Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle--field interactions. + + +Required arguments +================== +:configuration file: + :code:`type` positional + + Specifies the :code:`.toml` format configuration file containing simulation details. See :ref:`config-label` for details. + +:structure and topology file: + :code:`type` positional + + Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See :ref:`topology-label` for details. + +Optional arguments +================== +:code:`-v --verbose` + :code:`type` optional + + Number of following arguments: :code:`0` or :code:`1` + + Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying :code:`-v` or :code:`--verbose` with no additional specification. This increases verbosity level by :code:`1`. Alternatively, it maye be specified by :code:`--verbose V` with :code:`V` being :code:`0`, :code:`1`, or :code:`2`. + +:code:`--profile` + :code:`type` optional + + Number of following arguments: :code:`0` + + Enables code profiling using :code:`cProfile`. This will output one profiling file per MPI rank invoked in the simulation. + +:code:`--double-precision` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision internally in HyMD (including in the FFTs). + +:code:`--double-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision in the output trajectory from HyMD. + +:code:`--velocity-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that velocities should be output to the HyMD trajectory. + +:code:`--force-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that forces should be output to the HyMD trajectory. + +:code:`--disable-mpio` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult. + +:code:`--logfile` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the path of a plain text log file in which stdout is mirrored during simulation runs. + +:code:`--seed` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the random seed used in the :code:`numpy` random library to generate velocities, thermostatting, etc. + +:code:`--disable-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any two-particle bonds present in the system. + +:code:`--disable-angle-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any three-particle bonds present in the system. + +:code:`--disable-dihedrals` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any four-particle bonds present in the system. + +:code:`--disable-dipole` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any topological reconstruction of peptide backbone dipoles present in the system. + +:code:`--disable-field` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any particle--field interactions present in the system. + +:code:`--plumed` + :code:`type` optional + + Input file for PLUMED when using the PLUMED interface. See :ref:`interfaces-label` for details. + +:code:`--plumed-outfile + :code:`type` optional + + Name of PLUMED output file when running a simulation using PLUMED. diff --git a/v2.1.0/_sources/doc_pages/config_file.rst.txt b/v2.1.0/_sources/doc_pages/config_file.rst.txt new file mode 100644 index 00000000..2ee880b7 --- /dev/null +++ b/v2.1.0/_sources/doc_pages/config_file.rst.txt @@ -0,0 +1,244 @@ +.. _config-label: + +Configuration file +################## +The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order. + +The configuration file is a `toml`_ format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs. + +.. _`toml`: + https://github.com/toml-lang/toml + +.. role:: required + +Configuration file keywords +--------------------------- + +The following constitutes every possible keyword specification in HyMD +configuration files: + +Metadata keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying metadata for the H5MD output trajectory. + +:name: + :code:`string` [**optional**, default: :code:`None`] + + Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file. + + +:tags: + :code:`array` [:code:`string`] [**optional**, default: :code:`None`] + + Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file. + + +Particle keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying properties of particles and molecules in the +system. + +:n_particles: + :code:`integer` [**optional**, default: :code:`None`] + + Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules. + +:mass: + :code:`float` [**optional**, default: :code:`72.0`] {units: :math:`\text{u}=\text{g}\,\text{mol}^{-1}`} + + Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal. + +:max_molecule_size: + :code:`integer` [**optional**, default: :code:`201`] + + Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code **will** crash if there are molecules larger than :code:`max_molecule_size` in the topology/structure input file. + + +Simulation keywords +^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying simulation parameters. + +:n_steps: + :code:`integer` [:required:`required`] + + Total number of integration steps to perform for this simulation. + +:n_print: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of *number of time steps*). + +:n_flush: + :code:`integer` [**optional**, default: :code:`None`] + + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of *number of* :code:`n_print`, i.e. :code:`n_print = 13`, :code:`n_flush = 3` would result in the trajectory/energy being written to disk every :code:`13 x 3 = 39` *simulation steps*) + +:time_step: + :code:`float` [:required:`required`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time step per integration step. If the rRESPA multiple time step integrator is used (:code:`integrator = "respa"`), this specifies the **inner** time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is :code:`respa_inner` times the :code:`time_step` , and the total simulation time is :code:`n_steps` times :code:`time_step` times :code:`respa_inner` . + +:box_size: + :code:`array` [:code:`float`] [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable. + +:integrator: + :code:`string` [:required:`required`] (options: :code:`velocity-verlet` or :code:`respa`) + + Specifies the time integrator used in the simulation. If :code:`respa`, the *reversible reference system propagator algorithm (rRESPA)* :cite:`tuckerman1992reversible` integrator is used, with :code:`respa_inner` number of inner (intramolecular force) time steps. If :code:`velocity-verlet`, a normal Velocity Verlet integrator is used. If :code:`respa` and :code:`respa_inner = 1`, the rRESPA integrator is equivalent to the Velocity Verlet. + +:respa_inner: + :code:`integer` [**optional**, default: :code:`1`] + + The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces. + +:domain_decomposition: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Specifies the interval (in time steps) of *domain decomposition exchange*, involving all MPI ranks sending and receiving particles according to the particles' positions in the integration box and the MPI ranks' assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If :code:`True`, the decomposition is performed once (before starting the simulation). If :code:`False`, no decomposition is performed. + +:cancel_com_momentum: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + If :code:`True`, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every :code:`remove_com_momentum` time steps. If :code:`False`, the linear momentum is never removed. + +:start_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at :code:`start_temperature` Kelvin prior to starting the simulation. If :code:`False`, the velocities are not changed before starting the simulation. + +:target_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Couple the system to a heat bath at :code:`target_temperature` Kelvin by applying a *Canonical sampling through velocity rescaling* :cite:`Bussi2007JCP` thermostat with coupling strength :code:`tau`. If :code:`False`, no temperature control is applied. + +:tau: + :code:`float` [**optional**, default: :code:`0.7`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the CSVR thermostat coupling. In the limit of :code:`tau → ∞`, the Hamiltonian dynamics are preserved and no temperature coupling takes place. + +:thermostat_coupling_groups: + :code:`array` [:code:`array` [:code:`string`]] [**optional**, default: :code:`[]`] + + Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and :code:`"C"` type particles, :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would thermalise types :code:`"A"` and :code:`"B"` together and couple :code:`"C"` type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. :code:`target_temperature` Kelvin). +:hamiltonian: + :code:`string` [**optional**, default: :code:`"DefaultNohChi"`] (options: :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`) + + Specifies the interaction energy functional :math:`W[\tilde\phi]` for use with the particle-field interactions. See :ref:`functionals-label` for details. + + +Field keywords +^^^^^^^^^^^^^^ +Configuration keywords specifying field parameters. + +:mesh_size: + :code:`array` [:code:`integer`] or :code:`integer` [:required:`required`] + + Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is :code:`box_size / mesh_size`. + +:kappa: + :code:`float` [:required:`required`] {units: :math:`\text{kJ}^{-1}\text{mol}`} + + Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional :math:`W[\tilde\phi]`. See :ref:`functionals-label` for more details. + +:sigma: + :code:`float` [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See :ref:`filtering-label` for more details. + +:chi: + :code:`array` [:code:`array` [:code:`string`, :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}`} + + Array of :math:`\tilde\chi_\text{AB}`-parameters indicating the strength of the repulsive or attractive interaction between particles of type :code:`"A"` and the number density due to particles of type :code:`"B"`, and vice versa. Example: :code:`chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ]` would specify a repulsive :code:`"A"`--:code:`"B"` type interaction, and a weakly attractive :code:`"C"`--:code:`"D"` interaction. Self-interaction :math:`\tilde\chi`-terms are always zero. See :ref:`functionals-label` for more details. + + +Bond keywords +^^^^^^^^^^^^^ +Configuration keywords specifying bonds and bonds parameters. + +:bonds: + :code:`array` [:code:`array` [2 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{nm}=10^{-9}~\text{m}` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: :code:`bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ]` indicates a :code:`"A"`--:code:`"A"` bond of equilibrium length :code:`0.47` :math:`\text{nm}` with a bond strength of :code:`980.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding bond between :code:`"A"` and :code:`"B"` type particles with equilibrium length :code:`0.31` :math:`\text{nm}` and a strength of :code:`1250.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify stretching bonds. + +:angle_bonds: + :code:`array` [:code:`array` [3 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`{}^\circ` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: :code:`bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ]` indicates a :code:`"A"`--:code:`"A"`--:code:`"A"` angular bond that tries to keep the bond linear at :code:`180` degrees with a bending strength of :code:`55.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding angle bond between :code:`"A"`--:code:`"B"`--:code:`"B"` prefering the angle at :code:`120` degrees and a strength of :code:`25.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify angular bonds. + +:dihedrals: + :code:`array` [:code:`array` [4 :code:`string`, :code:`integer`, :code:`COSINE SERIES` ]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`} + + Specifies four-particle torsional potentials by cosine series. See :ref:`bonds-label` for details about how to specify dihedrals. + + + +Electrostatic keywords +^^^^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying electrostatics and electrostatic parameters. + +:coulombtype: + :code:`string` [**optional**, default: :code:`None`] (options: :code:`PIC_Spectral`) + + Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the :code:`dielectric_const` keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, *not* in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to `PIC_Spectral`. + +:dielectric_const: + :code:`float` [**optional**, default: :code:`None`] + + Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified---even if electrostatics are not included with the :code:`coulombtype` keyword. + +Pressure keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying pressure and barostat parameters. + +Simulation keywords +========================================= + +:pressure: + :code:`boolean` [**optional**, default: :code:`False`] + + Specifies whether or not to calculate total internal pressure vector. + +:barostat: + :code:`string` [**optional**, default: :code:`None`](options: :code:`isotropic` or :code:`semiisotropic`) + + Specifies whether to apply pressure constraints equally in all 3 Cartesian directions (`isotropic`) or equally in xy and different in z (`semiisotropic`). + +:barostat_type: + :code:`string` [**optional**, default: :code:`berendsen`](options: :code:`berendsen` or :code:`scr`) + + Specifies the type of barostat to use. :code:`berendsen` is more suitable for equilibration and :code:`scr` for equilibrium data collection. + +:n_b: + :code:`integer` [**optional**, default: :code:`1`] + + Frequency of barostat call in number of outer rRESPA steps. + +:tau_p: + :code:`float` [**optional**, default: :code:`10 tau` if :code:`tau < 0.1` else :code:`1.0`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the barostat coupling. + +:target_pressure: + :code:`array` [:code:`float`] [**optional**, default: :code:1] {units: `bar`} + + Couples the system to an external pressure set to `target_pressure`. + +Field keywords +========================================= + +:rho0: + :code:`float` [**optional**, default: :code:average density] {units: :math:`\text{nm}^{-3}`} + + Intrinsic parameter corresponding to the specific volume of a coarse-grained particle. Typically: `8.66` + +:a: + :code:`float` [:required:`required`] {units: :math:`\text{nm}^{-3}`} + + Calibrated parameter to obtain the correct average density at the target temperature and pressure. Typically: `9.21` diff --git a/v2.1.0/_sources/doc_pages/constants_and_units.rst.txt b/v2.1.0/_sources/doc_pages/constants_and_units.rst.txt new file mode 100644 index 00000000..ee429829 --- /dev/null +++ b/v2.1.0/_sources/doc_pages/constants_and_units.rst.txt @@ -0,0 +1,80 @@ +.. _units-label: + +Constants and Units +################### + +HyMD uses the following units and constants internally and in all input and +output: + +.. list-table:: **Units** + :widths: 30 10 75 + :header-rows: 1 + + * - Quantity + - Symbol + - Unit + * - length + - :math:`r` + - :math:`\text{nm}=10^{-9}~\text{m}` + * - time + - :math:`t` + - :math:`\text{ps}=10^{-12}~\text{s}` + * - charge + - :math:`q` + - :math:`e=1.602176634 \cdot 10^{-19}~\text{C}` + * - mass + - :math:`m` + - :math:`\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}` + * - temperature + - :math:`\text{T}` + - :math:`\text{K}` + * - energy + - :math:`E` + - :math:`\text{kJ}\,\text{mol}^{-1}` + * - velocity + - :math:`v` + - :math:`\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}` + * - momentum + - :math:`P` + - :math:`\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}` + * - force + - :math:`\mathbf{F}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}` + * - pressure + - :math:`p` + - :math:`\text{bar}=100~\text{kPa}` + * - electric potential + - :math:`\Psi` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}` + * - electric field + - :math:`\mathbf{E}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}` + * - compressibility + - :math:`\kappa` + - :math:`\text{mol}\,\text{kJ}^{-1}` + * - field-interaction + - :math:`\tilde\chi` + - :math:`\text{kJ}\,\text{mol}^{-1}` + +.. list-table:: **Constants** + :widths: 30 10 75 + :header-rows: 1 + + * - Constant + - Symbol + - Value + * - gas constant + - :math:`R` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Boltzmann’s constant + - :math:`k_\text{B}` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Avogadro's constant + - :math:`N_\text{A}` + - :math:`6.02214076 \cdot 10^23~\text{mol}^{-1}` + * - Vacuum permittivity + - :math:`\varepsilon_0` + - :math:`8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2` + * - Coulomb constant + - :math:`k_\text{e}` + - :math:`138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}` diff --git a/v2.1.0/_sources/doc_pages/electrostatics.rst.txt b/v2.1.0/_sources/doc_pages/electrostatics.rst.txt new file mode 100644 index 00000000..7e11c09d --- /dev/null +++ b/v2.1.0/_sources/doc_pages/electrostatics.rst.txt @@ -0,0 +1,48 @@ +.. _electrostatics-label: + +Electrostatic interactions +########################## +In the filtered Hamiltonian hPF formalism :cite:`bore2020hamiltonian` the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle--mesh Ewald. + +The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered + +.. math:: + + \tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i), + +with :math:`q_i` being the charge of particle :math:`i` and :math:`H` is the +filtering function (see :ref:`filtering-label`). The value of the charge grid at +vertex :math:`(i,j,k)` is found by + +.. math:: + + \tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)] + +and the electrostatic potential :math:`\Psi_{ijk}` + +.. math:: + + \Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right], + +where :math:`k_\text{e}` is the Coulomb constant :math:`1/4\pi\varepsilon_0`. +The *electric field* is obtained by differentiation of the electrostatic +potential in Fourier space, + +.. math:: + + \mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)] + +from which the forces are interpolated back to the particle positions. + +Specifying electrostatics +^^^^^^^^^^^^^^^^^^^^^^^^^ +In HyMD, electrostatics are specified by the :code:`coulombtype` and +:code:`dielectric_const` keywords in the configuration file (see +:ref:`config-label`) and the :code:`/charge` dataset in the HDF5 format +structure/topology input file (see :ref:`topology-label`). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions. diff --git a/v2.1.0/_sources/doc_pages/examples.rst.txt b/v2.1.0/_sources/doc_pages/examples.rst.txt new file mode 100644 index 00000000..9f9c3655 --- /dev/null +++ b/v2.1.0/_sources/doc_pages/examples.rst.txt @@ -0,0 +1,621 @@ +.. _examples-label: + +Examples +######## +The following examples are ordered in *more or less* order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the `HyMD-tutorial`_ github repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Ideal gas +========= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true + :align: right + :width: 200 + +The simplest possible system is one with no interactions at all---intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like: + + +.. code-block:: toml + :caption: **ideal_gas.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = false # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + +A simple input structure/topology file :code:`ideal_gas.HDF5` is available in +the `HyMD-tutorial/ideal_gas`_ github repository (along with the code to +generate it). Run the (very) short simulation by + +.. code:: bash + + python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field \ + --velocity-output \ + --force-output + +with the :code:`--disable-field` argument to completely turn off all +particle--field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook `ideal_gas.ipynb`_ for details. + + +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas +.. _ideal_gas.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.ipynb + + +Ideal chains +============ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true + :align: right + :width: 200 + +The simplest available interaction is the harmonic two-particle bond (see +:ref:`bonds-label`), + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2. + +Extending the configuration file from the ideal gas case, we need to add a +:code:`bonds` specification. Note that the :code:`[bonds]` meta specifier is not +necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **ideal_chain.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + +A simple input structure/topology file :code:`ideal_chain.HDF5` with a few +coiled up ideal chain polymers is available in the +`HyMD-tutorial/ideal_chain`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field + +we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +`ideal_chain.ipynb`_. + + +.. _HyMD-tutorial/ideal_chain: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_chain +.. _ideal_chain.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/ideal_chain.ipynb + + +Stiff rods +========== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true + :align: right + :width: 200 + +Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the :code:`i--j--k` angle :math:`\theta` (see +:ref:`bonds-label`), + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2. + +Extending the configuration file from the ideal chain case, we need to add a +:code:`angle_bonds` specification. Note that the :code:`[bonds]` meta specifier +is not necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **rods.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + + angle_bonds = [ + ["A", "A", "A", 180.0, 100.0], # (i, j, k, equilibrium angle, strength) + ] + + +A simple input structure/topology file :code:`rods.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook `rods.ipynb`_. + + +.. _HyMD-tutorial/rods: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/rods +.. _rods.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.ipynb + + + +Helixes +======= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true + :align: right + :width: 200 + +Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle :math:`\phi` between the +:code:`i--j--k` plane and the :code:`j--k--l` plane (see :ref:`bonds-label`), + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n). + +The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a :code:`dihedrals` keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the :code:`dielectric_const` +keyword even though we are not including electrostatic forces in the current +simulation. Note that the :code:`[bonds]` meta specifier is not necessary, but +may be used to help organise the input file. + +.. code-block:: toml + :caption: **helixes.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + dielectric_const = 15.0 + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.31, 10000.0], # (i name, j name, equilibrium length, strength) + ] + + dihedrals = [ + [ + ["A", "A", "A", "A"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0] + ], + ] + +A simple input structure/topology file :code:`helixes.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook `helixes.ipynb`_. + + +.. _HyMD-tutorial/helixes: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/helixes +.. _helixes.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.ipynb + + +Phase separation +================ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true + :align: right + :width: 200 + +The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types :code:`A` and :code:`B`. Using the Hamiltonian + +.. math:: + + \mathcal{H}=H_0+W + +with :math:`\tilde\chi`--dependent interactions defined by (specified in the +configuration file by :code:`hamiltonian = DefaultWithChi`): + +.. math:: + + W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2. + + +.. code-block:: toml + :caption: **phase_separation.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + + [field] + mesh_size = [20, 20, 20] # FFT grid size + sigma = 1.0 # filtering length scale in nm + kappa = 0.05 # compressibility in mol/kJ + chi = [ + ['A', 'B', 5.0], # (name i, name j, strength) + ] + +A simple input structure/topology file :code:`phase_separation.HDF5` containing +an equal number of :code:`A` type and :code:`B` type particles is available in +the `HyMD-tutorial/phase_separation`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd phase_separation.toml phase_separation.HDF5 + +we may examine the resulting trajectory. In the case of a low interaction +strength :math:`\tilde\chi` of :code:`5.0` (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to :code:`40.0` (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +`phase_separation.ipynb`_. + + +.. _HyMD-tutorial/phase_separation: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/phase_separation +.. _phase_separation.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/phase_separation.ipynb + + +Diblock copolymers +================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true + :align: right + :width: 200 + +Having introduced particle--field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive :math:`\tilde\chi`--interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the :code:`integrator = "respa"` keyword. Putting the pieces together, the +configuration file may look like the following: + +.. code-block:: toml + :caption: **copolymer.toml** + + [simulation] + integrator = "respa" + respa_inner = 15 + n_steps = 2000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [10.0, 10.0, 10.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [50, 50, 50] # FFT grid size + sigma = 0.5 # filtering length scale in nm + chi = [ + ["A", "B", 30.0], # (i, j, strength) + ] + + [bonds] + bonds = [ + ["A", "A", 0.25, 1500.0], # (i, j, equilibrium length, strength) + ["A", "B", 0.25, 1500.0], + ["B", "B", 0.25, 1500.0], + ] + angle_bonds = [ + ["A", "A", "A", 180.0, 25.0], # (i, j, k, equilibrium angle, strength) + ["B", "B", "B", 180.0, 25.0], + ] + +A simple input structure/topology file :code:`copolymer.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/copolymer`_ github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten :code:`A` followed by ten :code:`B` type particles. +Running the simulation with + +.. code:: bash + + python3 -m hymd copolymer.toml copolymer.HDF5 + +the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +`copolymer.ipynb`_. + + +.. _HyMD-tutorial/copolymer: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/copolymer +.. _copolymer.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer.ipynb + + +Lipid bilayer self-assembly +=========================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true + :align: right + :width: 300 + +Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field--particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the :code:`thermostat_coupling_groups` keyword. With parameters +optimised in :cite:`ledum2020automated`, the configuration file looks like: + + +.. code-block:: toml + :caption: **lipid_self_assembly.toml** + + [simulation] + integrator = "respa" + respa_inner = 25 + n_steps = 3000 + n_print = 200 + n_flush = 1 + time_step = 0.01 + box_size = [9.96924, 9.96924, 10.03970] + start_temperature = 323 + target_temperature = 323 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.05 + domain_decomposition = 10001 + cancel_com_momentum = true + max_molecule_size = 15 + thermostat_coupling_groups = [ + ["N", "P", "G", "C"], + ["W"], + ] + + [field] + mesh_size = [25, 25, 25] + sigma = 1.0 + chi = [ + ["C", "W", 42.24], + ["G", "C", 10.47], + ["N", "W", -3.77], + ["G", "W", 4.53], + ["N", "P", -9.34], + ["P", "G", 8.04], + ["N", "G", 1.97], + ["P", "C", 14.72], + ["P", "W", -1.51], + ["N", "C", 13.56], + ] + + [bonds] + bonds = [ + ["N", "P", 0.47, 1250.0], + ["P", "G", 0.47, 1250.0], + ["G", "G", 0.37, 1250.0], + ["G", "C", 0.47, 1250.0], + ["C", "C", 0.47, 1250.0], + ] + angle_bonds = [ + ["P", "G", "G", 120.0, 25.0], + ["P", "G", "C", 180.0, 25.0], + ["G", "C", "C", 180.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +A randomly mixed input structure/topology file +:code:`lipid_self_assembly.HDF5` with a few hundred lipids in a roughy +:code:`10 x 10 x 10nm` box is available in the +`HyMD-tutorial/lipid_self_assembly`_ github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation + +.. code:: bash + + python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5 + +we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook `lipid_self_assembly.ipynb`_. + + +.. _HyMD-tutorial/lipid_self_assembly: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/lipid_self_assembly +.. _lipid_self_assembly.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/lipid_self_assembly.ipynb + + +Peptide in lipid bilayer +======================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true + :align: right + :width: 300 + +Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer. + + +The `configuration file`_ is available in the `HyMD-tutorial/peptide`_ github +repository (omitted here for brevity). + +A pre-equilibrated input structure/topology file :code:`peptide.HDF5` with a +few hundred lipids in a roughy :code:`20 x 20 x 20nm` box is available in the +`HyMD-tutorial/peptide`_ github repository. Running the simulation + +.. code:: bash + + python3 -m hymd peptide.toml peptide.HDF5 + +we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook `peptide.ipynb`_. + + +.. _HyMD-tutorial/peptide: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/peptide +.. _configuration file: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.toml +.. _peptide.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.ipynb + + +SDS +=== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true + :align: right + :width: 300 + +The last part we introduce is explicit electrostatic interactions through +particle--mesh Ewald. Enabling the electrostatic calculations is done via the +:code:`coulombtype` keyword. :code:`"PIC_Spectral"` is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the :code:`dielectric_const` keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge. + + + +.. code-block:: toml + :caption: **sds.toml** + + [simulation] + integrator = "respa" + respa_inner = 10 + n_steps = 3000 + n_print = 1500 + n_flush = + time_step = 0.01 + box_size = [8.3, 8.3, 8.3] + start_temperature = 298 + target_temperature = 298 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.1 + domain_decomposition = 10000 + cancel_com_momentum = true + max_molecule_size = 5 + thermostat_coupling_groups = [ + ["S", "C"], + ["W", "Na"], + ] + dielectric_const = 45.0 # dielectric constant for the simulation medium + coulombtype = "PIC_Spectral" # particle in cloud, spectral method + + [field] + mesh_size = [64, 64, 64] + sigma = 0.5 + chi = [ + ["S", "C", 13.50], + ["S", "Na", 0.00], + ["S", "W", -3.60], + ["C", "Na", 13.50], + ["C", "W", 33.75], + ["W", "Na", 0.00], + ] + + [bonds] + bonds = [ + ["S", "C", 0.50, 1250.0], + ["C", "C", 0.50, 1250.0], + ] + angle_bonds = [ + ["S", "C", "C", 170.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +An input structure/topology file :code:`sds.HDF5` with a couple thousand +randomly dispersed SDS chains is available in the `HyMD-tutorial/sds`_ github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a :code:`/charge` dataset. +Running the simulation with + +.. code:: bash + + python3 -m hymd sds.toml sds.HDF5 + +we observe the aggregation of the SDS into micellular structures---first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook `sds.ipynb`_. + + +.. _HyMD-tutorial/sds: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/sds +.. _sds.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/sds.ipynb diff --git a/v2.1.0/_sources/doc_pages/filtering.rst.txt b/v2.1.0/_sources/doc_pages/filtering.rst.txt new file mode 100644 index 00000000..02af68c6 --- /dev/null +++ b/v2.1.0/_sources/doc_pages/filtering.rst.txt @@ -0,0 +1,30 @@ +.. _filtering-label: + +Filtering +######### +The default grid-independent filter function used in HyMD is a Gaussian + +.. math:: + + H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] + +with reciprocal space representation + +.. math:: + + \hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +The coarse-graining parameter :math:`\sigma` determines a length scale of +particle extent and is given as configuration file input by + +.. code:: toml + + sigma = 0.75 + + +Implementing new filters +^^^^^^^^^^^^^^^^^^^^^^^^ +Implementing new filter functions is straightforward by hijacking +the :code:`setup` method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional. diff --git a/v2.1.0/_sources/doc_pages/installation.rst.txt b/v2.1.0/_sources/doc_pages/installation.rst.txt new file mode 100644 index 00000000..930d5dbc --- /dev/null +++ b/v2.1.0/_sources/doc_pages/installation.rst.txt @@ -0,0 +1,315 @@ +.. _installation-label: + +Installation +############ + +Dependencies +============ + +**Installing non-Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-openmpi-dev # Install MPI-enabled HDF5 + sudo apt-get install -y pkg-config # Install pkg-config, required for h5py install + sudo apt-get install -y curl wget + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + sudo dnf update -y + sudo dnf install -y python3.9 python3-devel # Install python3 and pip + sudo dnf install -y openmpi-devel # Install MPI development headers + sudo dnf install -y hdf5-openmpi-devel # Install MPI-enabled HDF5 + sudo dnf install -y curl wget + + + The automatic download and building of PFFT has some issues, so we + manually build FFTW and PFFT before calling :code:`pip3 install pfft-python`. + + .. code-block:: bash + + sudo dnf install -y git + sudo dnf install -y libtool + sudo dnf install -y fftw-openmpi-devel fftw-openmpi-libs + export PATH=$PATH:/usr/lib64/openmpi/bin/ # Ensure MPICC is in path + git clone https://github.com/mpip/pfft.git + cd pfft/ + ./bootstrap.sh + ./configure + make + make install + + + .. group-tab:: Mac OSX (brew) + + .. code-block:: bash + + brew update + brew install python # Install python3 and pip + brew install open-mpi # Install MPI development headers + brew install hdf5-mpi # Install MPI-enabled HDF5 + brew install pkg-config # Install pkg-config, required for h5py install + brew install curl wget + +.. warning:: + There might be memory leaks when using HyMD with OpenMPI 4.1.1. + Therefore, using a newer version of OpenMPI is recommended. + See `Issue #186 `_ for more details. + + +**Installing Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + python3 -m pip install --upgrade pip + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + python3.9 -m ensurepip --upgrade + PATH=$PATH:/usr/lib64/openmpi/bin/:/usr/lib64/openmpi/lib/ + python3.9 -m pip install mpi4py numpy cython + export HDF5_DIR="/usr/lib64/openmpi/" + CC="mpicc" HDF5_MPI="ON" python3.9 -m pip install --no-binary=h5py h5py + + .. group-tab:: Mac OSX (brew) + + Find the location of the installed :code:`hdf5-mpi` package by + + .. code-block:: bash + + find /usr -iname "*hdf5.h" + + or + + .. code-block:: bash + + brew info hdf5-mpi + + and extract the path, which will look like for example + :code:`/usr/local/Cellar/hdf5-mpi/1.13.0/`. Export it as :code:`HDF5_DIR` + + .. code-block:: bash + + python3 -m ensurepip --upgrade + export HDF5_DIR="/usr/local/Cellar/hdf5-mpi/1.13.0/" + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + + +.. warning:: + + If MPI-enabled HDF5 and :code:`h5py` can not be installed, limited support + for serial HDF5 is available. Note that having MPI-enabled file IO is + **highly recommended**, and simulation performance under serial HDF5 will + potentially be very low. + + Example dependency install on Ubuntu (apt) using serial HDF5: + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-serial-dev # Install serial HDF5 + sudo apt-get install -y curl wget + + python3 -m pip install h5py mpi4py numpy cython + + Running parallel simulations without a + MPI-enabled HDF5 library available necessitates the use of the + :code:`--disable-mpio` argument to HyMD, see :ref:`commandline-label`. Note that + due to the way HyMD is built, a working MPI compiler is required even if all + intended simulations are serial. + + +Installing HyMD +=============== +HyMD may be installed using :code:`pip` by + +.. code-block:: bash + + python3 -m pip install hymd + + + +Install in docker +================= +A docker image with build essentials setup is available at `dockerhub`_ with tag +:code:`mortele/hymd`, + +.. code-block:: bash + + docker pull mortele/hymd:latest + docker run -it mortele/hymd + /app$ python3 -m pip install hymd + + # Grab example input files + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5 + + # Run simulation + /app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose + +.. _dockerhub: + https://hub.docker.com/repository/docker/mortele/hymd + + +Run interactively in Google Colaboratory +======================================== +A `Google Colaboratory`_ jupyter notebook is setup `here`_ with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Common issues +============= + +Numpy errors while importing the Fortran force kernels +------------------------------------------------------ + +.. code-block:: python + + RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd + + Traceback (most recent call last): + + (...) + + File "/..../HyMD/hymd/__init__.py", line 2, in + from .main import main # noqa: F401 + File "/..../HyMD/hymd/main.py", line 10, in + from .configure_runtime import configure_runtime + File "/..../hymd/configure_runtime.py", line 12, in + from .input_parser import read_config_toml, parse_config_toml + File "/..../HyMD/hymd/input_parser.py", line 12, in + from .force import Bond, Angle, Dihedral, Chi + File "/..../HyMD/hymd/force.py", line 8, in + from force_kernels import ( # noqa: F401 + ImportError: numpy.core.multiarray failed to import + +can normally be fixed by updating numpy versions, + +.. code-block:: bash + + python3 -m pip install -U numpy + + +Error building pfft-python due to missing curl/wget +--------------------------------------------------- + +.. code-block:: python + + Building wheel for pfft-python (setup.py) ... error + ERROR: Command errored out with exit status 1: + command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_ + cwd: /tmp/pip-install-fr6nt9m4/pfft-python/ + Complete output (56 lines): + running bdist_wheel + running build + running build_py + + (...) + + curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found + wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found + Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + Please check curl or wget + You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ + Traceback (most recent call last): + File "", line 1, in + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in + setup( + File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup + return distutils.core.setup(**attrs) + File "/usr/lib/python3.8/distutils/core.py", line 148, in setup + + (...) + + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions + build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:])) + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft + raise ValueError("could not build fftw; check MPICC?") + ValueError: could not build fftw; check MPICC? + ---------------------------------------- + ERROR: Failed building wheel for pfft-python + Running setup.py clean for pfft-python + Failed to build pfft-python + +can be fixed by installing either `curl`_ or `wget`_ + +.. code-block:: bash + + apt-get install -y curl wget + + +.. _`curl`: + https://curl.se/ + +.. _`wget`: + https://www.gnu.org/software/wget/ + + +Error running parallel HyMD without MPI-enabled h5py +---------------------------------------------------- + +.. code-block:: python + + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + main() + File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main + with h5py.File(args.input, "r", **_kwargs) as in_file: + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__ + with h5py.File(args.input, "r", **_kwargs) as in_file: + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + raise ValueError("h5py was built without MPI support, can't use mpio driver") + ValueError: h5py was built without MPI support, can't use mpio driver + +Can be fixed by installing a MPI-enabled :code:`h5py` through + +.. code-block:: bash + + python3 -m pip uninstall -y h5py + HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py diff --git a/v2.1.0/_sources/doc_pages/interaction_energy_functionals.rst.txt b/v2.1.0/_sources/doc_pages/interaction_energy_functionals.rst.txt new file mode 100644 index 00000000..f33c004e --- /dev/null +++ b/v2.1.0/_sources/doc_pages/interaction_energy_functionals.rst.txt @@ -0,0 +1,98 @@ +.. _functionals-label: + +Interaction energy functionals +############################## +A few interaction energy functionals :math:`W` are defined in HyMD through +the :code:`Hamiltonian` class and associated subclasses. + +:math:`\chi`--interaction and :math:`\kappa`--incompressibility +=============================================================== +The most common hPF energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultWithChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where :math:`\tilde\chi_{\text{A}-\text{B}}` is the interaction energy between +overlapping densities of particle types :math:`\text{A}` and :math:`\text{B}`. +The incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\tilde\chi` +and :math:`\kappa` in the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + chi = [ + ["A", "B", 15.85], + ["B", "C", -5.70], + ... + ] + +Only :math:`\kappa`--incompressibility +====================================== +The only :math:`\kappa` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultNoChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where the incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Only :math:`\phi^2` +=================== +The :math:`\phi^2` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "SquaredPhi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2, + +where the :math:`\phi` squared term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Implementing new interaction energy forms +========================================= +Implementing new interaction energy functions is straightforward by subclassing +:code:`Hamiltonian` and applying :code:`sympy` differentiation to the symbolic +field objects. The :code:`sympy.lamdify` function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields. diff --git a/v2.1.0/_sources/doc_pages/interfaces.rst.txt b/v2.1.0/_sources/doc_pages/interfaces.rst.txt new file mode 100644 index 00000000..07cceece --- /dev/null +++ b/v2.1.0/_sources/doc_pages/interfaces.rst.txt @@ -0,0 +1,23 @@ +.. _interfaces-label: + +PLUMED interface +################ + +HyMD is interfaced with `PLUMED ` for simulations using enhanced sampling or free-energy methods. +To use the interface, the Python package of PLUMED must be installed, and the user must provide a working :code:`PLUMED_KERNEL` by setting this environment variable to the kernel path. +In the current version, only simulations using a single replica are supported. + +.. warning:: + PLUMED versions prior to :code:`2.8.1` did not have a working Python interface with MPI. Therefore, you **must** use PLUMED :code:`2.8.1` or greater when installing the PLUMED library in Python. Older versions for the kernel are supported if the Python interface was correctly installed with version :code:`2.8.1`. + +Running simulations using PLUMED +================================ + +To run your simulations using PLUMED you must first set the environment variable :code:`PLUMED_KERNEL` and then call HyMD with the :code:`--plumed` option, passing the PLUMED input file to HyMD. +Optionally, you can also set the output file name with the :code:`--plumed-outfile` option (the default it :code:`plumed.out`). + +If your PLUMED input (see the `PLUMED manual <>` for details) is called, e.g., :code:`plumed_input.dat`, you can run a simulation using the PLUMED interface with: + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field --plumed plumed_input.dat diff --git a/v2.1.0/_sources/doc_pages/intramolecular_bonds.rst.txt b/v2.1.0/_sources/doc_pages/intramolecular_bonds.rst.txt new file mode 100644 index 00000000..820e81bc --- /dev/null +++ b/v2.1.0/_sources/doc_pages/intramolecular_bonds.rst.txt @@ -0,0 +1,142 @@ +.. _bonds-label: + +Intramolecular bonds +#################### + +Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see :ref:`config-label`. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +:ref:`benchmarks-label`), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable. + +All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]). + + +Two-particle bonds +^^^^^^^^^^^^^^^^^^ +Stretching bonds in HyMD are implemented as harmonic spring potentials, + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2, + +where :math:`r=|\mathbf{r}|` is the inter-particle distance, :math:`k` is a +constant of dimension energy (units :math:`\text{kJ}\,\text{mol}^{-1}`), and +:math:`r_0` is the equilibrum length of the bond (units: :math:`\text{nm}`). The +force is calculated as + +.. math:: + + F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r}, + +where :math:`\mathbf{r}` is the vector pointing *from* :math:`i` *to* :math:`j`. + +In the configuration file, two-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_two_particle_example.toml + + [bonds] + bonds = [ + ["A", "A", 0.47, 1250.0], + ["A", "B", 0.37, 940.0], + ["B", "C", 0.50, 1010.0], + ["C", "A", 0.42, 550.0], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Three-particle bonds +^^^^^^^^^^^^^^^^^^^^ +Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle--particle--particle angle :math:`\theta`, + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2, + +where :math:`k` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}`), and :math:`\theta_0` is the equilibrum +angle of the bond (units: :math:`{}^\circ`). Defining the particles with labels +:math:`a`, :math:`b`, and :math:`c`, let :math:`\mathbf{r}_a` denote the vector +pointing from :math:`b` to :math:`a`, and correspondingly let +:math:`\mathbf{r}_c` point from :math:`b` to :math:`c`. The +:math:`a`--:math:`b`--:math:`c` may be computed through the law of Cosines, + +.. math:: + + \theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right] + +Then the force acting on :math:`a` and :math:`c` is + +.. math:: + + \mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a}, + + \mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c}, + +and + +.. math:: + + \mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c + +In the configuration file, three-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_three_particle_example.toml + + [bonds] + angle_bonds = [ + ["A", "A", "A", 180.0, 90.0], + ["A", "B", "A", 120.0, 55.0], + ["B", "C", "C", 30.0, 10.0], + ["C", "A", "B", 110.0, 25.5], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Four-particle bonds +^^^^^^^^^^^^^^^^^^^ +Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle :math:`\phi` between the +:math:`a`--:math:`b`--:math:`c` and :math:`b`--:math:`c`--:math:`d` planes, for +a dihedral bond quartet :math:`a`, :math:`b`, :math:`c`, and :math:`d`. The +potential takes the form + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n), + +where :math:`c_n` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`), and :math:`\phi_n` are +specified phase angles in the cosine series. + +In the configuration file, four-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_four_particle_example.toml + + [bonds] + dihedrals = [ + ["A", "B", "C", "D"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0], + ] diff --git a/v2.1.0/_sources/doc_pages/overview.rst.txt b/v2.1.0/_sources/doc_pages/overview.rst.txt new file mode 100644 index 00000000..0e4d6b65 --- /dev/null +++ b/v2.1.0/_sources/doc_pages/overview.rst.txt @@ -0,0 +1,166 @@ +.. _overview-label: + +================================ + Usage overview for HylleraasMD +================================ + +HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a `toml`_ format configuration file, along with a topology and structure +file specifying the input system in HDF5 format. + +.. _`toml`: + https://github.com/toml-lang/toml + +**Configuration file** + +The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a :code:`[5, 5, 5]` nm simulation box at 300 K may look like +the following: + +.. code-block:: toml + :caption: **config_simple_1.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "SquaredPhi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [30, 30, 30] # FFT grid size + sigma = 0.5 # filtering length scale in nm + +Note that for the version 1.0 release of HyMD, the :code:`[particles]`, +:code:`[simulation]`, and :code:`[field]` groups are optional specifiers for +structuring the configuration file. + +For a full specification of every recognised configuration keyword in HyMD, +please refer to :ref:`config-label`. + +**Topology and structure file** + +The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +:code:`N` particles may look like the following: + +.. code-block:: bash + :caption: **example_structure.HDF5** + + group / + # root group + + dataset /coordinates + # float32, shape (T, N, D,) + # Time steps of N rows of D dimensional coordinate data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /velocities + # float32, shape (T, N, D,) OPTIONAL + # Time steps of N rows of D dimensional velocity data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /bonds + # int32, shape (N, B,) OPTIONAL + # Each row i contains indices of the particles bonds from/to i + # B denotes the maximum bonds per particle + + dataset /indices + # int32, shape (N,) + # Index of each particle, 0--(N-1) + + dataset /molecules + # int32, shape (N,) + # Index of molecule each particle belongs to + # Used to construct bond network locally on MPI ranks + + dataset /names + # str10, shape (N,) + # Fixed size string array containing particle type names + + dataset /types + # int32, shape (N,) OPTIONAL + # Mapping of particle names to type indices + + +For a full specification of the topology and structure input file, see +:ref:`topology-label`. + +**Command line arguments** + +A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the :code:`config_simple_1.toml` and :code:`example_structure.HDF5` +files may look like the following: + +.. code-block:: bash + + mpirun -n ${MPI_NUM_RANKS} python3 -m hymd \ # HyMD executable + config_simple_1.toml \ # configuration file + example_structure.HDF5 \ # structure file + --logfile=log_out.txt \ # set logfile path + --seed 123456 \ # set random seed + --verbose 2 \ # set logging verbosity + --velocity-output # enable velocity in trajectory output + +For a full specification of all command line arguments, see +:ref:`commandline-label`. + +**More examples** + +For more thorough rundown and concrete usage examples, see +:ref:`examples-label`. + +Running parallel simulations +============================ +Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the **only** difference being how the python3 interpreter is +invoked. Prepending :code:`mpirun -n ${NPROCS}` to the usual +:code:`python3 -m hymd` runs the simulation with :code:`${NPROCS}` MPI ranks. + +Inputting + +.. code:: bash + + mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field + +sets up an example simulation of the `HyMD-tutorial/ideal_gas`_ system. For +more details about this system in particular, or other example simulations, see +the `HyMD-tutorial`_ repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas + + +Running tests +============= +Run serial code tests by + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd + cd hymd/ + python3 -m pip install pytest pytest-mpi + python3 -m pytest + +There is a small convenience script in :code:`hymd/` for running the MPI-enabled +tests, + +.. code-block:: bash + + chmod +x pytest-mpi + ./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no diff --git a/v2.1.0/_sources/doc_pages/pressure.rst.txt b/v2.1.0/_sources/doc_pages/pressure.rst.txt new file mode 100644 index 00000000..be9c7cda --- /dev/null +++ b/v2.1.0/_sources/doc_pages/pressure.rst.txt @@ -0,0 +1,37 @@ +.. _pressure-label: + +Pressure +######## +Internal pressure is calculated from internal energy according to + +.. math:: + + P_a = \frac{1}{\mathcal{V}} \left( 2T_a - \text{Vir}_a \right) \\ + \text{Vir}_a = L_a \frac{\partial \mathcal{U}}{\partial L_a} \\ + \mathcal{U} = \sum_{i=1}^M \mathcal{U}_0( \{ \mathbf{r}\}_i ) + W[\{ \tilde\phi \} ] + +where +:math:`\mathcal{V}` is the simulation volume, +:math:`{T_a}` is the kinetic energy +and :math:`L_a` the length of the box in the Cartesian direction :math:`a`, +Vir is the virial of the total interaction energy :math:`\mathcal{U}`. + +:math:`\mathcal{U}` comprises intramolecular bonded terms :math:`\mathcal{U}_0` (see :ref:`bonds-label` for details), +and field terms :math:`W[\{ \tilde\phi \} ]` (see :ref:`theory-label` for details). + +Using the above expressions, the following form for internal pressure is obtained: + +.. math:: + + P_a = \frac{2 T_a}{\mathcal{V}} -\frac{L_a}{\mathcal{V}} \sum_{i=1}^N \frac{\partial \mathcal{U}_{0i}}{\partial L_a} + P^{(3)}_a \\ + +.. P^{(3)}_a = - \frac{L_a}{\mathcal{V}} \frac{\partial W[\{ \tilde\phi \} ]}{\partial L_a} \\ + +.. math:: + + P^{(3)}_a = \frac{1}{\mathcal{V}}\left ( -W[\{ \tilde\phi(\mathbf{r}) \}] + \int \sum_t \bar{V}_t(\mathbf{r})\tilde\phi_t(\mathbf{r})d\mathbf{r} + + \int \sum_t \sigma^2\bar{V}_t(\mathbf{r})\nabla_a^2\tilde\phi_t(\mathbf{r}) d\mathbf{r} \right) + +where :math:`\bar{V}_t(\mathbf{r}) = \frac{\partial w(\{\tilde\phi\})}{\partial\tilde\phi_t}` +and :math:`σ` is a coarse-graining parameter (see :ref:`filtering-label` for details). +Note that the above expression is obtained for a Gaussian filter which is the most natural choice in HhPF theory. diff --git a/v2.1.0/_sources/doc_pages/theory.rst.txt b/v2.1.0/_sources/doc_pages/theory.rst.txt new file mode 100644 index 00000000..2429bc0d --- /dev/null +++ b/v2.1.0/_sources/doc_pages/theory.rst.txt @@ -0,0 +1,122 @@ +.. _theory-label: + +Theory +###### +Hybrid particle--field simulations switch out the ordinary particle--particle +`Lennard-Jones`_ interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle--field densities are +defined as + +.. math:: + + \phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i), + +where :math:`\mathbf{r}` is a spatial coordinate, :math:`P` is a window function +used to distribute particle number densities onto a computational grid, and +:math:`\mathbf{r}_i` is the position of particle :math:`i` (of total :math:`N`). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of :math:`N` particles in :math:`M` molecules is + +.. math:: + + \mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})] + +with :math:`H_0` being a standard intramolecular Hamiltonian form (see +:ref:`bonds-label`) including kinetic terms, while :math:`W` is a density +dependent *interaction energy functional*. + +In the Hamiltonian hPF-MD formalism :cite:`bore2020hamiltonian`, the density +field is filtered using a grid-independent filtering function :math:`H`, + +.. math:: + + \tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}). + +The filter smooths the density, ensuring that :math:`\tilde\phi` and +:math:`W[\tilde\phi([\phi])]` both converge as the grid size is reduced. + +External potential +================== +The external potential acting on a particle is defined as the functional +derivative of :math:`W` with respect to :math:`\phi`. In the filtered formalism, +the potential takes the form + +.. math:: + + V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ + &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})}, + +under the assumption of a *local* form of the interaction energy functional, +:math:`W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]`. Note +that + +.. math:: + + \frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}). + +Force interpolation +=================== +The forces on particle :math:`i` are obtained by differentiation of the external +potential, + +.. math:: + + \mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i). + + +Reciprocal space calculations +============================= +The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density :math:`\phi_{ijk}` with CIC, we apply the filtering +and obtain the discrete version of the external potential by + +.. math:: + + \tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big] + +and + +.. math:: + + V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +The forces are obtained by differentiation of :math:`V` in Fourier space as + +.. math:: + + \nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +Filter +====== +By default, the filter used in HyMD is a simple Gaussian of the form + +.. math:: + + H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ + \hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +For more details about the filtering, see :ref:`filtering-label`. + +Hamiltonian form +================ +The default form of the interaction energy functional in HyMD is + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2. + +In the case of constant pressure simulations (NPT), the interaction energy functional becomes + +.. math:: + + W=\frac{1}{2\rho_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-a\right)^2. + +where, :math:`\rho_0= 1 / ν` is an intrinsic parameter corresponding to the specific volume :math:`(ν)` of a coarse-grained particle, +:math:`a` is a calibrated parameter to obtain the correct average density at the target temperature and pressure. +See :ref:`functionals-label` for details. + + +.. _`Lennard-Jones`: + https://en.wikipedia.org/wiki/Lennard-Jones_potential diff --git a/v2.1.0/_sources/doc_pages/topology_input.rst.txt b/v2.1.0/_sources/doc_pages/topology_input.rst.txt new file mode 100644 index 00000000..02faa501 --- /dev/null +++ b/v2.1.0/_sources/doc_pages/topology_input.rst.txt @@ -0,0 +1,84 @@ +.. _topology-label: + +============================ +Topology and structure file +============================ +The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root :code:`/` group. + +The `HyMD-tutorial`_ has multiple examples of structure files for various levels +of complexity. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Required datasets +================= +:/coordinates: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/indices: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/names: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`string` (:code:`length` between :code:`1` and :code:`16`)] + + The shape represents one particle name per :code:`N` particles. The datatype may be a string of length :code:`=<16`. + + + +Optional datasets +================= +:/velocities: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/types: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle type index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/molecules: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one molecule index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/bonds: + :code:`array` shape [:code:`N`, :code:`B`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents :code:`B` bond specifications (indices of different particles) per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/charge: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents one particle charge per :code:`N` particles. The data type may be either four or eight byte reals. + +:/box: + :code:`array` shape [:code:`3`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents the initial box dimensions in Cartesian coordinates. diff --git a/v2.1.0/_sources/index.rst.txt b/v2.1.0/_sources/index.rst.txt new file mode 100644 index 00000000..6899ec42 --- /dev/null +++ b/v2.1.0/_sources/index.rst.txt @@ -0,0 +1,164 @@ +.. hymd documentation master file, created by + sphinx-quickstart on Thu Dec 16 13:31:43 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +############################### +HylleraasMD documentation +############################### + +:Release: + |release| +:Date: + |today| + +**HylleraasMD** (HyMD) is a massively parallel Python package for Hamiltonian hybrid +particle-field molecular dynamics (HhPF-MD) simulations of coarse-grained bio- +and soft-matter systems. + +HyMD can run canonical hPF-MD simulations, or filtered density HhPF-MD simulations :cite:`hymd_domain2023,hymd_massive2023,hymd_pressure2023,hymd_alias2020` +with or without explicit PME electrostatic interactions. It includes all standard intramolecular interactions, +including stretching, bending, torsional, and combined bending-dihedral potentials. Additionally, topological reconstruction of permanent peptide chain backbone +dipoles is possible for accurate recreation of protein conformational dynamics. It can run simulations in constant energy (NVE), constant volume (NVT) :cite:`hymd_domain2023,hymd_massive2023` +or constant pressure (NPT) conditions :cite:`hymd_pressure2023`. +HyMD is also interfaced with :doc:`PLUMED ` and can perform simulations using enhanced sampling methods. + +HyMD uses the pmesh library for particle-mesh operations, with the PPFT :cite:`pippig2013` backend for FFTs through the pfft-python bindings. +File IO is done via HDF5 formats to allow MPI parallel reads. + +User Guide +========== +The HylleraasMD :doc:`User Guide ` provides comprehensive information on how to run +simulations. Selected :doc:`Examples ` are available to guide new users. + +.. _`github.com/rainwoodman/pmesh`: + https://github.com/rainwoodman/pmesh +.. _`github.com/rainwoodman/pfft-python`: + https://github.com/rainwoodman/pfft-python + +Installing HyMD +=============== +The easiest approach is to install using pip_: + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + +For more information and **required dependencies**, see +:ref:`installation-label`. + +.. _pip: + http://www.pip-installer.org/en/latest/index.html + + +Run in Google colab +------------------- +Run HyMD interactively in `Google Colaboratory`_ jupyter notebook `here`_. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Source Code +=========== +**Source code** is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the `GNU Lesser General Public +License v3.0`_. Obtain the source code with `git`_: + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git + +.. _GNU Lesser General Public License v3.0: + https://www.gnu.org/licenses/lgpl-3.0.html +.. _git: + https://git-scm.com/ + + +Development +=========== +HyMD is developed and maintained by researchers at the `Hylleraas Centre for +Quantum Molecular Sciences`_ at the `University of Oslo`_. + +|pic1| |pic2| + +.. _`Hylleraas Centre for Quantum Molecular Sciences`: + https://www.mn.uio.no/hylleraas/english/ +.. _`University of Oslo`: + https://www.uio.no/ + +.. |pic1| image:: img/hylleraas_centre_logo_black.png + :target: img/hylleraas_centre_logo_black.png + :width: 250 px + +.. |pic2| image:: img/uio_full_logo_eng_pos.png + :target: img/uio_full_logo_eng_pos.png + :width: 325 px + + + +References +========== +.. bibliography:: + :all: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. Contents +.. ======== + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Getting started + + ./doc_pages/installation + ./doc_pages/overview + ./doc_pages/config_file + ./doc_pages/topology_input + ./doc_pages/command_line + ./doc_pages/constants_and_units + + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Examples + + ./doc_pages/examples + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Theory + + ./doc_pages/theory + ./doc_pages/intramolecular_bonds + ./doc_pages/electrostatics + ./doc_pages/pressure + ./doc_pages/interfaces + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Developer documentation + + ./doc_pages/interaction_energy_functionals + ./doc_pages/filtering + ./doc_pages/benchmarks + ./doc_pages/api diff --git a/v2.1.0/_static/basic.css b/v2.1.0/_static/basic.css new file mode 100644 index 00000000..be19270e --- /dev/null +++ b/v2.1.0/_static/basic.css @@ -0,0 +1,856 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/v2.1.0/_static/css/badge_only.css b/v2.1.0/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/v2.1.0/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/v2.1.0/_static/css/fonts/Roboto-Slab-Bold.woff b/v2.1.0/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/v2.1.0/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/v2.1.0/_static/css/fonts/Roboto-Slab-Bold.woff2 b/v2.1.0/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/v2.1.0/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/v2.1.0/_static/css/fonts/Roboto-Slab-Regular.woff b/v2.1.0/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/v2.1.0/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/v2.1.0/_static/css/fonts/Roboto-Slab-Regular.woff2 b/v2.1.0/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/v2.1.0/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/v2.1.0/_static/css/fonts/fontawesome-webfont.eot b/v2.1.0/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/v2.1.0/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/v2.1.0/_static/css/fonts/fontawesome-webfont.svg b/v2.1.0/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/v2.1.0/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v2.1.0/_static/css/fonts/fontawesome-webfont.ttf b/v2.1.0/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/v2.1.0/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/v2.1.0/_static/css/fonts/fontawesome-webfont.woff b/v2.1.0/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/v2.1.0/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/v2.1.0/_static/css/fonts/fontawesome-webfont.woff2 b/v2.1.0/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/v2.1.0/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/v2.1.0/_static/css/fonts/lato-bold-italic.woff b/v2.1.0/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/v2.1.0/_static/css/fonts/lato-bold-italic.woff differ diff --git a/v2.1.0/_static/css/fonts/lato-bold-italic.woff2 b/v2.1.0/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/v2.1.0/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/v2.1.0/_static/css/fonts/lato-bold.woff b/v2.1.0/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/v2.1.0/_static/css/fonts/lato-bold.woff differ diff --git a/v2.1.0/_static/css/fonts/lato-bold.woff2 b/v2.1.0/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/v2.1.0/_static/css/fonts/lato-bold.woff2 differ diff --git a/v2.1.0/_static/css/fonts/lato-normal-italic.woff b/v2.1.0/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/v2.1.0/_static/css/fonts/lato-normal-italic.woff differ diff --git a/v2.1.0/_static/css/fonts/lato-normal-italic.woff2 b/v2.1.0/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/v2.1.0/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/v2.1.0/_static/css/fonts/lato-normal.woff b/v2.1.0/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/v2.1.0/_static/css/fonts/lato-normal.woff differ diff --git a/v2.1.0/_static/css/fonts/lato-normal.woff2 b/v2.1.0/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/v2.1.0/_static/css/fonts/lato-normal.woff2 differ diff --git a/v2.1.0/_static/css/theme.css b/v2.1.0/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/v2.1.0/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/v2.1.0/_static/custom.css b/v2.1.0/_static/custom.css new file mode 100644 index 00000000..b20d6282 --- /dev/null +++ b/v2.1.0/_static/custom.css @@ -0,0 +1,91 @@ + +body{ + background: #FFFFFF !important; +} + +.wy-menu-vertical header, .wy-menu-vertical p.caption{ + color: #4EA0AF!important; +} +.wy-menu-vertical li.current{ + background-color: #f4f4f4!important; +} +.wy-menu-vertical li.toctree-l2.current>a{ + background-color: #ebebeb!important; +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{ + background-color: #e3e3e3!important; +} + +.rst-content .sidebar{ + background-color: #fff!important; + border-radius: 6px; + -moz-border-radius: 6px; + -webkit-border-radius: 6px; +} + +h1 > a, h2 > a, h3 > a, h4 > a, h5 > a, h6 > a { + color: #17d9ff; +} + +h1, h2, h3, h4, h5, h6 { + color: black; + font-weight: normal; + padding: 0; +} + +h1, h2, h3 { + margin-top: 30px; + margin-bottom: 20px; +} + +h1 { + color: white; + padding: 20px 20px 20px 45px; + margin: 20px 0 35px -45px; + background: linear-gradient(to left, #fff, #2b38ff)!important; + + width: calc(100% + 90px); + border-bottom: 3px solid #000; +} + +h2 { + padding: .2em 0; + border-bottom: 1px solid #ddd; +} + +h3 { + margin-top: 35px; +} + +h4 { + margin-top: 30px; +} + +h5 { + margin-top: 25px; +} + +.wy-nav-content{ + max-width: none!important; +} + +.wy-side-nav-search{ + background: #2b38ff!important; +} + +.wy-side-nav-search input[type=text]{ + border-color:#4DA0B0!important; +} + +.wy-side-nav-search input[type=text]{ + border-radius: 4px!important; +} + +#caption-api { + background: red !important; +} + +#caption-text-api { + text-color: blue !important; +} diff --git a/v2.1.0/_static/doctools.js b/v2.1.0/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/v2.1.0/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/v2.1.0/_static/documentation_options.js b/v2.1.0/_static/documentation_options.js new file mode 100644 index 00000000..1cccfc07 --- /dev/null +++ b/v2.1.0/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '2.1.0', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/v2.1.0/_static/file.png b/v2.1.0/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/v2.1.0/_static/file.png differ diff --git a/v2.1.0/_static/hymd_icon_white.png b/v2.1.0/_static/hymd_icon_white.png new file mode 100644 index 00000000..d0396a17 Binary files /dev/null and b/v2.1.0/_static/hymd_icon_white.png differ diff --git a/v2.1.0/_static/hymd_logl_white_text_abbr.png b/v2.1.0/_static/hymd_logl_white_text_abbr.png new file mode 100644 index 00000000..8c0e50c8 Binary files /dev/null and b/v2.1.0/_static/hymd_logl_white_text_abbr.png differ diff --git a/v2.1.0/_static/jquery-3.5.1.js b/v2.1.0/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/v2.1.0/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. API reference

+
+

4.1. Integrator

+

Integrates equations of motion.

+

Implements the Velocity Verlet integrator. The reversible reference system +propagator algorithm (rRESPA) integrator uses the Velocity Verlet functions +inside the MD loop in the main module.

+
+
+hymd.integrator.integrate_position(positions, velocities, time_step)[source]
+

Position update step of the Velocity Verlet integration algorithm.

+

Computes the position update step of the Velocity Verlet algorithm. The +positions argument is not changed in place.

+
+
Parameters:
+
+
positions(N, D) numpy.ndarray

Array of positions of N particles in D dimensions.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_velocity

The velocity update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step, then the positions are updated a full step using the updated +velocities

+
+\[\mathbf{x}_{\text{new}} = \mathbf{x} + \Delta t \mathbf{v}\]
+
+ +
+
+hymd.integrator.integrate_velocity(velocities, accelerations, time_step)[source]
+

Velocity update step of the Velocity Verlet integration algorithm.

+

Computes the velocity update step of the Velocity Verlet algorithm. The +velocities argument is not changed in place.

+
+
Parameters:
+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
accelerations(N, D) numpy.ndarray

Array of accelerations of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_position

The position update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step

+
+\[\mathbf{v}_{\text{new}} = \mathbf{v} + \frac{\Delta t}{2m} +\mathbf{f}\]
+

before the positions are moved a full step using the updated half-step +velocities.

+
+ +
+
+

4.2. Thermostat

+

Scales or otherwise modifies the particle velocities during simulation to +simulate coupling to an external heat bath with temperature T₀.

+
+
+hymd.thermostat._random_chi_squared(prng: numpy.random._generator.Generator, M: int)float[source]
+

Draw the sum of M squared normally distributed values

+

The value is generated by the Gamma distribution, in lieu of generating +M Gaussian distributed numbers and summing their squares.

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
Mint

Number of standard normally distributed numbers in the sum.

+
+
+
+
Returns:
+
+
float

The sum of M squared normally distributed values centered at +zero with unit standard deviation.

+
+
+
+
+

Notes

+

The sum of the squares of k independent standard normal random variables is +distributed according to a \(\chi^2\) distribution.

+
+\[\chi^2_1 + \chi_2^2 + \chi_3^2 + \dots + \chi_M^2 +\sim +\sigma^2\chi^2(k)\]
+

This is a special case of the \(\Gamma\) distribution, +\(\Gamma(k/2, 2)\), and may be generated by

+
+\[\chi^2(k) \sim 2 \Gamma(k/2, 2)\]
+

References

+

Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of +Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. +J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246.

+
+ +
+
+hymd.thermostat._random_gaussian(prng: numpy.random._generator.Generator)float[source]
+

Draw a single random number from the standard normal distribution +Generate a number from the Gaussian distribution centered at zero with unit +standard deviation, \(N(0, 1)\).

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
+
+
Returns:
+
+
float

A random number drawn from \(N(0, 1)\).

+
+
+
+
+
+ +
+
+hymd.thermostat.csvr_thermostat(velocity: numpy.ndarray, names: numpy.ndarray, config: hymd.input_parser.Config, prng: numpy.random._generator.Generator, comm: mpi4py.MPI.Intracomm = <mpi4py.MPI.Intracomm object>, random_gaussian: Callable[[numpy.random._generator.Generator], float] = <function _random_gaussian>, random_chi_squared: Callable[[numpy.random._generator.Generator, int, float], float] = <function _random_chi_squared>, remove_center_of_mass_momentum: bool = True)numpy.ndarray[source]
+

Canonical sampling through velocity rescaling thermostat

+

Implements the CSVR thermostat. Rescales the system kinetic energy by a +stochastically chosen factor to keep the temperature constant. Requires +communcation of the kinetic energies calculated locally for each MPI rank. +The random numbers sampled through random_gaussian and +random_chi_squared are broadcast from the root rank to the other +ranks to ensure the scaling is performed with the same stochasticity for +all particles in the full system.

+

The velocities are cleaned of center of mass momentum before the thermostat +is applied, and the center of mass momentum is subsequently reapplied. This +is performed for each thermostat coupling group, i.e. the center of mass +momenta of each group is separately removed and reapplied after +thermostatting.

+

The implementation here is based on the derivation presented in the 2008 +Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper.

+
+
Parameters:
+
+
velocity(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
names(N,) numpy.ndarray

Array of particle names.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
random_gaussiancallable, optional

Function for generating standard normally distributed numbers.

+
+
random_chi_squaredcallable, optional

Function for generating \(\chi^2\)-distributed numbers

+
+
remove_center_of_mass_momentumbool, optional

If True, the center of mass of each coupling group is removed before +the thermostat is applied. The center of mass momenta are added back +after the kinetic energy rescaling is complete.

+
+
+
+
+
+

See also

+
+
_random_gaussian

Used to sample Gaussian-distributed numbers.

+
+
_random_chi_squared

Used to sample \(\chi^2\)-distributed numbers.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +

References

+

G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). +G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008).

+
+ +
+
+

4.3. Barostat

+
+

4.3.1. Berendsen Barostat

+

Implements the Berendsen barostat. +Scales the box and particle positions during simulation to +simulate coupling to an external pressure bath set at a +target pressure.

+

It calculates the scaling factor according to: +.. math:

+
\alpha_{L,N} = 1 - \frac{dt n_b}{\tau_p}\β(P_{L,N}^t - P_{L,N})
+
+
+

where \(dt\) is the outer rRESPA time-step, \(n_b\) is the frequency +of barostat calls, \(\tau_p\) is the pressure coupling time constant, +\(\beta\) is the isothermal compressibility, \(P_{L,N}^t\) and +\(P_{L,N}\) is the target and instantaneous internal pressure in the +lateral (L) and normal (N) directions respectively. Convention: Cartesian +z-direction is considered normal.

+

The box and particle positions are scaled in the L and N directions according +to the nature of the barostat (see functions isotropic and semiisotropic +below by an amount \(\α^{\frac{1}{3}}\).

+

The updated system information is passed on to the pmesh objects.

+
+

4.3.1.1. References

+

H. J. C. Berendsen, J. P. M. Postma, W. F. van Gunsteren, +A. DiNola, and J. R. Haak , “Molecular dynamics with coupling +to an external bath”, J. Chem. Phys. 81, 3684-3690 (1984)

+
+
+hymd.barostat.isotropic(pmesh, pm_stuff, phi, phi_q, psi, hamiltonian, positions, velocities, config, phi_fft, phi_laplacian, phi_transfer, bond_pr, angle_pr, step, prng, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Implements an isotropic Berendsen barostat. +The box and particle positions are scaled uniformly +in the L and N directions.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of pmesh objects.

+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fftlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds.

+
+
stepinteger

MD step number

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of modified/unmodified pmesh objects.

+
+
changeBoolean

Indicates whether or not any pmesh objects were reinitialized.

+
+
+
+
+
+ +
+
+hymd.barostat.semiisotropic(pmesh, pm_stuff, phi, phi_q, psi, hamiltonian, positions, velocities, config, phi_fft, phi_laplacian, phi_transfer, bond_pr, angle_pr, step, prng, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Implements a semiisotropic Berendsen barostat. +The box and particle positions are scaled by \(\alpha_L^{\frac{1}{3}}\) +in the L direction and by \(\alpha_N^{\frac{1}{3}}\) in the N direction.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of pmesh objects.

+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fftlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds.

+
+
stepinteger

MD step number

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of modified/unmodified pmesh objects.

+
+
changeBoolean

Indicates whether or not any pmesh objects were reinitialized.

+
+
+
+
+
+ +
+
+
+

4.3.2. SCR Barostat

+
+
+
+

4.4. Hamiltonian

+
+
+class hymd.hamiltonian.Hamiltonian(config)[source]
+

Interaction energy functional superclass

+
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+_setup()[source]
+

Superclass setup

+

Sets up the grid-independent filtering function H, and the +SymPy logic for symbolically differentiating interaction energy +functionals in Hamiltonian subclasses.

+
+ +
+ +
+
+class hymd.hamiltonian.SquaredPhi(config)[source]
+

Simple squared density interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + \sum_k \tilde\phi_k + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(rho_0\) is the +average density of the fully homogenous system. Expressing the species +densities in terms of fluctuations from the average,

+
+\[\mathrm{d}\tilde\phi_k = \rho_0 - \tilde\phi_k,\]
+

it is evident that this interaction energy functional is a slight change of +the DefaultNoChi Hamiltonian, as the expanded interaction energy +density becomes

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + 6\rho_0\left[ + \sum_k \mathrm{d}\tilde\phi_k + \right] + + + 9\rho_0^2 + + + \sum_k \mathrm{d}\tilde\phi_k^2 + + + \prod_{k\not=l} + \mathrm{d}\tilde\phi_k \mathrm{d}\tilde\phi_l + \right),\]
+

identical to DefaultNoChi apart from a constant energy shift +\(9\rho_0^2`(which does not impact dynamics) and the +:math:\)rho_0`–\(\mathrm{d}\tilde\phi_k\) cross-terms. These +cross-terms constitute contributions to the energy linear in +\(\mathrm{d}\tilde\phi_k\) absent in DefaultNoChi, which has +only quadratic terms present.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultNoChi(config)[source]
+

Incompressibility-only interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a +\right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. The SquaredPhi Hamiltonian implements a similar +functional with an additional linear term component depending on

+
+\[\mathmr{d}\tilde\phi_k = \tilde\phi_k - \rho_0\]
+

and not \(\mathrm{d}\tilde\phi_k^2\). No explicit inter-species +interaction is present apart from the indirect interaction through the +incompressibility.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultWithChi(config, unique_names, type_to_name_map)[source]
+

Incompressibility and \(\chi\)-interactions energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = + \frac{1}{2\rho_0} + \sum_{k,l}\chi_{kl} \tilde\phi_k \tilde\phi_l + + + \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. \(\chi_{ij}\) is the Flory-Huggins-like +inter-species mixing energy.

+
+
+__init__(config, unique_names, type_to_name_map)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup(unique_names, type_to_name_map)[source]
+

Setup the interaction energy potential and the external potential

+
+
Parameters:
+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+ +
+ +
+
+

4.5. Force

+

Calculates intramolecular forces between bonded particles in molecules

+
+
+class hymd.force.Angle(atom_1: str, atom_2: str, equilibrium: float, strength: float, atom_3: str)[source]
+

Dataclass representing a single three-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any three-particle bond between particles of specific types A, +B, and C (where A, B, and C may be +different or the same). Harmonic angular three-particle bonds in HyMD take +the form

+
+\[V_3(\mathbf{r}_1, \mathbf{r}_2, \mathbf{r}_3) = + \frac{1}{2}k + \left( + \cos^{-1} + \left[ + \frac{ + (\mathbf{r}_1-\mathbf{r}_2) + \cdot + (\mathbf{r}_3-\mathbf{r}_2) + } + { + \vert\mathbf{r}_1-\mathbf{r}_2\vert + \vert\mathbf{r}_3-\mathbf{r}_2\vert + } + \right] - \theta_0 + \right)^2\]
+
+

See also

+
+
Bond

Two-particle bond type dataclass

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
equilibriumfloat

Equilibrium angle at which the energy associated with the +three-particle angular bond vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient.

+
+
+
+
+
+
+atom_3: str
+
+ +
+ +
+
+class hymd.force.Bond(atom_1: str, atom_2: str, equilibrium: float, strength: float)[source]
+

Dataclass representing a single two-particle bond type

+

A bond type is a bond strength and equilibrium distance associated with +any bond between particles of specific types A and B +(where A and B may be the same or different). Harmonic +two-particle bonds in HyMD take the form

+
+\[V_2(\mathbf{r}_1, \mathbf{r}_2) = + \frac{1}{2}k + \left( + \vert \mathbf{r}_1 - \mathbf{r}_2 \vert - r_0 + \right)^2,\]
+

where \(k\) is the bond strength (spring constant) and \(r_0\) is +the equilibrium bond length (at which the energy is zero).

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
equilibriumfloat

Equilibrium distance at which the energy associated with the bond +vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient (spring constant).

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+equilibrium: float
+
+ +
+
+strength: float
+
+ +
+ +
+
+class hymd.force.Chi(atom_1: str, atom_2: str, interaction_energy: float)[source]
+

Dataclass representing a single \(\chi\) mixing interaction type

+

An interaction mixing energy type is a mixing energy associated with +density overlap between species of types A and B +(specified as inputs atom_1 and atom_2). A positive mixing +energy promotes phase separation, a negative mixing energy promotes mixing. +The interaction energy density (provided the DefaultWithChi +Hamiltonian is used) takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} + \sum_{k,l}\chi_{k,l} \tilde\phi_k\tilde\phi_l,\]
+

where \(\chi_{k,l}\) denotes the mixing energy between species +\(k\) and \(l\), with \(\kappa\) being the incompressibility. +The value of the interaction mixing energy parameter may be extracted from +Flory-Huggins theory.

+
+

See also

+
+
hymd.hamiltonian.DefaultWithChi

Interaction energy functional using \(\chi\)-interactions.

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
interaction_energyfloat

Interaction mixing energy.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+interaction_energy: float
+
+ +
+ +
+
+class hymd.force.Dielectric_type(atom_1: str, dielectric_value: float)[source]
+
+
+atom_1: str
+
+ +
+
+dielectric_value: float
+
+ +
+ +
+
+class hymd.force.Dihedral(atom_1: str, atom_2: str, atom_3: str, atom_4: str, coeffs: numpy.ndarray, dih_type: int)[source]
+

Dataclass representing a single four-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any four-particle torsional bond between particles of specific types +A, B, C, and D (where A, B, +C, and D may be different or the same). Dihedral +four-particle bonds in HyMD take different forms depending on the +dih_type parameter.

+

In the following, let \(\phi\) denote the angle between the planes +spanned by the relative positions of atoms A-B-C +and B-C-D. If dih_type = 0, then

+
+\[V_4(\phi) = \sum_n c_n + \left( + 1 + \cos\left[ + n\phi - d_n + \right] + \right),\]
+

where \(c_n\) are energy coefficients and \(d_n\) are propensity +phases. By default, the cosine sum is truncated at five terms. If +coeffs provides only a single float, this is used as the coiling +propensity parameter \(\lambda\). In this case, \(c_n\) and +\(d_n\) are automatically set to values which promote alpha helical +(\(\lambda=-1\)), beta sheet (\(\lambda=1\)), or a mixed +(\(1>\lambda>-1\)) structure (using values provided by Bore et al. +(2018)). In this case, the full potential takes the form

+
+\[V_4(\phi;\lambda) = + \frac{1}{2}(1-\lambda) V_{\text{prop},\alpha}(\phi) + + + \frac{1}{2}(1+\lambda) V_{\text{prop},\beta}(\phi) + + + (1-\vert\lambda\vert) V_{\text{prop}, \text{coil}}(\phi),\]
+

with each of the \(V_{\mathrm{prop}, X}\) being fixed cosine series +potentials with pre-set \(c_n\) -s and \(d_n\) -s.

+

If dih_type = 1, then a combined bending torsional (CBT) potential +is employed,

+
+\[V_4(\phi,\gamma;\lambda) = + V_4(\phi;\lambda) + + + \frac{1}{2}K(\phi)(\gamma - \gamma_0)^2,\]
+

where \(V_4(\phi;\lambda)\) specifies the potential as given by the +coiling propensity parameter above, \(K(\phi)\) is a separate cosine +series potential acting as the angular three-particle bond strength, and +\(\gamma_0\) is the three-particle bond equilibrium angle. In this +case, the coeffs parameter must specify both a \(\lambda\) +value, in additon to the energy and phases dictating the \(K(\phi)\) +potential.

+

References

+

Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018.

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
atom_4str

Type name of particle 4.

+
+
coeffslist[list[float]] or list[float] or numpy.ndarray

Dihedral coefficients defining the series expansion of the dihedral +energy.

+
+
dih_typeint

Specifies the type of dihedral used; If 0, then coeffs +must contain either two lists of five energy coefficients +\(c_n\) and five propensity phases \(d_n\) or a single +floating point number defining the \(\lambda\) coiling propensity +parameter. If 1, the combined bending-torsional potential is +used, and coeffs must specify \(\lambda\) and two lists +containing energy coefficients and propensity phases for the +\(V_\text{prop}\) propensity potential, defined in terms of cosine +series.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+atom_3: str
+
+ +
+
+atom_4: str
+
+ +
+
+coeffs: numpy.ndarray
+
+ +
+
+dih_type: int
+
+ +
+ +
+
+hymd.force.compute_angle_forces__plain(f_angles, r, bonds_3, box_size)[source]
+

Computes forces resulting from angular interactions

+
+

Deprecated since version 1.0.0: compute_angle_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_bond_forces__plain(f_bonds, r, bonds_2, box_size)[source]
+

Computes forces resulting from bonded interactions

+
+

Deprecated since version 1.0.0: compute_bond_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size)[source]
+

Computes forces resulting from dihedral interactions

+
+

Deprecated since version 1.0.0: compute_dihedral_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.dipole_forces_redistribution(f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb)[source]
+

Redistribute electrostatic forces calculated from topologically +reconstructed ghost dipole point charges to the backcone atoms of the protein.

+
+ +
+
+hymd.force.find_all_paths(G, u, n)[source]
+

Helper function that recursively finds all paths of given lenght ‘n + 1’ inside a network ‘G’. +Adapted from https://stackoverflow.com/a/28103735.

+
+ +
+
+hymd.force.prepare_bonds(molecules, names, bonds, indices, config, topol=None)[source]
+

Rearrange the bond information for usage in compiled Fortran kernels

+

Restructures the lists resulting from the execution of +prepare_bonds_old into numpy arrays suitable for calls to optimized +Fortran code calculating bonded forces and energiesself.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2_atom_1(B,) numpy.ndarray

Local index of particle 1 for each of B constructed +two-particle bonds.

+
+
bonds_2_atom_2(B,) numpy.ndarray

Local index of particle 2 for each of B constructed +two-particle bonds.

+
+
bonds_2_equilibrium(B,) numpy.ndarray

Equilibrium distance for each of B constructed two-particle +bonds.

+
+
bonds_2_strength(B,) numpy.ndarray

Bond strength for each of B constructed two-particle +bonds.

+
+
bonds_3_atom_1(A,) numpy.ndarray

Local index of particle 1 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_2(A,) numpy.ndarray

Local index of particle 2 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_3(A,) numpy.ndarray

Local index of particle 3 for each of A constructed +three-particle bonds.

+
+
bonds_3_equilibrium(A,) numpy.ndarray

Equilibrium angle for each of A constructed three-particle +bonds.

+
+
bonds_3_strength(A,) numpy.ndarray

Bond strength for each of A constructed three-particle +bonds.

+
+
bonds_4_atom_1(D,) numpy.ndarray

Local index of particle 1 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_2(D,) numpy.ndarray

Local index of particle 2 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_3(D,) numpy.ndarray

Local index of particle 3 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_4(D,) numpy.ndarray

Local index of particle 4 for each of D constructed +four-particle bonds.

+
+
bonds_4_coeff(D,) numpy.ndarray

Cosine series coefficients for each of D constructed +four-particle bonds.

+
+
bonds_4_type(D,) numpy.ndarray

Dihedral type for each of D constructed four-particle +bonds.

+
+
bonds_4_last(D,) numpy.ndarray

Flags indicating if dih_type is 1 for each of D +constructed four-particle bonds.

+
+
+
+
+
+

See also

+
+
prepare_bonds_old

Used internally to reconstruct the bonded interactions types from the connectivity information in the structure/topology input file and the bonded types specified in the configuration file.

+
+
+ +
+ +
+
+hymd.force.prepare_bonds_old(molecules, names, bonds, indices, config)[source]
+

Find bonded interactions from connectivity and bond types information

+
+

Deprecated since version 1.0.0: prepare_bonds_old was replaced by prepare_bonds for +use with compiled Fortran kernels prior to 1.0.0 release.

+
+

Prepares the necessary equilibrium and bond strength information needed by +the intramolecular interaction functions. This is performed locally on each +MPI rank, as the domain decomposition ensures that for all molecules all +consituent particles are always contained on the same MPI rankself.

+

This function traverses the bond connectivity information provided in the +structure/topology input file and indentifies any two-, three-, or +four-particle potential bonds. For each connected chain of two, three, or +four particles, a matching to bond types is attempted. If the corresponding +names match, a bond object is initialized.

+

In order to investigate the connectivity, a graph is created using +networkx functionality.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2list

List of lists containing local particle indices, equilibrium +distance, and bond strength coefficient for each reconstructed +two-particle bond.

+
+
bonds_3

List of lists containing local particle indices, equilibrium angle, +and bond strength coefficient for each reconstructed three-particle +bond.

+
+
bonds_4

List of lists containing local particle indices, dihedral type index, +and dihedral coefficients for each reconstructed four-particle +torsional bond.

+
+
bb_indexlist

List indicating the dihedral type of each four-particle bond in +bonds_4.

+
+
+
+
+
+

See also

+
+
Bond

Two-particle bond type dataclass.

+
+
Angle

Three-particle angular bond type dataclass.

+
+
Dihedral

Four-particle torsional bond type dataclass.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+hymd.force.prepare_index_based_bonds(molecules, topol)[source]
+
+ +
+
+hymd.force.propensity_potential_coeffs(x: float)[source]
+
+ +
+
+

4.6. Pressure

+
+
+hymd.pressure.comp_pressure(phi, phi_q, psi, hamiltonian, velocities, config, phi_fourier, phi_laplacian, phi_transfer, positions, bond_pr, angle_pr, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Computes total internal pressure of the system. +Kinetic pressure is trivially calculated from the kinetic energy. +Already computed bond and angle pressure terms are inserted into the +total internal pressure. +The field pressure equation is implemented.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fourierlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pressure(18,) numpy.ndarray

Pressure contributions from various energy terms. +0: due to kinetic energy +1-5: due to field energy +6-8: due to two-particle bonded terms +9-11: due to three-particle bonded terms (called angle terms) +12-14: due to four-particle bonded terms (called dihedral terms) +(defaults to 0 currently. Yet to be implemented) +15-17: total pressure in x,y,z directions.

+
+
+
+
+
+ +
+
+

4.7. Logger

+
+
+class hymd.logger.Logger[source]
+

Log output handler class

+

Notes

+

This wraps the default python library logging, see +docs.python.org/3/library/logging.html.

+
+
Attributes:
+
+
levelint

Determines the verbosity level of the log, corresponding to +logging.level. Numerical values 50 (logging.CRITICAL), +40 (logging.ERROR), 30 +(logging.WARNING), 20 (logging.INFO), +10 (logging.DEBUG), and 0 +(logging.UNSET) are supported values. Any log event message +less severe than the specified level is ignored. All other event +messages are emitted.

+
+
log_filestr

Path to output log file.

+
+
formatstr

Prepended dump string for each log event. Specifies the log event +level, the module emitting the event, the code line, the enclosing +function name, and the MPI rank writing the message.

+
+
date_formatstr

Prepends the date before all log event messages.

+
+
formatterlogging.Formatter

Formatter handling the prepending of the information in format and +date_format to each log event message. Used by default for all +loggers.

+
+
rank0logging.Logger

Default logger object for the root MPI rank.

+
+
all_rankslogging.Logger

Default logger object for messages being emitted from all MPI ranks +simultaneously.

+
+
+
+
+
+
+classmethod setup(default_level=20, log_file=None, verbose=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Sets up the logger object.

+

If a log_file path is provided, log event messages are output +to it. Otherwise, the logging messages are emitted to stdout.

+
+
Parameters:
+
+
default_levelint, optional

Default verbosity level of the logger. Unless specified, it is +10 (logging.INFO).

+
+
log_filestr, optional

Path to output log file. If None or not priovided, no log file is +used and all logging is done to stdout.

+
+
verbosebool, optional

Increases the logging level to 30 (logging.WARNING) +if True, otherwise leaves the logging level unchanged.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterRoot(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the root MPI rank log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterAll(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the all-MPI-ranks log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+

4.8. Input parser

+

Parses and handles the configuration information provided for the simulation

+
+
+class hymd.input_parser.Config(n_steps: int, time_step: float, mesh_size: Union[List[int], numpy.ndarray, int], sigma: float, kappa: float, dtype: Optional[numpy.dtype] = None, box_size: Optional[Union[List[float], numpy.ndarray]] = None, n_print: Optional[int] = None, tau: Optional[float] = None, start_temperature: Optional[Union[float, bool]] = None, target_temperature: Optional[Union[float, bool]] = None, mass: Optional[float] = None, hamiltonian: Optional[str] = None, domain_decomposition: Optional[Union[int, bool]] = None, integrator: Optional[str] = None, respa_inner: int = 1, file_name: str = '<config file path unknown>', name: Optional[str] = None, tags: List[str] = <factory>, bonds: List[hymd.force.Bond] = <factory>, angle_bonds: List[hymd.force.Angle] = <factory>, dihedrals: List[hymd.force.Dihedral] = <factory>, chi: List[hymd.force.Chi] = <factory>, n_particles: Optional[int] = None, max_molecule_size: Optional[int] = None, n_flush: Optional[int] = None, thermostat_work: float = 0.0, thermostat_coupling_groups: List[List[str]] = <factory>, initial_energy: Optional[float] = None, cancel_com_momentum: Union[int, bool] = False, coulombtype: Optional[str] = None, convergence_type: Optional[str] = None, pol_mixing: Optional[float] = None, dielectric_const: Optional[float] = None, conv_crit: Optional[float] = None, dielectric_type: List[hymd.force.Dielectric_type] = <factory>, self_energy: Optional[float] = None, type_charges: Optional[Union[List[float], numpy.ndarray]] = None, rho0: Optional[float] = None, a: Optional[float] = None, pressure: bool = False, barostat: Optional[str] = None, barostat_type: Optional[str] = None, tau_p: Optional[float] = None, target_pressure: List[hymd.barostat.Target_pressure] = <factory>, n_b: Optional[int] = None, m: List[float] = <factory>)[source]
+

Configuration object

+

Handles and verifies the simulation configuration specified in the +configuration file.

+
+

See also

+
+
hymd.input_parser.Bond

Two-particle bond type dataclass.

+
+
hymd.input_parser.Angle

Three-particle bond type dataclass.

+
+
hymd.input_parser.Dihedral

Four-particle bond type dataclass.

+
+
+ +
+
Attributes:
+
+
gas_constantfloat

Constant value of the gas constant, R (equivalently the Boltzmann +constant) in the units used internally in HyMD.

+
+
coulomb_constantfloat

Constant value of the Coulomb constant which converts electric field +values to forces and electric potential values to energies in the units +used internally in HyMD.

+
+
n_steps: int

Number of time steps in the simulation.

+
+
time_step: float

Outer time step used in the simulation. If the rRESPA intergrator is +used, the inner time step (the time step used in the integration of +intramolecular bending, stretching, and torsional forces) is +time_step / respa_inner.

+
+
box_sizelist[float] or (D,) numpy.ndarray

Simulation box size of simulation in D dimensions in units of +nanometers.

+
+
mesh_sizelist[int] or int or numpy.ndarray

Number of grid points used for the discrete density grid.

+
+
sigmafloat

Filter width representing the effective coarse-graining level of the +particles in the simulation.

+
+
kappafloat

Compressibility parameter used in the relaxed incompressibility term in +the interaction energy functional.

+
+
n_printint, optional

Frequency of trajectory/energy output to the H5MD trajectory/energy +output file (in units of number of time steps).

+
+
taufloat, optional

The time scale of the CSVR thermostat coupling.

+
+
start_temperaturefloat, optional

Generate starting temperature by assigning all particle velocities +randomly according to the Maxwell-Boltzmann distribution at +start_temperature Kelvin prior to starting the simulation.

+
+
target_temperaturefloat, optional

Couple the system to a heat bath at target_temperature Kelvin.

+
+
massfloat, optional

Mass of the particles in the simulation.

+
+
hamiltonianstr, optional

Specifies the interaction energy functional \(W[\tilde\phi]\) +for use with the particle-field interactions. Options: +SquaredPhi, DefaultNohChi, or DefaultWithChi.

+
+
domain_decompositionint, optional

Specifies the interval (in time steps) of domain decomposition +exchange, involving all MPI ranks sending and receiving particles +according to the particles’ positions in the integration box and the +MPI ranks’ assigned domain.

+
+
integratorstr, optional

Specifies the time integrator used in the simulation. Options: +velocity-verlet or respa.

+
+
respa_innerint, optional

The number of inner time steps in the rRESPA integrator. This denotes +the number of intramolecular force calculations (stretching, bending, +torsional) are performed between each impulse applied from the field +forces.

+
+
file_namestr, optional

File path of the parsed configuration file.

+
+
namestr, optional

Name for the simulation.

+
+
tagslist[str], optional

Tags for the simulation.

+
+
bondslist[Bond], optional

Specifies harmonic stretching potentials between particles in the +same molecule.

+
+
angle_bondslist[Angle], optional

Specifies harmonic angular bending potentials between particles in the +same molecule.

+
+
dihedralslist[Dihedral], optional

Specifies four-particle torsional potentials by cosine series.

+
+
chilist[Chi], optional

Specifies \(\chi\)-interaction parameters between particle +species.

+
+
n_particlesint, optional

Specifies the total number of particles in the input. Optional keyword +for validation, ensuring the input HDF5 topology has the correct number +of particles and molecules.

+
+
max_molecule_sizeint, optional

Maximum size of any single molecule in the system. Used to speed up +distribution of particles onto MPI ranks in a parallel fashion.

+
+
n_flushint, optional

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be +written to disk (in units of number of n_print).

+
+
thermostat_workfloat

Work performed by the thermostat on the system.

+
+
thermostat_coupling_groupslist[str], optional

Specifies individual groups coupling independently to the CSVR +thermostat. E.g. in a system containing "A", "B", and +"C" type particles, +thermostat_coupling_groups = [["A", "B"], ["C"],] would +thermalise types "A" and "B" together and couple +"C" type particles to a different thermostat (all individual +thermostats are at the same temperature, i.e. target_temperature +Kelvin).

+
+
initial_energyfloat

Value of the total energy prior to the start of the simulation.

+
+
cancel_com_momentumint, optional

If True, the total linear momentum of the center of mass is +removed before starting the simulation. If an integer is specifed, the +total linear momentum of the center of mass is removed every +remove_com_momentum time steps. If False, the linear +momentum is never removed.

+
+
coulombtypestr, optional

Specifies the type of electrostatic Coulomb interactions in the system. +The strength of the electrostatic forces is modulated by the relative +dielectric constant of the simulation medium, specified with the +dielectric_const keyword. Charges for individual particles are +specified in the structure/topology HDF5 input file, not in the +configuration file. If no charges (or peptide backbone dipoles) are +present, the electrostatic forces will not be calculated even if this +keyword is set to "PIC_Spectral".

+
+
dielectric_constfloat, optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. When +using helical propensity dihedrals, this keyword must be specified—even +if electrostatics are not included with the coulombtype +keyword.

+
+
dielectric_type: list[float], optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. The list assigns +relative dielectric values to each bead type, and an anisotropic +dielectric function is obtained from a weighted average.

+
+
+
+
+
+
+a: float = None
+
+ +
+
+angle_bonds: List[hymd.force.Angle]
+
+ +
+
+barostat: str = None
+
+ +
+
+barostat_type: str = None
+
+ +
+
+bonds: List[hymd.force.Bond]
+
+ +
+
+box_size: Union[List[float], numpy.ndarray] = None
+
+ +
+
+cancel_com_momentum: Union[int, bool] = False
+
+ +
+
+chi: List[hymd.force.Chi]
+
+ +
+
+conv_crit: float = None
+
+ +
+
+convergence_type: str = None
+
+ +
+
+coulomb_constant: ClassVar[float] = 138.935458
+
+ +
+
+coulombtype: str = None
+
+ +
+
+dielectric_const: float = None
+
+ +
+
+dielectric_type: List[hymd.force.Dielectric_type]
+
+ +
+
+dihedrals: List[hymd.force.Dihedral]
+
+ +
+
+domain_decomposition: Union[int, bool] = None
+
+ +
+
+dtype: numpy.dtype = None
+
+ +
+
+file_name: str = '<config file path unknown>'
+
+ +
+
+gas_constant: ClassVar[float] = 0.0083144621
+
+ +
+
+hamiltonian: str = None
+
+ +
+
+initial_energy: float = None
+
+ +
+
+integrator: str = None
+
+ +
+
+kappa: float
+
+ +
+
+m: List[float]
+
+ +
+
+mass: float = None
+
+ +
+
+max_molecule_size: int = None
+
+ +
+
+mesh_size: Union[List[int], numpy.ndarray, int]
+
+ +
+
+n_b: int = None
+
+ +
+
+n_flush: int = None
+
+ +
+
+n_particles: int = None
+
+ +
+
+n_print: int = None
+
+ +
+
+n_steps: int
+
+ +
+
+name: str = None
+
+ +
+
+pol_mixing: float = None
+
+ +
+
+pressure: bool = False
+
+ +
+
+respa_inner: int = 1
+
+ +
+
+rho0: float = None
+
+ +
+
+self_energy: float = None
+
+ +
+
+sigma: float
+
+ +
+
+start_temperature: Union[float, bool] = None
+
+ +
+
+tags: List[str]
+
+ +
+
+target_pressure: List[hymd.barostat.Target_pressure]
+
+ +
+
+target_temperature: Union[float, bool] = None
+
+ +
+
+tau: float = None
+
+ +
+
+tau_p: float = None
+
+ +
+
+thermostat_coupling_groups: List[List[str]]
+
+ +
+
+thermostat_work: float = 0.0
+
+ +
+
+time_step: float
+
+ +
+
+type_charges: Union[List[float], numpy.ndarray] = None
+
+ +
+ +
+
+hymd.input_parser.check_NPT_conditions(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check validity of barostat_type, barostat, +a, rho0, target_pressure, tau_p

+
+ +
+
+hymd.input_parser.check_angles(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_bonds(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_box_size(config, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_cancel_com_momentum(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_charges(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if charges across ranks sum to zero.

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of floats with charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_charges_types_list(config, types, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates a list of charge values of length types. +Charges are sorted according to type ID. Used in field.py. +# TODO: this is messy, we should fix it

+
+ +
+
+hymd.input_parser.check_chi(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_config(config, indices, names, types, charges, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs various checks on the specfied config to ensure consistency

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
indices(N,) numpy.ndarray

Array of integer indices for N particles.

+
+
names(N,) numpy.ndarray

Array of string names for N particles.

+
+
types(N,) numpy.ndarray

Array of integer type indices for N particles.

+
+
charges(N,) numpy.ndarray

Array of floats charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
Returns:
+
+
configConfig

Validated configuration object.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_dielectric(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Error handling for electrostatics. +Unit testing of toml/tomli input.

+
+ +
+
+hymd.input_parser.check_dihedrals(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_domain_decomposition(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_hamiltonian(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_integrator(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_m(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_mass(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_max_molecule_size(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_b(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_flush(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_particles(config, indices, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_print(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_name(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_start_and_target_temperature(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Validate provided starting and target thermostat temperatures

+

Assesses the provided temperature target and ensures it is a non-negative +floating point number or False. Ensures the starting temperature is +a non-negative floating point number or False.

+

If the value for either is None, the returned configuration object +has the values defaulted to False in each case.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
validated_configConfig

Configuration object with validated target_temperature and +start_temperature.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_tau(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_thermostat_coupling_groups(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.parse_config_toml(toml_content, file_path=None, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.read_config_toml(file_path)[source]
+
+ +
+
+hymd.input_parser.sort_dielectric_by_type_id(config, charges, types)[source]
+

Creates a list of length N CG-particles, sorted after the charges from +the input HDF5 file. Used in file_io.py

+
+ +
+
+

4.9. Field

+

Forces and energies from the discretized particle-field grid interactions

+
+
+hymd.field.compute_field_and_kinetic_energy(phi, phi_q, psi, velocity, hamiltonian, positions, types, v_ext, config, layouts, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the particle-field and kinetic energy contributions

+

Calculates the kinetic energy through

+
+\[E_k = \sum_j \frac{1}{2}m_j\mathbf{v}_j\cdot\mathbf{v}_j,\]
+

and the particle-field energy by

+
+\[E_\text{field} = \int\mathrm{d}\mathbf{r}\, + w[\tilde\phi],\]
+

where \(w\) is the interaction energy functional density.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
velocity(N,D) numpy.ndarray

Array of velocities for N particles in D dimensions. +Local for each MPI rank.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Local for each MPI rank–the full computational grid is +represented by the collective fields of all MPI ranks.

+
+
configConfig

Configuration object.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field

Computes the up-to-date external potential for use in calculating the particle-field energy.

+
+
+ +
+ +
+
+hymd.field.compute_field_energy_q_GPE(config, phi_eps, field_q_energy, dot_elec, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the electrostatic energy after electrosatic forces is +calculated.

+

From the definition of the elecrostatic potential \(\Psi\), the energy +is

+
+
+
W = frac{1}{2}intmathrm{d}mathbf{r},

epsilon(mathbf{r})} left(mathbf{E}cdot mathbf{E}right),

+
+
+
+

where \(\epsilon(\mathbf{r})}\) is the anisotropic, spatially dependent, +relative dielectric of the simulation medium.

+
+
Parameters:
+
+
confighymd.input_parser.Config

Configuration object.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
field_q_energyfloat

Total elecrostatic energy.

+
+
dot_elecpmesh.pm.RealField

Pmesh RealField object for storing \(|\mathbf{E(r)}|^{2}\) +on the computational grid. Local for each MPI rank – the full computational +grid is represented by the collective fields of all MPI ranks.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field_force_q_GPE

Compute the electrosatic force from an anisotropic dielectric general Poisson equation.

+
+
+ +
+ +
+
+hymd.field.compute_field_force(layouts, r, force_mesh, force, types, n_types)[source]
+

Interpolate particle-field forces from the grid onto particle positions

+

Backmaps the forces calculated on the grid to particle positions using the +window function \(P\) (by default cloud-in-cell [CIC]). In the +following, let \(\mathbf{F}_j\) denote the force acting on the +particle with index \(j\) and position \(\mathbf{r}_j\). The +interpolated force is

+
+\[\mathbf{F}_j = -\sum_k\nabla V_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(V_{j_k}\) is the discretized external potential at grid vertex +\(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid vertex +with index \(j_k\), and \(h^3\) is the volume of each grid voxel. +The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
r(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
force(N,D) numpy.ndarray

Array of forces for N particles in D dimensions. Local +for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
n_typesint

Number of different unique types present in the simulation system. +n_types is global, i.e. the same for all MPI ranks even if some +ranks contain zero particles of certain types.

+
+
+
+
+
+ +
+
+hymd.field.compute_self_energy_q(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the self energy for the interaction due to the Ewald scheme +used to compute the electrostatics. The energy is stored in config.

+

The self interaction energy is given by:

+
+\[U_{self} = \sqrt{\frac{1}{2\pi\sigma^2}} \sum_{i=1}^{N} q_i^2\]
+

where \(q_i\) are the charges and \(\sigma\) is the half-width +of the Gaussian filter.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
Returns:
+
+
field_q_self_energyfloat

Electrostatic self energy.

+
+
+
+
+
+ +
+
+hymd.field.domain_decomposition(positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs domain decomposition

+

Rearranges the MPI rank memory layout into one that better mimics the PFFT +pencil grid 2D decomposition. As molecules are always required to be fully +contained on a single MPI rank, a perfect decomposition is not always +possible. The best decomposition which leaves the center of mass of all +molecules in their respective correct domains is used, with possible +overlap into neighbouring domains if the spatial extent of any molecule +crosses domain boundaries.

+
+
Parameters:
+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
*args

Variable length argument list containing arrays to include in the +domain decomposition.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
bonds(N,M) numpy.ndarray, optional

Array of M bonds originating from each of N particles.

+
+
verboseint, optional

Specify the logging event verbosity of this function.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
Domain decomposedcode:positions and any array specified in
+
:code:`*args`, in addition tocode:bonds and molecules if these
+
arrays were provided as input.
+
+
+
+
+ +
+
+hymd.field.initialize_pm(pmesh, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates the necessary pmesh objects for pfft operations.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pmobject ‘pmesh.pm.ParticleMesh’
+
field_listlist[pmesh.pm.RealField], (multiple)

Essential list of pmesh objects required for MD

+
+
list_coulomblist[pmesh.pm.RealField], (multiple)

Additional list of pmesh objects required for electrostatics.

+
+
+
+
+
+ +
+
+hymd.field.update_field(phi, phi_laplacian, phi_transfer, layouts, force_mesh, hamiltonian, pm, positions, types, config, v_ext, phi_fourier, v_ext_fourier, m, compute_potential=False)[source]
+

Calculate the particle-field potential and force density

+

If compute_potential is True, the energy may subsequently +be computed by calling compute_field_and_kinetic_energy.

+

Computes the particle-field external potential \(V_\text{ext}\) from +particle number densities through the smoothed density field, +\(\phi(\mathbf{r})\). With \(P\) being the cloud-in-cell (CIC) +window function, the density and filtered densities are computed as

+
+\[\phi(\mathbf{r}) = \sum_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\phi(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +external potential is computed in reciprocal space as

+
+\[V_\text{ext} = \mathrm{FFT}^{-1}\left[ + \mathrm{FFT} + \left( + \frac{\partial w}{\partial \tilde\phi} + \right) + \mathrm{FFT}(H) +\right],\]
+

where \(w\) is the interaction energy functional. Differentiating +\(V_\text{ext}\) is done by simply applying \(i\mathbf{k}\) in +Fourier space, and the resulting forces are back-transformed to direct +space and interpolated to particle positions by

+
+\[\mathbf{F}_j = -\sum_{j_k} \nabla V_{j_k} + P(\mathbf{r}_{j_k} - \mathbf{r}_j)h^3,\]
+

where \(j_k\) are the neighbouring vertices of particle \(j\) at +position \(\mathbf{r}_j\), and \(h^3\) is the volume of each grid +voxel.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Pre-allocated, but empty; any values +in this field are discarded. Changed in-place. Local for each MPI +rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
configConfig

Configuration object.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Pre-allocated, but empty; any values in this field are +discarded Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
phi_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computational grid is represented by the collective fields of all +MPI ranks.

+
+
v_ext_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplesField objects containing discretized +particle-field external potential values in reciprocal space on the +computational grid; D+1 fields in D dimensions for each +particle type. D copies are made after calculation for later +use in force calculation, because the force transfer function +application differentiates the field in-place, ruining the contents +for differentiation in the remaining D-1 spatial directions. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
m: list[float], (M,)

pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. +Defaults to 1.0 for all particle types.

+
+
compute_potentialbool, optional

If True, a D+1-th copy of the Fourier transformed +external potential field is made to be used later in particle-field +energy calculation. If False, only D copies are made.

+
+
+
+
+
+

See also

+
+
compute_field_and_kinetic_energy

Compute the particle-field energy after the external potential is calculated.

+
+
+ +
+ +
+
+hymd.field.update_field_force_q(charges, phi_q, phi_q_fourier, psi, psi_fourier, elec_field_fourier, elec_field, elec_forces, layout_q, hamiltonian, pm, positions, config)[source]
+

Calculate the electrostatic particle-field forces on the grid

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential is computed in reciprocal space as

+
+\[\Phi = \mathrm{FFT}^{-1}\left[ + \frac{4\pi k_e}{\varepsilon \vert\mathbf{k}\vert^2} + \mathrm{FFT}(\rho)\mathrm{FFT}(H) +\right],\]
+

with the electric field

+
+\[\mathbf{E} = \mathrm{FFT}^{-1}\left[ + -i\mathbf{k}\,\mathrm{FFT}(\Psi) +\right].\]
+

In the following, let \(\mathbf{F}_j\) denote the electrostatic force +acting on the particle with index \(j\) and position +\(\mathbf{r}_j\). The interpolated electrostatic force is

+
+\[\mathbf{F}_j = \sum_k q_j\mathbf{E}_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(\mathbf{E}_{j_k}\) is the discretized electric field at grid +vertex \(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid +vertex with index \(j_k\), and \(h^3\) is the volume of each grid +voxel. The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty; any values in this field +are discarded. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
elec_field_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +electric field values in reciprocal space on the computational grid. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
+
+
+
+ +
+
+hymd.field.update_field_force_q_GPE(conv_fun, phi, types, charges, phi_q, phi_q_fourier, phi_eps, phi_eps_fourier, phi_eta, phi_eta_fourier, phi_pol_prev, phi_pol, elec_field, elec_forces, elec_field_contrib, psi, Vbar_elec, Vbar_elec_fourier, force_mesh_elec, force_mesh_elec_fourier, hamiltonian, layout_q, layouts, pm, positions, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Calculate the electrostatic particle-field forces on the grid, arising from +a general Poisson equation, i.e. anisotropic permittivity/dielectric. +The function is called when tomli input config.coulombtype = “PIC_Spectral_GPE.”

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential for a variable dielectric does not have an +analytical expression, and is computed in reciprocal through an iterative +method.

+

The GPE states that

+
+\[\nabla \cdot \left(\epsilon(\mathbf{r}) +\nabla{\mathbf{\psi(r)}}\right) = -\rho({\mathbf{r}}).\]
+

where \(\epsilon(\mathbf{r})\) is the relative dielectric function.

+
+
Parameters:
+
+
conv_funConvergence function.

Returns a scalar. Depends on MPI allreduce for similar convergence +across MPI ranks.

+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_eps_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_etapmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +gradients of the relative dielectric values on the computational grid. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank–the +full computational grid is represented by the collective fields of all MPI ranks.

+
+
phi_eta_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated discretized +Fourier transformed gradient relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_pol_prevpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charge values on the computational grid. Parameter in +the iterative method.Pre-allocated,but empty. Changedin-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_polpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charges on the computational grid. Parameter in the iterative +method, updating the next quess in solving for the electrostatic potential. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank– +the full computational grid is represented by the collective fields of +all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all +MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
elec_field_contribpmesh.pm.RealField

Pmesh RealField object for storing +\(|\mathbf{E(r)}|^2/\phi_{0}\) on the computational grid. +Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
psipmesh.pm.RealField

Pmesh RealField object for storing electrostatic potential +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
Vbar_elecmesh.pm.RealField

Pmesh RealField object for storing functional derivatives of +:math:`|w({ phi })_{elec}`on the computational grid. +Pre-allocated, but empty. Changed in-place. Local for each MPI rank– +the full computational grid is represented by the collective fields of

+
+

all MPI ranks.

+
+
+
Vbar_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated functional +derivatives of \(\|w(\{ \phi \})_{elec}\) in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
force_mesh_elecpmesh.pm.RealField

Pmesh RealField object for storing electrostatic force values +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
force_mesh_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated electrostatic +force values in reciprocal space on the computational grid. Local for +each MPI rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
layouts: list[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
comm: mpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
compute_field_energy_q_GPE

Compute the electrostatic energy after electrosatic force is calculated for a variable (anisotropic) dielectric general Poisson equation.

+
+
+ +
+ +
+
+

4.10. File input/output

+

Handle file input/output in parllel HDF5 fashion

+
+
+class hymd.file_io.OutDataset(dest_directory, config, double_out=False, disable_mpio=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

HDF5 dataset handler for file output

+
+
+close_file(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Closes the HDF5 output file

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+
+flush()[source]
+

Flushes output buffers, forcing file writes

+
+ +
+
+is_open(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if HDF5 output file is open

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+ +
+
+hymd.file_io.distribute_input(in_file, rank, size, n_particles, max_molecule_size=201, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Assign global arrays onto MPI ranks, attempting load balancing

+

Distributes approximately equal numbers of particles (workload) onto each +independent MPI rank, while respecting the requirement that any molecule +must be fully contained on a single MPI rank only (no splitting molecules +across multiple CPUs).

+
+
Parameters:
+
+
in_fileh5py.File

HDF5 input file object.

+
+
rankint

Local rank number for this MPI rank.

+
+
sizeint

Global size of the MPI communicator (number of total CPUs).

+
+
n_particlesint

Total number of particles.

+
+
max_molecule_sizeint, optional

Maximum size of any molecule present in the system. Used to initially +guess where the MPI rank boundaries (start/end indices) in the global +arrays should be placed. If molecules of size +>max_molecule_size exist in the simulation system, HyMD +might work as expected. Or it might fail spectacularly.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
rank_range

Starting and ending indices in the global arrays for each MPI rank.

+
+
+
+
+
+ +
+
+hymd.file_io.setup_time_dependent_element(name, parent_group, n_frames, shape, dtype, units=None)[source]
+

Helper function for setting up time-dependent HDF5 group datasets

+

All output groups must adhere to the H5MD standard, meaning a structure of

+
+
┗━ group particle group (e.g. all) or observables group
+
+
┗━ group time-dependent data
+
+
┣━ dataset step shape=(n_frames,)
+
┣━ dataset time shape=(n_frames,)
+
┗━ dataset value shape=(n_frames, *)
+
+
+
+

is necessary.

+

References

+
+
H5MD specification :

https://www.nongnu.org/h5md/h5md.html

+
+
+
+ +
+
+hymd.file_io.store_data(h5md, step, frame, indices, positions, velocities, forces, box_size, temperature, pressure, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, field_energy, field_q_energy, plumed_bias, time_step, config, velocity_out=False, force_out=False, charge_out=False, plumed_out=False, dump_per_particle=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Writes time-step data to HDF5 output file

+

Handles all quantities which change during simulation, as opposed to +static quanitities (see store_static).

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
stepint

Step number.

+
+
frameint

Output frame number (step // n_print).

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
positions(N,) numpy.ndarray

Array of positions for N particles in D dimensions.

+
+
velocities(N,) numpy.ndarray

Array of velocities for N particles in D dimensions.

+
+
forces(N,) numpy.ndarray

Array of forces for N particles in D dimensions.

+
+
box_size(D,) numpy.ndarray

Array containing the simulation box size.

+
+
temperaturefloat

Calculated instantaneous temperature.

+
+
kinetic_energyfloat

Calculated instantaneous kinetic energy.

+
+
bond2_energyfloat

Calculated instantaneous harmonic two-particle bond energy.

+
+
bond3_energyfloat

Calculated instantaneous harmonic angular three-particle bond energy.

+
+
bond4_energyfloat

Calculated instantaneous dihedral four-particle torsion energy.

+
+
field_energyfloat

Calculated instantaneous particle-field energy.

+
+
field_q_energyfloat

Calculated instantaneous electrostatic energy.

+
+
plumed_biasfloat

PLUMED instantaneous bias energy.

+
+
time_stepfloat

Value of the time step.

+
+
configConfig

Configuration object.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charge_outbool, optional

If True, electrostatic energies are written to the output +HDF5 file.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to the output HDF5 file.

+
+
dump_per_particlebool, optional

If True, all quantities are written per particle.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
store_static

Outputs all static time-independent quantities to the HDF5 output file

+
+
+ +
+ +
+
+hymd.file_io.store_static(h5md, rank_range, names, types, indices, config, bonds_2_atom1, bonds_2_atom2, molecules=None, velocity_out=False, force_out=False, charges=False, dielectrics=False, plumed_out=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Outputs all static time-independent quantities to the HDF5 output file

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
rank_rangelist[int]

Start and end indices for global arrays for each MPI rank.

+
+
names(N,) numpy.ndarray

Array of names for N particles.

+
+
types(N,) numpy.ndarray

Array of type indices for N particles.

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
configConfig

Configuration object.

+
+
bonds_2_atom1(B,) numpy.ndarray

Array of indices of the first particle for B total +two-particle bonds.

+
+
bonds_2_atom2(B,) numpy.ndarray

Array of indices of the second particle for B total +two-particle bonds.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles.

+
+
dielectrics(N,) numpy.ndarray

Array of particle relative dielectric values for N particles.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to output HDF5 file.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
prepare_bonds

Constructs two-, three-, and four-particle bonds from toplogy input file and bond configuration information.

+
+
distribute_input

Distributes input arrays onto MPI ranks, attempting load balancing.

+
+
+ +
+ +
+
+

4.11. PLUMED

+

Class to wrap PLUMED for use within HyMD.

+
+
+class hymd.plumed.PlumedBias(config, plumeddat, logfile, intracomm=<mpi4py.MPI.Intracomm object>, intercomm=None, verbose=1)[source]
+

PLUMED handler class

+

Notes

+

This wraps the Plumed() class, see +https://github.com/plumed/plumed2/tree/master/python.

+

The PlumedBias() object is created with the arguments from +__init__ and at everystep the methods prepare() and +calc() should be called.

+
+
Attributes:
+
+
plumed_objplumed.Plumed

Plumed object used to pass and request information from PLUMED.

+
+
plumed_forces(N, D) numpy.ndarray

Array of forces of N particles in D dimensions. +After calc(), this array contains only the forces due +to the PLUMED bias.

+
+
positions(N, D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank. +Needed because we need C-contiguous array for passing to PLUMED.

+
+
plumed_bias(1,) numpy.ndarray

Used as a pointer to an double to store the bias energy.

+
+
plumed_version(1,) numpy.ndarray

Used as a pointer to an int to store PLUMED API version.

+
+
intracommmpi4py.Comm

MPI communicator to use for rank communication within a replica.

+
+
intercommmpi4py.Comm

MPI communicator to use for rank communication between replicas.

+
+
readybool

Stores wether the calc() method can be called or not.

+
+
+
+
+
+
+property api_version
+

Returns the API version got from the PLUMED kernel.

+
+ +
+
+calc(forces, poteng)[source]
+

Passes the energy (which can be set to any value in case +prepare() returns PLUMED doesn’t need it) to get +the forces and energy from the bias.

+
+ +
+
+finalize()[source]
+

Finalize object

+
+ +
+
+prepare(step, forces, positions, indices, config, charges)[source]
+

Set the pointers to positions and forces, and returns +wether the potential energy is being requested by PLUMED or not.

+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/doc_pages/benchmarks.html b/v2.1.0/doc_pages/benchmarks.html new file mode 100644 index 00000000..353511a6 --- /dev/null +++ b/v2.1.0/doc_pages/benchmarks.html @@ -0,0 +1,322 @@ + + + + + + + 3. Benchmarks — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Benchmarks

+

Homopolymer melt test systems of \(30^2\), \(40^2\), and \(50^2\) +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively.

+
+

3.1. Bonded forces

+

Legend label denotes the number of particles in the system.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-1.png +
+
+
+

3.2. Particle–field forces

+

Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-2.png +
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/doc_pages/command_line.html b/v2.1.0/doc_pages/command_line.html new file mode 100644 index 00000000..9af950e9 --- /dev/null +++ b/v2.1.0/doc_pages/command_line.html @@ -0,0 +1,385 @@ + + + + + + + 5. Command line arguments — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. Command line arguments

+

Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle–field interactions.

+
+

5.1. Required arguments

+
+
configuration file:
+

type positional

+

Specifies the .toml format configuration file containing simulation details. See Configuration file for details.

+
+
structure and topology file:
+

type positional

+

Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See Topology and structure file for details.

+
+
+
+
+

5.2. Optional arguments

+
+
-v  --verbose

type optional

+

Number of following arguments: 0 or 1

+

Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying -v or --verbose with no additional specification. This increases verbosity level by 1. Alternatively, it maye be specified by --verbose V with V being 0, 1, or 2.

+
+
--profile

type optional

+

Number of following arguments: 0

+

Enables code profiling using cProfile. This will output one profiling file per MPI rank invoked in the simulation.

+
+
--double-precision

type optional

+

Number of following arguments: 0

+

Specify usage of double precision internally in HyMD (including in the FFTs).

+
+
--double-output

type optional

+

Number of following arguments: 0

+

Specify usage of double precision in the output trajectory from HyMD.

+
+
--velocity-output

type optional

+

Number of following arguments: 0

+

Specify that velocities should be output to the HyMD trajectory.

+
+
--force-output

type optional

+

Number of following arguments: 0

+

Specify that forces should be output to the HyMD trajectory.

+
+
--disable-mpio

type optional

+

Number of following arguments: 0

+

Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult.

+
+
--logfile

type optional

+

Number of following arguments: 1

+

Specifies the path of a plain text log file in which stdout is mirrored during simulation runs.

+
+
--seed

type optional

+

Number of following arguments: 1

+

Specifies the random seed used in the numpy random library to generate velocities, thermostatting, etc.

+
+
--disable-bonds

type optional

+

Number of following arguments: 0

+

Disable any two-particle bonds present in the system.

+
+
--disable-angle-bonds

type optional

+

Number of following arguments: 0

+

Disable any three-particle bonds present in the system.

+
+
--disable-dihedrals

type optional

+

Number of following arguments: 0

+

Disable any four-particle bonds present in the system.

+
+
--disable-dipole

type optional

+

Number of following arguments: 0

+

Disable any topological reconstruction of peptide backbone dipoles present in the system.

+
+
--disable-field

type optional

+

Number of following arguments: 0

+

Disable any particle–field interactions present in the system.

+
+
--plumed

type optional

+

Input file for PLUMED when using the PLUMED interface. See PLUMED interface for details.

+
+
:code:`–plumed-outfile

type optional

+

Name of PLUMED output file when running a simulation using PLUMED.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/doc_pages/config_file.html b/v2.1.0/doc_pages/config_file.html new file mode 100644 index 00000000..233bd234 --- /dev/null +++ b/v2.1.0/doc_pages/config_file.html @@ -0,0 +1,512 @@ + + + + + + + 3. Configuration file — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Configuration file

+

The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order.

+

The configuration file is a toml format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs.

+
+

3.1. Configuration file keywords

+

The following constitutes every possible keyword specification in HyMD +configuration files:

+
+

3.1.1. Metadata keywords

+

Configuration keywords specifying metadata for the H5MD output trajectory.

+
+
name:
+

string [optional, default: None]

+

Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file.

+
+
tags:
+

array [string] [optional, default: None]

+

Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file.

+
+
+
+
+

3.1.2. Particle keywords

+

Configuration keywords specifying properties of particles and molecules in the +system.

+
+
n_particles:
+

integer [optional, default: None]

+

Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules.

+
+
mass:
+

float [optional, default: 72.0] {units: \(\text{u}=\text{g}\,\text{mol}^{-1}\)}

+

Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal.

+
+
max_molecule_size:
+

integer [optional, default: 201]

+

Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code will crash if there are molecules larger than max_molecule_size in the topology/structure input file.

+
+
+
+
+

3.1.3. Simulation keywords

+

Configuration keywords specifying simulation parameters.

+
+
n_steps:
+

integer [required]

+

Total number of integration steps to perform for this simulation.

+
+
n_print:
+

integer or boolean [optional, default: False]

+

Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of number of time steps).

+
+
n_flush:
+

integer [optional, default: None]

+

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of number of n_print, i.e. n_print = 13, n_flush = 3 would result in the trajectory/energy being written to disk every 13 x 3 = 39 simulation steps)

+
+
time_step:
+

float [required] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time step per integration step. If the rRESPA multiple time step integrator is used (integrator = "respa"), this specifies the inner time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is respa_inner times the time_step , and the total simulation time is n_steps times time_step times respa_inner .

+
+
box_size:
+

array [float] [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable.

+
+
integrator:
+

string [required] (options: velocity-verlet or respa)

+

Specifies the time integrator used in the simulation. If respa, the reversible reference system propagator algorithm (rRESPA) [Tuckerman et al., 1992] integrator is used, with respa_inner number of inner (intramolecular force) time steps. If velocity-verlet, a normal Velocity Verlet integrator is used. If respa and respa_inner = 1, the rRESPA integrator is equivalent to the Velocity Verlet.

+
+
respa_inner:
+

integer [optional, default: 1]

+

The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces.

+
+
domain_decomposition:
+

integer or boolean [optional, default: False]

+

Specifies the interval (in time steps) of domain decomposition exchange, involving all MPI ranks sending and receiving particles according to the particles’ positions in the integration box and the MPI ranks’ assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If True, the decomposition is performed once (before starting the simulation). If False, no decomposition is performed.

+
+
cancel_com_momentum:
+

integer or boolean [optional, default: False]

+

If True, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every remove_com_momentum time steps. If False, the linear momentum is never removed.

+
+
start_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at start_temperature Kelvin prior to starting the simulation. If False, the velocities are not changed before starting the simulation.

+
+
target_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Couple the system to a heat bath at target_temperature Kelvin by applying a Canonical sampling through velocity rescaling [Bussi et al., 2007] thermostat with coupling strength tau. If False, no temperature control is applied.

+
+
tau:
+

float [optional, default: 0.7] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the CSVR thermostat coupling. In the limit of tau , the Hamiltonian dynamics are preserved and no temperature coupling takes place.

+
+
thermostat_coupling_groups:
+

array [array [string]] [optional, default: []]

+

Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing "A", "B", and "C" type particles, thermostat_coupling_groups = [["A", "B"], ["C"],] would thermalise types "A" and "B" together and couple "C" type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. target_temperature Kelvin).

+
+
hamiltonian:
+

string [optional, default: "DefaultNohChi"] (options: SquaredPhi, DefaultNohChi, or DefaultWithChi)

+

Specifies the interaction energy functional \(W[\tilde\phi]\) for use with the particle-field interactions. See Interaction energy functionals for details.

+
+
+
+
+

3.1.4. Field keywords

+

Configuration keywords specifying field parameters.

+
+
mesh_size:
+

array [integer] or integer [required]

+

Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is box_size / mesh_size.

+
+
kappa:
+

float [required] {units: \(\text{kJ}^{-1}\text{mol}\)}

+

Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional \(W[\tilde\phi]\). See Interaction energy functionals for more details.

+
+
sigma:
+

float [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See Filtering for more details.

+
+
chi:
+

array [array [string, float]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\)}

+

Array of \(\tilde\chi_\text{AB}\)-parameters indicating the strength of the repulsive or attractive interaction between particles of type "A" and the number density due to particles of type "B", and vice versa. Example: chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ] would specify a repulsive "A""B" type interaction, and a weakly attractive "C""D" interaction. Self-interaction \(\tilde\chi\)-terms are always zero. See Interaction energy functionals for more details.

+
+
+
+
+

3.1.5. Bond keywords

+

Configuration keywords specifying bonds and bonds parameters.

+
+
bonds:
+

array [array [2 string, 2 float]] [optional, default: []] {units: \(\text{nm}=10^{-9}~\text{m}\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+

Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ] indicates a "A""A" bond of equilibrium length 0.47 \(\text{nm}\) with a bond strength of 980.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding bond between "A" and "B" type particles with equilibrium length 0.31 \(\text{nm}\) and a strength of 1250.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify stretching bonds.

+
+
angle_bonds:
+

array [array [3 string, 2 float]] [optional, default: []] {units: \({}^\circ\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+
+

Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ] indicates a "A""A""A" angular bond that tries to keep the bond linear at 180 degrees with a bending strength of 55.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding angle bond between "A""B""B" prefering the angle at 120 degrees and a strength of 25.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify angular bonds.

+
+
+
dihedrals:
+

array [array [4 string, integer, COSINE SERIES ]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)}

+

Specifies four-particle torsional potentials by cosine series. See Intramolecular bonds for details about how to specify dihedrals.

+
+
+
+
+

3.1.6. Electrostatic keywords

+

Configuration keywords specifying electrostatics and electrostatic parameters.

+
+
coulombtype:
+

string [optional, default: None] (options: PIC_Spectral)

+

Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the dielectric_const keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, not in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to PIC_Spectral.

+
+
dielectric_const:
+

float [optional, default: None]

+

Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified—even if electrostatics are not included with the coulombtype keyword.

+
+
+
+
+

3.1.7. Pressure keywords

+

Configuration keywords specifying pressure and barostat parameters.

+
+

3.1.7.1. Simulation keywords

+
+
pressure:
+

boolean [optional, default: False]

+

Specifies whether or not to calculate total internal pressure vector.

+
+
barostat:
+

string [optional, default: None](options: isotropic or semiisotropic)

+

Specifies whether to apply pressure constraints equally in all 3 Cartesian directions (isotropic) or equally in xy and different in z (semiisotropic).

+
+
barostat_type:
+

string [optional, default: berendsen](options: berendsen or scr)

+

Specifies the type of barostat to use. berendsen is more suitable for equilibration and scr for equilibrium data collection.

+
+
n_b:
+

integer [optional, default: 1]

+

Frequency of barostat call in number of outer rRESPA steps.

+
+
tau_p:
+

float [optional, default: 10 tau if tau < 0.1 else 1.0] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the barostat coupling.

+
+
target_pressure:
+

array [float] [optional, default: :code:1] {units: bar}

+

Couples the system to an external pressure set to target_pressure.

+
+
+
+
+

3.1.7.2. Field keywords

+
+
rho0:
+

float [optional, default: :code:average density] {units: \(\text{nm}^{-3}\)}

+

Intrinsic parameter corresponding to the specific volume of a coarse-grained particle. Typically: 8.66

+
+
a:
+

float [required] {units: \(\text{nm}^{-3}\)}

+

Calibrated parameter to obtain the correct average density at the target temperature and pressure. Typically: 9.21

+
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/doc_pages/constants_and_units.html b/v2.1.0/doc_pages/constants_and_units.html new file mode 100644 index 00000000..17676ff2 --- /dev/null +++ b/v2.1.0/doc_pages/constants_and_units.html @@ -0,0 +1,413 @@ + + + + + + + 6. Constants and Units — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

6. Constants and Units

+

HyMD uses the following units and constants internally and in all input and +output:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Units

Quantity

Symbol

Unit

length

\(r\)

\(\text{nm}=10^{-9}~\text{m}\)

time

\(t\)

\(\text{ps}=10^{-12}~\text{s}\)

charge

\(q\)

\(e=1.602176634 \cdot 10^{-19}~\text{C}\)

mass

\(m\)

\(\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}\)

temperature

\(\text{T}\)

\(\text{K}\)

energy

\(E\)

\(\text{kJ}\,\text{mol}^{-1}\)

velocity

\(v\)

\(\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}\)

momentum

\(P\)

\(\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}\)

force

\(\mathbf{F}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}\)

pressure

\(p\)

\(\text{bar}=100~\text{kPa}\)

electric potential

\(\Psi\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}\)

electric field

\(\mathbf{E}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}\)

compressibility

\(\kappa\)

\(\text{mol}\,\text{kJ}^{-1}\)

field-interaction

\(\tilde\chi\)

\(\text{kJ}\,\text{mol}^{-1}\)

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants

Constant

Symbol

Value

gas constant

\(R\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Boltzmann’s constant

\(k_\text{B}\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Avogadro’s constant

\(N_\text{A}\)

\(6.02214076 \cdot 10^23~\text{mol}^{-1}\)

Vacuum permittivity

\(\varepsilon_0\)

\(8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2\)

Coulomb constant

\(k_\text{e}\)

\(138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}\)

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/doc_pages/electrostatics.html b/v2.1.0/doc_pages/electrostatics.html new file mode 100644 index 00000000..b69db01c --- /dev/null +++ b/v2.1.0/doc_pages/electrostatics.html @@ -0,0 +1,334 @@ + + + + + + + 3. Electrostatic interactions — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Electrostatic interactions

+

In the filtered Hamiltonian hPF formalism [] the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle–mesh Ewald.

+

The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered

+
+\[\tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i),\]
+

with \(q_i\) being the charge of particle \(i\) and \(H\) is the +filtering function (see Filtering). The value of the charge grid at +vertex \((i,j,k)\) is found by

+
+\[\tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)]\]
+

and the electrostatic potential \(\Psi_{ijk}\)

+
+\[\Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right],\]
+

where \(k_\text{e}\) is the Coulomb constant \(1/4\pi\varepsilon_0\). +The electric field is obtained by differentiation of the electrostatic +potential in Fourier space,

+
+\[\mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)]\]
+

from which the forces are interpolated back to the particle positions.

+
+

3.1. Specifying electrostatics

+

In HyMD, electrostatics are specified by the coulombtype and +dielectric_const keywords in the configuration file (see +Configuration file) and the /charge dataset in the HDF5 format +structure/topology input file (see Topology and structure file). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/doc_pages/examples.html b/v2.1.0/doc_pages/examples.html new file mode 100644 index 00000000..ecf57290 --- /dev/null +++ b/v2.1.0/doc_pages/examples.html @@ -0,0 +1,782 @@ + + + + + + + 1. Examples — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Examples

+

The following examples are ordered in more or less order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the HyMD-tutorial github repository.

+
+

1.1. Ideal gas

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true +

The simplest possible system is one with no interactions at all—intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like:

+
+
ideal_gas.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = false         # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+
+
+

A simple input structure/topology file ideal_gas.HDF5 is available in +the HyMD-tutorial/ideal_gas github repository (along with the code to +generate it). Run the (very) short simulation by

+
python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field   \
+                                              --velocity-output \
+                                              --force-output
+
+
+

with the --disable-field argument to completely turn off all +particle–field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook ideal_gas.ipynb for details.

+
+
+

1.2. Ideal chains

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true +

The simplest available interaction is the harmonic two-particle bond (see +Intramolecular bonds),

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2.\]
+

Extending the configuration file from the ideal gas case, we need to add a +bonds specification. Note that the [bonds] meta specifier is not +necessary, but may be used to help organise the input file.

+
+
ideal_chain.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+
+
+

A simple input structure/topology file ideal_chain.HDF5 with a few +coiled up ideal chain polymers is available in the +HyMD-tutorial/ideal_chain github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field
+
+
+

we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +ideal_chain.ipynb.

+
+
+

1.3. Stiff rods

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true +

Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the i--j--k angle \(\theta\) (see +Intramolecular bonds),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2.\]
+

Extending the configuration file from the ideal chain case, we need to add a +angle_bonds specification. Note that the [bonds] meta specifier +is not necessary, but may be used to help organise the input file.

+
+
rods.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+angle_bonds = [
+  ["A", "A", "A", 180.0, 100.0],   # (i, j, k, equilibrium angle, strength)
+]
+
+
+
+

A simple input structure/topology file rods.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook rods.ipynb.

+
+
+

1.4. Helixes

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true +

Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle \(\phi\) between the +i--j--k plane and the j--k--l plane (see Intramolecular bonds),

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n).\]
+

The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a dihedrals keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the dielectric_const +keyword even though we are not including electrostatic forces in the current +simulation. Note that the [bonds] meta specifier is not necessary, but +may be used to help organise the input file.

+
+
helixes.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+dielectric_const = 15.0
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.31, 10000.0],       # (i name, j name, equilibrium length, strength)
+]
+
+dihedrals = [
+  [
+    ["A", "A", "A", "A"],
+    [
+      [-1],
+      [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+      [0.08, 0.46, 1.65, -0.96, 0.38],
+    ],
+    [1.0]
+  ],
+]
+
+
+
+

A simple input structure/topology file helixes.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook helixes.ipynb.

+
+
+

1.5. Phase separation

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true +

The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types A and B. Using the Hamiltonian

+
+\[\mathcal{H}=H_0+W\]
+

with \(\tilde\chi\)–dependent interactions defined by (specified in the +configuration file by hamiltonian = DefaultWithChi):

+
+\[W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2.\]
+
+
phase_separation.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+
+[field]
+mesh_size = [20, 20, 20]           # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+kappa = 0.05                       # compressibility in mol/kJ
+chi = [
+  ['A', 'B', 5.0],                 # (name i, name j, strength)
+]
+
+
+
+

A simple input structure/topology file phase_separation.HDF5 containing +an equal number of A type and B type particles is available in +the HyMD-tutorial/phase_separation github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd phase_separation.toml phase_separation.HDF5
+
+
+

we may examine the resulting trajectory. In the case of a low interaction +strength \(\tilde\chi\) of 5.0 (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to 40.0 (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +phase_separation.ipynb.

+
+
+

1.6. Diblock copolymers

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true +

Having introduced particle–field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive \(\tilde\chi\)–interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the integrator = "respa" keyword. Putting the pieces together, the +configuration file may look like the following:

+
+
copolymer.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 15
+n_steps = 2000                     # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [10.0, 10.0, 10.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [50, 50, 50]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+chi = [
+  ["A", "B", 30.0],                # (i, j, strength)
+]
+
+[bonds]
+bonds = [
+  ["A", "A", 0.25, 1500.0],        # (i, j, equilibrium length, strength)
+  ["A", "B", 0.25, 1500.0],
+  ["B", "B", 0.25, 1500.0],
+]
+angle_bonds = [
+  ["A", "A", "A", 180.0, 25.0],    # (i, j, k, equilibrium angle, strength)
+  ["B", "B", "B", 180.0, 25.0],
+]
+
+
+
+

A simple input structure/topology file copolymer.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/copolymer github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten A followed by ten B type particles. +Running the simulation with

+
python3 -m hymd copolymer.toml copolymer.HDF5
+
+
+

the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +copolymer.ipynb.

+
+
+

1.7. Lipid bilayer self-assembly

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true +

Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field–particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the thermostat_coupling_groups keyword. With parameters +optimised in [Ledum et al., 2020], the configuration file looks like:

+
+
lipid_self_assembly.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 25
+n_steps = 3000
+n_print = 200
+n_flush = 1
+time_step = 0.01
+box_size = [9.96924, 9.96924, 10.03970]
+start_temperature = 323
+target_temperature = 323
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.05
+domain_decomposition = 10001
+cancel_com_momentum = true
+max_molecule_size = 15
+thermostat_coupling_groups = [
+  ["N", "P", "G", "C"],
+  ["W"],
+]
+
+[field]
+mesh_size = [25, 25, 25]
+sigma = 1.0
+chi = [
+  ["C", "W", 42.24],
+  ["G", "C", 10.47],
+  ["N", "W", -3.77],
+  ["G", "W", 4.53],
+  ["N", "P", -9.34],
+  ["P", "G", 8.04],
+  ["N", "G", 1.97],
+  ["P", "C", 14.72],
+  ["P", "W", -1.51],
+  ["N", "C", 13.56],
+]
+
+[bonds]
+bonds = [
+  ["N", "P", 0.47, 1250.0],
+  ["P", "G", 0.47, 1250.0],
+  ["G", "G", 0.37, 1250.0],
+  ["G", "C", 0.47, 1250.0],
+  ["C", "C", 0.47, 1250.0],
+]
+angle_bonds = [
+  ["P", "G", "G", 120.0, 25.0],
+  ["P", "G", "C", 180.0, 25.0],
+  ["G", "C", "C", 180.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

A randomly mixed input structure/topology file +lipid_self_assembly.HDF5 with a few hundred lipids in a roughy +10 x 10 x 10nm box is available in the +HyMD-tutorial/lipid_self_assembly github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation

+
python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5
+
+
+

we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook lipid_self_assembly.ipynb.

+
+
+

1.8. Peptide in lipid bilayer

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true +

Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer.

+

The configuration file is available in the HyMD-tutorial/peptide github +repository (omitted here for brevity).

+

A pre-equilibrated input structure/topology file peptide.HDF5 with a +few hundred lipids in a roughy 20 x 20 x 20nm box is available in the +HyMD-tutorial/peptide github repository. Running the simulation

+
python3 -m hymd peptide.toml peptide.HDF5
+
+
+

we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook peptide.ipynb.

+
+
+

1.9. SDS

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true +

The last part we introduce is explicit electrostatic interactions through +particle–mesh Ewald. Enabling the electrostatic calculations is done via the +coulombtype keyword. "PIC_Spectral" is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the dielectric_const keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge.

+
+
sds.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 10
+n_steps = 3000
+n_print = 1500
+n_flush =
+time_step = 0.01
+box_size = [8.3, 8.3, 8.3]
+start_temperature = 298
+target_temperature = 298
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.1
+domain_decomposition = 10000
+cancel_com_momentum = true
+max_molecule_size = 5
+thermostat_coupling_groups = [
+  ["S", "C"],
+  ["W", "Na"],
+]
+dielectric_const = 45.0              # dielectric constant for the simulation medium
+coulombtype = "PIC_Spectral"         # particle in cloud, spectral method
+
+[field]
+mesh_size = [64, 64, 64]
+sigma = 0.5
+chi = [
+  ["S", "C",  13.50],
+  ["S", "Na",  0.00],
+  ["S", "W",  -3.60],
+  ["C", "Na", 13.50],
+  ["C", "W",  33.75],
+  ["W", "Na",  0.00],
+]
+
+[bonds]
+bonds = [
+  ["S",   "C",   0.50, 1250.0],
+  ["C",   "C",   0.50, 1250.0],
+]
+angle_bonds = [
+  ["S", "C", "C", 170.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

An input structure/topology file sds.HDF5 with a couple thousand +randomly dispersed SDS chains is available in the HyMD-tutorial/sds github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a /charge dataset. +Running the simulation with

+
python3 -m hymd sds.toml sds.HDF5
+
+
+

we observe the aggregation of the SDS into micellular structures—first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook sds.ipynb.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/doc_pages/filtering.html b/v2.1.0/doc_pages/filtering.html new file mode 100644 index 00000000..0b225cc2 --- /dev/null +++ b/v2.1.0/doc_pages/filtering.html @@ -0,0 +1,321 @@ + + + + + + + 2. Filtering — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Filtering

+

The default grid-independent filter function used in HyMD is a Gaussian

+
+\[H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right]\]
+

with reciprocal space representation

+
+\[\hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right].\]
+

The coarse-graining parameter \(\sigma\) determines a length scale of +particle extent and is given as configuration file input by

+
sigma = 0.75
+
+
+
+

2.1. Implementing new filters

+

Implementing new filter functions is straightforward by hijacking +the setup method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/doc_pages/installation.html b/v2.1.0/doc_pages/installation.html new file mode 100644 index 00000000..236fcb59 --- /dev/null +++ b/v2.1.0/doc_pages/installation.html @@ -0,0 +1,553 @@ + + + + + + + 1. Installation — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Installation

+
+

1.1. Dependencies

+

Installing non-Python dependencies may be done by

+
+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-openmpi-dev  # Install MPI-enabled HDF5
+sudo apt-get install -y pkg-config           # Install pkg-config, required for h5py install
+sudo apt-get install -y curl wget
+
+
+
+
+

Warning

+

There might be memory leaks when using HyMD with OpenMPI 4.1.1. +Therefore, using a newer version of OpenMPI is recommended. +See Issue #186 for more details.

+ +

Installing Python dependencies may be done by

+
+
python3 -m pip install --upgrade pip
+CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+python3 -m pip install mpi4py numpy cython
+
+
+
+
+

Warning

+

If MPI-enabled HDF5 and h5py can not be installed, limited support +for serial HDF5 is available. Note that having MPI-enabled file IO is +highly recommended, and simulation performance under serial HDF5 will +potentially be very low.

+

Example dependency install on Ubuntu (apt) using serial HDF5:

+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-serial-dev   # Install serial HDF5
+sudo apt-get install -y curl wget
+
+python3 -m pip install h5py mpi4py numpy cython
+
+
+

Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +--disable-mpio argument to HyMD, see Command line arguments. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial.

+ +
+
+

1.2. Installing HyMD

+

HyMD may be installed using pip by

+
python3 -m pip install hymd
+
+
+
+
+

1.3. Install in docker

+

A docker image with build essentials setup is available at dockerhub with tag +mortele/hymd,

+
docker pull mortele/hymd:latest
+docker run -it mortele/hymd
+/app$ python3 -m pip install hymd
+
+# Grab example input files
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5
+
+# Run simulation
+/app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose
+
+
+
+
+

1.4. Run interactively in Google Colaboratory

+

A Google Colaboratory jupyter notebook is setup here with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons.

+
+
+

1.5. Common issues

+
+

1.5.1. Numpy errors while importing the Fortran force kernels

+
RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd
+
+Traceback (most recent call last):
+
+  (...)
+
+File "/..../HyMD/hymd/__init__.py", line 2, in <module>
+  from .main import main  # noqa: F401
+File "/..../HyMD/hymd/main.py", line 10, in <module>
+  from .configure_runtime import configure_runtime
+File "/..../hymd/configure_runtime.py", line 12, in <module>
+  from .input_parser import read_config_toml, parse_config_toml
+File "/..../HyMD/hymd/input_parser.py", line 12, in <module>
+  from .force import Bond, Angle, Dihedral, Chi
+File "/..../HyMD/hymd/force.py", line 8, in <module>
+  from force_kernels import (  # noqa: F401
+ImportError: numpy.core.multiarray failed to import
+
+
+

can normally be fixed by updating numpy versions,

+
python3 -m pip install -U numpy
+
+
+
+
+

1.5.2. Error building pfft-python due to missing curl/wget

+
Building wheel for pfft-python (setup.py) ... error
+ERROR: Command errored out with exit status 1:
+command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_
+cwd: /tmp/pip-install-fr6nt9m4/pfft-python/
+Complete output (56 lines):
+running bdist_wheel
+running build
+running build_py
+
+  (...)
+
+curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found
+wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found
+Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+Please check curl or wget
+You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/
+Traceback (most recent call last):
+  File "<string>", line 1, in <module>
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in <module>
+    setup(
+  File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup
+    return distutils.core.setup(**attrs)
+  File "/usr/lib/python3.8/distutils/core.py", line 148, in setup
+
+  (...)
+
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions
+    build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:]))
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft
+    raise ValueError("could not build fftw; check MPICC?")
+ValueError: could not build fftw; check MPICC?
+----------------------------------------
+ERROR: Failed building wheel for pfft-python
+Running setup.py clean for pfft-python
+Failed to build pfft-python
+
+
+

can be fixed by installing either curl or wget

+
apt-get install -y curl wget
+
+
+
+
+

1.5.3. Error running parallel HyMD without MPI-enabled h5py

+
Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    main()
+  File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    raise ValueError("h5py was built without MPI support, can't use mpio driver")
+ValueError: h5py was built without MPI support, can't use mpio driver
+
+
+

Can be fixed by installing a MPI-enabled h5py through

+
python3 -m pip uninstall -y h5py
+HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/doc_pages/interaction_energy_functionals.html b/v2.1.0/doc_pages/interaction_energy_functionals.html new file mode 100644 index 00000000..08ff8c28 --- /dev/null +++ b/v2.1.0/doc_pages/interaction_energy_functionals.html @@ -0,0 +1,374 @@ + + + + + + + 1. Interaction energy functionals — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Interaction energy functionals

+

A few interaction energy functionals \(W\) are defined in HyMD through +the Hamiltonian class and associated subclasses.

+
+

1.1. \(\chi\)–interaction and \(\kappa\)–incompressibility

+

The most common hPF energy functional is specified by

+
hamiltonian = "DefaultWithChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where \(\tilde\chi_{\text{A}-\text{B}}\) is the interaction energy between +overlapping densities of particle types \(\text{A}\) and \(\text{B}\). +The incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\tilde\chi\) +and \(\kappa\) in the configuration file (see Configuration file)

+
kappa = 0.05
+chi = [
+   ["A", "B", 15.85],
+   ["B", "C", -5.70],
+   ...
+]
+
+
+
+
+

1.2. Only \(\kappa\)–incompressibility

+

The only \(\kappa\) interactions energy functional is specified by

+
hamiltonian = "DefaultNoChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where the incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.3. Only \(\phi^2\)

+

The \(\phi^2\) interactions energy functional is specified by

+
hamiltonian = "SquaredPhi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2,\]
+

where the \(\phi\) squared term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.4. Implementing new interaction energy forms

+

Implementing new interaction energy functions is straightforward by subclassing +Hamiltonian and applying sympy differentiation to the symbolic +field objects. The sympy.lamdify function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/doc_pages/interfaces.html b/v2.1.0/doc_pages/interfaces.html new file mode 100644 index 00000000..c9d80f0d --- /dev/null +++ b/v2.1.0/doc_pages/interfaces.html @@ -0,0 +1,318 @@ + + + + + + + 5. PLUMED interface — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. PLUMED interface

+

HyMD is interfaced with PLUMED <https://www.plumed.org/> for simulations using enhanced sampling or free-energy methods. +To use the interface, the Python package of PLUMED must be installed, and the user must provide a working PLUMED_KERNEL by setting this environment variable to the kernel path. +In the current version, only simulations using a single replica are supported.

+
+

Warning

+

PLUMED versions prior to 2.8.1 did not have a working Python interface with MPI. Therefore, you must use PLUMED 2.8.1 or greater when installing the PLUMED library in Python. Older versions for the kernel are supported if the Python interface was correctly installed with version 2.8.1.

+ +
+

5.1. Running simulations using PLUMED

+

To run your simulations using PLUMED you must first set the environment variable PLUMED_KERNEL and then call HyMD with the --plumed option, passing the PLUMED input file to HyMD. +Optionally, you can also set the output file name with the --plumed-outfile option (the default it plumed.out).

+

If your PLUMED input (see the PLUMED manual <> for details) is called, e.g., plumed_input.dat, you can run a simulation using the PLUMED interface with:

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field --plumed plumed_input.dat
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/doc_pages/intramolecular_bonds.html b/v2.1.0/doc_pages/intramolecular_bonds.html new file mode 100644 index 00000000..0d7466bd --- /dev/null +++ b/v2.1.0/doc_pages/intramolecular_bonds.html @@ -0,0 +1,414 @@ + + + + + + + 2. Intramolecular bonds — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Intramolecular bonds

+

Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see Configuration file. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +Benchmarks), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable.

+

All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]).

+
+

2.1. Two-particle bonds

+

Stretching bonds in HyMD are implemented as harmonic spring potentials,

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2,\]
+

where \(r=|\mathbf{r}|\) is the inter-particle distance, \(k\) is a +constant of dimension energy (units \(\text{kJ}\,\text{mol}^{-1}\)), and +\(r_0\) is the equilibrum length of the bond (units: \(\text{nm}\)). The +force is calculated as

+
+\[F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r},\]
+

where \(\mathbf{r}\) is the vector pointing from \(i\) to \(j\).

+

In the configuration file, two-particle bonds are specified per particle type:

+
+
configuration_two_particle_example.toml
+
[bonds]
+bonds = [
+   ["A", "A", 0.47, 1250.0],
+   ["A", "B", 0.37,  940.0],
+   ["B", "C", 0.50, 1010.0],
+   ["C", "A", 0.42,  550.0],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.2. Three-particle bonds

+

Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle–particle–particle angle \(\theta\),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2,\]
+

where \(k\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\)), and \(\theta_0\) is the equilibrum +angle of the bond (units: \({}^\circ\)). Defining the particles with labels +\(a\), \(b\), and \(c\), let \(\mathbf{r}_a\) denote the vector +pointing from \(b\) to \(a\), and correspondingly let +\(\mathbf{r}_c\) point from \(b\) to \(c\). The +\(a\)\(b\)\(c\) may be computed through the law of Cosines,

+
+\[\theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right]\]
+

Then the force acting on \(a\) and \(c\) is

+
+\[ \begin{align}\begin{aligned}\mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a},\\\mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c},\end{aligned}\end{align} \]
+

and

+
+\[\mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c\]
+

In the configuration file, three-particle bonds are specified per particle type:

+
+
configuration_three_particle_example.toml
+
[bonds]
+angle_bonds = [
+   ["A", "A", "A", 180.0, 90.0],
+   ["A", "B", "A", 120.0, 55.0],
+   ["B", "C", "C",  30.0, 10.0],
+   ["C", "A", "B", 110.0, 25.5],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.3. Four-particle bonds

+

Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle \(\phi\) between the +\(a\)\(b\)\(c\) and \(b\)\(c\)\(d\) planes, for +a dihedral bond quartet \(a\), \(b\), \(c\), and \(d\). The +potential takes the form

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n),\]
+

where \(c_n\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)), and \(\phi_n\) are +specified phase angles in the cosine series.

+

In the configuration file, four-particle bonds are specified per particle type:

+
+
configuration_four_particle_example.toml
+
[bonds]
+dihedrals = [
+   ["A", "B", "C", "D"],
+   [
+     [-1],
+     [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+     [0.08, 0.46, 1.65, -0.96, 0.38],
+   ],
+   [1.0],
+]
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/doc_pages/overview.html b/v2.1.0/doc_pages/overview.html new file mode 100644 index 00000000..b2a6108f --- /dev/null +++ b/v2.1.0/doc_pages/overview.html @@ -0,0 +1,435 @@ + + + + + + + 2. Usage overview for HylleraasMD — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Usage overview for HylleraasMD

+

HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a toml format configuration file, along with a topology and structure +file specifying the input system in HDF5 format.

+

Configuration file

+

The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a [5, 5, 5] nm simulation box at 300 K may look like +the following:

+
+
config_simple_1.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "SquaredPhi"         # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [30, 30, 30]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+
+
+
+

Note that for the version 1.0 release of HyMD, the [particles], +[simulation], and [field] groups are optional specifiers for +structuring the configuration file.

+

For a full specification of every recognised configuration keyword in HyMD, +please refer to Configuration file.

+

Topology and structure file

+

The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +N particles may look like the following:

+
+
example_structure.HDF5
+
group   /
+   # root group
+
+dataset /coordinates
+   # float32, shape (T, N, D,)
+   # Time steps of N rows of D dimensional coordinate data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /velocities
+   # float32, shape (T, N, D,) OPTIONAL
+   # Time steps of N rows of D dimensional velocity data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /bonds
+   # int32,   shape (N, B,)    OPTIONAL
+   # Each row i contains indices of the particles bonds from/to i
+   # B denotes the maximum bonds per particle
+
+dataset /indices
+   # int32,   shape (N,)
+   # Index of each particle, 0--(N-1)
+
+dataset /molecules
+   # int32,   shape (N,)
+   # Index of molecule each particle belongs to
+   # Used to construct bond network locally on MPI ranks
+
+dataset /names
+   # str10,   shape (N,)
+   # Fixed size string array containing particle type names
+
+dataset /types
+   # int32,   shape (N,)       OPTIONAL
+   # Mapping of particle names to type indices
+
+
+
+

For a full specification of the topology and structure input file, see +Topology and structure file.

+

Command line arguments

+

A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the config_simple_1.toml and example_structure.HDF5 +files may look like the following:

+
mpirun -n ${MPI_NUM_RANKS} python3 -m hymd         \  # HyMD executable
+                           config_simple_1.toml    \  # configuration file
+                           example_structure.HDF5  \  # structure file
+                           --logfile=log_out.txt   \  # set logfile path
+                           --seed 123456           \  # set random seed
+                           --verbose 2             \  # set logging verbosity
+                           --velocity-output          # enable velocity in trajectory output
+
+
+

For a full specification of all command line arguments, see +Command line arguments.

+

More examples

+

For more thorough rundown and concrete usage examples, see +Examples.

+
+

2.1. Running parallel simulations

+

Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the only difference being how the python3 interpreter is +invoked. Prepending mpirun -n ${NPROCS} to the usual +python3 -m hymd runs the simulation with ${NPROCS} MPI ranks.

+

Inputting

+
mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field
+
+
+

sets up an example simulation of the HyMD-tutorial/ideal_gas system. For +more details about this system in particular, or other example simulations, see +the HyMD-tutorial repository.

+
+
+

2.2. Running tests

+

Run serial code tests by

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd
+cd hymd/
+python3 -m pip install pytest pytest-mpi
+python3 -m pytest
+
+
+

There is a small convenience script in hymd/ for running the MPI-enabled +tests,

+
chmod +x pytest-mpi
+./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/doc_pages/pressure.html b/v2.1.0/doc_pages/pressure.html new file mode 100644 index 00000000..3aa5e142 --- /dev/null +++ b/v2.1.0/doc_pages/pressure.html @@ -0,0 +1,324 @@ + + + + + + + 4. Pressure — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Pressure

+

Internal pressure is calculated from internal energy according to

+
+\[\begin{split}P_a = \frac{1}{\mathcal{V}} \left( 2T_a - \text{Vir}_a \right) \\ +\text{Vir}_a = L_a \frac{\partial \mathcal{U}}{\partial L_a} \\ +\mathcal{U} = \sum_{i=1}^M \mathcal{U}_0( \{ \mathbf{r}\}_i ) + W[\{ \tilde\phi \} ]\end{split}\]
+

where +\(\mathcal{V}\) is the simulation volume, +\({T_a}\) is the kinetic energy +and \(L_a\) the length of the box in the Cartesian direction \(a\), +Vir is the virial of the total interaction energy \(\mathcal{U}\).

+

\(\mathcal{U}\) comprises intramolecular bonded terms \(\mathcal{U}_0\) (see Intramolecular bonds for details), +and field terms \(W[\{ \tilde\phi \} ]\) (see Theory for details).

+

Using the above expressions, the following form for internal pressure is obtained:

+
+\[\begin{split}P_a = \frac{2 T_a}{\mathcal{V}} -\frac{L_a}{\mathcal{V}} \sum_{i=1}^N \frac{\partial \mathcal{U}_{0i}}{\partial L_a} + P^{(3)}_a \\\end{split}\]
+
+\[P^{(3)}_a = \frac{1}{\mathcal{V}}\left ( -W[\{ \tilde\phi(\mathbf{r}) \}] + \int \sum_t \bar{V}_t(\mathbf{r})\tilde\phi_t(\mathbf{r})d\mathbf{r} + + \int \sum_t \sigma^2\bar{V}_t(\mathbf{r})\nabla_a^2\tilde\phi_t(\mathbf{r}) d\mathbf{r} \right)\]
+

where \(\bar{V}_t(\mathbf{r}) = \frac{\partial w(\{\tilde\phi\})}{\partial\tilde\phi_t}\) +and \(σ\) is a coarse-graining parameter (see Filtering for details). +Note that the above expression is obtained for a Gaussian filter which is the most natural choice in HhPF theory.

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/doc_pages/theory.html b/v2.1.0/doc_pages/theory.html new file mode 100644 index 00000000..19022b4e --- /dev/null +++ b/v2.1.0/doc_pages/theory.html @@ -0,0 +1,382 @@ + + + + + + + 1. Theory — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Theory

+

Hybrid particle–field simulations switch out the ordinary particle–particle +Lennard-Jones interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle–field densities are +defined as

+
+\[\phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i),\]
+

where \(\mathbf{r}\) is a spatial coordinate, \(P\) is a window function +used to distribute particle number densities onto a computational grid, and +\(\mathbf{r}_i\) is the position of particle \(i\) (of total \(N\)). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of \(N\) particles in \(M\) molecules is

+
+\[\mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})]\]
+

with \(H_0\) being a standard intramolecular Hamiltonian form (see +Intramolecular bonds) including kinetic terms, while \(W\) is a density +dependent interaction energy functional.

+

In the Hamiltonian hPF-MD formalism [], the density +field is filtered using a grid-independent filtering function \(H\),

+
+\[\tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}).\]
+

The filter smooths the density, ensuring that \(\tilde\phi\) and +\(W[\tilde\phi([\phi])]\) both converge as the grid size is reduced.

+
+

1.1. External potential

+

The external potential acting on a particle is defined as the functional +derivative of \(W\) with respect to \(\phi\). In the filtered formalism, +the potential takes the form

+
+\[\begin{split}V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ +&= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})},\end{split}\]
+

under the assumption of a local form of the interaction energy functional, +\(W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]\). Note +that

+
+\[\frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}).\]
+
+
+

1.2. Force interpolation

+

The forces on particle \(i\) are obtained by differentiation of the external +potential,

+
+\[\mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i).\]
+
+
+

1.3. Reciprocal space calculations

+

The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density \(\phi_{ijk}\) with CIC, we apply the filtering +and obtain the discrete version of the external potential by

+
+\[\tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big]\]
+

and

+
+\[V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+

The forces are obtained by differentiation of \(V\) in Fourier space as

+
+\[\nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+
+
+

1.4. Filter

+

By default, the filter used in HyMD is a simple Gaussian of the form

+
+\[\begin{split}H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ +\hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right].\end{split}\]
+

For more details about the filtering, see Filtering.

+
+
+

1.5. Hamiltonian form

+

The default form of the interaction energy functional in HyMD is

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2.\]
+

In the case of constant pressure simulations (NPT), the interaction energy functional becomes

+
+\[W=\frac{1}{2\rho_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-a\right)^2.\]
+

where, \(\rho_0= 1 / ν\) is an intrinsic parameter corresponding to the specific volume \((ν)\) of a coarse-grained particle, +\(a\) is a calibrated parameter to obtain the correct average density at the target temperature and pressure. +See Interaction energy functionals for details.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/doc_pages/topology_input.html b/v2.1.0/doc_pages/topology_input.html new file mode 100644 index 00000000..96633bbb --- /dev/null +++ b/v2.1.0/doc_pages/topology_input.html @@ -0,0 +1,363 @@ + + + + + + + 4. Topology and structure file — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Topology and structure file

+

The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root / group.

+

The HyMD-tutorial has multiple examples of structure files for various levels +of complexity.

+
+

4.1. Required datasets

+
+
/coordinates:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/indices:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/names:
+

array shape [N,]

+

datatype [string (length between 1 and 16)]

+

The shape represents one particle name per N particles. The datatype may be a string of length =<16.

+
+
+
+
+

4.2. Optional datasets

+
+
/velocities:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/types:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle type index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/molecules:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one molecule index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/bonds:
+

array shape [N, B,]

+

datatype [int32 or int64]

+

The shape represents B bond specifications (indices of different particles) per N particles. The data type may be either 32 or 64 bit integers.

+
+
/charge:
+

array shape [N,]

+

datatype [float32 or float64]

+

The shape represents one particle charge per N particles. The data type may be either four or eight byte reals.

+
+
/box:
+

array shape [3,]

+

datatype [float32 or float64]

+

The shape represents the initial box dimensions in Cartesian coordinates.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/genindex.html b/v2.1.0/genindex.html new file mode 100644 index 00000000..fcdaf7d3 --- /dev/null +++ b/v2.1.0/genindex.html @@ -0,0 +1,879 @@ + + + + + + Index — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + +
+ +

F

+ + + +
+ +

G

+ + +
+ +

H

+ + + +
    +
  • + hymd.input_parser + +
  • +
  • + hymd.integrator + +
  • +
  • + hymd.plumed + +
  • +
  • + hymd.pressure + +
  • +
  • + hymd.thermostat + +
  • +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/index.html b/v2.1.0/index.html new file mode 100644 index 00000000..73489ffc --- /dev/null +++ b/v2.1.0/index.html @@ -0,0 +1,408 @@ + + + + + + + HylleraasMD documentation — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

HylleraasMD documentation

+
+
Release:
+

2.1.0

+
+
Date:
+

May 12, 2023

+
+
+

HylleraasMD (HyMD) is a massively parallel Python package for Hamiltonian hybrid +particle-field molecular dynamics (HhPF-MD) simulations of coarse-grained bio- +and soft-matter systems.

+

HyMD can run canonical hPF-MD simulations, or filtered density HhPF-MD simulations [Bore and Cascella, 2020, Ledum et al., 2023, Ledum et al., 2023, Sen et al., 2023] +with or without explicit PME electrostatic interactions. It includes all standard intramolecular interactions, +including stretching, bending, torsional, and combined bending-dihedral potentials. Additionally, topological reconstruction of permanent peptide chain backbone +dipoles is possible for accurate recreation of protein conformational dynamics. It can run simulations in constant energy (NVE), constant volume (NVT) [Ledum et al., 2023, Ledum et al., 2023] +or constant pressure (NPT) conditions [Sen et al., 2023]. +HyMD is also interfaced with PLUMED and can perform simulations using enhanced sampling methods.

+

HyMD uses the pmesh library for particle-mesh operations, with the PPFT [Pippig, 2013] backend for FFTs through the pfft-python bindings. +File IO is done via HDF5 formats to allow MPI parallel reads.

+
+

User Guide

+

The HylleraasMD User Guide provides comprehensive information on how to run +simulations. Selected Examples are available to guide new users.

+
+
+

Installing HyMD

+

The easiest approach is to install using pip:

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+

For more information and required dependencies, see +Installation.

+
+

Run in Google colab

+

Run HyMD interactively in Google Colaboratory jupyter notebook here.

+
+
+
+

Source Code

+

Source code is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the GNU Lesser General Public +License v3.0. Obtain the source code with git:

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git
+
+
+
+
+

Development

+

HyMD is developed and maintained by researchers at the Hylleraas Centre for +Quantum Molecular Sciences at the University of Oslo.

+

pic1 pic2

+
+
+

References

+
+
+[BC20] +

Sigbjørn Løland Bore and Michele Cascella. Hamiltonian and alias-free hybrid particle–field molecular dynamics. J. Chem. Phys., 153(9):094106, 2020. doi:10.1063/5.0020733.

+
+
+[BDP07] +

Giovanni Bussi, Davide Donadio, and Michele Parrinello. Canonical sampling through velocity rescaling. J. Chem. Phys., 126(1):014101, 2007. doi:10.1063/1.2408420.

+
+
+[LBC20] +

Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Automated determination of hybrid particle-field parameters by machine learning. Mol. Phys., 118(19-20):e1785571, 2020. doi:10.1080/00268976.2020.1785571.

+
+
+[LCS+23] +

Morten Ledum, Manuel Carrer, Samiran Sen, Xinmeng Li, Michele Cascella, and Sigbjørn Løland Bore. HylleraasMD: Massively parallel hybrid particle-field molecular dynamics in Python. Journal of Open Source Software, 8(84):4149, apr 2023. URL: https://joss.theoj.org/papers/10.21105/joss.04149, doi:10.21105/joss.04149.

+
+
+[LSL+23] +

missing journal in hymd_domain2023

+
+
+[Pip13] +

Michael Pippig. Pfft: an extension of fftw to massively parallel architectures. SIAM J. Sci. Comput., 35(3):C213–C236, 2013. doi:10.1137/120885887.

+
+
+[SLBC23] +

Samiran Sen, Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Soft matter under pressure: pushing particle–field molecular dynamics to the isobaric ensemble. J Chem Inf Model, 63(7):2207–2217, March 2023. URL: https://doi.org/10.1021/acs.jcim.3c00186, doi:10.1021/acs.jcim.3c00186.

+
+
+[TBM92] +

MBBJM Tuckerman, Bruce J Berne, and Glenn J Martyna. Reversible multiple time scale molecular dynamics. J. Chem. Phys., 97(3):1990–2001, 1992. doi:10.1063/1.463137.

+
+
+
+
+
+

Indices and tables

+ +
+
+
+
+
+
+
+
+
+ + + +
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+ + + + + +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/objects.inv b/v2.1.0/objects.inv new file mode 100644 index 00000000..c313b3a7 Binary files /dev/null and b/v2.1.0/objects.inv differ diff --git a/v2.1.0/py-modindex.html b/v2.1.0/py-modindex.html new file mode 100644 index 00000000..6e826f12 --- /dev/null +++ b/v2.1.0/py-modindex.html @@ -0,0 +1,359 @@ + + + + + + Python Module Index — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ h +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ h
+ hymd +
    + hymd.barostat +
    + hymd.field +
    + hymd.file_io +
    + hymd.force +
    + hymd.input_parser +
    + hymd.integrator +
    + hymd.plumed +
    + hymd.pressure +
    + hymd.thermostat +
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.1.0/search.html b/v2.1.0/search.html new file mode 100644 index 00000000..d303e35a --- /dev/null +++ b/v2.1.0/search.html @@ -0,0 +1,314 @@ + + + + + + Search — hymd 2.1.0 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.1.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v2.1.0/searchindex.js b/v2.1.0/searchindex.js new file mode 100644 index 00000000..177765bd --- /dev/null +++ b/v2.1.0/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["doc_pages/api","doc_pages/benchmarks","doc_pages/command_line","doc_pages/config_file","doc_pages/constants_and_units","doc_pages/electrostatics","doc_pages/examples","doc_pages/filtering","doc_pages/installation","doc_pages/interaction_energy_functionals","doc_pages/interfaces","doc_pages/intramolecular_bonds","doc_pages/overview","doc_pages/pressure","doc_pages/theory","doc_pages/topology_input","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,"sphinxcontrib.bibtex":9,sphinx:56},filenames:["doc_pages/api.rst","doc_pages/benchmarks.rst","doc_pages/command_line.rst","doc_pages/config_file.rst","doc_pages/constants_and_units.rst","doc_pages/electrostatics.rst","doc_pages/examples.rst","doc_pages/filtering.rst","doc_pages/installation.rst","doc_pages/interaction_energy_functionals.rst","doc_pages/interfaces.rst","doc_pages/intramolecular_bonds.rst","doc_pages/overview.rst","doc_pages/pressure.rst","doc_pages/theory.rst","doc_pages/topology_input.rst","index.rst"],objects:{"hymd.barostat":{isotropic:[0,1,1,""],semiisotropic:[0,1,1,""]},"hymd.field":{compute_field_and_kinetic_energy:[0,1,1,""],compute_field_energy_q_GPE:[0,1,1,""],compute_field_force:[0,1,1,""],compute_self_energy_q:[0,1,1,""],domain_decomposition:[0,1,1,""],initialize_pm:[0,1,1,""],update_field:[0,1,1,""],update_field_force_q:[0,1,1,""],update_field_force_q_GPE:[0,1,1,""]},"hymd.file_io":{OutDataset:[0,2,1,""],distribute_input:[0,1,1,""],setup_time_dependent_element:[0,1,1,""],store_data:[0,1,1,""],store_static:[0,1,1,""]},"hymd.file_io.OutDataset":{close_file:[0,3,1,""],flush:[0,3,1,""],is_open:[0,3,1,""]},"hymd.force":{Angle:[0,2,1,""],Bond:[0,2,1,""],Chi:[0,2,1,""],Dielectric_type:[0,2,1,""],Dihedral:[0,2,1,""],compute_angle_forces__plain:[0,1,1,""],compute_bond_forces__plain:[0,1,1,""],compute_dihedral_forces__plain:[0,1,1,""],dipole_forces_redistribution:[0,1,1,""],find_all_paths:[0,1,1,""],prepare_bonds:[0,1,1,""],prepare_bonds_old:[0,1,1,""],prepare_index_based_bonds:[0,1,1,""],propensity_potential_coeffs:[0,1,1,""]},"hymd.force.Angle":{atom_3:[0,4,1,""]},"hymd.force.Bond":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],equilibrium:[0,4,1,""],strength:[0,4,1,""]},"hymd.force.Chi":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],interaction_energy:[0,4,1,""]},"hymd.force.Dielectric_type":{atom_1:[0,4,1,""],dielectric_value:[0,4,1,""]},"hymd.force.Dihedral":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],atom_3:[0,4,1,""],atom_4:[0,4,1,""],coeffs:[0,4,1,""],dih_type:[0,4,1,""]},"hymd.hamiltonian":{DefaultNoChi:[0,2,1,""],DefaultWithChi:[0,2,1,""],Hamiltonian:[0,2,1,""],SquaredPhi:[0,2,1,""]},"hymd.hamiltonian.DefaultNoChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.DefaultWithChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.Hamiltonian":{__init__:[0,3,1,""],_setup:[0,3,1,""]},"hymd.hamiltonian.SquaredPhi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.input_parser":{Config:[0,2,1,""],check_NPT_conditions:[0,1,1,""],check_angles:[0,1,1,""],check_bonds:[0,1,1,""],check_box_size:[0,1,1,""],check_cancel_com_momentum:[0,1,1,""],check_charges:[0,1,1,""],check_charges_types_list:[0,1,1,""],check_chi:[0,1,1,""],check_config:[0,1,1,""],check_dielectric:[0,1,1,""],check_dihedrals:[0,1,1,""],check_domain_decomposition:[0,1,1,""],check_hamiltonian:[0,1,1,""],check_integrator:[0,1,1,""],check_m:[0,1,1,""],check_mass:[0,1,1,""],check_max_molecule_size:[0,1,1,""],check_n_b:[0,1,1,""],check_n_flush:[0,1,1,""],check_n_particles:[0,1,1,""],check_n_print:[0,1,1,""],check_name:[0,1,1,""],check_start_and_target_temperature:[0,1,1,""],check_tau:[0,1,1,""],check_thermostat_coupling_groups:[0,1,1,""],parse_config_toml:[0,1,1,""],read_config_toml:[0,1,1,""],sort_dielectric_by_type_id:[0,1,1,""]},"hymd.input_parser.Config":{a:[0,4,1,""],angle_bonds:[0,4,1,""],barostat:[0,4,1,""],barostat_type:[0,4,1,""],bonds:[0,4,1,""],box_size:[0,4,1,""],cancel_com_momentum:[0,4,1,""],chi:[0,4,1,""],conv_crit:[0,4,1,""],convergence_type:[0,4,1,""],coulomb_constant:[0,4,1,""],coulombtype:[0,4,1,""],dielectric_const:[0,4,1,""],dielectric_type:[0,4,1,""],dihedrals:[0,4,1,""],domain_decomposition:[0,4,1,""],dtype:[0,4,1,""],file_name:[0,4,1,""],gas_constant:[0,4,1,""],hamiltonian:[0,4,1,""],initial_energy:[0,4,1,""],integrator:[0,4,1,""],kappa:[0,4,1,""],m:[0,4,1,""],mass:[0,4,1,""],max_molecule_size:[0,4,1,""],mesh_size:[0,4,1,""],n_b:[0,4,1,""],n_flush:[0,4,1,""],n_particles:[0,4,1,""],n_print:[0,4,1,""],n_steps:[0,4,1,""],name:[0,4,1,""],pol_mixing:[0,4,1,""],pressure:[0,4,1,""],respa_inner:[0,4,1,""],rho0:[0,4,1,""],self_energy:[0,4,1,""],sigma:[0,4,1,""],start_temperature:[0,4,1,""],tags:[0,4,1,""],target_pressure:[0,4,1,""],target_temperature:[0,4,1,""],tau:[0,4,1,""],tau_p:[0,4,1,""],thermostat_coupling_groups:[0,4,1,""],thermostat_work:[0,4,1,""],time_step:[0,4,1,""],type_charges:[0,4,1,""]},"hymd.integrator":{integrate_position:[0,1,1,""],integrate_velocity:[0,1,1,""]},"hymd.logger":{Logger:[0,2,1,""],MPIFilterAll:[0,2,1,""],MPIFilterRoot:[0,2,1,""]},"hymd.logger.Logger":{setup:[0,3,1,""]},"hymd.logger.MPIFilterAll":{filter:[0,3,1,""]},"hymd.logger.MPIFilterRoot":{filter:[0,3,1,""]},"hymd.plumed":{PlumedBias:[0,2,1,""]},"hymd.plumed.PlumedBias":{api_version:[0,3,1,""],calc:[0,3,1,""],finalize:[0,3,1,""],prepare:[0,3,1,""]},"hymd.pressure":{comp_pressure:[0,1,1,""]},"hymd.thermostat":{_random_chi_squared:[0,1,1,""],_random_gaussian:[0,1,1,""],csvr_thermostat:[0,1,1,""]},hymd:{barostat:[0,0,0,"-"],field:[0,0,0,"-"],file_io:[0,0,0,"-"],force:[0,0,0,"-"],input_parser:[0,0,0,"-"],integrator:[0,0,0,"-"],plumed:[0,0,0,"-"],pressure:[0,0,0,"-"],thermostat:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0020733":16,"00268976":16,"0083144621":0,"01036426965":4,"014101":[0,16],"02214076":4,"03642696562":4,"03970":6,"04149":16,"08790868":[6,11],"094106":16,"0xd":8,"0xe":8,"100":[4,6,12],"1000":6,"10000":6,"10001":6,"1010":11,"1021":16,"1063":16,"1080":16,"10nm":6,"110":11,"1120":0,"1130":0,"1137":16,"118":16,"120":[3,6,11],"120885887":16,"120ff":0,"123456":12,"1250":[3,6,11],"126":[0,16],"138":[0,4],"144":8,"148":8,"1500":6,"153":16,"166":8,"170":6,"1785571":16,"179":0,"180":[3,6,11],"186":8,"197":8,"1974":0,"1981":0,"1984":0,"1990":16,"1992":[3,16],"200":[6,11],"2000":6,"2001":16,"2007":[0,3,16],"2008":0,"201":[0,3],"2013":16,"2018":0,"2020":[6,16],"2023":16,"20nm":6,"21105":16,"2207":16,"2217":16,"223":0,"224":1,"2408420":16,"2408724":[6,11],"246":0,"251":[6,11],"28103735":0,"298":6,"2_1":0,"2don2d":8,"2nd":0,"2t_a":13,"300":[6,12],"3000":6,"3144621":4,"323":6,"3684":0,"3690":0,"3c00186":16,"4149":16,"449":[6,11],"463137":16,"48626121":[6,11],"502":8,"533":1,"544":[6,11],"550":11,"59427866":[6,11],"602176634":4,"610":[6,11],"66053906660":4,"85418781281":4,"935458":[0,4],"940":11,"96924":6,"980":3,"9918564":[6,11],"\u03b1":0,"\u03b2":0,"\u03bd":14,"\u03c3":13,"boolean":[0,3],"byte":15,"case":[0,3,6,11,14],"class":[0,9],"default":[0,3,7,10,12,14,15],"export":8,"final":0,"float":[0,3],"function":[0,3,5,6,7,12,14],"int":[0,5,6,9,13,14],"long":[5,6],"new":[0,11,15,16],"particle\u00e2":16,"public":16,"return":[0,8],"short":[6,12],"static":0,"switch":14,"true":[0,3,6],"while":[0,14],Adding:6,For:[0,12,14,16],LCS:16,The:[0,3,5,6,7,8,9,11,12,14,15,16],Then:11,There:[8,12],These:0,Used:[0,3,12],Using:[6,9,13],With:[0,6],__file__:8,__init__:[0,8],__main__:8,_gener:0,_hl:8,_kwarg:8,_random_chi_squar:0,_random_gaussian:0,_run_cod:8,_run_module_as_main:8,_set_fapl_mpio:8,_setup:0,about:[3,12,14],abov:[0,6,13],absent:0,acceler:0,accompani:6,accord:[0,3,13],accur:16,acid:6,across:[0,3],acs:16,act:[0,11,14],adapt:0,add:[5,6],added:0,adding:6,addison:0,addit:[0,2,5,12],addition:16,additon:0,adher:0,affect:0,affili:[0,2],after:[0,11,14],against:8,aggreg:6,ahren:0,alanin:6,algorithm:[0,3,14],alia:16,all:[0,2,3,4,6,8,11,12,16],all_nam:0,all_rank:0,alloc:0,allow:[12,16],allreduc:0,along:[6,12],alpha3:8,alpha:0,alpha_:0,alpha_l:0,alpha_n:0,alreadi:0,also:[6,8,10,16],altern:2,alwai:[0,3],amino:6,amount:0,analyt:0,angl:[0,2,3,6,8,11],angle_bond:[0,3,6,11],angle_pr:0,angular:[0,3,6,11],ani:[0,2,3],anisotrop:0,apart:0,api:8,api_vers:0,app:8,appli:[0,3,7,9,14],applic:0,approach:16,approxim:0,apr:16,apt:8,architectur:16,arg:[0,8],argument:[0,6,8,12],argv:8,aris:0,around:11,arrai:[0,3,12,15],arriv:6,art:0,aspect:3,assess:0,assign:[0,3,11],associ:[0,9],assum:3,assumpt:14,atom:0,atom_1:0,atom_2:0,atom_3:0,atom_4:0,attach:15,attempt:0,attr:8,attract:3,attribut:0,autom:16,automat:[0,7,8,9],avail:[6,8,16],averag:[0,3,9,14],avogadro:4,back:[0,5],backbon:[0,2,3,16],backcon:0,backend:16,backmap:0,balanc:0,ballist:6,bar:[3,4,13],barostat:3,barostat_typ:[0,3],base:0,bath:[0,3],bb_index:0,bc20:16,bdist_wheel:8,bdp07:16,bead:0,becaus:0,becom:[0,14],befor:[0,3,6,8],being:[0,2,3,5,11,12,14],belong:12,below:[0,6],benchmark:11,bend:[0,3,11,16],berendsen:3,bern:16,besid:2,best:0,beta:0,better:0,between:[0,3,5,6,9,11,14,15],bia:0,big:14,bin:8,binari:8,bind:16,bio:16,bit:[0,15],blueprint:0,boltzmann:[0,3,4],bond2_energi:0,bond3_energi:0,bond4_energi:0,bond:[0,2,6,8,12,13,14,15],bond_pr:0,bonds_2:0,bonds_2_atom1:0,bonds_2_atom2:0,bonds_2_atom_1:0,bonds_2_atom_2:0,bonds_2_equilibrium:0,bonds_2_strength:0,bonds_3:0,bonds_3_atom_1:0,bonds_3_atom_2:0,bonds_3_atom_3:0,bonds_3_equilibrium:0,bonds_3_strength:0,bonds_4:0,bonds_4_atom_1:0,bonds_4_atom_2:0,bonds_4_atom_3:0,bonds_4_atom_4:0,bonds_4_coeff:0,bonds_4_last:0,bonds_4_typ:0,bool:0,bootstrap:8,bore:[0,16],both:[0,14],boundari:[0,3],box:[0,3,6,12,13,15],box_siz:[0,3,6,12],breviti:6,brew:8,broadcast:0,browser:8,bruce:16,buffer:[0,3],build_extens:8,build_pfft:8,build_pi:8,built:8,bussi:[0,3,16],c213:16,c236:16,c_n:[0,6,11],calc:0,calcul:[0,3,6,11,13],calibr:[0,3,14],call:[0,3,8,10],callabl:0,can:[0,6,8,10,16],cancel_com_momentum:[0,3,6],canon:[0,3,16],capabl:2,captur:12,carrer:16,carri:6,cartesian:[0,3,13,15],cascella:[8,12,16],cbt:0,cdot10:4,cdot:[0,4,11],cell:[0,14],cellar:8,center:[0,3],centr:16,certain:[0,2],chain:[0,16],chang:[0,3],changedin:0,charg:[0,3,4,5,6,15],charge_out:0,check:[0,8],check_angl:0,check_bond:0,check_box_s:0,check_cancel_com_momentum:0,check_charg:0,check_charges_types_list:0,check_chi:0,check_config:0,check_dielectr:0,check_dihedr:0,check_domain_decomposit:0,check_hamiltonian:0,check_integr:0,check_m:0,check_mass:0,check_max_molecule_s:0,check_n_b:0,check_n_flush:0,check_n_particl:0,check_n_print:0,check_nam:0,check_npt_condit:0,check_start_and_target_temperatur:0,check_tau:0,check_thermostat_coupling_group:0,chem:[0,16],chi:[0,3,4,6,8],chi_2:0,chi_3:0,chi_:[0,3,6,9,14],chi_m:0,chmod:12,choic:13,chosen:0,cic:[0,5,14],circ:[3,11],circumv:14,classmethod:0,classvar:0,clean:[0,8],clone:[8,12,16],close:[0,8],close_fil:0,closest:0,cloud:[0,6,14],coars:[0,3,7,13,14,16],code:[0,1,2,3,6,8,12],coeff:0,coeffici:0,coil:[0,6],colab:8,colaboratori:16,collect:[0,3,15],com:[0,8,12,16],combin:[0,6,16],comm:0,comm_world:0,command:[8,12],common:9,commuic:0,commun:[0,3,11],communc:0,comp_pressur:0,compar:6,compat:2,compil:[0,8],compiler_so:8,complesfield:0,complet:[0,6,8],complex:[6,15],complexfield:0,compon:0,comprehens:16,compress:[0,3,4,6,9,12],compris:13,comput:[0,5,11,14,16],computaion:0,compute_angle_forces__plain:0,compute_bond_forces__plain:0,compute_dihedral_forces__plain:0,compute_field_and_kinetic_energi:0,compute_field_energy_q_gp:0,compute_field_forc:0,compute_potenti:0,compute_self_energy_q:0,concret:12,condit:[6,16],config:[0,8],config_simple_1:12,configur:[0,2,5,6,7,8,9,11,12],configuration_four_particle_exampl:11,configuration_three_particle_exampl:11,configuration_two_particle_exampl:11,configure_runtim:8,conform:[6,15,16],connect:0,conserv:1,consid:[0,6],consist:[0,6],consit:6,consitu:0,constant:[0,3,5,6,11,14,16],constitut:[0,2,3],constraint:3,construct:[0,11,12],constructor:0,contain:[0,1,2,3,6,12],content:[0,6],contigu:0,contribut:0,control:3,conv_crit:0,conv_fun:0,conveni:12,convent:0,converg:[0,14],convergence_typ:0,convert:0,coordin:[12,14,15],copi:0,core:8,correct:[0,3,14],correctli:10,correspond:[0,3,14],correspondingli:11,cos:[0,6,11],cosin:[0,3,6,11],cost:[3,11],could:8,coulomb:[0,3,4,5],coulomb_const:0,coulombtyp:[0,3,5,6],counter:6,coupl:[0,3,6,12],cprofil:2,cpu:[0,11],crash:3,creat:[0,9],critic:[0,6],cross:0,csvr:[0,3],csvr_thermostat:0,current:[0,6,10],cwd:8,cython:[8,16],d_n:0,dat:10,data:[0,3,6,12,15],dataclass:0,dataset:[0,5,6,12],datatyp:15,date:[0,16],date_format:0,david:16,debug:[0,2],decompos:0,decomposit:[0,3,11],default_level:0,defaultnochi:[0,6,9],defaultnohchi:[0,3],defaultwithchi:[0,3,6,9],defin:[0,6,9,11,14],definit:0,degre:3,delta:[0,14],denot:[0,1,3,9,11,12],densiti:[0,3,5,9,14,16],depend:[0,6,11,14,16],deprec:0,deriv:[0,14],design:6,dest_directori:0,detail:[2,3,6,8,10,12,13,14],determin:[0,2,7,16],dev:8,devel:8,develop:[6,8],deviat:[0,3],dict:0,dictat:0,dictionari:0,did:10,dielectr:[0,3,6],dielectric_const:[0,3,5,6],dielectric_typ:0,dielectric_valu:0,dieter:0,differ:[0,3,6,12,15],differenti:[0,5,7,9,14],difficult:2,dih_typ:0,dihedr:[0,2,3,5,6,8,11,16],dimens:[0,11,12,15],dimension:12,dinola:0,dipol:[0,2,3,5,6,16],dipole_forces_redistribut:0,direct:[0,3,13],directori:12,disabl:[2,6,8,10,12],disable_mpio:0,discard:0,discret:[0,14],discretis:14,disk:[0,3],dispers:6,dist:8,distanc:[0,3,11],distinct:0,distribut:[0,3,5,6,14],distribute_input:0,distutil:8,dnf:8,doc:0,dockerhub:8,dodecyl:6,doe:[0,11],doesn:0,doi:16,domain:[0,3,11],domain_decomposit:[0,3,6],donadio:[0,16],done:[0,6,8,16],dopc:6,dot:0,dot_elec:0,doubl:[0,2],double_out:0,download:8,dppc:6,draw:0,drawn:0,driver:[8,12],dtype:0,due:[0,3],dump:0,dump_per_particl:0,dure:[0,2,3,11,12],dynam:[0,3,12,14,16],e1785571:16,e_k:0,each:[0,3,6,11,12],easiest:16,effect:[0,3],effici:11,eight:15,either:[0,3,8,15],elec:0,elec_field:0,elec_field_contrib:0,elec_field_fouri:0,elec_forc:0,elecrostat:0,electr:[0,4,5],electrosat:0,electrostat:[0,6,16],els:3,elucid:6,embed:6,emit:0,emploi:0,empti:0,enabl:[2,6,12],enclos:0,end:0,energi:[0,1,3,4,6,7,10,11,12,13,14,16],energiesself:0,enhanc:[10,16],ensembl:16,ensur:[0,3,6,8,14],ensurepip:8,entri:3,environ:10,epsilon:0,equal:[0,3,6],equat:0,equilibr:[3,6],equilibrium:[0,3,6],equilibrum:11,equival:[0,3],error:0,essenti:[0,1,8],etc:[2,3],even:[0,3,6,8],event:0,everi:[0,3,6,11,12],everystep:0,evid:0,ewald:[0,5,6],examin:6,exampl:[3,8,12,15,16],example_structur:12,except:11,exchang:[0,3],exec:8,execut:[0,8,12],exist:0,exit:8,exp:[7,14],expand:0,expans:0,expect:0,expens:[3,14],explicit:[0,6,11,16],express:[0,13],ext:0,extend:6,extens:16,extent:[0,7],extern:[0,3],extract:[0,8],f401:8,f_angl:0,f_bond:0,f_dihedr:0,f_dipol:0,f_on_bead:0,factor:0,factori:0,fail:[0,8],fals:[0,3,6],fapl:8,fashion:[0,3],fast:14,fedora:8,few:[6,9,11,12],fft:[0,1,2,3,5,6,12,14,16],fftw3:8,fftw:[8,16],field:[2,4,5,6,9,10,12,13,14,16],field_energi:0,field_list:0,field_q_energi:0,field_q_self_energi:0,file:[2,5,6,7,8,9,10,11,12,16],file_io:0,file_nam:0,file_path:0,filter:[0,3,5,6,12,13,16],find:[0,8],find_all_path:0,first:[0,3,6,10,12],five:0,fix:[0,8,12],flag:[0,15],flat:12,float32:[12,15],float64:15,flori:0,fluctuat:0,flush:[0,3],follow:[0,2,3,4,6,12,13],forc:[2,3,4,5,6,11],force_kernel:8,force_mesh:0,force_mesh_elec:0,force_mesh_elec_fouri:0,force_out:0,forego:2,form:[0,5,11,13],formal:[5,14],format:[0,2,3,5,12,15,16],formatt:0,fortran:[0,11],forward:0,found:[5,8],four:[0,2,3,6,15],fourier:[0,5,14],fr6nt9m4:8,frac:[0,5,6,7,9,11,13,14],frame:[0,12,15],framework:8,free:[10,16],frequenc:[0,3],from:[0,2,3,5,6,8,9,11,12,13,16],full:[0,9,12],fulli:[0,6,8],fundament:12,gamma:0,gamma_0:0,gas:[0,4],gas_const:0,gather:0,gaussian:[0,3,7,13,14],gener:[0,2,3,6,16],get:[0,8],getattr:8,ghost:0,giovanni:16,git:[8,12,16],github:[0,6,8,12,16],githubusercont:8,given:[0,3,6,7],glenn:16,global:0,gnu:16,got:0,govern:9,gpe:0,grab:8,gradient:0,grain:[0,3,7,13,14,16],graph:0,greater:10,grid:[0,1,3,5,6,7,12,14],group:[0,3,6,8,12,15,16],guess:0,gunsteren:0,gyrat:6,h5md:[0,3],h5py:[0,2],h_0:[6,14],haak:0,half:0,hamiltonian:[3,5,6,7,9,12,16],handl:0,handler:0,happen:11,harmon:[0,3,6,11],has:[0,3,8,15],hat:[7,14],have:[0,6,8,10],hdf5:[0,2,3,5,6,8,10,12,15,16],hdf5_dir:8,hdf5_mpi:8,head:6,header:8,heat:[0,3],helic:[0,3,5,6],help:6,helper:0,here:[0,6,8,16],hhpf:[13,16],highli:[8,11,12],hijack:7,hire:1,homogen:0,homopolym:1,homopolypeptid:6,how:[3,12,16],howev:6,hpf:[3,5,9,12,14,16],html:0,http:[0,8,10,12,16],huggin:0,hundr:[6,11],hybrid:[12,14,16],hylleraa:16,hymd:[0,2,3,4,5,6,7,9,10,11,12,14,15],hymd_domain2023:16,ideal:11,ideal_chain:[6,8,10],ideal_ga:[6,12],ident:0,ignor:0,ijk:[5,14],imag:8,impact:0,implement:[0,11],importerror:8,impuls:[0,3],in_fil:[0,8],inam:8,includ:[0,2,3,6,14,16],incompress:[0,3],increas:[0,2,6],indentifi:0,independ:[0,3,7,14],index:[0,12,15,16],indic:[0,2,3,11,12,15],indirect:0,individu:[0,3,6],induc:5,inf:16,infer:11,info:[0,8],inform:[0,11,16],ingredi:6,initi:[0,15],initial_energi:0,initialis:12,initialize_pm:0,inner:[0,3],input:[2,3,4,5,6,7,8,10,12,15],input_box:0,input_pars:[0,8],insert:0,insid:[0,3,6],instal:[2,10,12],install_pfft:8,instantan:0,int32:[12,15],int64:15,integ:[0,3,6,15],integr:[3,6,12],integrate_posit:0,integrate_veloc:0,intend:8,inter:[0,11],interact:[0,2,3,4,6,7,12,13,14,16],interaction_energi:0,intercomm:0,interfac:[0,2,16],intergr:0,intermediari:0,intermolecular:6,intern:[0,2,3,4,11,13],interpol:[0,5],interpret:12,interv:[0,3],intmathrm:0,intracomm:0,intramolecular:[0,3,6,13,14,16],intrins:[3,5,14],introduc:6,investig:0,invok:[2,12],involv:[0,3,11],ion:6,ipynb:6,is_open:0,isobar:16,isotherm:0,isotrop:[0,3],iter:0,j_k:0,jcim:16,join:8,jone:14,joss:16,journal:16,jupyt:[6,8,16],k_e:0,kappa:[0,3,4,6,12,14],keep:[0,3],kelvin:[0,3,6,12],kernel:[0,10,11],keyword:[0,5,6,12],kinet:[0,13,14],kinetic_energi:0,knuth:0,kpa:4,kwd:8,l_a:13,label:[1,11],lambda:0,lamdifi:9,land:16,laplacian:0,larg:[8,12],larger:3,last:[6,8,12,15],last_bb:0,later:[0,6],latest:8,law:11,layout:0,layout_q:0,lbc20:16,leak:8,learn:16,leav:0,ledum:[6,16],left:[0,5,6,7,9,11,13,14],legend:1,lenght:0,length:[0,3,4,6,7,11,12,13,15],lennard:14,less:[0,6],lesser:16,let:[0,11],level:[0,2,3,15],lib64:8,lib:8,libhdf5:8,libopenmpi:8,librari:[0,2,8,10,16],libtool:8,libver:8,licens:16,lieu:0,like:[0,6,8,12],limit:[3,8],line:[0,8,12],linear:[0,3],lipid_self_assembl:6,list:0,list_coulomb:0,load:0,local:[0,8,11,12,14],locat:8,log:[0,2,12],log_fil:0,log_out:12,logfil:[0,2,12],logger:2,logic:0,logrecord:0,look:[6,8,12],loop:0,lost:3,low:[6,8],lsl:16,m_j:0,mac:8,machin:[2,16],made:0,mai:[0,2,3,6,8,11,12,15,16],main:[0,8,12],main_glob:8,maintain:16,make:[6,8],make_fapl:8,manner:6,manual:[8,10],manuel:16,map:[0,12],march:16,martini:6,martyna:16,mass:[0,3,4,15],massiv:16,master:0,match:0,math:0,mathbf:[0,4,5,6,9,11,13,14],mathcal:[6,13,14],mathmr:0,mathrm:[0,5,6,9,11,14],matter:[6,11,16],max_molecule_s:[0,3,6],maximum:[0,3,11,12],maxwel:[0,3],may:2,mbbjm:16,mean:[0,2,3],measur:11,medium:[0,3,6],melt:1,membran:6,memori:[0,8],mesh:[0,1,3,5,6,16],mesh_siz:[0,3,6,12],messag:0,messi:0,meta:6,metadata:0,method:[0,1,6,7,10,16],mh_0:14,micellular:6,michael:16,michel:16,might:[0,8],mimic:0,minim:6,minuscul:11,mirror:2,miss:16,mix:[0,6],model:[6,16],modifi:0,modul:[0,3,8,16],mol:[3,4,6,11,12,16],molecul:[0,3,12,14,15],molecular:[0,2,12,14,16],momenta:[0,12],momentum:[0,3,4],monoatom:6,more:[2,3,6,8,12,14,16],mortel:8,morten:16,most:[8,9,12,13,14],mostli:2,motion:[0,6],move:0,mpi4pi:[0,8,16],mpi:[0,2,3,10,11,12,16],mpi_num_rank:12,mpicc:8,mpifilteral:0,mpifilterroot:0,mpio:[2,8],mpip:8,mpirun:12,multiarrai:8,multipl:[0,3,6,12,15,16],must:[0,3,10],n_b:[0,3],n_flush:[0,3,6],n_frame:0,n_particl:[0,3],n_print:[0,3,6,12],n_step:[0,3,6,12],n_type:0,nabla:[0,14],nabla_a:13,name:[0,2,3,6,10,11,12,15],nanomet:[0,1],nanosecond:6,natur:[0,13],ndarrai:0,ne5et1y_:8,necessari:[0,6],necessit:[8,9],need:[0,6],neg:[0,6],neighbour:0,network:[0,11,12,15],networkx:0,neutralis:6,never:[0,3],nevertheless:3,newer:8,next:[0,6],non:[0,2,6,8],none:[0,3,8],nongnu:0,noqa:8,normal:[0,2,3,8,14],notabl:12,note:[0,6,8,12,13,14],notebook:[6,8,16],now:6,nproc:12,npt:[0,14,16],nq_i:5,number:[0,1,2,3,6,12,14,15],numer:0,numpi:[0,2,9,16],nve:16,nvt:[0,16],object:[0,9],oblat:6,observ:[0,6],obtain:[0,3,5,13,14,16],obviou:8,off:6,older:10,omit:6,onc:[3,11],one:[0,2,3,6,15],onli:[0,6,10,11,12],onto:[0,3,5,14],open:[0,8,16],openmpi:8,oper:[0,3,14,16],oppos:0,optim:[0,11],optimis:[6,11],option:[0,3,6,10,12],order:[0,3,6,11,12],ordinari:[5,14],org:[0,10,16],organis:6,origin:0,oslo:16,osx:8,other:[0,12],otherwis:0,out:[8,10,14],outdataset:0,outer:[0,3],outfil:[2,10],output:[2,3,4,6,8,10,12],outsid:3,over:0,overlap:[0,9],p_a:13,packag:[8,10,12,16],page:16,paint:0,paper:[0,16],parallel:[0,2,3,16],paramet:[0,3,6,7,9,13,14,16],parent_group:0,parllel:0,parrinello:[0,16],pars:[0,3],parse_config_toml:[0,8],part:[5,6,14],partial:[0,13],particl:[0,2,5,6,7,9,12,14,15,16],particlemesh:0,particular:12,pass:[0,10],path:[0,2,8,10,12],pdf:1,pencil:0,peptid:[0,2,3,5,16],per:[0,2,3,11,12,15],perfect:0,perform:[0,3,8,11,12,14,16],perman:[11,16],permitt:[0,4],pfft:[0,16],pfft_build_dir:8,phase:[0,11],phase_separ:6,phi:[0,3,6,11,13,14],phi_0:[6,9,14],phi_:[0,6,9,14],phi_ep:0,phi_eps_fouri:0,phi_eta:0,phi_eta_fouri:0,phi_fft:0,phi_fouri:0,phi_k:0,phi_l:0,phi_laplacian:0,phi_n:[6,11],phi_pol:0,phi_pol_prev:0,phi_q:0,phi_q_fouri:0,phi_t:13,phi_transf:0,phospholipid:6,phy:[0,16],pic_spectr:[0,3,6],pic_spectral_gp:0,piec:6,pip13:16,pip3:8,pip:[8,12,16],pippig:16,pkg:8,place:[0,3],plain:2,plane:[0,6,11],pleas:[8,12],plist:8,plume:[2,16],plumed2:0,plumed_bia:0,plumed_forc:0,plumed_input:10,plumed_kernel:10,plumed_obj:0,plumed_out:0,plumed_vers:0,plumedbia:0,plumeddat:0,pm_stuff:0,pme:16,pmesh:[0,16],png:1,point:[0,1,11,15],pointer:0,poisson:0,pol_mix:0,polar:0,polym:6,posit:[0,2,3,5,6,12,14],possibl:[0,3,6,16],postma:0,poteng:0,potenti:[0,3,4,5,7,8,11,16],ppft:16,practic:11,pre:[0,6],precis:[1,2],prefer:3,prepar:0,prepare_bond:0,prepare_bonds_old:0,prepare_index_based_bond:0,prepend:[0,12],present:[0,2,3,6],preserv:3,pressur:[4,14,16],pretti:8,previou:0,previous:6,prior:[0,3,10],priovid:0,prng:0,prod_:0,profil:2,program:[0,12],project:5,promot:0,prop:0,propag:[0,3],propens:[0,3,5,6],propensity_potential_coeff:0,properti:[0,3],protein:[0,16],provid:[0,2,3,10,12,15,16],psi:[0,4,5],psi_:5,psi_fouri:0,pull:8,push:16,put:6,pytest:12,python3:[6,8,10,12,16],python:[0,10,12,16],q_i:[0,5],q_j:0,quadrat:0,quanit:0,quantiti:[0,4],quantum:16,quartet:11,quess:0,r_0:[0,6,11],r_a:11,r_c:11,rad:[3,11],radial:6,radii:6,radiu:6,rainwoodman:8,rais:[6,8],random:[0,2,12],random_chi_squar:0,random_gaussian:0,randomli:[0,3,6],rang:5,rank0:0,rank:[0,2,3,11,12],rank_rang:0,rankself:0,rare:11,raw:8,rdcc_nbyte:8,rdcc_nslot:8,rdcc_w0:8,read:[0,8,12,16],read_config_toml:[0,8],readi:0,readout:0,real:15,realfield:0,realist:6,reappli:0,rearrang:0,reason:8,receiv:[0,3],recent:8,reciproc:[0,7],recognis:12,recommend:8,reconstruct:[0,2,5,6,11,16],record:0,recreat:16,recurs:0,redistribut:0,reduc:[3,14],refer:[3,12],regim:6,regul:[0,3],reiniti:0,rel:[0,3,6,11],relax:[0,3],releas:[0,6,8,12,16],remain:[0,6],remov:[0,3],remove_center_of_mass_momentum:0,remove_com_momentum:[0,3],replac:[0,8],replica:[0,10],repositori:[6,12],repres:[0,3,15],represent:7,repuls:3,request:0,requir:[0,3,8,11,12,16],rescal:[0,3,16],research:16,respa:[0,3,6],respa_inn:[0,3,6],respect:[0,1,14],restructur:0,result:[0,3,6,9],revers:[0,3,16],rho0:[0,3],rho:[0,5],rho_0:[0,14],rho_:5,right:[0,5,6,7,9,11,13,14],rightarrow:11,root:[0,12,15],roughi:6,row:12,rrespa:[0,3,6],ruin:0,run:[0,2,3,6,11],run_glob:8,rundown:12,runpi:8,runtimeerror:8,same:[0,3,6],samiran:16,sampl:[0,3,10,16],scalar:0,scale:[0,3,6,7,8,11,12,16],scheme:[0,6],sci:16,scienc:16,scr:3,script:12,sds:6,search:16,second:[0,12],see:[0,2,3,5,6,8,9,10,11,12,13,14,16],seed:[2,12],select:[12,16],self:[0,3,8],self_energi:0,semiisotrop:[0,3],seminumer:0,sen:16,send:[0,3],separ:0,seri:[0,3,6,11],serial:[8,12],serialis:3,set:[0,3,10,12],set_fapl:8,setup:[0,6,7,8,15],setup_time_dependent_el:0,setuptool:8,sever:0,shape:[0,6,12,15],sheet:0,shift:0,should:[0,2,11],shown:6,siam:16,sigbj:16,sigma:[0,3,6,7,12,13,14],sim:0,similar:0,simpl:[0,6,12,14],simplest:6,simpli:0,simul:[0,2,6,8,11,13,14,15,16],simultan:0,sinc:0,singl:[0,3,6,10],site:8,size:[0,3,6,12,14],slbc23:16,slight:0,slowli:14,small:[3,12],smear:5,smooth:[0,14],sodium:6,soft:[6,16],softwar:16,solv:0,solvent:6,some:[0,3,8],sort:0,sort_dielectric_by_type_id:0,sourc:[0,1],space:[0,3,5,7],span:0,spatial:[0,3,12,14],specfi:0,speci:0,special:0,specif:[0,2,3,6,9,11,12,14,15],specifi:[0,2,3,6,9,11,12,15],spectacularli:0,spectral:6,speed:[0,3],spheric:6,spheroid:6,split:0,spontan:6,spring:[0,11],sqrt:[0,7,14],squar:[0,9],squaredphi:[0,3,9,12],stabil:6,stabl:6,stackoverflow:0,standard:[0,3,14,16],start:[0,3,6,11,15],start_temperatur:[0,3,6],state:0,statu:8,stdout:[0,2],step:[0,3,6,11,12],stiff:3,stochast:0,store:0,store_data:0,store_stat:0,str10:12,str:0,straightforward:[7,9],stream:0,strength:[0,3,6,12],stretch:[0,3,11,16],string:[0,3,8,12,15],structur:[0,2,3,5,6,12],sub:6,subclass:[0,9],subsequ:[0,5,6,11],sudo:8,suitabl:[0,3],sulfat:6,sum:0,sum_:[0,5,9,13,14],sum_i:0,sum_j:0,sum_k:0,sum_n:[0,6,11],sum_t:13,summari:12,superclass:[0,7],support:[0,6,8,10],swap:11,symbol:[0,4,9],sympi:[0,9],sys:8,system:[0,1,2,3,6,9,12,14,16],t_a:13,tag:[0,3,8],take:[0,3,5,9,11,12,14],taken:0,tar:8,target:[0,3,14],target_pressur:[0,3],target_temperatur:[0,3,6,12],tau:[0,3,6,12],tau_p:[0,3],tbm92:16,temperatur:[0,3,4,6,12,14],ten:6,term:[0,3,6,9,13,14],test:[0,1],text:[0,2,3,4,5,6,9,11,13,14],than:[0,3],theoj:16,theori:[0,13],therefor:[8,10],thermalis:[0,3],thermostat:[2,3,6,12],thermostat_coupling_group:[0,3,6],thermostat_work:0,theta:[6,11],theta_0:[0,6,11],thi:[0,2,3,6,8,9,10,11,12,14],thorough:12,though:6,thousand:[6,11],three:[0,2,3,6],through:[0,3,6,7,8,9,11,16],tild:[0,3,4,5,6,9,13,14],time:[0,3,4,6,11,12,16],time_step:[0,3,6,12],tmp:8,todo:0,togeth:[0,3,6],token:8,toml:[0,2,3,6,8,10,11,12],toml_cont:0,tomli:0,too:3,toplog:0,topol:0,topolog:[0,2,3,5,6,12,16],torsion:[0,3,11,16],total:[0,3,6,12,13,14],traceback:8,trajectori:[0,2,3,6,12],trans_matric:0,transfer:[0,11],transform:[0,9,14],travers:0,tree:0,tri:3,trivial:0,truncat:0,tuckerman:[3,16],turn:6,tutori:[6,8,12,15],two:[0,2,3,6],txt:12,type:[0,2,3,5,6,9,11,12,15],type_arrai:0,type_charg:0,type_to_name_map:0,typic:3,ubuntu:8,uio:[8,12,16],unchang:0,under:[6,8,14,16],uniformli:0,uninstal:8,union:0,uniqu:0,unique_nam:0,unit:[0,3,11],univers:16,unknown:0,unless:[0,3],unmodifi:0,unset:0,unstabl:3,until:6,updat:[0,8],update_field:0,update_field_force_q:0,update_field_force_q_gp:0,upgrad:[8,16],url:16,usag:[0,2],use:[0,3,5,6,8,10],used:[0,1,2,3,6,7,9,12,14,15],user:10,uses:[0,4,14,16],using:[0,2,3,8,14,16],usr:8,usual:12,v_2:[0,6,11],v_3:[0,6,11],v_4:[0,6,11],v_ext:0,v_ext_fouri:0,vacuum:4,valid:[0,3],validated_config:0,valu:[0,3,4,5,6,11],valueerror:8,van:0,vanish:0,varepsilon:0,varepsilon_0:[4,5],vari:14,variabl:[0,10],variant:6,variou:[0,15],vbar_elec:0,vbar_elec_fouri:0,vector:[3,11],vectoris:9,veloc:[0,2,3,4,6,12,15,16],velocity_out:0,velocti:0,verbos:[0,2,8,12],veri:[6,8,11],verifi:0,verlet:[0,3,6,12],versa:3,version:[0,6,8,10,12,14],vert:0,vertex:[0,5],vertic:0,via:[6,16],vice:3,vir:13,virial:13,vol:0,volum:[0,3,13,14,16],voxel:0,wai:[8,14],warn:0,weakli:3,weight:0,well:6,were:0,weslei:0,wether:0,wheel:8,when:[0,2,3,8,10,11],where:[0,5,9,11,13,14],whether:[0,3],which:[0,2,3,5,6,8,9,11,12,13],width:[0,3],window:[0,5,14],within:0,without:[0,16],work:[0,8,10],workload:0,would:[0,3],wrap:0,wrapper:0,write:[0,3],written:[0,3],www:[0,10],xinmeng:16,yet:0,yield:6,you:[8,10,11],your:10,zero:[0,3]},titles:["4. API reference","3. Benchmarks","5. Command line arguments","3. Configuration file","6. Constants and Units","3. Electrostatic interactions","1. Examples","2. Filtering","1. Installation","1. Interaction energy functionals","5. PLUMED interface","2. Intramolecular bonds","2. Usage overview for HylleraasMD","4. Pressure","1. Theory","4. Topology and structure file","HylleraasMD documentation"],titleterms:{"function":9,"import":8,"new":[7,9],"while":8,SDS:6,api:0,argument:2,assembl:6,barostat:0,benchmark:1,berendsen:0,bilay:6,bond:[1,3,11],build:8,calcul:14,chain:6,chi:9,code:16,colab:16,colaboratori:8,command:2,common:8,configur:3,constant:4,copolym:6,curl:8,dataset:15,depend:8,develop:16,diblock:6,docker:8,document:16,due:8,electrostat:[3,5],enabl:8,energi:9,error:8,exampl:6,extern:14,field:[0,1,3],file:[0,3,15],filter:[7,14],forc:[0,1,8,14],form:[9,14],fortran:8,four:11,gas:6,googl:[8,16],guid:16,h5py:8,hamiltonian:[0,14],helix:6,hylleraasmd:[12,16],hymd:[8,16],ideal:6,implement:[7,9],incompress:9,indic:16,input:0,instal:[8,16],integr:0,interact:[5,8,9],interfac:10,interpol:14,intramolecular:11,issu:8,kappa:9,kernel:8,keyword:3,line:2,lipid:6,logger:0,metadata:3,miss:8,mpi:8,numpi:8,onli:9,option:[2,15],output:0,overview:12,parallel:[8,12],parser:0,particl:[1,3,11],peptid:6,pfft:8,phase:6,phi:9,plume:[0,10],potenti:14,pressur:[0,3,13],python:8,reciproc:14,refer:[0,16],requir:[2,15],rod:6,run:[8,10,12,16],scr:0,self:6,separ:6,simul:[3,10,12],sourc:16,space:14,specifi:5,stiff:6,structur:15,tabl:16,test:12,theori:14,thermostat:0,three:11,topolog:15,two:11,unit:4,usag:12,user:16,using:10,wget:8,without:8}}) \ No newline at end of file diff --git a/v2.2.0/.buildinfo b/v2.2.0/.buildinfo new file mode 100644 index 00000000..0d25f1b6 --- /dev/null +++ b/v2.2.0/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: df9eaa88d927f33391f649de43af831d +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/v2.2.0/.doctrees/doc_pages/api.doctree b/v2.2.0/.doctrees/doc_pages/api.doctree new file mode 100644 index 00000000..37b39d7c Binary files /dev/null and b/v2.2.0/.doctrees/doc_pages/api.doctree differ diff --git a/v2.2.0/.doctrees/doc_pages/benchmarks.doctree b/v2.2.0/.doctrees/doc_pages/benchmarks.doctree new file mode 100644 index 00000000..353f1e1d Binary files /dev/null and b/v2.2.0/.doctrees/doc_pages/benchmarks.doctree differ diff --git a/v2.2.0/.doctrees/doc_pages/command_line.doctree b/v2.2.0/.doctrees/doc_pages/command_line.doctree new file mode 100644 index 00000000..38e47c97 Binary files /dev/null and b/v2.2.0/.doctrees/doc_pages/command_line.doctree differ diff --git a/v2.2.0/.doctrees/doc_pages/config_file.doctree b/v2.2.0/.doctrees/doc_pages/config_file.doctree new file mode 100644 index 00000000..c7d3ee41 Binary files /dev/null and b/v2.2.0/.doctrees/doc_pages/config_file.doctree differ diff --git a/v2.2.0/.doctrees/doc_pages/constants_and_units.doctree b/v2.2.0/.doctrees/doc_pages/constants_and_units.doctree new file mode 100644 index 00000000..847d7905 Binary files /dev/null and b/v2.2.0/.doctrees/doc_pages/constants_and_units.doctree differ diff --git a/v2.2.0/.doctrees/doc_pages/electrostatics.doctree b/v2.2.0/.doctrees/doc_pages/electrostatics.doctree new file mode 100644 index 00000000..50837500 Binary files /dev/null and b/v2.2.0/.doctrees/doc_pages/electrostatics.doctree differ diff --git a/v2.2.0/.doctrees/doc_pages/examples.doctree b/v2.2.0/.doctrees/doc_pages/examples.doctree new file mode 100644 index 00000000..3689d68d Binary files /dev/null and b/v2.2.0/.doctrees/doc_pages/examples.doctree differ diff --git a/v2.2.0/.doctrees/doc_pages/filtering.doctree b/v2.2.0/.doctrees/doc_pages/filtering.doctree new file mode 100644 index 00000000..5699f9fa Binary files /dev/null and b/v2.2.0/.doctrees/doc_pages/filtering.doctree differ diff --git a/v2.2.0/.doctrees/doc_pages/installation.doctree b/v2.2.0/.doctrees/doc_pages/installation.doctree new file mode 100644 index 00000000..66188b0e Binary files /dev/null and b/v2.2.0/.doctrees/doc_pages/installation.doctree differ diff --git a/v2.2.0/.doctrees/doc_pages/interaction_energy_functionals.doctree b/v2.2.0/.doctrees/doc_pages/interaction_energy_functionals.doctree new file mode 100644 index 00000000..51e0ed24 Binary files /dev/null and b/v2.2.0/.doctrees/doc_pages/interaction_energy_functionals.doctree differ diff --git a/v2.2.0/.doctrees/doc_pages/interfaces.doctree b/v2.2.0/.doctrees/doc_pages/interfaces.doctree new file mode 100644 index 00000000..e47baf00 Binary files /dev/null and b/v2.2.0/.doctrees/doc_pages/interfaces.doctree differ diff --git a/v2.2.0/.doctrees/doc_pages/intramolecular_bonds.doctree b/v2.2.0/.doctrees/doc_pages/intramolecular_bonds.doctree new file mode 100644 index 00000000..a5554eb8 Binary files /dev/null and b/v2.2.0/.doctrees/doc_pages/intramolecular_bonds.doctree differ diff --git a/v2.2.0/.doctrees/doc_pages/overview.doctree b/v2.2.0/.doctrees/doc_pages/overview.doctree new file mode 100644 index 00000000..26a2f88f Binary files /dev/null and b/v2.2.0/.doctrees/doc_pages/overview.doctree differ diff --git a/v2.2.0/.doctrees/doc_pages/pressure.doctree b/v2.2.0/.doctrees/doc_pages/pressure.doctree new file mode 100644 index 00000000..a372e241 Binary files /dev/null and b/v2.2.0/.doctrees/doc_pages/pressure.doctree differ diff --git a/v2.2.0/.doctrees/doc_pages/theory.doctree b/v2.2.0/.doctrees/doc_pages/theory.doctree new file mode 100644 index 00000000..d3d61595 Binary files /dev/null and b/v2.2.0/.doctrees/doc_pages/theory.doctree differ diff --git a/v2.2.0/.doctrees/doc_pages/topology_input.doctree b/v2.2.0/.doctrees/doc_pages/topology_input.doctree new file mode 100644 index 00000000..b44b4086 Binary files /dev/null and b/v2.2.0/.doctrees/doc_pages/topology_input.doctree differ diff --git a/v2.2.0/.doctrees/environment.pickle b/v2.2.0/.doctrees/environment.pickle new file mode 100644 index 00000000..f1b4a4c7 Binary files /dev/null and b/v2.2.0/.doctrees/environment.pickle differ diff --git a/v2.2.0/.doctrees/index.doctree b/v2.2.0/.doctrees/index.doctree new file mode 100644 index 00000000..431014ba Binary files /dev/null and b/v2.2.0/.doctrees/index.doctree differ diff --git a/v2.2.0/_downloads/06277b09d9dbd669eb066a87bde69764/benchmarks-2.png b/v2.2.0/_downloads/06277b09d9dbd669eb066a87bde69764/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v2.2.0/_downloads/06277b09d9dbd669eb066a87bde69764/benchmarks-2.png differ diff --git a/v2.2.0/_downloads/65e54d27de07d1f3391023244e2c96b6/benchmarks-2.py b/v2.2.0/_downloads/65e54d27de07d1f3391023244e2c96b6/benchmarks-2.py new file mode 100644 index 00000000..fd287cbc --- /dev/null +++ b/v2.2.0/_downloads/65e54d27de07d1f3391023244e2c96b6/benchmarks-2.py @@ -0,0 +1,33 @@ +import numpy as np +import matplotlib.pyplot as plt + +mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] +mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + +mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + +mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] +mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + +mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] +mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + +mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + +mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] +mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + +plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") +plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") +plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") +plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") +plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") +plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") +plt.xlabel("CPUs", fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.ylabel("Time per step, s", fontsize=15) +plt.legend(loc="upper left", fontsize=15) +plt.show() \ No newline at end of file diff --git a/v2.2.0/_downloads/682597475ba7aeb79c5d27601a114807/benchmarks-1.png b/v2.2.0/_downloads/682597475ba7aeb79c5d27601a114807/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v2.2.0/_downloads/682597475ba7aeb79c5d27601a114807/benchmarks-1.png differ diff --git a/v2.2.0/_downloads/9732f060c48ad320d8ef77b0255fa65c/benchmarks-2.hires.png b/v2.2.0/_downloads/9732f060c48ad320d8ef77b0255fa65c/benchmarks-2.hires.png new file mode 100644 index 00000000..82806426 Binary files /dev/null and b/v2.2.0/_downloads/9732f060c48ad320d8ef77b0255fa65c/benchmarks-2.hires.png differ diff --git a/v2.2.0/_downloads/c2b4427af0abc490fea62e3654884461/benchmarks-1.py b/v2.2.0/_downloads/c2b4427af0abc490fea62e3654884461/benchmarks-1.py new file mode 100644 index 00000000..deb4348f --- /dev/null +++ b/v2.2.0/_downloads/c2b4427af0abc490fea62e3654884461/benchmarks-1.py @@ -0,0 +1,38 @@ +import numpy as np +import matplotlib.pyplot as plt +nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) +time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 +], dtype=np.float64) +nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 +], dtype=np.float64,) +time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, +], dtype=np.float64) +nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 +], dtype=np.float64) +time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, +], dtype=np.float64) +plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" +) +plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" +) +plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" +) +plt.xlabel("CPUs", fontsize=15) +plt.ylabel("Time per step, us", fontsize=15) +plt.legend(fontsize=15) +plt.xscale('log', base=2) +plt.yscale('log', base=2) +plt.show() \ No newline at end of file diff --git a/v2.2.0/_downloads/d3fab0727cec9bfe48cd44e3926f8b8b/benchmarks-1.pdf b/v2.2.0/_downloads/d3fab0727cec9bfe48cd44e3926f8b8b/benchmarks-1.pdf new file mode 100644 index 00000000..7e3c284f Binary files /dev/null and b/v2.2.0/_downloads/d3fab0727cec9bfe48cd44e3926f8b8b/benchmarks-1.pdf differ diff --git a/v2.2.0/_downloads/d80367d2b3a595c564d561412e710698/benchmarks-1.hires.png b/v2.2.0/_downloads/d80367d2b3a595c564d561412e710698/benchmarks-1.hires.png new file mode 100644 index 00000000..173b39f3 Binary files /dev/null and b/v2.2.0/_downloads/d80367d2b3a595c564d561412e710698/benchmarks-1.hires.png differ diff --git a/v2.2.0/_downloads/f62fcc5108e569ea2fe61890ff1f4f10/benchmarks-2.pdf b/v2.2.0/_downloads/f62fcc5108e569ea2fe61890ff1f4f10/benchmarks-2.pdf new file mode 100644 index 00000000..be18b504 Binary files /dev/null and b/v2.2.0/_downloads/f62fcc5108e569ea2fe61890ff1f4f10/benchmarks-2.pdf differ diff --git a/v2.2.0/_images/benchmarks-1.png b/v2.2.0/_images/benchmarks-1.png new file mode 100644 index 00000000..766335cb Binary files /dev/null and b/v2.2.0/_images/benchmarks-1.png differ diff --git a/v2.2.0/_images/benchmarks-2.png b/v2.2.0/_images/benchmarks-2.png new file mode 100644 index 00000000..61c630a5 Binary files /dev/null and b/v2.2.0/_images/benchmarks-2.png differ diff --git a/v2.2.0/_images/hylleraas_centre_logo_black.png b/v2.2.0/_images/hylleraas_centre_logo_black.png new file mode 100644 index 00000000..40826396 Binary files /dev/null and b/v2.2.0/_images/hylleraas_centre_logo_black.png differ diff --git a/v2.2.0/_images/uio_full_logo_eng_pos.png b/v2.2.0/_images/uio_full_logo_eng_pos.png new file mode 100644 index 00000000..6c603139 Binary files /dev/null and b/v2.2.0/_images/uio_full_logo_eng_pos.png differ diff --git a/v2.2.0/_modules/hymd/barostat.html b/v2.2.0/_modules/hymd/barostat.html new file mode 100644 index 00000000..13d92e20 --- /dev/null +++ b/v2.2.0/_modules/hymd/barostat.html @@ -0,0 +1,604 @@ + + + + + + hymd.barostat — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.barostat

+"""Implements the Berendsen barostat.
+Scales the box and particle positions during simulation to
+simulate coupling to an external pressure bath set at a
+target pressure.
+
+It calculates the scaling factor according to:
+.. math::
+
+    \\alpha_{L,N} = 1 - \\frac{dt n_b}{\\tau_p}\\β(P_{L,N}^t - P_{L,N})
+
+where :math:`dt` is the outer rRESPA time-step, :math:`n_b` is the frequency
+of barostat calls, :math:`\\tau_p` is the pressure coupling time constant,
+:math:`\\beta` is the isothermal compressibility, :math:`P_{L,N}^t` and 
+:math:`P_{L,N}` is the target and instantaneous internal pressure in the 
+lateral (L) and normal (N) directions respectively. Convention: Cartesian
+z-direction is considered normal.
+
+The box and particle positions are scaled in the L and N directions according
+to the nature of the barostat (see functions `isotropic` and `semiisotropic`
+below by an amount :math:`\α^{\\frac{1}{3}}`.
+
+The updated system information is passed on to the pmesh objects.
+
+References
+----------
+H. J. C. Berendsen, J. P. M. Postma, W. F. van Gunsteren,
+A. DiNola, and J. R. Haak , "Molecular dynamics with coupling
+to an external bath", J. Chem. Phys. 81, 3684-3690 (1984)
+"""
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass
+from typing import Union
+from .pressure import comp_pressure
+from .field import initialize_pm
+
+
+@dataclass
+class Target_pressure:
+    P_L: Union[bool, float]
+    P_N: Union[bool, float]
+
+
+
[docs]def isotropic( + pmesh, + pm_stuff, + phi, + phi_q, + psi, + hamiltonian, + positions, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + bond_pr, + angle_pr, + step, + prng, + comm=MPI.COMM_WORLD, +): + """ + Implements an isotropic Berendsen barostat. + The box and particle positions are scaled uniformly + in the L and N directions. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of pmesh objects. + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fft : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds. + step : integer + MD step number + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of modified/unmodified pmesh objects. + change : Boolean + Indicates whether or not any pmesh objects were reinitialized. + """ + rank = comm.Get_rank() + beta = 4.6 * 10 ** (-5) # bar^(-1) #isothermal compressibility of water + change = False + + if np.mod(step, config.n_b) == 0: + change = True + # compute pressure + pressure = comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=comm, + ) + + # Total pressure across all ranks + P = np.average(pressure[-3:-1]) # kJ/(mol nm^3) + P = P * 16.61 # bar + + # scaling factor + alpha = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_L - P) + ) ** (1 / 3) + + # length scaling + config.box_size *= alpha + + # position coordinates scaling + positions *= alpha + + # pmesh re-initialize + pm_stuff = initialize_pm(pmesh, config, comm) + return (pm_stuff, change)
+ + +
[docs]def semiisotropic( + pmesh, + pm_stuff, + phi, + phi_q, + psi, + hamiltonian, + positions, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + bond_pr, + angle_pr, + step, + prng, + comm=MPI.COMM_WORLD, +): + """ + Implements a semiisotropic Berendsen barostat. + The box and particle positions are scaled by :math:`\\alpha_L^{\\frac{1}{3}}` + in the L direction and by :math:`\\alpha_N^{\\frac{1}{3}}` in the N direction. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of pmesh objects. + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fft : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds. + step : integer + MD step number + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm_stuff : list[Union(pmesh.pm.RealField, pmesh.pm.ComplexField] + List of modified/unmodified pmesh objects. + change : Boolean + Indicates whether or not any pmesh objects were reinitialized. + """ + rank = comm.Get_rank() + beta = 4.6 * 10 ** (-5) # bar^(-1) #isothermal compressibility of water + change = False + if np.mod(step, config.n_b) == 0: + change = True + + # compute pressure + pressure = comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fft, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=comm, + ) + + # Total pressure across all ranks + # L: Lateral; N: Normal + [PL, PN] = [0, 0] + PL = (pressure[-3] + pressure[-2]) / 2 # kJ/(mol nm^3) + PN = pressure[-1] # kJ/(mol nm^3) + PL = PL * 16.61 # bar + PN = PN * 16.61 # bar + alphaL = 1.0 + alphaN = 1.0 + + if config.target_pressure.P_L: + # scaling factor + alphaL = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_L - PL) + ) ** (1 / 3) + # length scaling + config.box_size[0:2] *= alphaL + + positions[:][0:2] *= alphaL + + if config.target_pressure.P_N: + # scaling factor + alphaN = ( + 1.0 + - (config.time_step * config.respa_inner) + * config.n_b + / config.tau_p + * beta + * (config.target_pressure.P_N - PN) + ) ** (1 / 3) + # length scaling + config.box_size[2] *= alphaN + + positions[:][2] *= alphaN + + # pmesh re-initialize + pm_stuff = initialize_pm(pmesh, config, comm) + return (pm_stuff, change)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/_modules/hymd/field.html b/v2.2.0/_modules/hymd/field.html new file mode 100644 index 00000000..7fa356ef --- /dev/null +++ b/v2.2.0/_modules/hymd/field.html @@ -0,0 +1,1473 @@ + + + + + + hymd.field — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.field

+"""Forces and energies from the discretized particle-field grid interactions
+"""
+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import warnings
+
+
+
[docs]def initialize_pm(pmesh, config, comm=MPI.COMM_WORLD): + """ + Creates the necessary pmesh objects for pfft operations. + + Parameters + ---------- + pmesh : module 'pmesh.pm' + config : Config + Configuration dataclass containing simulation metadata and parameters. + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pm : object 'pmesh.pm.ParticleMesh' + field_list : list[pmesh.pm.RealField], (multiple) + Essential list of pmesh objects required for MD + list_coulomb : list[pmesh.pm.RealField], (multiple) + Additional list of pmesh objects required for electrostatics. + """ + + if config.dtype == np.float64: + pmeshtype = "f8" + else: + pmeshtype = "f4" + # Ignore numpy numpy.VisibleDeprecationWarning: Creating an ndarray from + # ragged nested sequences until it is fixed in pmesh + with warnings.catch_warnings(): + warnings.filterwarnings( + action="ignore", + category=np.VisibleDeprecationWarning, + message=r"Creating an ndarray from ragged nested sequences", + ) + # The first argument of ParticleMesh has to be a tuple + pm = pmesh.ParticleMesh( + config.mesh_size, BoxSize=config.box_size, dtype=pmeshtype, comm=comm + ) + phi = [pm.create("real", value=0.0) for _ in range(config.n_types)] + phi_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] # noqa: E501 + force_on_grid = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + v_ext_fourier = [pm.create("complex", value=0.0) for _ in range(4)] + v_ext = [pm.create("real", value=0.0) for _ in range(config.n_types)] + + phi_transfer = [pm.create("complex", value=0.0) for _ in range(3)] + + phi_laplacian = [ + [pm.create("real", value=0.0) for d in range(3)] for _ in range(config.n_types) + ] + + # Initialize charge density fields + coulomb_list = [] + elec_common_list = [None, None, None, None] + _SPACE_DIM = config.box_size.size + + if config.coulombtype == "PIC_Spectral_GPE" or config.coulombtype == "PIC_Spectral": + phi_q = pm.create("real", value=0.0) + phi_q_fourier = pm.create("complex", value=0.0) + psi = pm.create("real", value=0.0) + elec_field = [pm.create("real", value=0.0) for _ in range(_SPACE_DIM)] + + elec_common_list = [phi_q, phi_q_fourier, psi, elec_field] + + if config.coulombtype == "PIC_Spectral": + elec_field_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] # for force calculation + psi_fourier = pm.create("complex", value=0.0) + + coulomb_list = [ + elec_field_fourier, + psi_fourier, + ] + + if ( + config.coulombtype == "PIC_Spectral_GPE" + ): ## initializing the density mesh #dielectric_flag + phi_eps = pm.create( + "real", value=0.0 + ) ## real contrib of the epsilon dielectric painted to grid + phi_eps_fourier = pm.create("complex", value=0.0) # complex contrib of phi eps + phi_eta = [ + pm.create("real", value=0.0) for _ in range(_SPACE_DIM) + ] ## real contrib of factor in polarization charge density + phi_eta_fourier = [ + pm.create("complex", value=0.0) for _ in range(_SPACE_DIM) + ] ## fourier of factor in polarization charge density + phi_pol = pm.create( + "real", value=0.0 + ) ## real contrib of the polarization charge + phi_pol_prev = pm.create("real", value=0.0) + elec_dot = pm.create("real", value=0.0) + elec_field_contrib = pm.create( + "real", value=0.0 + ) # needed for pol energies later + + # External potential and force meshes + Vbar_elec = [pm.create("real", value=0.0) for _ in range(config.n_types)] + Vbar_elec_fourier = [ + pm.create("complex", value=0.0) for _ in range(config.n_types) + ] + force_mesh_elec = [ + [pm.create("real", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + force_mesh_elec_fourier = [ + [pm.create("complex", value=0.0) for d in range(3)] + for _ in range(config.n_types) + ] + + coulomb_list = [ + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol, + phi_pol_prev, + elec_dot, + elec_field_contrib, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + ] + + field_list = [ + phi, + phi_fourier, + force_on_grid, + v_ext_fourier, + v_ext, + phi_transfer, + phi_laplacian, + ] + + return (pm, field_list, elec_common_list, coulomb_list)
+ + +
[docs]def compute_field_force(layouts, r, force_mesh, force, types, n_types): + """Interpolate particle-field forces from the grid onto particle positions + + Backmaps the forces calculated on the grid to particle positions using the + window function :math:`P` (by default cloud-in-cell [CIC]). In the + following, let :math:`\\mathbf{F}_j` denote the force acting on the + particle with index :math:`j` and position :math:`\\mathbf{r}_j`. The + interpolated force is + + .. math:: + + \\mathbf{F}_j = -\\sum_k\\nabla V_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`V_{j_k}` is the discretized external potential at grid vertex + :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid vertex + with index :math:`j_k`, and :math:`h^3` is the volume of each grid voxel. + The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + r : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + force : (N,D) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. Local + for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + n_types : int + Number of different unique types present in the simulation system. + :code:`n_types` is global, i.e. the same for all MPI ranks even if some + ranks contain zero particles of certain types. + """ + for t in range(n_types): + ind = types == t + for d in range(3): + force[ind, d] = force_mesh[t][d].readout(r[ind], layout=layouts[t])
+ + +
[docs]def compute_self_energy_q(config, charges, comm=MPI.COMM_WORLD): + """Compute the self energy for the interaction due to the Ewald scheme + used to compute the electrostatics. The energy is stored in :code:`config`. + + The self interaction energy is given by: + + .. math:: + + U_{self} = \\sqrt{\\frac{1}{2\\pi\\sigma^2}} \\sum_{i=1}^{N} q_i^2 + + where :math:`q_i` are the charges and :math:`\\sigma` is the half-width + of the Gaussian filter. + + Parameters + ---------- + config : Config + Configuration object. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + comm : mpi4py.Comm + MPI communicator to use for rank communication. + + Returns + ------- + field_q_self_energy : float + Electrostatic self energy. + """ + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + prefac = elec_conversion_factor * np.sqrt( + 1.0 / (2.0 * np.pi * config.sigma * config.sigma) + ) + _squared_charges = charges * charges + squared_charges_sum = comm.allreduce(np.sum(_squared_charges)) + return prefac * squared_charges_sum
+ + +
[docs]def update_field_force_q( + charges, + phi_q, + phi_q_fourier, + psi, + psi_fourier, + elec_field_fourier, + elec_field, + elec_forces, + layout_q, + hamiltonian, + pm, + positions, + config, +): + """Calculate the electrostatic particle-field forces on the grid + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential is computed in reciprocal space as + + .. math:: + + \\Phi = \\mathrm{FFT}^{-1}\\left[ + \\frac{4\\pi k_e}{\\varepsilon \\vert\\mathbf{k}\\vert^2} + \\mathrm{FFT}(\\rho)\\mathrm{FFT}(H) + \\right], + + with the electric field + + .. math:: + + \\mathbf{E} = \\mathrm{FFT}^{-1}\\left[ + -i\\mathbf{k}\\,\\mathrm{FFT}(\\Psi) + \\right]. + + In the following, let :math:`\\mathbf{F}_j` denote the electrostatic force + acting on the particle with index :math:`j` and position + :math:`\\mathbf{r}_j`. The interpolated electrostatic force is + + .. math:: + + \\mathbf{F}_j = \\sum_k q_j\\mathbf{E}_{j_k} + P(\\mathbf{r}_{j_k}-\\mathbf{r}_j)h^3, + + where :math:`\\mathbf{E}_{j_k}` is the discretized electric field at grid + vertex :math:`j_k`, :math:`\\mathbf{r}_{j_k}` is the position of the grid + vertex with index :math:`j_k`, and :math:`h^3` is the volume of each grid + voxel. The sum is taken over all closest neighbour vertices, :math:`j_k`. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty; any values in this field + are discarded. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + elec_field_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + electric field values in reciprocal space on the computational grid. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty; any values in this field are discarded. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + n_dimensions = config.box_size.size + elec_conversion_factor = config.coulomb_constant / config.dielectric_const + + # charges to grid + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) + phi_q /= volume_per_cell + # print("phi_q", np.sum(phi_q)) + phi_q.r2c(out=phi_q_fourier) + + # smear charges with filter + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + + # solve Poisson equation in Fourier space to get electrostatic potential + def poisson_transfer_function(k, v): + return 4.0 * np.pi * elec_conversion_factor * v / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(poisson_transfer_function, out=psi_fourier) + # print("psi_fourier", np.sum(psi_fourier)) + psi_fourier.c2r(out=psi) + # print("phi_q * psi update_field", np.sum(phi_q * psi)) + + # exit() + + # compute electric field directly from smeared charged densities in Fourier + for _d in np.arange(n_dimensions): + + def poisson_transfer_function(k, v, d=_d): + return ( + -1j + * k[d] + * 4.0 + * np.pi + * elec_conversion_factor + * v + / k.normp(p=2, zeromode=1) + ) + + phi_q_fourier.apply(poisson_transfer_function, out=elec_field_fourier[_d]) + elec_field_fourier[_d].c2r(out=elec_field[_d]) + + # get electrostatic force from electric field + for _d in np.arange(n_dimensions): + elec_forces[:, _d] = charges * ( + elec_field[_d].readout(positions, layout=layout_q) + )
+ + +def comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, +): + for t in range(config.n_types): + np.copyto(phi_transfer[0].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[1].value, phi_fourier[t].value, casting="no", where=True) + np.copyto(phi_transfer[2].value, phi_fourier[t].value, casting="no", where=True) + + # Evaluate laplacian of phi in fourier space + for d in range(3): + + def laplacian_transfer(k, v, d=d): + return -k[d] ** 2 * v + + phi_transfer[d].apply(laplacian_transfer, out=Ellipsis) + phi_transfer[d].c2r(out=phi_laplacian[t][d]) + + +
[docs]def update_field( + phi, + phi_laplacian, + phi_transfer, + layouts, + force_mesh, + hamiltonian, + pm, + positions, + types, + config, + v_ext, + phi_fourier, + v_ext_fourier, + m, + compute_potential=False, +): + """Calculate the particle-field potential and force density + + If :code:`compute_potential` is :code:`True`, the energy may subsequently + be computed by calling :code:`compute_field_and_kinetic_energy`. + + Computes the particle-field external potential :math:`V_\\text{ext}` from + particle number densities through the smoothed density field, + :math:`\\phi(\\mathbf{r})`. With :math:`P` being the cloud-in-cell (CIC) + window function, the density and filtered densities are computed as + + .. math:: + + \\phi(\\mathbf{r}) = \\sum_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\phi(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\phi(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + external potential is computed in reciprocal space as + + .. math:: + + V_\\text{ext} = \\mathrm{FFT}^{-1}\\left[ + \\mathrm{FFT} + \\left( + \\frac{\\partial w}{\\partial \\tilde\\phi} + \\right) + \\mathrm{FFT}(H) + \\right], + + where :math:`w` is the interaction energy functional. Differentiating + :math:`V_\\text{ext}` is done by simply applying :math:`i\\mathbf{k}` in + Fourier space, and the resulting forces are back-transformed to direct + space and interpolated to particle positions by + + .. math:: + + \\mathbf{F}_j = -\\sum_{j_k} \\nabla V_{j_k} + P(\\mathbf{r}_{j_k} - \\mathbf{r}_j)h^3, + + where :math:`j_k` are the neighbouring vertices of particle :math:`j` at + position :math:`\\mathbf{r}_j`, and :math:`h^3` is the volume of each grid + voxel. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + force_mesh : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + force density values on the computational grid; :code:`D` fields in D + dimensions for each particle type. Pre-allocated, but empty; any values + in this field are discarded. Changed in-place. Local for each MPI + rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + config : Config + Configuration object. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Pre-allocated, but empty; any values in this field are + discarded Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all MPI + ranks. + phi_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computational grid is represented by the collective fields of all + MPI ranks. + v_ext_fourier : list[pmesh.pm.ComplexField] + Pmesh :code:`ComplesField` objects containing discretized + particle-field external potential values in reciprocal space on the + computational grid; :code:`D+1` fields in D dimensions for each + particle type. :code:`D` copies are made after calculation for later + use in force calculation, because the `force transfer function` + application differentiates the field in-place, ruining the contents + for differentiation in the remaining :code:`D-1` spatial directions. + Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computational grid + is represented by the collective fields of all MPI ranks. + m: list[float], (M,) + pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. + Defaults to 1.0 for all particle types. + compute_potential : bool, optional + If :code:`True`, a :code:`D+1`-th copy of the Fourier transformed + external potential field is made to be used later in particle-field + energy calculation. If :code:`False`, only :code:`D` copies are made. + + See also + -------- + compute_field_and_kinetic_energy : + Compute the particle-field energy after the external potential is + calculated. + """ + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + for t in range(config.n_types): + pm.paint(positions[types == t], mass=m[t], layout=layouts[t], out=phi[t]) + phi[t] /= volume_per_cell + phi[t].r2c(out=phi_fourier[t]) + phi_fourier[t].apply(hamiltonian.H, out=Ellipsis) + phi_fourier[t].c2r(out=phi[t]) + + # External potential + for t in range(config.n_types): + v = hamiltonian.v_ext[t](phi) + + v.r2c(out=v_ext_fourier[0]) + v_ext_fourier[0].apply(hamiltonian.H, out=Ellipsis) + np.copyto( + v_ext_fourier[1].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + np.copyto( + v_ext_fourier[2].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + if compute_potential: + np.copyto( + v_ext_fourier[3].value, + v_ext_fourier[0].value, + casting="no", + where=True, + ) + + # Differentiate the external potential in fourier space + for d in range(3): + + def force_transfer_function(k, v, d=d): + return -k[d] * 1j * v + + v_ext_fourier[d].apply(force_transfer_function, out=Ellipsis) + v_ext_fourier[d].c2r(out=force_mesh[t][d]) + + if compute_potential: + v_ext_fourier[3].c2r(out=v_ext[t])
+ + +
[docs]def compute_field_and_kinetic_energy( + phi, + phi_q, + psi, + velocity, + hamiltonian, + positions, + types, + v_ext, + config, + layouts, + comm=MPI.COMM_WORLD, +): + """Compute the particle-field and kinetic energy contributions + + Calculates the kinetic energy through + + .. math:: + + E_k = \\sum_j \\frac{1}{2}m_j\\mathbf{v}_j\\cdot\\mathbf{v}_j, + + and the particle-field energy by + + .. math:: + + E_\\text{field} = \\int\\mathrm{d}\\mathbf{r}\\, + w[\\tilde\\phi], + + where :math:`w` is the interaction energy functional `density`. + + Parameters + ---------- + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + velocity : (N,D) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + v_ext : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle-field + external potential values on the computational grid; one for each + particle type. Local for each MPI rank--the full computational grid is + represented by the collective fields of all MPI ranks. + config : Config + Configuration object. + layouts : list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field : + Computes the up-to-date external potential for use in calculating the + particle-field energy. + """ + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + field_energy = w_0.csum() # w to W + + kinetic_energy = comm.allreduce(0.5 * config.mass * np.sum(velocity**2)) + + if config.coulombtype == "PIC_Spectral": + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + field_q_energy = w_elec.csum() + else: + field_q_energy = 0.0 + + return field_energy, kinetic_energy, field_q_energy
+ + +
[docs]def compute_field_energy_q_GPE( + config, + phi_eps, + field_q_energy, + dot_elec, + comm=MPI.COMM_WORLD, +): + """ + Compute the electrostatic energy after electrosatic forces is + calculated. + + From the definition of the elecrostatic potential :math:`\\Psi`, the energy + is + + W = \\frac{1}{2}\\int\\mathrm{d}\\mathbf{r}\\, + \\epsilon(\\mathbf{r})} \\left(\\mathbf{E}\\cdot \\mathbf{E}\\right), + + where :math:`\\epsilon(\\mathbf{r})}` is the anisotropic, spatially dependent, + relative dielectric of the simulation medium. + + Parameters + ---------- + config : hymd.input_parser.Config + Configuration object. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + field_q_energy : float + Total elecrostatic energy. + dot_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing :math:`|\\mathbf{E(r)}|^{2}` + on the computational grid. Local for each MPI rank -- the full computational + grid is represented by the collective fields of all MPI ranks. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + update_field_force_q_GPE: + Compute the electrosatic force from an anisotropic dielectric general + Poisson equation. + """ + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + # ^ due to integration on local cell before allreduce + + eps_0 = 1.0 / (config.coulomb_constant * 4 * np.pi) + field_q_energy = ( + volume_per_cell * (0.5 * eps_0) * comm.allreduce(np.sum(phi_eps * dot_elec)) + ) + + return field_q_energy
+ + +
[docs]def update_field_force_q_GPE( + conv_fun, + phi, + types, + charges, + phi_q, + phi_q_fourier, + phi_eps, + phi_eps_fourier, + phi_eta, + phi_eta_fourier, + phi_pol_prev, + phi_pol, + elec_field, + elec_forces, + elec_field_contrib, + psi, + Vbar_elec, + Vbar_elec_fourier, + force_mesh_elec, + force_mesh_elec_fourier, + hamiltonian, + layout_q, + layouts, + pm, + positions, + config, + comm=MPI.COMM_WORLD, +): + """ + Calculate the electrostatic particle-field forces on the grid, arising from + a general Poisson equation, i.e. anisotropic permittivity/dielectric. + The function is called when tomli input config.coulombtype = "PIC_Spectral_GPE." + + Computes the electrostatic potential :math:`\\Psi` from particle charges + through the smoothed charge density :math:`\\tilde\\rho`. With :math:`P` + being the cloud-in-cell (CIC) window function, the charge density and + filtered charge densities are computed as + + .. math:: + + \\rho(\\mathbf{r}) = \\sum_i q_i P(\\mathbf{r}-\\mathbf{r}_i), + + and + + .. math:: + + \\tilde\\rho(\\mathbf{r}) = \\int\\mathrm{x}\\mathbf{r}\\, + \\rho(\\mathbf{x})H(\\mathbf{r}-\\mathbf{x}), + + where :math:`H` is the grid-independent filtering function. The + electrostatic potential for a variable dielectric does not have an + analytical expression, and is computed in reciprocal through an iterative + method. + + The GPE states that + + .. math:: + + \\nabla \\cdot \\left(\\epsilon(\\mathbf{r}) + \\nabla{\\mathbf{\\psi(r)}}\\right) = -\\rho({\\mathbf{r}}). + + where :math:`\\epsilon(\\mathbf{r})` is the relative dielectric function. + + Parameters + ---------- + conv_fun : Convergence function. + Returns a scalar. Depends on MPI allreduce for similar convergence + across MPI ranks. + phi : list[pmesh.pm.RealField] + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + types : (N,) numpy.ndarray + Array of type indices for each of :code:`N` particles. Local for each + MPI rank. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. Local for each + MPI rank. + phi_q : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + charge density density values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_q_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed charge density values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + relative dielectric values on the computational grid. Pre-allocated, + but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented by + the collective fields of all MPI ranks. + phi_eps_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing calculated discretized + Fourier transformed relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_eta : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + gradients of the relative dielectric values on the computational grid. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank--the + full computational grid is represented by the collective fields of all MPI ranks. + phi_eta_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated discretized + Fourier transformed gradient relative dielectric values in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol_prev : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charge values on the computational grid. Parameter in + the iterative method.Pre-allocated,but empty. Changedin-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + phi_pol : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + polarization charges on the computational grid. Parameter in the iterative + method, updating the next quess in solving for the electrostatic potential. + Pre-allocated,but empty. Changed in-place.Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + elec_field : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing calculated discretized + electric field values on the computational grid. Pre-allocated, + but empty. Changed in-place. Local for each MPI rank--the full + computational grid is represented by the collective fields of all + MPI ranks. + elec_forces : (N,D) numpy.ndarray + Array of electrostatic forces on :code:`N` particles in :code:`D` + dimensions. + elec_field_contrib : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing + :math:`|\\mathbf{E(r)}|^2/\\phi_{0}` on the computational grid. + Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + psi : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic potential + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + Vbar_elec : mesh.pm.RealField + Pmesh :code:`RealField` object for storing functional derivatives of + :math:`\\|w(\\{ \\phi \\})_{elec}`on the computational grid. + Pre-allocated, but empty. Changed in-place. Local for each MPI rank-- + the full computational grid is represented by the collective fields of + all MPI ranks. + Vbar_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated functional + derivatives of :math:`\\|w(\\{ \\phi \\})_{elec}` in reciprocal space on the + computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank--the full computational grid is represented + by the collective fields of all MPI ranks. + force_mesh_elec : pmesh.pm.RealField + Pmesh :code:`RealField` object for storing electrostatic force values + on the computational grid. Pre-allocated, but empty. Changed in-place. + Local for each MPI rank-- the full computational grid is represented by + the collective fields of all MPI ranks. + force_mesh_elec_fourier : pmesh.pm.ComplexField + Pmesh :code:`ComplexField` object for storing the calculated electrostatic + force values in reciprocal space on the computational grid. Local for + each MPI rank--the full computational grid is represented by the collective + fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + layout_q : pmesh.domain.Layout + Pmesh communication layout object for domain decomposition of the full + system. Used as blueprint by :code:`pmesh.pm.paint` and + :code:`pmesh.pm.readout` for exchange of particle information across + MPI ranks as necessary. + layouts: list[pmesh.domain.Layout] + Pmesh communication layout objects for domain decompositions of each + particle type. Used as blueprint by :code:`pmesh.pm.readout` for + exchange of particle information across MPI ranks as necessary. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + config : hymd.input_parser.Config + Configuration object. + comm: mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + compute_field_energy_q_GPE: + Compute the electrostatic energy after electrosatic force is + calculated for a variable (anisotropic) dielectric general Poisson equation. + """ + + ## basic setup + V = np.prod(config.box_size) + n_mesh_cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh_cells + ## old protocol in gen_qe_hpf_use_self + pm.paint(positions, layout=layout_q, mass=charges, out=phi_q) ## + ## scale and fft + ## old protocol in gen_qe_hpf_use_self + phi_q /= volume_per_cell + phi_q.r2c(out=phi_q_fourier) + + phi_q_fourier.apply(hamiltonian.H, out=phi_q_fourier) + ## ^------ use the same gaussian as the \kai interaciton + phi_q_fourier.c2r(out=phi_q) ## this phi_q is after applying the smearing function + + denom_phi_tot = pm.create("real", value=0.0) + num_types = pm.create("real", value=0.0) + ### ^ ----- Calculate the relative dielectric (permittivity) to field + ### ------- from a mean contribution of particle number densities + + for t_ in range(config.n_types): + num_types = num_types + (config.dielectric_type[t_]) * phi[t_] + denom_phi_tot = denom_phi_tot + phi[t_] + + np.divide(num_types, denom_phi_tot, where=np.abs(denom_phi_tot > 1e-6), out=phi_eps) + + phi_eps.r2c(out=phi_eps_fourier) # FFT dielectric + + # phi_q_eps = (phi_q/phi_eps) + np.divide(phi_q, phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_q) + + _SPACE_DIM = 3 + ##^--------- constants needed throughout the calculations + + ### method for finding the gradient (fourier space), using the spatial dimension of k + for _d in np.arange(_SPACE_DIM): + + def gradient_transfer_function(k, x, d=_d): + return 1j * k[d] * x + + phi_eps_fourier.apply(gradient_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=phi_eta[_d]) + np.divide(phi_eta[_d], phi_eps, where=np.abs(phi_eps > 1e-6), out=phi_eta[_d]) + + ### iterative GPE solver ### + ### ---------------------------------------------- + max_iter = 100 + i = 0 + delta = 1.0 + # phi_pol_prev = pm.create("real", value = 0.0) + ### ^------ set to zero before each iterative procedure or soft start + conv_criteria = config.conv_crit # conv. criteria (default 1e-6) + w = config.pol_mixing # polarization mixing param (default 0.6) + while i < max_iter and delta > conv_criteria: + (phi_q + phi_pol_prev).r2c(out=phi_q_fourier) + for _d in np.arange(_SPACE_DIM): + + def iterate_apply_k_vec(k, additive_terms, d=_d): + return additive_terms * (-1j * k[d]) / k.normp(p=2, zeromode=1) + + phi_q_fourier.apply(iterate_apply_k_vec, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + + phi_pol = -( + phi_eta[0] * elec_field[0] + + phi_eta[1] * elec_field[1] + + phi_eta[2] * elec_field[2] + ) + ### ^-- Following a negative sign convention (-ik) of the FT, a neg sign is + ### --- mathematically correct by the definition of the GPE (double - -> +) + phi_pol = w * phi_pol + (1.0 - w) * phi_pol_prev + diff = np.abs(phi_pol - phi_pol_prev) + delta = conv_fun(comm, diff) # decided from toml input + phi_pol_prev = phi_pol.copy() + i = i + 1 + # print("Stopping after iteration {:d} with stop crit {:.2e}, delta {:.2e}".format(i,conv_criteria,delta)) + + # compute_potential = True + def k_norm_divide(k, potential): + return potential / k.normp(p=2, zeromode=1) + + ## > Electrostatic potential + eps0_inv = config.coulomb_constant * 4 * np.pi + ## ^ the 1/(4pi eps0)*4*pi = 1/eps0 + ((eps0_inv) * (phi_q + phi_pol)).r2c(out=phi_q_fourier) + phi_q_fourier.apply(k_norm_divide, out=phi_q_fourier) + phi_q_fourier.c2r(out=psi) + ### ^ electrostatic potential for the GPE + + for _d in np.arange(_SPACE_DIM): + + def field_transfer_function(k, x, d=_d): + return ( + -1j * k[d] * x + ) ## negative sign relation, due to E = - nabla psi relation + + phi_q_fourier.apply(field_transfer_function, out=phi_eta_fourier[_d]) + phi_eta_fourier[_d].c2r(out=elec_field[_d]) + ## ^-------- Method: Obtaining the electric field from electrostatic potential + ## Assuming the electric field is conserved. + ## Assumption holds if no magnetic flux (magnetic induced fields) + + ############## Obtain forces ############## + elec_dot = ( + elec_field[0] * elec_field[0] + + elec_field[1] * elec_field[1] + + elec_field[2] * elec_field[2] + ) + # needed for energy calculations + + np.divide( + elec_dot, + denom_phi_tot, + where=np.abs(denom_phi_tot > 1e-6), + out=elec_field_contrib, + ) + + eps0_inv = config.coulomb_constant * 4 * np.pi + + for t_ in range(config.n_types): + Vbar_elec[t_] = ( + config.type_charges[t_] * psi + - (0.5 / eps0_inv) + * (config.dielectric_type[t_] - phi_eps) + * elec_field_contrib + ) + + # Obtain Vext,k + for t_ in range(config.n_types): + Vbar_elec[t_].r2c(out=Vbar_elec_fourier[t_]) + Vbar_elec_fourier[t_].apply(hamiltonian.H, out=Vbar_elec_fourier[t_]) + + # force terms + # F = - grad Vext + for t_ in range(config.n_types): + for _d in np.arange(_SPACE_DIM): + + def force_transfer_function(k, x, d=_d): + return -1j * k[_d] * x ## negative gradient + + Vbar_elec_fourier[t_].apply( + force_transfer_function, out=force_mesh_elec_fourier[t_][_d] + ) + force_mesh_elec_fourier[t_][_d].c2r(out=force_mesh_elec[t_][_d]) + elec_forces[types == t_, _d] = force_mesh_elec[t_][_d].readout( + positions[types == t_], layout=layouts[t_] + ) + + return Vbar_elec, phi_eps, elec_dot
+ + +
[docs]def domain_decomposition( + positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=MPI.COMM_WORLD +): + """Performs domain decomposition + + Rearranges the MPI rank memory layout into one that better mimics the PFFT + pencil grid 2D decomposition. As molecules are always required to be fully + contained on a single MPI rank, a perfect decomposition is not always + possible. The best decomposition which leaves the center of mass of all + molecules in their respective correct domains is used, with possible + overlap into neighbouring domains if the spatial extent of any molecule + crosses domain boundaries. + + Parameters + ---------- + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + pm : pmesh.pm.ParticleMesh + Pmesh :code:`ParticleMesh` object interfacing to the CIC window + function and the PFFT discrete Fourier transform library. + *args + Variable length argument list containing arrays to include in the + domain decomposition. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + bonds : (N,M) numpy.ndarray, optional + Array of :code:`M` bonds originating from each of :code:`N` particles. + verbose : int, optional + Specify the logging event verbosity of this function. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + Domain decomposed :code:`positions` and any array specified in + :code:`*args`, in addition to :code:`bonds` and :code:`molecules` if these + arrays were provided as input. + """ + if molecules is not None: + if not topol: + assert bonds is not None, "bonds must be provided with molecules" + unique_molecules = np.sort(np.unique(molecules)) + molecules_com = np.empty_like(positions) + for m in unique_molecules: + ind = molecules == m + r = positions[ind, :][0, :] + molecules_com[ind, :] = r + layout = pm.decompose(molecules_com, smoothing=0) + if not topol: + args = (*args, bonds, molecules) + else: + args = (*args, molecules) + else: + layout = pm.decompose(positions, smoothing=0) + if verbose > 1: + Logger.rank0.log( + logging.INFO, + "DOMAIN_DECOMP: Total number of particles to be exchanged = %d", + np.sum(layout.get_exchange_cost()), + ) + return layout.exchange(positions, *args)
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/_modules/hymd/file_io.html b/v2.2.0/_modules/hymd/file_io.html new file mode 100644 index 00000000..6d25f0cb --- /dev/null +++ b/v2.2.0/_modules/hymd/file_io.html @@ -0,0 +1,1169 @@ + + + + + + hymd.file_io — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.file_io

+"""Handle file input/output in parllel HDF5 fashion
+"""
+import numpy as np
+import h5py
+import os
+import logging
+import getpass
+from mpi4py import MPI
+from .logger import Logger, get_version
+
+
+
[docs]class OutDataset: + """HDF5 dataset handler for file output""" + + def __init__( + self, + dest_directory, + config, + double_out=False, + disable_mpio=False, + comm=MPI.COMM_WORLD, + ): + """Constructor + + Parameters + ---------- + dest_directory : str + Ouput directory for saving data. + config : Config + Configuration object. + double_out : bool, optional + If :code:`True`, the output HDF5 objects are written in eight byte + floating point representation. Otherwise, four byte single + precision is used. + disable_mpio : bool, optional + If :code:`True`, disables parallel MPI-enabled HDF5 file output. + This is a compatibility option used if HDF5 is not compiled with + MPI support. This makes everything much harder by splitting all + output in one file per MPI rank, and having an MPI-enabled HDF5 + library is **highly recommended**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + """ + self.disable_mpio = disable_mpio + self.config = config + if double_out: + self.float_dtype = "float64" + else: + self.float_dtype = "float32" + + if disable_mpio: + self.file = h5py.File( + os.path.join( + dest_directory, f"sim.hdf5-{comm.rank:6d}-of-{comm.size:6d}" + ), + "w", + ) + else: + self.file = h5py.File( + os.path.join(dest_directory, "sim.H5"), "w", driver="mpio", comm=comm + ) + +
[docs] def is_open(self, comm=MPI.COMM_WORLD): + """Check if HDF5 output file is open + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + return self.file.__bool__()
+ +
[docs] def close_file(self, comm=MPI.COMM_WORLD): + """Closes the HDF5 output file + + Parameters + ---------- + comm : mpi4py.Comm + MPI communicator to use for rank communication. + """ + comm.Barrier() + self.file.close()
+ +
[docs] def flush(self): + """Flushes output buffers, forcing file writes""" + self.file.flush()
+ + +
[docs]def setup_time_dependent_element( + name, parent_group, n_frames, shape, dtype, units=None +): + """Helper function for setting up time-dependent HDF5 group datasets + + All output groups must adhere to the H5MD standard, meaning a structure of + + + | ┗━ **group** particle group (e.g. :code:`all`) or :code:`observables` group + | ┗━ **group** time-dependent data + | ┣━ **dataset** :code:`step` :code:`shape=(n_frames,)` + | ┣━ **dataset** :code:`time` :code:`shape=(n_frames,)` + | ┗━ **dataset** :code:`value` :code:`shape=(n_frames, *)` + + is necessary. + + References + ---------- + H5MD specification : + https://www.nongnu.org/h5md/h5md.html + """ # noqa: E501 + group = parent_group.create_group(name) + step = group.create_dataset("step", (n_frames,), "int32") + time = group.create_dataset("time", (n_frames,), "float32") + value = group.create_dataset("value", (n_frames, *shape), dtype) + + if units is not None: + value.attrs["unit"] = units + time.attrs["unit"] = "ps" + return group, step, time, value
+ + +
[docs]def store_static( + h5md, + rank_range, + names, + types, + indices, + config, + bonds_2_atom1, + bonds_2_atom2, + molecules=None, + velocity_out=False, + force_out=False, + charges=False, + dielectrics=False, + plumed_out=False, + comm=MPI.COMM_WORLD, +): + """Outputs all static time-independent quantities to the HDF5 output file + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + rank_range : list[int] + Start and end indices for global arrays for each MPI rank. + names : (N,) numpy.ndarray + Array of names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of type indices for :code:`N` particles. + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + config : Config + Configuration object. + bonds_2_atom1 : (B,) numpy.ndarray + Array of indices of the first particle for :code:`B` total + two-particle bonds. + bonds_2_atom2 : (B,) numpy.ndarray + Array of indices of the second particle for :code:`B` total + two-particle bonds. + molecules : (N,) numpy.ndarray, optional + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charges : (N,) numpy.ndarray + Array of particle charge values for :code:`N` particles. + dielectrics : (N,) numpy.ndarray + Array of particle relative dielectric values for :code:`N` particles. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to output HDF5 file. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + prepare_bonds : + Constructs two-, three-, and four-particle bonds from toplogy input + file and bond configuration information. + distribute_input : + Distributes input arrays onto MPI ranks, attempting load balancing. + """ + dtype = h5md.float_dtype + + h5md_group = h5md.file.create_group("/h5md") + h5md.h5md_group = h5md_group + h5md.observables = h5md.file.create_group("/observables") + h5md.connectivity = h5md.file.create_group("/connectivity") + h5md.parameters = h5md.file.create_group("/parameters") + + h5md_group.attrs["version"] = np.array([1, 1], dtype=int) + author_group = h5md_group.create_group("author") + author_group.attrs["name"] = np.string_(getpass.getuser()) + creator_group = h5md_group.create_group("creator") + creator_group.attrs["name"] = np.string_("Hylleraas MD") + + # Get HyMD version + creator_group.attrs["version"] = np.string_(get_version()) + + h5md.particles_group = h5md.file.create_group("/particles") + h5md.all_particles = h5md.particles_group.create_group("all") + mass = h5md.all_particles.create_dataset("mass", (config.n_particles,), dtype) + mass[...] = config.mass + + if charges is not False: + charge = h5md.all_particles.create_dataset( + "charge", (config.n_particles,), dtype="float32" + ) + charge[indices] = charges + if dielectrics is not False: + dielectric = h5md.all_particles.create_dataset( + "dielectric", (config.n_particles,), dtype="float32" + ) + dielectric[indices] = dielectrics + + box = h5md.all_particles.create_group("box") + box.attrs["dimension"] = 3 + box.attrs["boundary"] = np.array( + [np.string_(s) for s in 3 * ["periodic"]], dtype="S8" + ) + + n_frames = config.n_steps // config.n_print + if np.mod(config.n_steps - 1, config.n_print) != 0: + n_frames += 1 + if np.mod(config.n_steps, config.n_print) == 1: + n_frames += 1 + if n_frames == config.n_steps: + n_frames += 1 + + species = h5md.all_particles.create_dataset( + "species", + (config.n_particles,), + dtype="i", + ) + + ( + _, + h5md.positions_step, + h5md.positions_time, + h5md.positions, + ) = setup_time_dependent_element( + "position", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm", + ) + if velocity_out: + ( + _, + h5md.velocities_step, + h5md.velocities_time, + h5md.velocities, + ) = setup_time_dependent_element( + "velocity", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="nm ps-1", + ) + if force_out: + ( + _, + h5md.forces_step, + h5md.forces_time, + h5md.forces, + ) = setup_time_dependent_element( + "force", + h5md.all_particles, + n_frames, + (config.n_particles, 3), + dtype, + units="kJ mol-1 nm-1", + ) + ( + _, + h5md.total_energy_step, + h5md.total_energy_time, + h5md.total_energy, + ) = setup_time_dependent_element( + "total_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.kinetc_energy_step, + h5md.kinetc_energy_time, + h5md.kinetc_energy, + ) = setup_time_dependent_element( + "kinetic_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.potential_energy_step, + h5md.potential_energy_time, + h5md.potential_energy, + ) = setup_time_dependent_element( + "potential_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.bond_energy_step, + h5md.bond_energy_time, + h5md.bond_energy, + ) = setup_time_dependent_element( + "bond_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.angle_energy_step, + h5md.angle_energy_time, + h5md.angle_energy, + ) = setup_time_dependent_element( + "angle_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.dihedral_energy_step, + h5md.dihedral_energy_time, + h5md.dihedral_energy, + ) = setup_time_dependent_element( + "dihedral_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.field_energy_step, + h5md.field_energy_time, + h5md.field_energy, + ) = setup_time_dependent_element( + "field_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) + if charges is not False: + ( + _, + h5md.field_q_energy_step, + h5md.field_q_energy_time, + h5md.field_q_energy, + ) = setup_time_dependent_element( + "field_q_energy", + h5md.observables, + n_frames, + (1,), + dtype, + units="kJ mol-1", # noqa: E501 + ) # <-------- xinmeng + if plumed_out is not False: + ( + _, + h5md.plumed_bias_step, + h5md.plumed_bias_time, + h5md.plumed_bias, + ) = setup_time_dependent_element( + "plumed_bias", h5md.observables, n_frames, (1,), dtype, units="kJ mol-1" # noqa: E501 + ) + ( + _, + h5md.total_momentum_step, + h5md.total_momentum_time, + h5md.total_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "total_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm g ps-1 mol-1", + ) + ( + _, + h5md.angular_momentum_step, + h5md.angular_momentum_time, + h5md.angular_momentum, + ) = setup_time_dependent_element( # noqa: E501 + "angular_momentum", + h5md.observables, + n_frames, + (3,), + dtype, + units="nm+2 g ps-1 mol-1", + ) + ( + _, + h5md.torque_step, + h5md.torque_time, + h5md.torque, + ) = setup_time_dependent_element( # noqa: E501 + "torque", + h5md.observables, + n_frames, + (3,), + dtype, + units="kJ nm+2 mol-1", + ) + ( + _, + h5md.temperature_step, + h5md.temperature_time, + h5md.temperature, + ) = setup_time_dependent_element( + "temperature", h5md.observables, n_frames, (3,), dtype, units="K" + ) + ( + _, + h5md.thermostat_work_step, + h5md.thermostat_work_time, + h5md.thermostat_work, + ) = setup_time_dependent_element( + "thermostat_work", + h5md.observables, + n_frames, + (1,), + "float32", + units="kJ mol-1", # noqa: E501 + ) + ( + _, + h5md.pressure_step, + h5md.pressure_time, + h5md.pressure, + ) = setup_time_dependent_element( + "pressure", h5md.observables, n_frames, (18,), "float32", units="Bar" + ) + (_, h5md.box_step, h5md.box_time, h5md.box_value,) = setup_time_dependent_element( + "edges", box, n_frames, (3, 3), "float32", units="nm" + ) + + ind_sort = np.argsort(indices) + for i in ind_sort: + species[indices[i]] = config.name_to_type_map[names[i].decode("utf-8")] + + h5md.parameters.attrs["config.toml"] = np.string_(str(config)) + vmd_group = h5md.parameters.create_group("vmd_structure") + index_of_species = vmd_group.create_dataset( + "indexOfSpecies", (config.n_types,), "i" + ) + index_of_species[:] = np.array(list(range(config.n_types))) + + # VMD-h5mdplugin maximum name/type name length is 16 characters (for + # whatever reason [VMD internals?]). + name_dataset = vmd_group.create_dataset("name", (config.n_types,), "S16") + type_dataset = vmd_group.create_dataset("type", (config.n_types,), "S16") + if molecules is not None: + resid_dataset = vmd_group.create_dataset( + "resid", + (config.n_particles,), + "i", + ) + + # Change this + for i, n in config.type_to_name_map.items(): + name_dataset[i] = np.string_(n[:16]) + if n == "W": + type_dataset[i] = np.string_("solvent") + else: + type_dataset[i] = np.string_("membrane") + + total_bonds = comm.allreduce(len(bonds_2_atom1), MPI.SUM) + n_bonds_local = len(bonds_2_atom1) + + receive_buffer = comm.gather(n_bonds_local, root=0) + n_bonds_global = None + if comm.Get_rank() == 0: + n_bonds_global = receive_buffer + n_bonds_global = np.array(comm.bcast(n_bonds_global, root=0)) + rank_bond_start = np.sum(n_bonds_global[: comm.Get_rank()]) + + bonds_from = vmd_group.create_dataset("bond_from", (total_bonds,), "i") + bonds_to = vmd_group.create_dataset("bond_to", (total_bonds,), "i") + for i in range(n_bonds_local): + a = bonds_2_atom1[i] + b = bonds_2_atom2[i] + bonds_from[rank_bond_start + i] = indices[a] + 1 + bonds_to[rank_bond_start + i] = indices[b] + 1 + + if molecules is not None: + resid_dataset[indices[ind_sort]] = molecules
+ + +# store data old vs +""" +h5md, step, frame, indices, positions, velocities, forces, box_size, +temperature, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, +field_energy, field_q_energy, time_step, config, velocity_out=False, +force_out=False, charge_out=False, dump_per_particle=False, +""" + + +
[docs]def store_data( + h5md, + step, + frame, + indices, + positions, + velocities, + forces, + box_size, + temperature, + pressure, + kinetic_energy, + bond2_energy, + bond3_energy, + bond4_energy, + field_energy, + field_q_energy, + plumed_bias, + time_step, + config, + velocity_out=False, + force_out=False, + charge_out=False, + plumed_out=False, + dump_per_particle=False, + comm=MPI.COMM_WORLD, +): + """Writes time-step data to HDF5 output file + + Handles all quantities which change during simulation, as opposed to + static quanitities (see :code:`store_static`). + + Parameters + ---------- + h5md : OutDataset + HDF5 dataset handler. + step : int + Step number. + frame : int + Output frame number (:code:`step // n_print`). + indices : (N,) numpy.ndarray + Array of indices for :code:`N` particles. + positions : (N,) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + velocities : (N,) numpy.ndarray + Array of velocities for :code:`N` particles in :code:`D` dimensions. + forces : (N,) numpy.ndarray + Array of forces for :code:`N` particles in :code:`D` dimensions. + box_size : (D,) numpy.ndarray + Array containing the simulation box size. + temperature : float + Calculated instantaneous temperature. + kinetic_energy : float + Calculated instantaneous kinetic energy. + bond2_energy : float + Calculated instantaneous harmonic two-particle bond energy. + bond3_energy : float + Calculated instantaneous harmonic angular three-particle bond energy. + bond4_energy : float + Calculated instantaneous dihedral four-particle torsion energy. + field_energy : float + Calculated instantaneous particle-field energy. + field_q_energy : float + Calculated instantaneous electrostatic energy. + plumed_bias : float + PLUMED instantaneous bias energy. + time_step : float + Value of the time step. + config : Config + Configuration object. + velocity_out : bool, optional + If :code:`True`, velocities are written to output HDF5 file. + force_out : bool, optional + If :code:`True`, forces are written to output HDF5 file. + charge_out : bool, optional + If :code:`True`, electrostatic energies are written to the output + HDF5 file. + plumed_out : bool, optional + If :code:`True`, PLUMED bias is written to the output HDF5 file. + dump_per_particle : bool, optional + If :code:`True`, all quantities are written **per particle**. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + See also + -------- + store_static : + Outputs all static time-independent quantities to the HDF5 output file + """ + for dset in ( + h5md.positions_step, + h5md.total_energy_step, + h5md.potential_energy_step, + h5md.kinetc_energy_step, + h5md.bond_energy_step, + h5md.angle_energy_step, + h5md.dihedral_energy_step, + h5md.field_energy_step, + h5md.total_momentum_step, + h5md.angular_momentum_step, + h5md.torque_step, + h5md.temperature_step, + h5md.pressure_step, + h5md.box_step, + h5md.thermostat_work_step, + ): + dset[frame] = step + + for dset in ( + h5md.positions_time, + h5md.total_energy_time, + h5md.potential_energy_time, + h5md.kinetc_energy_time, + h5md.bond_energy_time, + h5md.angle_energy_time, + h5md.dihedral_energy_time, + h5md.field_energy_time, + h5md.total_momentum_time, + h5md.angular_momentum_time, + h5md.torque_time, + h5md.temperature_time, + h5md.pressure_time, + h5md.box_time, + h5md.thermostat_work_time, + ): + dset[frame] = step * time_step + + if velocity_out: + h5md.velocities_step[frame] = step + h5md.velocities_time[frame] = step * time_step + if force_out: + h5md.forces_step[frame] = step + h5md.forces_time[frame] = step * time_step + if charge_out: + h5md.field_q_energy_step[frame] = step + h5md.field_q_energy_time[frame] = step * time_step + if plumed_out: + h5md.plumed_bias_step[frame] = step + h5md.plumed_bias_time[frame] = step * time_step + + ind_sort = np.argsort(indices) + h5md.positions[frame, indices[ind_sort]] = positions[ind_sort] + + if velocity_out: + h5md.velocities[frame, indices[ind_sort]] = velocities[ind_sort] + if force_out: + h5md.forces[frame, indices[ind_sort]] = forces[ind_sort] + if charge_out: + h5md.field_q_energy[frame] = field_q_energy + if plumed_out: + h5md.plumed_bias[frame] = plumed_bias + + potential_energy = ( + bond2_energy + bond3_energy + bond4_energy + field_energy + field_q_energy + ) + + total_momentum = config.mass * comm.allreduce(np.sum(velocities, axis=0), MPI.SUM) + angular_momentum = config.mass * comm.allreduce( + np.sum(np.cross(positions, velocities), axis=0), MPI.SUM + ) + torque = config.mass * comm.allreduce( + np.sum(np.cross(positions, forces), axis=0), MPI.SUM + ) + h5md.total_energy[frame] = kinetic_energy + potential_energy + h5md.potential_energy[frame] = potential_energy + h5md.kinetc_energy[frame] = kinetic_energy + h5md.bond_energy[frame] = bond2_energy + h5md.angle_energy[frame] = bond3_energy + h5md.dihedral_energy[frame] = bond4_energy + h5md.field_energy[frame] = field_energy + h5md.total_momentum[frame, :] = total_momentum + h5md.angular_momentum[frame, :] = angular_momentum + h5md.torque[frame, :] = torque + h5md.temperature[frame] = temperature + h5md.pressure[frame] = pressure + for d in range(3): + h5md.box_value[frame, d, d] = box_size[d] + h5md.thermostat_work[frame] = config.thermostat_work + + fmt_ = [ + "step", + "time", + "temp", + "tot E", + "kin E", + "pot E", + "field E", + "elec E", + "bond E", + "ang E", + "dih E", + "bias E", + "Px", + "Py", + "Pz", + "ΔH" if config.target_temperature else "ΔE", + ] + fmt_ = np.array(fmt_) + + # create mask to show only energies != 0 + en_array = np.array([ + field_energy, + field_q_energy, + bond2_energy, + bond3_energy, + bond4_energy, + plumed_bias, + ]) + mask = np.full_like(fmt_, True, dtype=bool) + mask[range(6,12)] = en_array != 0. + + header_ = fmt_[mask].shape[0] * "{:>13}" + if config.initial_energy is None: + fmt_[-1] = "" + + divide_by = 1.0 + if dump_per_particle: + for i in range(3, 9): + fmt_[i] = fmt_[i][:-2] + "E/N" + fmt_[-1] += "/N" + divide_by = config.n_particles + total_energy = kinetic_energy + potential_energy + if config.initial_energy is not None: + if config.target_temperature: + H_tilde = total_energy - config.initial_energy - config.thermostat_work + else: + H_tilde = total_energy - config.initial_energy + else: + H_tilde = 0.0 + + header = header_.format(*fmt_[mask]) + data_fmt = f'{"{:13}"}{(fmt_[mask].shape[0]-1) * "{:13.5g}" }' + all_data = [ + step, + time_step * step, + temperature, + total_energy / divide_by, + kinetic_energy / divide_by, + potential_energy / divide_by, + field_energy / divide_by, + field_q_energy / divide_by, + bond2_energy / divide_by, + bond3_energy / divide_by, + bond4_energy / divide_by, + plumed_bias / divide_by, + total_momentum[0] / divide_by, + total_momentum[1] / divide_by, + total_momentum[2] / divide_by, + H_tilde / divide_by, + ] + data = data_fmt.format(*[val for i, val in enumerate(all_data) if mask[i]]) + Logger.rank0.log(logging.INFO, ("\n" + header + "\n" + data))
+ + +
[docs]def distribute_input( + in_file, rank, size, n_particles, max_molecule_size=201, comm=MPI.COMM_WORLD +): + """Assign global arrays onto MPI ranks, attempting load balancing + + Distributes approximately equal numbers of particles (workload) onto each + independent MPI rank, while respecting the requirement that any molecule + must be fully contained on a single MPI rank only (no splitting molecules + across multiple CPUs). + + Parameters + ---------- + in_file : h5py.File + HDF5 input file object. + rank : int + Local rank number for this MPI rank. + size : int + Global size of the MPI communicator (number of total CPUs). + n_particles : int + Total number of particles. + max_molecule_size : int, optional + Maximum size of any molecule present in the system. Used to initially + guess where the MPI rank boundaries (start/end indices) in the global + arrays should be placed. If molecules of size + :code:`>max_molecule_size` exist in the simulation system, HyMD + **might** work as expected. Or it might fail spectacularly. + comm : mpi4py.Comm + MPI communicator to use for rank commuication. + + Returns + ------- + rank_range : + Starting and ending indices in the global arrays for each MPI rank. + """ + if n_particles is None: + n_particles = len(in_file["indices"]) + np_per_MPI = n_particles // size + + molecules_flag = False + if "molecules" in in_file: + molecules_flag = True + + if not molecules_flag: + if rank == size - 1: + np_cum_mpi = [rank * np_per_MPI, n_particles] + else: + np_cum_mpi = [rank * np_per_MPI, (rank + 1) * np_per_MPI] + p_mpi_range = list(range(np_cum_mpi[0], np_cum_mpi[1])) + return p_mpi_range, molecules_flag + + # To avoid splitting molecules across multiple different ranks, we need + # to read in some extra indices before/after the expected break points + # and iterate until we find a molecule break. + # + # Implicitly assuming no molecule is bigger than + # min(max_molecule_size, n_particles // n_MPI_ranks) atoms. + max_molecule_size += 2 + grab_extra = max_molecule_size if np_per_MPI > max_molecule_size else np_per_MPI + if rank == 0: + mpi_range_start = 0 + if size == 1: + mpi_range_end = n_particles + else: + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + elif rank == size - 1: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = n_particles + else: + mpi_range_start = rank * np_per_MPI - 1 + mpi_range_end = (rank + 1) * np_per_MPI + grab_extra + + molecules = in_file["molecules"][mpi_range_start:mpi_range_end] + indices = in_file["indices"][mpi_range_start:mpi_range_end] + molecule_end_indices = np.nonzero(np.diff(molecules))[0] + + p_mpi_range = [None, None] + if rank == 0: + p_mpi_range[0] = 0 + if size == 1: + p_mpi_range[1] = n_particles + else: + p_mpi_range[1] = indices[ + molecule_end_indices[molecule_end_indices >= np_per_MPI][0] + 1 + ] + elif rank == size - 1: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = n_particles + else: + p_mpi_range[0] = indices[molecule_end_indices[molecule_end_indices > 0][0]] + 1 + p_mpi_range[1] = ( + indices[molecule_end_indices[molecule_end_indices > np_per_MPI][0]] + + 1 # noqa: E501 + ) + return list(range(p_mpi_range[0], p_mpi_range[1])), molecules_flag
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/_modules/hymd/force.html b/v2.2.0/_modules/hymd/force.html new file mode 100644 index 00000000..b5cb947f --- /dev/null +++ b/v2.2.0/_modules/hymd/force.html @@ -0,0 +1,1172 @@ + + + + + + hymd.force — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.force

+"""Calculates intramolecular forces between bonded particles in molecules
+"""
+import numpy as np
+import networkx as nx
+from dataclasses import dataclass
+
+# Imported here so we can call from force import compute_bond_forces__fortran
+from force_kernels import cbf as compute_bond_forces__fortran  # noqa: F401
+from force_kernels import (  # noqa: F401
+    caf as compute_angle_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cdf as compute_dihedral_forces__fortran,
+)
+from force_kernels import (  # noqa: F401
+    cbf_d as compute_bond_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    caf_d as compute_angle_forces__fortran__double,
+)
+from force_kernels import (  # noqa: F401
+    cdf_d as compute_dihedral_forces__fortran__double,
+)
+
+
+
[docs]@dataclass # might not be needed +class Dielectric_type: + atom_1: str + dielectric_value: float
+ + +
[docs]@dataclass +class Bond: + """Dataclass representing a single two-particle bond type + + A `bond type` is a bond strength and equilibrium distance associated with + any bond between particles of specific types :code:`A` and :code:`B` + (where :code:`A` and :code:`B` may be the same or different). Harmonic + two-particle bonds in HyMD take the form + + .. math:: + + V_2(\\mathbf{r}_1, \\mathbf{r}_2) = + \\frac{1}{2}k + \\left( + \\vert \\mathbf{r}_1 - \\mathbf{r}_2 \\vert - r_0 + \\right)^2, + + where :math:`k` is the bond strength (spring constant) and :math:`r_0` is + the equilibrium bond length (at which the energy is zero). + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + equilibrium : float + Equilibrium distance at which the energy associated with the bond + vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient (spring constant). + """ + + atom_1: str + atom_2: str + equilibrium: float + strength: float
+ + +
[docs]@dataclass +class Angle(Bond): + """Dataclass representing a single three-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any three-particle bond between particles of specific types :code:`A`, + :code:`B`, and :code:`C` (where :code:`A`, :code:`B`, and :code:`C` may be + different or the same). Harmonic angular three-particle bonds in HyMD take + the form + + .. math:: + + V_3(\\mathbf{r}_1, \\mathbf{r}_2, \\mathbf{r}_3) = + \\frac{1}{2}k + \\left( + \\cos^{-1} + \\left[ + \\frac{ + (\\mathbf{r}_1-\\mathbf{r}_2) + \\cdot + (\\mathbf{r}_3-\\mathbf{r}_2) + } + { + \\vert\\mathbf{r}_1-\\mathbf{r}_2\\vert + \\vert\\mathbf{r}_3-\\mathbf{r}_2\\vert + } + \\right] - \\theta_0 + \\right)^2 + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + equilibrium : float + Equilibrium angle at which the energy associated with the + three-particle angular bond vanishes and the resulting force is zero. + strength : float + Harmonic bond strength coefficient. + + See also + -------- + Bond : + Two-particle bond type dataclass + """ + + atom_3: str
+ + +
[docs]@dataclass +class Dihedral: + """Dataclass representing a single four-particle bond type + + A `bond type` is a bond strength and equilibrium angle associated with + any four-particle torsional bond between particles of specific types + :code:`A`, :code:`B`, :code:`C`, and :code:`D` (where :code:`A`, :code:`B`, + :code:`C`, and :code:`D` may be different or the same). Dihedral + four-particle bonds in HyMD take different forms depending on the + :code:`dih_type` parameter. + + In the following, let :math:`\\phi` denote the angle between the planes + spanned by the relative positions of atoms :code:`A`-:code:`B`-:code:`C` + and :code:`B`-:code:`C`-:code:`D`. If :code:`dih_type = 0`, then + + .. math:: + + V_4(\\phi) = \\sum_n c_n + \\left( + 1 + \\cos\\left[ + n\\phi - d_n + \\right] + \\right), + + where :math:`c_n` are energy coefficients and :math:`d_n` are propensity + phases. By default, the cosine sum is truncated at five terms. If + :code:`coeffs` provides only a single float, this is used as the coiling + propensity parameter :math:`\\lambda`. In this case, :math:`c_n` and + :math:`d_n` are automatically set to values which promote alpha helical + (:math:`\\lambda=-1`), beta sheet (:math:`\\lambda=1`), or a mixed + (:math:`1>\\lambda>-1`) structure (using values provided by Bore et al. + (2018)). In this case, the full potential takes the form + + .. math:: + + V_4(\\phi;\\lambda) = + \\frac{1}{2}(1-\\lambda) V_{\\text{prop},\\alpha}(\\phi) + + + \\frac{1}{2}(1+\\lambda) V_{\\text{prop},\\beta}(\\phi) + + + (1-\\vert\\lambda\\vert) V_{\\text{prop}, \\text{coil}}(\\phi), + + with each of the :math:`V_{\\mathrm{prop}, X}` being fixed cosine series + potentials with pre-set :math:`c_n` -s and :math:`d_n` -s. + + If :code:`dih_type = 1`, then a combined bending torsional (CBT) potential + is employed, + + .. math:: + + V_4(\\phi,\\gamma;\\lambda) = + V_4(\\phi;\\lambda) + + + \\frac{1}{2}K(\\phi)(\\gamma - \\gamma_0)^2, + + where :math:`V_4(\\phi;\\lambda)` specifies the potential as given by the + coiling propensity parameter above, :math:`K(\\phi)` is a separate cosine + series potential acting as the angular three-particle bond strength, and + :math:`\\gamma_0` is the three-particle bond equilibrium angle. In this + case, the :code:`coeffs` parameter must specify *both* a :math:`\\lambda` + value, in additon to the energy and phases dictating the :math:`K(\\phi)` + potential. + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + atom_3 : str + Type name of particle 3. + atom_4 : str + Type name of particle 4. + coeffs : list[list[float]] or list[float] or numpy.ndarray + Dihedral coefficients defining the series expansion of the dihedral + energy. + dih_type : int + Specifies the type of dihedral used; If :code:`0`, then :code:`coeffs` + must contain **either** two lists of five energy coefficients + :math:`c_n` and five propensity phases :math:`d_n` **or** a single + floating point number defining the :math:`\\lambda` coiling propensity + parameter. If :code:`1`, the combined bending-torsional potential is + used, and :code:`coeffs` must specify :math:`\\lambda` *and* two lists + containing energy coefficients and propensity phases for the + :math:`V_\\text{prop}` propensity potential, defined in terms of cosine + series. + + References + ---------- + Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018. + """ + + atom_1: str + atom_2: str + atom_3: str + atom_4: str + coeffs: np.ndarray + dih_type: int
+ + +
[docs]@dataclass +class Chi: + """Dataclass representing a single :math:`\\chi` mixing interaction type + + An `interaction mixing energy type` is a mixing energy associated with + density overlap between species of types :code:`A` and :code:`B` + (specified as inputs :code:`atom_1` and :code:`atom_2`). A positive mixing + energy promotes phase separation, a negative mixing energy promotes mixing. + The interaction energy density (provided the :code:`DefaultWithChi` + Hamiltonian is used) takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} + \\sum_{k,l}\\chi_{k,l} \\tilde\\phi_k\\tilde\\phi_l, + + where :math:`\\chi_{k,l}` denotes the mixing energy between species + :math:`k` and :math:`l`, with :math:`\\kappa` being the incompressibility. + The value of the interaction mixing energy parameter may be extracted from + `Flory-Huggins theory`_. + + .. _`Flory-Huggins theory`: + https://en.wikipedia.org/wiki/Flory%E2%80%93Huggins_solution_theory + + Attributes + ---------- + atom_1 : str + Type name of particle 1. + atom_2 : str + Type name of particle 2. + interaction_energy : float + Interaction mixing energy. + + See also + -------- + hymd.hamiltonian.DefaultWithChi : + Interaction energy functional using :math:`\\chi`-interactions. + """ + + atom_1: str + atom_2: str + interaction_energy: float
+ + +
[docs]def find_all_paths(G, u, n): + """Helper function that recursively finds all paths of given lenght 'n + 1' inside a network 'G'. + Adapted from https://stackoverflow.com/a/28103735.""" + if n == 0: + return [[u]] + paths = [] + for neighbor in G.neighbors(u): + for path in find_all_paths(G, neighbor, n - 1): + if u not in path: + paths.append([u] + path) + return paths
+ + +
[docs]def propensity_potential_coeffs(x: float): + alpha_coeffs = np.array( + [ + [7.406, -5.298, -2.570, 1.336, 0.739], + [-0.28632126, 1.2099146, 1.18122138, 0.49075168, 0.98495911], + ] + ) + beta_coeffs = np.array( + [ + [3.770, 5.929, -4.151, -0.846, 0.190], + [-0.2300693, -0.0583289, 0.99342396, 1.03237971, 2.90160988], + ] + ) + coil_coeffs = np.array( + [ + [1.416, -0.739, 0.990, -0.397, 0.136], + [1.3495933, 0.45649087, 2.30441057, -0.12274901, -0.26179939], + ] + ) + + zero_add = np.zeros((2, 5)) + if np.isclose(x, -1): + return np.concatenate((alpha_coeffs, zero_add)) + elif np.isclose(x, 0): + return np.concatenate((coil_coeffs, zero_add)) + elif np.isclose(x, 1): + return np.concatenate((beta_coeffs, zero_add)) + + abs_x = np.abs(x) + if abs_x > 1: + err_str = ( + f"The provided value of lambda = {x} is out of lambda definition range, " + f"[-1.0, 1.0]." + ) + Logger.rank0.log(logging.ERROR, err_str) + else: + coil_coeffs[0] *= 1 - abs_x + if x < 0: + alpha_coeffs[0] *= 0.5 * (abs_x - x) + return np.concatenate((alpha_coeffs, coil_coeffs)) + else: + beta_coeffs[0] *= 0.5 * (abs_x + x) + return np.concatenate((beta_coeffs, coil_coeffs))
+ + +
[docs]def prepare_bonds_old(molecules, names, bonds, indices, config): + """Find bonded interactions from connectivity and bond types information + + .. deprecated:: 1.0.0 + :code:`prepare_bonds_old` was replaced by :code:`prepare_bonds` for + use with compiled Fortran kernels prior to 1.0.0 release. + + Prepares the necessary equilibrium and bond strength information needed by + the intramolecular interaction functions. This is performed locally on each + MPI rank, as the domain decomposition ensures that for all molecules *all* + consituent particles are always contained on *the same* MPI rankself. + + This function traverses the bond connectivity information provided in the + structure/topology input file and indentifies any two-, three-, or + four-particle potential bonds. For each connected chain of two, three, or + four particles, a matching to bond types is attempted. If the corresponding + names match, a bond object is initialized. + + In order to investigate the connectivity, a graph is created using + networkx functionality. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2 : list + List of lists containing *local* particle indices, equilibrium + distance, and bond strength coefficient for each reconstructed + two-particle bond. + bonds_3 : + List of lists containing *local* particle indices, equilibrium angle, + and bond strength coefficient for each reconstructed three-particle + bond. + bonds_4 : + List of lists containing *local* particle indices, dihedral type index, + and dihedral coefficients for each reconstructed four-particle + torsional bond. + bb_index : list + List indicating the dihedral type of each four-particle bond in + :code:`bonds_4`. + + See also + -------- + Bond : + Two-particle bond type dataclass. + Angle : + Three-particle angular bond type dataclass. + Dihedral : + Four-particle torsional bond type dataclass. + hymd.input_parser.Config + Configuration dataclass handler. + """ + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + bb_index = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + bb_dihedral = 0 + bond_graph = nx.Graph() + + for local_index, global_index in enumerate(indices): + if molecules[local_index] != mol: + continue + + bond_graph.add_node( + global_index, + name=names[local_index].decode("UTF-8"), + local_index=local_index, + ) + for bond in [b for b in bonds[local_index] if b != -1]: + bond_graph.add_edge(global_index, bond) + + connectivity = nx.all_pairs_shortest_path(bond_graph) + for c in connectivity: + i = c[0] + connected = c[1] + for j, path in connected.items(): + if len(path) == 2 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for b in config.bonds: + match_forward = name_i == b.atom_1 and name_j == b.atom_2 + match_backward = name_i == b.atom_2 and name_j == b.atom_1 + if match_forward or match_backward: + bonds_2.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[j]["local_index"], + b.equilibrium, + b.strength, + ] + ) + + if len(path) == 3 and path[-1] > path[0]: + name_i = bond_graph.nodes()[i]["name"] + name_mid = bond_graph.nodes()[path[1]]["name"] + name_j = bond_graph.nodes()[j]["name"] + + for a in config.angle_bonds: + match_forward = ( + name_i == a.atom_1 + and name_mid == a.atom_2 + and name_j == a.atom_3 + ) + match_backward = ( + name_i == a.atom_3 + and name_mid == a.atom_2 + and name_j == a.atom_1 + ) + if match_forward or match_backward: + bonds_3.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[path[1]]["local_index"], + bond_graph.nodes()[j]["local_index"], + np.radians(a.equilibrium), + a.strength, + ] + ) + + all_paths_len_four = find_all_paths(bond_graph, i, 3) + for p in all_paths_len_four: + name_i = bond_graph.nodes()[i]["name"] + name_mid_1 = bond_graph.nodes()[p[1]]["name"] + name_mid_2 = bond_graph.nodes()[p[2]]["name"] + name_j = bond_graph.nodes()[p[3]]["name"] + + for a in config.dihedrals: + match_forward = ( + name_i == a.atom_1 + and name_mid_1 == a.atom_2 + and name_mid_2 == a.atom_3 + and name_j == a.atom_4 + ) + if ( + match_forward + and [ + bond_graph.nodes()[p[3]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[i]["local_index"], + a.coeffs, + a.dih_type, + ] + not in bonds_4 + ): + bonds_4.append( + [ + bond_graph.nodes()[i]["local_index"], + bond_graph.nodes()[p[1]]["local_index"], + bond_graph.nodes()[p[2]]["local_index"], + bond_graph.nodes()[p[3]]["local_index"], + a.coeffs, + a.dih_type, + ] + ) + if a.dih_type == 1: + bb_dihedral = len(bonds_4) + + if bb_dihedral: + bb_index.append(bb_dihedral - 1) + + return bonds_2, bonds_3, bonds_4, bb_index
+ + +
[docs]def prepare_index_based_bonds(molecules, topol): + bonds_2 = [] + bonds_3 = [] + bonds_4 = [] + + different_molecules = np.unique(molecules) + for mol in different_molecules: + resid = mol + 1 + top_summary = topol["system"]["molecules"] + resname = None + test_mol_number = 0 + for molname in top_summary: + test_mol_number += molname[1] + if resid <= test_mol_number: + resname = molname[0] + break + + if resname is None: + break + + if "bonds" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for bond in topol[resname]["bonds"]: + index_i = bond[0] - 1 + first_id + index_j = bond[1] - 1 + first_id + # bond[2] is the bond type, inherited by the itp format. Not used + equilibrium = bond[3] + strength = bond[4] + bonds_2.append([index_i, index_j, equilibrium, strength]) + + if "angles" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["angles"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + # angle[3] is the angle type, inherited by the itp format. Not used + equilibrium = np.radians(angle[4]) + strength = angle[5] + bonds_3.append([index_i, index_j, index_k, equilibrium, strength]) + + if "dihedrals" in topol[resname]: + first_id = np.where(molecules == mol)[0][0] + for angle in topol[resname]["dihedrals"]: + index_i = angle[0] - 1 + first_id + index_j = angle[1] - 1 + first_id + index_k = angle[2] - 1 + first_id + index_l = angle[3] - 1 + first_id + dih_type = angle[4] + coeff = angle[5] + if dih_type == 0 and isinstance(coeff[0], (float, int)): + coeff = propensity_potential_coeffs(coeff[0]) + elif dih_type == 1 and len(coeff) == 3: + coeff = np.array( + propensity_potential_coeffs(coeff[0][0]).tolist() + + coeff[1:] + ) + elif dih_type == 2: + coeff = np.array(coeff) + else: + coeff = np.insert(np.array(coeff), 2, np.zeros((2, 5)), axis=0) + bonds_4.append([index_i, index_j, index_k, index_l, coeff, dih_type, 0]) + return bonds_2, bonds_3, bonds_4
+ + +
[docs]def prepare_bonds(molecules, names, bonds, indices, config, topol=None): + """Rearrange the bond information for usage in compiled Fortran kernels + + Restructures the lists resulting from the execution of + :code:`prepare_bonds_old` into numpy arrays suitable for calls to optimized + Fortran code calculating bonded forces and energiesself. + + Parameters + ---------- + molecules : (N,) numpy.ndarray + Array of integer molecule affiliation for each of :code:`N` particles. + Global (across all MPI ranks) or local (local indices on this MPI rank + only) may be used, both, without affecting the result. + names : (N,) numpy.ndarray + Array of type names for each of :code:`N` particles. + bonds : (N,M) numpy.ndarray + Array of :code:`M` bonds originating from each of :code:`N` particles. + indices : (N,) numpy.ndarray + Array of integer indices for each of :code:`N` particles. Global + (across all MPI ranks) or local (local indices on this MPI rank only) + may be used, both, without affecting the result. + config : Config + Configuration object. + + Returns + ------- + bonds_2_atom_1 : (B,) numpy.ndarray + Local index of particle 1 for each of :code:`B` constructed + two-particle bonds. + bonds_2_atom_2 : (B,) numpy.ndarray + Local index of particle 2 for each of :code:`B` constructed + two-particle bonds. + bonds_2_equilibrium : (B,) numpy.ndarray + Equilibrium distance for each of :code:`B` constructed two-particle + bonds. + bonds_2_strength : (B,) numpy.ndarray + Bond strength for each of :code:`B` constructed two-particle + bonds. + bonds_3_atom_1 : (A,) numpy.ndarray + Local index of particle 1 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_2 : (A,) numpy.ndarray + Local index of particle 2 for each of :code:`A` constructed + three-particle bonds. + bonds_3_atom_3 : (A,) numpy.ndarray + Local index of particle 3 for each of :code:`A` constructed + three-particle bonds. + bonds_3_equilibrium : (A,) numpy.ndarray + Equilibrium angle for each of :code:`A` constructed three-particle + bonds. + bonds_3_strength : (A,) numpy.ndarray + Bond strength for each of :code:`A` constructed three-particle + bonds. + bonds_4_atom_1 : (D,) numpy.ndarray + Local index of particle 1 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_2 : (D,) numpy.ndarray + Local index of particle 2 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_3 : (D,) numpy.ndarray + Local index of particle 3 for each of :code:`D` constructed + four-particle bonds. + bonds_4_atom_4 : (D,) numpy.ndarray + Local index of particle 4 for each of :code:`D` constructed + four-particle bonds. + bonds_4_coeff : (D,) numpy.ndarray + Cosine series coefficients for each of :code:`D` constructed + four-particle bonds. + bonds_4_type : (D,) numpy.ndarray + Dihedral type for each of :code:`D` constructed four-particle + bonds. + bonds_4_last : (D,) numpy.ndarray + Flags indicating if :code:`dih_type` is :code:`1` for each of :code:`D` + constructed four-particle bonds. + + See also + -------- + prepare_bonds_old : + Used internally to reconstruct the bonded interactions types from the + connectivity information in the structure/topology input file and the + bonded types specified in the configuration file. + """ + if topol is not None: + bonds_2, bonds_3, bonds_4 = prepare_index_based_bonds( + molecules, topol + ) + else: + bonds_2, bonds_3, bonds_4, bb_index = prepare_bonds_old( + molecules, names, bonds, indices, config + ) + + # Bonds + bonds_2_atom1 = np.empty(len(bonds_2), dtype=int) + bonds_2_atom2 = np.empty(len(bonds_2), dtype=int) + bonds_2_equilibrium = np.empty(len(bonds_2), dtype=np.float64) + bonds_2_strength = np.empty(len(bonds_2), dtype=np.float64) + for i, b in enumerate(bonds_2): + bonds_2_atom1[i] = b[0] + bonds_2_atom2[i] = b[1] + bonds_2_equilibrium[i] = b[2] + bonds_2_strength[i] = b[3] + + # Angles + bonds_3_atom1 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom2 = np.empty(len(bonds_3), dtype=int) + bonds_3_atom3 = np.empty(len(bonds_3), dtype=int) + bonds_3_equilibrium = np.empty(len(bonds_3), dtype=np.float64) + bonds_3_strength = np.empty(len(bonds_3), dtype=np.float64) + for i, b in enumerate(bonds_3): + bonds_3_atom1[i] = b[0] + bonds_3_atom2[i] = b[1] + bonds_3_atom3[i] = b[2] + bonds_3_equilibrium[i] = b[3] + bonds_3_strength[i] = b[4] + # Dihedrals + bonds_4_atom1 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom2 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom3 = np.empty(len(bonds_4), dtype=int) + bonds_4_atom4 = np.empty(len(bonds_4), dtype=int) + number_of_coeff = 6 + len_of_coeff = 5 + bonds_4_coeff = np.empty( + (len(bonds_4), number_of_coeff, len_of_coeff), dtype=np.float64 + ) + bonds_4_type = np.empty(len(bonds_4), dtype=int) + bonds_4_last = np.zeros(len(bonds_4), dtype=int) + for i, b in enumerate(bonds_4): + bonds_4_atom1[i] = b[0] + bonds_4_atom2[i] = b[1] + bonds_4_atom3[i] = b[2] + bonds_4_atom4[i] = b[3] + bonds_4_coeff[i] = np.resize(b[4], (number_of_coeff, len_of_coeff)) + bonds_4_type[i] = b[5] + if topol is not None: + bonds_4_last[i] = b[6] + if topol is None: + bonds_4_last[bb_index] = 1 + + return ( + bonds_2_atom1, + bonds_2_atom2, + bonds_2_equilibrium, + bonds_2_strength, + bonds_3_atom1, + bonds_3_atom2, + bonds_3_atom3, + bonds_3_equilibrium, + bonds_3_strength, # noqa: E501 + bonds_4_atom1, + bonds_4_atom2, + bonds_4_atom3, + bonds_4_atom4, + bonds_4_coeff, + bonds_4_type, + bonds_4_last, # noqa: E501 + )
+ + +
[docs]def compute_bond_forces__plain(f_bonds, r, bonds_2, box_size): + """Computes forces resulting from bonded interactions + + .. deprecated:: 1.0.0 + :code:`compute_bond_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_bonds.fill(0.0) + energy = 0.0 + + for i, j, r0, k in bonds_2: + ri = r[i, :] + rj = r[j, :] + rij = rj - ri + + # Apply periodic boundary conditions to the distance rij + for dim in range(len(rij)): + rij[dim] -= box_size[dim] * np.around(rij[dim] / box_size[dim]) + dr = np.linalg.norm(rij) + df = -k * (dr - r0) + f_bond_vector = df * rij / dr + f_bonds[i, :] -= f_bond_vector + f_bonds[j, :] += f_bond_vector + + energy += 0.5 * k * (dr - r0) ** 2 + return energy
+ + +
[docs]def compute_angle_forces__plain(f_angles, r, bonds_3, box_size): + """Computes forces resulting from angular interactions + + .. deprecated:: 1.0.0 + :code:`compute_angle_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_angles.fill(0.0) + energy = 0.0 + + for a, b, c, theta0, k in bonds_3: + ra = r[a, :] - r[b, :] + rc = r[c, :] - r[b, :] + + for dim in range(len(ra)): + ra[dim] -= box_size[dim] * np.around(ra[dim] / box_size[dim]) + rc[dim] -= box_size[dim] * np.around(rc[dim] / box_size[dim]) + + xra = 1.0 / np.sqrt(np.dot(ra, ra)) + xrc = 1.0 / np.sqrt(np.dot(rc, rc)) + ea = ra * xra + ec = rc * xrc + + cosphi = np.dot(ea, ec) + theta = np.arccos(cosphi) + xsinph = 1.0 / np.sqrt(1.0 - cosphi**2) + + d = theta - theta0 + f = -k * d + + xrasin = xra * xsinph * f + xrcsin = xrc * xsinph * f + + fa = (ea * cosphi - ec) * xrasin + fc = (ec * cosphi - ea) * xrcsin + + f_angles[a, :] += fa + f_angles[c, :] += fc + f_angles[b, :] -= fa + fc + # f_angles[b, :] += -(fa + fc) + + energy -= 0.5 * f * d + + return energy
+ + +
[docs]def compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size): + """Computes forces resulting from dihedral interactions + + .. deprecated:: 1.0.0 + :code:`compute_dihedral_forces__plain` was replaced by compiled Fortran + code prior to 1.0.0 release. + """ + f_dihedrals.fill(0.0) + energy = 0.0 + + for a, b, c, d, coeffs, phase in bonds_4: + f = r[a, :] - r[b, :] + g = r[b, :] - r[c, :] + h = r[d, :] - r[c, :] + + for dim in range(3): + f -= box_size[dim] * np.around(f[dim] / box_size[dim]) + g -= box_size[dim] * np.around(g[dim] / box_size[dim]) + h -= box_size[dim] * np.around(h[dim] / box_size[dim]) + + v = np.cross(f, g) + w = np.cross(h, g) + vv = np.dot(v, v) + ww = np.dot(w, w) + gn = np.linalg.norm(g) + + cosphi = np.dot(v, w) + sinphi = np.dot(np.cross(v, w), g) / gn + phi = np.arctan2(sinphi, cosphi) + + fg = np.dot(f, g) + hg = np.dot(h, g) + sc = v * fg / (vv * gn) - w * hg / (ww * gn) + + df = 0 + + for m in range(len(coeffs[0])): + energy += coeffs[0][m] * (1 + np.cos(m * phi - coeffs[1][m])) + df += m * coeffs[0][m] * np.sin(m * phi - coeffs[1][m]) + + force_on_a = df * gn * v / vv + force_on_d = df * gn * w / ww + + f_dihedrals[a, :] -= force_on_a + f_dihedrals[b, :] += df * sc + force_on_a + f_dihedrals[c, :] -= df * sc + force_on_d + f_dihedrals[d, :] += force_on_d + return energy
+ + +
[docs]def dipole_forces_redistribution( + f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb +): + """Redistribute electrostatic forces calculated from topologically + reconstructed ghost dipole point charges to the backcone atoms of the protein. + """ + f_on_bead.fill(0.0) + for i, j, k, l, fd, matrix, dih_type, is_last in zip( + a, b, c, d, f_dipoles, trans_matrices, type_array, last_bb + ): + if dih_type == 1: + sum_force = fd[0] + fd[1] + diff_force = fd[0] - fd[1] + f_on_bead[i] += matrix[0] @ diff_force # Atom A + f_on_bead[j] += matrix[1] @ diff_force + 0.5 * sum_force # Atom B + f_on_bead[k] += matrix[2] @ diff_force + 0.5 * sum_force # Atom C + + if is_last == 1: + sum_force = fd[2] + fd[3] + diff_force = fd[2] - fd[3] + f_on_bead[j] += matrix[3] @ diff_force + f_on_bead[k] += matrix[4] @ diff_force + 0.5 * sum_force + f_on_bead[l] += matrix[5] @ diff_force + 0.5 * sum_force
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/_modules/hymd/hamiltonian.html b/v2.2.0/_modules/hymd/hamiltonian.html new file mode 100644 index 00000000..706341d1 --- /dev/null +++ b/v2.2.0/_modules/hymd/hamiltonian.html @@ -0,0 +1,807 @@ + + + + + + hymd.hamiltonian — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.hamiltonian

+"""Interaction energy functionals.
+
+Implements field--particle interaction energy functionals depending on the
+field configuration. Extending HyMD with a new Hamiltonian is done by
+subclassing the :code:`Hamiltonian` superclass with logic intialized in the
+constructor.
+
+The grid-independent filtering function is defined in the :code:`Hamiltonian`
+superclass constructor. Hijack :code:`self.H` in a subclass to change the
+filter.
+"""
+import numpy as np
+import sympy
+
+
+
[docs]class Hamiltonian: + """Interaction energy functional superclass""" + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + self.config = config + self._setup()
+ +
[docs] def _setup(self): + """Superclass setup + + Sets up the grid-independent filtering function :code:`H`, and the + SymPy logic for symbolically differentiating interaction energy + functionals in Hamiltonian subclasses. + """ + if not hasattr(self.config, "simulation_volume"): + self.config.simulation_volume = np.prod(np.asarray(self.config.box_size)) + if not self.config.barostat: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.config.a = self.config.rho0 + if not self.config.rho0: + self.config.rho0 = self.config.n_particles / self.config.simulation_volume + self.phi = sympy.var("phi:%d" % (self.config.n_types)) + k = sympy.var("k:%d" % (3)) + + # electrostatics variables + self.psi = sympy.var("psi") + self.phi_q = sympy.var("phi_q") + if not self.config.self_energy: + self.config.self_energy = 0.0 + + def fourier_space_window_function(k): + return sympy.functions.elementary.exponential.exp( + -0.5 + * self.config.sigma**2 + * (k0**2 + k1**2 + k2**2) # noqa: F821, E501 + ) + + self.window_function_lambda = sympy.lambdify( + [k], fourier_space_window_function(k) + ) + + def H(k, v): + return v * self.window_function_lambda(k) + + self.H = H
+ + +
[docs]class SquaredPhi(Hamiltonian): + """Simple squared density interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + \\sum_k \\tilde\\phi_k + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`rho_0` is the + average density of the fully homogenous system. Expressing the species + densities in terms of fluctuations from the average, + + .. math:: + + \\mathrm{d}\\tilde\\phi_k = \\rho_0 - \\tilde\\phi_k, + + it is evident that this interaction energy functional is a slight change of + the :code:`DefaultNoChi` Hamiltonian, as the expanded interaction energy + density becomes + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa\\rho_0} + \\left( + 6\\rho_0\\left[ + \\sum_k \\mathrm{d}\\tilde\\phi_k + \\right] + + + 9\\rho_0^2 + + + \\sum_k \\mathrm{d}\\tilde\\phi_k^2 + + + \\prod_{k\\not=l} + \\mathrm{d}\\tilde\\phi_k \\mathrm{d}\\tilde\\phi_l + \\right), + + identical to :code:`DefaultNoChi` apart from a constant energy shift + :math:`9\\rho_0^2`(which does not impact dynamics) and the + :math:`\\rho_0`--:math:`\\mathrm{d}\\tilde\\phi_k` cross-terms. These + cross-terms constitute contributions to the energy linear in + :math:`\\mathrm{d}\\tilde\\phi_k` absent in :code:`DefaultNoChi`, which has + only quadratic terms present. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(SquaredPhi, self).__init__(config) + super(SquaredPhi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0): + return 0.5 / (kappa * rho0) * (sum(phi)) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + ): + V_incompressibility = 1 / (kappa * rho0) * sum(phi) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultNoChi(Hamiltonian): + """Incompressibility-only interaction energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. The :code:`SquaredPhi` Hamiltonian implements a similar + functional with an additional linear term component depending on + + .. math:: + + \\mathmr{d}\\tilde\\phi_k = \\tilde\\phi_k - \\rho_0 + + and not :math:`\\mathrm{d}\\tilde\\phi_k^2`. No explicit inter-species + interaction is present apart from the indirect interaction through the + incompressibility. + + See also + -------- + hymd.hamiltonian.DefaultNoChi + hymd.input_parser.Config : + Configuration dataclass handler. + """ + +
[docs] def __init__(self, config): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultNoChi, self).__init__(config) + super(DefaultNoChi, self)._setup() + self.setup()
+ +
[docs] def setup(self): + """Setup the interaction energy potential and the external potential""" + + def w(phi, kappa=self.config.kappa, rho0=self.config.rho0, a=self.config.a): + return 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + k, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + V_interaction = 0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[i])) + for i in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +
[docs]class DefaultWithChi(Hamiltonian): + """Incompressibility and :math:`\\chi`-interactions energy functional + + The interaction energy density takes the form + + .. math:: + + w[\\tilde\\phi] = + \\frac{1}{2\\rho_0} + \\sum_{k,l}\\chi_{kl} \\tilde\\phi_k \\tilde\\phi_l + + + \\frac{1}{2\\kappa} \\left( + \\sum_k \\tilde\\phi_k - a + \\right)^2, + + where :math:`\\kappa` is the compressibility and :math:`a=\\rho_0` for + NVT runs where :math:`\\rho_0` is the average density of the fully + homogenous system. In case of NPT runs, :math:`a` is a calibrated + parameter to obtain the correct average density at the target temperature + and pressure. :math:`\\chi_{ij}` is the Flory-Huggins-like + inter-species mixing energy. + """ + +
[docs] def __init__(self, config, unique_names, type_to_name_map): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + super(DefaultWithChi, self).__init__(config) + super(DefaultWithChi, self)._setup() + self.setup(unique_names, type_to_name_map)
+ +
[docs] def setup(self, unique_names, type_to_name_map): + """Setup the interaction energy potential and the external potential + + Parameters + ---------- + unique_names : numpy.ndarray + Sorted array of all distinct names of different species present in + the simulation. Result of :code:`numpy.unique(all_names)`, where + :code:`all_names` is the gathered union of all individual MPI + ranks' :code:`names` arrays. + type_to_name_map : dict[int, str] + Dictionary of the mapping from type indices (integers) to type + names. + """ + self.type_to_name_map = type_to_name_map + self.chi_type_dictionary = { + tuple(sorted([c.atom_1, c.atom_2])): c.interaction_energy + for c in self.config.chi + } + self.phi_laplacian = [ + sympy.var("phi_laplacian%d(0:%d)" % (t, 3)) + for t in range(self.config.n_types) + ] + + def w( + phi, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + interaction = 0.0 + for i in range(self.config.n_types): + for j in range(i + 1, self.config.n_types): + ni = type_to_name_map[i] + nj = type_to_name_map[j] + names = sorted([ni, nj]) + c = chi_type_dictionary[tuple(names)] + + interaction += c * phi[i] * phi[j] / rho0 + incompressibility = 0.5 / (kappa * rho0) * (sum(phi) - a) ** 2 + return incompressibility + interaction + + def w_elec( + phi_q, + psi, + volume=self.config.simulation_volume, + self_energy=self.config.self_energy, + ): + self_energy /= volume + return 0.5 * phi_q * psi - self_energy + + def V_bar_0( + phi, + t, + kappa=self.config.kappa, + rho0=self.config.rho0, + a=self.config.a, + chi=self.config.chi, + type_to_name_map=self.type_to_name_map, + chi_type_dictionary=self.chi_type_dictionary, + ): + V_incompressibility = 1 / (kappa * rho0) * (sum(phi) - a) + + V_interaction = 0.0 + nk = type_to_name_map[t] + for i in range(self.config.n_types): + ni = type_to_name_map[i] + names = sorted([nk, ni]) + if ni != nk: + c = chi_type_dictionary[tuple(names)] + else: + c = 0.0 + # uncomment to count diagonal chi terms: + # c = chi_type_dictionary[tuple(names)] + V_interaction += c * phi[i] / rho0 + return V_interaction + V_incompressibility + + def V_bar_elec( + psi, + t, + type_charges=self.config.type_charges, + ): + return type_charges[t] * psi + + self.V_bar_0 = [ + sympy.lambdify( + [(self.phi)], V_bar_0(self.phi, t) + ) + for t in range(self.config.n_types) + ] + + self.V_bar = [ + sympy.lambdify( + [(self.phi, self.psi)], V_bar_0(self.phi, t) + V_bar_elec(self.psi, t) + ) + for t in range(self.config.n_types) + ] + + self.v_ext = [ + sympy.lambdify([self.phi], sympy.diff(w(self.phi), self.phi[t])) + for t in range(self.config.n_types) + ] + + self.w_0 = sympy.lambdify([self.phi], w(self.phi)) + self.w_elec = sympy.lambdify( + [(self.phi_q, self.psi)], w_elec(self.phi_q, self.psi) + ) + + if self.config.coulombtype == "PIC_Spectral": + self.w = sympy.lambdify( + [(self.phi, self.phi_q, self.psi)], + w(self.phi) + w_elec(self.phi_q, self.psi), + ) + else: + self.w = self.w_0
+ + +def get_hamiltonian(config): + """Return appropriate Hamiltonian object based on the + config.hamiltonian string. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ---------- + hamiltonian : Hamiltonian + Hamiltonian object. + """ + if config.hamiltonian.lower() == "defaultnochi": + hamiltonian = DefaultNoChi(config) + elif config.hamiltonian.lower() == "defaultwithchi": + hamiltonian = DefaultWithChi( + config, config.unique_names, config.type_to_name_map + ) + elif config.hamiltonian.lower() == "squaredphi": + hamiltonian = SquaredPhi(config) + + return hamiltonian +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/_modules/hymd/input_parser.html b/v2.2.0/_modules/hymd/input_parser.html new file mode 100644 index 00000000..e30b5d6d --- /dev/null +++ b/v2.2.0/_modules/hymd/input_parser.html @@ -0,0 +1,1645 @@ + + + + + + hymd.input_parser — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.input_parser

+"""Parses and handles the configuration information provided for the simulation
+"""
+import copy
+import tomli
+import datetime
+import logging
+import warnings
+import numpy as np
+from mpi4py import MPI
+from dataclasses import dataclass, field
+from typing import List, Union, ClassVar
+from .force import Bond, Angle, Dihedral, Chi, Dielectric_type, propensity_potential_coeffs
+from .barostat import Target_pressure
+from .logger import Logger
+
+
+
[docs]@dataclass +class Config: + """Configuration object + + Handles and verifies the simulation configuration specified in the + configuration file. + + Attributes + ---------- + gas_constant : float + Constant value of the gas constant, R (equivalently the Boltzmann + constant) in the units used internally in HyMD. + coulomb_constant : float + Constant value of the Coulomb constant which converts electric field + values to forces and electric potential values to energies in the units + used internally in HyMD. + n_steps: int + Number of time steps in the simulation. + time_step: float + *Outer* time step used in the simulation. If the rRESPA intergrator is + used, the *inner* time step (the time step used in the integration of + intramolecular bending, stretching, and torsional forces) is + :code:`time_step / respa_inner`. + box_size : list[float] or (D,) numpy.ndarray + Simulation box size of simulation in :code:`D` dimensions in units of + nanometers. + mesh_size : list[int] or int or numpy.ndarray + Number of grid points used for the discrete density grid. + sigma : float + Filter width representing the effective coarse-graining level of the + particles in the simulation. + kappa : float + Compressibility parameter used in the relaxed incompressibility term in + the interaction energy functional. + n_print : int, optional + Frequency of trajectory/energy output to the H5MD trajectory/energy + output file (in units of number of time steps). + tau : float, optional + The time scale of the CSVR thermostat coupling. + start_temperature : float, optional + Generate starting temperature by assigning all particle velocities + randomly according to the Maxwell-Boltzmann distribution at + :code:`start_temperature` Kelvin prior to starting the simulation. + target_temperature : float, optional + Couple the system to a heat bath at :code:`target_temperature` Kelvin. + mass : float, optional + Mass of the particles in the simulation. + hamiltonian : str, optional + Specifies the interaction energy functional :math:`W[\\tilde\\phi]` + for use with the particle-field interactions. Options: + :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`. + domain_decomposition : int, optional + Specifies the interval (in time steps) of domain decomposition + exchange, involving all MPI ranks sending and receiving particles + according to the particles’ positions in the integration box and the + MPI ranks’ assigned domain. + integrator : str, optional + Specifies the time integrator used in the simulation. Options: + :code:`velocity-verlet` or :code:`respa`. + respa_inner : int, optional + The number of inner time steps in the rRESPA integrator. This denotes + the number of intramolecular force calculations (stretching, bending, + torsional) are performed between each impulse applied from the field + forces. + file_name : str, optional + File path of the parsed configuration file. + name : str, optional + Name for the simulation. + tags : list[str], optional + Tags for the simulation. + bonds : list[Bond], optional + Specifies harmonic stretching potentials between particles in the + same molecule. + angle_bonds : list[Angle], optional + Specifies harmonic angular bending potentials between particles in the + same molecule. + dihedrals : list[Dihedral], optional + Specifies four-particle torsional potentials by cosine series. + chi : list[Chi], optional + Specifies :math:`\\chi`-interaction parameters between particle + species. + n_particles : int, optional + Specifies the total number of particles in the input. Optional keyword + for validation, ensuring the input HDF5 topology has the correct number + of particles and molecules. + max_molecule_size : int, optional + Maximum size of any single molecule in the system. Used to speed up + distribution of particles onto MPI ranks in a parallel fashion. + n_flush : int, optional + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be + written to disk (in units of number of :code:`n_print`). + thermostat_work : float + Work performed by the thermostat on the system. + thermostat_coupling_groups : list[str], optional + Specifies individual groups coupling independently to the CSVR + thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and + :code:`"C"` type particles, + :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would + thermalise types :code:`"A"` and :code:`"B"` together and couple + :code:`"C"` type particles to a different thermostat (all individual + thermostats are at the same temperature, i.e. target_temperature + Kelvin). + initial_energy : float + Value of the total energy prior to the start of the simulation. + cancel_com_momentum : int, optional + If :code:`True`, the total linear momentum of the center of mass is + removed before starting the simulation. If an integer is specifed, the + total linear momentum of the center of mass is removed every + :code:`remove_com_momentum` time steps. If :code:`False`, the linear + momentum is never removed. + coulombtype : str, optional + Specifies the type of electrostatic Coulomb interactions in the system. + The strength of the electrostatic forces is modulated by the relative + dielectric constant of the simulation medium, specified with the + :code:`dielectric_const` keyword. Charges for individual particles are + specified in the structure/topology HDF5 input file, not in the + configuration file. If no charges (or peptide backbone dipoles) are + present, the electrostatic forces will not be calculated even if this + keyword is set to :code:`"PIC_Spectral"`. + dielectric_const : float, optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. When + using helical propensity dihedrals, this keyword must be specified—even + if electrostatics are not included with the :code:`coulombtype` + keyword. + dielectric_type: list[float], optional + Specifies the relative dielectric constant of the simulation medium + which regulates the strength of the electrostatic interactions. The list assigns + relative dielectric values to each bead type, and an anisotropic + dielectric function is obtained from a weighted average. + + + See also + -------- + hymd.input_parser.Bond : + Two-particle bond type dataclass. + hymd.input_parser.Angle : + Three-particle bond type dataclass. + hymd.input_parser.Dihedral : + Four-particle bond type dataclass. + """ + + gas_constant: ClassVar[float] = 0.0083144621 # kJ mol-1 K-1 + coulomb_constant: ClassVar[float] = 138.935458 # kJ nm mol-1 e-2 + + n_steps: int + time_step: float + mesh_size: Union[Union[List[int], np.ndarray], int] + sigma: float + kappa: float + + dtype: np.dtype = None + box_size: Union[List[float], np.ndarray] = None + n_print: int = None + tau: float = None + start_temperature: Union[float, bool] = None + target_temperature: Union[float, bool] = None + mass: float = None + hamiltonian: str = None + domain_decomposition: Union[int, bool] = None + integrator: str = None + respa_inner: int = 1 + file_name: str = "<config file path unknown>" + name: str = None + tags: List[str] = field(default_factory=list) + bonds: List[Bond] = field(default_factory=list) + angle_bonds: List[Angle] = field(default_factory=list) + dihedrals: List[Dihedral] = field(default_factory=list) + chi: List[Chi] = field(default_factory=list) + n_particles: int = None + max_molecule_size: int = None + n_flush: int = None + thermostat_work: float = 0.0 + thermostat_coupling_groups: List[List[str]] = field(default_factory=list) + initial_energy: float = None + cancel_com_momentum: Union[int, bool] = False + coulombtype: str = None + convergence_type: str = None + pol_mixing: float = None + dielectric_const: float = None + conv_crit: float = None + dielectric_type: List[Dielectric_type] = field(default_factory=list) + self_energy: float = None + type_charges: Union[List[float], np.ndarray] = None + + # For NPT runs + rho0: float = None + a: float = None + pressure: bool = False + barostat: str = None + barostat_type: str = None + tau_p: float = None + target_pressure: List[Target_pressure] = field(default_factory=list) + n_b: int = None + m: List[float] = field(default_factory=list) + + def __str__(self): + target_pressure_str = "\ttarget_pressure:\n" + "".join( + "\t\tP_L: " + + f"{self.target_pressure.P_L}\n" + + "\t\tP_N: " + + f"{self.target_pressure.P_N}\n" + ) + bonds_str = "\tbonds:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " f"{k.equilibrium}, {k.strength}\n") + for k in self.bonds + ] + ) + angle_str = "\tangle_bonds:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3}: " + + f"{k.equilibrium}, {k.strength}\n" + ) + for k in self.angle_bonds + ] + ) + dihedrals_str = "\tdihedrals:\n" + "".join( + [ + ( + f"\t\t{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: " + # This might need to be fixed/made prettier, probably + # there's an easier way + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ).join( + map( + str, + [ + [round(num, 3) for num in c_in] + if isinstance(c_in, list) + else c_in + for c_in in k.coeffs + ], + ) + ) + + ( + "\n\t\t" + + " " * len(f"{k.atom_1} {k.atom_2} {k.atom_3} {k.atom_4}: ") + ) + + f"dih_type = {k.dih_type}\n" + ) + for k in self.dihedrals + ] + ) + chi_str = "\tchi:\n" + "".join( + [ + (f"\t\t{k.atom_1} {k.atom_2}: " + f"{k.interaction_energy}\n") + for k in self.chi + ] + ) + + """ If dielectric wanted as dictionary + dielectric_type_str = "\tdielectric_type:\n" + "".join( + [ + (f"\t\t{k.atom_1}: " + f"{k.dielectric_value}\n") + for k in self.dielectric_type + ] + ) + + """ + + thermostat_coupling_groups_str = "" + if any(self.thermostat_coupling_groups): + thermostat_coupling_groups_str = ( + "\tthermostat_coupling_groups:\n" + + "".join( + [ + "\t\t" + ", ".join([f"{n}" for n in ng]) + "\n" + for ng in self.thermostat_coupling_groups + ] + ) + ) + + ret_str = f'\n\n\tConfig: {self.file_name}\n\t{50 * "-"}\n' + for k, v in self.__dict__.items(): + if k not in ( + "target_pressure", + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "thermostat_coupling_groups", + ): + ret_str += f"\t{k}: {v}\n" + ret_str += ( + target_pressure_str + + bonds_str + + angle_str + + dihedrals_str + + chi_str + + thermostat_coupling_groups_str + ) + return ret_str
+ + +
[docs]def read_config_toml(file_path): + with open(file_path, "r") as in_file: + file_content = in_file.read() + return file_content
+ +
[docs]def parse_config_toml(toml_content, file_path=None, comm=MPI.COMM_WORLD): + config_dict = {} + + # read toml to a dictionary + toml_content = tomli.loads(toml_content) + + # Defaults = None + for n in ( + "box_size", + "n_print", + "tau", + "start_temperature", + "target_temperature", + "mass", + "hamiltonian", + "domain_decomposition", + "integrator", + "name", + "n_particles", + "max_molecule_size", + "coulombtype", + "convergence_type", + "dielectric_const", + "pol_mixing", + "conv_crit", + "dielectric_type", + "n_b", + "box_size", + "n_flush", + "self_energy", + "dtype", + ): + config_dict[n] = None + + # Defaults = [] + + for n in ( + "bonds", + "angle_bonds", + "dihedrals", + "chi", + "tags", + "m", + "dielectric_type", + "target_pressure", + "type_charges", + ): + config_dict[n] = [] + + # Defaults: bool + config_dict["pressure"] = False + + # Flatten the .toml dictionary, ignoring the top level [tag] directives (if + # any). + for k, v in toml_content.items(): + if isinstance(v, dict): + if k == "nn": # Don't parse diff-hymd optimization options + continue + for nested_k, nested_v in v.items(): + config_dict[nested_k] = nested_v + else: + config_dict[k] = v + for k, v in config_dict.items(): + if k == "bonds": + config_dict["bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["bonds"][i] = Bond( + atom_1=b[0], + atom_2=b[1], + equilibrium=b[2], + strength=b[3], + ) + if k == "angle_bonds": + config_dict["angle_bonds"] = [None] * len(v) + for i, b in enumerate(v): + config_dict["angle_bonds"][i] = Angle( + atom_1=b[0], + atom_2=b[1], + atom_3=b[2], + equilibrium=b[3], + strength=b[4], + ) + if k == "dihedrals": + config_dict["dihedrals"] = [None] * len(v) + for i, b in enumerate(v): + try: + dih_type = int(b[2][0]) + except IndexError: + Logger.rank0.log( + logging.WARNING, "Dihedral type not provided, defaulting to 0." + ) + dih_type = 0 + + # Probably it's better to move this in check_dihedrals? + wrong_len = len(b[1]) not in (1, 2) + wrong_type_1 = len(b[1]) == 1 and not isinstance(b[1][0], float) + wrong_type_2 = len(b[1]) == 2 and not isinstance(b[1][0], list) + if wrong_len or wrong_type_1 or wrong_type_2: + err_str = ( + "The coefficients specified for the dihedral type " + "(0) do not match the correct structure. Either " + "use [lambda] or [[cn_prop], [dn_prop]], or select" + " the correct dihedral type." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise RuntimeError(err_str) + + # FIXME: this is messy af, I don't like it + if dih_type == 0 and isinstance(b[1][0], (float, int)): + coeff = propensity_potential_coeffs(b[1][0]) + elif dih_type == 1 and len(b[1]) == 3: + coeff = np.array( + propensity_potential_coeffs(b[1][0][0]).tolist() + + b[1][1:] + ) + elif dih_type == 2: + coeff = np.array(b[1]) + else: + coeff = np.insert(np.array(b[1]), 2, np.zeros((2, 5)), axis=0) + + config_dict["dihedrals"][i] = Dihedral( + atom_1=b[0][0], + atom_2=b[0][1], + atom_3=b[0][2], + atom_4=b[0][3], + coeffs=coeff, + dih_type=dih_type, + ) + if k == "chi": + config_dict["chi"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0], c[1]]) + config_dict["chi"][i] = Chi( + atom_1=c_[0], atom_2=c_[1], interaction_energy=c[2] + ) + + """ + if k == "dielectric_type": + config_dict["dielectric_type"] = [None] * len(v) + for i, c in enumerate(v): + c_ = sorted([c[0][0]]) + config_dict["dielectric_type"][i] = Dielectric_type( + atom_1=c_[0], dielectric_value=c[1][0] + ) + """ + if k == "target_pressure": + if len(v) == 2: + config_dict["target_pressure"] = Target_pressure( + P_L=v[0], + P_N=v[1], # check condition # V array (still read as array?) + ) + elif len(v) == 1: + config_dict["target_pressure"] = Target_pressure(P_L=v[0], P_N=None) + else: + config_dict["target_pressure"] = Target_pressure(P_L=None, P_N=None) + + if file_path is not None: + config_dict["file_name"] = file_path + + for n in ( + "n_steps", "time_step", "mesh_size", "sigma", "kappa" + ): + if n not in config_dict: + err_str = ( + f"No {n} specified in config file {file_path}. Unable to start" + f" simulation." + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return Config(**config_dict)
+ + +
[docs]def check_n_particles(config, indices, comm=MPI.COMM_WORLD): + n_particles = comm.allreduce(len(indices), MPI.SUM) + if config.n_particles is None: + config = copy.deepcopy(config) + config.n_particles = n_particles + info_str = ( + f"No n_particles found in toml file {config.file_name}, defaulting" + f" to indices.shape ({n_particles})" + ) + Logger.rank0.log(logging.INFO, info_str) + return config + + if n_particles != config.n_particles: + warn_str = ( + f"n_particles in {config.file_name} ({config.n_particles}) does " + "not match the shape of the indices array in the .HDF5 file " + f"({n_particles}). Defaulting to using indices.shape " + f"({n_particles})" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.n_particles = n_particles + return config
+ + +
[docs]def check_max_molecule_size(config, comm=MPI.COMM_WORLD): + if config.max_molecule_size is None: + info_str = ( + f"No max_molecule_size found in toml file {config.file_name}, " + f"defaulting to 201" + ) + Logger.rank0.log(logging.INFO, info_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + + if config.max_molecule_size < 1: + warn_str = ( + f"max_molecule_size in {config.file_name} must be a positive " + f"integer, not {config.max_molecule_size}, defaulting to 201" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config = copy.deepcopy(config) + config.max_molecule_size = 201 + return config + return config
+ + +def _find_unique_names(config, names, comm=MPI.COMM_WORLD): + unique_names = np.unique(names) + receive_buffer = comm.gather(unique_names, root=0) + + gathered_unique_names = None + if comm.Get_rank() == 0: + gathered_unique_names = np.unique(np.concatenate(receive_buffer)) + unique_names = comm.bcast(gathered_unique_names, root=0) + unique_names = sorted([n.decode("UTF-8") for n in unique_names]) + config.unique_names = unique_names + config.n_types = len(unique_names) + return config + + +def _setup_type_to_name_map(config, names, types, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + name_to_type_ = {} + for n, t in zip(names, types): + n = n.decode("utf-8") + if n not in name_to_type_: + name_to_type_[n] = t + receive_buffer = comm.gather(name_to_type_, root=0) + gathered_dict = None + if comm.Get_rank() == 0: + gathered_dict = {} + for d in receive_buffer: + for k, v in d.items(): + if k not in gathered_dict: + gathered_dict[k] = v + else: + assert v == gathered_dict[k] + name_to_type_map = comm.bcast(gathered_dict, root=0) + config.name_to_type_map = name_to_type_map + config.type_to_name_map = {v: k for k, v in name_to_type_map.items()} + return config + + +
[docs]def check_bonds(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for b in config.bonds: + if b.atom_1 not in unique_names or b.atom_2 not in unique_names: + missing_str = "" + if b.atom_1 not in unique_names: + if b.atom_2 not in unique_names: + if b.atom_1 == b.atom_2: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"neither {b.atom_1}, {b.atom_2} atoms" + else: + missing_str = f"no {b.atom_1} atoms" + else: + missing_str = f"no {b.atom_2} atoms" + + warn_str = ( + f"Bond type {b.atom_1}--{b.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_angles(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for a in config.angle_bonds: + if ( + a.atom_1 not in unique_names + or a.atom_2 not in unique_names + or a.atom_3 not in unique_names + ): + missing = [ + a.atom_1 not in unique_names, + a.atom_2 not in unique_names, + a.atom_3 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([a.atom_1, a.atom_2, a.atom_3]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Angle bond type {a.atom_1}--{a.atom_2}--{a.atom_3} " + f"specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_dihedrals(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for d in config.dihedrals: + if ( + d.atom_1 not in unique_names + or d.atom_2 not in unique_names + or d.atom_3 not in unique_names + or d.atom_4 not in unique_names + ): + missing = [ + d.atom_1 not in unique_names, + d.atom_2 not in unique_names, + d.atom_3 not in unique_names, + d.atom_4 not in unique_names, + ] + missing_names = [ + atom + for i, atom in enumerate([d.atom_1, d.atom_2, d.atom_3, d.atom_4]) + if missing[i] + ] + missing_str = ", ".join(np.unique(missing_names)) + + warn_str = ( + f"Dihedral type {d.atom_1}--{d.atom_2}--{d.atom_3}--{d.atom_4}" + f" specified in {config.file_name} but no {missing_str} atoms " + f"are present in the specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_chi(config, names, comm=MPI.COMM_WORLD): + if not hasattr(config, "unique_names"): + config = _find_unique_names(config, names) + unique_names = config.unique_names + + for c in config.chi: + if c.atom_1 not in unique_names or c.atom_2 not in unique_names: + missing_str = "" + if c.atom_1 not in unique_names: + if c.atom_2 not in unique_names: + if c.atom_1 == c.atom_2: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"neither {c.atom_1}, {c.atom_2} atoms" + else: + missing_str = f"no {c.atom_1} atoms" + else: + missing_str = f"no {c.atom_2} atoms" + + warn_str = ( + f"Chi interaction {c.atom_1}--{c.atom_2} specified in " + f"{config.file_name} but {missing_str} are present in the " + f"specified system (names array)" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + for i, n in enumerate(unique_names): + for m in unique_names[i + 1 :]: + found = False + for c in config.chi: + if (c.atom_1 == n and c.atom_2 == m) or ( + c.atom_1 == m and c.atom_2 == n + ): + found = True + if not found: + config.chi.append(Chi(atom_1=n, atom_2=m, interaction_energy=0.0)) + warn_str = ( + f"Atom types {n} and {m} found in the " + f"system, but no chi interaction {n}--{m} " + f"specified in {config.file_name}. Defaulting to " + f"chi[{n}, {m}] = 0" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_box_size(config, input_box, comm=MPI.COMM_WORLD): + if config.box_size is not None: + config.box_size = np.array(config.box_size, dtype=np.float32) + if input_box.all() and not np.allclose(config.box_size, input_box, atol=0.009): + err_str = ( + f"Box size specified in {config.file_name}: " + f"{config.box_size} does not match input box:" + f"{input_box}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + else: + if input_box.all(): + config.box_size = input_box + else: + err_str = f"No box information found" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + for b in config.box_size: + if b <= 0.0: + err_str = ( + f"Invalid box size specified in {config.file_name}: " + f"{config.box_size}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + return config
+ + +
[docs]def check_integrator(config, comm=MPI.COMM_WORLD): + if config.integrator.lower() not in ("velocity-verlet", "respa"): + err_str = ( + f"Invalid integrator specified in {config.file_name}: " + f'{config.integrator}. Available options "velocity-verlet" or ' + f'"respa".' + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise ValueError(err_str) + + if config.integrator.lower() == "respa": + if isinstance(config.respa_inner, float): + warn_str = ( + f"Number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner} specified " + f"as float, using {int(config.respa_inner)}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = int(config.respa_inner) + elif not isinstance(config.respa_inner, int): + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + + if config.respa_inner <= 0: + err_str = ( + f"Invalid number of inner rRESPA time steps in " + f"{config.file_name}: {config.respa_inner}. Must be " + f"positive integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + if config.integrator.lower() == "velocity-verlet" and config.respa_inner != 1: + warn_str = ( + f"Integrator type Velocity-Verlet specified in {config.file_name} " + f"and inner rRESPA time steps set to {config.respa_inner}. " + f"Using respa_inner = 1" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.respa_inner = 1 + + return config
+ + +
[docs]def check_hamiltonian(config, comm=MPI.COMM_WORLD): + valid_hamiltonians = ["defaultnochi", "defaultwithchi", "squaredphi"] + + if config.hamiltonian is None: + if len(config.chi) == 0: + warn_str = ( + f"No hamiltonian form and no chi interactions specified in " + f"{config.file_name}, defaulting to DefaultNoChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultNoChi" + else: + warn_str = ( + f"No hamiltonian form specified in {config.file_name}, but " + f"chi interactions are specified, defaulting to " + f"DefaultWithChi hamiltonian" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + config.hamiltonian = "DefaultWithChi" + elif config.hamiltonian.lower() not in valid_hamiltonians: + err_str = ( + f"The specified Hamiltonian {config.hamiltonian} was not " + f"recognized as a valid Hamiltonian." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise NotImplementedError(err_str) + + return config
+ + +
[docs]def check_n_flush(config, comm=MPI.COMM_WORLD): + if config.n_print: + if config.n_flush is None: + config.n_flush = 10000 // config.n_print + return config
+ + +
[docs]def check_n_print(config, comm=MPI.COMM_WORLD): + if ( + not isinstance(config.n_print, int) + and not isinstance(config.n_print, float) + and config.n_print is not None + ): + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if config.n_print is None or config.n_print <= 0: + config.n_print = False + elif not isinstance(config.n_print, int): + if isinstance(config.n_print, float): + warn_str = ( + f"n_print is a float ({config.n_print}), not int, using " + f"{int(round(config.n_print))}" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + config.n_print = int(round(config.n_print)) + else: + err_str = f"invalid value for n_print ({config.n_print})" + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + return config
+ + +
[docs]def check_tau(config, comm=MPI.COMM_WORLD): + if config.tau is None and config.target_temperature is not None: + warn_str = "target temp specified but no tau, defaulting 0.7" + config.tau = 0.7 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_start_and_target_temperature(config, comm=MPI.COMM_WORLD): + """Validate provided starting and target thermostat temperatures + + Assesses the provided temperature target and ensures it is a non-negative + floating point number or :code:`False`. Ensures the starting temperature is + a non-negative floating point number or :code:`False`. + + If the value for either is :code:`None`, the returned configuration object + has the values defaulted to :code:`False` in each case. + + Parameters + ---------- + config : Config + Configuration object. + + Returns + ------- + validated_config : Config + Configuration object with validated :code:`target_temperature` and + :code:`start_temperature`. + """ + for t in ("start_temperature", "target_temperature"): + if getattr(config, t) is not None: + try: + if getattr(config, t) < 0: + warn_str = ( + f"{t} set to negative value ({getattr(config, t)}), " + f"defaulting to False" + ) + setattr(config, t, False) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + except TypeError as e: + err_str = ( + f"Could not interpret {t} = {repr(getattr(config, t))} as " + f"a number." + ) + raise TypeError(err_str) from e + + if config.start_temperature is None: + config.start_temperature = False + if config.target_temperature is None: + config.target_temperature = False + return config
+ + +
[docs]def check_mass(config, comm=MPI.COMM_WORLD): + if config.mass is None: + info_str = "no mass specified, defaulting to 72.0" + config.mass = 72.0 + Logger.rank0.log(logging.INFO, info_str) + elif not isinstance(config.mass, int) and not isinstance(config.mass, float): + err_str = ( + f"specified mass is invalid type {config.mass}, " f"({type(config.mass)})" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise TypeError(err_str) + elif config.mass < 0: + err_str = f"invalid mass specified, {config.mass}" + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + else: + config.mass = float(config.mass) + + return config
+ + +
[docs]def check_domain_decomposition(config, comm=MPI.COMM_WORLD): + dd = config.domain_decomposition + if dd is None or dd is False: + config.domain_decomposition = False + return config + + if isinstance(dd, int): + if dd < 0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + elif isinstance(dd, float): + if dd < 0.0: + warn_str = "negative domain_decomposition specified, using False" + config.domain_decomposition = False + else: + warn_str = ( + f"domain_decomposition ({config.domain_decomposition}) is not " + f"an integer, using {int(round(dd))}" + ) + config.domain_decomposition = int(round(dd)) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + else: + err_str = ( + f"invalid value for domain_decomposition " + f"({config.domain_decomposition}) use an integer" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ValueError(err_str) + + return config
+ + +
[docs]def check_name(config, comm=MPI.COMM_WORLD): + if config.name is None: + root_current_time = "" + if comm.Get_rank() == 0: + root_current_time = datetime.datetime.now().strftime("%m/%d/%Y, %H:%M:%S") + current_time = comm.bcast(root_current_time, root=0) + + if config.name is None: + config.name = "sim" + current_time + else: + config.name = str(config.name) + return config
+ + +
[docs]def check_NPT_conditions(config, comm=MPI.COMM_WORLD): + """ + Check validity of barostat_type, barostat, + a, rho0, target_pressure, tau_p + """ + if config.barostat is None: + if ( + config.tau_p is not None + or (config.target_pressure.P_L and config.target_pressure.P_N) is not None + ): + err_str = ( + "barostat not specified but config.tau_p " + "or config.target_pressure specified, cannot start simulation {config.barostat}" + ) + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.a: + warn_str = "a specified but no barostat," "setting a to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.rho0: + warn_str = ( + "rho0 specified but no barostat," "setting rho0 to average density" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + if config.barostat is not None: + if not config.barostat_type: + config.barostat_type = "berendsen" + warn_str = "barostat_type not specified," "setting to berendsen" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.barostat != "isotropic" and config.barostat != "semiisotropic": + err_str = "barostat option not recognised. Valid options: isotropic, semiisotropic" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if config.target_pressure.P_L is None: + config.target_pressure.P_L = 1.0 # bar + config.target_pressure.P_N = None + if config.barostat == "semiisotropic": + config.target_pressure.P_N = 1.0 # bar + warn_str = ( + "barostat specified but no target_pressure, defaulting to 1.0 bar" + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if config.tau_p is None: + if config.tau <= 0.1: + config.tau_p = config.tau * 10.0 + else: + config.tau_p = 1.0 + warn_str = "barostat specified but no tau_p, defaulting to " + str( + config.tau_p + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + if not config.a: + err_str = "a not specified; cannot start simulation {config.a}" + Logger.rank0.log(logging.ERROR, err_str) + if comm.Get_rank() == 0: + raise TypeError(err_str) + if not config.rho0: + warn_str = "rho0 not specified;" "setting rho0 to average density" + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + return config
+ + +
[docs]def check_thermostat_coupling_groups(config, comm=MPI.COMM_WORLD): + if any(config.thermostat_coupling_groups): + found = [0 for _ in config.unique_names] + unique_names = [n for n in config.unique_names] + for i, group in enumerate(config.thermostat_coupling_groups): + for species in group: + try: + ind = unique_names.index(species) + found[ind] += 1 + except ValueError as e: + err_str = ( + f"Particle species {species} specified in thermostat " + f"coupling group {i}, but no {species} particles were " + "found in the system." + ) + raise ValueError(err_str) from e + if any([True if f > 1 else False for f in found]): + for i, f in enumerate(found): + if f > 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} specified in multiple " + "thermostat coupling groups; " + f"{config.thermostat_coupling_groups}." + ) + raise ValueError(err_str) + if not all([True if f == 1 else False for f in found]): + for i, f in enumerate(found): + if f != 1: + species = unique_names[i] + err_str = ( + f"Particle species {species} not specified in any " + f"thermostat coupling group, but {species} particles " + "were found in the system" + ) + raise ValueError(err_str) + return config
+ + +
[docs]def check_m(config, comm=MPI.COMM_WORLD): + if config.m == []: + config.m = [1.0 for t in range(config.n_types)] + return config
+ + +
[docs]def check_n_b(config, comm=MPI.COMM_WORLD): + if config.n_b is None: + warn_str = f"config.n_b not specified." "Defaulting to 1" + config.n_b = 1 + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + return config
+ + +
[docs]def check_cancel_com_momentum(config, comm=MPI.COMM_WORLD): + if isinstance(config.cancel_com_momentum, int): + if config.cancel_com_momentum == 0 or config.cancel_com_momentum < 0: + config.cancel_com_momentum = False + elif not isinstance(config.cancel_com_momentum, bool): + err_str = ( + f"Could not interpret {config.cancel_com_momentum} as an integer " + f"or boolean." + ) + raise ValueError(err_str) + return config
+ + +
[docs]def sort_dielectric_by_type_id(config, charges, types): + """ + Creates a list of length N CG-particles, sorted after the charges from + the input HDF5 file. Used in file_io.py + """ + dielectric_val = np.zeros(config.n_types) + for j in range(config.n_types): + name = config.dielectric_type[j][0][0] + type_id = config.name_to_type_map[name] + dielectric_val[type_id] = config.dielectric_type[j][1][0] + config.dielectric_type = dielectric_val.copy() + + N = len(charges) + len_list = np.zeros(config.n_types) + dielectric_by_types = np.zeros(N) + for i in range(N): + dielectric_by_types[i] = dielectric_val[types[i]] + # print("types ", types) + # print("diel val", dielectric_by_types) + # print("charges", charges) + # print(config.name_to_type_map) + return dielectric_by_types # by types with each particle id
+ + +
[docs]def check_charges_types_list(config, types, charges, comm=MPI.COMM_WORLD): + """ + Creates a list of charge values of length types. + Charges are sorted according to type ID. Used in field.py. + # TODO: this is messy, we should fix it + """ + if charges is None: + config.type_charges = [0.0] * config.n_types + return config + + check_val = -100.0 # some random value that will never be encountered + charges_list = np.full(config.n_types, check_val) # gatherv cant handle None + rank = comm.Get_rank() + # print(charges_list) + for t_ in range(config.n_types): + if t_ in types: + charges_list[t_] = charges[types == t_][0] + + nprocs = int(comm.Get_size()) + recv_charges = None + if rank == 0: + recv_charges = np.full( + config.n_types * nprocs, check_val + ) # gatherv cant handle None + comm.Gather(charges_list, recv_charges, root=0) + + ## make a charges list + if rank == 0: + config_charges = np.zeros(config.n_types) + test_config = np.full(config.n_types, check_val) + for j in range(nprocs): + for i in range(config.n_types): + if recv_charges[i + j * config.n_types] != check_val: + config_charges[i] = recv_charges[i + j * config.n_types] + if np.any([test_config, config_charges]): + continue + else: + break + + # print(config_charges) + # print(config.name_to_type_map) + # print(charges[types == 0][0],charges[types == 1][0],charges[types == 2][0],charges[types == 3][0], + # charges[types == 4][0]) + else: + config_charges = np.zeros(config.n_types) + + comm.Bcast(config_charges, root=0) + # print("config_charges", config_charges , "rank", rank) + # print(recv_charges) + # rank = comm.Get_rank() + # print(all_charges) + config.type_charges = config_charges + return config
+ + +
[docs]def check_dielectric(config, comm=MPI.COMM_WORLD): + """ + Error handling for electrostatics. + Unit testing of toml/tomli input. + """ + err_str_const = "Dielectric constant not given." + if config.coulombtype == "PIC_Spectral": + assert config.dielectric_const != None, err_str_const + + err_str = "Dielectric list is empty." + if config.coulombtype == "PIC_Spectral_GPE": + assert len(config.dielectric_type) != 0, err_str + # default values + if config.pol_mixing is None: + config.pol_mixing = 0.6 + if config.conv_crit is None: + config.conv_crit = 1e-6 + return config
+ + +
[docs]def check_charges(config, charges, comm=MPI.COMM_WORLD): + """Check if charges across ranks sum to zero. + + Parameters + ---------- + charges : (N,) numpy.ndarray + Array of floats with charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + """ + total_charge = comm.allreduce(np.sum(charges), MPI.SUM) + + if not np.isclose(total_charge, 0.0): + warn_str = ( + f"Charges in the input file do not sum to zero. " + f"Total charge is {total_charge}." + ) + Logger.rank0.log(logging.WARNING, warn_str) + if comm.Get_rank() == 0: + warnings.warn(warn_str) + + # if charges are ok, compute self energy + if config.coulombtype == "PIC_Spectral": + from .field import compute_self_energy_q + + config.self_energy = compute_self_energy_q(config, charges, comm=comm) + + return config
+ + +
[docs]def check_config( + config, indices, names, types, charges, input_box, comm=MPI.COMM_WORLD +): + """Performs various checks on the specfied config to ensure consistency + + Parameters + ---------- + config : Config + Configuration object. + indices : (N,) numpy.ndarray + Array of integer indices for :code:`N` particles. + names : (N,) numpy.ndarray + Array of string names for :code:`N` particles. + types : (N,) numpy.ndarray + Array of integer type indices for :code:`N` particles. + charges : (N,) numpy.ndarray + Array of floats charges for :code:`N` particles. + comm : mpi4py.Comm, optional + MPI communicator, defaults to :code:`mpi4py.COMM_WORLD`. + + Returns + ------- + config : Config + Validated configuration object. + """ + config = _find_unique_names(config, names, comm=comm) + if types is not None: + config = _setup_type_to_name_map(config, names, types, comm=comm) + config = check_box_size(config, input_box, comm=comm) + config = check_integrator(config, comm=comm) + config = check_max_molecule_size(config, comm=comm) + config = check_tau(config, comm=comm) + config = check_start_and_target_temperature(config, comm=comm) + config = check_mass(config, comm=comm) + config = check_domain_decomposition(config, comm=comm) + config = check_name(config, comm=comm) + config = check_n_particles(config, indices, comm=comm) + config = check_chi(config, names, comm=comm) + config = check_bonds(config, names, comm=comm) + config = check_angles(config, names, comm=comm) + config = check_dihedrals(config, names, comm=comm) + config = check_hamiltonian(config, comm=comm) + config = check_NPT_conditions(config, comm=comm) + config = check_n_b(config, comm=comm) + config = check_m(config, comm=comm) + config = check_thermostat_coupling_groups(config, comm=comm) + config = check_cancel_com_momentum(config, comm=comm) + config = check_dielectric(config, comm=comm) + config = check_n_print(config, comm=comm) + config = check_n_flush(config, comm=comm) + config = check_charges_types_list(config, types, charges, comm=comm) + if charges is not None: + config = check_charges(config, charges, comm=comm) + + return config
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/_modules/hymd/integrator.html b/v2.2.0/_modules/hymd/integrator.html new file mode 100644 index 00000000..68b25cb9 --- /dev/null +++ b/v2.2.0/_modules/hymd/integrator.html @@ -0,0 +1,368 @@ + + + + + + hymd.integrator — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.integrator

+"""Integrates equations of motion.
+
+Implements the Velocity Verlet integrator. The *reversible reference system
+propagator algorithm* (rRESPA) integrator uses the Velocity Verlet functions
+inside the MD loop in the main module.
+"""
+
+
+
[docs]def integrate_velocity(velocities, accelerations, time_step): + """Velocity update step of the Velocity Verlet integration algorithm. + + Computes the velocity update step of the Velocity Verlet algorithm. The + :code:`velocities` argument is **not** changed in place. + + Parameters + ---------- + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + accelerations : (N, D) numpy.ndarray + Array of accelerations of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step + + .. math:: \\mathbf{v}_{\\text{new}} = \\mathbf{v} + \\frac{\\Delta t}{2m} + \\mathbf{f} + + before the positions are moved a full step using the updated half-step + velocities. + + See Also + -------- + integrate_position : The position update step of the Velocity Verlet + algorithm. + """ + return velocities + 0.5 * time_step * accelerations
+ + +
[docs]def integrate_position(positions, velocities, time_step): + """Position update step of the Velocity Verlet integration algorithm. + + Computes the position update step of the Velocity Verlet algorithm. The + :code:`positions` argument is **not** changed in place. + + Parameters + ---------- + positions : (N, D) numpy.ndarray + Array of positions of :code:`N` particles in :code:`D` dimensions. + velocities : (N, D) numpy.ndarray + Array of velocities of :code:`N` particles in :code:`D` dimensions. + time_step : float + The time step used in the integration. + + Notes + ----- + The Velocity Verlet algorithm contains two steps, first the velocties are + integrated one half step forward in time by applying the forces from the + previous step, then the positions are updated a full step using the updated + velocities + + .. math:: \\mathbf{x}_{\\text{new}} = \\mathbf{x} + \\Delta t \\mathbf{v} + + See Also + -------- + integrate_velocity : The velocity update step of the Velocity Verlet + algorithm. + """ + return positions + time_step * velocities
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/_modules/hymd/logger.html b/v2.2.0/_modules/hymd/logger.html new file mode 100644 index 00000000..f2cc3d5d --- /dev/null +++ b/v2.2.0/_modules/hymd/logger.html @@ -0,0 +1,557 @@ + + + + + + hymd.logger — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.logger

+"""Handles event logging for simulation information, warnings, and errors.
+"""
+import sys
+import os
+import logging
+from mpi4py import MPI
+from .version import __version__
+
+
+
[docs]class MPIFilterRoot(logging.Filter): + """Log output Filter wrapper class for the root MPI rank log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + if self.comm.Get_rank() == 0: + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True + else: + return False
+ + +
[docs]class MPIFilterAll(logging.Filter): + """Log output Filter wrapper class for the all-MPI-ranks log""" + + comm = None + + def __init__(self, comm=MPI.COMM_WORLD): + self.comm = comm + +
[docs] def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.rank = self.comm.Get_rank() + record.size = self.comm.Get_size() + return True
+ + +class MPIFilterStdout(logging.Filter): + """Log output Filter wrapper class for filtering STDOUT log""" + + def filter(self, record): + """Log event message filter + + Parameters + ---------- + record : logging.LogRecord + LogRecord object corresponding to the log event. + """ + if record.funcName == "<module>": + record.funcName = "main" + record.funcName = "replica 0 " + record.funcName + if MPI.COMM_WORLD.Get_rank() == 0: + record.rank = MPI.COMM_WORLD.Get_rank() + record.size = MPI.COMM_WORLD.Get_size() + return True + else: + return False + + +
[docs]class Logger: + """Log output handler class + + Notes + ----- + This wraps the default python library :code:`logging`, see + `docs.python.org/3/library/logging.html`_. + + .. _`docs.python.org/3/library/logging.html`: + https://docs.python.org/3/library/logging.html + + Attributes + ---------- + level : int + Determines the verbosity level of the log, corresponding to + logging.level. Numerical values :code:`50` (:code:`logging.CRITICAL`), + :code:`40` (:code:`logging.ERROR`), :code:`30` + (:code:`logging.WARNING`), :code:`20` (:code:`logging.INFO`), + :code:`10` (:code:`logging.DEBUG`), and :code:`0` + (:code:`logging.UNSET`) are supported values. Any log event message + less severe than the specified level is ignored. All other event + messages are emitted. + log_file : str + Path to output log file. + format : str + Prepended dump string for each log event. Specifies the log event + level, the module emitting the event, the code line, the enclosing + function name, and the MPI rank writing the message. + date_format : str + Prepends the date before all log event messages. + formatter : logging.Formatter + Formatter handling the prepending of the information in `format` and + `date_format` to each log event message. Used by default for all + loggers. + rank0 : logging.Logger + Default logger object for the root MPI rank. + all_ranks : logging.Logger + Default logger object for messages being emitted from all MPI ranks + simultaneously. + """ + + level = None + log_file = None + format = " %(levelname)-8s [%(filename)s:%(lineno)d] <%(funcName)s> {rank %(rank)d/%(size)d} %(message)s" # noqa: E501 + date_format = "%(asctime)s" + formatter = logging.Formatter(fmt=date_format + format) + rank0 = logging.getLogger("HyMD.rank_0") + all_ranks = logging.getLogger("HyMD.all_ranks") + +
[docs] @classmethod + def setup(cls, default_level=logging.INFO, log_file=None, verbose=False, comm=MPI.COMM_WORLD): + """Sets up the logger object. + + If a :code:`log_file` path is provided, log event messages are output + to it. Otherwise, the logging messages are emitted to stdout. + + Parameters + ---------- + default_level : int, optional + Default verbosity level of the logger. Unless specified, it is + :code:`10` (:code:`logging.INFO`). + log_file : str, optional + Path to output log file. If `None` or not priovided, no log file is + used and all logging is done to stdout. + verbose : bool, optional + Increases the logging level to :code:`30` (:code:`logging.WARNING`) + if True, otherwise leaves the logging level unchanged. + """ + cls.level = default_level + cls.log_file = log_file + + log_to_stdout = False + if verbose: + log_to_stdout = True + + level = default_level + if not verbose: + level = logging.WARNING + cls.rank0.setLevel(level) + cls.all_ranks.setLevel(level) + + root_filter = MPIFilterRoot(comm) + all_filter = MPIFilterAll(comm) + cls.rank0.addFilter(root_filter) + cls.all_ranks.addFilter(all_filter) + + if (not log_file) and (not log_to_stdout): + return + if log_file: + cls.log_file_handler = logging.FileHandler(log_file) + cls.log_file_handler.setLevel(level) + cls.log_file_handler.setFormatter(cls.formatter) + + cls.rank0.addHandler(cls.log_file_handler) + cls.all_ranks.addHandler(cls.log_file_handler) + if log_to_stdout: + cls.log_to_stdout = True + cls.stdout_handler = logging.StreamHandler() + cls.stdout_handler.setLevel(level) + cls.stdout_handler.setStream(sys.stdout) + cls.stdout_handler.setFormatter(cls.formatter) + cls.stdout_handler.addFilter(MPIFilterStdout()) + + cls.rank0.addHandler(cls.stdout_handler) + cls.all_ranks.addHandler(cls.stdout_handler)
+ + +def format_timedelta(timedelta): + days = timedelta.days + hours, rem = divmod(timedelta.seconds, 3600) + minutes, seconds = divmod(rem, 60) + microseconds = timedelta.microseconds + ret_str = "" + if days != 0: + ret_str += f"{days} days " + ret_str += f"{hours:02d}:{minutes:02d}:{seconds:02d}.{microseconds:06d}" + return ret_str + + +def get_version(): + # Check if we are in a git repo and grab the commit hash and the branch if + # we are, append it to the version number in the output specification. + try: + import git + + try: + repo_dir = os.path.abspath( + os.path.join(os.path.dirname(__file__), os.pardir) + ) + repo = git.Repo(repo_dir) + commit = str(repo.head.commit)[:7] + branch = repo.active_branch + version = f"{__version__} [{branch} branch commit {commit}]" + except git.exc.InvalidGitRepositoryError: + version = f"{__version__}" + except ModuleNotFoundError: + version = f"{__version__}" + + return version + + +def print_header(): + banner = r""" + __ __ ____ __ _______ + / / / /_ __/ / /__ _________ _____ ______ / |/ / __ \ + / /_/ / / / / / / _ \/ ___/ __ `/ __ `/ ___/ / /|_/ / / / / + / __ / /_/ / / / __/ / / /_/ / /_/ (__ ) / / / / /_/ / + /_/ /_/\__, /_/_/\___/_/ \__,_/\__,_/____/ /_/ /_/_____/ + /____/ + """ + + refs_set = """ + + [1] Ledum, M.; Sen, S.; Li, X.; Carrer, M.; Feng Y.; Cascella, M.; Bore, S. L. + HylleraasMD: A Domain Decomposition-Based Hybrid Particle-Field Software for Multi-Scale Simulations of Soft Matter. + J. Chem. Theory Comput. 2023. + + [2] Ledum, M.; Carrer, M.; Sen, S.; Li, X.; Cascella, M.; Bore, S. L. + HyMD: Massively parallel hybrid particle-field molecular dynamics in Python. + J. Open Source Softw. 8(84), 4149, 2023. + + [3] Sen, S.; Ledum, M.; Bore, S. L.; Cascella, M. + Soft Matter under Pressure: Pushing Particle–Field Molecular Dynamics to the Isobaric Ensemble. + J Chem Inf Model 2023, 63(7), 1549-9596. + + [4] Bore, S. L.; Cascella, M. + Hamiltonian and alias-free hybrid particle–field molecular dynamics. + J. Chem. Phys. 2020, 153, 094106. + + [5] Pippig, M. PFFT: An extension of FFTW to massively parallel architectures. + SIAM J. Sci. Comput. 2013, 35, C213–C236. + +""" + + version = f"Version {get_version()}" + header = banner + header += version.center(56) + "\n\n" + #header += " Please read and cite the references below:" + header += " PLEASE READ AND CITE THE REFERENCES BELOW:" + header += refs_set + + return header +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/_modules/hymd/plumed.html b/v2.2.0/_modules/hymd/plumed.html new file mode 100644 index 00000000..95f5e34f --- /dev/null +++ b/v2.2.0/_modules/hymd/plumed.html @@ -0,0 +1,530 @@ + + + + + + hymd.plumed — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.plumed

+"""Class to wrap PLUMED for use within HyMD.
+"""
+
+import numpy as np
+import logging
+import os
+from mpi4py import MPI
+from .logger import Logger
+
+
+
[docs]class PlumedBias: + """PLUMED handler class + + Notes + ----- + This wraps the :code:`Plumed()` class, see + `https://github.com/plumed/plumed2/tree/master/python`. + + The :code:`PlumedBias()` object is created with the arguments from + :code:`__init__` and at everystep the methods :code:`prepare()` and + :code:`calc()` should be called. + + Attributes + ---------- + plumed_obj : plumed.Plumed + Plumed object used to pass and request information from PLUMED. + plumed_forces : (N, D) numpy.ndarray + Array of forces of :code:`N` particles in :code:`D` dimensions. + After :code:`calc()`, this array contains only the forces due + to the PLUMED bias. + positions : (N, D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + Needed because we need C-contiguous array for passing to PLUMED. + plumed_bias : (1,) numpy.ndarray + Used as a pointer to an :code:`double` to store the bias energy. + plumed_version : (1,) numpy.ndarray + Used as a pointer to an :code:`int` to store PLUMED API version. + intracomm : mpi4py.Comm + MPI communicator to use for rank communication within a replica. + intercomm : mpi4py.Comm + MPI communicator to use for rank communication between replicas. + ready : bool + Stores wether the :code:`calc()` method can be called or not. + """ + + plumed_obj = None + plumed_forces = None + positions = None + charges = None + plumed_bias = np.zeros(1, np.double) + plumed_version = np.zeros(1, dtype=np.intc) + intracomm = None + intercomm = None + ready = False + verbose = None + + def __init__(self, config, plumeddat, logfile, intracomm=MPI.COMM_WORLD, intercomm=None, verbose=1): + """Constructor + + Parameters + ---------- + config : Config + Configuration object. + plumeddat : str + Path file containing PLUMED input. + logfile : str + Path to PLUMED's output file + intracomm : mpi4py.Comm, optional + MPI communicator to use for rank communication within a replica. + intercomm : mpi4py.Comm, optional + MPI communicator to use for rank communication between replicas. + verbose : int, optional + Specify the logging event verbosity of this object. + + See also + -------- + hymd.input_parser.Config : Configuration dataclass handler. + """ + try: + import plumed + except ImportError: + err_str = ( + "You are trying to use PLUMED but HyMD could not import py-plumed." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise ImportError(err_str) + + self.intracomm = intracomm + self.intercomm = intercomm + self.verbose = verbose + + try: + kernel_str = "Using PLUMED_KERNEL={}".format(os.environ["PLUMED_KERNEL"]) + except: + kernel_str = "The PLUMED_KERNEL environment variable is not set." + + Logger.rank0.log(logging.INFO, kernel_str) + + try: + self.plumed_obj = plumed.Plumed() + except: + err_str = ( + "HyMD was not able to create a PLUMED object. " + "Maybe there is a problem with your PLUMED_KERNEL?" + ) + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + self.plumed_obj.cmd("getApiVersion", self.plumed_version) + if self.plumed_version[0] <= 3: + err_str = "HyMD requires a PLUMED API > 3. Use a newer PLUMED kernel." + Logger.rank0.log(logging.ERROR, err_str) + raise AssertionError(err_str) + + self.plumed_obj.cmd("setMDEngine", "HyMD") + + if intercomm is not None: + if intracomm.Get_rank() == 0: + self.plumed_obj.cmd("GREX setMPIIntercomm", intercomm) + self.plumed_obj.cmd("GREX setMPIIntracomm", intracomm) + self.plumed_obj.cmd("GREX init") + + self.plumed_obj.cmd("setMPIComm", intracomm) + + Logger.rank0.log( + logging.INFO, f"Attempting to read PLUMED input from {plumeddat}" + ) + + self.plumed_obj.cmd("setPlumedDat", plumeddat) + self.plumed_obj.cmd("setLogFile", logfile) + self.plumed_obj.cmd("setTimestep", config.respa_inner * config.time_step) + self.plumed_obj.cmd("setNatoms", config.n_particles) + self.plumed_obj.cmd("setKbT", config.gas_constant * config.target_temperature) + self.plumed_obj.cmd("setNoVirial") + self.plumed_obj.cmd("init") + + Logger.rank0.log( + logging.INFO, + f"Successfully read PLUMED input. PLUMED output file is {logfile}", + ) + +
[docs] def finalize(self): + """Finalize object""" + self.plumed_obj.finalize()
+ + def __enter__(self): + """Allow usage in 'with' context""" + return self + + def __exit__(self, exc_type, exc_value, traceback): + """Finalize on exit of context""" + self.plumed_obj.__exit__(exc_type, exc_value, traceback) + + @property + def api_version(self): + """Returns the API version got from the PLUMED kernel.""" + return self.plumed_version[0] + +
[docs] def prepare(self, step, forces, positions, indices, config, charges): + """Set the pointers to positions and forces, and returns + wether the potential energy is being requested by PLUMED or not. + """ + if self.verbose > 1: + Logger.rank0.log(logging.INFO, f"Setting PLUMED pointers for step {step}") + self.plumed_forces = forces.ravel(order="C").astype(np.double) + self.charges = charges.astype(np.double) + self.positions = positions.ravel(order="C").astype( + np.double + ) # get C-contiguous array + + needs_energy = np.zeros(1, np.intc) + # plumed_virial = np.zeros((3,3), dtype=np.double) + masses = np.full_like(indices, config.mass, dtype=np.double) + box = np.diag(config.box_size).astype(np.double) + + self.plumed_obj.cmd("setAtomsNlocal", indices.shape[0]) + self.plumed_obj.cmd("setAtomsGatindex", indices) + self.plumed_obj.cmd("setStep", step) + self.plumed_obj.cmd("setForces", self.plumed_forces) + self.plumed_obj.cmd("setPositions", self.positions) + self.plumed_obj.cmd("setCharges", self.charges) + self.plumed_obj.cmd("setMasses", masses) + self.plumed_obj.cmd("setBox", box) + # self.plumed_obj.cmd("setVirial", plumed_virial) + + # check if PLUMED needs energy and returns + self.plumed_obj.cmd("prepareCalc") + self.plumed_obj.cmd("isEnergyNeeded", needs_energy) + + self.ready = True + return True if needs_energy[0] != 0 else False
+ +
[docs] def calc(self, forces, poteng): + """Passes the energy (which can be set to any value in case + :code:`prepare()` returns PLUMED doesn't need it) to get + the forces and energy from the bias. + """ + if not self.ready: + err_str = ( + "Trying to calculate PLUMED biased forces " + "without first calling prepare method." + ) + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + if self.verbose > 1: + Logger.rank0.log(logging.INFO, "Calculating PLUMED forces") + + # set the energy and calc + self.plumed_obj.cmd("setEnergy", poteng) + self.plumed_obj.cmd("performCalc") + self.plumed_obj.cmd("getBias", self.plumed_bias) + + # check if the returned forces are valid + if np.isnan(self.plumed_forces).any(): + err_str = ( + "Forces returned by PLUMED are not valid. " + "It means there's a NaN in the computed forces, " + "and your input should be checked. " + ) + Logger.rank0.log(logging.ERROR, err_str) + raise RuntimeError(err_str) + + # subtract forces to get only the bias' extra force + self.plumed_forces -= forces.ravel(order="C") + + if self.verbose > 1: + Logger.rank0.log(logging.INFO, "Done calculating PLUMED forces") + + self.ready = False + return ( + np.asfortranarray(np.reshape(self.plumed_forces, forces.shape, order="C")), + self.plumed_bias[0], + )
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/_modules/hymd/pressure.html b/v2.2.0/_modules/hymd/pressure.html new file mode 100644 index 00000000..0c6fa2e0 --- /dev/null +++ b/v2.2.0/_modules/hymd/pressure.html @@ -0,0 +1,474 @@ + + + + + + hymd.pressure — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.pressure

+import logging
+import numpy as np
+from mpi4py import MPI
+from .logger import Logger
+import sympy
+from .field import comp_laplacian
+
+
+
[docs]def comp_pressure( + phi, + phi_q, + psi, + hamiltonian, + velocities, + config, + phi_fourier, + phi_laplacian, + phi_transfer, + positions, + bond_pr, + angle_pr, + comm=MPI.COMM_WORLD, +): + """ + Computes total internal pressure of the system. + Kinetic pressure is trivially calculated from the kinetic energy. + Already computed bond and angle pressure terms are inserted into the + total internal pressure. + The field pressure equation is implemented. + + Parameters + ---------- + phi : list[pmesh.pm.RealField], (M,) + Pmesh :code:`RealField` objects containing discretized particle number + density values on the computational grid; one for each particle type + :code:`M`. Pre-allocated, but empty; any values in this field are discarded. + Changed in-place. Local for each MPI rank--the full computaional grid + is represented by the collective fields of all MPI ranks. + hamiltonian : Hamiltonian + Particle-field interaction energy handler object. Defines the + grid-independent filtering function, :math:`H`. + velocities : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + config : Config + Configuration dataclass containing simulation metadata and parameters. + phi_fourier : list[pmesh.pm.ComplexField], (M,) + Pmesh :code:`ComplexField` objects containing discretized particle + number density values in reciprocal space on the computational grid; + one for each particle type. Pre-allocated, but empty; any values in + this field are discarded Changed in-place. Local for each MPI rank--the + full computaional grid is represented by the collective fields of all + MPI ranks. + phi_laplacian : list[pmesh.pm.RealField], (M, 3) + Like phi, but containing the laplacian of particle number densities. + phi_transfer : list[pmesh.pm.ComplexField], (3,) + Like phi_fourier, used as an intermediary to perform FFT operations + to obtain the gradient or laplacian of particle number densities. + positions : (N,D) numpy.ndarray + Array of positions for :code:`N` particles in :code:`D` dimensions. + Local for each MPI rank. + bond_pr : (3,) numpy.ndarray + Total bond pressure due all two-particle bonds. + angle_pr : (3,) numpy.ndarray + Total angle pressure due all three-particle bonds + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + + Returns + ------- + pressure : (18,) numpy.ndarray + Pressure contributions from various energy terms. + 0: due to kinetic energy + 1-5: due to field energy + 6-8: due to two-particle bonded terms + 9-11: due to three-particle bonded terms (called angle terms) + 12-14: due to four-particle bonded terms (called dihedral terms) + (defaults to 0 currently. Yet to be implemented) + 15-17: total pressure in x,y,z directions. + """ + rank = comm.Get_rank() + size = comm.Get_size() + + V = np.prod(config.box_size) + n_mesh__cells = np.prod(np.full(3, config.mesh_size)) + volume_per_cell = V / n_mesh__cells + + w_0 = hamiltonian.w_0(phi) * volume_per_cell + w_elec = 0.0 + if (config.coulombtype == "PIC_Spectral_GPE") or ( + config.coulombtype == "PIC_Spectral" + ): + w_elec = hamiltonian.w_elec([phi_q, psi]) * volume_per_cell + w = w_0 + w_elec + + # Kinetic term + kinetic_energy = 0.5 * config.mass * np.sum(velocities**2) + p_kin = 2 / (3 * V) * kinetic_energy + + # Term 1 + p0 = -1 / V * np.sum(w) + + # Term 2 + if psi is not None: # if using electrostatics + V_bar = np.array([hamiltonian.V_bar[k]([phi, psi]) for k in range(config.n_types)]) + else: + V_bar = np.array([hamiltonian.V_bar_0[k](phi) for k in range(config.n_types)]) + + p1 = np.sum((volume_per_cell / V) * V_bar * phi) + + # Term 3 + comp_laplacian( + phi_fourier, + phi_transfer, + phi_laplacian, + hamiltonian, + config, + ) + + p2 = np.sum( + volume_per_cell + / V + * config.sigma**2 + * np.repeat(V_bar[:, np.newaxis, :, :, :], 3, axis=1) + * phi_laplacian, + axis=(0, 2, 3, 4), + ) + + # Bonded force term: linking 2 particles + p_bond = bond_pr / V + + # Angle force term: linking 3 particles + p_angle = angle_pr / V + + # TODO: Dihedral angle force term: linking 4 atoms + p_dihedral = np.zeros(3) + + # Add formal parameter dihedral_forces as: comp_pressure(..., dihedral_forces) + # Define dictionary: + # forces = { + # 'x': dihedral_forces[:,0], + # 'y': dihedral_forces[:,1], + # 'z': dihedral_forces[:,2] + # } + # Compute the pressure due to dihedrals as: + # p_dihedral = { + # 'x': np.sum( np.multiply(forces['x'],positions[:,0]) )*(1/V), + # 'y': np.sum( np.multiply(forces['y'],positions[:,1]) )*(1/V), + # 'z': np.sum( np.multiply(forces['z'],positions[:,2]) )*(1/V) + # } + + # Total pressure in x, y, z + p_tot = p_kin + p0 + p1 + p2 + p_bond + p_angle + p_dihedral + + return_value = np.array( + [ + p_kin, + p0, + p1, + p2[0], + p2[1], + p2[2], + p_bond[0], + p_bond[1], + p_bond[2], + p_angle[0], + p_angle[1], + p_angle[2], + p_dihedral[0], + p_dihedral[1], + p_dihedral[2], + p_tot[0], + p_tot[1], + p_tot[2], + ] + ) + return_value = comm.allreduce(return_value, MPI.SUM) + + return return_value
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/_modules/hymd/thermostat.html b/v2.2.0/_modules/hymd/thermostat.html new file mode 100644 index 00000000..649dc880 --- /dev/null +++ b/v2.2.0/_modules/hymd/thermostat.html @@ -0,0 +1,514 @@ + + + + + + hymd.thermostat — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +

Source code for hymd.thermostat

+"""Scales or otherwise modifies the particle velocities during simulation to
+simulate coupling to an external heat bath with temperature T₀.
+"""
+import numpy as np
+import logging
+from mpi4py import MPI
+from typing import Callable
+from .logger import Logger
+from .input_parser import Config
+
+
+def cancel_com_momentum(velocities, config, comm=MPI.COMM_WORLD):
+    com_velocity = comm.allreduce(np.sum(velocities[...], axis=0), MPI.SUM)
+    velocities[...] = velocities[...] - com_velocity / config.n_particles
+    return velocities
+
+
+def generate_initial_velocities(velocities, config, prng, comm=MPI.COMM_WORLD):
+    kT_start = config.gas_constant * config.start_temperature
+    n_particles_ = velocities.shape[0]
+    velocities[...] = prng.normal(
+        loc=0, scale=kT_start / config.mass, size=(n_particles_, 3)
+    )
+    velocities = cancel_com_momentum(velocities, config, comm=comm)
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    start_kinetic_energy_target = (
+        1.5 * config.gas_constant * config.n_particles * config.start_temperature
+    )
+    factor = np.sqrt(1.5 * config.n_particles * kT_start / kinetic_energy)
+    velocities[...] = velocities[...] * factor
+    kinetic_energy = comm.allreduce(
+        0.5 * config.mass * np.sum(velocities**2), MPI.SUM
+    )
+    Logger.rank0.log(
+        logging.INFO,
+        (
+            f"Initialized {config.n_particles} velocities, target kinetic "
+            f"energy: {start_kinetic_energy_target}, actual kinetic energy "
+            f"generated: {kinetic_energy}"
+        ),
+    )
+    return velocities
+
+
+
[docs]def _random_gaussian(prng: np.random.Generator) -> float: + """Draw a single random number from the standard normal distribution + Generate a number from the Gaussian distribution centered at zero with unit + standard deviation, :math:`N(0, 1)`. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + + Returns + ------- + float + A random number drawn from :math:`N(0, 1)`. + """ + return prng.normal()
+ + +
[docs]def _random_chi_squared(prng: np.random.Generator, M: int) -> float: + """Draw the sum of :code:`M` squared normally distributed values + + The value is generated by the Gamma distribution, in lieu of generating + :code:`M` Gaussian distributed numbers and summing their squares. + + Parameters + ---------- + prng : np.random.Generator + Numpy object that provides a stream of random bits + M : int + Number of standard normally distributed numbers in the sum. + + Returns + ------- + float + The sum of :code:`M` squared normally distributed values centered at + zero with unit standard deviation. + + Notes + ----- + The sum of the squares of k independent standard normal random variables is + distributed according to a :math:`\\chi^2` distribution. + + .. math:: + + \\chi^2_1 + \\chi_2^2 + \\chi_3^2 + \\dots + \\chi_M^2 + \\sim + \\sigma^2\\chi^2(k) + + This is a special case of the :math:`\\Gamma` distribution, + :math:`\\Gamma(k/2, 2)`, and may be generated by + + .. math:: + + \\chi^2(k) \\sim 2 \\Gamma(k/2, 2) + + References + ---------- + Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of + Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. + J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246. + """ + return prng.chisquare(M)
+ + +
[docs]def csvr_thermostat( + velocity: np.ndarray, + names: np.ndarray, + config: Config, + prng: np.random.Generator, + comm: MPI.Intracomm = MPI.COMM_WORLD, + random_gaussian: Callable[[np.random.Generator], float] = _random_gaussian, + random_chi_squared: Callable[ + [np.random.Generator, int, float], float + ] = _random_chi_squared, + remove_center_of_mass_momentum: bool = True, +) -> np.ndarray: + """Canonical sampling through velocity rescaling thermostat + + Implements the CSVR thermostat. Rescales the system kinetic energy by a + stochastically chosen factor to keep the temperature constant. Requires + communcation of the kinetic energies calculated locally for each MPI rank. + The random numbers sampled through :code:`random_gaussian` and + :code:`random_chi_squared` are broadcast from the root rank to the other + ranks to ensure the scaling is performed with the same stochasticity for + all particles in the full system. + + The velocities are cleaned of center of mass momentum before the thermostat + is applied, and the center of mass momentum is subsequently reapplied. This + is performed for each thermostat coupling group, i.e. the center of mass + momenta of each *group* is separately removed and reapplied after + thermostatting. + + The implementation here is based on the derivation presented in the 2008 + Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper. + + Parameters + ---------- + velocity : (N, D) numpy.ndarray + Array of velocities of N particles in D dimensions. + names : (N,) numpy.ndarray + Array of particle names. + config : Config + Configuration dataclass containing simulation metadata and parameters. + prng : np.random.Generator + Numpy object that provides a stream of random bits + comm : MPI.Intracomm, optional + MPI communicator to use for rank commuication. Defaults to + MPI.COMM_WORLD. + random_gaussian : callable, optional + Function for generating standard normally distributed numbers. + random_chi_squared : callable, optional + Function for generating :math:`\\chi^2`-distributed numbers + remove_center_of_mass_momentum : bool, optional + If True, the center of mass of each coupling group is removed before + the thermostat is applied. The center of mass momenta are added back + after the kinetic energy rescaling is complete. + + See Also + -------- + _random_gaussian : + Used to sample Gaussian-distributed numbers. + _random_chi_squared : + Used to sample :math:`\\chi^2`-distributed numbers. + hymd.input_parser.Config : + Configuration dataclass handler. + + References + ---------- + G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). + G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008). + """ + if not any(config.thermostat_coupling_groups): + config.thermostat_coupling_groups = [config.unique_names.copy()] + for i, group in enumerate(config.thermostat_coupling_groups): + ind = np.where( + np.logical_or.reduce(list(names == np.string_(t) for t in group)) + ) + group_n_particles = comm.allreduce(len(ind[0]), MPI.SUM) + + # Clean velocities of center of mass momentum + if remove_center_of_mass_momentum and group_n_particles > 1: + com_velocity = comm.allreduce(np.sum(velocity[ind], axis=0)) + velocity_clean = velocity[ind] - com_velocity / group_n_particles + K = comm.allreduce(0.5 * config.mass * np.sum(velocity_clean[...] ** 2)) + else: + K = comm.allreduce(0.5 * config.mass * np.sum(velocity[...] ** 2)) + K_target = ( + 1.5 * config.gas_constant * group_n_particles * config.target_temperature + ) + N_f = 3 * group_n_particles + c = np.exp(-(config.time_step * config.respa_inner) / config.tau) + + # Random numbers are identical across ranks because all ranks have + # the same prng after the initialization of the velocities + R = random_gaussian(prng) + SNf = random_chi_squared(prng, N_f - 1) + + alpha2 = ( + c + + (1 - c) * (SNf + R**2) * K_target / (N_f * K) + + 2 * R * np.sqrt(c * (1 - c) * K_target / (N_f * K)) + ) + dK = K * (alpha2 - 1) + alpha = np.sqrt(alpha2) + + if remove_center_of_mass_momentum and group_n_particles > 1: + # Assign velocities and reapply the previously removed center + # of mass momentum removed + velocity_clean *= alpha + velocity[ind] = velocity_clean + com_velocity / group_n_particles + else: + velocity *= alpha + config.thermostat_work += dK
+
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/_modules/index.html b/v2.2.0/_modules/index.html new file mode 100644 index 00000000..dafe4deb --- /dev/null +++ b/v2.2.0/_modules/index.html @@ -0,0 +1,305 @@ + + + + + + Overview: module code — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css b/v2.2.0/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css new file mode 100644 index 00000000..1b057df2 --- /dev/null +++ b/v2.2.0/_panels_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css @@ -0,0 +1 @@ +.badge{border-radius:.25rem;display:inline-block;font-size:75%;font-weight:700;line-height:1;padding:.25em .4em;text-align:center;vertical-align:baseline;white-space:nowrap}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.badge-pill{border-radius:10rem;padding-left:.6em;padding-right:.6em}.badge-primary{background-color:#007bff;color:#fff}.badge-primary[href]:focus,.badge-primary[href]:hover{background-color:#0062cc;color:#fff;text-decoration:none}.badge-secondary{background-color:#6c757d;color:#fff}.badge-secondary[href]:focus,.badge-secondary[href]:hover{background-color:#545b62;color:#fff;text-decoration:none}.badge-success{background-color:#28a745;color:#fff}.badge-success[href]:focus,.badge-success[href]:hover{background-color:#1e7e34;color:#fff;text-decoration:none}.badge-info{background-color:#17a2b8;color:#fff}.badge-info[href]:focus,.badge-info[href]:hover{background-color:#117a8b;color:#fff;text-decoration:none}.badge-warning{background-color:#ffc107;color:#212529}.badge-warning[href]:focus,.badge-warning[href]:hover{background-color:#d39e00;color:#212529;text-decoration:none}.badge-danger{background-color:#dc3545;color:#fff}.badge-danger[href]:focus,.badge-danger[href]:hover{background-color:#bd2130;color:#fff;text-decoration:none}.badge-light{background-color:#f8f9fa;color:#212529}.badge-light[href]:focus,.badge-light[href]:hover{background-color:#dae0e5;color:#212529;text-decoration:none}.badge-dark{background-color:#343a40;color:#fff}.badge-dark[href]:focus,.badge-dark[href]:hover{background-color:#1d2124;color:#fff;text-decoration:none}.border-0{border:0 !important}.border-top-0{border-top:0 !important}.border-right-0{border-right:0 !important}.border-bottom-0{border-bottom:0 !important}.border-left-0{border-left:0 !important}.p-0{padding:0 !important}.pt-0,.py-0{padding-top:0 !important}.pr-0,.px-0{padding-right:0 !important}.pb-0,.py-0{padding-bottom:0 !important}.pl-0,.px-0{padding-left:0 !important}.p-1{padding:.25rem !important}.pt-1,.py-1{padding-top:.25rem !important}.pr-1,.px-1{padding-right:.25rem !important}.pb-1,.py-1{padding-bottom:.25rem !important}.pl-1,.px-1{padding-left:.25rem !important}.p-2{padding:.5rem !important}.pt-2,.py-2{padding-top:.5rem !important}.pr-2,.px-2{padding-right:.5rem !important}.pb-2,.py-2{padding-bottom:.5rem !important}.pl-2,.px-2{padding-left:.5rem !important}.p-3{padding:1rem !important}.pt-3,.py-3{padding-top:1rem !important}.pr-3,.px-3{padding-right:1rem !important}.pb-3,.py-3{padding-bottom:1rem !important}.pl-3,.px-3{padding-left:1rem !important}.p-4{padding:1.5rem !important}.pt-4,.py-4{padding-top:1.5rem !important}.pr-4,.px-4{padding-right:1.5rem !important}.pb-4,.py-4{padding-bottom:1.5rem !important}.pl-4,.px-4{padding-left:1.5rem !important}.p-5{padding:3rem !important}.pt-5,.py-5{padding-top:3rem !important}.pr-5,.px-5{padding-right:3rem !important}.pb-5,.py-5{padding-bottom:3rem !important}.pl-5,.px-5{padding-left:3rem !important}.m-0{margin:0 !important}.mt-0,.my-0{margin-top:0 !important}.mr-0,.mx-0{margin-right:0 !important}.mb-0,.my-0{margin-bottom:0 !important}.ml-0,.mx-0{margin-left:0 !important}.m-1{margin:.25rem !important}.mt-1,.my-1{margin-top:.25rem !important}.mr-1,.mx-1{margin-right:.25rem !important}.mb-1,.my-1{margin-bottom:.25rem !important}.ml-1,.mx-1{margin-left:.25rem !important}.m-2{margin:.5rem !important}.mt-2,.my-2{margin-top:.5rem !important}.mr-2,.mx-2{margin-right:.5rem !important}.mb-2,.my-2{margin-bottom:.5rem !important}.ml-2,.mx-2{margin-left:.5rem !important}.m-3{margin:1rem !important}.mt-3,.my-3{margin-top:1rem !important}.mr-3,.mx-3{margin-right:1rem !important}.mb-3,.my-3{margin-bottom:1rem !important}.ml-3,.mx-3{margin-left:1rem !important}.m-4{margin:1.5rem !important}.mt-4,.my-4{margin-top:1.5rem !important}.mr-4,.mx-4{margin-right:1.5rem !important}.mb-4,.my-4{margin-bottom:1.5rem !important}.ml-4,.mx-4{margin-left:1.5rem !important}.m-5{margin:3rem !important}.mt-5,.my-5{margin-top:3rem !important}.mr-5,.mx-5{margin-right:3rem !important}.mb-5,.my-5{margin-bottom:3rem !important}.ml-5,.mx-5{margin-left:3rem !important}.btn{background-color:transparent;border:1px solid transparent;border-radius:.25rem;color:#212529;cursor:pointer;display:inline-block;font-size:1rem;font-weight:400;line-height:1.5;padding:.375rem .75rem;text-align:center;transition:color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none;vertical-align:middle}.btn:hover{color:#212529;text-decoration:none}.btn:visited{color:#212529}.btn.focus,.btn:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.25);outline:0}.btn.disabled,.btn:disabled{opacity:.65}@media (prefers-reduced-motion: reduce){.btn{transition:none}}a.btn.disabled,fieldset:disabled a.btn{pointer-events:none}.btn-primary{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary:visited{color:#fff}.btn-primary:hover{background-color:#0069d9;border-color:#0062cc;color:#fff}.btn-primary.focus,.btn-primary:focus{background-color:#0069d9;border-color:#0062cc;box-shadow:0 0 0 .2rem rgba(0,123,255,0.5);color:#fff}.btn-primary.disabled,.btn-primary:disabled{background-color:#007bff;border-color:#007bff;color:#fff}.btn-primary.active:not(:disabled):not(.disabled),.btn-primary:not(:disabled):not(.disabled):active,.show>.btn-primary.dropdown-toggle{background-color:#0062cc;border-color:#005cbf;color:#fff}.btn-primary.active:not(:disabled):not(.disabled):focus,.btn-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-secondary{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary:visited{color:#fff}.btn-secondary:hover{background-color:#5a6268;border-color:#545b62;color:#fff}.btn-secondary.focus,.btn-secondary:focus{background-color:#5a6268;border-color:#545b62;box-shadow:0 0 0 .2rem rgba(108,117,125,0.5);color:#fff}.btn-secondary.disabled,.btn-secondary:disabled{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled),.btn-secondary:not(:disabled):not(.disabled):active,.show>.btn-secondary.dropdown-toggle{background-color:#545b62;border-color:#4e555b;color:#fff}.btn-secondary.active:not(:disabled):not(.disabled):focus,.btn-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-success{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success:visited{color:#fff}.btn-success:hover{background-color:#218838;border-color:#1e7e34;color:#fff}.btn-success.focus,.btn-success:focus{background-color:#218838;border-color:#1e7e34;box-shadow:0 0 0 .2rem rgba(40,167,69,0.5);color:#fff}.btn-success.disabled,.btn-success:disabled{background-color:#28a745;border-color:#28a745;color:#fff}.btn-success.active:not(:disabled):not(.disabled),.btn-success:not(:disabled):not(.disabled):active,.show>.btn-success.dropdown-toggle{background-color:#1e7e34;border-color:#1c7430;color:#fff}.btn-success.active:not(:disabled):not(.disabled):focus,.btn-success:not(:disabled):not(.disabled):active:focus,.show>.btn-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-info{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info:visited{color:#fff}.btn-info:hover{background-color:#138496;border-color:#117a8b;color:#fff}.btn-info.focus,.btn-info:focus{background-color:#138496;border-color:#117a8b;box-shadow:0 0 0 .2rem rgba(23,162,184,0.5);color:#fff}.btn-info.disabled,.btn-info:disabled{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-info.active:not(:disabled):not(.disabled),.btn-info:not(:disabled):not(.disabled):active,.show>.btn-info.dropdown-toggle{background-color:#117a8b;border-color:#10707f;color:#fff}.btn-info.active:not(:disabled):not(.disabled):focus,.btn-info:not(:disabled):not(.disabled):active:focus,.show>.btn-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-warning{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning:visited{color:#212529}.btn-warning:hover{background-color:#e0a800;border-color:#d39e00;color:#212529}.btn-warning.focus,.btn-warning:focus{background-color:#e0a800;border-color:#d39e00;box-shadow:0 0 0 .2rem rgba(255,193,7,0.5);color:#212529}.btn-warning.disabled,.btn-warning:disabled{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-warning.active:not(:disabled):not(.disabled),.btn-warning:not(:disabled):not(.disabled):active,.show>.btn-warning.dropdown-toggle{background-color:#d39e00;border-color:#c69500;color:#212529}.btn-warning.active:not(:disabled):not(.disabled):focus,.btn-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-danger{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger:visited{color:#fff}.btn-danger:hover{background-color:#c82333;border-color:#bd2130;color:#fff}.btn-danger.focus,.btn-danger:focus{background-color:#c82333;border-color:#bd2130;box-shadow:0 0 0 .2rem rgba(220,53,69,0.5);color:#fff}.btn-danger.disabled,.btn-danger:disabled{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-danger.active:not(:disabled):not(.disabled),.btn-danger:not(:disabled):not(.disabled):active,.show>.btn-danger.dropdown-toggle{background-color:#bd2130;border-color:#b21f2d;color:#fff}.btn-danger.active:not(:disabled):not(.disabled):focus,.btn-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-light{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light:visited{color:#212529}.btn-light:hover{background-color:#e2e6ea;border-color:#dae0e5;color:#212529}.btn-light.focus,.btn-light:focus{background-color:#e2e6ea;border-color:#dae0e5;box-shadow:0 0 0 .2rem rgba(248,249,250,0.5);color:#212529}.btn-light.disabled,.btn-light:disabled{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-light.active:not(:disabled):not(.disabled),.btn-light:not(:disabled):not(.disabled):active,.show>.btn-light.dropdown-toggle{background-color:#dae0e5;border-color:#d3d9df;color:#212529}.btn-light.active:not(:disabled):not(.disabled):focus,.btn-light:not(:disabled):not(.disabled):active:focus,.show>.btn-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-dark{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark:visited{color:#fff}.btn-dark:hover{background-color:#23272b;border-color:#1d2124;color:#fff}.btn-dark.focus,.btn-dark:focus{background-color:#23272b;border-color:#1d2124;box-shadow:0 0 0 .2rem rgba(52,58,64,0.5);color:#fff}.btn-dark.disabled,.btn-dark:disabled{background-color:#343a40;border-color:#343a40;color:#fff}.btn-dark.active:not(:disabled):not(.disabled),.btn-dark:not(:disabled):not(.disabled):active,.show>.btn-dark.dropdown-toggle{background-color:#1d2124;border-color:#171a1d;color:#fff}.btn-dark.active:not(:disabled):not(.disabled):focus,.btn-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-primary{border-color:#007bff;color:#007bff}.btn-outline-primary:visited{color:#007bff}.btn-outline-primary:hover{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.focus,.btn-outline-primary:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-primary.disabled,.btn-outline-primary:disabled{background-color:transparent;color:#007bff}.btn-outline-primary.active:not(:disabled):not(.disabled),.btn-outline-primary:not(:disabled):not(.disabled):active,.show>.btn-outline-primary.dropdown-toggle{background-color:#007bff;border-color:#007bff;color:#fff}.btn-outline-primary.active:not(:disabled):not(.disabled):focus,.btn-outline-primary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-primary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(0,123,255,0.5)}.btn-outline-secondary{border-color:#6c757d;color:#6c757d}.btn-outline-secondary:visited{color:#6c757d}.btn-outline-secondary:hover{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.focus,.btn-outline-secondary:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-secondary.disabled,.btn-outline-secondary:disabled{background-color:transparent;color:#6c757d}.btn-outline-secondary.active:not(:disabled):not(.disabled),.btn-outline-secondary:not(:disabled):not(.disabled):active,.show>.btn-outline-secondary.dropdown-toggle{background-color:#6c757d;border-color:#6c757d;color:#fff}.btn-outline-secondary.active:not(:disabled):not(.disabled):focus,.btn-outline-secondary:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-secondary.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(108,117,125,0.5)}.btn-outline-success{border-color:#28a745;color:#28a745}.btn-outline-success:visited{color:#28a745}.btn-outline-success:hover{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.focus,.btn-outline-success:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-success.disabled,.btn-outline-success:disabled{background-color:transparent;color:#28a745}.btn-outline-success.active:not(:disabled):not(.disabled),.btn-outline-success:not(:disabled):not(.disabled):active,.show>.btn-outline-success.dropdown-toggle{background-color:#28a745;border-color:#28a745;color:#fff}.btn-outline-success.active:not(:disabled):not(.disabled):focus,.btn-outline-success:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-success.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(40,167,69,0.5)}.btn-outline-info{border-color:#17a2b8;color:#17a2b8}.btn-outline-info:visited{color:#17a2b8}.btn-outline-info:hover{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.focus,.btn-outline-info:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-info.disabled,.btn-outline-info:disabled{background-color:transparent;color:#17a2b8}.btn-outline-info.active:not(:disabled):not(.disabled),.btn-outline-info:not(:disabled):not(.disabled):active,.show>.btn-outline-info.dropdown-toggle{background-color:#17a2b8;border-color:#17a2b8;color:#fff}.btn-outline-info.active:not(:disabled):not(.disabled):focus,.btn-outline-info:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-info.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(23,162,184,0.5)}.btn-outline-warning{border-color:#ffc107;color:#ffc107}.btn-outline-warning:visited{color:#ffc107}.btn-outline-warning:hover{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.focus,.btn-outline-warning:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-warning.disabled,.btn-outline-warning:disabled{background-color:transparent;color:#ffc107}.btn-outline-warning.active:not(:disabled):not(.disabled),.btn-outline-warning:not(:disabled):not(.disabled):active,.show>.btn-outline-warning.dropdown-toggle{background-color:#ffc107;border-color:#ffc107;color:#212529}.btn-outline-warning.active:not(:disabled):not(.disabled):focus,.btn-outline-warning:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-warning.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(255,193,7,0.5)}.btn-outline-danger{border-color:#dc3545;color:#dc3545}.btn-outline-danger:visited{color:#dc3545}.btn-outline-danger:hover{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.focus,.btn-outline-danger:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-danger.disabled,.btn-outline-danger:disabled{background-color:transparent;color:#dc3545}.btn-outline-danger.active:not(:disabled):not(.disabled),.btn-outline-danger:not(:disabled):not(.disabled):active,.show>.btn-outline-danger.dropdown-toggle{background-color:#dc3545;border-color:#dc3545;color:#fff}.btn-outline-danger.active:not(:disabled):not(.disabled):focus,.btn-outline-danger:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-danger.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(220,53,69,0.5)}.btn-outline-light{border-color:#f8f9fa;color:#f8f9fa}.btn-outline-light:visited{color:#f8f9fa}.btn-outline-light:hover{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.focus,.btn-outline-light:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-light.disabled,.btn-outline-light:disabled{background-color:transparent;color:#f8f9fa}.btn-outline-light.active:not(:disabled):not(.disabled),.btn-outline-light:not(:disabled):not(.disabled):active,.show>.btn-outline-light.dropdown-toggle{background-color:#f8f9fa;border-color:#f8f9fa;color:#212529}.btn-outline-light.active:not(:disabled):not(.disabled):focus,.btn-outline-light:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-light.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(248,249,250,0.5)}.btn-outline-dark{border-color:#343a40;color:#343a40}.btn-outline-dark:visited{color:#343a40}.btn-outline-dark:hover{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.focus,.btn-outline-dark:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-outline-dark.disabled,.btn-outline-dark:disabled{background-color:transparent;color:#343a40}.btn-outline-dark.active:not(:disabled):not(.disabled),.btn-outline-dark:not(:disabled):not(.disabled):active,.show>.btn-outline-dark.dropdown-toggle{background-color:#343a40;border-color:#343a40;color:#fff}.btn-outline-dark.active:not(:disabled):not(.disabled):focus,.btn-outline-dark:not(:disabled):not(.disabled):active:focus,.show>.btn-outline-dark.dropdown-toggle:focus{box-shadow:0 0 0 .2rem rgba(52,58,64,0.5)}.btn-link{color:#007bff;font-weight:400;text-decoration:none}.btn-link:hover{color:#0056b3;text-decoration:underline}.btn-link.focus,.btn-link:focus{box-shadow:none;text-decoration:underline}.btn-link.disabled,.btn-link:disabled{color:#6c757d;pointer-events:none}.btn-group-lg>.btn,.btn-lg{border-radius:.3rem;font-size:1.25rem;line-height:1.5;padding:.5rem 1rem}.btn-group-sm>.btn,.btn-sm{border-radius:.2rem;font-size:.875rem;line-height:1.5;padding:.25rem .5rem}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:.5rem}input.btn-block[type=button],input.btn-block[type=reset],input.btn-block[type=submit]{width:100%}.stretched-link::after{background-color:rgba(0,0,0,0);bottom:0;content:'';left:0;pointer-events:auto;position:absolute;right:0;top:0;z-index:1}.text-wrap{white-space:normal !important}.card{background-clip:border-box;background-color:#fff;border:1px solid rgba(0,0,0,0.125);border-radius:.25rem;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;min-width:0;position:relative;word-wrap:break-word}.card>hr{margin-left:0;margin-right:0}.card>.list-group:first-child .list-group-item:first-child{border-top-left-radius:.25rem;border-top-right-radius:.25rem}.card>.list-group:last-child .list-group-item:last-child{border-bottom-left-radius:.25rem;border-bottom-right-radius:.25rem}.card-body{-ms-flex:1 1 auto;flex:1 1 auto;min-height:1px;padding:1.25rem}.card-title{margin-bottom:.75rem}.card-subtitle{margin-bottom:0;margin-top:-.375rem}.card-text:last-child{margin-bottom:0}.card-link:hover{text-decoration:none}.card-link+.card-link{margin-left:1.25rem}.card-header{background-color:rgba(0,0,0,0.03);border-bottom:1px solid rgba(0,0,0,0.125);margin-bottom:0;padding:.75rem 1.25rem}.card-header:first-child{border-radius:calc(.25rem - 1px) calc(.25rem - 1px) 0 0}.card-header+.list-group .list-group-item:first-child{border-top:0}.card-footer{background-color:rgba(0,0,0,0.03);border-top:1px solid rgba(0,0,0,0.125);padding:.75rem 1.25rem}.card-footer:last-child{border-radius:0 0 calc(.25rem - 1px) calc(.25rem - 1px)}.card-header-tabs{border-bottom:0;margin-bottom:-.75rem;margin-left:-.625rem;margin-right:-.625rem}.card-header-pills{margin-left:-.625rem;margin-right:-.625rem}.card-img-overlay{bottom:0;left:0;padding:1.25rem;position:absolute;right:0;top:0}.card-img,.card-img-bottom,.card-img-top{-ms-flex-negative:0;flex-shrink:0;width:100%}.card-img,.card-img-top{border-top-left-radius:calc(.25rem - 1px);border-top-right-radius:calc(.25rem - 1px)}.card-img,.card-img-bottom{border-bottom-left-radius:calc(.25rem - 1px);border-bottom-right-radius:calc(.25rem - 1px)}.w-100{width:100% !important}.shadow{box-shadow:0 0.5rem 1rem rgba(0,0,0,0.15) !important}.bg-primary{background-color:#007bff !important}button.bg-primary:focus,button.bg-primary:hover{background-color:#0062cc !important}a.bg-primary:focus,a.bg-primary:hover{background-color:#0062cc !important}a.text-primary:focus,a.text-primary:hover{color:#121416 !important}.bg-secondary{background-color:#6c757d !important}button.bg-secondary:focus,button.bg-secondary:hover{background-color:#545b62 !important}a.bg-secondary:focus,a.bg-secondary:hover{background-color:#545b62 !important}a.text-secondary:focus,a.text-secondary:hover{color:#121416 !important}.bg-success{background-color:#28a745 !important}button.bg-success:focus,button.bg-success:hover{background-color:#1e7e34 !important}a.bg-success:focus,a.bg-success:hover{background-color:#1e7e34 !important}a.text-success:focus,a.text-success:hover{color:#121416 !important}.bg-info{background-color:#17a2b8 !important}button.bg-info:focus,button.bg-info:hover{background-color:#117a8b !important}a.bg-info:focus,a.bg-info:hover{background-color:#117a8b !important}a.text-info:focus,a.text-info:hover{color:#121416 !important}.bg-warning{background-color:#ffc107 !important}button.bg-warning:focus,button.bg-warning:hover{background-color:#d39e00 !important}a.bg-warning:focus,a.bg-warning:hover{background-color:#d39e00 !important}a.text-warning:focus,a.text-warning:hover{color:#121416 !important}.bg-danger{background-color:#dc3545 !important}button.bg-danger:focus,button.bg-danger:hover{background-color:#bd2130 !important}a.bg-danger:focus,a.bg-danger:hover{background-color:#bd2130 !important}a.text-danger:focus,a.text-danger:hover{color:#121416 !important}.bg-light{background-color:#f8f9fa !important}button.bg-light:focus,button.bg-light:hover{background-color:#dae0e5 !important}a.bg-light:focus,a.bg-light:hover{background-color:#dae0e5 !important}a.text-light:focus,a.text-light:hover{color:#121416 !important}.bg-dark{background-color:#343a40 !important}button.bg-dark:focus,button.bg-dark:hover{background-color:#1d2124 !important}a.bg-dark:focus,a.bg-dark:hover{background-color:#1d2124 !important}a.text-dark:focus,a.text-dark:hover{color:#121416 !important}.bg-white{background-color:#fff !important}button.bg-white:focus,button.bg-white:hover{background-color:#e6e6e6 !important}a.bg-white:focus,a.bg-white:hover{background-color:#e6e6e6 !important}a.text-white:focus,a.text-white:hover{color:#121416 !important}.text-primary{color:#007bff !important}.text-secondary{color:#6c757d !important}.text-success{color:#28a745 !important}.text-info{color:#17a2b8 !important}.text-warning{color:#ffc107 !important}.text-danger{color:#dc3545 !important}.text-light{color:#f8f9fa !important}.text-dark{color:#343a40 !important}.text-white{color:#fff !important}.text-body{color:#212529 !important}.text-muted{color:#6c757d !important}.text-black-50{color:rgba(0,0,0,0.5) !important}.text-white-50{color:rgba(255,255,255,0.5) !important}.bg-transparent{background-color:transparent !important}.text-justify{text-align:justify !important}.text-left{text-align:left !important}.text-right{text-align:right !important}.text-center{text-align:center !important}.font-weight-light{font-weight:300 !important}.font-weight-lighter{font-weight:lighter !important}.font-weight-normal{font-weight:400 !important}.font-weight-bold{font-weight:700 !important}.font-weight-bolder{font-weight:bolder !important}.font-italic{font-style:italic !important}.container{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container{max-width:540px}}@media (min-width: 768px){.container{max-width:720px}}@media (min-width: 992px){.container{max-width:960px}}@media (min-width: 1200px){.container{max-width:1140px}}.container-fluid,.container-lg,.container-md,.container-sm,.container-xl{margin-left:auto;margin-right:auto;padding-left:15px;padding-right:15px;width:100%}@media (min-width: 576px){.container,.container-sm{max-width:540px}}@media (min-width: 768px){.container,.container-md,.container-sm{max-width:720px}}@media (min-width: 992px){.container,.container-lg,.container-md,.container-sm{max-width:960px}}@media (min-width: 1200px){.container,.container-lg,.container-md,.container-sm,.container-xl{max-width:1140px}}.row{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-left:-15px;margin-right:-15px}.col-lg,.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-auto,.col-md,.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-auto,.col-sm,.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-auto,.col-xl,.col-xl-1,.col-xl-10,.col-xl-11,.col-xl-12,.col-xl-2,.col-xl-3,.col-xl-4,.col-xl-5,.col-xl-6,.col-xl-7,.col-xl-8,.col-xl-9,.col-xl-auto{padding-left:15px;padding-right:15px;position:relative;width:100%}@media (min-width: 576px){.col-sm{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-sm-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-sm-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-sm-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-sm-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-sm-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-sm-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-sm-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-sm-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-sm-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-sm-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-sm-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-sm-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-sm-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 768px){.col-md{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-md-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-md-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-md-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-md-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-md-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-md-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-md-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-md-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-md-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-md-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-md-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-md-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-md-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 992px){.col-lg{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-lg-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-lg-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-lg-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-lg-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-lg-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-lg-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-lg-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-lg-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-lg-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-lg-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-lg-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-lg-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-lg-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}@media (min-width: 1200px){.col-xl{flex-basis:0;flex-grow:1;-ms-flex-positive:1;-ms-flex-preferred-size:0;max-width:100%}.col-xl-auto{-ms-flex:0 0 auto;flex:0 0 auto;max-width:100%;width:auto}.col-xl-1{-ms-flex:0 0 8.33333%;flex:0 0 8.33333%;max-width:8.33333%}.col-xl-2{-ms-flex:0 0 16.66667%;flex:0 0 16.66667%;max-width:16.66667%}.col-xl-3{-ms-flex:0 0 25%;flex:0 0 25%;max-width:25%}.col-xl-4{-ms-flex:0 0 33.33333%;flex:0 0 33.33333%;max-width:33.33333%}.col-xl-5{-ms-flex:0 0 41.66667%;flex:0 0 41.66667%;max-width:41.66667%}.col-xl-6{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%}.col-xl-7{-ms-flex:0 0 58.33333%;flex:0 0 58.33333%;max-width:58.33333%}.col-xl-8{-ms-flex:0 0 66.66667%;flex:0 0 66.66667%;max-width:66.66667%}.col-xl-9{-ms-flex:0 0 75%;flex:0 0 75%;max-width:75%}.col-xl-10{-ms-flex:0 0 83.33333%;flex:0 0 83.33333%;max-width:83.33333%}.col-xl-11{-ms-flex:0 0 91.66667%;flex:0 0 91.66667%;max-width:91.66667%}.col-xl-12{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%}}.d-flex{display:-ms-flexbox !important;display:flex !important}.sphinx-bs,.sphinx-bs *{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.sphinx-bs p{margin-top:0} diff --git a/v2.2.0/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css b/v2.2.0/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css new file mode 100644 index 00000000..fc14abc8 --- /dev/null +++ b/v2.2.0/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css @@ -0,0 +1 @@ +details.dropdown .summary-title{padding-right:3em !important;-moz-user-select:none;-ms-user-select:none;-webkit-user-select:none;user-select:none}details.dropdown:hover{cursor:pointer}details.dropdown .summary-content{cursor:default}details.dropdown summary{list-style:none;padding:1em}details.dropdown summary .octicon.no-title{vertical-align:middle}details.dropdown[open] summary .octicon.no-title{visibility:hidden}details.dropdown summary::-webkit-details-marker{display:none}details.dropdown summary:focus{outline:none}details.dropdown summary:hover .summary-up svg,details.dropdown summary:hover .summary-down svg{opacity:1}details.dropdown .summary-up svg,details.dropdown .summary-down svg{display:block;opacity:.6}details.dropdown .summary-up,details.dropdown .summary-down{pointer-events:none;position:absolute;right:1em;top:.75em}details.dropdown[open] .summary-down{visibility:hidden}details.dropdown:not([open]) .summary-up{visibility:hidden}details.dropdown.fade-in[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out;animation:panels-fade-in .5s ease-in-out}details.dropdown.fade-in-slide-down[open] summary~*{-moz-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;-webkit-animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out;animation:panels-fade-in .5s ease-in-out, panels-slide-down .5s ease-in-out}@keyframes panels-fade-in{0%{opacity:0}100%{opacity:1}}@keyframes panels-slide-down{0%{transform:translate(0, -10px)}100%{transform:translate(0, 0)}}.octicon{display:inline-block;fill:currentColor;vertical-align:text-top}.tabbed-content{box-shadow:0 -.0625rem var(--tabs-color-overline),0 .0625rem var(--tabs-color-underline);display:none;order:99;padding-bottom:.75rem;padding-top:.75rem;width:100%}.tabbed-content>:first-child{margin-top:0 !important}.tabbed-content>:last-child{margin-bottom:0 !important}.tabbed-content>.tabbed-set{margin:0}.tabbed-set{border-radius:.125rem;display:flex;flex-wrap:wrap;margin:1em 0;position:relative}.tabbed-set>input{opacity:0;position:absolute}.tabbed-set>input:checked+label{border-color:var(--tabs-color-label-active);color:var(--tabs-color-label-active)}.tabbed-set>input:checked+label+.tabbed-content{display:block}.tabbed-set>input:focus+label{outline-style:auto}.tabbed-set>input:not(.focus-visible)+label{outline:none;-webkit-tap-highlight-color:transparent}.tabbed-set>label{border-bottom:.125rem solid transparent;color:var(--tabs-color-label-inactive);cursor:pointer;font-size:var(--tabs-size-label);font-weight:700;padding:1em 1.25em .5em;transition:color 250ms;width:auto;z-index:1}html .tabbed-set>label:hover{color:var(--tabs-color-label-active)} diff --git a/v2.2.0/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css b/v2.2.0/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css new file mode 100644 index 00000000..adc61662 --- /dev/null +++ b/v2.2.0/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css @@ -0,0 +1,7 @@ +:root { +--tabs-color-label-active: hsla(231, 99%, 66%, 1); +--tabs-color-label-inactive: rgba(178, 206, 245, 0.62); +--tabs-color-overline: rgb(207, 236, 238); +--tabs-color-underline: rgb(207, 236, 238); +--tabs-size-label: 1rem; +} \ No newline at end of file diff --git a/v2.2.0/_sources/doc_pages/api.rst.txt b/v2.2.0/_sources/doc_pages/api.rst.txt new file mode 100644 index 00000000..6761cfc0 --- /dev/null +++ b/v2.2.0/_sources/doc_pages/api.rst.txt @@ -0,0 +1,122 @@ +.. _api-label: + + +API reference +============= + +Integrator +---------- + +.. automodule:: hymd.integrator + :members: + + +Thermostat +---------- + +.. automodule:: hymd.thermostat + :members: csvr_thermostat, _random_chi_squared, _random_gaussian + :undoc-members: + + +Barostat +-------- + +Berendsen Barostat +^^^^^^^^^^^^^^^^^^ + +.. automodule:: hymd.barostat + :members: isotropic, semiisotropic + :undoc-members: + +SCR Barostat +^^^^^^^^^^^^^^^^^^ + +.. automodule:: hymd.barostat_bussi + :members: isotropic, semiisotropic + :undoc-members: + + +Hamiltonian +----------- + +.. autoclass:: hymd.hamiltonian.Hamiltonian + :members: + + .. automethod:: __init__ + + .. automethod:: _setup + +.. autoclass:: hymd.hamiltonian.SquaredPhi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultNoChi + :members: + + .. automethod:: __init__ + + +.. autoclass:: hymd.hamiltonian.DefaultWithChi + :members: + + .. automethod:: __init__ + + +Force +----- + +.. automodule:: hymd.force + :members: + :undoc-members: + + +Pressure +-------- + +.. automodule:: hymd.pressure + :members: comp_pressure + :undoc-members: + + +Logger +------ + +.. autoclass:: hymd.logger.Logger + :members: + +.. autoclass:: hymd.logger.MPIFilterRoot + :members: + +.. autoclass:: hymd.logger.MPIFilterAll + :members: + + +Input parser +------------ + +.. automodule:: hymd.input_parser + :members: + :undoc-members: propensity_potential_coeffs + + +Field +----- + +.. automodule:: hymd.field + :members: + + +File input/output +----------------- + +.. automodule:: hymd.file_io + :members: + +PLUMED +------ + +.. automodule:: hymd.plumed + :members: diff --git a/v2.2.0/_sources/doc_pages/benchmarks.rst.txt b/v2.2.0/_sources/doc_pages/benchmarks.rst.txt new file mode 100644 index 00000000..06377a85 --- /dev/null +++ b/v2.2.0/_sources/doc_pages/benchmarks.rst.txt @@ -0,0 +1,93 @@ +.. _benchmarks-label: + +Benchmarks +########## +Homopolymer melt test systems of :math:`30^2`, :math:`40^2`, and :math:`50^2` +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively. + +Bonded forces +^^^^^^^^^^^^^ +Legend label denotes the number of particles in the system. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + nodes_small = np.array([1, 2, 5, 8, 12, 15, 17, 18], dtype=np.float64) + time_small = np.array([ + 4.187099, 2.403876, 1.604452, 1.104753, 1.102880, 1.102931, 1.091972, + 1.090594 + ], dtype=np.float64) + nodes_medium = np.array([ + 1, 3, 4, 7, 13, 14, 16, 25, 30, 31, 35, 40, 42, 46, 47, 50 + ], dtype=np.float64,) + time_medium = np.array([ + 11.201839, 5.281660, 3.693661, 2.317845, 1.566609, 1.425823, 1.437634, + 0.962915, 0.955779, 0.958936, 0.966228, 0.973874, 0.974221, 0.976087, + 0.982746, 0.950908, + ], dtype=np.float64) + nodes_large = np.array([ + 1, 2, 3, 4, 5, 7, 12, 13, 16, 25, 26, 30, 37, 49, 55, 71, 80 + ], dtype=np.float64) + time_large = np.array([ + 20.77469, 12.257692, 9.430474, 6.560756, 5.340657, 3.760844, 3.655468, + 2.623202, 2.315075, 1.668369, 1.497107, 1.533885, 1.414385, 1.417828, + 1.404457, 1.411190, 1.435383, + ], dtype=np.float64) + plt.plot( + nodes_small * 128, 1e6 * time_small / 10000.0, "r-o", label="224 k" + ) + plt.plot( + nodes_medium * 128, 1e6 * time_medium / 10000.0, "b-x", label="533 k" + ) + plt.plot( + nodes_large * 128, 1e6 * time_large / 10000.0, "k-^", label="1.04 M" + ) + plt.xlabel("CPUs", fontsize=15) + plt.ylabel("Time per step, us", fontsize=15) + plt.legend(fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.show() + + +Particle--field forces +^^^^^^^^^^^^^^^^^^^^^^ +Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method. + +.. plot:: + + import numpy as np + import matplotlib.pyplot as plt + + mesh_2048_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4 , ] + mesh_2048_time = [3.375108, 5.977880, 10.414429, 16.859782, 31.692761, 50.496983, 51.508302, 76.465812, 114.956267, 200.790592, ] + + mesh_1024_cpus = [2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_1024_time = [0.439009, 0.662988, 1.172991, 2.024713, 3.625324, 7.148897, 7.330420, 9.117424, 13.209331, 22.204145, 41.150021, 71.836402, ] + + mesh_512_cpus = [1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1 , ] + mesh_512_time = [0.137271, 0.148182, 0.161536, 0.271535, 0.798458, 0.817093, 1.114978, 1.712410, 2.870377, 5.151649, 8.589524, ] + + mesh_256_cpus = [256, 128, 64, 32, 16, 8, 4, 2, 1] + mesh_256_time = [0.033834, 0.037837, 0.053191, 0.070217, 0.115923, 0.200090, 0.336702, 0.665111, 1.127391] + + mesh_128_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_128_time = [0.012815, 0.018430, 0.022436, 0.037648, 0.055399, 0.093687, 0.169120, ] + + mesh_64_cpus = [64, 32, 16, 8, 4, 2, 1, ] + mesh_64_time = [0.012815, 0.018162, 0.018430, 0.037648, 0.037949, 0.055399, 0.093687, ] + + plt.loglog(mesh_2048_cpus, mesh_2048_time, "r-x", label="2048³") + plt.loglog(mesh_1024_cpus, mesh_1024_time, "b-o", label="1024³") + plt.loglog(mesh_512_cpus, mesh_512_time, "k-^", label="512³") + plt.loglog(mesh_256_cpus, mesh_256_time, "c-v", label="256³") + plt.loglog(mesh_128_cpus, mesh_128_time, "y-8", label="128³") + plt.loglog(mesh_64_cpus, mesh_64_time, "g->", label="64³") + plt.xlabel("CPUs", fontsize=15) + plt.xscale('log', base=2) + plt.yscale('log', base=2) + plt.ylabel("Time per step, s", fontsize=15) + plt.legend(loc="upper left", fontsize=15) + plt.show() diff --git a/v2.2.0/_sources/doc_pages/command_line.rst.txt b/v2.2.0/_sources/doc_pages/command_line.rst.txt new file mode 100644 index 00000000..f0fb00bd --- /dev/null +++ b/v2.2.0/_sources/doc_pages/command_line.rst.txt @@ -0,0 +1,130 @@ +.. _commandline-label: + +Command line arguments +###################### +Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle--field interactions. + + +Required arguments +================== +:configuration file: + :code:`type` positional + + Specifies the :code:`.toml` format configuration file containing simulation details. See :ref:`config-label` for details. + +:structure and topology file: + :code:`type` positional + + Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See :ref:`topology-label` for details. + +Optional arguments +================== +:code:`-v --verbose` + :code:`type` optional + + Number of following arguments: :code:`0` or :code:`1` + + Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying :code:`-v` or :code:`--verbose` with no additional specification. This increases verbosity level by :code:`1`. Alternatively, it maye be specified by :code:`--verbose V` with :code:`V` being :code:`0`, :code:`1`, or :code:`2`. + +:code:`--profile` + :code:`type` optional + + Number of following arguments: :code:`0` + + Enables code profiling using :code:`cProfile`. This will output one profiling file per MPI rank invoked in the simulation. + +:code:`--double-precision` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision internally in HyMD (including in the FFTs). + +:code:`--double-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify usage of double precision in the output trajectory from HyMD. + +:code:`--velocity-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that velocities should be output to the HyMD trajectory. + +:code:`--force-output` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that forces should be output to the HyMD trajectory. + +:code:`--disable-mpio` + :code:`type` optional + + Number of following arguments: :code:`0` + + Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult. + +:code:`--logfile` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the path of a plain text log file in which stdout is mirrored during simulation runs. + +:code:`--seed` + :code:`type` optional + + Number of following arguments: :code:`1` + + Specifies the random seed used in the :code:`numpy` random library to generate velocities, thermostatting, etc. + +:code:`--disable-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any two-particle bonds present in the system. + +:code:`--disable-angle-bonds` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any three-particle bonds present in the system. + +:code:`--disable-dihedrals` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any four-particle bonds present in the system. + +:code:`--disable-dipole` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any topological reconstruction of peptide backbone dipoles present in the system. + +:code:`--disable-field` + :code:`type` optional + + Number of following arguments: :code:`0` + + Disable any particle--field interactions present in the system. + +:code:`--plumed` + :code:`type` optional + + Input file for PLUMED when using the PLUMED interface. See :ref:`interfaces-label` for details. + +:code:`--plumed-outfile + :code:`type` optional + + Name of PLUMED output file when running a simulation using PLUMED. diff --git a/v2.2.0/_sources/doc_pages/config_file.rst.txt b/v2.2.0/_sources/doc_pages/config_file.rst.txt new file mode 100644 index 00000000..2ee880b7 --- /dev/null +++ b/v2.2.0/_sources/doc_pages/config_file.rst.txt @@ -0,0 +1,244 @@ +.. _config-label: + +Configuration file +################## +The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order. + +The configuration file is a `toml`_ format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs. + +.. _`toml`: + https://github.com/toml-lang/toml + +.. role:: required + +Configuration file keywords +--------------------------- + +The following constitutes every possible keyword specification in HyMD +configuration files: + +Metadata keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying metadata for the H5MD output trajectory. + +:name: + :code:`string` [**optional**, default: :code:`None`] + + Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file. + + +:tags: + :code:`array` [:code:`string`] [**optional**, default: :code:`None`] + + Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file. + + +Particle keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying properties of particles and molecules in the +system. + +:n_particles: + :code:`integer` [**optional**, default: :code:`None`] + + Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules. + +:mass: + :code:`float` [**optional**, default: :code:`72.0`] {units: :math:`\text{u}=\text{g}\,\text{mol}^{-1}`} + + Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal. + +:max_molecule_size: + :code:`integer` [**optional**, default: :code:`201`] + + Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code **will** crash if there are molecules larger than :code:`max_molecule_size` in the topology/structure input file. + + +Simulation keywords +^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying simulation parameters. + +:n_steps: + :code:`integer` [:required:`required`] + + Total number of integration steps to perform for this simulation. + +:n_print: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of *number of time steps*). + +:n_flush: + :code:`integer` [**optional**, default: :code:`None`] + + Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of *number of* :code:`n_print`, i.e. :code:`n_print = 13`, :code:`n_flush = 3` would result in the trajectory/energy being written to disk every :code:`13 x 3 = 39` *simulation steps*) + +:time_step: + :code:`float` [:required:`required`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time step per integration step. If the rRESPA multiple time step integrator is used (:code:`integrator = "respa"`), this specifies the **inner** time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is :code:`respa_inner` times the :code:`time_step` , and the total simulation time is :code:`n_steps` times :code:`time_step` times :code:`respa_inner` . + +:box_size: + :code:`array` [:code:`float`] [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable. + +:integrator: + :code:`string` [:required:`required`] (options: :code:`velocity-verlet` or :code:`respa`) + + Specifies the time integrator used in the simulation. If :code:`respa`, the *reversible reference system propagator algorithm (rRESPA)* :cite:`tuckerman1992reversible` integrator is used, with :code:`respa_inner` number of inner (intramolecular force) time steps. If :code:`velocity-verlet`, a normal Velocity Verlet integrator is used. If :code:`respa` and :code:`respa_inner = 1`, the rRESPA integrator is equivalent to the Velocity Verlet. + +:respa_inner: + :code:`integer` [**optional**, default: :code:`1`] + + The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces. + +:domain_decomposition: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + Specifies the interval (in time steps) of *domain decomposition exchange*, involving all MPI ranks sending and receiving particles according to the particles' positions in the integration box and the MPI ranks' assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If :code:`True`, the decomposition is performed once (before starting the simulation). If :code:`False`, no decomposition is performed. + +:cancel_com_momentum: + :code:`integer` or :code:`boolean` [**optional**, default: :code:`False`] + + If :code:`True`, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every :code:`remove_com_momentum` time steps. If :code:`False`, the linear momentum is never removed. + +:start_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at :code:`start_temperature` Kelvin prior to starting the simulation. If :code:`False`, the velocities are not changed before starting the simulation. + +:target_temperature: + :code:`float` or :code:`boolean` [**optional**, default: :code:`False`] {units: :math:`\text{K}`} + + Couple the system to a heat bath at :code:`target_temperature` Kelvin by applying a *Canonical sampling through velocity rescaling* :cite:`Bussi2007JCP` thermostat with coupling strength :code:`tau`. If :code:`False`, no temperature control is applied. + +:tau: + :code:`float` [**optional**, default: :code:`0.7`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the CSVR thermostat coupling. In the limit of :code:`tau → ∞`, the Hamiltonian dynamics are preserved and no temperature coupling takes place. + +:thermostat_coupling_groups: + :code:`array` [:code:`array` [:code:`string`]] [**optional**, default: :code:`[]`] + + Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing :code:`"A"`, :code:`"B"`, and :code:`"C"` type particles, :code:`thermostat_coupling_groups = [["A", "B"], ["C"],]` would thermalise types :code:`"A"` and :code:`"B"` together and couple :code:`"C"` type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. :code:`target_temperature` Kelvin). +:hamiltonian: + :code:`string` [**optional**, default: :code:`"DefaultNohChi"`] (options: :code:`SquaredPhi`, :code:`DefaultNohChi`, or :code:`DefaultWithChi`) + + Specifies the interaction energy functional :math:`W[\tilde\phi]` for use with the particle-field interactions. See :ref:`functionals-label` for details. + + +Field keywords +^^^^^^^^^^^^^^ +Configuration keywords specifying field parameters. + +:mesh_size: + :code:`array` [:code:`integer`] or :code:`integer` [:required:`required`] + + Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is :code:`box_size / mesh_size`. + +:kappa: + :code:`float` [:required:`required`] {units: :math:`\text{kJ}^{-1}\text{mol}`} + + Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional :math:`W[\tilde\phi]`. See :ref:`functionals-label` for more details. + +:sigma: + :code:`float` [:required:`required`] {units: :math:`\text{nm}=10^{-9}~\text{m}`} + + Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See :ref:`filtering-label` for more details. + +:chi: + :code:`array` [:code:`array` [:code:`string`, :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}`} + + Array of :math:`\tilde\chi_\text{AB}`-parameters indicating the strength of the repulsive or attractive interaction between particles of type :code:`"A"` and the number density due to particles of type :code:`"B"`, and vice versa. Example: :code:`chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ]` would specify a repulsive :code:`"A"`--:code:`"B"` type interaction, and a weakly attractive :code:`"C"`--:code:`"D"` interaction. Self-interaction :math:`\tilde\chi`-terms are always zero. See :ref:`functionals-label` for more details. + + +Bond keywords +^^^^^^^^^^^^^ +Configuration keywords specifying bonds and bonds parameters. + +:bonds: + :code:`array` [:code:`array` [2 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`\text{nm}=10^{-9}~\text{m}` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: :code:`bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ]` indicates a :code:`"A"`--:code:`"A"` bond of equilibrium length :code:`0.47` :math:`\text{nm}` with a bond strength of :code:`980.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding bond between :code:`"A"` and :code:`"B"` type particles with equilibrium length :code:`0.31` :math:`\text{nm}` and a strength of :code:`1250.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify stretching bonds. + +:angle_bonds: + :code:`array` [:code:`array` [3 :code:`string`, 2 :code:`float`]] [**optional**, default: :code:`[]`] {units: :math:`{}^\circ` and :math:`\text{kJ}\,\text{mol}^{-1}`} + + Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: :code:`bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ]` indicates a :code:`"A"`--:code:`"A"`--:code:`"A"` angular bond that tries to keep the bond linear at :code:`180` degrees with a bending strength of :code:`55.0` :math:`\text{kJ}\,\text{mol}^{-1}` and a corresponding angle bond between :code:`"A"`--:code:`"B"`--:code:`"B"` prefering the angle at :code:`120` degrees and a strength of :code:`25.0` :math:`\text{kJ}\,\text{mol}^{-1}`. See :ref:`bonds-label` for details about how to specify angular bonds. + +:dihedrals: + :code:`array` [:code:`array` [4 :code:`string`, :code:`integer`, :code:`COSINE SERIES` ]] [**optional**, default: :code:`[]`] {units: :math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`} + + Specifies four-particle torsional potentials by cosine series. See :ref:`bonds-label` for details about how to specify dihedrals. + + + +Electrostatic keywords +^^^^^^^^^^^^^^^^^^^^^^ +Configuration keywords specifying electrostatics and electrostatic parameters. + +:coulombtype: + :code:`string` [**optional**, default: :code:`None`] (options: :code:`PIC_Spectral`) + + Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the :code:`dielectric_const` keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, *not* in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to `PIC_Spectral`. + +:dielectric_const: + :code:`float` [**optional**, default: :code:`None`] + + Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified---even if electrostatics are not included with the :code:`coulombtype` keyword. + +Pressure keywords +^^^^^^^^^^^^^^^^^ +Configuration keywords specifying pressure and barostat parameters. + +Simulation keywords +========================================= + +:pressure: + :code:`boolean` [**optional**, default: :code:`False`] + + Specifies whether or not to calculate total internal pressure vector. + +:barostat: + :code:`string` [**optional**, default: :code:`None`](options: :code:`isotropic` or :code:`semiisotropic`) + + Specifies whether to apply pressure constraints equally in all 3 Cartesian directions (`isotropic`) or equally in xy and different in z (`semiisotropic`). + +:barostat_type: + :code:`string` [**optional**, default: :code:`berendsen`](options: :code:`berendsen` or :code:`scr`) + + Specifies the type of barostat to use. :code:`berendsen` is more suitable for equilibration and :code:`scr` for equilibrium data collection. + +:n_b: + :code:`integer` [**optional**, default: :code:`1`] + + Frequency of barostat call in number of outer rRESPA steps. + +:tau_p: + :code:`float` [**optional**, default: :code:`10 tau` if :code:`tau < 0.1` else :code:`1.0`] {units: :math:`\text{ps}=10^{-12}~\text{s}`} + + The time scale of the barostat coupling. + +:target_pressure: + :code:`array` [:code:`float`] [**optional**, default: :code:1] {units: `bar`} + + Couples the system to an external pressure set to `target_pressure`. + +Field keywords +========================================= + +:rho0: + :code:`float` [**optional**, default: :code:average density] {units: :math:`\text{nm}^{-3}`} + + Intrinsic parameter corresponding to the specific volume of a coarse-grained particle. Typically: `8.66` + +:a: + :code:`float` [:required:`required`] {units: :math:`\text{nm}^{-3}`} + + Calibrated parameter to obtain the correct average density at the target temperature and pressure. Typically: `9.21` diff --git a/v2.2.0/_sources/doc_pages/constants_and_units.rst.txt b/v2.2.0/_sources/doc_pages/constants_and_units.rst.txt new file mode 100644 index 00000000..ee429829 --- /dev/null +++ b/v2.2.0/_sources/doc_pages/constants_and_units.rst.txt @@ -0,0 +1,80 @@ +.. _units-label: + +Constants and Units +################### + +HyMD uses the following units and constants internally and in all input and +output: + +.. list-table:: **Units** + :widths: 30 10 75 + :header-rows: 1 + + * - Quantity + - Symbol + - Unit + * - length + - :math:`r` + - :math:`\text{nm}=10^{-9}~\text{m}` + * - time + - :math:`t` + - :math:`\text{ps}=10^{-12}~\text{s}` + * - charge + - :math:`q` + - :math:`e=1.602176634 \cdot 10^{-19}~\text{C}` + * - mass + - :math:`m` + - :math:`\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}` + * - temperature + - :math:`\text{T}` + - :math:`\text{K}` + * - energy + - :math:`E` + - :math:`\text{kJ}\,\text{mol}^{-1}` + * - velocity + - :math:`v` + - :math:`\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}` + * - momentum + - :math:`P` + - :math:`\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}` + * - force + - :math:`\mathbf{F}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}` + * - pressure + - :math:`p` + - :math:`\text{bar}=100~\text{kPa}` + * - electric potential + - :math:`\Psi` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}` + * - electric field + - :math:`\mathbf{E}` + - :math:`\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}` + * - compressibility + - :math:`\kappa` + - :math:`\text{mol}\,\text{kJ}^{-1}` + * - field-interaction + - :math:`\tilde\chi` + - :math:`\text{kJ}\,\text{mol}^{-1}` + +.. list-table:: **Constants** + :widths: 30 10 75 + :header-rows: 1 + + * - Constant + - Symbol + - Value + * - gas constant + - :math:`R` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Boltzmann’s constant + - :math:`k_\text{B}` + - :math:`8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}` + * - Avogadro's constant + - :math:`N_\text{A}` + - :math:`6.02214076 \cdot 10^23~\text{mol}^{-1}` + * - Vacuum permittivity + - :math:`\varepsilon_0` + - :math:`8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2` + * - Coulomb constant + - :math:`k_\text{e}` + - :math:`138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}` diff --git a/v2.2.0/_sources/doc_pages/electrostatics.rst.txt b/v2.2.0/_sources/doc_pages/electrostatics.rst.txt new file mode 100644 index 00000000..7e11c09d --- /dev/null +++ b/v2.2.0/_sources/doc_pages/electrostatics.rst.txt @@ -0,0 +1,48 @@ +.. _electrostatics-label: + +Electrostatic interactions +########################## +In the filtered Hamiltonian hPF formalism :cite:`bore2020hamiltonian` the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle--mesh Ewald. + +The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered + +.. math:: + + \tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i), + +with :math:`q_i` being the charge of particle :math:`i` and :math:`H` is the +filtering function (see :ref:`filtering-label`). The value of the charge grid at +vertex :math:`(i,j,k)` is found by + +.. math:: + + \tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)] + +and the electrostatic potential :math:`\Psi_{ijk}` + +.. math:: + + \Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right], + +where :math:`k_\text{e}` is the Coulomb constant :math:`1/4\pi\varepsilon_0`. +The *electric field* is obtained by differentiation of the electrostatic +potential in Fourier space, + +.. math:: + + \mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)] + +from which the forces are interpolated back to the particle positions. + +Specifying electrostatics +^^^^^^^^^^^^^^^^^^^^^^^^^ +In HyMD, electrostatics are specified by the :code:`coulombtype` and +:code:`dielectric_const` keywords in the configuration file (see +:ref:`config-label`) and the :code:`/charge` dataset in the HDF5 format +structure/topology input file (see :ref:`topology-label`). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions. diff --git a/v2.2.0/_sources/doc_pages/examples.rst.txt b/v2.2.0/_sources/doc_pages/examples.rst.txt new file mode 100644 index 00000000..9f9c3655 --- /dev/null +++ b/v2.2.0/_sources/doc_pages/examples.rst.txt @@ -0,0 +1,621 @@ +.. _examples-label: + +Examples +######## +The following examples are ordered in *more or less* order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the `HyMD-tutorial`_ github repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Ideal gas +========= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true + :align: right + :width: 200 + +The simplest possible system is one with no interactions at all---intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like: + + +.. code-block:: toml + :caption: **ideal_gas.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = false # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + +A simple input structure/topology file :code:`ideal_gas.HDF5` is available in +the `HyMD-tutorial/ideal_gas`_ github repository (along with the code to +generate it). Run the (very) short simulation by + +.. code:: bash + + python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field \ + --velocity-output \ + --force-output + +with the :code:`--disable-field` argument to completely turn off all +particle--field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook `ideal_gas.ipynb`_ for details. + + +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas +.. _ideal_gas.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.ipynb + + +Ideal chains +============ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true + :align: right + :width: 200 + +The simplest available interaction is the harmonic two-particle bond (see +:ref:`bonds-label`), + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2. + +Extending the configuration file from the ideal gas case, we need to add a +:code:`bonds` specification. Note that the :code:`[bonds]` meta specifier is not +necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **ideal_chain.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + +A simple input structure/topology file :code:`ideal_chain.HDF5` with a few +coiled up ideal chain polymers is available in the +`HyMD-tutorial/ideal_chain`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field + +we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +`ideal_chain.ipynb`_. + + +.. _HyMD-tutorial/ideal_chain: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_chain +.. _ideal_chain.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/ideal_chain.ipynb + + +Stiff rods +========== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true + :align: right + :width: 200 + +Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the :code:`i--j--k` angle :math:`\theta` (see +:ref:`bonds-label`), + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2. + +Extending the configuration file from the ideal chain case, we need to add a +:code:`angle_bonds` specification. Note that the :code:`[bonds]` meta specifier +is not necessary, but may be used to help organise the input file. + +.. code-block:: toml + :caption: **rods.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.5, 1000.0], # (i name, j name, equilibrium length, strength) + ] + + angle_bonds = [ + ["A", "A", "A", 180.0, 100.0], # (i, j, k, equilibrium angle, strength) + ] + + +A simple input structure/topology file :code:`rods.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook `rods.ipynb`_. + + +.. _HyMD-tutorial/rods: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/rods +.. _rods.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.ipynb + + + +Helixes +======= +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true + :align: right + :width: 200 + +Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle :math:`\phi` between the +:code:`i--j--k` plane and the :code:`j--k--l` plane (see :ref:`bonds-label`), + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n). + +The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a :code:`dihedrals` keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the :code:`dielectric_const` +keyword even though we are not including electrostatic forces in the current +simulation. Note that the :code:`[bonds]` meta specifier is not necessary, but +may be used to help organise the input file. + +.. code-block:: toml + :caption: **helixes.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 200 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [30.0, 30.0, 30.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultnochi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + dielectric_const = 15.0 + + [field] + mesh_size = [1, 1, 1] # FFT grid size + sigma = 1.0 # filtering length scale in nm + + [bonds] + bonds = [ + ["A", "A", 0.31, 10000.0], # (i name, j name, equilibrium length, strength) + ] + + dihedrals = [ + [ + ["A", "A", "A", "A"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0] + ], + ] + +A simple input structure/topology file :code:`helixes.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/rods`_ github +repository (along with the code to generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd rods.toml rods.HDF5 --disable-field + +the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook `helixes.ipynb`_. + + +.. _HyMD-tutorial/helixes: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/helixes +.. _helixes.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.ipynb + + +Phase separation +================ +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true + :align: right + :width: 200 + +The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types :code:`A` and :code:`B`. Using the Hamiltonian + +.. math:: + + \mathcal{H}=H_0+W + +with :math:`\tilde\chi`--dependent interactions defined by (specified in the +configuration file by :code:`hamiltonian = DefaultWithChi`): + +.. math:: + + W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2. + + +.. code-block:: toml + :caption: **phase_separation.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 10000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + start_temperature = 300 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + + [field] + mesh_size = [20, 20, 20] # FFT grid size + sigma = 1.0 # filtering length scale in nm + kappa = 0.05 # compressibility in mol/kJ + chi = [ + ['A', 'B', 5.0], # (name i, name j, strength) + ] + +A simple input structure/topology file :code:`phase_separation.HDF5` containing +an equal number of :code:`A` type and :code:`B` type particles is available in +the `HyMD-tutorial/phase_separation`_ github repository (along with the code to +generate it). Running the simulation with + +.. code:: bash + + python3 -m hymd phase_separation.toml phase_separation.HDF5 + +we may examine the resulting trajectory. In the case of a low interaction +strength :math:`\tilde\chi` of :code:`5.0` (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to :code:`40.0` (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +`phase_separation.ipynb`_. + + +.. _HyMD-tutorial/phase_separation: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/phase_separation +.. _phase_separation.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/phase_separation.ipynb + + +Diblock copolymers +================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true + :align: right + :width: 200 + +Having introduced particle--field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive :math:`\tilde\chi`--interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the :code:`integrator = "respa"` keyword. Putting the pieces together, the +configuration file may look like the following: + +.. code-block:: toml + :caption: **copolymer.toml** + + [simulation] + integrator = "respa" + respa_inner = 15 + n_steps = 2000 # total simulation steps + n_print = 2000 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [10.0, 10.0, 10.0] # simulation box size in nm + start_temperature = 50 # generate starting temperature in Kelvin + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "defaultwithchi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [50, 50, 50] # FFT grid size + sigma = 0.5 # filtering length scale in nm + chi = [ + ["A", "B", 30.0], # (i, j, strength) + ] + + [bonds] + bonds = [ + ["A", "A", 0.25, 1500.0], # (i, j, equilibrium length, strength) + ["A", "B", 0.25, 1500.0], + ["B", "B", 0.25, 1500.0], + ] + angle_bonds = [ + ["A", "A", "A", 180.0, 25.0], # (i, j, k, equilibrium angle, strength) + ["B", "B", "B", 180.0, 25.0], + ] + +A simple input structure/topology file :code:`copolymer.HDF5` with a few +coiled up polymer chains is available in the `HyMD-tutorial/copolymer`_ github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten :code:`A` followed by ten :code:`B` type particles. +Running the simulation with + +.. code:: bash + + python3 -m hymd copolymer.toml copolymer.HDF5 + +the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +`copolymer.ipynb`_. + + +.. _HyMD-tutorial/copolymer: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/copolymer +.. _copolymer.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer.ipynb + + +Lipid bilayer self-assembly +=========================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true + :align: right + :width: 300 + +Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field--particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the :code:`thermostat_coupling_groups` keyword. With parameters +optimised in :cite:`ledum2020automated`, the configuration file looks like: + + +.. code-block:: toml + :caption: **lipid_self_assembly.toml** + + [simulation] + integrator = "respa" + respa_inner = 25 + n_steps = 3000 + n_print = 200 + n_flush = 1 + time_step = 0.01 + box_size = [9.96924, 9.96924, 10.03970] + start_temperature = 323 + target_temperature = 323 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.05 + domain_decomposition = 10001 + cancel_com_momentum = true + max_molecule_size = 15 + thermostat_coupling_groups = [ + ["N", "P", "G", "C"], + ["W"], + ] + + [field] + mesh_size = [25, 25, 25] + sigma = 1.0 + chi = [ + ["C", "W", 42.24], + ["G", "C", 10.47], + ["N", "W", -3.77], + ["G", "W", 4.53], + ["N", "P", -9.34], + ["P", "G", 8.04], + ["N", "G", 1.97], + ["P", "C", 14.72], + ["P", "W", -1.51], + ["N", "C", 13.56], + ] + + [bonds] + bonds = [ + ["N", "P", 0.47, 1250.0], + ["P", "G", 0.47, 1250.0], + ["G", "G", 0.37, 1250.0], + ["G", "C", 0.47, 1250.0], + ["C", "C", 0.47, 1250.0], + ] + angle_bonds = [ + ["P", "G", "G", 120.0, 25.0], + ["P", "G", "C", 180.0, 25.0], + ["G", "C", "C", 180.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +A randomly mixed input structure/topology file +:code:`lipid_self_assembly.HDF5` with a few hundred lipids in a roughy +:code:`10 x 10 x 10nm` box is available in the +`HyMD-tutorial/lipid_self_assembly`_ github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation + +.. code:: bash + + python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5 + +we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook `lipid_self_assembly.ipynb`_. + + +.. _HyMD-tutorial/lipid_self_assembly: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/lipid_self_assembly +.. _lipid_self_assembly.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/lipid_self_assembly.ipynb + + +Peptide in lipid bilayer +======================== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true + :align: right + :width: 300 + +Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer. + + +The `configuration file`_ is available in the `HyMD-tutorial/peptide`_ github +repository (omitted here for brevity). + +A pre-equilibrated input structure/topology file :code:`peptide.HDF5` with a +few hundred lipids in a roughy :code:`20 x 20 x 20nm` box is available in the +`HyMD-tutorial/peptide`_ github repository. Running the simulation + +.. code:: bash + + python3 -m hymd peptide.toml peptide.HDF5 + +we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook `peptide.ipynb`_. + + +.. _HyMD-tutorial/peptide: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/peptide +.. _configuration file: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.toml +.. _peptide.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.ipynb + + +SDS +=== +.. image:: https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true + :align: right + :width: 300 + +The last part we introduce is explicit electrostatic interactions through +particle--mesh Ewald. Enabling the electrostatic calculations is done via the +:code:`coulombtype` keyword. :code:`"PIC_Spectral"` is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the :code:`dielectric_const` keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge. + + + +.. code-block:: toml + :caption: **sds.toml** + + [simulation] + integrator = "respa" + respa_inner = 10 + n_steps = 3000 + n_print = 1500 + n_flush = + time_step = 0.01 + box_size = [8.3, 8.3, 8.3] + start_temperature = 298 + target_temperature = 298 + tau = 0.1 + hamiltonian = "defaultwithchi" + kappa = 0.1 + domain_decomposition = 10000 + cancel_com_momentum = true + max_molecule_size = 5 + thermostat_coupling_groups = [ + ["S", "C"], + ["W", "Na"], + ] + dielectric_const = 45.0 # dielectric constant for the simulation medium + coulombtype = "PIC_Spectral" # particle in cloud, spectral method + + [field] + mesh_size = [64, 64, 64] + sigma = 0.5 + chi = [ + ["S", "C", 13.50], + ["S", "Na", 0.00], + ["S", "W", -3.60], + ["C", "Na", 13.50], + ["C", "W", 33.75], + ["W", "Na", 0.00], + ] + + [bonds] + bonds = [ + ["S", "C", 0.50, 1250.0], + ["C", "C", 0.50, 1250.0], + ] + angle_bonds = [ + ["S", "C", "C", 170.0, 25.0], + ["C", "C", "C", 180.0, 25.0], + ] + + +An input structure/topology file :code:`sds.HDF5` with a couple thousand +randomly dispersed SDS chains is available in the `HyMD-tutorial/sds`_ github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a :code:`/charge` dataset. +Running the simulation with + +.. code:: bash + + python3 -m hymd sds.toml sds.HDF5 + +we observe the aggregation of the SDS into micellular structures---first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook `sds.ipynb`_. + + +.. _HyMD-tutorial/sds: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/sds +.. _sds.ipynb: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/sds.ipynb diff --git a/v2.2.0/_sources/doc_pages/filtering.rst.txt b/v2.2.0/_sources/doc_pages/filtering.rst.txt new file mode 100644 index 00000000..02af68c6 --- /dev/null +++ b/v2.2.0/_sources/doc_pages/filtering.rst.txt @@ -0,0 +1,30 @@ +.. _filtering-label: + +Filtering +######### +The default grid-independent filter function used in HyMD is a Gaussian + +.. math:: + + H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] + +with reciprocal space representation + +.. math:: + + \hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +The coarse-graining parameter :math:`\sigma` determines a length scale of +particle extent and is given as configuration file input by + +.. code:: toml + + sigma = 0.75 + + +Implementing new filters +^^^^^^^^^^^^^^^^^^^^^^^^ +Implementing new filter functions is straightforward by hijacking +the :code:`setup` method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional. diff --git a/v2.2.0/_sources/doc_pages/installation.rst.txt b/v2.2.0/_sources/doc_pages/installation.rst.txt new file mode 100644 index 00000000..2f6e3659 --- /dev/null +++ b/v2.2.0/_sources/doc_pages/installation.rst.txt @@ -0,0 +1,318 @@ +.. _installation-label: + +Installation +############ + +Dependencies +============ + +**Installing non-Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-openmpi-dev # Install MPI-enabled HDF5 + sudo apt-get install -y pkg-config # Install pkg-config, required for h5py install + sudo apt-get install -y curl wget + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + sudo dnf update -y + sudo dnf install -y python3.9 python3-devel # Install python3 and pip + sudo dnf install -y openmpi-devel # Install MPI development headers + sudo dnf install -y hdf5-openmpi-devel # Install MPI-enabled HDF5 + sudo dnf install -y curl wget + + + The automatic download and building of PFFT has some issues, so we + manually build FFTW and PFFT before calling :code:`pip3 install pfft-python`. + + .. code-block:: bash + + sudo dnf install -y git + sudo dnf install -y libtool + sudo dnf install -y fftw-openmpi-devel fftw-openmpi-libs + export PATH=$PATH:/usr/lib64/openmpi/bin/ # Ensure MPICC is in path + git clone https://github.com/mpip/pfft.git + cd pfft/ + ./bootstrap.sh + ./configure + make + make install + + + .. group-tab:: Mac OSX (brew) + + .. code-block:: bash + + brew update + brew install python # Install python3 and pip + brew install open-mpi # Install MPI development headers + brew install hdf5-mpi # Install MPI-enabled HDF5 + brew install pkg-config # Install pkg-config, required for h5py install + brew install curl wget + +.. warning:: + There might be memory leaks when using HyMD with OpenMPI 4.1.1. + Therefore, using a newer version of OpenMPI is recommended. + See `Issue #186 `_ for more details. + + +**Installing Python dependencies** may be done by + +.. tabs:: + + .. group-tab:: Ubuntu (apt) + + .. code-block:: bash + + python3 -m pip install --upgrade pip + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + python3 -m pip install "pmesh @ git+https://github.com/rainwoodman/pmesh" + + + .. group-tab:: Fedora (dnf) + + .. code-block:: bash + + python3.9 -m ensurepip --upgrade + PATH=$PATH:/usr/lib64/openmpi/bin/:/usr/lib64/openmpi/lib/ + python3.9 -m pip install mpi4py numpy cython + export HDF5_DIR="/usr/lib64/openmpi/" + CC="mpicc" HDF5_MPI="ON" python3.9 -m pip install --no-binary=h5py h5py + python3.9 -m pip install "pmesh @ git+https://github.com/rainwoodman/pmesh" + + .. group-tab:: Mac OSX (brew) + + Find the location of the installed :code:`hdf5-mpi` package by + + .. code-block:: bash + + find /usr -iname "*hdf5.h" + + or + + .. code-block:: bash + + brew info hdf5-mpi + + and extract the path, which will look like for example + :code:`/usr/local/Cellar/hdf5-mpi/1.13.0/`. Export it as :code:`HDF5_DIR` + + .. code-block:: bash + + python3 -m ensurepip --upgrade + export HDF5_DIR="/usr/local/Cellar/hdf5-mpi/1.13.0/" + CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py + python3 -m pip install mpi4py numpy cython + python3 -m pip install "pmesh @ git+https://github.com/rainwoodman/pmesh" + + +.. warning:: + + If MPI-enabled HDF5 and :code:`h5py` can not be installed, limited support + for serial HDF5 is available. Note that having MPI-enabled file IO is + **highly recommended**, and simulation performance under serial HDF5 will + potentially be very low. + + Example dependency install on Ubuntu (apt) using serial HDF5: + + .. code-block:: bash + + sudo apt-get update -y + sudo apt-get install -y python3 python3-pip # Install python3 and pip + sudo apt-get install -y libopenmpi-dev # Install MPI development headers + sudo apt-get install -y libhdf5-serial-dev # Install serial HDF5 + sudo apt-get install -y curl wget + + python3 -m pip install h5py mpi4py numpy cython + + Running parallel simulations without a + MPI-enabled HDF5 library available necessitates the use of the + :code:`--disable-mpio` argument to HyMD, see :ref:`commandline-label`. Note that + due to the way HyMD is built, a working MPI compiler is required even if all + intended simulations are serial. + + +Installing HyMD +=============== +HyMD may be installed using :code:`pip` by + +.. code-block:: bash + + python3 -m pip install hymd + + + +Install in docker +================= +A docker image with build essentials setup is available at `dockerhub`_ with tag +:code:`mortele/hymd`, + +.. code-block:: bash + + docker pull mortele/hymd:latest + docker run -it mortele/hymd + /app$ python3 -m pip install hymd + + # Grab example input files + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml + /app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5 + + # Run simulation + /app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose + +.. _dockerhub: + https://hub.docker.com/repository/docker/mortele/hymd + + +Run interactively in Google Colaboratory +======================================== +A `Google Colaboratory`_ jupyter notebook is setup `here`_ with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Common issues +============= + +Numpy errors while importing the Fortran force kernels +------------------------------------------------------ + +.. code-block:: python + + RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd + + Traceback (most recent call last): + + (...) + + File "/..../HyMD/hymd/__init__.py", line 2, in + from .main import main # noqa: F401 + File "/..../HyMD/hymd/main.py", line 10, in + from .configure_runtime import configure_runtime + File "/..../hymd/configure_runtime.py", line 12, in + from .input_parser import read_config_toml, parse_config_toml + File "/..../HyMD/hymd/input_parser.py", line 12, in + from .force import Bond, Angle, Dihedral, Chi + File "/..../HyMD/hymd/force.py", line 8, in + from force_kernels import ( # noqa: F401 + ImportError: numpy.core.multiarray failed to import + +can normally be fixed by updating numpy versions, + +.. code-block:: bash + + python3 -m pip install -U numpy + + +Error building pfft-python due to missing curl/wget +--------------------------------------------------- + +.. code-block:: python + + Building wheel for pfft-python (setup.py) ... error + ERROR: Command errored out with exit status 1: + command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_ + cwd: /tmp/pip-install-fr6nt9m4/pfft-python/ + Complete output (56 lines): + running bdist_wheel + running build + running build_py + + (...) + + curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found + wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + /tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found + Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz + Please check curl or wget + You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ + Traceback (most recent call last): + File "", line 1, in + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in + setup( + File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup + return distutils.core.setup(**attrs) + File "/usr/lib/python3.8/distutils/core.py", line 148, in setup + + (...) + + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions + build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:])) + File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft + raise ValueError("could not build fftw; check MPICC?") + ValueError: could not build fftw; check MPICC? + ---------------------------------------- + ERROR: Failed building wheel for pfft-python + Running setup.py clean for pfft-python + Failed to build pfft-python + +can be fixed by installing either `curl`_ or `wget`_ + +.. code-block:: bash + + apt-get install -y curl wget + + +.. _`curl`: + https://curl.se/ + +.. _`wget`: + https://www.gnu.org/software/wget/ + + +Error running parallel HyMD without MPI-enabled h5py +---------------------------------------------------- + +.. code-block:: python + + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + Traceback (most recent call last): + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + return _run_code(code, main_globals, None, + File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + exec(code, run_globals) + File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in + main() + File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main + with h5py.File(args.input, "r", **_kwargs) as in_file: + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__ + with h5py.File(args.input, "r", **_kwargs) as in_file: + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0, + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + set_fapl(plist, **kwds) + File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio + raise ValueError("h5py was built without MPI support, can't use mpio driver") + ValueError: h5py was built without MPI support, can't use mpio driver + +Can be fixed by installing a MPI-enabled :code:`h5py` through + +.. code-block:: bash + + python3 -m pip uninstall -y h5py + HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py diff --git a/v2.2.0/_sources/doc_pages/interaction_energy_functionals.rst.txt b/v2.2.0/_sources/doc_pages/interaction_energy_functionals.rst.txt new file mode 100644 index 00000000..f33c004e --- /dev/null +++ b/v2.2.0/_sources/doc_pages/interaction_energy_functionals.rst.txt @@ -0,0 +1,98 @@ +.. _functionals-label: + +Interaction energy functionals +############################## +A few interaction energy functionals :math:`W` are defined in HyMD through +the :code:`Hamiltonian` class and associated subclasses. + +:math:`\chi`--interaction and :math:`\kappa`--incompressibility +=============================================================== +The most common hPF energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultWithChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where :math:`\tilde\chi_{\text{A}-\text{B}}` is the interaction energy between +overlapping densities of particle types :math:`\text{A}` and :math:`\text{B}`. +The incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\tilde\chi` +and :math:`\kappa` in the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + chi = [ + ["A", "B", 15.85], + ["B", "C", -5.70], + ... + ] + +Only :math:`\kappa`--incompressibility +====================================== +The only :math:`\kappa` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "DefaultNoChi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2, + +where the incompressibility term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Only :math:`\phi^2` +=================== +The :math:`\phi^2` interactions energy functional is specified by + +.. code:: toml + + hamiltonian = "SquaredPhi" + +in the configuration file (see :ref:`config-label`). It takes the form + +.. math:: + + W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2, + +where the :math:`\phi` squared term is governed by the compressibility parameter +:math:`\kappa`. The average density of the full system is denoted +:math:`\phi_0`. + +Using this energy functional necessitates specification of :math:`\kappa` in +the configuration file (see :ref:`config-label`) + +.. code-block:: toml + + kappa = 0.05 + + +Implementing new interaction energy forms +========================================= +Implementing new interaction energy functions is straightforward by subclassing +:code:`Hamiltonian` and applying :code:`sympy` differentiation to the symbolic +field objects. The :code:`sympy.lamdify` function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields. diff --git a/v2.2.0/_sources/doc_pages/interfaces.rst.txt b/v2.2.0/_sources/doc_pages/interfaces.rst.txt new file mode 100644 index 00000000..07cceece --- /dev/null +++ b/v2.2.0/_sources/doc_pages/interfaces.rst.txt @@ -0,0 +1,23 @@ +.. _interfaces-label: + +PLUMED interface +################ + +HyMD is interfaced with `PLUMED ` for simulations using enhanced sampling or free-energy methods. +To use the interface, the Python package of PLUMED must be installed, and the user must provide a working :code:`PLUMED_KERNEL` by setting this environment variable to the kernel path. +In the current version, only simulations using a single replica are supported. + +.. warning:: + PLUMED versions prior to :code:`2.8.1` did not have a working Python interface with MPI. Therefore, you **must** use PLUMED :code:`2.8.1` or greater when installing the PLUMED library in Python. Older versions for the kernel are supported if the Python interface was correctly installed with version :code:`2.8.1`. + +Running simulations using PLUMED +================================ + +To run your simulations using PLUMED you must first set the environment variable :code:`PLUMED_KERNEL` and then call HyMD with the :code:`--plumed` option, passing the PLUMED input file to HyMD. +Optionally, you can also set the output file name with the :code:`--plumed-outfile` option (the default it :code:`plumed.out`). + +If your PLUMED input (see the `PLUMED manual <>` for details) is called, e.g., :code:`plumed_input.dat`, you can run a simulation using the PLUMED interface with: + +.. code:: bash + + python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field --plumed plumed_input.dat diff --git a/v2.2.0/_sources/doc_pages/intramolecular_bonds.rst.txt b/v2.2.0/_sources/doc_pages/intramolecular_bonds.rst.txt new file mode 100644 index 00000000..820e81bc --- /dev/null +++ b/v2.2.0/_sources/doc_pages/intramolecular_bonds.rst.txt @@ -0,0 +1,142 @@ +.. _bonds-label: + +Intramolecular bonds +#################### + +Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see :ref:`config-label`. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +:ref:`benchmarks-label`), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable. + +All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]). + + +Two-particle bonds +^^^^^^^^^^^^^^^^^^ +Stretching bonds in HyMD are implemented as harmonic spring potentials, + +.. math:: + + V_2(r) = \frac{k}{2}(r-r_0)^2, + +where :math:`r=|\mathbf{r}|` is the inter-particle distance, :math:`k` is a +constant of dimension energy (units :math:`\text{kJ}\,\text{mol}^{-1}`), and +:math:`r_0` is the equilibrum length of the bond (units: :math:`\text{nm}`). The +force is calculated as + +.. math:: + + F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r}, + +where :math:`\mathbf{r}` is the vector pointing *from* :math:`i` *to* :math:`j`. + +In the configuration file, two-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_two_particle_example.toml + + [bonds] + bonds = [ + ["A", "A", 0.47, 1250.0], + ["A", "B", 0.37, 940.0], + ["B", "C", 0.50, 1010.0], + ["C", "A", 0.42, 550.0], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Three-particle bonds +^^^^^^^^^^^^^^^^^^^^ +Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle--particle--particle angle :math:`\theta`, + +.. math:: + + V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2, + +where :math:`k` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}`), and :math:`\theta_0` is the equilibrum +angle of the bond (units: :math:`{}^\circ`). Defining the particles with labels +:math:`a`, :math:`b`, and :math:`c`, let :math:`\mathbf{r}_a` denote the vector +pointing from :math:`b` to :math:`a`, and correspondingly let +:math:`\mathbf{r}_c` point from :math:`b` to :math:`c`. The +:math:`a`--:math:`b`--:math:`c` may be computed through the law of Cosines, + +.. math:: + + \theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right] + +Then the force acting on :math:`a` and :math:`c` is + +.. math:: + + \mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a}, + + \mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c}, + +and + +.. math:: + + \mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c + +In the configuration file, three-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_three_particle_example.toml + + [bonds] + angle_bonds = [ + ["A", "A", "A", 180.0, 90.0], + ["A", "B", "A", 120.0, 55.0], + ["B", "C", "C", 30.0, 10.0], + ["C", "A", "B", 110.0, 25.5], + ... + ] + +The order of the specified names does not matter, but the order of the length +and energy scales do. + +Four-particle bonds +^^^^^^^^^^^^^^^^^^^ +Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle :math:`\phi` between the +:math:`a`--:math:`b`--:math:`c` and :math:`b`--:math:`c`--:math:`d` planes, for +a dihedral bond quartet :math:`a`, :math:`b`, :math:`c`, and :math:`d`. The +potential takes the form + +.. math:: + + V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n), + +where :math:`c_n` is a constant of dimension energy (units +:math:`\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}`), and :math:`\phi_n` are +specified phase angles in the cosine series. + +In the configuration file, four-particle bonds are specified per particle type: + +.. code-block:: toml + :caption: configuration_four_particle_example.toml + + [bonds] + dihedrals = [ + ["A", "B", "C", "D"], + [ + [-1], + [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564], + [0.08, 0.46, 1.65, -0.96, 0.38], + ], + [1.0], + ] diff --git a/v2.2.0/_sources/doc_pages/overview.rst.txt b/v2.2.0/_sources/doc_pages/overview.rst.txt new file mode 100644 index 00000000..0e4d6b65 --- /dev/null +++ b/v2.2.0/_sources/doc_pages/overview.rst.txt @@ -0,0 +1,166 @@ +.. _overview-label: + +================================ + Usage overview for HylleraasMD +================================ + +HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a `toml`_ format configuration file, along with a topology and structure +file specifying the input system in HDF5 format. + +.. _`toml`: + https://github.com/toml-lang/toml + +**Configuration file** + +The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a :code:`[5, 5, 5]` nm simulation box at 300 K may look like +the following: + +.. code-block:: toml + :caption: **config_simple_1.toml** + + [simulation] + integrator = "velocity-verlet" + n_steps = 100 # total simulation steps + n_print = 10 # output trajectory data every n_print steps + time_step = 0.01 # time step in ps + box_size = [5.0, 5.0, 5.0] # simulation box size in nm + target_temperature = 300 # thermostat temperature in Kelvin + tau = 0.1 # thermostat coupling strength in ps + hamiltonian = "SquaredPhi" # interaction energy functional + kappa = 0.05 # compressibility in mol/kJ + + [field] + mesh_size = [30, 30, 30] # FFT grid size + sigma = 0.5 # filtering length scale in nm + +Note that for the version 1.0 release of HyMD, the :code:`[particles]`, +:code:`[simulation]`, and :code:`[field]` groups are optional specifiers for +structuring the configuration file. + +For a full specification of every recognised configuration keyword in HyMD, +please refer to :ref:`config-label`. + +**Topology and structure file** + +The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +:code:`N` particles may look like the following: + +.. code-block:: bash + :caption: **example_structure.HDF5** + + group / + # root group + + dataset /coordinates + # float32, shape (T, N, D,) + # Time steps of N rows of D dimensional coordinate data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /velocities + # float32, shape (T, N, D,) OPTIONAL + # Time steps of N rows of D dimensional velocity data + # The last frame is used by default if multiple time steps are provided + # T is the number of time steps, D is the spatial dimension + + dataset /bonds + # int32, shape (N, B,) OPTIONAL + # Each row i contains indices of the particles bonds from/to i + # B denotes the maximum bonds per particle + + dataset /indices + # int32, shape (N,) + # Index of each particle, 0--(N-1) + + dataset /molecules + # int32, shape (N,) + # Index of molecule each particle belongs to + # Used to construct bond network locally on MPI ranks + + dataset /names + # str10, shape (N,) + # Fixed size string array containing particle type names + + dataset /types + # int32, shape (N,) OPTIONAL + # Mapping of particle names to type indices + + +For a full specification of the topology and structure input file, see +:ref:`topology-label`. + +**Command line arguments** + +A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the :code:`config_simple_1.toml` and :code:`example_structure.HDF5` +files may look like the following: + +.. code-block:: bash + + mpirun -n ${MPI_NUM_RANKS} python3 -m hymd \ # HyMD executable + config_simple_1.toml \ # configuration file + example_structure.HDF5 \ # structure file + --logfile=log_out.txt \ # set logfile path + --seed 123456 \ # set random seed + --verbose 2 \ # set logging verbosity + --velocity-output # enable velocity in trajectory output + +For a full specification of all command line arguments, see +:ref:`commandline-label`. + +**More examples** + +For more thorough rundown and concrete usage examples, see +:ref:`examples-label`. + +Running parallel simulations +============================ +Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the **only** difference being how the python3 interpreter is +invoked. Prepending :code:`mpirun -n ${NPROCS}` to the usual +:code:`python3 -m hymd` runs the simulation with :code:`${NPROCS}` MPI ranks. + +Inputting + +.. code:: bash + + mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field + +sets up an example simulation of the `HyMD-tutorial/ideal_gas`_ system. For +more details about this system in particular, or other example simulations, see +the `HyMD-tutorial`_ repository. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial +.. _HyMD-tutorial/ideal_gas: + https://github.com/Cascella-Group-UiO/HyMD-tutorial/tree/main/ideal_gas + + +Running tests +============= +Run serial code tests by + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd + cd hymd/ + python3 -m pip install pytest pytest-mpi + python3 -m pytest + +There is a small convenience script in :code:`hymd/` for running the MPI-enabled +tests, + +.. code-block:: bash + + chmod +x pytest-mpi + ./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no diff --git a/v2.2.0/_sources/doc_pages/pressure.rst.txt b/v2.2.0/_sources/doc_pages/pressure.rst.txt new file mode 100644 index 00000000..be9c7cda --- /dev/null +++ b/v2.2.0/_sources/doc_pages/pressure.rst.txt @@ -0,0 +1,37 @@ +.. _pressure-label: + +Pressure +######## +Internal pressure is calculated from internal energy according to + +.. math:: + + P_a = \frac{1}{\mathcal{V}} \left( 2T_a - \text{Vir}_a \right) \\ + \text{Vir}_a = L_a \frac{\partial \mathcal{U}}{\partial L_a} \\ + \mathcal{U} = \sum_{i=1}^M \mathcal{U}_0( \{ \mathbf{r}\}_i ) + W[\{ \tilde\phi \} ] + +where +:math:`\mathcal{V}` is the simulation volume, +:math:`{T_a}` is the kinetic energy +and :math:`L_a` the length of the box in the Cartesian direction :math:`a`, +Vir is the virial of the total interaction energy :math:`\mathcal{U}`. + +:math:`\mathcal{U}` comprises intramolecular bonded terms :math:`\mathcal{U}_0` (see :ref:`bonds-label` for details), +and field terms :math:`W[\{ \tilde\phi \} ]` (see :ref:`theory-label` for details). + +Using the above expressions, the following form for internal pressure is obtained: + +.. math:: + + P_a = \frac{2 T_a}{\mathcal{V}} -\frac{L_a}{\mathcal{V}} \sum_{i=1}^N \frac{\partial \mathcal{U}_{0i}}{\partial L_a} + P^{(3)}_a \\ + +.. P^{(3)}_a = - \frac{L_a}{\mathcal{V}} \frac{\partial W[\{ \tilde\phi \} ]}{\partial L_a} \\ + +.. math:: + + P^{(3)}_a = \frac{1}{\mathcal{V}}\left ( -W[\{ \tilde\phi(\mathbf{r}) \}] + \int \sum_t \bar{V}_t(\mathbf{r})\tilde\phi_t(\mathbf{r})d\mathbf{r} + + \int \sum_t \sigma^2\bar{V}_t(\mathbf{r})\nabla_a^2\tilde\phi_t(\mathbf{r}) d\mathbf{r} \right) + +where :math:`\bar{V}_t(\mathbf{r}) = \frac{\partial w(\{\tilde\phi\})}{\partial\tilde\phi_t}` +and :math:`σ` is a coarse-graining parameter (see :ref:`filtering-label` for details). +Note that the above expression is obtained for a Gaussian filter which is the most natural choice in HhPF theory. diff --git a/v2.2.0/_sources/doc_pages/theory.rst.txt b/v2.2.0/_sources/doc_pages/theory.rst.txt new file mode 100644 index 00000000..2429bc0d --- /dev/null +++ b/v2.2.0/_sources/doc_pages/theory.rst.txt @@ -0,0 +1,122 @@ +.. _theory-label: + +Theory +###### +Hybrid particle--field simulations switch out the ordinary particle--particle +`Lennard-Jones`_ interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle--field densities are +defined as + +.. math:: + + \phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i), + +where :math:`\mathbf{r}` is a spatial coordinate, :math:`P` is a window function +used to distribute particle number densities onto a computational grid, and +:math:`\mathbf{r}_i` is the position of particle :math:`i` (of total :math:`N`). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of :math:`N` particles in :math:`M` molecules is + +.. math:: + + \mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})] + +with :math:`H_0` being a standard intramolecular Hamiltonian form (see +:ref:`bonds-label`) including kinetic terms, while :math:`W` is a density +dependent *interaction energy functional*. + +In the Hamiltonian hPF-MD formalism :cite:`bore2020hamiltonian`, the density +field is filtered using a grid-independent filtering function :math:`H`, + +.. math:: + + \tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}). + +The filter smooths the density, ensuring that :math:`\tilde\phi` and +:math:`W[\tilde\phi([\phi])]` both converge as the grid size is reduced. + +External potential +================== +The external potential acting on a particle is defined as the functional +derivative of :math:`W` with respect to :math:`\phi`. In the filtered formalism, +the potential takes the form + +.. math:: + + V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ + &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})}, + +under the assumption of a *local* form of the interaction energy functional, +:math:`W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]`. Note +that + +.. math:: + + \frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}). + +Force interpolation +=================== +The forces on particle :math:`i` are obtained by differentiation of the external +potential, + +.. math:: + + \mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i). + + +Reciprocal space calculations +============================= +The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density :math:`\phi_{ijk}` with CIC, we apply the filtering +and obtain the discrete version of the external potential by + +.. math:: + + \tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big] + +and + +.. math:: + + V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +The forces are obtained by differentiation of :math:`V` in Fourier space as + +.. math:: + + \nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right]. + +Filter +====== +By default, the filter used in HyMD is a simple Gaussian of the form + +.. math:: + + H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ + \hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right]. + +For more details about the filtering, see :ref:`filtering-label`. + +Hamiltonian form +================ +The default form of the interaction energy functional in HyMD is + +.. math:: + + W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2. + +In the case of constant pressure simulations (NPT), the interaction energy functional becomes + +.. math:: + + W=\frac{1}{2\rho_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-a\right)^2. + +where, :math:`\rho_0= 1 / ν` is an intrinsic parameter corresponding to the specific volume :math:`(ν)` of a coarse-grained particle, +:math:`a` is a calibrated parameter to obtain the correct average density at the target temperature and pressure. +See :ref:`functionals-label` for details. + + +.. _`Lennard-Jones`: + https://en.wikipedia.org/wiki/Lennard-Jones_potential diff --git a/v2.2.0/_sources/doc_pages/topology_input.rst.txt b/v2.2.0/_sources/doc_pages/topology_input.rst.txt new file mode 100644 index 00000000..02faa501 --- /dev/null +++ b/v2.2.0/_sources/doc_pages/topology_input.rst.txt @@ -0,0 +1,84 @@ +.. _topology-label: + +============================ +Topology and structure file +============================ +The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root :code:`/` group. + +The `HyMD-tutorial`_ has multiple examples of structure files for various levels +of complexity. + +.. _HyMD-tutorial: + https://github.com/Cascella-Group-UiO/HyMD-tutorial + +Required datasets +================= +:/coordinates: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/indices: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/names: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`string` (:code:`length` between :code:`1` and :code:`16`)] + + The shape represents one particle name per :code:`N` particles. The datatype may be a string of length :code:`=<16`. + + + +Optional datasets +================= +:/velocities: + :code:`array` shape [:code:`T`, :code:`N`, :code:`D`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents :code:`T` number of frames, :code:`N` number of particles, in :code:`D` dimensions. The data type may be either four or eight byte reals. If multiple frames are provided :code:`T > 1`, then the last frame is used as starting point for the new simulation by default. + +:/types: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one particle type index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/molecules: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents one molecule index per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/bonds: + :code:`array` shape [:code:`N`, :code:`B`,] + + :code:`datatype` [:code:`int32` or :code:`int64`] + + The shape represents :code:`B` bond specifications (indices of different particles) per :code:`N` particles. The data type may be either 32 or 64 bit integers. + +:/charge: + :code:`array` shape [:code:`N`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents one particle charge per :code:`N` particles. The data type may be either four or eight byte reals. + +:/box: + :code:`array` shape [:code:`3`,] + + :code:`datatype` [:code:`float32` or :code:`float64`] + + The shape represents the initial box dimensions in Cartesian coordinates. diff --git a/v2.2.0/_sources/index.rst.txt b/v2.2.0/_sources/index.rst.txt new file mode 100644 index 00000000..6899ec42 --- /dev/null +++ b/v2.2.0/_sources/index.rst.txt @@ -0,0 +1,164 @@ +.. hymd documentation master file, created by + sphinx-quickstart on Thu Dec 16 13:31:43 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +############################### +HylleraasMD documentation +############################### + +:Release: + |release| +:Date: + |today| + +**HylleraasMD** (HyMD) is a massively parallel Python package for Hamiltonian hybrid +particle-field molecular dynamics (HhPF-MD) simulations of coarse-grained bio- +and soft-matter systems. + +HyMD can run canonical hPF-MD simulations, or filtered density HhPF-MD simulations :cite:`hymd_domain2023,hymd_massive2023,hymd_pressure2023,hymd_alias2020` +with or without explicit PME electrostatic interactions. It includes all standard intramolecular interactions, +including stretching, bending, torsional, and combined bending-dihedral potentials. Additionally, topological reconstruction of permanent peptide chain backbone +dipoles is possible for accurate recreation of protein conformational dynamics. It can run simulations in constant energy (NVE), constant volume (NVT) :cite:`hymd_domain2023,hymd_massive2023` +or constant pressure (NPT) conditions :cite:`hymd_pressure2023`. +HyMD is also interfaced with :doc:`PLUMED ` and can perform simulations using enhanced sampling methods. + +HyMD uses the pmesh library for particle-mesh operations, with the PPFT :cite:`pippig2013` backend for FFTs through the pfft-python bindings. +File IO is done via HDF5 formats to allow MPI parallel reads. + +User Guide +========== +The HylleraasMD :doc:`User Guide ` provides comprehensive information on how to run +simulations. Selected :doc:`Examples ` are available to guide new users. + +.. _`github.com/rainwoodman/pmesh`: + https://github.com/rainwoodman/pmesh +.. _`github.com/rainwoodman/pfft-python`: + https://github.com/rainwoodman/pfft-python + +Installing HyMD +=============== +The easiest approach is to install using pip_: + +.. code-block:: bash + + python3 -m pip install --upgrade pip + python3 -m pip install --upgrade numpy mpi4py cython + python3 -m pip install hymd + +For more information and **required dependencies**, see +:ref:`installation-label`. + +.. _pip: + http://www.pip-installer.org/en/latest/index.html + + +Run in Google colab +------------------- +Run HyMD interactively in `Google Colaboratory`_ jupyter notebook `here`_. + +.. _`Google colaboratory` : + https://colab.research.google.com/ +.. _`here` : + https://colab.research.google.com/drive/1jfzRaXjL3q53J4U8OrCgADepmf_HuCOh?usp=sharing + + +Source Code +=========== +**Source code** is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the `GNU Lesser General Public +License v3.0`_. Obtain the source code with `git`_: + +.. code-block:: bash + + git clone https://github.com/Cascella-Group-UiO/HyMD.git + +.. _GNU Lesser General Public License v3.0: + https://www.gnu.org/licenses/lgpl-3.0.html +.. _git: + https://git-scm.com/ + + +Development +=========== +HyMD is developed and maintained by researchers at the `Hylleraas Centre for +Quantum Molecular Sciences`_ at the `University of Oslo`_. + +|pic1| |pic2| + +.. _`Hylleraas Centre for Quantum Molecular Sciences`: + https://www.mn.uio.no/hylleraas/english/ +.. _`University of Oslo`: + https://www.uio.no/ + +.. |pic1| image:: img/hylleraas_centre_logo_black.png + :target: img/hylleraas_centre_logo_black.png + :width: 250 px + +.. |pic2| image:: img/uio_full_logo_eng_pos.png + :target: img/uio_full_logo_eng_pos.png + :width: 325 px + + + +References +========== +.. bibliography:: + :all: + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. Contents +.. ======== + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Getting started + + ./doc_pages/installation + ./doc_pages/overview + ./doc_pages/config_file + ./doc_pages/topology_input + ./doc_pages/command_line + ./doc_pages/constants_and_units + + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Examples + + ./doc_pages/examples + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Theory + + ./doc_pages/theory + ./doc_pages/intramolecular_bonds + ./doc_pages/electrostatics + ./doc_pages/pressure + ./doc_pages/interfaces + +.. toctree:: + :maxdepth: 2 + :numbered: + :hidden: + :caption: Developer documentation + + ./doc_pages/interaction_energy_functionals + ./doc_pages/filtering + ./doc_pages/benchmarks + ./doc_pages/api diff --git a/v2.2.0/_static/basic.css b/v2.2.0/_static/basic.css new file mode 100644 index 00000000..be19270e --- /dev/null +++ b/v2.2.0/_static/basic.css @@ -0,0 +1,856 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +code.descclassname { + background-color: transparent; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/v2.2.0/_static/css/badge_only.css b/v2.2.0/_static/css/badge_only.css new file mode 100644 index 00000000..c718cee4 --- /dev/null +++ b/v2.2.0/_static/css/badge_only.css @@ -0,0 +1 @@ +.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/v2.2.0/_static/css/fonts/Roboto-Slab-Bold.woff b/v2.2.0/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 00000000..6cb60000 Binary files /dev/null and b/v2.2.0/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/v2.2.0/_static/css/fonts/Roboto-Slab-Bold.woff2 b/v2.2.0/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 00000000..7059e231 Binary files /dev/null and b/v2.2.0/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/v2.2.0/_static/css/fonts/Roboto-Slab-Regular.woff b/v2.2.0/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 00000000..f815f63f Binary files /dev/null and b/v2.2.0/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/v2.2.0/_static/css/fonts/Roboto-Slab-Regular.woff2 b/v2.2.0/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 00000000..f2c76e5b Binary files /dev/null and b/v2.2.0/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/v2.2.0/_static/css/fonts/fontawesome-webfont.eot b/v2.2.0/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 00000000..e9f60ca9 Binary files /dev/null and b/v2.2.0/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/v2.2.0/_static/css/fonts/fontawesome-webfont.svg b/v2.2.0/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 00000000..855c845e --- /dev/null +++ b/v2.2.0/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/v2.2.0/_static/css/fonts/fontawesome-webfont.ttf b/v2.2.0/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 00000000..35acda2f Binary files /dev/null and b/v2.2.0/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/v2.2.0/_static/css/fonts/fontawesome-webfont.woff b/v2.2.0/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 00000000..400014a4 Binary files /dev/null and b/v2.2.0/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/v2.2.0/_static/css/fonts/fontawesome-webfont.woff2 b/v2.2.0/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 00000000..4d13fc60 Binary files /dev/null and b/v2.2.0/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/v2.2.0/_static/css/fonts/lato-bold-italic.woff b/v2.2.0/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 00000000..88ad05b9 Binary files /dev/null and b/v2.2.0/_static/css/fonts/lato-bold-italic.woff differ diff --git a/v2.2.0/_static/css/fonts/lato-bold-italic.woff2 b/v2.2.0/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 00000000..c4e3d804 Binary files /dev/null and b/v2.2.0/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/v2.2.0/_static/css/fonts/lato-bold.woff b/v2.2.0/_static/css/fonts/lato-bold.woff new file mode 100644 index 00000000..c6dff51f Binary files /dev/null and b/v2.2.0/_static/css/fonts/lato-bold.woff differ diff --git a/v2.2.0/_static/css/fonts/lato-bold.woff2 b/v2.2.0/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 00000000..bb195043 Binary files /dev/null and b/v2.2.0/_static/css/fonts/lato-bold.woff2 differ diff --git a/v2.2.0/_static/css/fonts/lato-normal-italic.woff b/v2.2.0/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 00000000..76114bc0 Binary files /dev/null and b/v2.2.0/_static/css/fonts/lato-normal-italic.woff differ diff --git a/v2.2.0/_static/css/fonts/lato-normal-italic.woff2 b/v2.2.0/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 00000000..3404f37e Binary files /dev/null and b/v2.2.0/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/v2.2.0/_static/css/fonts/lato-normal.woff b/v2.2.0/_static/css/fonts/lato-normal.woff new file mode 100644 index 00000000..ae1307ff Binary files /dev/null and b/v2.2.0/_static/css/fonts/lato-normal.woff differ diff --git a/v2.2.0/_static/css/fonts/lato-normal.woff2 b/v2.2.0/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 00000000..3bf98433 Binary files /dev/null and b/v2.2.0/_static/css/fonts/lato-normal.woff2 differ diff --git a/v2.2.0/_static/css/theme.css b/v2.2.0/_static/css/theme.css new file mode 100644 index 00000000..19a446a0 --- /dev/null +++ b/v2.2.0/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! + * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome + * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) + */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .eqno .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a button.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-left.toctree-expand,.wy-menu-vertical li button.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .eqno .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a button.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a button.fa-pull-right.toctree-expand,.wy-menu-vertical li button.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .eqno .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a button.pull-left.toctree-expand,.wy-menu-vertical li.on a button.pull-left.toctree-expand,.wy-menu-vertical li button.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .eqno .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a button.pull-right.toctree-expand,.wy-menu-vertical li.on a button.pull-right.toctree-expand,.wy-menu-vertical li button.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li button.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li button.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content .eqno .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content .eqno a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content p a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand,.wy-menu-vertical li a button.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content .eqno .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content p .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li button.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content .eqno .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a button.toctree-expand,.btn .wy-menu-vertical li.on a button.toctree-expand,.btn .wy-menu-vertical li button.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content .eqno .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a button.toctree-expand,.nav .wy-menu-vertical li.on a button.toctree-expand,.nav .wy-menu-vertical li button.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .eqno .btn .headerlink,.rst-content .eqno .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p .btn .headerlink,.rst-content p .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn button.toctree-expand,.wy-menu-vertical li.current>a .btn button.toctree-expand,.wy-menu-vertical li.current>a .nav button.toctree-expand,.wy-menu-vertical li .nav button.toctree-expand,.wy-menu-vertical li.on a .btn button.toctree-expand,.wy-menu-vertical li.on a .nav button.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .eqno .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li button.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .eqno .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li button.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .eqno .btn .fa-large.headerlink,.rst-content .eqno .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p .btn .fa-large.headerlink,.rst-content p .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn button.fa-large.toctree-expand,.wy-menu-vertical li .nav button.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .eqno .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li button.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .eqno .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li button.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .eqno .btn .fa-spin.headerlink,.rst-content .eqno .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p .btn .fa-spin.headerlink,.rst-content p .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn button.fa-spin.toctree-expand,.wy-menu-vertical li .nav button.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content .eqno .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li button.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content .eqno .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li button.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content .eqno .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li button.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content .eqno .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini button.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.rst-content section ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.rst-content section ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.rst-content section ul li p:last-child,.rst-content section ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.rst-content section ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.rst-content section ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.rst-content section ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content .section ol.arabic,.rst-content .toctree-wrapper ol,.rst-content .toctree-wrapper ol.arabic,.rst-content section ol,.rst-content section ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol.arabic li,.rst-content .section ol li,.rst-content .toctree-wrapper ol.arabic li,.rst-content .toctree-wrapper ol li,.rst-content section ol.arabic li,.rst-content section ol li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol.arabic li ul,.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content .toctree-wrapper ol.arabic li ul,.rst-content .toctree-wrapper ol li p:last-child,.rst-content .toctree-wrapper ol li ul,.rst-content section ol.arabic li ul,.rst-content section ol li p:last-child,.rst-content section ol li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol.arabic li ul li,.rst-content .section ol li ul li,.rst-content .toctree-wrapper ol.arabic li ul li,.rst-content .toctree-wrapper ol li ul li,.rst-content section ol.arabic li ul li,.rst-content section ol li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs>li{display:inline-block;padding-top:5px}.wy-breadcrumbs>li.wy-breadcrumbs-aside{float:right}.rst-content .wy-breadcrumbs>li code,.rst-content .wy-breadcrumbs>li tt,.wy-breadcrumbs>li .rst-content tt,.wy-breadcrumbs>li code{all:inherit;color:inherit}.breadcrumb-item:before{content:"/";color:#bbb;font-size:13px;padding:0 6px 0 3px}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li button.toctree-expand{display:block;float:left;margin-left:-1.2em;line-height:18px;color:#4d4d4d;border:none;background:none;padding:0}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover button.toctree-expand,.wy-menu-vertical li.on a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.current>a button.toctree-expand,.wy-menu-vertical li.on a button.toctree-expand{display:block;line-height:18px;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover button.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover button.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{padding:.4045em 1.618em .4045em 4.045em}.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{padding:.4045em 1.618em .4045em 5.663em}.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a{padding:.4045em 1.618em .4045em 7.281em}.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a{padding:.4045em 1.618em .4045em 8.899em}.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a{padding:.4045em 1.618em .4045em 10.517em}.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a{padding:.4045em 1.618em .4045em 12.135em}.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a{padding:.4045em 1.618em .4045em 13.753em}.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a{padding:.4045em 1.618em .4045em 15.371em}.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 1.618em .4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 button.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 button.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active button.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em;max-width:100%}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .eqno .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content .eqno .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li button.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version button.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content .toctree-wrapper>p.caption,.rst-content h1,.rst-content h2,.rst-content h3,.rst-content h4,.rst-content h5,.rst-content h6{margin-bottom:24px}.rst-content img{max-width:100%;height:auto}.rst-content div.figure,.rst-content figure{margin-bottom:24px}.rst-content div.figure .caption-text,.rst-content figure .caption-text{font-style:italic}.rst-content div.figure p:last-child.caption,.rst-content figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center,.rst-content figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img,.rst-content section>a>img,.rst-content section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp,.rst-content div.highlight span.linenos{user-select:none;pointer-events:none}.rst-content div.highlight span.linenos{display:inline-block;padding-left:0;padding-right:12px;margin-right:12px;border-right:1px solid #e6e9ea}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li,.rst-content .toctree-wrapper ol.loweralpha,.rst-content .toctree-wrapper ol.loweralpha>li,.rst-content section ol.loweralpha,.rst-content section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li,.rst-content .toctree-wrapper ol.upperalpha,.rst-content .toctree-wrapper ol.upperalpha>li,.rst-content section ol.upperalpha,.rst-content section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*,.rst-content .toctree-wrapper ol li>*,.rst-content .toctree-wrapper ul li>*,.rst-content section ol li>*,.rst-content section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child,.rst-content .toctree-wrapper ol li>:first-child,.rst-content .toctree-wrapper ul li>:first-child,.rst-content section ol li>:first-child,.rst-content section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child,.rst-content .toctree-wrapper ol li>p,.rst-content .toctree-wrapper ol li>p:last-child,.rst-content .toctree-wrapper ul li>p,.rst-content .toctree-wrapper ul li>p:last-child,.rst-content section ol li>p,.rst-content section ol li>p:last-child,.rst-content section ul li>p,.rst-content section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child,.rst-content .toctree-wrapper ol li>p:only-child,.rst-content .toctree-wrapper ol li>p:only-child:last-child,.rst-content .toctree-wrapper ul li>p:only-child,.rst-content .toctree-wrapper ul li>p:only-child:last-child,.rst-content section ol li>p:only-child,.rst-content section ol li>p:only-child:last-child,.rst-content section ul li>p:only-child,.rst-content section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul,.rst-content .toctree-wrapper ol li>ol,.rst-content .toctree-wrapper ol li>ul,.rst-content .toctree-wrapper ul li>ol,.rst-content .toctree-wrapper ul li>ul,.rst-content section ol li>ol,.rst-content section ol li>ul,.rst-content section ul li>ol,.rst-content section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul,.rst-content .toctree-wrapper ol.simple li>*,.rst-content .toctree-wrapper ol.simple li ol,.rst-content .toctree-wrapper ol.simple li ul,.rst-content .toctree-wrapper ul.simple li>*,.rst-content .toctree-wrapper ul.simple li ol,.rst-content .toctree-wrapper ul.simple li ul,.rst-content section ol.simple li>*,.rst-content section ol.simple li ol,.rst-content section ol.simple li ul,.rst-content section ul.simple li>*,.rst-content section ul.simple li ol,.rst-content section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .eqno .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content p .headerlink,.rst-content table>caption .headerlink{opacity:0;font-size:14px;font-family:FontAwesome;margin-left:.5em}.rst-content .code-block-caption .headerlink:focus,.rst-content .code-block-caption:hover .headerlink,.rst-content .eqno .headerlink:focus,.rst-content .eqno:hover .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink:focus,.rst-content .toctree-wrapper>p.caption:hover .headerlink,.rst-content dl dt .headerlink:focus,.rst-content dl dt:hover .headerlink,.rst-content h1 .headerlink:focus,.rst-content h1:hover .headerlink,.rst-content h2 .headerlink:focus,.rst-content h2:hover .headerlink,.rst-content h3 .headerlink:focus,.rst-content h3:hover .headerlink,.rst-content h4 .headerlink:focus,.rst-content h4:hover .headerlink,.rst-content h5 .headerlink:focus,.rst-content h5:hover .headerlink,.rst-content h6 .headerlink:focus,.rst-content h6:hover .headerlink,.rst-content p.caption .headerlink:focus,.rst-content p.caption:hover .headerlink,.rst-content p .headerlink:focus,.rst-content p:hover .headerlink,.rst-content table>caption .headerlink:focus,.rst-content table>caption:hover .headerlink{opacity:1}.rst-content p a{overflow-wrap:anywhere}.rst-content .wy-table td p,.rst-content .wy-table td ul,.rst-content .wy-table th p,.rst-content .wy-table th ul,.rst-content table.docutils td p,.rst-content table.docutils td ul,.rst-content table.docutils th p,.rst-content table.docutils th ul,.rst-content table.field-list td p,.rst-content table.field-list td ul,.rst-content table.field-list th p,.rst-content table.field-list th ul{font-size:inherit}.rst-content .btn:focus{outline:2px solid}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .citation-reference>span.fn-bracket,.rst-content .footnote-reference>span.fn-bracket{display:none}.rst-content .hlist{width:100%}.rst-content dl dt span.classifier:before{content:" : "}.rst-content dl dt span.classifier-delimiter{display:none!important}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:auto minmax(80%,95%)}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{display:inline-grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{display:grid;grid-template-columns:auto auto minmax(.65rem,auto) minmax(40%,95%)}html.writer-html5 .rst-content aside.citation>span.label,html.writer-html5 .rst-content aside.footnote>span.label,html.writer-html5 .rst-content div.citation>span.label{grid-column-start:1;grid-column-end:2}html.writer-html5 .rst-content aside.citation>span.backrefs,html.writer-html5 .rst-content aside.footnote>span.backrefs,html.writer-html5 .rst-content div.citation>span.backrefs{grid-column-start:2;grid-column-end:3;grid-row-start:1;grid-row-end:3}html.writer-html5 .rst-content aside.citation>p,html.writer-html5 .rst-content aside.footnote>p,html.writer-html5 .rst-content div.citation>p{grid-column-start:4;grid-column-end:5}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{margin-bottom:24px}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.citation>dt,html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.citation>dt>span.brackets:before,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.citation>dt>span.brackets:after,html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a{word-break:keep-all}html.writer-html5 .rst-content dl.citation>dt>span.fn-backref>a:not(:first-child):before,html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content dl.citation>dd,html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.citation>dd p,html.writer-html5 .rst-content dl.footnote>dd p{font-size:.9rem}html.writer-html5 .rst-content aside.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content div.citation{padding-left:1rem;padding-right:1rem;font-size:.9rem;line-height:1.2rem}html.writer-html5 .rst-content aside.citation p,html.writer-html5 .rst-content aside.footnote p,html.writer-html5 .rst-content div.citation p{font-size:.9rem;line-height:1.2rem;margin-bottom:12px}html.writer-html5 .rst-content aside.citation span.backrefs,html.writer-html5 .rst-content aside.footnote span.backrefs,html.writer-html5 .rst-content div.citation span.backrefs{text-align:left;font-style:italic;margin-left:.65rem;word-break:break-word;word-spacing:-.1rem;max-width:5rem}html.writer-html5 .rst-content aside.citation span.backrefs>a,html.writer-html5 .rst-content aside.footnote span.backrefs>a,html.writer-html5 .rst-content div.citation span.backrefs>a{word-break:keep-all}html.writer-html5 .rst-content aside.citation span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content aside.footnote span.backrefs>a:not(:first-child):before,html.writer-html5 .rst-content div.citation span.backrefs>a:not(:first-child):before{content:" "}html.writer-html5 .rst-content aside.citation span.label,html.writer-html5 .rst-content aside.footnote span.label,html.writer-html5 .rst-content div.citation span.label{line-height:1.2rem}html.writer-html5 .rst-content aside.citation-list,html.writer-html5 .rst-content aside.footnote-list,html.writer-html5 .rst-content div.citation-list{margin-bottom:24px}html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content aside.footnote,html.writer-html5 .rst-content aside.footnote-list aside.footnote,html.writer-html5 .rst-content div.citation-list>div.citation,html.writer-html5 .rst-content dl.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content aside.footnote-list aside.footnote code,html.writer-html5 .rst-content aside.footnote-list aside.footnote tt,html.writer-html5 .rst-content aside.footnote code,html.writer-html5 .rst-content aside.footnote tt,html.writer-html5 .rst-content div.citation-list>div.citation code,html.writer-html5 .rst-content div.citation-list>div.citation tt,html.writer-html5 .rst-content dl.citation code,html.writer-html5 .rst-content dl.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c;white-space:normal}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040;overflow-wrap:normal}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}.rst-content dl dd>ol:last-child,.rst-content dl dd>p:last-child,.rst-content dl dd>table:last-child,.rst-content dl dd>ul:last-child{margin-bottom:0}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px;max-width:100%}html.writer-html4 .rst-content dl:not(.docutils) .k,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .k{font-style:italic}html.writer-html4 .rst-content dl:not(.docutils) .descclassname,html.writer-html4 .rst-content dl:not(.docutils) .descname,html.writer-html4 .rst-content dl:not(.docutils) .sig-name,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) .sig-name{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#000}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel,.rst-content .menuselection{font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .guilabel,.rst-content .menuselection{border:1px solid #7fbbe3;background:#e7f2fa}.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>.kbd,.rst-content :not(dl.option-list)>:not(dt):not(kbd):not(.kbd)>kbd{color:inherit;font-size:80%;background-color:#fff;border:1px solid #a6a6a6;border-radius:4px;box-shadow:0 2px grey;padding:2.4px 6px;margin:auto 0}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/v2.2.0/_static/custom.css b/v2.2.0/_static/custom.css new file mode 100644 index 00000000..b20d6282 --- /dev/null +++ b/v2.2.0/_static/custom.css @@ -0,0 +1,91 @@ + +body{ + background: #FFFFFF !important; +} + +.wy-menu-vertical header, .wy-menu-vertical p.caption{ + color: #4EA0AF!important; +} +.wy-menu-vertical li.current{ + background-color: #f4f4f4!important; +} +.wy-menu-vertical li.toctree-l2.current>a{ + background-color: #ebebeb!important; +} + +.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{ + background-color: #e3e3e3!important; +} + +.rst-content .sidebar{ + background-color: #fff!important; + border-radius: 6px; + -moz-border-radius: 6px; + -webkit-border-radius: 6px; +} + +h1 > a, h2 > a, h3 > a, h4 > a, h5 > a, h6 > a { + color: #17d9ff; +} + +h1, h2, h3, h4, h5, h6 { + color: black; + font-weight: normal; + padding: 0; +} + +h1, h2, h3 { + margin-top: 30px; + margin-bottom: 20px; +} + +h1 { + color: white; + padding: 20px 20px 20px 45px; + margin: 20px 0 35px -45px; + background: linear-gradient(to left, #fff, #2b38ff)!important; + + width: calc(100% + 90px); + border-bottom: 3px solid #000; +} + +h2 { + padding: .2em 0; + border-bottom: 1px solid #ddd; +} + +h3 { + margin-top: 35px; +} + +h4 { + margin-top: 30px; +} + +h5 { + margin-top: 25px; +} + +.wy-nav-content{ + max-width: none!important; +} + +.wy-side-nav-search{ + background: #2b38ff!important; +} + +.wy-side-nav-search input[type=text]{ + border-color:#4DA0B0!important; +} + +.wy-side-nav-search input[type=text]{ + border-radius: 4px!important; +} + +#caption-api { + background: red !important; +} + +#caption-text-api { + text-color: blue !important; +} diff --git a/v2.2.0/_static/doctools.js b/v2.2.0/_static/doctools.js new file mode 100644 index 00000000..61ac9d26 --- /dev/null +++ b/v2.2.0/_static/doctools.js @@ -0,0 +1,321 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/v2.2.0/_static/documentation_options.js b/v2.2.0/_static/documentation_options.js new file mode 100644 index 00000000..f202afa0 --- /dev/null +++ b/v2.2.0/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '2.2.0', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/v2.2.0/_static/file.png b/v2.2.0/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/v2.2.0/_static/file.png differ diff --git a/v2.2.0/_static/hymd_icon_white.png b/v2.2.0/_static/hymd_icon_white.png new file mode 100644 index 00000000..d0396a17 Binary files /dev/null and b/v2.2.0/_static/hymd_icon_white.png differ diff --git a/v2.2.0/_static/hymd_logl_white_text_abbr.png b/v2.2.0/_static/hymd_logl_white_text_abbr.png new file mode 100644 index 00000000..8c0e50c8 Binary files /dev/null and b/v2.2.0/_static/hymd_logl_white_text_abbr.png differ diff --git a/v2.2.0/_static/jquery-3.5.1.js b/v2.2.0/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/v2.2.0/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. API reference

+
+

4.1. Integrator

+

Integrates equations of motion.

+

Implements the Velocity Verlet integrator. The reversible reference system +propagator algorithm (rRESPA) integrator uses the Velocity Verlet functions +inside the MD loop in the main module.

+
+
+hymd.integrator.integrate_position(positions, velocities, time_step)[source]
+

Position update step of the Velocity Verlet integration algorithm.

+

Computes the position update step of the Velocity Verlet algorithm. The +positions argument is not changed in place.

+
+
Parameters:
+
+
positions(N, D) numpy.ndarray

Array of positions of N particles in D dimensions.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_velocity

The velocity update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step, then the positions are updated a full step using the updated +velocities

+
+\[\mathbf{x}_{\text{new}} = \mathbf{x} + \Delta t \mathbf{v}\]
+
+ +
+
+hymd.integrator.integrate_velocity(velocities, accelerations, time_step)[source]
+

Velocity update step of the Velocity Verlet integration algorithm.

+

Computes the velocity update step of the Velocity Verlet algorithm. The +velocities argument is not changed in place.

+
+
Parameters:
+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
accelerations(N, D) numpy.ndarray

Array of accelerations of N particles in D dimensions.

+
+
time_stepfloat

The time step used in the integration.

+
+
+
+
+
+

See also

+
+
integrate_position

The position update step of the Velocity Verlet algorithm.

+
+
+ +

Notes

+

The Velocity Verlet algorithm contains two steps, first the velocties are +integrated one half step forward in time by applying the forces from the +previous step

+
+\[\mathbf{v}_{\text{new}} = \mathbf{v} + \frac{\Delta t}{2m} +\mathbf{f}\]
+

before the positions are moved a full step using the updated half-step +velocities.

+
+ +
+
+

4.2. Thermostat

+

Scales or otherwise modifies the particle velocities during simulation to +simulate coupling to an external heat bath with temperature T₀.

+
+
+hymd.thermostat._random_chi_squared(prng: numpy.random._generator.Generator, M: int)float[source]
+

Draw the sum of M squared normally distributed values

+

The value is generated by the Gamma distribution, in lieu of generating +M Gaussian distributed numbers and summing their squares.

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
Mint

Number of standard normally distributed numbers in the sum.

+
+
+
+
Returns:
+
+
float

The sum of M squared normally distributed values centered at +zero with unit standard deviation.

+
+
+
+
+

Notes

+

The sum of the squares of k independent standard normal random variables is +distributed according to a \(\chi^2\) distribution.

+
+\[\chi^2_1 + \chi_2^2 + \chi_3^2 + \dots + \chi_M^2 +\sim +\sigma^2\chi^2(k)\]
+

This is a special case of the \(\Gamma\) distribution, +\(\Gamma(k/2, 2)\), and may be generated by

+
+\[\chi^2(k) \sim 2 \Gamma(k/2, 2)\]
+

References

+

Knuth, D.E. 1981, Seminumerical Algorithms, 2nd ed., vol. 2 of The Art of +Computer Programming (Reading, MA: Addison-Wesley), pp. 120ff. +J. H. Ahrens and U. Dieter, Computing 12 (1974), 223-246.

+
+ +
+
+hymd.thermostat._random_gaussian(prng: numpy.random._generator.Generator)float[source]
+

Draw a single random number from the standard normal distribution +Generate a number from the Gaussian distribution centered at zero with unit +standard deviation, \(N(0, 1)\).

+
+
Parameters:
+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
+
+
Returns:
+
+
float

A random number drawn from \(N(0, 1)\).

+
+
+
+
+
+ +
+
+hymd.thermostat.csvr_thermostat(velocity: numpy.ndarray, names: numpy.ndarray, config: hymd.input_parser.Config, prng: numpy.random._generator.Generator, comm: mpi4py.MPI.Intracomm = <mpi4py.MPI.Intracomm object>, random_gaussian: Callable[[numpy.random._generator.Generator], float] = <function _random_gaussian>, random_chi_squared: Callable[[numpy.random._generator.Generator, int, float], float] = <function _random_chi_squared>, remove_center_of_mass_momentum: bool = True)numpy.ndarray[source]
+

Canonical sampling through velocity rescaling thermostat

+

Implements the CSVR thermostat. Rescales the system kinetic energy by a +stochastically chosen factor to keep the temperature constant. Requires +communcation of the kinetic energies calculated locally for each MPI rank. +The random numbers sampled through random_gaussian and +random_chi_squared are broadcast from the root rank to the other +ranks to ensure the scaling is performed with the same stochasticity for +all particles in the full system.

+

The velocities are cleaned of center of mass momentum before the thermostat +is applied, and the center of mass momentum is subsequently reapplied. This +is performed for each thermostat coupling group, i.e. the center of mass +momenta of each group is separately removed and reapplied after +thermostatting.

+

The implementation here is based on the derivation presented in the 2008 +Comput. Phys. Commun paper, not in the original 2007 J. Chem. Phys. paper.

+
+
Parameters:
+
+
velocity(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
names(N,) numpy.ndarray

Array of particle names.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
random_gaussiancallable, optional

Function for generating standard normally distributed numbers.

+
+
random_chi_squaredcallable, optional

Function for generating \(\chi^2\)-distributed numbers

+
+
remove_center_of_mass_momentumbool, optional

If True, the center of mass of each coupling group is removed before +the thermostat is applied. The center of mass momenta are added back +after the kinetic energy rescaling is complete.

+
+
+
+
+
+

See also

+
+
_random_gaussian

Used to sample Gaussian-distributed numbers.

+
+
_random_chi_squared

Used to sample \(\chi^2\)-distributed numbers.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +

References

+

G. Bussi, D. Donadio, and M. Parrinello, J. Chem. Phys. 126, 014101 (2007). +G. Bussi and M. Parrinello, Comput. Phys. Commun. 179, 26-29, (2008).

+
+ +
+
+

4.3. Barostat

+
+

4.3.1. Berendsen Barostat

+

Implements the Berendsen barostat. +Scales the box and particle positions during simulation to +simulate coupling to an external pressure bath set at a +target pressure.

+

It calculates the scaling factor according to: +.. math:

+
\alpha_{L,N} = 1 - \frac{dt n_b}{\tau_p}\β(P_{L,N}^t - P_{L,N})
+
+
+

where \(dt\) is the outer rRESPA time-step, \(n_b\) is the frequency +of barostat calls, \(\tau_p\) is the pressure coupling time constant, +\(\beta\) is the isothermal compressibility, \(P_{L,N}^t\) and +\(P_{L,N}\) is the target and instantaneous internal pressure in the +lateral (L) and normal (N) directions respectively. Convention: Cartesian +z-direction is considered normal.

+

The box and particle positions are scaled in the L and N directions according +to the nature of the barostat (see functions isotropic and semiisotropic +below by an amount \(\α^{\frac{1}{3}}\).

+

The updated system information is passed on to the pmesh objects.

+
+

4.3.1.1. References

+

H. J. C. Berendsen, J. P. M. Postma, W. F. van Gunsteren, +A. DiNola, and J. R. Haak , “Molecular dynamics with coupling +to an external bath”, J. Chem. Phys. 81, 3684-3690 (1984)

+
+
+hymd.barostat.isotropic(pmesh, pm_stuff, phi, phi_q, psi, hamiltonian, positions, velocities, config, phi_fft, phi_laplacian, phi_transfer, bond_pr, angle_pr, step, prng, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Implements an isotropic Berendsen barostat. +The box and particle positions are scaled uniformly +in the L and N directions.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of pmesh objects.

+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fftlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds.

+
+
stepinteger

MD step number

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of modified/unmodified pmesh objects.

+
+
changeBoolean

Indicates whether or not any pmesh objects were reinitialized.

+
+
+
+
+
+ +
+
+hymd.barostat.semiisotropic(pmesh, pm_stuff, phi, phi_q, psi, hamiltonian, positions, velocities, config, phi_fft, phi_laplacian, phi_transfer, bond_pr, angle_pr, step, prng, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Implements a semiisotropic Berendsen barostat. +The box and particle positions are scaled by \(\alpha_L^{\frac{1}{3}}\) +in the L direction and by \(\alpha_N^{\frac{1}{3}}\) in the N direction.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of pmesh objects.

+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fftlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds.

+
+
stepinteger

MD step number

+
+
prngnp.random.Generator

Numpy object that provides a stream of random bits

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pm_stufflist[Union(pmesh.pm.RealField, pmesh.pm.ComplexField]

List of modified/unmodified pmesh objects.

+
+
changeBoolean

Indicates whether or not any pmesh objects were reinitialized.

+
+
+
+
+
+ +
+
+
+

4.3.2. SCR Barostat

+
+
+
+

4.4. Hamiltonian

+
+
+class hymd.hamiltonian.Hamiltonian(config)[source]
+

Interaction energy functional superclass

+
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+_setup()[source]
+

Superclass setup

+

Sets up the grid-independent filtering function H, and the +SymPy logic for symbolically differentiating interaction energy +functionals in Hamiltonian subclasses.

+
+ +
+ +
+
+class hymd.hamiltonian.SquaredPhi(config)[source]
+

Simple squared density interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + \sum_k \tilde\phi_k + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(rho_0\) is the +average density of the fully homogenous system. Expressing the species +densities in terms of fluctuations from the average,

+
+\[\mathrm{d}\tilde\phi_k = \rho_0 - \tilde\phi_k,\]
+

it is evident that this interaction energy functional is a slight change of +the DefaultNoChi Hamiltonian, as the expanded interaction energy +density becomes

+
+\[w[\tilde\phi] = \frac{1}{2\kappa\rho_0} + \left( + 6\rho_0\left[ + \sum_k \mathrm{d}\tilde\phi_k + \right] + + + 9\rho_0^2 + + + \sum_k \mathrm{d}\tilde\phi_k^2 + + + \prod_{k\not=l} + \mathrm{d}\tilde\phi_k \mathrm{d}\tilde\phi_l + \right),\]
+

identical to DefaultNoChi apart from a constant energy shift +\(9\rho_0^2`(which does not impact dynamics) and the +:math:\)rho_0`–\(\mathrm{d}\tilde\phi_k\) cross-terms. These +cross-terms constitute contributions to the energy linear in +\(\mathrm{d}\tilde\phi_k\) absent in DefaultNoChi, which has +only quadratic terms present.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultNoChi(config)[source]
+

Incompressibility-only interaction energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a +\right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. The SquaredPhi Hamiltonian implements a similar +functional with an additional linear term component depending on

+
+\[\mathmr{d}\tilde\phi_k = \tilde\phi_k - \rho_0\]
+

and not \(\mathrm{d}\tilde\phi_k^2\). No explicit inter-species +interaction is present apart from the indirect interaction through the +incompressibility.

+
+

See also

+
+
hymd.hamiltonian.DefaultNoChi
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+
+__init__(config)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup()[source]
+

Setup the interaction energy potential and the external potential

+
+ +
+ +
+
+class hymd.hamiltonian.DefaultWithChi(config, unique_names, type_to_name_map)[source]
+

Incompressibility and \(\chi\)-interactions energy functional

+

The interaction energy density takes the form

+
+\[w[\tilde\phi] = + \frac{1}{2\rho_0} + \sum_{k,l}\chi_{kl} \tilde\phi_k \tilde\phi_l + + + \frac{1}{2\kappa} \left( + \sum_k \tilde\phi_k - a + \right)^2,\]
+

where \(\kappa\) is the compressibility and \(a=\rho_0\) for +NVT runs where \(\rho_0\) is the average density of the fully +homogenous system. In case of NPT runs, \(a\) is a calibrated +parameter to obtain the correct average density at the target temperature +and pressure. \(\chi_{ij}\) is the Flory-Huggins-like +inter-species mixing energy.

+
+
+__init__(config, unique_names, type_to_name_map)[source]
+

Constructor

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+

See also

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+setup(unique_names, type_to_name_map)[source]
+

Setup the interaction energy potential and the external potential

+
+
Parameters:
+
+
unique_namesnumpy.ndarray

Sorted array of all distinct names of different species present in +the simulation. Result of numpy.unique(all_names), where +all_names is the gathered union of all individual MPI +ranks’ names arrays.

+
+
type_to_name_mapdict[int, str]

Dictionary of the mapping from type indices (integers) to type +names.

+
+
+
+
+
+ +
+ +
+
+

4.5. Force

+

Calculates intramolecular forces between bonded particles in molecules

+
+
+class hymd.force.Angle(atom_1: str, atom_2: str, equilibrium: float, strength: float, atom_3: str)[source]
+

Dataclass representing a single three-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any three-particle bond between particles of specific types A, +B, and C (where A, B, and C may be +different or the same). Harmonic angular three-particle bonds in HyMD take +the form

+
+\[V_3(\mathbf{r}_1, \mathbf{r}_2, \mathbf{r}_3) = + \frac{1}{2}k + \left( + \cos^{-1} + \left[ + \frac{ + (\mathbf{r}_1-\mathbf{r}_2) + \cdot + (\mathbf{r}_3-\mathbf{r}_2) + } + { + \vert\mathbf{r}_1-\mathbf{r}_2\vert + \vert\mathbf{r}_3-\mathbf{r}_2\vert + } + \right] - \theta_0 + \right)^2\]
+
+

See also

+
+
Bond

Two-particle bond type dataclass

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
equilibriumfloat

Equilibrium angle at which the energy associated with the +three-particle angular bond vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient.

+
+
+
+
+
+
+atom_3: str
+
+ +
+ +
+
+class hymd.force.Bond(atom_1: str, atom_2: str, equilibrium: float, strength: float)[source]
+

Dataclass representing a single two-particle bond type

+

A bond type is a bond strength and equilibrium distance associated with +any bond between particles of specific types A and B +(where A and B may be the same or different). Harmonic +two-particle bonds in HyMD take the form

+
+\[V_2(\mathbf{r}_1, \mathbf{r}_2) = + \frac{1}{2}k + \left( + \vert \mathbf{r}_1 - \mathbf{r}_2 \vert - r_0 + \right)^2,\]
+

where \(k\) is the bond strength (spring constant) and \(r_0\) is +the equilibrium bond length (at which the energy is zero).

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
equilibriumfloat

Equilibrium distance at which the energy associated with the bond +vanishes and the resulting force is zero.

+
+
strengthfloat

Harmonic bond strength coefficient (spring constant).

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+equilibrium: float
+
+ +
+
+strength: float
+
+ +
+ +
+
+class hymd.force.Chi(atom_1: str, atom_2: str, interaction_energy: float)[source]
+

Dataclass representing a single \(\chi\) mixing interaction type

+

An interaction mixing energy type is a mixing energy associated with +density overlap between species of types A and B +(specified as inputs atom_1 and atom_2). A positive mixing +energy promotes phase separation, a negative mixing energy promotes mixing. +The interaction energy density (provided the DefaultWithChi +Hamiltonian is used) takes the form

+
+\[w[\tilde\phi] = \frac{1}{2\kappa} + \sum_{k,l}\chi_{k,l} \tilde\phi_k\tilde\phi_l,\]
+

where \(\chi_{k,l}\) denotes the mixing energy between species +\(k\) and \(l\), with \(\kappa\) being the incompressibility. +The value of the interaction mixing energy parameter may be extracted from +Flory-Huggins theory.

+
+

See also

+
+
hymd.hamiltonian.DefaultWithChi

Interaction energy functional using \(\chi\)-interactions.

+
+
+ +
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
interaction_energyfloat

Interaction mixing energy.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+interaction_energy: float
+
+ +
+ +
+
+class hymd.force.Dielectric_type(atom_1: str, dielectric_value: float)[source]
+
+
+atom_1: str
+
+ +
+
+dielectric_value: float
+
+ +
+ +
+
+class hymd.force.Dihedral(atom_1: str, atom_2: str, atom_3: str, atom_4: str, coeffs: numpy.ndarray, dih_type: int)[source]
+

Dataclass representing a single four-particle bond type

+

A bond type is a bond strength and equilibrium angle associated with +any four-particle torsional bond between particles of specific types +A, B, C, and D (where A, B, +C, and D may be different or the same). Dihedral +four-particle bonds in HyMD take different forms depending on the +dih_type parameter.

+

In the following, let \(\phi\) denote the angle between the planes +spanned by the relative positions of atoms A-B-C +and B-C-D. If dih_type = 0, then

+
+\[V_4(\phi) = \sum_n c_n + \left( + 1 + \cos\left[ + n\phi - d_n + \right] + \right),\]
+

where \(c_n\) are energy coefficients and \(d_n\) are propensity +phases. By default, the cosine sum is truncated at five terms. If +coeffs provides only a single float, this is used as the coiling +propensity parameter \(\lambda\). In this case, \(c_n\) and +\(d_n\) are automatically set to values which promote alpha helical +(\(\lambda=-1\)), beta sheet (\(\lambda=1\)), or a mixed +(\(1>\lambda>-1\)) structure (using values provided by Bore et al. +(2018)). In this case, the full potential takes the form

+
+\[V_4(\phi;\lambda) = + \frac{1}{2}(1-\lambda) V_{\text{prop},\alpha}(\phi) + + + \frac{1}{2}(1+\lambda) V_{\text{prop},\beta}(\phi) + + + (1-\vert\lambda\vert) V_{\text{prop}, \text{coil}}(\phi),\]
+

with each of the \(V_{\mathrm{prop}, X}\) being fixed cosine series +potentials with pre-set \(c_n\) -s and \(d_n\) -s.

+

If dih_type = 1, then a combined bending torsional (CBT) potential +is employed,

+
+\[V_4(\phi,\gamma;\lambda) = + V_4(\phi;\lambda) + + + \frac{1}{2}K(\phi)(\gamma - \gamma_0)^2,\]
+

where \(V_4(\phi;\lambda)\) specifies the potential as given by the +coiling propensity parameter above, \(K(\phi)\) is a separate cosine +series potential acting as the angular three-particle bond strength, and +\(\gamma_0\) is the three-particle bond equilibrium angle. In this +case, the coeffs parameter must specify both a \(\lambda\) +value, in additon to the energy and phases dictating the \(K(\phi)\) +potential.

+

References

+

Bore et al. J. Chem. Theory Comput., 14(2): 1120–1130, 2018.

+
+
Attributes:
+
+
atom_1str

Type name of particle 1.

+
+
atom_2str

Type name of particle 2.

+
+
atom_3str

Type name of particle 3.

+
+
atom_4str

Type name of particle 4.

+
+
coeffslist[list[float]] or list[float] or numpy.ndarray

Dihedral coefficients defining the series expansion of the dihedral +energy.

+
+
dih_typeint

Specifies the type of dihedral used; If 0, then coeffs +must contain either two lists of five energy coefficients +\(c_n\) and five propensity phases \(d_n\) or a single +floating point number defining the \(\lambda\) coiling propensity +parameter. If 1, the combined bending-torsional potential is +used, and coeffs must specify \(\lambda\) and two lists +containing energy coefficients and propensity phases for the +\(V_\text{prop}\) propensity potential, defined in terms of cosine +series.

+
+
+
+
+
+
+atom_1: str
+
+ +
+
+atom_2: str
+
+ +
+
+atom_3: str
+
+ +
+
+atom_4: str
+
+ +
+
+coeffs: numpy.ndarray
+
+ +
+
+dih_type: int
+
+ +
+ +
+
+hymd.force.compute_angle_forces__plain(f_angles, r, bonds_3, box_size)[source]
+

Computes forces resulting from angular interactions

+
+

Deprecated since version 1.0.0: compute_angle_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_bond_forces__plain(f_bonds, r, bonds_2, box_size)[source]
+

Computes forces resulting from bonded interactions

+
+

Deprecated since version 1.0.0: compute_bond_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.compute_dihedral_forces__plain(f_dihedrals, r, bonds_4, box_size)[source]
+

Computes forces resulting from dihedral interactions

+
+

Deprecated since version 1.0.0: compute_dihedral_forces__plain was replaced by compiled Fortran +code prior to 1.0.0 release.

+
+
+ +
+
+hymd.force.dipole_forces_redistribution(f_on_bead, f_dipoles, trans_matrices, a, b, c, d, type_array, last_bb)[source]
+

Redistribute electrostatic forces calculated from topologically +reconstructed ghost dipole point charges to the backcone atoms of the protein.

+
+ +
+
+hymd.force.find_all_paths(G, u, n)[source]
+

Helper function that recursively finds all paths of given lenght ‘n + 1’ inside a network ‘G’. +Adapted from https://stackoverflow.com/a/28103735.

+
+ +
+
+hymd.force.prepare_bonds(molecules, names, bonds, indices, config, topol=None)[source]
+

Rearrange the bond information for usage in compiled Fortran kernels

+

Restructures the lists resulting from the execution of +prepare_bonds_old into numpy arrays suitable for calls to optimized +Fortran code calculating bonded forces and energiesself.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2_atom_1(B,) numpy.ndarray

Local index of particle 1 for each of B constructed +two-particle bonds.

+
+
bonds_2_atom_2(B,) numpy.ndarray

Local index of particle 2 for each of B constructed +two-particle bonds.

+
+
bonds_2_equilibrium(B,) numpy.ndarray

Equilibrium distance for each of B constructed two-particle +bonds.

+
+
bonds_2_strength(B,) numpy.ndarray

Bond strength for each of B constructed two-particle +bonds.

+
+
bonds_3_atom_1(A,) numpy.ndarray

Local index of particle 1 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_2(A,) numpy.ndarray

Local index of particle 2 for each of A constructed +three-particle bonds.

+
+
bonds_3_atom_3(A,) numpy.ndarray

Local index of particle 3 for each of A constructed +three-particle bonds.

+
+
bonds_3_equilibrium(A,) numpy.ndarray

Equilibrium angle for each of A constructed three-particle +bonds.

+
+
bonds_3_strength(A,) numpy.ndarray

Bond strength for each of A constructed three-particle +bonds.

+
+
bonds_4_atom_1(D,) numpy.ndarray

Local index of particle 1 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_2(D,) numpy.ndarray

Local index of particle 2 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_3(D,) numpy.ndarray

Local index of particle 3 for each of D constructed +four-particle bonds.

+
+
bonds_4_atom_4(D,) numpy.ndarray

Local index of particle 4 for each of D constructed +four-particle bonds.

+
+
bonds_4_coeff(D,) numpy.ndarray

Cosine series coefficients for each of D constructed +four-particle bonds.

+
+
bonds_4_type(D,) numpy.ndarray

Dihedral type for each of D constructed four-particle +bonds.

+
+
bonds_4_last(D,) numpy.ndarray

Flags indicating if dih_type is 1 for each of D +constructed four-particle bonds.

+
+
+
+
+
+

See also

+
+
prepare_bonds_old

Used internally to reconstruct the bonded interactions types from the connectivity information in the structure/topology input file and the bonded types specified in the configuration file.

+
+
+ +
+ +
+
+hymd.force.prepare_bonds_old(molecules, names, bonds, indices, config)[source]
+

Find bonded interactions from connectivity and bond types information

+
+

Deprecated since version 1.0.0: prepare_bonds_old was replaced by prepare_bonds for +use with compiled Fortran kernels prior to 1.0.0 release.

+
+

Prepares the necessary equilibrium and bond strength information needed by +the intramolecular interaction functions. This is performed locally on each +MPI rank, as the domain decomposition ensures that for all molecules all +consituent particles are always contained on the same MPI rankself.

+

This function traverses the bond connectivity information provided in the +structure/topology input file and indentifies any two-, three-, or +four-particle potential bonds. For each connected chain of two, three, or +four particles, a matching to bond types is attempted. If the corresponding +names match, a bond object is initialized.

+

In order to investigate the connectivity, a graph is created using +networkx functionality.

+
+
Parameters:
+
+
molecules(N,) numpy.ndarray

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
names(N,) numpy.ndarray

Array of type names for each of N particles.

+
+
bonds(N,M) numpy.ndarray

Array of M bonds originating from each of N particles.

+
+
indices(N,) numpy.ndarray

Array of integer indices for each of N particles. Global +(across all MPI ranks) or local (local indices on this MPI rank only) +may be used, both, without affecting the result.

+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
bonds_2list

List of lists containing local particle indices, equilibrium +distance, and bond strength coefficient for each reconstructed +two-particle bond.

+
+
bonds_3

List of lists containing local particle indices, equilibrium angle, +and bond strength coefficient for each reconstructed three-particle +bond.

+
+
bonds_4

List of lists containing local particle indices, dihedral type index, +and dihedral coefficients for each reconstructed four-particle +torsional bond.

+
+
bb_indexlist

List indicating the dihedral type of each four-particle bond in +bonds_4.

+
+
+
+
+
+

See also

+
+
Bond

Two-particle bond type dataclass.

+
+
Angle

Three-particle angular bond type dataclass.

+
+
Dihedral

Four-particle torsional bond type dataclass.

+
+
hymd.input_parser.Config

Configuration dataclass handler.

+
+
+ +
+ +
+
+hymd.force.prepare_index_based_bonds(molecules, topol)[source]
+
+ +
+
+hymd.force.propensity_potential_coeffs(x: float)[source]
+
+ +
+
+

4.6. Pressure

+
+
+hymd.pressure.comp_pressure(phi, phi_q, psi, hamiltonian, velocities, config, phi_fourier, phi_laplacian, phi_transfer, positions, bond_pr, angle_pr, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Computes total internal pressure of the system. +Kinetic pressure is trivially calculated from the kinetic energy. +Already computed bond and angle pressure terms are inserted into the +total internal pressure. +The field pressure equation is implemented.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField], (M,)

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type +M. Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computaional grid +is represented by the collective fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
velocities(N, D) numpy.ndarray

Array of velocities of N particles in D dimensions.

+
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
phi_fourierlist[pmesh.pm.ComplexField], (M,)

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computaional grid is represented by the collective fields of all +MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
bond_pr(3,) numpy.ndarray

Total bond pressure due all two-particle bonds.

+
+
angle_pr(3,) numpy.ndarray

Total angle pressure due all three-particle bonds

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pressure(18,) numpy.ndarray

Pressure contributions from various energy terms. +0: due to kinetic energy +1-5: due to field energy +6-8: due to two-particle bonded terms +9-11: due to three-particle bonded terms (called angle terms) +12-14: due to four-particle bonded terms (called dihedral terms) +(defaults to 0 currently. Yet to be implemented) +15-17: total pressure in x,y,z directions.

+
+
+
+
+
+ +
+
+

4.7. Logger

+
+
+class hymd.logger.Logger[source]
+

Log output handler class

+

Notes

+

This wraps the default python library logging, see +docs.python.org/3/library/logging.html.

+
+
Attributes:
+
+
levelint

Determines the verbosity level of the log, corresponding to +logging.level. Numerical values 50 (logging.CRITICAL), +40 (logging.ERROR), 30 +(logging.WARNING), 20 (logging.INFO), +10 (logging.DEBUG), and 0 +(logging.UNSET) are supported values. Any log event message +less severe than the specified level is ignored. All other event +messages are emitted.

+
+
log_filestr

Path to output log file.

+
+
formatstr

Prepended dump string for each log event. Specifies the log event +level, the module emitting the event, the code line, the enclosing +function name, and the MPI rank writing the message.

+
+
date_formatstr

Prepends the date before all log event messages.

+
+
formatterlogging.Formatter

Formatter handling the prepending of the information in format and +date_format to each log event message. Used by default for all +loggers.

+
+
rank0logging.Logger

Default logger object for the root MPI rank.

+
+
all_rankslogging.Logger

Default logger object for messages being emitted from all MPI ranks +simultaneously.

+
+
+
+
+
+
+classmethod setup(default_level=20, log_file=None, verbose=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Sets up the logger object.

+

If a log_file path is provided, log event messages are output +to it. Otherwise, the logging messages are emitted to stdout.

+
+
Parameters:
+
+
default_levelint, optional

Default verbosity level of the logger. Unless specified, it is +10 (logging.INFO).

+
+
log_filestr, optional

Path to output log file. If None or not priovided, no log file is +used and all logging is done to stdout.

+
+
verbosebool, optional

Increases the logging level to 30 (logging.WARNING) +if True, otherwise leaves the logging level unchanged.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterRoot(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the root MPI rank log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+class hymd.logger.MPIFilterAll(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Log output Filter wrapper class for the all-MPI-ranks log

+
+
+filter(record)[source]
+

Log event message filter

+
+
Parameters:
+
+
recordlogging.LogRecord

LogRecord object corresponding to the log event.

+
+
+
+
+
+ +
+ +
+
+

4.8. Input parser

+

Parses and handles the configuration information provided for the simulation

+
+
+class hymd.input_parser.Config(n_steps: int, time_step: float, mesh_size: Union[List[int], numpy.ndarray, int], sigma: float, kappa: float, dtype: Optional[numpy.dtype] = None, box_size: Optional[Union[List[float], numpy.ndarray]] = None, n_print: Optional[int] = None, tau: Optional[float] = None, start_temperature: Optional[Union[float, bool]] = None, target_temperature: Optional[Union[float, bool]] = None, mass: Optional[float] = None, hamiltonian: Optional[str] = None, domain_decomposition: Optional[Union[int, bool]] = None, integrator: Optional[str] = None, respa_inner: int = 1, file_name: str = '<config file path unknown>', name: Optional[str] = None, tags: List[str] = <factory>, bonds: List[hymd.force.Bond] = <factory>, angle_bonds: List[hymd.force.Angle] = <factory>, dihedrals: List[hymd.force.Dihedral] = <factory>, chi: List[hymd.force.Chi] = <factory>, n_particles: Optional[int] = None, max_molecule_size: Optional[int] = None, n_flush: Optional[int] = None, thermostat_work: float = 0.0, thermostat_coupling_groups: List[List[str]] = <factory>, initial_energy: Optional[float] = None, cancel_com_momentum: Union[int, bool] = False, coulombtype: Optional[str] = None, convergence_type: Optional[str] = None, pol_mixing: Optional[float] = None, dielectric_const: Optional[float] = None, conv_crit: Optional[float] = None, dielectric_type: List[hymd.force.Dielectric_type] = <factory>, self_energy: Optional[float] = None, type_charges: Optional[Union[List[float], numpy.ndarray]] = None, rho0: Optional[float] = None, a: Optional[float] = None, pressure: bool = False, barostat: Optional[str] = None, barostat_type: Optional[str] = None, tau_p: Optional[float] = None, target_pressure: List[hymd.barostat.Target_pressure] = <factory>, n_b: Optional[int] = None, m: List[float] = <factory>)[source]
+

Configuration object

+

Handles and verifies the simulation configuration specified in the +configuration file.

+
+

See also

+
+
hymd.input_parser.Bond

Two-particle bond type dataclass.

+
+
hymd.input_parser.Angle

Three-particle bond type dataclass.

+
+
hymd.input_parser.Dihedral

Four-particle bond type dataclass.

+
+
+ +
+
Attributes:
+
+
gas_constantfloat

Constant value of the gas constant, R (equivalently the Boltzmann +constant) in the units used internally in HyMD.

+
+
coulomb_constantfloat

Constant value of the Coulomb constant which converts electric field +values to forces and electric potential values to energies in the units +used internally in HyMD.

+
+
n_steps: int

Number of time steps in the simulation.

+
+
time_step: float

Outer time step used in the simulation. If the rRESPA intergrator is +used, the inner time step (the time step used in the integration of +intramolecular bending, stretching, and torsional forces) is +time_step / respa_inner.

+
+
box_sizelist[float] or (D,) numpy.ndarray

Simulation box size of simulation in D dimensions in units of +nanometers.

+
+
mesh_sizelist[int] or int or numpy.ndarray

Number of grid points used for the discrete density grid.

+
+
sigmafloat

Filter width representing the effective coarse-graining level of the +particles in the simulation.

+
+
kappafloat

Compressibility parameter used in the relaxed incompressibility term in +the interaction energy functional.

+
+
n_printint, optional

Frequency of trajectory/energy output to the H5MD trajectory/energy +output file (in units of number of time steps).

+
+
taufloat, optional

The time scale of the CSVR thermostat coupling.

+
+
start_temperaturefloat, optional

Generate starting temperature by assigning all particle velocities +randomly according to the Maxwell-Boltzmann distribution at +start_temperature Kelvin prior to starting the simulation.

+
+
target_temperaturefloat, optional

Couple the system to a heat bath at target_temperature Kelvin.

+
+
massfloat, optional

Mass of the particles in the simulation.

+
+
hamiltonianstr, optional

Specifies the interaction energy functional \(W[\tilde\phi]\) +for use with the particle-field interactions. Options: +SquaredPhi, DefaultNohChi, or DefaultWithChi.

+
+
domain_decompositionint, optional

Specifies the interval (in time steps) of domain decomposition +exchange, involving all MPI ranks sending and receiving particles +according to the particles’ positions in the integration box and the +MPI ranks’ assigned domain.

+
+
integratorstr, optional

Specifies the time integrator used in the simulation. Options: +velocity-verlet or respa.

+
+
respa_innerint, optional

The number of inner time steps in the rRESPA integrator. This denotes +the number of intramolecular force calculations (stretching, bending, +torsional) are performed between each impulse applied from the field +forces.

+
+
file_namestr, optional

File path of the parsed configuration file.

+
+
namestr, optional

Name for the simulation.

+
+
tagslist[str], optional

Tags for the simulation.

+
+
bondslist[Bond], optional

Specifies harmonic stretching potentials between particles in the +same molecule.

+
+
angle_bondslist[Angle], optional

Specifies harmonic angular bending potentials between particles in the +same molecule.

+
+
dihedralslist[Dihedral], optional

Specifies four-particle torsional potentials by cosine series.

+
+
chilist[Chi], optional

Specifies \(\chi\)-interaction parameters between particle +species.

+
+
n_particlesint, optional

Specifies the total number of particles in the input. Optional keyword +for validation, ensuring the input HDF5 topology has the correct number +of particles and molecules.

+
+
max_molecule_sizeint, optional

Maximum size of any single molecule in the system. Used to speed up +distribution of particles onto MPI ranks in a parallel fashion.

+
+
n_flushint, optional

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be +written to disk (in units of number of n_print).

+
+
thermostat_workfloat

Work performed by the thermostat on the system.

+
+
thermostat_coupling_groupslist[str], optional

Specifies individual groups coupling independently to the CSVR +thermostat. E.g. in a system containing "A", "B", and +"C" type particles, +thermostat_coupling_groups = [["A", "B"], ["C"],] would +thermalise types "A" and "B" together and couple +"C" type particles to a different thermostat (all individual +thermostats are at the same temperature, i.e. target_temperature +Kelvin).

+
+
initial_energyfloat

Value of the total energy prior to the start of the simulation.

+
+
cancel_com_momentumint, optional

If True, the total linear momentum of the center of mass is +removed before starting the simulation. If an integer is specifed, the +total linear momentum of the center of mass is removed every +remove_com_momentum time steps. If False, the linear +momentum is never removed.

+
+
coulombtypestr, optional

Specifies the type of electrostatic Coulomb interactions in the system. +The strength of the electrostatic forces is modulated by the relative +dielectric constant of the simulation medium, specified with the +dielectric_const keyword. Charges for individual particles are +specified in the structure/topology HDF5 input file, not in the +configuration file. If no charges (or peptide backbone dipoles) are +present, the electrostatic forces will not be calculated even if this +keyword is set to "PIC_Spectral".

+
+
dielectric_constfloat, optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. When +using helical propensity dihedrals, this keyword must be specified—even +if electrostatics are not included with the coulombtype +keyword.

+
+
dielectric_type: list[float], optional

Specifies the relative dielectric constant of the simulation medium +which regulates the strength of the electrostatic interactions. The list assigns +relative dielectric values to each bead type, and an anisotropic +dielectric function is obtained from a weighted average.

+
+
+
+
+
+
+a: float = None
+
+ +
+
+angle_bonds: List[hymd.force.Angle]
+
+ +
+
+barostat: str = None
+
+ +
+
+barostat_type: str = None
+
+ +
+
+bonds: List[hymd.force.Bond]
+
+ +
+
+box_size: Union[List[float], numpy.ndarray] = None
+
+ +
+
+cancel_com_momentum: Union[int, bool] = False
+
+ +
+
+chi: List[hymd.force.Chi]
+
+ +
+
+conv_crit: float = None
+
+ +
+
+convergence_type: str = None
+
+ +
+
+coulomb_constant: ClassVar[float] = 138.935458
+
+ +
+
+coulombtype: str = None
+
+ +
+
+dielectric_const: float = None
+
+ +
+
+dielectric_type: List[hymd.force.Dielectric_type]
+
+ +
+
+dihedrals: List[hymd.force.Dihedral]
+
+ +
+
+domain_decomposition: Union[int, bool] = None
+
+ +
+
+dtype: numpy.dtype = None
+
+ +
+
+file_name: str = '<config file path unknown>'
+
+ +
+
+gas_constant: ClassVar[float] = 0.0083144621
+
+ +
+
+hamiltonian: str = None
+
+ +
+
+initial_energy: float = None
+
+ +
+
+integrator: str = None
+
+ +
+
+kappa: float
+
+ +
+
+m: List[float]
+
+ +
+
+mass: float = None
+
+ +
+
+max_molecule_size: int = None
+
+ +
+
+mesh_size: Union[List[int], numpy.ndarray, int]
+
+ +
+
+n_b: int = None
+
+ +
+
+n_flush: int = None
+
+ +
+
+n_particles: int = None
+
+ +
+
+n_print: int = None
+
+ +
+
+n_steps: int
+
+ +
+
+name: str = None
+
+ +
+
+pol_mixing: float = None
+
+ +
+
+pressure: bool = False
+
+ +
+
+respa_inner: int = 1
+
+ +
+
+rho0: float = None
+
+ +
+
+self_energy: float = None
+
+ +
+
+sigma: float
+
+ +
+
+start_temperature: Union[float, bool] = None
+
+ +
+
+tags: List[str]
+
+ +
+
+target_pressure: List[hymd.barostat.Target_pressure]
+
+ +
+
+target_temperature: Union[float, bool] = None
+
+ +
+
+tau: float = None
+
+ +
+
+tau_p: float = None
+
+ +
+
+thermostat_coupling_groups: List[List[str]]
+
+ +
+
+thermostat_work: float = 0.0
+
+ +
+
+time_step: float
+
+ +
+
+type_charges: Union[List[float], numpy.ndarray] = None
+
+ +
+ +
+
+hymd.input_parser.check_NPT_conditions(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check validity of barostat_type, barostat, +a, rho0, target_pressure, tau_p

+
+ +
+
+hymd.input_parser.check_angles(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_bonds(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_box_size(config, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_cancel_com_momentum(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_charges(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if charges across ranks sum to zero.

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of floats with charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_charges_types_list(config, types, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates a list of charge values of length types. +Charges are sorted according to type ID. Used in field.py. +# TODO: this is messy, we should fix it

+
+ +
+
+hymd.input_parser.check_chi(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_config(config, indices, names, types, charges, input_box, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs various checks on the specfied config to ensure consistency

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
indices(N,) numpy.ndarray

Array of integer indices for N particles.

+
+
names(N,) numpy.ndarray

Array of string names for N particles.

+
+
types(N,) numpy.ndarray

Array of integer type indices for N particles.

+
+
charges(N,) numpy.ndarray

Array of floats charges for N particles.

+
+
commmpi4py.Comm, optional

MPI communicator, defaults to mpi4py.COMM_WORLD.

+
+
+
+
Returns:
+
+
configConfig

Validated configuration object.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_dielectric(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Error handling for electrostatics. +Unit testing of toml/tomli input.

+
+ +
+
+hymd.input_parser.check_dihedrals(config, names, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_domain_decomposition(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_hamiltonian(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_integrator(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_m(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_mass(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_max_molecule_size(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_b(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_flush(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_particles(config, indices, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_n_print(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_name(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_start_and_target_temperature(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Validate provided starting and target thermostat temperatures

+

Assesses the provided temperature target and ensures it is a non-negative +floating point number or False. Ensures the starting temperature is +a non-negative floating point number or False.

+

If the value for either is None, the returned configuration object +has the values defaulted to False in each case.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
+
+
Returns:
+
+
validated_configConfig

Configuration object with validated target_temperature and +start_temperature.

+
+
+
+
+
+ +
+
+hymd.input_parser.check_tau(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.check_thermostat_coupling_groups(config, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.parse_config_toml(toml_content, file_path=None, comm=<mpi4py.MPI.Intracomm object>)[source]
+
+ +
+
+hymd.input_parser.read_config_toml(file_path)[source]
+
+ +
+
+hymd.input_parser.sort_dielectric_by_type_id(config, charges, types)[source]
+

Creates a list of length N CG-particles, sorted after the charges from +the input HDF5 file. Used in file_io.py

+
+ +
+
+

4.9. Field

+

Forces and energies from the discretized particle-field grid interactions

+
+
+hymd.field.compute_field_and_kinetic_energy(phi, phi_q, psi, velocity, hamiltonian, positions, types, v_ext, config, layouts, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the particle-field and kinetic energy contributions

+

Calculates the kinetic energy through

+
+\[E_k = \sum_j \frac{1}{2}m_j\mathbf{v}_j\cdot\mathbf{v}_j,\]
+

and the particle-field energy by

+
+\[E_\text{field} = \int\mathrm{d}\mathbf{r}\, + w[\tilde\phi],\]
+

where \(w\) is the interaction energy functional density.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
velocity(N,D) numpy.ndarray

Array of velocities for N particles in D dimensions. +Local for each MPI rank.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Local for each MPI rank–the full computational grid is +represented by the collective fields of all MPI ranks.

+
+
configConfig

Configuration object.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field

Computes the up-to-date external potential for use in calculating the particle-field energy.

+
+
+ +
+ +
+
+hymd.field.compute_field_energy_q_GPE(config, phi_eps, field_q_energy, dot_elec, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the electrostatic energy after electrosatic forces is +calculated.

+

From the definition of the elecrostatic potential \(\Psi\), the energy +is

+
+
+
W = frac{1}{2}intmathrm{d}mathbf{r},

epsilon(mathbf{r})} left(mathbf{E}cdot mathbf{E}right),

+
+
+
+

where \(\epsilon(\mathbf{r})}\) is the anisotropic, spatially dependent, +relative dielectric of the simulation medium.

+
+
Parameters:
+
+
confighymd.input_parser.Config

Configuration object.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
field_q_energyfloat

Total elecrostatic energy.

+
+
dot_elecpmesh.pm.RealField

Pmesh RealField object for storing \(|\mathbf{E(r)}|^{2}\) +on the computational grid. Local for each MPI rank – the full computational +grid is represented by the collective fields of all MPI ranks.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
update_field_force_q_GPE

Compute the electrosatic force from an anisotropic dielectric general Poisson equation.

+
+
+ +
+ +
+
+hymd.field.compute_field_force(layouts, r, force_mesh, force, types, n_types)[source]
+

Interpolate particle-field forces from the grid onto particle positions

+

Backmaps the forces calculated on the grid to particle positions using the +window function \(P\) (by default cloud-in-cell [CIC]). In the +following, let \(\mathbf{F}_j\) denote the force acting on the +particle with index \(j\) and position \(\mathbf{r}_j\). The +interpolated force is

+
+\[\mathbf{F}_j = -\sum_k\nabla V_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(V_{j_k}\) is the discretized external potential at grid vertex +\(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid vertex +with index \(j_k\), and \(h^3\) is the volume of each grid voxel. +The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
r(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
force(N,D) numpy.ndarray

Array of forces for N particles in D dimensions. Local +for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
n_typesint

Number of different unique types present in the simulation system. +n_types is global, i.e. the same for all MPI ranks even if some +ranks contain zero particles of certain types.

+
+
+
+
+
+ +
+
+hymd.field.compute_self_energy_q(config, charges, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Compute the self energy for the interaction due to the Ewald scheme +used to compute the electrostatics. The energy is stored in config.

+

The self interaction energy is given by:

+
+\[U_{self} = \sqrt{\frac{1}{2\pi\sigma^2}} \sum_{i=1}^{N} q_i^2\]
+

where \(q_i\) are the charges and \(\sigma\) is the half-width +of the Gaussian filter.

+
+
Parameters:
+
+
configConfig

Configuration object.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
Returns:
+
+
field_q_self_energyfloat

Electrostatic self energy.

+
+
+
+
+
+ +
+
+hymd.field.domain_decomposition(positions, pm, *args, molecules=None, bonds=None, topol=False, verbose=0, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Performs domain decomposition

+

Rearranges the MPI rank memory layout into one that better mimics the PFFT +pencil grid 2D decomposition. As molecules are always required to be fully +contained on a single MPI rank, a perfect decomposition is not always +possible. The best decomposition which leaves the center of mass of all +molecules in their respective correct domains is used, with possible +overlap into neighbouring domains if the spatial extent of any molecule +crosses domain boundaries.

+
+
Parameters:
+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
*args

Variable length argument list containing arrays to include in the +domain decomposition.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
bonds(N,M) numpy.ndarray, optional

Array of M bonds originating from each of N particles.

+
+
verboseint, optional

Specify the logging event verbosity of this function.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
Domain decomposedcode:positions and any array specified in
+
:code:`*args`, in addition tocode:bonds and molecules if these
+
arrays were provided as input.
+
+
+
+
+ +
+
+hymd.field.initialize_pm(pmesh, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Creates the necessary pmesh objects for pfft operations.

+
+
Parameters:
+
+
pmeshmodule ‘pmesh.pm’
+
configConfig

Configuration dataclass containing simulation metadata and parameters.

+
+
commMPI.Intracomm, optional

MPI communicator to use for rank commuication. Defaults to +MPI.COMM_WORLD.

+
+
+
+
Returns:
+
+
pmobject ‘pmesh.pm.ParticleMesh’
+
field_listlist[pmesh.pm.RealField], (multiple)

Essential list of pmesh objects required for MD

+
+
list_coulomblist[pmesh.pm.RealField], (multiple)

Additional list of pmesh objects required for electrostatics.

+
+
+
+
+
+ +
+
+hymd.field.update_field(phi, phi_laplacian, phi_transfer, layouts, force_mesh, hamiltonian, pm, positions, types, config, v_ext, phi_fourier, v_ext_fourier, m, compute_potential=False)[source]
+

Calculate the particle-field potential and force density

+

If compute_potential is True, the energy may subsequently +be computed by calling compute_field_and_kinetic_energy.

+

Computes the particle-field external potential \(V_\text{ext}\) from +particle number densities through the smoothed density field, +\(\phi(\mathbf{r})\). With \(P\) being the cloud-in-cell (CIC) +window function, the density and filtered densities are computed as

+
+\[\phi(\mathbf{r}) = \sum_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\phi(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +external potential is computed in reciprocal space as

+
+\[V_\text{ext} = \mathrm{FFT}^{-1}\left[ + \mathrm{FFT} + \left( + \frac{\partial w}{\partial \tilde\phi} + \right) + \mathrm{FFT}(H) +\right],\]
+

where \(w\) is the interaction energy functional. Differentiating +\(V_\text{ext}\) is done by simply applying \(i\mathbf{k}\) in +Fourier space, and the resulting forces are back-transformed to direct +space and interpolated to particle positions by

+
+\[\mathbf{F}_j = -\sum_{j_k} \nabla V_{j_k} + P(\mathbf{r}_{j_k} - \mathbf{r}_j)h^3,\]
+

where \(j_k\) are the neighbouring vertices of particle \(j\) at +position \(\mathbf{r}_j\), and \(h^3\) is the volume of each grid +voxel.

+
+
Parameters:
+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
phi_laplacianlist[pmesh.pm.RealField], (M, 3)

Like phi, but containing the laplacian of particle number densities.

+
+
phi_transferlist[pmesh.pm.ComplexField], (3,)

Like phi_fourier, used as an intermediary to perform FFT operations +to obtain the gradient or laplacian of particle number densities.

+
+
layoutslist[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
force_meshlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +force density values on the computational grid; D fields in D +dimensions for each particle type. Pre-allocated, but empty; any values +in this field are discarded. Changed in-place. Local for each MPI +rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
configConfig

Configuration object.

+
+
v_extlist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle-field +external potential values on the computational grid; one for each +particle type. Pre-allocated, but empty; any values in this field are +discarded Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
phi_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplexField objects containing discretized particle +number density values in reciprocal space on the computational grid; +one for each particle type. Pre-allocated, but empty; any values in +this field are discarded Changed in-place. Local for each MPI rank–the +full computational grid is represented by the collective fields of all +MPI ranks.

+
+
v_ext_fourierlist[pmesh.pm.ComplexField]

Pmesh ComplesField objects containing discretized +particle-field external potential values in reciprocal space on the +computational grid; D+1 fields in D dimensions for each +particle type. D copies are made after calculation for later +use in force calculation, because the force transfer function +application differentiates the field in-place, ruining the contents +for differentiation in the remaining D-1 spatial directions. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
m: list[float], (M,)

pmesh.pm.ParticleMesh parameter for mass of particles in simulation unit. +Defaults to 1.0 for all particle types.

+
+
compute_potentialbool, optional

If True, a D+1-th copy of the Fourier transformed +external potential field is made to be used later in particle-field +energy calculation. If False, only D copies are made.

+
+
+
+
+
+

See also

+
+
compute_field_and_kinetic_energy

Compute the particle-field energy after the external potential is calculated.

+
+
+ +
+ +
+
+hymd.field.update_field_force_q(charges, phi_q, phi_q_fourier, psi, psi_fourier, elec_field_fourier, elec_field, elec_forces, layout_q, hamiltonian, pm, positions, config)[source]
+

Calculate the electrostatic particle-field forces on the grid

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential is computed in reciprocal space as

+
+\[\Phi = \mathrm{FFT}^{-1}\left[ + \frac{4\pi k_e}{\varepsilon \vert\mathbf{k}\vert^2} + \mathrm{FFT}(\rho)\mathrm{FFT}(H) +\right],\]
+

with the electric field

+
+\[\mathbf{E} = \mathrm{FFT}^{-1}\left[ + -i\mathbf{k}\,\mathrm{FFT}(\Psi) +\right].\]
+

In the following, let \(\mathbf{F}_j\) denote the electrostatic force +acting on the particle with index \(j\) and position +\(\mathbf{r}_j\). The interpolated electrostatic force is

+
+\[\mathbf{F}_j = \sum_k q_j\mathbf{E}_{j_k} + P(\mathbf{r}_{j_k}-\mathbf{r}_j)h^3,\]
+

where \(\mathbf{E}_{j_k}\) is the discretized electric field at grid +vertex \(j_k\), \(\mathbf{r}_{j_k}\) is the position of the grid +vertex with index \(j_k\), and \(h^3\) is the volume of each grid +voxel. The sum is taken over all closest neighbour vertices, \(j_k\).

+
+
Parameters:
+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty; any values in this field +are discarded. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all MPI +ranks.

+
+
elec_field_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +electric field values in reciprocal space on the computational grid. +Pre-allocated, but empty; any values in this field are discarded. +Changed in-place. Local for each MPI rank–the full computational grid +is represented by the collective fields of all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty; any values in this field are discarded. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
+
+
+
+ +
+
+hymd.field.update_field_force_q_GPE(conv_fun, phi, types, charges, phi_q, phi_q_fourier, phi_eps, phi_eps_fourier, phi_eta, phi_eta_fourier, phi_pol_prev, phi_pol, elec_field, elec_forces, elec_field_contrib, psi, Vbar_elec, Vbar_elec_fourier, force_mesh_elec, force_mesh_elec_fourier, hamiltonian, layout_q, layouts, pm, positions, config, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Calculate the electrostatic particle-field forces on the grid, arising from +a general Poisson equation, i.e. anisotropic permittivity/dielectric. +The function is called when tomli input config.coulombtype = “PIC_Spectral_GPE.”

+

Computes the electrostatic potential \(\Psi\) from particle charges +through the smoothed charge density \(\tilde\rho\). With \(P\) +being the cloud-in-cell (CIC) window function, the charge density and +filtered charge densities are computed as

+
+\[\rho(\mathbf{r}) = \sum_i q_i P(\mathbf{r}-\mathbf{r}_i),\]
+

and

+
+\[\tilde\rho(\mathbf{r}) = \int\mathrm{x}\mathbf{r}\, + \rho(\mathbf{x})H(\mathbf{r}-\mathbf{x}),\]
+

where \(H\) is the grid-independent filtering function. The +electrostatic potential for a variable dielectric does not have an +analytical expression, and is computed in reciprocal through an iterative +method.

+

The GPE states that

+
+\[\nabla \cdot \left(\epsilon(\mathbf{r}) +\nabla{\mathbf{\psi(r)}}\right) = -\rho({\mathbf{r}}).\]
+

where \(\epsilon(\mathbf{r})\) is the relative dielectric function.

+
+
Parameters:
+
+
conv_funConvergence function.

Returns a scalar. Depends on MPI allreduce for similar convergence +across MPI ranks.

+
+
philist[pmesh.pm.RealField]

Pmesh RealField objects containing discretized particle number +density values on the computational grid; one for each particle type. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
types(N,) numpy.ndarray

Array of type indices for each of N particles. Local for each +MPI rank.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles. Local for each +MPI rank.

+
+
phi_qpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +charge density density values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_q_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed charge density values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_epspmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +relative dielectric values on the computational grid. Pre-allocated, +but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
phi_eps_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing calculated discretized +Fourier transformed relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_etapmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +gradients of the relative dielectric values on the computational grid. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank–the +full computational grid is represented by the collective fields of all MPI ranks.

+
+
phi_eta_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated discretized +Fourier transformed gradient relative dielectric values in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_pol_prevpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charge values on the computational grid. Parameter in +the iterative method.Pre-allocated,but empty. Changedin-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
phi_polpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +polarization charges on the computational grid. Parameter in the iterative +method, updating the next quess in solving for the electrostatic potential. +Pre-allocated,but empty. Changed in-place.Local for each MPI rank– +the full computational grid is represented by the collective fields of +all MPI ranks.

+
+
elec_fieldpmesh.pm.RealField

Pmesh RealField object for storing calculated discretized +electric field values on the computational grid. Pre-allocated, +but empty. Changed in-place. Local for each MPI rank–the full +computational grid is represented by the collective fields of all +MPI ranks.

+
+
elec_forces(N,D) numpy.ndarray

Array of electrostatic forces on N particles in D +dimensions.

+
+
elec_field_contribpmesh.pm.RealField

Pmesh RealField object for storing +\(|\mathbf{E(r)}|^2/\phi_{0}\) on the computational grid. +Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
psipmesh.pm.RealField

Pmesh RealField object for storing electrostatic potential +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
Vbar_elecmesh.pm.RealField

Pmesh RealField object for storing functional derivatives of +:math:`|w({ phi })_{elec}`on the computational grid. +Pre-allocated, but empty. Changed in-place. Local for each MPI rank– +the full computational grid is represented by the collective fields of

+
+

all MPI ranks.

+
+
+
Vbar_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated functional +derivatives of \(\|w(\{ \phi \})_{elec}\) in reciprocal space on the +computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank–the full computational grid is represented +by the collective fields of all MPI ranks.

+
+
force_mesh_elecpmesh.pm.RealField

Pmesh RealField object for storing electrostatic force values +on the computational grid. Pre-allocated, but empty. Changed in-place. +Local for each MPI rank– the full computational grid is represented by +the collective fields of all MPI ranks.

+
+
force_mesh_elec_fourierpmesh.pm.ComplexField

Pmesh ComplexField object for storing the calculated electrostatic +force values in reciprocal space on the computational grid. Local for +each MPI rank–the full computational grid is represented by the collective +fields of all MPI ranks.

+
+
hamiltonianHamiltonian

Particle-field interaction energy handler object. Defines the +grid-independent filtering function, \(H\).

+
+
layout_qpmesh.domain.Layout

Pmesh communication layout object for domain decomposition of the full +system. Used as blueprint by pmesh.pm.paint and +pmesh.pm.readout for exchange of particle information across +MPI ranks as necessary.

+
+
layouts: list[pmesh.domain.Layout]

Pmesh communication layout objects for domain decompositions of each +particle type. Used as blueprint by pmesh.pm.readout for +exchange of particle information across MPI ranks as necessary.

+
+
pmpmesh.pm.ParticleMesh

Pmesh ParticleMesh object interfacing to the CIC window +function and the PFFT discrete Fourier transform library.

+
+
positions(N,D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank.

+
+
confighymd.input_parser.Config

Configuration object.

+
+
comm: mpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
compute_field_energy_q_GPE

Compute the electrostatic energy after electrosatic force is calculated for a variable (anisotropic) dielectric general Poisson equation.

+
+
+ +
+ +
+
+

4.10. File input/output

+

Handle file input/output in parllel HDF5 fashion

+
+
+class hymd.file_io.OutDataset(dest_directory, config, double_out=False, disable_mpio=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

HDF5 dataset handler for file output

+
+
+close_file(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Closes the HDF5 output file

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+
+flush()[source]
+

Flushes output buffers, forcing file writes

+
+ +
+
+is_open(comm=<mpi4py.MPI.Intracomm object>)[source]
+

Check if HDF5 output file is open

+
+
Parameters:
+
+
commmpi4py.Comm

MPI communicator to use for rank communication.

+
+
+
+
+
+ +
+ +
+
+hymd.file_io.distribute_input(in_file, rank, size, n_particles, max_molecule_size=201, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Assign global arrays onto MPI ranks, attempting load balancing

+

Distributes approximately equal numbers of particles (workload) onto each +independent MPI rank, while respecting the requirement that any molecule +must be fully contained on a single MPI rank only (no splitting molecules +across multiple CPUs).

+
+
Parameters:
+
+
in_fileh5py.File

HDF5 input file object.

+
+
rankint

Local rank number for this MPI rank.

+
+
sizeint

Global size of the MPI communicator (number of total CPUs).

+
+
n_particlesint

Total number of particles.

+
+
max_molecule_sizeint, optional

Maximum size of any molecule present in the system. Used to initially +guess where the MPI rank boundaries (start/end indices) in the global +arrays should be placed. If molecules of size +>max_molecule_size exist in the simulation system, HyMD +might work as expected. Or it might fail spectacularly.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
Returns:
+
+
rank_range

Starting and ending indices in the global arrays for each MPI rank.

+
+
+
+
+
+ +
+
+hymd.file_io.setup_time_dependent_element(name, parent_group, n_frames, shape, dtype, units=None)[source]
+

Helper function for setting up time-dependent HDF5 group datasets

+

All output groups must adhere to the H5MD standard, meaning a structure of

+
+
┗━ group particle group (e.g. all) or observables group
+
+
┗━ group time-dependent data
+
+
┣━ dataset step shape=(n_frames,)
+
┣━ dataset time shape=(n_frames,)
+
┗━ dataset value shape=(n_frames, *)
+
+
+
+

is necessary.

+

References

+
+
H5MD specification :

https://www.nongnu.org/h5md/h5md.html

+
+
+
+ +
+
+hymd.file_io.store_data(h5md, step, frame, indices, positions, velocities, forces, box_size, temperature, pressure, kinetic_energy, bond2_energy, bond3_energy, bond4_energy, field_energy, field_q_energy, plumed_bias, time_step, config, velocity_out=False, force_out=False, charge_out=False, plumed_out=False, dump_per_particle=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Writes time-step data to HDF5 output file

+

Handles all quantities which change during simulation, as opposed to +static quanitities (see store_static).

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
stepint

Step number.

+
+
frameint

Output frame number (step // n_print).

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
positions(N,) numpy.ndarray

Array of positions for N particles in D dimensions.

+
+
velocities(N,) numpy.ndarray

Array of velocities for N particles in D dimensions.

+
+
forces(N,) numpy.ndarray

Array of forces for N particles in D dimensions.

+
+
box_size(D,) numpy.ndarray

Array containing the simulation box size.

+
+
temperaturefloat

Calculated instantaneous temperature.

+
+
kinetic_energyfloat

Calculated instantaneous kinetic energy.

+
+
bond2_energyfloat

Calculated instantaneous harmonic two-particle bond energy.

+
+
bond3_energyfloat

Calculated instantaneous harmonic angular three-particle bond energy.

+
+
bond4_energyfloat

Calculated instantaneous dihedral four-particle torsion energy.

+
+
field_energyfloat

Calculated instantaneous particle-field energy.

+
+
field_q_energyfloat

Calculated instantaneous electrostatic energy.

+
+
plumed_biasfloat

PLUMED instantaneous bias energy.

+
+
time_stepfloat

Value of the time step.

+
+
configConfig

Configuration object.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charge_outbool, optional

If True, electrostatic energies are written to the output +HDF5 file.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to the output HDF5 file.

+
+
dump_per_particlebool, optional

If True, all quantities are written per particle.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
store_static

Outputs all static time-independent quantities to the HDF5 output file

+
+
+ +
+ +
+
+hymd.file_io.store_static(h5md, rank_range, names, types, indices, config, bonds_2_atom1, bonds_2_atom2, molecules=None, velocity_out=False, force_out=False, charges=False, dielectrics=False, plumed_out=False, comm=<mpi4py.MPI.Intracomm object>)[source]
+

Outputs all static time-independent quantities to the HDF5 output file

+
+
Parameters:
+
+
h5mdOutDataset

HDF5 dataset handler.

+
+
rank_rangelist[int]

Start and end indices for global arrays for each MPI rank.

+
+
names(N,) numpy.ndarray

Array of names for N particles.

+
+
types(N,) numpy.ndarray

Array of type indices for N particles.

+
+
indices(N,) numpy.ndarray

Array of indices for N particles.

+
+
configConfig

Configuration object.

+
+
bonds_2_atom1(B,) numpy.ndarray

Array of indices of the first particle for B total +two-particle bonds.

+
+
bonds_2_atom2(B,) numpy.ndarray

Array of indices of the second particle for B total +two-particle bonds.

+
+
molecules(N,) numpy.ndarray, optional

Array of integer molecule affiliation for each of N particles. +Global (across all MPI ranks) or local (local indices on this MPI rank +only) may be used, both, without affecting the result.

+
+
velocity_outbool, optional

If True, velocities are written to output HDF5 file.

+
+
force_outbool, optional

If True, forces are written to output HDF5 file.

+
+
charges(N,) numpy.ndarray

Array of particle charge values for N particles.

+
+
dielectrics(N,) numpy.ndarray

Array of particle relative dielectric values for N particles.

+
+
plumed_outbool, optional

If True, PLUMED bias is written to output HDF5 file.

+
+
commmpi4py.Comm

MPI communicator to use for rank commuication.

+
+
+
+
+
+

See also

+
+
prepare_bonds

Constructs two-, three-, and four-particle bonds from toplogy input file and bond configuration information.

+
+
distribute_input

Distributes input arrays onto MPI ranks, attempting load balancing.

+
+
+ +
+ +
+
+

4.11. PLUMED

+

Class to wrap PLUMED for use within HyMD.

+
+
+class hymd.plumed.PlumedBias(config, plumeddat, logfile, intracomm=<mpi4py.MPI.Intracomm object>, intercomm=None, verbose=1)[source]
+

PLUMED handler class

+

Notes

+

This wraps the Plumed() class, see +https://github.com/plumed/plumed2/tree/master/python.

+

The PlumedBias() object is created with the arguments from +__init__ and at everystep the methods prepare() and +calc() should be called.

+
+
Attributes:
+
+
plumed_objplumed.Plumed

Plumed object used to pass and request information from PLUMED.

+
+
plumed_forces(N, D) numpy.ndarray

Array of forces of N particles in D dimensions. +After calc(), this array contains only the forces due +to the PLUMED bias.

+
+
positions(N, D) numpy.ndarray

Array of positions for N particles in D dimensions. +Local for each MPI rank. +Needed because we need C-contiguous array for passing to PLUMED.

+
+
plumed_bias(1,) numpy.ndarray

Used as a pointer to an double to store the bias energy.

+
+
plumed_version(1,) numpy.ndarray

Used as a pointer to an int to store PLUMED API version.

+
+
intracommmpi4py.Comm

MPI communicator to use for rank communication within a replica.

+
+
intercommmpi4py.Comm

MPI communicator to use for rank communication between replicas.

+
+
readybool

Stores wether the calc() method can be called or not.

+
+
+
+
+
+
+property api_version
+

Returns the API version got from the PLUMED kernel.

+
+ +
+
+calc(forces, poteng)[source]
+

Passes the energy (which can be set to any value in case +prepare() returns PLUMED doesn’t need it) to get +the forces and energy from the bias.

+
+ +
+
+finalize()[source]
+

Finalize object

+
+ +
+
+prepare(step, forces, positions, indices, config, charges)[source]
+

Set the pointers to positions and forces, and returns +wether the potential energy is being requested by PLUMED or not.

+
+ +
+ +
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/doc_pages/benchmarks.html b/v2.2.0/doc_pages/benchmarks.html new file mode 100644 index 00000000..2ca20996 --- /dev/null +++ b/v2.2.0/doc_pages/benchmarks.html @@ -0,0 +1,322 @@ + + + + + + + 3. Benchmarks — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Benchmarks

+

Homopolymer melt test systems of \(30^2\), \(40^2\), and \(50^2\) +nanometers containing 224 k, 533 k, and 1.04 M particles, respectively.

+
+

3.1. Bonded forces

+

Legend label denotes the number of particles in the system.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-1.png +
+
+
+

3.2. Particle–field forces

+

Legend label denotes the number of mesh grid points used in the FFT, essentially +the energy conservation precision of the method.

+

(Source code, png, hires.png, pdf)

+
+../_images/benchmarks-2.png +
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/doc_pages/command_line.html b/v2.2.0/doc_pages/command_line.html new file mode 100644 index 00000000..8f56e245 --- /dev/null +++ b/v2.2.0/doc_pages/command_line.html @@ -0,0 +1,385 @@ + + + + + + + 5. Command line arguments — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. Command line arguments

+

Certain options are provided to HyMD as command line arguments. Besides input +and output file specifications, these options mostly constitute debugging +options such as disabling all bonded or particle–field interactions.

+
+

5.1. Required arguments

+
+
configuration file:
+

type positional

+

Specifies the .toml format configuration file containing simulation details. See Configuration file for details.

+
+
structure and topology file:
+

type positional

+

Specifies the positions, indices, names (and optionally molecular affiliation, bond structure, velocities). See Topology and structure file for details.

+
+
+
+
+

5.2. Optional arguments

+
+
-v  --verbose

type optional

+

Number of following arguments: 0 or 1

+

Determines the verbosity of the simulation logger. More verbose means more text output during runs. Verbosity may be increased by specifying -v or --verbose with no additional specification. This increases verbosity level by 1. Alternatively, it maye be specified by --verbose V with V being 0, 1, or 2.

+
+
--profile

type optional

+

Number of following arguments: 0

+

Enables code profiling using cProfile. This will output one profiling file per MPI rank invoked in the simulation.

+
+
--double-precision

type optional

+

Number of following arguments: 0

+

Specify usage of double precision internally in HyMD (including in the FFTs).

+
+
--double-output

type optional

+

Number of following arguments: 0

+

Specify usage of double precision in the output trajectory from HyMD.

+
+
--velocity-output

type optional

+

Number of following arguments: 0

+

Specify that velocities should be output to the HyMD trajectory.

+
+
--force-output

type optional

+

Number of following arguments: 0

+

Specify that forces should be output to the HyMD trajectory.

+
+
--disable-mpio

type optional

+

Number of following arguments: 0

+

Specify that a non-MPI-enabled HDF5 library is to be used, foregoing the parallel file IO capabilities of h5py. This is normally used as a compatibility option for machines on which installing MPI-enabled HDF5 is difficult.

+
+
--logfile

type optional

+

Number of following arguments: 1

+

Specifies the path of a plain text log file in which stdout is mirrored during simulation runs.

+
+
--seed

type optional

+

Number of following arguments: 1

+

Specifies the random seed used in the numpy random library to generate velocities, thermostatting, etc.

+
+
--disable-bonds

type optional

+

Number of following arguments: 0

+

Disable any two-particle bonds present in the system.

+
+
--disable-angle-bonds

type optional

+

Number of following arguments: 0

+

Disable any three-particle bonds present in the system.

+
+
--disable-dihedrals

type optional

+

Number of following arguments: 0

+

Disable any four-particle bonds present in the system.

+
+
--disable-dipole

type optional

+

Number of following arguments: 0

+

Disable any topological reconstruction of peptide backbone dipoles present in the system.

+
+
--disable-field

type optional

+

Number of following arguments: 0

+

Disable any particle–field interactions present in the system.

+
+
--plumed

type optional

+

Input file for PLUMED when using the PLUMED interface. See PLUMED interface for details.

+
+
:code:`–plumed-outfile

type optional

+

Name of PLUMED output file when running a simulation using PLUMED.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/doc_pages/config_file.html b/v2.2.0/doc_pages/config_file.html new file mode 100644 index 00000000..bcf1115f --- /dev/null +++ b/v2.2.0/doc_pages/config_file.html @@ -0,0 +1,512 @@ + + + + + + + 3. Configuration file — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Configuration file

+

The HyMD configuration file specifies all aspects of the simulation, including +temperature coupling, bond specifications and strengths, the hPF interaction +energy potential, the integrator, and more. The keywords may be given in any +order.

+

The configuration file is a toml format file with keywords (strings) and +values (strings, numbers, arrays, etc.) which is serialised and parsed to +configure simulation runs.

+
+

3.1. Configuration file keywords

+

The following constitutes every possible keyword specification in HyMD +configuration files:

+
+

3.1.1. Metadata keywords

+

Configuration keywords specifying metadata for the H5MD output trajectory.

+
+
name:
+

string [optional, default: None]

+

Name for the simulation. Optional keyword specifying a name in the metadata for the H5MD output trajectory/energy file.

+
+
tags:
+

array [string] [optional, default: None]

+

Tags for the simulation. Optional keyword specifying metadata tags for the H5MD output trajectory/energy file.

+
+
+
+
+

3.1.2. Particle keywords

+

Configuration keywords specifying properties of particles and molecules in the +system.

+
+
n_particles:
+

integer [optional, default: None]

+

Specifies the total number of particles in the input. Optional keyword for validation, ensuring the input HDF5 topology has the correct number of particles and molecules.

+
+
mass:
+

float [optional, default: 72.0] {units: \(\text{u}=\text{g}\,\text{mol}^{-1}\)}

+

Mass of the particles in the simulation. Unless masses are provided in the HDF5 topology/structure file, all masses are assumed equal.

+
+
max_molecule_size:
+

integer [optional, default: 201]

+

Maximum size of any single molecule in the system. Used to speed up distribution of particles onto MPI ranks in a parallel fashion. The code will crash if there are molecules larger than max_molecule_size in the topology/structure input file.

+
+
+
+
+

3.1.3. Simulation keywords

+

Configuration keywords specifying simulation parameters.

+
+
n_steps:
+

integer [required]

+

Total number of integration steps to perform for this simulation.

+
+
n_print:
+

integer or boolean [optional, default: False]

+

Frequency of trajectory/energy output to the H5MD trajectory/energy output file (in units of number of time steps).

+
+
n_flush:
+

integer [optional, default: None]

+

Frequency of HDF5 write buffer flush, forcing trajectory/energy to be written to disk (in units of number of n_print, i.e. n_print = 13, n_flush = 3 would result in the trajectory/energy being written to disk every 13 x 3 = 39 simulation steps)

+
+
time_step:
+

float [required] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time step per integration step. If the rRESPA multiple time step integrator is used (integrator = "respa"), this specifies the inner time step, i.e. the step size used for the intramolecular force integration. In that case, the step size for the field force impulses is respa_inner times the time_step , and the total simulation time is n_steps times time_step times respa_inner .

+
+
box_size:
+

array [float] [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Size of the simulation box. Any particle outside the box is placed inside before the first time step is integrated, meaning no particles will be lost if the box size is specified too small, but the system may nevertheless be unstable.

+
+
integrator:
+

string [required] (options: velocity-verlet or respa)

+

Specifies the time integrator used in the simulation. If respa, the reversible reference system propagator algorithm (rRESPA) [Tuckerman et al., 1992] integrator is used, with respa_inner number of inner (intramolecular force) time steps. If velocity-verlet, a normal Velocity Verlet integrator is used. If respa and respa_inner = 1, the rRESPA integrator is equivalent to the Velocity Verlet.

+
+
respa_inner:
+

integer [optional, default: 1]

+

The number of inner time steps in the rRESPA integrator. This denotes the number of intramolecular force calculations (stretching, bending, torsional) are performed between each impulse applied from the field forces.

+
+
domain_decomposition:
+

integer or boolean [optional, default: False]

+

Specifies the interval (in time steps) of domain decomposition exchange, involving all MPI ranks sending and receiving particles according to the particles’ positions in the integration box and the MPI ranks’ assigned domain. Performing the decomposition is expensive in terms of MPI communication cost, but may reduce the communication of particle positions across MPI rank boundaries for some time during simulation. If True, the decomposition is performed once (before starting the simulation). If False, no decomposition is performed.

+
+
cancel_com_momentum:
+

integer or boolean [optional, default: False]

+

If True, the total linear momentum of the center of mass is removed before starting the simulation. If an integer is specifed, the total linear momentum of the center of mass is removed every remove_com_momentum time steps. If False, the linear momentum is never removed.

+
+
start_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Generate starting temperature by assigning all particle velocities randomly according to the Maxwell-Boltzmann distribution at start_temperature Kelvin prior to starting the simulation. If False, the velocities are not changed before starting the simulation.

+
+
target_temperature:
+

float or boolean [optional, default: False] {units: \(\text{K}\)}

+

Couple the system to a heat bath at target_temperature Kelvin by applying a Canonical sampling through velocity rescaling [Bussi et al., 2007] thermostat with coupling strength tau. If False, no temperature control is applied.

+
+
tau:
+

float [optional, default: 0.7] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the CSVR thermostat coupling. In the limit of tau , the Hamiltonian dynamics are preserved and no temperature coupling takes place.

+
+
thermostat_coupling_groups:
+

array [array [string]] [optional, default: []]

+

Specifies individual groups coupling independently to the CSVR thermostat. E.g. in a system containing "A", "B", and "C" type particles, thermostat_coupling_groups = [["A", "B"], ["C"],] would thermalise types "A" and "B" together and couple "C" type particles to a different thermostat (all individual thermostats are at the same temperature, i.e. target_temperature Kelvin).

+
+
hamiltonian:
+

string [optional, default: "DefaultNohChi"] (options: SquaredPhi, DefaultNohChi, or DefaultWithChi)

+

Specifies the interaction energy functional \(W[\tilde\phi]\) for use with the particle-field interactions. See Interaction energy functionals for details.

+
+
+
+
+

3.1.4. Field keywords

+

Configuration keywords specifying field parameters.

+
+
mesh_size:
+

array [integer] or integer [required]

+

Either an integer or an array of three integers specifying the mesh grid size to use in each of the three spatial directions for the FFT operations. The grid spacing is box_size / mesh_size.

+
+
kappa:
+

float [required] {units: \(\text{kJ}^{-1}\text{mol}\)}

+

Compressibility parameter used in the relaxed incompressibility term in the interaction energy functional \(W[\tilde\phi]\). See Interaction energy functionals for more details.

+
+
sigma:
+

float [required] {units: \(\text{nm}=10^{-9}~\text{m}\)}

+

Filter width, representing the effective coarse-graining level of the particles in the simulation. If a Gaussian filter is used (by default), this specifies the standard deviation. See Filtering for more details.

+
+
chi:
+

array [array [string, float]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\)}

+

Array of \(\tilde\chi_\text{AB}\)-parameters indicating the strength of the repulsive or attractive interaction between particles of type "A" and the number density due to particles of type "B", and vice versa. Example: chi = [ ["A", "B", 7.28], ["C", "D", -1.32] ] would specify a repulsive "A""B" type interaction, and a weakly attractive "C""D" interaction. Self-interaction \(\tilde\chi\)-terms are always zero. See Interaction energy functionals for more details.

+
+
+
+
+

3.1.5. Bond keywords

+

Configuration keywords specifying bonds and bonds parameters.

+
+
bonds:
+

array [array [2 string, 2 float]] [optional, default: []] {units: \(\text{nm}=10^{-9}~\text{m}\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+

Specifies harmonic stretching potentials between particles in the same molecule. Each entry in the array specifies one bond between two types of particles, followed by the equilibrium distance and the bond stiffness. Example: bonds = [ ["A", "A", 0.47, 980.0], ["A", "B", 0.31, 1250.0] ] indicates a "A""A" bond of equilibrium length 0.47 \(\text{nm}\) with a bond strength of 980.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding bond between "A" and "B" type particles with equilibrium length 0.31 \(\text{nm}\) and a strength of 1250.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify stretching bonds.

+
+
angle_bonds:
+

array [array [3 string, 2 float]] [optional, default: []] {units: \({}^\circ\) and \(\text{kJ}\,\text{mol}^{-1}\)}

+
+

Specifies harmonic angular bending potentials between particles in the same molecule. Each entry in the array specifies one bond between three types of particles, followed by the equilibrium angle (in degrees) and the angle bond stiffness. Example: bonds = [ ["A", "A", "A", 180.0, 55.0], ["A", "B", "B", 120.0, 25.0] ] indicates a "A""A""A" angular bond that tries to keep the bond linear at 180 degrees with a bending strength of 55.0 \(\text{kJ}\,\text{mol}^{-1}\) and a corresponding angle bond between "A""B""B" prefering the angle at 120 degrees and a strength of 25.0 \(\text{kJ}\,\text{mol}^{-1}\). See Intramolecular bonds for details about how to specify angular bonds.

+
+
+
dihedrals:
+

array [array [4 string, integer, COSINE SERIES ]] [optional, default: []] {units: \(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)}

+

Specifies four-particle torsional potentials by cosine series. See Intramolecular bonds for details about how to specify dihedrals.

+
+
+
+
+

3.1.6. Electrostatic keywords

+

Configuration keywords specifying electrostatics and electrostatic parameters.

+
+
coulombtype:
+

string [optional, default: None] (options: PIC_Spectral)

+

Specifies the type of electrostatic Coulomb interactions in the system. The strength of the electrostatic forces is modulated by the relative dielectric constant of the simulation medium, specified with the dielectric_const keyword. Charges for individual particles are specified in the structure/topology HDF5 input file, not in the configuration file. If no charges (or peptide backbone dipoles) are present, the electrostatic forces will not be calculated even if this keyword is set to PIC_Spectral.

+
+
dielectric_const:
+

float [optional, default: None]

+

Specifies the relative dielectric constant of the simulation medium which regulates the strength of the electrostatic interactions. When using helical propensity dihedrals, this keyword must be specified—even if electrostatics are not included with the coulombtype keyword.

+
+
+
+
+

3.1.7. Pressure keywords

+

Configuration keywords specifying pressure and barostat parameters.

+
+

3.1.7.1. Simulation keywords

+
+
pressure:
+

boolean [optional, default: False]

+

Specifies whether or not to calculate total internal pressure vector.

+
+
barostat:
+

string [optional, default: None](options: isotropic or semiisotropic)

+

Specifies whether to apply pressure constraints equally in all 3 Cartesian directions (isotropic) or equally in xy and different in z (semiisotropic).

+
+
barostat_type:
+

string [optional, default: berendsen](options: berendsen or scr)

+

Specifies the type of barostat to use. berendsen is more suitable for equilibration and scr for equilibrium data collection.

+
+
n_b:
+

integer [optional, default: 1]

+

Frequency of barostat call in number of outer rRESPA steps.

+
+
tau_p:
+

float [optional, default: 10 tau if tau < 0.1 else 1.0] {units: \(\text{ps}=10^{-12}~\text{s}\)}

+

The time scale of the barostat coupling.

+
+
target_pressure:
+

array [float] [optional, default: :code:1] {units: bar}

+

Couples the system to an external pressure set to target_pressure.

+
+
+
+
+

3.1.7.2. Field keywords

+
+
rho0:
+

float [optional, default: :code:average density] {units: \(\text{nm}^{-3}\)}

+

Intrinsic parameter corresponding to the specific volume of a coarse-grained particle. Typically: 8.66

+
+
a:
+

float [required] {units: \(\text{nm}^{-3}\)}

+

Calibrated parameter to obtain the correct average density at the target temperature and pressure. Typically: 9.21

+
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/doc_pages/constants_and_units.html b/v2.2.0/doc_pages/constants_and_units.html new file mode 100644 index 00000000..49bab26a --- /dev/null +++ b/v2.2.0/doc_pages/constants_and_units.html @@ -0,0 +1,413 @@ + + + + + + + 6. Constants and Units — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

6. Constants and Units

+

HyMD uses the following units and constants internally and in all input and +output:

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Units

Quantity

Symbol

Unit

length

\(r\)

\(\text{nm}=10^{-9}~\text{m}\)

time

\(t\)

\(\text{ps}=10^{-12}~\text{s}\)

charge

\(q\)

\(e=1.602176634 \cdot 10^{-19}~\text{C}\)

mass

\(m\)

\(\text{u}=1.66053906660 \cdot 10^{-27}~\text{kg}\)

temperature

\(\text{T}\)

\(\text{K}\)

energy

\(E\)

\(\text{kJ}\,\text{mol}^{-1}\)

velocity

\(v\)

\(\text{nm}\,\text{ps}^{-1}=10^3~\text{m}\,\text{s}^{-1}\)

momentum

\(P\)

\(\text{u}\,\text{nm}\,\text{ps}^{-1}=10^3\text{u}\,\text{m}\,\text{s}^{-1}\)

force

\(\mathbf{F}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}\)

pressure

\(p\)

\(\text{bar}=100~\text{kPa}\)

electric potential

\(\Psi\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=0.01036426965~\text{V}\)

electric field

\(\mathbf{E}\)

\(\text{kJ}\,\text{mol}^{-1}\text{nm}^{-1}e^{-1}=1.03642696562 \cdot 10^7~\text{V}\,\text{m}^{-1}\)

compressibility

\(\kappa\)

\(\text{mol}\,\text{kJ}^{-1}\)

field-interaction

\(\tilde\chi\)

\(\text{kJ}\,\text{mol}^{-1}\)

+ + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Constants

Constant

Symbol

Value

gas constant

\(R\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Boltzmann’s constant

\(k_\text{B}\)

\(8.3144621\cdot10^{-3}~\text{kJ}\,\text{mol}^{-1}\text{K}^{-1}\)

Avogadro’s constant

\(N_\text{A}\)

\(6.02214076 \cdot 10^23~\text{mol}^{-1}\)

Vacuum permittivity

\(\varepsilon_0\)

\(8.85418781281 \cdot 10^{-12}~\text{kg}^{-1}\text{m}^{-3}\text{s}^4\,\text{A}^2\)

Coulomb constant

\(k_\text{e}\)

\(138.935458~\text{kJ}\,\text{mol}^{-1}\text{nm}\,e^{-2}\)

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/doc_pages/electrostatics.html b/v2.2.0/doc_pages/electrostatics.html new file mode 100644 index 00000000..cd02b1e4 --- /dev/null +++ b/v2.2.0/doc_pages/electrostatics.html @@ -0,0 +1,334 @@ + + + + + + + 3. Electrostatic interactions — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

3. Electrostatic interactions

+

In the filtered Hamiltonian hPF formalism [] the +particles are intrinsically smeared, filtered density distributions. The +electrostatic interactions between such smeared densities takes on the form of +the long-range part of ordinary particle–mesh Ewald.

+

The charge density is projected onto the computational grid by use of the CIC +window function, and subsequently filtered

+
+\[\tilde\rho =\int\mathrm{d}\mathbf{x}\,H(\mathbf{r}-\mathbf{x})\sum_{i=1}^Nq_i P(\mathbf{r}-\mathbf{r}_i),\]
+

with \(q_i\) being the charge of particle \(i\) and \(H\) is the +filtering function (see Filtering). The value of the charge grid at +vertex \((i,j,k)\) is found by

+
+\[\tilde\rho_{ijk}=\text{FFT}^{-1}[\text{FFT}(\rho)\text{FFT}(H)]\]
+

and the electrostatic potential \(\Psi_{ijk}\)

+
+\[\Psi_{ijk}=\text{FFT}^{-1}\left[\frac{k_\text{e}}{|\mathbf{k}^2|}\text{FFT}(\rho)\text{FFT}(H)\right],\]
+

where \(k_\text{e}\) is the Coulomb constant \(1/4\pi\varepsilon_0\). +The electric field is obtained by differentiation of the electrostatic +potential in Fourier space,

+
+\[\mathbf{E}_{ijk}=\text{FFT}^{-1}[-i\mathbf{k}\text{FFT}(\Psi)]\]
+

from which the forces are interpolated back to the particle positions.

+
+

3.1. Specifying electrostatics

+

In HyMD, electrostatics are specified by the coulombtype and +dielectric_const keywords in the configuration file (see +Configuration file) and the /charge dataset in the HDF5 format +structure/topology input file (see Topology and structure file). In addition, the +helical propensity peptide dihedral type induces topological reconstruction +of peptide dipoles which adds electrostatic interactions.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/doc_pages/examples.html b/v2.2.0/doc_pages/examples.html new file mode 100644 index 00000000..5b1bb303 --- /dev/null +++ b/v2.2.0/doc_pages/examples.html @@ -0,0 +1,782 @@ + + + + + + + 1. Examples — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Examples

+

The following examples are ordered in more or less order of increasing +complexity, adding pieces at each step until we arrive at models for realistic +soft matter systems. All files (input and simulation output trajectories) are +available in the HyMD-tutorial github repository.

+
+

1.1. Ideal gas

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_gas/ideal_gas.png?raw=true +

The simplest possible system is one with no interactions at all—intramolecular +or intermolecular. A minimal configuration file for a non-interacting system +may look like:

+
+
ideal_gas.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = false         # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+
+
+

A simple input structure/topology file ideal_gas.HDF5 is available in +the HyMD-tutorial/ideal_gas github repository (along with the code to +generate it). Run the (very) short simulation by

+
python3 -m hymd ideal_gas.toml ideal_gas.HDF5 --disable-field   \
+                                              --velocity-output \
+                                              --force-output
+
+
+

with the --disable-field argument to completely turn off all +particle–field interactions. Adding the options to output the velocities and +forces to the trajectory file, enables examining the ballistic motion of the +particles. See the accompanying Jupyter notebook ideal_gas.ipynb for details.

+
+
+

1.2. Ideal chains

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/ideal_chain/100ps.png?raw=true +

The simplest available interaction is the harmonic two-particle bond (see +Intramolecular bonds),

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2.\]
+

Extending the configuration file from the ideal gas case, we need to add a +bonds specification. Note that the [bonds] meta specifier is not +necessary, but may be used to help organise the input file.

+
+
ideal_chain.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+
+
+

A simple input structure/topology file ideal_chain.HDF5 with a few +coiled up ideal chain polymers is available in the +HyMD-tutorial/ideal_chain github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field
+
+
+

we may examine the radius of gyration of the individual polymer chains. An +example of this is shown in the accompanying Jupyter notebook +ideal_chain.ipynb.

+
+
+

1.3. Stiff rods

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/rods/rods.png?raw=true +

Having considered two-particle bonds, the next step is three-particle angular +bonds depending on the i--j--k angle \(\theta\) (see +Intramolecular bonds),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2.\]
+

Extending the configuration file from the ideal chain case, we need to add a +angle_bonds specification. Note that the [bonds] meta specifier +is not necessary, but may be used to help organise the input file.

+
+
rods.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.5, 1000.0],         # (i name, j name, equilibrium length, strength)
+]
+
+angle_bonds = [
+  ["A", "A", "A", 180.0, 100.0],   # (i, j, k, equilibrium angle, strength)
+]
+
+
+
+

A simple input structure/topology file rods.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into rod-like conformations. We may examine the +radius of gyration of the individual polymer chains, and compare it to the +gyration radii of the ideal chain case. An example of this is shown in the +accompanying Jupyter notebook rods.ipynb.

+
+
+

1.4. Helixes

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/helixes/helixes.png?raw=true +

Having considered two- and three-particle bonds, the next step is dihedral +four-particle angular bonds, depending on the angle \(\phi\) between the +i--j--k plane and the j--k--l plane (see Intramolecular bonds),

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n).\]
+

The Cosine series defining the strength and equilibrium conditions of the bond +are given as input in a dihedrals keyword in the configuration file. +The helical dihedral bond is designed for use with peptides and topological +dipole reconstruction, so we need to specify the dielectric_const +keyword even though we are not including electrostatic forces in the current +simulation. Note that the [bonds] meta specifier is not necessary, but +may be used to help organise the input file.

+
+
helixes.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 200                      # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [30.0, 30.0, 30.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultnochi"       # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+dielectric_const = 15.0
+
+[field]
+mesh_size = [1, 1, 1]              # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+
+[bonds]
+bonds = [
+  ["A", "A", 0.31, 10000.0],       # (i name, j name, equilibrium length, strength)
+]
+
+dihedrals = [
+  [
+    ["A", "A", "A", "A"],
+    [
+      [-1],
+      [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+      [0.08, 0.46, 1.65, -0.96, 0.38],
+    ],
+    [1.0]
+  ],
+]
+
+
+
+

A simple input structure/topology file helixes.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/rods github +repository (along with the code to generate it). Running the simulation with

+
python3 -m hymd rods.toml rods.HDF5 --disable-field
+
+
+

the polymer chains extend into helical conformations. An example of this is +shown in the accompanying Jupyter notebook helixes.ipynb.

+
+
+

1.5. Phase separation

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/phase_separation/chi=40_final.png?raw=true +

The simplest field interaction available in HyMD is the interaction between two +monoatomic particles of types A and B. Using the Hamiltonian

+
+\[\mathcal{H}=H_0+W\]
+

with \(\tilde\chi\)–dependent interactions defined by (specified in the +configuration file by hamiltonian = DefaultWithChi):

+
+\[W=\frac{1}{\phi_0}\int\mathrm{d}\mathbf{r}\tilde\chi_{\text{A}-\text{B}}\tilde\phi_\text{A}(\mathbf{r})\tilde\phi_\text{B}(\mathbf{r}) + \frac{1}{2\kappa}\left(\tilde\phi_\text{A}(\mathbf{r})+\tilde\phi_\text{B}\mathbf{r}-\phi_0\right)^2.\]
+
+
phase_separation.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 10000                    # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+start_temperature = 300            # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+
+[field]
+mesh_size = [20, 20, 20]           # FFT grid size
+sigma = 1.0                        # filtering length scale in nm
+kappa = 0.05                       # compressibility in mol/kJ
+chi = [
+  ['A', 'B', 5.0],                 # (name i, name j, strength)
+]
+
+
+
+

A simple input structure/topology file phase_separation.HDF5 containing +an equal number of A type and B type particles is available in +the HyMD-tutorial/phase_separation github repository (along with the code to +generate it). Running the simulation with

+
python3 -m hymd phase_separation.toml phase_separation.HDF5
+
+
+

we may examine the resulting trajectory. In the case of a low interaction +strength \(\tilde\chi\) of 5.0 (below the critical value of +separation) the system remains mixed. However, raising the interaction strength +to 40.0 (well above the critical value) yields a phase separated system. +This may be elucidated by considering the radial distribution function in each +case. An example of this is shown in the accompanying Jupyter notebook +phase_separation.ipynb.

+
+
+

1.6. Diblock copolymers

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/copolymer/copolymer_final.png?raw=true +

Having introduced particle–field interactions, we may now combine bonded and +field terms and make a model of diblock copolymers phase separating under +positive \(\tilde\chi\)–interactions. This simple model contains two- and +three-particle harmonic bonds as well. With the combination of bonded and field +interactions, we may also introduce the rRESPA multiple time step integator with +the integrator = "respa" keyword. Putting the pieces together, the +configuration file may look like the following:

+
+
copolymer.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 15
+n_steps = 2000                     # total simulation steps
+n_print = 2000                     # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [10.0, 10.0, 10.0]      # simulation box size in nm
+start_temperature = 50             # generate starting temperature in Kelvin
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "defaultwithchi"     # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [50, 50, 50]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+chi = [
+  ["A", "B", 30.0],                # (i, j, strength)
+]
+
+[bonds]
+bonds = [
+  ["A", "A", 0.25, 1500.0],        # (i, j, equilibrium length, strength)
+  ["A", "B", 0.25, 1500.0],
+  ["B", "B", 0.25, 1500.0],
+]
+angle_bonds = [
+  ["A", "A", "A", 180.0, 25.0],    # (i, j, k, equilibrium angle, strength)
+  ["B", "B", "B", 180.0, 25.0],
+]
+
+
+
+

A simple input structure/topology file copolymer.HDF5 with a few +coiled up polymer chains is available in the HyMD-tutorial/copolymer github +repository (along with the code to generate it). Each polymer chain is 20 +particles long, with ten A followed by ten B type particles. +Running the simulation with

+
python3 -m hymd copolymer.toml copolymer.HDF5
+
+
+

the polymer chains extend into rod-like conformations in a phase-separating +manner. An example of this is shown in the accompanying Jupyter notebook +copolymer.ipynb.

+
+
+

1.7. Lipid bilayer self-assembly

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/lipid_self_assembly/bilayer.png?raw=true +

Putting together the same pieces as in the diblock copolymer case, we may setup +a model of a phospholipid (DPPC) which self-assembles into a bilayer +conformation. The same ingredients (as in the copolymer system) are present in +the configuration file; harmonic bonds, angular bonds, and field–particle +interactions. In this case, we couple a different thermostat to the solvent and +the lipids via the thermostat_coupling_groups keyword. With parameters +optimised in [Ledum et al., 2020], the configuration file looks like:

+
+
lipid_self_assembly.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 25
+n_steps = 3000
+n_print = 200
+n_flush = 1
+time_step = 0.01
+box_size = [9.96924, 9.96924, 10.03970]
+start_temperature = 323
+target_temperature = 323
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.05
+domain_decomposition = 10001
+cancel_com_momentum = true
+max_molecule_size = 15
+thermostat_coupling_groups = [
+  ["N", "P", "G", "C"],
+  ["W"],
+]
+
+[field]
+mesh_size = [25, 25, 25]
+sigma = 1.0
+chi = [
+  ["C", "W", 42.24],
+  ["G", "C", 10.47],
+  ["N", "W", -3.77],
+  ["G", "W", 4.53],
+  ["N", "P", -9.34],
+  ["P", "G", 8.04],
+  ["N", "G", 1.97],
+  ["P", "C", 14.72],
+  ["P", "W", -1.51],
+  ["N", "C", 13.56],
+]
+
+[bonds]
+bonds = [
+  ["N", "P", 0.47, 1250.0],
+  ["P", "G", 0.47, 1250.0],
+  ["G", "G", 0.37, 1250.0],
+  ["G", "C", 0.47, 1250.0],
+  ["C", "C", 0.47, 1250.0],
+]
+angle_bonds = [
+  ["P", "G", "G", 120.0, 25.0],
+  ["P", "G", "C", 180.0, 25.0],
+  ["G", "C", "C", 180.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

A randomly mixed input structure/topology file +lipid_self_assembly.HDF5 with a few hundred lipids in a roughy +10 x 10 x 10nm box is available in the +HyMD-tutorial/lipid_self_assembly github repository. The simulation box was +previously equilibrated in the Martini model before subsequent mixing of the +contents. Running the simulation

+
python3 -m hymd lipid_self_assembly.toml lipid_self_assembly.HDF5
+
+
+

we can observe spontaneous aggregation into a bilayer conformation in the +sub-nanosecond regime. An example of this is shown in the accompanying Jupyter +notebook lipid_self_assembly.ipynb.

+
+
+

1.8. Peptide in lipid bilayer

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/peptide/peptide.png?raw=true +

Next, we combine the dihedral helical propensity and the lipid model, and model +a single homopolypeptide consisting of alanine amino acids embedded inside a +DOPC phospholipid bilayer.

+

The configuration file is available in the HyMD-tutorial/peptide github +repository (omitted here for brevity).

+

A pre-equilibrated input structure/topology file peptide.HDF5 with a +few hundred lipids in a roughy 20 x 20 x 20nm box is available in the +HyMD-tutorial/peptide github repository. Running the simulation

+
python3 -m hymd peptide.toml peptide.HDF5
+
+
+

we observe the peptide embedded laterally in the membrane in a stable +configuration. An example of this is shown in the accompanying Jupyter +notebook peptide.ipynb.

+
+
+

1.9. SDS

+https://github.com/Cascella-Group-UiO/HyMD-tutorial/blob/main/sds/oblate.png?raw=true +

The last part we introduce is explicit electrostatic interactions through +particle–mesh Ewald. Enabling the electrostatic calculations is done via the +coulombtype keyword. "PIC_Spectral" is the only supported +value in the released version of the code (more general variants are in +development). We specify the relative dielectric constant of the simulation +medium via the dielectric_const keyword. As an example system, we use +a model for sodium dodecyl sulfate (SDS), consiting of short four-particle +chains with the head group carrying charge of negative one. We add sodium +counter-ions to ensure stability of the Ewald scheme by neutralising the total +system charge.

+
+
sds.toml
+
[simulation]
+integrator = "respa"
+respa_inner = 10
+n_steps = 3000
+n_print = 1500
+n_flush =
+time_step = 0.01
+box_size = [8.3, 8.3, 8.3]
+start_temperature = 298
+target_temperature = 298
+tau = 0.1
+hamiltonian = "defaultwithchi"
+kappa = 0.1
+domain_decomposition = 10000
+cancel_com_momentum = true
+max_molecule_size = 5
+thermostat_coupling_groups = [
+  ["S", "C"],
+  ["W", "Na"],
+]
+dielectric_const = 45.0              # dielectric constant for the simulation medium
+coulombtype = "PIC_Spectral"         # particle in cloud, spectral method
+
+[field]
+mesh_size = [64, 64, 64]
+sigma = 0.5
+chi = [
+  ["S", "C",  13.50],
+  ["S", "Na",  0.00],
+  ["S", "W",  -3.60],
+  ["C", "Na", 13.50],
+  ["C", "W",  33.75],
+  ["W", "Na",  0.00],
+]
+
+[bonds]
+bonds = [
+  ["S",   "C",   0.50, 1250.0],
+  ["C",   "C",   0.50, 1250.0],
+]
+angle_bonds = [
+  ["S", "C", "C", 170.0, 25.0],
+  ["C", "C", "C", 180.0, 25.0],
+]
+
+
+
+

An input structure/topology file sds.HDF5 with a couple thousand +randomly dispersed SDS chains is available in the HyMD-tutorial/sds github +repository (along with the code to generate it). Note that the charges are +specified in the structure/topology file through a /charge dataset. +Running the simulation with

+
python3 -m hymd sds.toml sds.HDF5
+
+
+

we observe the aggregation of the SDS into micellular structures—first oblate +spheroid shaped and later fully spherical. An example of this is shown in the +accompanying Jupyter notebook sds.ipynb.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/doc_pages/filtering.html b/v2.2.0/doc_pages/filtering.html new file mode 100644 index 00000000..c4e3f127 --- /dev/null +++ b/v2.2.0/doc_pages/filtering.html @@ -0,0 +1,321 @@ + + + + + + + 2. Filtering — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Filtering

+

The default grid-independent filter function used in HyMD is a Gaussian

+
+\[H(x) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right]\]
+

with reciprocal space representation

+
+\[\hat{H}(k) = \exp\left[\frac{-\sigma^2k^2}{2}\right].\]
+

The coarse-graining parameter \(\sigma\) determines a length scale of +particle extent and is given as configuration file input by

+
sigma = 0.75
+
+
+
+

2.1. Implementing new filters

+

Implementing new filter functions is straightforward by hijacking +the setup method of the Hamiltonian superclass. The new filter is +automatically applied and differentiated through the potential and interaction +energy functional.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/doc_pages/installation.html b/v2.2.0/doc_pages/installation.html new file mode 100644 index 00000000..7d8fd703 --- /dev/null +++ b/v2.2.0/doc_pages/installation.html @@ -0,0 +1,556 @@ + + + + + + + 1. Installation — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Installation

+
+

1.1. Dependencies

+

Installing non-Python dependencies may be done by

+
+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-openmpi-dev  # Install MPI-enabled HDF5
+sudo apt-get install -y pkg-config           # Install pkg-config, required for h5py install
+sudo apt-get install -y curl wget
+
+
+
+
+

Warning

+

There might be memory leaks when using HyMD with OpenMPI 4.1.1. +Therefore, using a newer version of OpenMPI is recommended. +See Issue #186 for more details.

+ +

Installing Python dependencies may be done by

+
+
python3 -m pip install --upgrade pip
+CC="mpicc" HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+python3 -m pip install mpi4py numpy cython
+python3 -m pip install "pmesh @ git+https://github.com/rainwoodman/pmesh"
+
+
+
+
+

Warning

+

If MPI-enabled HDF5 and h5py can not be installed, limited support +for serial HDF5 is available. Note that having MPI-enabled file IO is +highly recommended, and simulation performance under serial HDF5 will +potentially be very low.

+

Example dependency install on Ubuntu (apt) using serial HDF5:

+
sudo apt-get update -y
+sudo apt-get install -y python3 python3-pip  # Install python3 and pip
+sudo apt-get install -y libopenmpi-dev       # Install MPI development headers
+sudo apt-get install -y libhdf5-serial-dev   # Install serial HDF5
+sudo apt-get install -y curl wget
+
+python3 -m pip install h5py mpi4py numpy cython
+
+
+

Running parallel simulations without a +MPI-enabled HDF5 library available necessitates the use of the +--disable-mpio argument to HyMD, see Command line arguments. Note that +due to the way HyMD is built, a working MPI compiler is required even if all +intended simulations are serial.

+ +
+
+

1.2. Installing HyMD

+

HyMD may be installed using pip by

+
python3 -m pip install hymd
+
+
+
+
+

1.3. Install in docker

+

A docker image with build essentials setup is available at dockerhub with tag +mortele/hymd,

+
docker pull mortele/hymd:latest
+docker run -it mortele/hymd
+/app$ python3 -m pip install hymd
+
+# Grab example input files
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.toml
+/app$ curl -O https://raw.githubusercontent.com/Cascella-Group-UiO/HyMD-tutorial/main/ideal_chain/ideal_chain.HDF5
+
+# Run simulation
+/app$ python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --verbose
+
+
+
+
+

1.4. Run interactively in Google Colaboratory

+

A Google Colaboratory jupyter notebook is setup here with a working HyMD +fully installed and executable in the browser. We do not recommend running +large-scale simulations in colab for pretty obvious reasons.

+
+
+

1.5. Common issues

+
+

1.5.1. Numpy errors while importing the Fortran force kernels

+
RuntimeError: module compiled against API version 0xe but this version of numpy is 0xd
+
+Traceback (most recent call last):
+
+  (...)
+
+File "/..../HyMD/hymd/__init__.py", line 2, in <module>
+  from .main import main  # noqa: F401
+File "/..../HyMD/hymd/main.py", line 10, in <module>
+  from .configure_runtime import configure_runtime
+File "/..../hymd/configure_runtime.py", line 12, in <module>
+  from .input_parser import read_config_toml, parse_config_toml
+File "/..../HyMD/hymd/input_parser.py", line 12, in <module>
+  from .force import Bond, Angle, Dihedral, Chi
+File "/..../HyMD/hymd/force.py", line 8, in <module>
+  from force_kernels import (  # noqa: F401
+ImportError: numpy.core.multiarray failed to import
+
+
+

can normally be fixed by updating numpy versions,

+
python3 -m pip install -U numpy
+
+
+
+
+

1.5.2. Error building pfft-python due to missing curl/wget

+
Building wheel for pfft-python (setup.py) ... error
+ERROR: Command errored out with exit status 1:
+command: /usr/bin/python3 -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"'; __file__='"'"'/tmp/pip-install-fr6nt9m4/pfft-python/setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d /tmp/pip-wheel-ne5et1y_
+cwd: /tmp/pip-install-fr6nt9m4/pfft-python/
+Complete output (56 lines):
+running bdist_wheel
+running build
+running build_py
+
+  (...)
+
+curl -L -o /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 19: curl: not found
+wget -P /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/ https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+/tmp/pip-install-fr6nt9m4/pfft-python/depends/install_pfft.sh: 26: wget: not found
+Failed to get https://github.com/rainwoodman/pfft/releases/download/1.0.8-alpha3-fftw3-2don2d/pfft-1.0.8-alpha3-fftw3-2don2d.tar.gz
+Please check curl or wget
+You can also download it manually to /tmp/pip-install-fr6nt9m4/pfft-python/depends/..//depends/
+Traceback (most recent call last):
+  File "<string>", line 1, in <module>
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 86, in <module>
+    setup(
+  File "/usr/lib/python3/dist-packages/setuptools/__init__.py", line 144, in setup
+    return distutils.core.setup(**attrs)
+  File "/usr/lib/python3.8/distutils/core.py", line 148, in setup
+
+  (...)
+
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 56, in build_extensions
+    build_pfft(self.pfft_build_dir, self.mpicc, ' '.join(self.compiler.compiler_so[1:]))
+  File "/tmp/pip-install-fr6nt9m4/pfft-python/setup.py", line 28, in build_pfft
+    raise ValueError("could not build fftw; check MPICC?")
+ValueError: could not build fftw; check MPICC?
+----------------------------------------
+ERROR: Failed building wheel for pfft-python
+Running setup.py clean for pfft-python
+Failed to build pfft-python
+
+
+

can be fixed by installing either curl or wget

+
apt-get install -y curl wget
+
+
+
+
+

1.5.3. Error running parallel HyMD without MPI-enabled h5py

+
Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+Traceback (most recent call last):
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 197, in _run_module_as_main
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    return _run_code(code, main_globals, None,
+  File "/usr/local/Cellar/python@3.9/3.9.8/Frameworks/Python.framework/Versions/3.9/lib/python3.9/runpy.py", line 87, in _run_code
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    exec(code, run_globals)
+  File "/usr/local/lib/python3.9/site-packages/hymd/__main__.py", line 2, in <module>
+    main()
+  File "/usr/local/lib/python3.9/site-packages/hymd/main.py", line 64, in main
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 502, in __init__
+    with h5py.File(args.input, "r", **_kwargs) as in_file:
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    fapl = make_fapl(driver, libver, rdcc_nslots, rdcc_nbytes, rdcc_w0,
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 166, in make_fapl
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    set_fapl(plist, **kwds)
+  File "/usr/local/lib/python3.9/site-packages/h5py/_hl/files.py", line 52, in _set_fapl_mpio
+    raise ValueError("h5py was built without MPI support, can't use mpio driver")
+ValueError: h5py was built without MPI support, can't use mpio driver
+
+
+

Can be fixed by installing a MPI-enabled h5py through

+
python3 -m pip uninstall -y h5py
+HDF5_MPI="ON" python3 -m pip install --no-binary=h5py h5py
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/doc_pages/interaction_energy_functionals.html b/v2.2.0/doc_pages/interaction_energy_functionals.html new file mode 100644 index 00000000..bdd50a52 --- /dev/null +++ b/v2.2.0/doc_pages/interaction_energy_functionals.html @@ -0,0 +1,374 @@ + + + + + + + 1. Interaction energy functionals — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Interaction energy functionals

+

A few interaction energy functionals \(W\) are defined in HyMD through +the Hamiltonian class and associated subclasses.

+
+

1.1. \(\chi\)–interaction and \(\kappa\)–incompressibility

+

The most common hPF energy functional is specified by

+
hamiltonian = "DefaultWithChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i}, \text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where \(\tilde\chi_{\text{A}-\text{B}}\) is the interaction energy between +overlapping densities of particle types \(\text{A}\) and \(\text{B}\). +The incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\tilde\chi\) +and \(\kappa\) in the configuration file (see Configuration file)

+
kappa = 0.05
+chi = [
+   ["A", "B", 15.85],
+   ["B", "C", -5.70],
+   ...
+]
+
+
+
+
+

1.2. Only \(\kappa\)–incompressibility

+

The only \(\kappa\) interactions energy functional is specified by

+
hamiltonian = "DefaultNoChi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2,\]
+

where the incompressibility term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.3. Only \(\phi^2\)

+

The \(\phi^2\) interactions energy functional is specified by

+
hamiltonian = "SquaredPhi"
+
+
+

in the configuration file (see Configuration file). It takes the form

+
+\[W=\int\mathrm{d}\mathbf{r}\frac{1}{2\kappa\phi_0}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})\right)^2,\]
+

where the \(\phi\) squared term is governed by the compressibility parameter +\(\kappa\). The average density of the full system is denoted +\(\phi_0\).

+

Using this energy functional necessitates specification of \(\kappa\) in +the configuration file (see Configuration file)

+
kappa = 0.05
+
+
+
+
+

1.4. Implementing new interaction energy forms

+

Implementing new interaction energy functions is straightforward by subclassing +Hamiltonian and applying sympy differentiation to the symbolic +field objects. The sympy.lamdify function creates vectorised numpy +functions automatically from the differentiation result which is used to +transform the density fields.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/doc_pages/interfaces.html b/v2.2.0/doc_pages/interfaces.html new file mode 100644 index 00000000..d9ea60b7 --- /dev/null +++ b/v2.2.0/doc_pages/interfaces.html @@ -0,0 +1,318 @@ + + + + + + + 5. PLUMED interface — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

5. PLUMED interface

+

HyMD is interfaced with PLUMED <https://www.plumed.org/> for simulations using enhanced sampling or free-energy methods. +To use the interface, the Python package of PLUMED must be installed, and the user must provide a working PLUMED_KERNEL by setting this environment variable to the kernel path. +In the current version, only simulations using a single replica are supported.

+
+

Warning

+

PLUMED versions prior to 2.8.1 did not have a working Python interface with MPI. Therefore, you must use PLUMED 2.8.1 or greater when installing the PLUMED library in Python. Older versions for the kernel are supported if the Python interface was correctly installed with version 2.8.1.

+ +
+

5.1. Running simulations using PLUMED

+

To run your simulations using PLUMED you must first set the environment variable PLUMED_KERNEL and then call HyMD with the --plumed option, passing the PLUMED input file to HyMD. +Optionally, you can also set the output file name with the --plumed-outfile option (the default it plumed.out).

+

If your PLUMED input (see the PLUMED manual <> for details) is called, e.g., plumed_input.dat, you can run a simulation using the PLUMED interface with:

+
python3 -m hymd ideal_chain.toml ideal_chain.HDF5 --disable-field --plumed plumed_input.dat
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/doc_pages/intramolecular_bonds.html b/v2.2.0/doc_pages/intramolecular_bonds.html new file mode 100644 index 00000000..b6fcde10 --- /dev/null +++ b/v2.2.0/doc_pages/intramolecular_bonds.html @@ -0,0 +1,414 @@ + + + + + + + 2. Intramolecular bonds — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Intramolecular bonds

+

Intramolecular bonds types in HyMD are specified in the configuration file. +Once a simulation starts, the specific indices of bonded particles are inferred +from the type information in the configuration file, see Configuration file. +The construction of the bonds internally happens locally on each MPI rank after +every explicit domain decomposition transfer, which is the only time during +simulation when particles are permanently re-assigned to new CPUs. Ideally, you +should be running HyMD with relatively few particles per MPI rank (see +Benchmarks), around 200 being the optimal value for maximum +efficiency. In this case, the computational cost involved in reconstructing the +bond network subsequent to every domain decomposition swap is minuscule and not +measurable.

+

All intramolecular potentials are computed in highly optimised Fortran kernels, +and require no MPI communication (except for explicit domain decomposition +swaps which are performed very rarely in practice [e.g. every hundreds of +thousands time steps]).

+
+

2.1. Two-particle bonds

+

Stretching bonds in HyMD are implemented as harmonic spring potentials,

+
+\[V_2(r) = \frac{k}{2}(r-r_0)^2,\]
+

where \(r=|\mathbf{r}|\) is the inter-particle distance, \(k\) is a +constant of dimension energy (units \(\text{kJ}\,\text{mol}^{-1}\)), and +\(r_0\) is the equilibrum length of the bond (units: \(\text{nm}\)). The +force is calculated as

+
+\[F_{i\rightarrow j}(\mathbf{r}) = k(r-r_0)\frac{\mathbf{r}}{r},\]
+

where \(\mathbf{r}\) is the vector pointing from \(i\) to \(j\).

+

In the configuration file, two-particle bonds are specified per particle type:

+
+
configuration_two_particle_example.toml
+
[bonds]
+bonds = [
+   ["A", "A", 0.47, 1250.0],
+   ["A", "B", 0.37,  940.0],
+   ["B", "C", 0.50, 1010.0],
+   ["C", "A", 0.42,  550.0],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.2. Three-particle bonds

+

Bending bonds in HyMD are implemented as harmonic angular bonds, depending on +the particle–particle–particle angle \(\theta\),

+
+\[V_3(\theta) = \frac{k}{2}(\theta-\theta_0)^2,\]
+

where \(k\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\)), and \(\theta_0\) is the equilibrum +angle of the bond (units: \({}^\circ\)). Defining the particles with labels +\(a\), \(b\), and \(c\), let \(\mathbf{r}_a\) denote the vector +pointing from \(b\) to \(a\), and correspondingly let +\(\mathbf{r}_c\) point from \(b\) to \(c\). The +\(a\)\(b\)\(c\) may be computed through the law of Cosines,

+
+\[\theta = \cos^{-1}\left[\frac{\mathbf{r}_a\cdot \mathbf{r}_c}{r_a r_c}\right]\]
+

Then the force acting on \(a\) and \(c\) is

+
+\[ \begin{align}\begin{aligned}\mathbf{F}_a = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_a}\frac{\mathrm{d}r_a}{\mathrm{d}\mathbf{r}_a},\\\mathbf{F}_c = -\frac{\mathrm{d}V_3(\theta)}{\mathrm{d}r_c}\frac{\mathrm{d}r_c}{\mathrm{d}\mathbf{r}_c},\end{aligned}\end{align} \]
+

and

+
+\[\mathbf{F}_b = - \mathbf{F}_a - \mathbf{F}_c\]
+

In the configuration file, three-particle bonds are specified per particle type:

+
+
configuration_three_particle_example.toml
+
[bonds]
+angle_bonds = [
+   ["A", "A", "A", 180.0, 90.0],
+   ["A", "B", "A", 120.0, 55.0],
+   ["B", "C", "C",  30.0, 10.0],
+   ["C", "A", "B", 110.0, 25.5],
+   ...
+]
+
+
+
+

The order of the specified names does not matter, but the order of the length +and energy scales do.

+
+
+

2.3. Four-particle bonds

+

Torsional dihedral potentials in HyMD are implemented as Cosine series +potentials, depending on the angle \(\phi\) between the +\(a\)\(b\)\(c\) and \(b\)\(c\)\(d\) planes, for +a dihedral bond quartet \(a\), \(b\), \(c\), and \(d\). The +potential takes the form

+
+\[V_4(\phi) = \frac{1}{2}\sum_n^M c_n\cos(n\phi+\phi_n),\]
+

where \(c_n\) is a constant of dimension energy (units +\(\text{kJ}\,\text{mol}^{-1}\text{rad}^{-2}\)), and \(\phi_n\) are +specified phase angles in the cosine series.

+

In the configuration file, four-particle bonds are specified per particle type:

+
+
configuration_four_particle_example.toml
+
[bonds]
+dihedrals = [
+   ["A", "B", "C", "D"],
+   [
+     [-1],
+     [449.08790868, 610.2408724, -544.48626121, 251.59427866, -84.9918564],
+     [0.08, 0.46, 1.65, -0.96, 0.38],
+   ],
+   [1.0],
+]
+
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/doc_pages/overview.html b/v2.2.0/doc_pages/overview.html new file mode 100644 index 00000000..974580ef --- /dev/null +++ b/v2.2.0/doc_pages/overview.html @@ -0,0 +1,435 @@ + + + + + + + 2. Usage overview for HylleraasMD — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

2. Usage overview for HylleraasMD

+

HyMD is a Python package that allows large scale parallel hybrid particle-field +molecular dynamics (hPF-MD) simulations. The main simulation driver takes as +input a toml format configuration file, along with a topology and structure +file specifying the input system in HDF5 format.

+

Configuration file

+

The configuration file specifies the type and length of simulation to run. A +simple example of a configuration file which performs a short simulation of a +system contained in a [5, 5, 5] nm simulation box at 300 K may look like +the following:

+
+
config_simple_1.toml
+
[simulation]
+integrator = "velocity-verlet"
+n_steps = 100                      # total simulation steps
+n_print = 10                       # output trajectory data every n_print steps
+time_step = 0.01                   # time step in ps
+box_size = [5.0, 5.0, 5.0]         # simulation box size in nm
+target_temperature = 300           # thermostat temperature in Kelvin
+tau = 0.1                          # thermostat coupling strength in ps
+hamiltonian = "SquaredPhi"         # interaction energy functional
+kappa = 0.05                       # compressibility in mol/kJ
+
+[field]
+mesh_size = [30, 30, 30]           # FFT grid size
+sigma = 0.5                        # filtering length scale in nm
+
+
+
+

Note that for the version 1.0 release of HyMD, the [particles], +[simulation], and [field] groups are optional specifiers for +structuring the configuration file.

+

For a full specification of every recognised configuration keyword in HyMD, +please refer to Configuration file.

+

Topology and structure file

+

The topology and structure file specifies the positions, momenta, types, and +molecular structure of the particles in the system. In order to allow highly +parallel file read during program initialisation, the structure file format is a +simple flat HDF5 structure. An example structure file for a system containing +N particles may look like the following:

+
+
example_structure.HDF5
+
group   /
+   # root group
+
+dataset /coordinates
+   # float32, shape (T, N, D,)
+   # Time steps of N rows of D dimensional coordinate data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /velocities
+   # float32, shape (T, N, D,) OPTIONAL
+   # Time steps of N rows of D dimensional velocity data
+   # The last frame is used by default if multiple time steps are provided
+   # T is the number of time steps, D is the spatial dimension
+
+dataset /bonds
+   # int32,   shape (N, B,)    OPTIONAL
+   # Each row i contains indices of the particles bonds from/to i
+   # B denotes the maximum bonds per particle
+
+dataset /indices
+   # int32,   shape (N,)
+   # Index of each particle, 0--(N-1)
+
+dataset /molecules
+   # int32,   shape (N,)
+   # Index of molecule each particle belongs to
+   # Used to construct bond network locally on MPI ranks
+
+dataset /names
+   # str10,   shape (N,)
+   # Fixed size string array containing particle type names
+
+dataset /types
+   # int32,   shape (N,)       OPTIONAL
+   # Mapping of particle names to type indices
+
+
+
+

For a full specification of the topology and structure input file, see +Topology and structure file.

+

Command line arguments

+

A select few settings for HyMD are specified on the command line, most notably +output files, output directories, output specifications, and random seeds. In +addition, the configuration and structure files are provided as the first and +second required positional arguments. An example for running the simulation +specified by the config_simple_1.toml and example_structure.HDF5 +files may look like the following:

+
mpirun -n ${MPI_NUM_RANKS} python3 -m hymd         \  # HyMD executable
+                           config_simple_1.toml    \  # configuration file
+                           example_structure.HDF5  \  # structure file
+                           --logfile=log_out.txt   \  # set logfile path
+                           --seed 123456           \  # set random seed
+                           --verbose 2             \  # set logging verbosity
+                           --velocity-output          # enable velocity in trajectory output
+
+
+

For a full specification of all command line arguments, see +Command line arguments.

+

More examples

+

For more thorough rundown and concrete usage examples, see +Examples.

+
+

2.1. Running parallel simulations

+

Executing the HyMD code in parallel is fundamentally no different from running +it in serial, with the only difference being how the python3 interpreter is +invoked. Prepending mpirun -n ${NPROCS} to the usual +python3 -m hymd runs the simulation with ${NPROCS} MPI ranks.

+

Inputting

+
mpirun -n 6 python3 -m ideal_gas.toml ideal_gas.HDF5 --disable-field
+
+
+

sets up an example simulation of the HyMD-tutorial/ideal_gas system. For +more details about this system in particular, or other example simulations, see +the HyMD-tutorial repository.

+
+
+

2.2. Running tests

+

Run serial code tests by

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git hymd
+cd hymd/
+python3 -m pip install pytest pytest-mpi
+python3 -m pytest
+
+
+

There is a small convenience script in hymd/ for running the MPI-enabled +tests,

+
chmod +x pytest-mpi
+./pytest-mpi --nprocs 5 --order-output --no-summary --capture=no
+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/doc_pages/pressure.html b/v2.2.0/doc_pages/pressure.html new file mode 100644 index 00000000..3b500b82 --- /dev/null +++ b/v2.2.0/doc_pages/pressure.html @@ -0,0 +1,324 @@ + + + + + + + 4. Pressure — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Pressure

+

Internal pressure is calculated from internal energy according to

+
+\[\begin{split}P_a = \frac{1}{\mathcal{V}} \left( 2T_a - \text{Vir}_a \right) \\ +\text{Vir}_a = L_a \frac{\partial \mathcal{U}}{\partial L_a} \\ +\mathcal{U} = \sum_{i=1}^M \mathcal{U}_0( \{ \mathbf{r}\}_i ) + W[\{ \tilde\phi \} ]\end{split}\]
+

where +\(\mathcal{V}\) is the simulation volume, +\({T_a}\) is the kinetic energy +and \(L_a\) the length of the box in the Cartesian direction \(a\), +Vir is the virial of the total interaction energy \(\mathcal{U}\).

+

\(\mathcal{U}\) comprises intramolecular bonded terms \(\mathcal{U}_0\) (see Intramolecular bonds for details), +and field terms \(W[\{ \tilde\phi \} ]\) (see Theory for details).

+

Using the above expressions, the following form for internal pressure is obtained:

+
+\[\begin{split}P_a = \frac{2 T_a}{\mathcal{V}} -\frac{L_a}{\mathcal{V}} \sum_{i=1}^N \frac{\partial \mathcal{U}_{0i}}{\partial L_a} + P^{(3)}_a \\\end{split}\]
+
+\[P^{(3)}_a = \frac{1}{\mathcal{V}}\left ( -W[\{ \tilde\phi(\mathbf{r}) \}] + \int \sum_t \bar{V}_t(\mathbf{r})\tilde\phi_t(\mathbf{r})d\mathbf{r} + + \int \sum_t \sigma^2\bar{V}_t(\mathbf{r})\nabla_a^2\tilde\phi_t(\mathbf{r}) d\mathbf{r} \right)\]
+

where \(\bar{V}_t(\mathbf{r}) = \frac{\partial w(\{\tilde\phi\})}{\partial\tilde\phi_t}\) +and \(σ\) is a coarse-graining parameter (see Filtering for details). +Note that the above expression is obtained for a Gaussian filter which is the most natural choice in HhPF theory.

+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/doc_pages/theory.html b/v2.2.0/doc_pages/theory.html new file mode 100644 index 00000000..21a319ba --- /dev/null +++ b/v2.2.0/doc_pages/theory.html @@ -0,0 +1,382 @@ + + + + + + + 1. Theory — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

1. Theory

+

Hybrid particle–field simulations switch out the ordinary particle–particle +Lennard-Jones interactions with interactions between particles and a slowly +varying density field. In this way, the most expensive part of normal molecular +dynamics simulations is circumvented. Hybrid particle–field densities are +defined as

+
+\[\phi(\mathbf{r}) = \sum_{i=1}^NP(\mathbf{r}-\mathbf{r}_i),\]
+

where \(\mathbf{r}\) is a spatial coordinate, \(P\) is a window function +used to distribute particle number densities onto a computational grid, and +\(\mathbf{r}_i\) is the position of particle \(i\) (of total \(N\)). +By default, HyMD uses a Cloud-In-Cell (CIC) window function. A Hamiltonian form +for a system of \(N\) particles in \(M\) molecules is

+
+\[\mathcal{H}(\{\mathbf{r}\})=\sum_{m=1}^MH_0(\{\mathbf{r},\mathbf{v}\}_m)+W[\phi(\mathbf{r})]\]
+

with \(H_0\) being a standard intramolecular Hamiltonian form (see +Intramolecular bonds) including kinetic terms, while \(W\) is a density +dependent interaction energy functional.

+

In the Hamiltonian hPF-MD formalism [], the density +field is filtered using a grid-independent filtering function \(H\),

+
+\[\tilde\phi(\mathbf{r})=\int\mathrm{d}\mathbf{x}\,\phi(\mathbf{x})H(\mathbf{r}-\mathbf{x}).\]
+

The filter smooths the density, ensuring that \(\tilde\phi\) and +\(W[\tilde\phi([\phi])]\) both converge as the grid size is reduced.

+
+

1.1. External potential

+

The external potential acting on a particle is defined as the functional +derivative of \(W\) with respect to \(\phi\). In the filtered formalism, +the potential takes the form

+
+\[\begin{split}V(\mathbf{r}) &= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\phi(\mathbf{r})} \\ +&= \int\mathrm{d}\mathbf{y}\,\frac{\delta w}{\delta\tilde\phi(\mathbf{y})}\frac{\delta\tilde\phi(\mathbf{y})}{\delta\phi(\mathbf{r})},\end{split}\]
+

under the assumption of a local form of the interaction energy functional, +\(W[\tilde\phi]=\int\mathrm{d}\mathbf{r}\,w[\tilde\phi(\mathbf{r})]\). Note +that

+
+\[\frac{\delta \tilde\phi(\mathbf{y})}{\delta \phi(\mathbf{r})} = H(\mathbf{y}-\mathbf{r}).\]
+
+
+

1.2. Force interpolation

+

The forces on particle \(i\) are obtained by differentiation of the external +potential,

+
+\[\mathbf{F}_i=-\int\mathrm{d}\mathbf{r}\,\nabla V(\mathbf{r})P(\mathbf{r}-\mathbf{r}_i).\]
+
+
+

1.3. Reciprocal space calculations

+

The field operations in HyMD are discretised and performed on a grid in +reciprocal space using (discrete) fast Fourier transform algorithms. After +interpolating the density \(\phi_{ijk}\) with CIC, we apply the filtering +and obtain the discrete version of the external potential by

+
+\[\tilde\phi_{ijk}=\mathrm{FFT}^{-1}\big[\mathrm{FFT}(\phi)\mathrm{FFT}(H)\big]\]
+

and

+
+\[V_{ijk}=\mathrm{FFT}^{-1}\left[\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+

The forces are obtained by differentiation of \(V\) in Fourier space as

+
+\[\nabla V_{ijk} = \mathrm{FFT}^{-1}\left[i\mathbf{k}\mathrm{FFT}\left(\frac{\delta w(\tilde\phi)}{\delta \tilde\phi}\right)\mathrm{FFT}(H)\right].\]
+
+
+

1.4. Filter

+

By default, the filter used in HyMD is a simple Gaussian of the form

+
+\[\begin{split}H(x) &= \frac{1}{\sqrt{2\pi}\sigma}\exp\left[\frac{-x^2}{2\sigma^2}\right] \\ +\hat{H}(k) &= \exp\left[\frac{-\sigma^2k^2}{2}\right].\end{split}\]
+

For more details about the filtering, see Filtering.

+
+
+

1.5. Hamiltonian form

+

The default form of the interaction energy functional in HyMD is

+
+\[W=\frac{1}{2\phi_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-\phi_0\right)^2.\]
+

In the case of constant pressure simulations (NPT), the interaction energy functional becomes

+
+\[W=\frac{1}{2\rho_0}\int\mathrm{d}\mathbf{r}\sum_{\text{i},\text{j}}\tilde\chi_{\text{i}-\text{j}}\tilde\phi_\text{i}(\mathbf{r})\tilde\phi_\text{j}(\mathbf{r}) + \frac{1}{2\kappa}\left(\sum_\text{k}\tilde\phi_\text{k}(\mathbf{r})-a\right)^2.\]
+

where, \(\rho_0= 1 / ν\) is an intrinsic parameter corresponding to the specific volume \((ν)\) of a coarse-grained particle, +\(a\) is a calibrated parameter to obtain the correct average density at the target temperature and pressure. +See Interaction energy functionals for details.

+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/doc_pages/topology_input.html b/v2.2.0/doc_pages/topology_input.html new file mode 100644 index 00000000..778c0487 --- /dev/null +++ b/v2.2.0/doc_pages/topology_input.html @@ -0,0 +1,363 @@ + + + + + + + 4. Topology and structure file — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

4. Topology and structure file

+

The conformational setup, bond network, molecules, particle types, names, +masses, charges, and velocities are specified in the structure/topology input +file in HDF5 format. The file is structured as a flag collection of datasets +attached to the root / group.

+

The HyMD-tutorial has multiple examples of structure files for various levels +of complexity.

+
+

4.1. Required datasets

+
+
/coordinates:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/indices:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/names:
+

array shape [N,]

+

datatype [string (length between 1 and 16)]

+

The shape represents one particle name per N particles. The datatype may be a string of length =<16.

+
+
+
+
+

4.2. Optional datasets

+
+
/velocities:
+

array shape [T, N, D,]

+

datatype [float32 or float64]

+

The shape represents T number of frames, N number of particles, in D dimensions. The data type may be either four or eight byte reals. If multiple frames are provided T > 1, then the last frame is used as starting point for the new simulation by default.

+
+
/types:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one particle type index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/molecules:
+

array shape [N,]

+

datatype [int32 or int64]

+

The shape represents one molecule index per N particles. The data type may be either 32 or 64 bit integers.

+
+
/bonds:
+

array shape [N, B,]

+

datatype [int32 or int64]

+

The shape represents B bond specifications (indices of different particles) per N particles. The data type may be either 32 or 64 bit integers.

+
+
/charge:
+

array shape [N,]

+

datatype [float32 or float64]

+

The shape represents one particle charge per N particles. The data type may be either four or eight byte reals.

+
+
/box:
+

array shape [3,]

+

datatype [float32 or float64]

+

The shape represents the initial box dimensions in Cartesian coordinates.

+
+
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/genindex.html b/v2.2.0/genindex.html new file mode 100644 index 00000000..86f192aa --- /dev/null +++ b/v2.2.0/genindex.html @@ -0,0 +1,879 @@ + + + + + + Index — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Index

+ +
+ _ + | A + | B + | C + | D + | E + | F + | G + | H + | I + | K + | L + | M + | N + | O + | P + | R + | S + | T + | U + +
+

_

+ + + +
+ +

A

+ + + +
+ +

B

+ + + +
+ +

C

+ + + +
+ +

D

+ + + +
+ +

E

+ + +
+ +

F

+ + + +
+ +

G

+ + +
+ +

H

+ + + +
    +
  • + hymd.input_parser + +
  • +
  • + hymd.integrator + +
  • +
  • + hymd.plumed + +
  • +
  • + hymd.pressure + +
  • +
  • + hymd.thermostat + +
  • +
+ +

I

+ + + +
+ +

K

+ + +
+ +

L

+ + +
+ +

M

+ + + +
+ +

N

+ + + +
+ +

O

+ + +
+ +

P

+ + + +
+ +

R

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ +

U

+ + + +
+ + + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/index.html b/v2.2.0/index.html new file mode 100644 index 00000000..e2d9351b --- /dev/null +++ b/v2.2.0/index.html @@ -0,0 +1,408 @@ + + + + + + + HylleraasMD documentation — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

HylleraasMD documentation

+
+
Release:
+

2.2.0

+
+
Date:
+

Oct 06, 2023

+
+
+

HylleraasMD (HyMD) is a massively parallel Python package for Hamiltonian hybrid +particle-field molecular dynamics (HhPF-MD) simulations of coarse-grained bio- +and soft-matter systems.

+

HyMD can run canonical hPF-MD simulations, or filtered density HhPF-MD simulations [Bore and Cascella, 2020, Ledum et al., 2023, Ledum et al., 2023, Sen et al., 2023] +with or without explicit PME electrostatic interactions. It includes all standard intramolecular interactions, +including stretching, bending, torsional, and combined bending-dihedral potentials. Additionally, topological reconstruction of permanent peptide chain backbone +dipoles is possible for accurate recreation of protein conformational dynamics. It can run simulations in constant energy (NVE), constant volume (NVT) [Ledum et al., 2023, Ledum et al., 2023] +or constant pressure (NPT) conditions [Sen et al., 2023]. +HyMD is also interfaced with PLUMED and can perform simulations using enhanced sampling methods.

+

HyMD uses the pmesh library for particle-mesh operations, with the PPFT [Pippig, 2013] backend for FFTs through the pfft-python bindings. +File IO is done via HDF5 formats to allow MPI parallel reads.

+
+

User Guide

+

The HylleraasMD User Guide provides comprehensive information on how to run +simulations. Selected Examples are available to guide new users.

+
+
+

Installing HyMD

+

The easiest approach is to install using pip:

+
python3 -m pip install --upgrade pip
+python3 -m pip install --upgrade numpy mpi4py cython
+python3 -m pip install hymd
+
+
+

For more information and required dependencies, see +Installation.

+
+

Run in Google colab

+

Run HyMD interactively in Google Colaboratory jupyter notebook here.

+
+
+
+

Source Code

+

Source code is available from +https://github.com/Cascella-Group-UiO/HyMD/ under the GNU Lesser General Public +License v3.0. Obtain the source code with git:

+
git clone https://github.com/Cascella-Group-UiO/HyMD.git
+
+
+
+
+

Development

+

HyMD is developed and maintained by researchers at the Hylleraas Centre for +Quantum Molecular Sciences at the University of Oslo.

+

pic1 pic2

+
+
+

References

+
+
+[BC20] +

Sigbjørn Løland Bore and Michele Cascella. Hamiltonian and alias-free hybrid particle–field molecular dynamics. J. Chem. Phys., 153(9):094106, 2020. doi:10.1063/5.0020733.

+
+
+[BDP07] +

Giovanni Bussi, Davide Donadio, and Michele Parrinello. Canonical sampling through velocity rescaling. J. Chem. Phys., 126(1):014101, 2007. doi:10.1063/1.2408420.

+
+
+[LBC20] +

Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Automated determination of hybrid particle-field parameters by machine learning. Mol. Phys., 118(19-20):e1785571, 2020. doi:10.1080/00268976.2020.1785571.

+
+
+[LCS+23] +

Morten Ledum, Manuel Carrer, Samiran Sen, Xinmeng Li, Michele Cascella, and Sigbjørn Løland Bore. HylleraasMD: Massively parallel hybrid particle-field molecular dynamics in Python. Journal of Open Source Software, 8(84):4149, apr 2023. URL: https://joss.theoj.org/papers/10.21105/joss.04149, doi:10.21105/joss.04149.

+
+
+[LSL+23] +

missing journal in hymd_domain2023

+
+
+[Pip13] +

Michael Pippig. Pfft: an extension of fftw to massively parallel architectures. SIAM J. Sci. Comput., 35(3):C213–C236, 2013. doi:10.1137/120885887.

+
+
+[SLBC23] +

Samiran Sen, Morten Ledum, Sigbjørn Løland Bore, and Michele Cascella. Soft matter under pressure: pushing particle–field molecular dynamics to the isobaric ensemble. J Chem Inf Model, 63(7):2207–2217, March 2023. URL: https://doi.org/10.1021/acs.jcim.3c00186, doi:10.1021/acs.jcim.3c00186.

+
+
+[TBM92] +

MBBJM Tuckerman, Bruce J Berne, and Glenn J Martyna. Reversible multiple time scale molecular dynamics. J. Chem. Phys., 97(3):1990–2001, 1992. doi:10.1063/1.463137.

+
+
+
+
+
+

Indices and tables

+ +
+
+
+
+
+
+
+
+
+ + + +
+ +
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+ + + + + +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/objects.inv b/v2.2.0/objects.inv new file mode 100644 index 00000000..f0c7150d Binary files /dev/null and b/v2.2.0/objects.inv differ diff --git a/v2.2.0/py-modindex.html b/v2.2.0/py-modindex.html new file mode 100644 index 00000000..8fae07d8 --- /dev/null +++ b/v2.2.0/py-modindex.html @@ -0,0 +1,359 @@ + + + + + + Python Module Index — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + +

Python Module Index

+ +
+ h +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ h
+ hymd +
    + hymd.barostat +
    + hymd.field +
    + hymd.file_io +
    + hymd.force +
    + hymd.input_parser +
    + hymd.integrator +
    + hymd.plumed +
    + hymd.pressure +
    + hymd.thermostat +
+ + +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + \ No newline at end of file diff --git a/v2.2.0/search.html b/v2.2.0/search.html new file mode 100644 index 00000000..4521db3d --- /dev/null +++ b/v2.2.0/search.html @@ -0,0 +1,314 @@ + + + + + + Search — hymd 2.2.0 documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
  • + +
  • +
  • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2021, Morten Ledum, Xinmeng Li, Samiran Sen, Manuel Carrer, Sigbjørn Løland Bore.

+
+ + + +
+
+
+
+
+ +
+ + Other Versions + v: v2.2.0 + + +
+
+
Releases
+
v1.0.1
+
v1.0.2
+
v1.0.3
+
v1.0.4
+
v1.0.5
+
v1.0.6
+
v1.0.7
+
v1.0.8
+
v1.0.9
+
v2.0.0
+
v2.0.1
+
v2.0.2
+
v2.1.0
+
v2.2.0
+
+
+
Development
+
main
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v2.2.0/searchindex.js b/v2.2.0/searchindex.js new file mode 100644 index 00000000..48ec1e3a --- /dev/null +++ b/v2.2.0/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["doc_pages/api","doc_pages/benchmarks","doc_pages/command_line","doc_pages/config_file","doc_pages/constants_and_units","doc_pages/electrostatics","doc_pages/examples","doc_pages/filtering","doc_pages/installation","doc_pages/interaction_energy_functionals","doc_pages/interfaces","doc_pages/intramolecular_bonds","doc_pages/overview","doc_pages/pressure","doc_pages/theory","doc_pages/topology_input","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,"sphinx.ext.viewcode":1,"sphinxcontrib.bibtex":9,sphinx:56},filenames:["doc_pages/api.rst","doc_pages/benchmarks.rst","doc_pages/command_line.rst","doc_pages/config_file.rst","doc_pages/constants_and_units.rst","doc_pages/electrostatics.rst","doc_pages/examples.rst","doc_pages/filtering.rst","doc_pages/installation.rst","doc_pages/interaction_energy_functionals.rst","doc_pages/interfaces.rst","doc_pages/intramolecular_bonds.rst","doc_pages/overview.rst","doc_pages/pressure.rst","doc_pages/theory.rst","doc_pages/topology_input.rst","index.rst"],objects:{"hymd.barostat":{isotropic:[0,1,1,""],semiisotropic:[0,1,1,""]},"hymd.field":{compute_field_and_kinetic_energy:[0,1,1,""],compute_field_energy_q_GPE:[0,1,1,""],compute_field_force:[0,1,1,""],compute_self_energy_q:[0,1,1,""],domain_decomposition:[0,1,1,""],initialize_pm:[0,1,1,""],update_field:[0,1,1,""],update_field_force_q:[0,1,1,""],update_field_force_q_GPE:[0,1,1,""]},"hymd.file_io":{OutDataset:[0,2,1,""],distribute_input:[0,1,1,""],setup_time_dependent_element:[0,1,1,""],store_data:[0,1,1,""],store_static:[0,1,1,""]},"hymd.file_io.OutDataset":{close_file:[0,3,1,""],flush:[0,3,1,""],is_open:[0,3,1,""]},"hymd.force":{Angle:[0,2,1,""],Bond:[0,2,1,""],Chi:[0,2,1,""],Dielectric_type:[0,2,1,""],Dihedral:[0,2,1,""],compute_angle_forces__plain:[0,1,1,""],compute_bond_forces__plain:[0,1,1,""],compute_dihedral_forces__plain:[0,1,1,""],dipole_forces_redistribution:[0,1,1,""],find_all_paths:[0,1,1,""],prepare_bonds:[0,1,1,""],prepare_bonds_old:[0,1,1,""],prepare_index_based_bonds:[0,1,1,""],propensity_potential_coeffs:[0,1,1,""]},"hymd.force.Angle":{atom_3:[0,4,1,""]},"hymd.force.Bond":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],equilibrium:[0,4,1,""],strength:[0,4,1,""]},"hymd.force.Chi":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],interaction_energy:[0,4,1,""]},"hymd.force.Dielectric_type":{atom_1:[0,4,1,""],dielectric_value:[0,4,1,""]},"hymd.force.Dihedral":{atom_1:[0,4,1,""],atom_2:[0,4,1,""],atom_3:[0,4,1,""],atom_4:[0,4,1,""],coeffs:[0,4,1,""],dih_type:[0,4,1,""]},"hymd.hamiltonian":{DefaultNoChi:[0,2,1,""],DefaultWithChi:[0,2,1,""],Hamiltonian:[0,2,1,""],SquaredPhi:[0,2,1,""]},"hymd.hamiltonian.DefaultNoChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.DefaultWithChi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.hamiltonian.Hamiltonian":{__init__:[0,3,1,""],_setup:[0,3,1,""]},"hymd.hamiltonian.SquaredPhi":{__init__:[0,3,1,""],setup:[0,3,1,""]},"hymd.input_parser":{Config:[0,2,1,""],check_NPT_conditions:[0,1,1,""],check_angles:[0,1,1,""],check_bonds:[0,1,1,""],check_box_size:[0,1,1,""],check_cancel_com_momentum:[0,1,1,""],check_charges:[0,1,1,""],check_charges_types_list:[0,1,1,""],check_chi:[0,1,1,""],check_config:[0,1,1,""],check_dielectric:[0,1,1,""],check_dihedrals:[0,1,1,""],check_domain_decomposition:[0,1,1,""],check_hamiltonian:[0,1,1,""],check_integrator:[0,1,1,""],check_m:[0,1,1,""],check_mass:[0,1,1,""],check_max_molecule_size:[0,1,1,""],check_n_b:[0,1,1,""],check_n_flush:[0,1,1,""],check_n_particles:[0,1,1,""],check_n_print:[0,1,1,""],check_name:[0,1,1,""],check_start_and_target_temperature:[0,1,1,""],check_tau:[0,1,1,""],check_thermostat_coupling_groups:[0,1,1,""],parse_config_toml:[0,1,1,""],read_config_toml:[0,1,1,""],sort_dielectric_by_type_id:[0,1,1,""]},"hymd.input_parser.Config":{a:[0,4,1,""],angle_bonds:[0,4,1,""],barostat:[0,4,1,""],barostat_type:[0,4,1,""],bonds:[0,4,1,""],box_size:[0,4,1,""],cancel_com_momentum:[0,4,1,""],chi:[0,4,1,""],conv_crit:[0,4,1,""],convergence_type:[0,4,1,""],coulomb_constant:[0,4,1,""],coulombtype:[0,4,1,""],dielectric_const:[0,4,1,""],dielectric_type:[0,4,1,""],dihedrals:[0,4,1,""],domain_decomposition:[0,4,1,""],dtype:[0,4,1,""],file_name:[0,4,1,""],gas_constant:[0,4,1,""],hamiltonian:[0,4,1,""],initial_energy:[0,4,1,""],integrator:[0,4,1,""],kappa:[0,4,1,""],m:[0,4,1,""],mass:[0,4,1,""],max_molecule_size:[0,4,1,""],mesh_size:[0,4,1,""],n_b:[0,4,1,""],n_flush:[0,4,1,""],n_particles:[0,4,1,""],n_print:[0,4,1,""],n_steps:[0,4,1,""],name:[0,4,1,""],pol_mixing:[0,4,1,""],pressure:[0,4,1,""],respa_inner:[0,4,1,""],rho0:[0,4,1,""],self_energy:[0,4,1,""],sigma:[0,4,1,""],start_temperature:[0,4,1,""],tags:[0,4,1,""],target_pressure:[0,4,1,""],target_temperature:[0,4,1,""],tau:[0,4,1,""],tau_p:[0,4,1,""],thermostat_coupling_groups:[0,4,1,""],thermostat_work:[0,4,1,""],time_step:[0,4,1,""],type_charges:[0,4,1,""]},"hymd.integrator":{integrate_position:[0,1,1,""],integrate_velocity:[0,1,1,""]},"hymd.logger":{Logger:[0,2,1,""],MPIFilterAll:[0,2,1,""],MPIFilterRoot:[0,2,1,""]},"hymd.logger.Logger":{setup:[0,3,1,""]},"hymd.logger.MPIFilterAll":{filter:[0,3,1,""]},"hymd.logger.MPIFilterRoot":{filter:[0,3,1,""]},"hymd.plumed":{PlumedBias:[0,2,1,""]},"hymd.plumed.PlumedBias":{api_version:[0,3,1,""],calc:[0,3,1,""],finalize:[0,3,1,""],prepare:[0,3,1,""]},"hymd.pressure":{comp_pressure:[0,1,1,""]},"hymd.thermostat":{_random_chi_squared:[0,1,1,""],_random_gaussian:[0,1,1,""],csvr_thermostat:[0,1,1,""]},hymd:{barostat:[0,0,0,"-"],field:[0,0,0,"-"],file_io:[0,0,0,"-"],force:[0,0,0,"-"],input_parser:[0,0,0,"-"],integrator:[0,0,0,"-"],plumed:[0,0,0,"-"],pressure:[0,0,0,"-"],thermostat:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0020733":16,"00268976":16,"0083144621":0,"01036426965":4,"014101":[0,16],"02214076":4,"03642696562":4,"03970":6,"04149":16,"08790868":[6,11],"094106":16,"0xd":8,"0xe":8,"100":[4,6,12],"1000":6,"10000":6,"10001":6,"1010":11,"1021":16,"1063":16,"1080":16,"10nm":6,"110":11,"1120":0,"1130":0,"1137":16,"118":16,"120":[3,6,11],"120885887":16,"120ff":0,"123456":12,"1250":[3,6,11],"126":[0,16],"138":[0,4],"144":8,"148":8,"1500":6,"153":16,"166":8,"170":6,"1785571":16,"179":0,"180":[3,6,11],"186":8,"197":8,"1974":0,"1981":0,"1984":0,"1990":16,"1992":[3,16],"200":[6,11],"2000":6,"2001":16,"2007":[0,3,16],"2008":0,"201":[0,3],"2013":16,"2018":0,"2020":[6,16],"2023":16,"20nm":6,"21105":16,"2207":16,"2217":16,"223":0,"224":1,"2408420":16,"2408724":[6,11],"246":0,"251":[6,11],"28103735":0,"298":6,"2_1":0,"2don2d":8,"2nd":0,"2t_a":13,"300":[6,12],"3000":6,"3144621":4,"323":6,"3684":0,"3690":0,"3c00186":16,"4149":16,"449":[6,11],"463137":16,"48626121":[6,11],"502":8,"533":1,"544":[6,11],"550":11,"59427866":[6,11],"602176634":4,"610":[6,11],"66053906660":4,"85418781281":4,"935458":[0,4],"940":11,"96924":6,"980":3,"9918564":[6,11],"\u03b1":0,"\u03b2":0,"\u03bd":14,"\u03c3":13,"boolean":[0,3],"byte":15,"case":[0,3,6,11,14],"class":[0,9],"default":[0,3,7,10,12,14,15],"export":8,"final":0,"float":[0,3],"function":[0,3,5,6,7,12,14],"int":[0,5,6,9,13,14],"long":[5,6],"new":[0,11,15,16],"particle\u00e2":16,"public":16,"return":[0,8],"short":[6,12],"static":0,"switch":14,"true":[0,3,6],"while":[0,14],Adding:6,For:[0,12,14,16],LCS:16,The:[0,3,5,6,7,8,9,11,12,14,15,16],Then:11,There:[8,12],These:0,Used:[0,3,12],Using:[6,9,13],With:[0,6],__file__:8,__init__:[0,8],__main__:8,_gener:0,_hl:8,_kwarg:8,_random_chi_squar:0,_random_gaussian:0,_run_cod:8,_run_module_as_main:8,_set_fapl_mpio:8,_setup:0,about:[3,12,14],abov:[0,6,13],absent:0,acceler:0,accompani:6,accord:[0,3,13],accur:16,acid:6,across:[0,3],acs:16,act:[0,11,14],adapt:0,add:[5,6],added:0,adding:6,addison:0,addit:[0,2,5,12],addition:16,additon:0,adher:0,affect:0,affili:[0,2],after:[0,11,14],against:8,aggreg:6,ahren:0,alanin:6,algorithm:[0,3,14],alia:16,all:[0,2,3,4,6,8,11,12,16],all_nam:0,all_rank:0,alloc:0,allow:[12,16],allreduc:0,along:[6,12],alpha3:8,alpha:0,alpha_:0,alpha_l:0,alpha_n:0,alreadi:0,also:[6,8,10,16],altern:2,alwai:[0,3],amino:6,amount:0,analyt:0,angl:[0,2,3,6,8,11],angle_bond:[0,3,6,11],angle_pr:0,angular:[0,3,6,11],ani:[0,2,3],anisotrop:0,apart:0,api:8,api_vers:0,app:8,appli:[0,3,7,9,14],applic:0,approach:16,approxim:0,apr:16,apt:8,architectur:16,arg:[0,8],argument:[0,6,8,12],argv:8,aris:0,around:11,arrai:[0,3,12,15],arriv:6,art:0,aspect:3,assess:0,assign:[0,3,11],associ:[0,9],assum:3,assumpt:14,atom:0,atom_1:0,atom_2:0,atom_3:0,atom_4:0,attach:15,attempt:0,attr:8,attract:3,attribut:0,autom:16,automat:[0,7,8,9],avail:[6,8,16],averag:[0,3,9,14],avogadro:4,back:[0,5],backbon:[0,2,3,16],backcon:0,backend:16,backmap:0,balanc:0,ballist:6,bar:[3,4,13],barostat:3,barostat_typ:[0,3],base:0,bath:[0,3],bb_index:0,bc20:16,bdist_wheel:8,bdp07:16,bead:0,becaus:0,becom:[0,14],befor:[0,3,6,8],being:[0,2,3,5,11,12,14],belong:12,below:[0,6],benchmark:11,bend:[0,3,11,16],berendsen:3,bern:16,besid:2,best:0,beta:0,better:0,between:[0,3,5,6,9,11,14,15],bia:0,big:14,bin:8,binari:8,bind:16,bio:16,bit:[0,15],blueprint:0,boltzmann:[0,3,4],bond2_energi:0,bond3_energi:0,bond4_energi:0,bond:[0,2,6,8,12,13,14,15],bond_pr:0,bonds_2:0,bonds_2_atom1:0,bonds_2_atom2:0,bonds_2_atom_1:0,bonds_2_atom_2:0,bonds_2_equilibrium:0,bonds_2_strength:0,bonds_3:0,bonds_3_atom_1:0,bonds_3_atom_2:0,bonds_3_atom_3:0,bonds_3_equilibrium:0,bonds_3_strength:0,bonds_4:0,bonds_4_atom_1:0,bonds_4_atom_2:0,bonds_4_atom_3:0,bonds_4_atom_4:0,bonds_4_coeff:0,bonds_4_last:0,bonds_4_typ:0,bool:0,bootstrap:8,bore:[0,16],both:[0,14],boundari:[0,3],box:[0,3,6,12,13,15],box_siz:[0,3,6,12],breviti:6,brew:8,broadcast:0,browser:8,bruce:16,buffer:[0,3],build_extens:8,build_pfft:8,build_pi:8,built:8,bussi:[0,3,16],c213:16,c236:16,c_n:[0,6,11],calc:0,calcul:[0,3,6,11,13],calibr:[0,3,14],call:[0,3,8,10],callabl:0,can:[0,6,8,10,16],cancel_com_momentum:[0,3,6],canon:[0,3,16],capabl:2,captur:12,carrer:16,carri:6,cartesian:[0,3,13,15],cascella:[8,12,16],cbt:0,cdot10:4,cdot:[0,4,11],cell:[0,14],cellar:8,center:[0,3],centr:16,certain:[0,2],chain:[0,16],chang:[0,3],changedin:0,charg:[0,3,4,5,6,15],charge_out:0,check:[0,8],check_angl:0,check_bond:0,check_box_s:0,check_cancel_com_momentum:0,check_charg:0,check_charges_types_list:0,check_chi:0,check_config:0,check_dielectr:0,check_dihedr:0,check_domain_decomposit:0,check_hamiltonian:0,check_integr:0,check_m:0,check_mass:0,check_max_molecule_s:0,check_n_b:0,check_n_flush:0,check_n_particl:0,check_n_print:0,check_nam:0,check_npt_condit:0,check_start_and_target_temperatur:0,check_tau:0,check_thermostat_coupling_group:0,chem:[0,16],chi:[0,3,4,6,8],chi_2:0,chi_3:0,chi_:[0,3,6,9,14],chi_m:0,chmod:12,choic:13,chosen:0,cic:[0,5,14],circ:[3,11],circumv:14,classmethod:0,classvar:0,clean:[0,8],clone:[8,12,16],close:[0,8],close_fil:0,closest:0,cloud:[0,6,14],coars:[0,3,7,13,14,16],code:[0,1,2,3,6,8,12],coeff:0,coeffici:0,coil:[0,6],colab:8,colaboratori:16,collect:[0,3,15],com:[0,8,12,16],combin:[0,6,16],comm:0,comm_world:0,command:[8,12],common:9,commuic:0,commun:[0,3,11],communc:0,comp_pressur:0,compar:6,compat:2,compil:[0,8],compiler_so:8,complesfield:0,complet:[0,6,8],complex:[6,15],complexfield:0,compon:0,comprehens:16,compress:[0,3,4,6,9,12],compris:13,comput:[0,5,11,14,16],computaion:0,compute_angle_forces__plain:0,compute_bond_forces__plain:0,compute_dihedral_forces__plain:0,compute_field_and_kinetic_energi:0,compute_field_energy_q_gp:0,compute_field_forc:0,compute_potenti:0,compute_self_energy_q:0,concret:12,condit:[6,16],config:[0,8],config_simple_1:12,configur:[0,2,5,6,7,8,9,11,12],configuration_four_particle_exampl:11,configuration_three_particle_exampl:11,configuration_two_particle_exampl:11,configure_runtim:8,conform:[6,15,16],connect:0,conserv:1,consid:[0,6],consist:[0,6],consit:6,consitu:0,constant:[0,3,5,6,11,14,16],constitut:[0,2,3],constraint:3,construct:[0,11,12],constructor:0,contain:[0,1,2,3,6,12],content:[0,6],contigu:0,contribut:0,control:3,conv_crit:0,conv_fun:0,conveni:12,convent:0,converg:[0,14],convergence_typ:0,convert:0,coordin:[12,14,15],copi:0,core:8,correct:[0,3,14],correctli:10,correspond:[0,3,14],correspondingli:11,cos:[0,6,11],cosin:[0,3,6,11],cost:[3,11],could:8,coulomb:[0,3,4,5],coulomb_const:0,coulombtyp:[0,3,5,6],counter:6,coupl:[0,3,6,12],cprofil:2,cpu:[0,11],crash:3,creat:[0,9],critic:[0,6],cross:0,csvr:[0,3],csvr_thermostat:0,current:[0,6,10],cwd:8,cython:[8,16],d_n:0,dat:10,data:[0,3,6,12,15],dataclass:0,dataset:[0,5,6,12],datatyp:15,date:[0,16],date_format:0,david:16,debug:[0,2],decompos:0,decomposit:[0,3,11],default_level:0,defaultnochi:[0,6,9],defaultnohchi:[0,3],defaultwithchi:[0,3,6,9],defin:[0,6,9,11,14],definit:0,degre:3,delta:[0,14],denot:[0,1,3,9,11,12],densiti:[0,3,5,9,14,16],depend:[0,6,11,14,16],deprec:0,deriv:[0,14],design:6,dest_directori:0,detail:[2,3,6,8,10,12,13,14],determin:[0,2,7,16],dev:8,devel:8,develop:[6,8],deviat:[0,3],dict:0,dictat:0,dictionari:0,did:10,dielectr:[0,3,6],dielectric_const:[0,3,5,6],dielectric_typ:0,dielectric_valu:0,dieter:0,differ:[0,3,6,12,15],differenti:[0,5,7,9,14],difficult:2,dih_typ:0,dihedr:[0,2,3,5,6,8,11,16],dimens:[0,11,12,15],dimension:12,dinola:0,dipol:[0,2,3,5,6,16],dipole_forces_redistribut:0,direct:[0,3,13],directori:12,disabl:[2,6,8,10,12],disable_mpio:0,discard:0,discret:[0,14],discretis:14,disk:[0,3],dispers:6,dist:8,distanc:[0,3,11],distinct:0,distribut:[0,3,5,6,14],distribute_input:0,distutil:8,dnf:8,doc:0,dockerhub:8,dodecyl:6,doe:[0,11],doesn:0,doi:16,domain:[0,3,11],domain_decomposit:[0,3,6],donadio:[0,16],done:[0,6,8,16],dopc:6,dot:0,dot_elec:0,doubl:[0,2],double_out:0,download:8,dppc:6,draw:0,drawn:0,driver:[8,12],dtype:0,due:[0,3],dump:0,dump_per_particl:0,dure:[0,2,3,11,12],dynam:[0,3,12,14,16],e1785571:16,e_k:0,each:[0,3,6,11,12],easiest:16,effect:[0,3],effici:11,eight:15,either:[0,3,8,15],elec:0,elec_field:0,elec_field_contrib:0,elec_field_fouri:0,elec_forc:0,elecrostat:0,electr:[0,4,5],electrosat:0,electrostat:[0,6,16],els:3,elucid:6,embed:6,emit:0,emploi:0,empti:0,enabl:[2,6,12],enclos:0,end:0,energi:[0,1,3,4,6,7,10,11,12,13,14,16],energiesself:0,enhanc:[10,16],ensembl:16,ensur:[0,3,6,8,14],ensurepip:8,entri:3,environ:10,epsilon:0,equal:[0,3,6],equat:0,equilibr:[3,6],equilibrium:[0,3,6],equilibrum:11,equival:[0,3],error:0,essenti:[0,1,8],etc:[2,3],even:[0,3,6,8],event:0,everi:[0,3,6,11,12],everystep:0,evid:0,ewald:[0,5,6],examin:6,exampl:[3,8,12,15,16],example_structur:12,except:11,exchang:[0,3],exec:8,execut:[0,8,12],exist:0,exit:8,exp:[7,14],expand:0,expans:0,expect:0,expens:[3,14],explicit:[0,6,11,16],express:[0,13],ext:0,extend:6,extens:16,extent:[0,7],extern:[0,3],extract:[0,8],f401:8,f_angl:0,f_bond:0,f_dihedr:0,f_dipol:0,f_on_bead:0,factor:0,factori:0,fail:[0,8],fals:[0,3,6],fapl:8,fashion:[0,3],fast:14,fedora:8,few:[6,9,11,12],fft:[0,1,2,3,5,6,12,14,16],fftw3:8,fftw:[8,16],field:[2,4,5,6,9,10,12,13,14,16],field_energi:0,field_list:0,field_q_energi:0,field_q_self_energi:0,file:[2,5,6,7,8,9,10,11,12,16],file_io:0,file_nam:0,file_path:0,filter:[0,3,5,6,12,13,16],find:[0,8],find_all_path:0,first:[0,3,6,10,12],five:0,fix:[0,8,12],flag:[0,15],flat:12,float32:[12,15],float64:15,flori:0,fluctuat:0,flush:[0,3],follow:[0,2,3,4,6,12,13],forc:[2,3,4,5,6,11],force_kernel:8,force_mesh:0,force_mesh_elec:0,force_mesh_elec_fouri:0,force_out:0,forego:2,form:[0,5,11,13],formal:[5,14],format:[0,2,3,5,12,15,16],formatt:0,fortran:[0,11],forward:0,found:[5,8],four:[0,2,3,6,15],fourier:[0,5,14],fr6nt9m4:8,frac:[0,5,6,7,9,11,13,14],frame:[0,12,15],framework:8,free:[10,16],frequenc:[0,3],from:[0,2,3,5,6,8,9,11,12,13,16],full:[0,9,12],fulli:[0,6,8],fundament:12,gamma:0,gamma_0:0,gas:[0,4],gas_const:0,gather:0,gaussian:[0,3,7,13,14],gener:[0,2,3,6,16],get:[0,8],getattr:8,ghost:0,giovanni:16,git:[8,12,16],github:[0,6,8,12,16],githubusercont:8,given:[0,3,6,7],glenn:16,global:0,gnu:16,got:0,govern:9,gpe:0,grab:8,gradient:0,grain:[0,3,7,13,14,16],graph:0,greater:10,grid:[0,1,3,5,6,7,12,14],group:[0,3,6,8,12,15,16],guess:0,gunsteren:0,gyrat:6,h5md:[0,3],h5py:[0,2],h_0:[6,14],haak:0,half:0,hamiltonian:[3,5,6,7,9,12,16],handl:0,handler:0,happen:11,harmon:[0,3,6,11],has:[0,3,8,15],hat:[7,14],have:[0,6,8,10],hdf5:[0,2,3,5,6,8,10,12,15,16],hdf5_dir:8,hdf5_mpi:8,head:6,header:8,heat:[0,3],helic:[0,3,5,6],help:6,helper:0,here:[0,6,8,16],hhpf:[13,16],highli:[8,11,12],hijack:7,hire:1,homogen:0,homopolym:1,homopolypeptid:6,how:[3,12,16],howev:6,hpf:[3,5,9,12,14,16],html:0,http:[0,8,10,12,16],huggin:0,hundr:[6,11],hybrid:[12,14,16],hylleraa:16,hymd:[0,2,3,4,5,6,7,9,10,11,12,14,15],hymd_domain2023:16,ideal:11,ideal_chain:[6,8,10],ideal_ga:[6,12],ident:0,ignor:0,ijk:[5,14],imag:8,impact:0,implement:[0,11],importerror:8,impuls:[0,3],in_fil:[0,8],inam:8,includ:[0,2,3,6,14,16],incompress:[0,3],increas:[0,2,6],indentifi:0,independ:[0,3,7,14],index:[0,12,15,16],indic:[0,2,3,11,12,15],indirect:0,individu:[0,3,6],induc:5,inf:16,infer:11,info:[0,8],inform:[0,11,16],ingredi:6,initi:[0,15],initial_energi:0,initialis:12,initialize_pm:0,inner:[0,3],input:[2,3,4,5,6,7,8,10,12,15],input_box:0,input_pars:[0,8],insert:0,insid:[0,3,6],instal:[2,10,12],install_pfft:8,instantan:0,int32:[12,15],int64:15,integ:[0,3,6,15],integr:[3,6,12],integrate_posit:0,integrate_veloc:0,intend:8,inter:[0,11],interact:[0,2,3,4,6,7,12,13,14,16],interaction_energi:0,intercomm:0,interfac:[0,2,16],intergr:0,intermediari:0,intermolecular:6,intern:[0,2,3,4,11,13],interpol:[0,5],interpret:12,interv:[0,3],intmathrm:0,intracomm:0,intramolecular:[0,3,6,13,14,16],intrins:[3,5,14],introduc:6,investig:0,invok:[2,12],involv:[0,3,11],ion:6,ipynb:6,is_open:0,isobar:16,isotherm:0,isotrop:[0,3],iter:0,j_k:0,jcim:16,join:8,jone:14,joss:16,journal:16,jupyt:[6,8,16],k_e:0,kappa:[0,3,4,6,12,14],keep:[0,3],kelvin:[0,3,6,12],kernel:[0,10,11],keyword:[0,5,6,12],kinet:[0,13,14],kinetic_energi:0,knuth:0,kpa:4,kwd:8,l_a:13,label:[1,11],lambda:0,lamdifi:9,land:16,laplacian:0,larg:[8,12],larger:3,last:[6,8,12,15],last_bb:0,later:[0,6],latest:8,law:11,layout:0,layout_q:0,lbc20:16,leak:8,learn:16,leav:0,ledum:[6,16],left:[0,5,6,7,9,11,13,14],legend:1,lenght:0,length:[0,3,4,6,7,11,12,13,15],lennard:14,less:[0,6],lesser:16,let:[0,11],level:[0,2,3,15],lib64:8,lib:8,libhdf5:8,libopenmpi:8,librari:[0,2,8,10,16],libtool:8,libver:8,licens:16,lieu:0,like:[0,6,8,12],limit:[3,8],line:[0,8,12],linear:[0,3],lipid_self_assembl:6,list:0,list_coulomb:0,load:0,local:[0,8,11,12,14],locat:8,log:[0,2,12],log_fil:0,log_out:12,logfil:[0,2,12],logger:2,logic:0,logrecord:0,look:[6,8,12],loop:0,lost:3,low:[6,8],lsl:16,m_j:0,mac:8,machin:[2,16],made:0,mai:[0,2,3,6,8,11,12,15],main:[0,8,12],main_glob:8,maintain:16,make:[6,8],make_fapl:8,manner:6,manual:[8,10],manuel:16,map:[0,12],march:16,martini:6,martyna:16,mass:[0,3,4,15],massiv:16,master:0,match:0,math:0,mathbf:[0,4,5,6,9,11,13,14],mathcal:[6,13,14],mathmr:0,mathrm:[0,5,6,9,11,14],matter:[6,11,16],max_molecule_s:[0,3,6],maximum:[0,3,11,12],maxwel:[0,3],may:2,mbbjm:16,mean:[0,2,3],measur:11,medium:[0,3,6],melt:1,membran:6,memori:[0,8],mesh:[0,1,3,5,6,16],mesh_siz:[0,3,6,12],messag:0,messi:0,meta:6,metadata:0,method:[0,1,6,7,10,16],mh_0:14,micellular:6,michael:16,michel:16,might:[0,8],mimic:0,minim:6,minuscul:11,mirror:2,miss:16,mix:[0,6],model:[6,16],modifi:0,modul:[0,3,8,16],mol:[3,4,6,11,12,16],molecul:[0,3,12,14,15],molecular:[0,2,12,14,16],momenta:[0,12],momentum:[0,3,4],monoatom:6,more:[2,3,6,8,12,14,16],mortel:8,morten:16,most:[8,9,12,13,14],mostli:2,motion:[0,6],move:0,mpi4pi:[0,8,16],mpi:[0,2,3,10,11,12,16],mpi_num_rank:12,mpicc:8,mpifilteral:0,mpifilterroot:0,mpio:[2,8],mpip:8,mpirun:12,multiarrai:8,multipl:[0,3,6,12,15,16],must:[0,3,10],n_b:[0,3],n_flush:[0,3,6],n_frame:0,n_particl:[0,3],n_print:[0,3,6,12],n_step:[0,3,6,12],n_type:0,nabla:[0,14],nabla_a:13,name:[0,2,3,6,10,11,12,15],nanomet:[0,1],nanosecond:6,natur:[0,13],ndarrai:0,ne5et1y_:8,necessari:[0,6],necessit:[8,9],need:[0,6],neg:[0,6],neighbour:0,network:[0,11,12,15],networkx:0,neutralis:6,never:[0,3],nevertheless:3,newer:8,next:[0,6],non:[0,2,6,8],none:[0,3,8],nongnu:0,noqa:8,normal:[0,2,3,8,14],notabl:12,note:[0,6,8,12,13,14],notebook:[6,8,16],now:6,nproc:12,npt:[0,14,16],nq_i:5,number:[0,1,2,3,6,12,14,15],numer:0,numpi:[0,2,9,16],nve:16,nvt:[0,16],object:[0,9],oblat:6,observ:[0,6],obtain:[0,3,5,13,14,16],obviou:8,oct:16,off:6,older:10,omit:6,onc:[3,11],one:[0,2,3,6,15],onli:[0,6,10,11,12],onto:[0,3,5,14],open:[0,8,16],openmpi:8,oper:[0,3,14,16],oppos:0,optim:[0,11],optimis:[6,11],option:[0,3,6,10,12],order:[0,3,6,11,12],ordinari:[5,14],org:[0,10,16],organis:6,origin:0,oslo:16,osx:8,other:[0,12],otherwis:0,out:[8,10,14],outdataset:0,outer:[0,3],outfil:[2,10],output:[2,3,4,6,8,10,12],outsid:3,over:0,overlap:[0,9],p_a:13,packag:[8,10,12,16],page:16,paint:0,paper:[0,16],parallel:[0,2,3,16],paramet:[0,3,6,7,9,13,14,16],parent_group:0,parllel:0,parrinello:[0,16],pars:[0,3],parse_config_toml:[0,8],part:[5,6,14],partial:[0,13],particl:[0,2,5,6,7,9,12,14,15,16],particlemesh:0,particular:12,pass:[0,10],path:[0,2,8,10,12],pdf:1,pencil:0,peptid:[0,2,3,5,16],per:[0,2,3,11,12,15],perfect:0,perform:[0,3,8,11,12,14,16],perman:[11,16],permitt:[0,4],pfft:[0,16],pfft_build_dir:8,phase:[0,11],phase_separ:6,phi:[0,3,6,11,13,14],phi_0:[6,9,14],phi_:[0,6,9,14],phi_ep:0,phi_eps_fouri:0,phi_eta:0,phi_eta_fouri:0,phi_fft:0,phi_fouri:0,phi_k:0,phi_l:0,phi_laplacian:0,phi_n:[6,11],phi_pol:0,phi_pol_prev:0,phi_q:0,phi_q_fouri:0,phi_t:13,phi_transf:0,phospholipid:6,phy:[0,16],pic_spectr:[0,3,6],pic_spectral_gp:0,piec:6,pip13:16,pip3:8,pip:[8,12,16],pippig:16,pkg:8,place:[0,3],plain:2,plane:[0,6,11],pleas:[8,12],plist:8,plume:[2,16],plumed2:0,plumed_bia:0,plumed_forc:0,plumed_input:10,plumed_kernel:10,plumed_obj:0,plumed_out:0,plumed_vers:0,plumedbia:0,plumeddat:0,pm_stuff:0,pme:16,pmesh:[0,8,16],png:1,point:[0,1,11,15],pointer:0,poisson:0,pol_mix:0,polar:0,polym:6,posit:[0,2,3,5,6,12,14],possibl:[0,3,6,16],postma:0,poteng:0,potenti:[0,3,4,5,7,8,11,16],ppft:16,practic:11,pre:[0,6],precis:[1,2],prefer:3,prepar:0,prepare_bond:0,prepare_bonds_old:0,prepare_index_based_bond:0,prepend:[0,12],present:[0,2,3,6],preserv:3,pressur:[4,14,16],pretti:8,previou:0,previous:6,prior:[0,3,10],priovid:0,prng:0,prod_:0,profil:2,program:[0,12],project:5,promot:0,prop:0,propag:[0,3],propens:[0,3,5,6],propensity_potential_coeff:0,properti:[0,3],protein:[0,16],provid:[0,2,3,10,12,15,16],psi:[0,4,5],psi_:5,psi_fouri:0,pull:8,push:16,put:6,pytest:12,python3:[6,8,10,12,16],python:[0,10,12,16],q_i:[0,5],q_j:0,quadrat:0,quanit:0,quantiti:[0,4],quantum:16,quartet:11,quess:0,r_0:[0,6,11],r_a:11,r_c:11,rad:[3,11],radial:6,radii:6,radiu:6,rainwoodman:8,rais:[6,8],random:[0,2,12],random_chi_squar:0,random_gaussian:0,randomli:[0,3,6],rang:5,rank0:0,rank:[0,2,3,11,12],rank_rang:0,rankself:0,rare:11,raw:8,rdcc_nbyte:8,rdcc_nslot:8,rdcc_w0:8,read:[0,8,12,16],read_config_toml:[0,8],readi:0,readout:0,real:15,realfield:0,realist:6,reappli:0,rearrang:0,reason:8,receiv:[0,3],recent:8,reciproc:[0,7],recognis:12,recommend:8,reconstruct:[0,2,5,6,11,16],record:0,recreat:16,recurs:0,redistribut:0,reduc:[3,14],refer:[3,12],regim:6,regul:[0,3],reiniti:0,rel:[0,3,6,11],relax:[0,3],releas:[0,6,8,12,16],remain:[0,6],remov:[0,3],remove_center_of_mass_momentum:0,remove_com_momentum:[0,3],replac:[0,8],replica:[0,10],repositori:[6,12],repres:[0,3,15],represent:7,repuls:3,request:0,requir:[0,3,8,11,12,16],rescal:[0,3,16],research:16,respa:[0,3,6],respa_inn:[0,3,6],respect:[0,1,14],restructur:0,result:[0,3,6,9],revers:[0,3,16],rho0:[0,3],rho:[0,5],rho_0:[0,14],rho_:5,right:[0,5,6,7,9,11,13,14],rightarrow:11,root:[0,12,15],roughi:6,row:12,rrespa:[0,3,6],ruin:0,run:[0,2,3,6,11],run_glob:8,rundown:12,runpi:8,runtimeerror:8,same:[0,3,6],samiran:16,sampl:[0,3,10,16],scalar:0,scale:[0,3,6,7,8,11,12,16],scheme:[0,6],sci:16,scienc:16,scr:3,script:12,sds:6,search:16,second:[0,12],see:[0,2,3,5,6,8,9,10,11,12,13,14,16],seed:[2,12],select:[12,16],self:[0,3,8],self_energi:0,semiisotrop:[0,3],seminumer:0,sen:16,send:[0,3],separ:0,seri:[0,3,6,11],serial:[8,12],serialis:3,set:[0,3,10,12],set_fapl:8,setup:[0,6,7,8,15],setup_time_dependent_el:0,setuptool:8,sever:0,shape:[0,6,12,15],sheet:0,shift:0,should:[0,2,11],shown:6,siam:16,sigbj:16,sigma:[0,3,6,7,12,13,14],sim:0,similar:0,simpl:[0,6,12,14],simplest:6,simpli:0,simul:[0,2,6,8,11,13,14,15,16],simultan:0,sinc:0,singl:[0,3,6,10],site:8,size:[0,3,6,12,14],slbc23:16,slight:0,slowli:14,small:[3,12],smear:5,smooth:[0,14],sodium:6,soft:[6,16],softwar:16,solv:0,solvent:6,some:[0,3,8],sort:0,sort_dielectric_by_type_id:0,sourc:[0,1],space:[0,3,5,7],span:0,spatial:[0,3,12,14],specfi:0,speci:0,special:0,specif:[0,2,3,6,9,11,12,14,15],specifi:[0,2,3,6,9,11,12,15],spectacularli:0,spectral:6,speed:[0,3],spheric:6,spheroid:6,split:0,spontan:6,spring:[0,11],sqrt:[0,7,14],squar:[0,9],squaredphi:[0,3,9,12],stabil:6,stabl:6,stackoverflow:0,standard:[0,3,14,16],start:[0,3,6,11,15],start_temperatur:[0,3,6],state:0,statu:8,stdout:[0,2],step:[0,3,6,11,12],stiff:3,stochast:0,store:0,store_data:0,store_stat:0,str10:12,str:0,straightforward:[7,9],stream:0,strength:[0,3,6,12],stretch:[0,3,11,16],string:[0,3,8,12,15],structur:[0,2,3,5,6,12],sub:6,subclass:[0,9],subsequ:[0,5,6,11],sudo:8,suitabl:[0,3],sulfat:6,sum:0,sum_:[0,5,9,13,14],sum_i:0,sum_j:0,sum_k:0,sum_n:[0,6,11],sum_t:13,summari:12,superclass:[0,7],support:[0,6,8,10],swap:11,symbol:[0,4,9],sympi:[0,9],sys:8,system:[0,1,2,3,6,9,12,14,16],t_a:13,tag:[0,3,8],take:[0,3,5,9,11,12,14],taken:0,tar:8,target:[0,3,14],target_pressur:[0,3],target_temperatur:[0,3,6,12],tau:[0,3,6,12],tau_p:[0,3],tbm92:16,temperatur:[0,3,4,6,12,14],ten:6,term:[0,3,6,9,13,14],test:[0,1],text:[0,2,3,4,5,6,9,11,13,14],than:[0,3],theoj:16,theori:[0,13],therefor:[8,10],thermalis:[0,3],thermostat:[2,3,6,12],thermostat_coupling_group:[0,3,6],thermostat_work:0,theta:[6,11],theta_0:[0,6,11],thi:[0,2,3,6,8,9,10,11,12,14],thorough:12,though:6,thousand:[6,11],three:[0,2,3,6],through:[0,3,6,7,8,9,11,16],tild:[0,3,4,5,6,9,13,14],time:[0,3,4,6,11,12,16],time_step:[0,3,6,12],tmp:8,todo:0,togeth:[0,3,6],token:8,toml:[0,2,3,6,8,10,11,12],toml_cont:0,tomli:0,too:3,toplog:0,topol:0,topolog:[0,2,3,5,6,12,16],torsion:[0,3,11,16],total:[0,3,6,12,13,14],traceback:8,trajectori:[0,2,3,6,12],trans_matric:0,transfer:[0,11],transform:[0,9,14],travers:0,tree:0,tri:3,trivial:0,truncat:0,tuckerman:[3,16],turn:6,tutori:[6,8,12,15],two:[0,2,3,6],txt:12,type:[0,2,3,5,6,9,11,12,15],type_arrai:0,type_charg:0,type_to_name_map:0,typic:3,ubuntu:8,uio:[8,12,16],unchang:0,under:[6,8,14,16],uniformli:0,uninstal:8,union:0,uniqu:0,unique_nam:0,unit:[0,3,11],univers:16,unknown:0,unless:[0,3],unmodifi:0,unset:0,unstabl:3,until:6,updat:[0,8],update_field:0,update_field_force_q:0,update_field_force_q_gp:0,upgrad:[8,16],url:16,usag:[0,2],use:[0,3,5,6,8,10],used:[0,1,2,3,6,7,9,12,14,15],user:10,uses:[0,4,14,16],using:[0,2,3,8,14,16],usr:8,usual:12,v_2:[0,6,11],v_3:[0,6,11],v_4:[0,6,11],v_ext:0,v_ext_fouri:0,vacuum:4,valid:[0,3],validated_config:0,valu:[0,3,4,5,6,11],valueerror:8,van:0,vanish:0,varepsilon:0,varepsilon_0:[4,5],vari:14,variabl:[0,10],variant:6,variou:[0,15],vbar_elec:0,vbar_elec_fouri:0,vector:[3,11],vectoris:9,veloc:[0,2,3,4,6,12,15,16],velocity_out:0,velocti:0,verbos:[0,2,8,12],veri:[6,8,11],verifi:0,verlet:[0,3,6,12],versa:3,version:[0,6,8,10,12,14],vert:0,vertex:[0,5],vertic:0,via:[6,16],vice:3,vir:13,virial:13,vol:0,volum:[0,3,13,14,16],voxel:0,wai:[8,14],warn:0,weakli:3,weight:0,well:6,were:0,weslei:0,wether:0,wheel:8,when:[0,2,3,8,10,11],where:[0,5,9,11,13,14],whether:[0,3],which:[0,2,3,5,6,8,9,11,12,13],width:[0,3],window:[0,5,14],within:0,without:[0,16],work:[0,8,10],workload:0,would:[0,3],wrap:0,wrapper:0,write:[0,3],written:[0,3],www:[0,10],xinmeng:16,yet:0,yield:6,you:[8,10,11],your:10,zero:[0,3]},titles:["4. API reference","3. Benchmarks","5. Command line arguments","3. Configuration file","6. Constants and Units","3. Electrostatic interactions","1. Examples","2. Filtering","1. Installation","1. Interaction energy functionals","5. PLUMED interface","2. Intramolecular bonds","2. Usage overview for HylleraasMD","4. Pressure","1. Theory","4. Topology and structure file","HylleraasMD documentation"],titleterms:{"function":9,"import":8,"new":[7,9],"while":8,SDS:6,api:0,argument:2,assembl:6,barostat:0,benchmark:1,berendsen:0,bilay:6,bond:[1,3,11],build:8,calcul:14,chain:6,chi:9,code:16,colab:16,colaboratori:8,command:2,common:8,configur:3,constant:4,copolym:6,curl:8,dataset:15,depend:8,develop:16,diblock:6,docker:8,document:16,due:8,electrostat:[3,5],enabl:8,energi:9,error:8,exampl:6,extern:14,field:[0,1,3],file:[0,3,15],filter:[7,14],forc:[0,1,8,14],form:[9,14],fortran:8,four:11,gas:6,googl:[8,16],guid:16,h5py:8,hamiltonian:[0,14],helix:6,hylleraasmd:[12,16],hymd:[8,16],ideal:6,implement:[7,9],incompress:9,indic:16,input:0,instal:[8,16],integr:0,interact:[5,8,9],interfac:10,interpol:14,intramolecular:11,issu:8,kappa:9,kernel:8,keyword:3,line:2,lipid:6,logger:0,metadata:3,miss:8,mpi:8,numpi:8,onli:9,option:[2,15],output:0,overview:12,parallel:[8,12],parser:0,particl:[1,3,11],peptid:6,pfft:8,phase:6,phi:9,plume:[0,10],potenti:14,pressur:[0,3,13],python:8,reciproc:14,refer:[0,16],requir:[2,15],rod:6,run:[8,10,12,16],scr:0,self:6,separ:6,simul:[3,10,12],sourc:16,space:14,specifi:5,stiff:6,structur:15,tabl:16,test:12,theori:14,thermostat:0,three:11,topolog:15,two:11,unit:4,usag:12,user:16,using:10,wget:8,without:8}}) \ No newline at end of file